Merge lp:~stefan-lohmaier/nuvola-player/rdio into lp:nuvola-player/2.5.x

[StefanL]

I just added a new service. I've using it for the past week without any issues. It supports the old and the new design.

[Jiří Janoušek (fenryxo)]

Thanks for your contribution to Nuvola Player project.

Code looks good, a few minor improvements:

--------8<--------

6 +<p><strong>Rdio</strong> is an ad-free music subscription service available ..

The line is too long, split it to multiple lines with maximal width 80 characters.

--------8<--------

25 + Copyright 2011 Stefan Lohmaier <email address hidden>

It's 2012.

--------8<--------

44 + * @param Nuvola Nuvola JS API

You can remove this line, because the param no longer exists. I should clean up my scripts :-)

--------8<--------

62 + * 0 : old ui
63 + * 1 : new ui

replace with

* @returns 0 for the old ui and 1 for the new ui

--------8<--------

83 + var state = Nuvola.STATE_NONE;
...
133 + default: state = Nuvola.STATE_NONE; break;

The second assignment is unnecessary.

--------8<--------

126 + player_model.playState;//old

You may have forgotten an assignment to rdiostate (not sure):

rdiostate = player_model.playState;//old

--------8<--------

Your work will be shipped with Nuvola Player 1.1. As a maintainer, you will be responsible for fixing all bugs reported against this service integration. The bugs will be assigned to your Launchpad account.

I can also create package for release 1.0.x, if you are willing to support it.

review: Needs Fixing

[Jiří Janoušek (fenryxo)]

FYI I'm about to release version 1.0.4 soon (at the weekend), so you should perform suggested modifications, if you would like to have your work merged to that release.

[lp:~stefan-lohmaier/nuvola-player/rdio]

345. By StefanL on 2012-03-28

fixed notes from review

Unmerged revisions

=== added directory 'data/nuvolaplayer/services/rdio'
=== added file 'data/nuvolaplayer/services/rdio/description.html'
--- data/nuvolaplayer/services/rdio/description.html	1970-01-01 00:00:00 +0000
+++ data/nuvolaplayer/services/rdio/description.html	2012-03-28 22:17:18 +0000
@@ -0,0 +1,10 @@
+<p><strong>Rdio</strong> is an ad-free music subscription service available in
+the United States, Canada, Germany, Brazil, Australia, Spain, Portugal and New
+Zealand. It is available as a website and also has clients for the iPhone,
+iPod Touch & iPad, Android, BlackBerry and Windows Phone mobile devices, which
+can play streaming music or cache songs for offline playback.
+</p><p>
+<em>Source:
+<a href="http://en.wikipedia.org/wiki/Rdio">Rdio on Wikipedia</a>,
+<a href="http://www.rdio.com">Official website</a></em>
+</p>

=== added file 'data/nuvolaplayer/services/rdio/integration.js'
--- data/nuvolaplayer/services/rdio/integration.js	1970-01-01 00:00:00 +0000
+++ data/nuvolaplayer/services/rdio/integration.js	2012-03-28 22:17:18 +0000
@@ -0,0 +1,207 @@
+/*
+	Nuvola Player :: Cloud music integration
+	
+	This script provides integration of the Rdio streaming service
+	on the JavaScript side. It's executed when Rdio page is completely
+	loaded.
+
+
+	Copyright 2012 Stefan Lohmaier <[e-mail]>
+
+This program is free software: you can redistribute it and/or modify it 
+under the terms of the GNU General Public License version 3, as published 
+by the Free Software Foundation.
+
+This program is distributed in the hope that it will be useful, but 
+WITHOUT ANY WARRANTY; without even the implied warranties of 
+MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
+PURPOSE.  See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along 
+with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/* Anonymous function is used not to pollute environment */
+(function(Nuvola){
+	/**
+	 * Creates Rdio integration binded to Nuvola JS API
+	 */
+	var Integration = function(){
+		/* Overwrite default commnad function */
+		Nuvola.command = Nuvola.bind(this, this.command);
+		
+		/* For debug output */
+		this.name = "Rdio";		
+		
+		/* Let's run */
+		this.state = Nuvola.STATE_NONE;
+		this.update();
+		this.timeout = setInterval(Nuvola.bind(this, this.update), 500);
+	};
+
+
+	/**
+	 * Determine, which version of the ui is currently being used.
+	 * @returns 0 for the old ui and 1 for the new ui
+	 */
+	Integration.prototype.getUiVersion = function(){
+		var uiVersion;
+		try {
+			if (playbackControls == undefined) {
+				uiVersion = 0;
+			}
+		}
+		catch (e) {
+			uiVersion = 1;
+		}
+		return uiVersion;
+	}
+	
+	/**
+	 * Updates current playback state
+	 */
+	Integration.prototype.update = function(){
+		// Default state
+		var state = Nuvola.STATE_NONE;
+		var album = null;
+		var album_art = null;
+		var artist = null;
+		var song = null;
+		var can_prev;
+		var can_next;
+		var can_thumbs_up = false;
+		var can_thumbs_down = false;
+		var can_favorite = false;
+		var uiVersion = this.getUiVersion();
+			
+		try{
+			var album_art;
+			var album;
+			var artist;
+			var song;
+
+			if(uiVersion == 1){
+				album_art = document.getElementsByClassName("album_link")[0].getElementsByClassName("image")[0].src;
+				album = null;
+				artist = document.getElementsByClassName("artist truncated_line")[0].innerText;
+				song = document.getElementsByClassName("name truncated_line")[0].innerText;
+			}
+			else {
+				album_art = document.getElementById('playerNowPlayingImage').src;
+				album = document.getElementById('playerNowPlayingAlbum').firstChild.innerText;
+				artist = document.getElementById('playerNowPlayingArtist').firstChild.innerText;
+				song = document.getElementById('playerNowPlayingTitle').firstChild.innerText;
+			}
+		}
+		catch(e){
+			//~ console.debug("Unable to obtain song info: " + e.message);
+		}
+		
+		try{
+			var state = Nuvola.STATE_NONE;
+
+			var rdiostate;
+			if(uiVersion == 1){
+				rdiostate = R.Services.Player.model.attributes.playState;//new
+			}
+			else {
+				rdiostate = player_model.playState;//old
+			}
+
+
+			switch (rdiostate){
+				case 0: state = Nuvola.STATE_PAUSED; break;
+				case 1: state = Nuvola.STATE_PLAYING; break;
+			}
+			
+			if(state != Nuvola.STATE_NONE){
+				can_prev = can_next = true;
+			}
+			else{
+				can_prev = can_next = false;
+			}
+			
+		}
+		catch(e){
+			can_prev = can_next = false;
+		}
+
+		this.state = state;
+		
+		// Submit data to Nuvola backend
+		Nuvola.dataChanged(
+			song, artist, album, album_art,
+			state, can_prev, can_next,
+			can_thumbs_up, can_thumbs_down, can_favorite);
+	}
+	
+	/**
+	 * Command handler
+	 * @param cmd command to execute
+	 */
+	Integration.prototype.command = function(cmd){
+		uiVersion = this.getUiVersion();
+
+		try{
+			switch(cmd){
+			case Nuvola.CMD_PLAY:
+				if(this.state != Nuvola.STATE_PLAYING){
+					if(uiVersion == 1){
+						document.getElementsByClassName("play_pause")[0].click();
+					}
+					else{
+						playbackControls.playPause();
+					}
+				}
+				break;
+			case Nuvola.CMD_PAUSE:
+				if(this.state == Nuvola.STATE_PLAYING){
+					if(uiVersion == 1){
+						document.getElementsByClassName("play_pause")[0].click();
+					}
+					else{
+						playbackControls.playPause();
+					}
+				}
+				break;
+			case Nuvola.CMD_TOGGLE:
+				if(uiVersion == 1){
+					document.getElementsByClassName("play_pause")[0].click();
+				}
+				else{
+					playbackControls.playPause();
+				}
+				break;
+			case Nuvola.CMD_PREV_SONG:
+				if(uiVersion == 1){
+					document.getElementsByClassName("prev")[0].click();
+				}
+				else{
+					getPlayer()._previous();
+				}
+				break;
+			case Nuvola.CMD_NEXT_SONG:
+				if(uiVersion == 1){
+					document.getElementsByClassName("next")[0].click();
+				}
+				else{
+					getPlayer()._next();
+				}
+				break;
+			default:
+				// Other commands are not supported
+				throw {"message": "Not supported."};
+			}
+			console.log(this.name + ": comand '" + cmd + "' executed.");
+		}
+		catch(e){
+			// API expects exception to be a string!
+			throw (this.name + ": " + e.message);
+		}
+	}
+
+	/* Store reference */ 
+	Nuvola.integration = new Integration(); // Singleton
+	
+// Call anonymous function with Nuvola object as an argument
+})(window._Nuvola);

=== added file 'data/nuvolaplayer/services/rdio/metadata.conf'
--- data/nuvolaplayer/services/rdio/metadata.conf	1970-01-01 00:00:00 +0000
+++ data/nuvolaplayer/services/rdio/metadata.conf	2012-03-28 22:17:18 +0000
@@ -0,0 +1,6 @@
+name = Rdio
+home_page = http://www.rdio.com/
+sandbox_pattern = https?://((www\.)?rdio\.com/|ak.rdio\.com|)
+maintainer_name = Stefan Lohmaier	
+maintainer_link = https://launchpad.net/~stefan-lohmaier
+version = 1