Merge lp:~mikeycgto/nuvola-player/8tracks-2-0 into lp:nuvola-player/2.5.x

[mikeycgto]

Updated 8tracks integration to 2.0 of API.

[Jiří Janoušek (fenryxo)]

Hi. Thanks for fixing and adopting 8tracks service integration. Could you please create a bug report[1] for the issue you have fixed so the fix can be backported to the stable series?

[1] https://bugs.launchpad.net/nuvola-player/+filebug

=== data/nuvolaplayer/services/eighttracks/integration.js

Please add yourself to the list of copyright holders at the beginning of the file.

---

61 - var can_favorite = $("#profile_link").length != 0;

You removed and didn't re-implemented functionality to mark a mix as favorite. Is there any reason for this?

---

126 + // TODO implement NEXT_SONG properly
127 + Nuvola.updateAction(Nuvola.ACTION_NEXT_SONG, true);

Could you elaborate more what do you mean by "implement NEXT_SONG properly"?

=== data/nuvolaplayer/services/eighttracks/metadata.conf
212 +maintainer_link = https://about.me/mikeycgto

"If you want to have your service integration shipped with Nuvola Player, you must use link to your Launchpad profile." [2]

[2] http://nuvolaplayer.fenryxo.cz/contribute/development/service_integration.html

review: Needs Fixing

[mikeycgto (mikeycgto)]

Just filed the bug (was caused by $j no longer being defined by 8tracks).

Regarding the favorite functionality, I just forgot to re-implement it. I can fix this no problem.

For the updating the NEXT_SONG state, you only have to certain amount of skips on 8tracks (per-mix). There are somethings in the DOM I can use to determine if you can skip the song. I need to just double check a few things and make sure this logic is sound.

Should be able to get these things fixed up and submitted sometime tomorrow. Really love nuvola and will try and help out with service integrations where possible!

[Jiří Janoušek (fenryxo)]

It's been a while since your last change. Is the branch ready for a review?

[mikeycgto (mikeycgto)]

Yes, it's ready for review.

On Mon, Feb 25, 2013 at 6:26 AM, Jiří Janoušek <email address hidden>wrote:

> It's been a while since your last change. Is the branch ready for a review?
> --
>
> https://code.launchpad.net/~mikeycgto/nuvola-player/8tracks-2-0/+merge/148889
> You are the owner of lp:~mikeycgto/nuvola-player/8tracks-2-0.
>

--
http://about.me/mikeycgto

[Jiří Janoušek (fenryxo)]

>Yes, it's ready for review.

Next time, you can comment on the review to get me know the review is ready.

=== file 'data/nuvolaplayer/services/eighttracks/integration.js'

8 + * Copyright 2011-2012 Michael J Coyne <email address hidden>

It should be "Copyright 2013 Michael J Coyne <email address hidden>".

=== file 'data/nuvolaplayer/services/eighttracks/metadata.conf'

231 +maintainer_name = Michael J Coyne
232 +maintainer_link = https://about.me/mikeycgto

Please use your Launchpad profile URL (https://launchpad.net/~mikeycgto) as a maintainer_link.

"If you want to have your service integration shipped with Nuvola Player, you must use link to your Launchpad profile." [2]

[2] http://nuvolaplayer.fenryxo.cz/contribute/development/service_integration.html

review: Needs Fixing

[mikeycgto (mikeycgto)]

Should be set

[Jiří Janoušek (fenryxo)]

Great. Will merge on the weekend. Thanks for your work.

review: Approve

[lp:~mikeycgto/nuvola-player/8tracks-2-0]

647. By Jiří Janoušek on 2013-03-03

googleplay 3.15: Fixed resolving of a name and an artist of the current song.

Bugs: LP:1138576

648. By mikeycgto on 2013-03-03

eighttracks 4.0: Adopted. Fixed breakage.

 * Service integration was adopted by Michael J Coyne.

 * Fixed breakage (alert loop) caused by a change in 8tracks web interface.

 * Ported to NP JS API 2.0.

Bugs: LP:1035490, LP:1127488.

Reviewed by: Jiří Janoušek <email address hidden>

=== modified file 'data/nuvolaplayer/services/eighttracks/integration.js'
--- data/nuvolaplayer/services/eighttracks/integration.js	2012-08-28 15:42:51 +0000
+++ data/nuvolaplayer/services/eighttracks/integration.js	2013-02-26 15:23:23 +0000
@@ -1,6 +1,7 @@
 /*
  * Copyright 2011-2012 Janez Troha <[e-mail]>
  * Copyright 2011-2012 Jiří Janoušek <[e-mail]>
+ * Copyright 2013 Michael J Coyne <[e-mail]>
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met: 
@@ -24,14 +25,21 @@
  */
 
 /* Anonymous function is used not to pollute environment */
-(function(Nuvola){
-	
-	var get_play_button = function(){
+(function(Nuvola, $j){
+	if (!$j) return alert("Unable to find window.jQuery");
+
+	function get_play_button(){
 		var play_button = $j('#player_play_button');
-		if(play_button.length == 0) play_button = $j('#play_page span');
-		if(play_button.length == 0) play_button = null;
+
+		if (play_button.length == 0) play_button = $j('#play_page span');
+		if (play_button.length == 0) play_button = null;
+
 		return play_button;
 	}
+
+	function get_favorite_button(){
+		return $('#like_button');
+	}
 	
 	/**
 	 * Creates 8tracks integration binded to Nuvola JS API
@@ -39,117 +47,87 @@
 	 */
 	var Integration = function(){
 		/* Overwrite default commnad function */
-		Nuvola.command = Nuvola.bind(this, this.command);
-		
-		/* For debug output */
+		Nuvola.onMessageReceived = Nuvola.bind(this, this.messageHandler);
+
+		// We can never go back in 8tracks
+		Nuvola.updateAction(Nuvola.ACTION_PREV_SONG, false);
+
 		this.name = "8tracks";
-		
-		/* Let's run */
 		this.state = Nuvola.STATE_NONE;
+
 		this.update();
-		// Periodically update state
-		this.timeout = setInterval(Nuvola.bind(this, this.update), 500);
 	};
 
 	/**
 	 * Updates current playback state
 	 */
 	Integration.prototype.update = function(){
-		
-		var album = null;
-		var album_art = null;
-		var artist = null;
-		var song = null;
-		var state = Nuvola.STATE_NONE;
-		var can_prev = false;
-		var can_next = false;
-		var can_thumbs_up = false;
-		var can_thumbs_down = false;
-		var can_favorite = $("#profile_link").length != 0;
-		
-		try{
-			song = $(".track.now_playing .t").text();
-			album = $(".track.now_playing .album .detail").text();
-			artist = $(".track.now_playing .a").text();
-			album_art = $("#play_area .cover")[0].src;
-			can_next = true; // FIXME
-			
-		}
-		catch(e){
-			//alert("Unable to grab info:" + e.message);
-		}
-		try{	
-			var play_button = $j('#player_play_button');
-			play_button = play_button.length == 0 
-				? null : play_button[0];
-			
-			//~ if(! play_button){
-				//~ play_button = $j('#play_page');
-			//~ play_button = play_button.length == 0 
-				//~ ? null : play_button[0];
-			//~ }
-			
-			var pause_button = $j('#player_pause_button');
-			pause_button = pause_button.length == 0 
-				? null : pause_button[0];
-			
-			if(play_button && play_button.style.display != "none"){
-				state = Nuvola.STATE_PAUSED;
-			}
-			else if(pause_button && pause_button.style.display != "none"){
-				state = Nuvola.STATE_PLAYING;
-			}
-		}
-		catch(e){
-			alert("Unable to grab state: " + e.message);
-		}
-		
-		this.state = state;
-		Nuvola.dataChanged(
-			song, artist, album, album_art,
-			state, can_prev, can_next,
-			can_thumbs_up, can_thumbs_down, can_favorite);
+		var meta   = $('#play_area');
+		var song   = meta.find('.t').text();
+		var artist = meta.find('.a').text();
+		var album  = meta.find('.album .detail').text();
+		var ab_art = meta.find('.cover').attr('src') || null;
+
+		var play_button = $j('#player_play_button');
+		var pause_button = $j('#player_pause_button');
+		
+		if (play_button.css('display') != "none"){
+			this.state = Nuvola.STATE_PAUSED;
+		} else if (pause_button.css('display') != "none"){
+			this.state = Nuvola.STATE_PLAYING;
+		} else {
+			this.state = Nuvola.STATE_NONE;
+		}
+
+		var can_fav  = !!get_favorite_button().length;
+		var can_next = true;
+
+		// Update song information
+		Nuvola.updateSong(song, artist, album, ab_art, this.state);
+
+		// Update actions
+		Nuvola.updateAction(Nuvola.ACTION_FAVORITE, can_fav);
+		Nuvola.updateAction(Nuvola.ACTION_NEXT_SONG, can_next);
+
+		// Callback in 500ms
+		setTimeout(Nuvola.bind(this, this.update), 500);
 	}
-	
-	
+
 	/**
-	 * Command handler
+	 * Message Handler
 	 * @param cmd command to execute
 	 */
-	Integration.prototype.command = function(cmd){
-		try{
-			console.log(this.name + ": " + cmd + ", " + this.state);
-			switch(cmd){
-			case Nuvola.CMD_PAUSE:
+	Integration.prototype.messageHandler = function(cmd){
+		switch(cmd){
+			case Nuvola.ACTION_PAUSE:
 				if(this.state == Nuvola.STATE_PLAYING)
-					window.$j('#player_play_button').trigger('click');
+					$j('#player_play_button').trigger('click');
 				break;
-			case Nuvola.CMD_PLAY:
+
+			case Nuvola.ACTION_PLAY:
 				if(this.state != Nuvola.STATE_PLAYING)
-					window.$j('#player_play_button').trigger('click');
+					$j('#player_play_button').trigger('click');
 				break;
-			case Nuvola.CMD_TOGGLE:
+
+			case Nuvola.ACTION_TOGGLE_PLAY:
 				get_play_button().trigger('click');
 				break;
-			case Nuvola.CMD_NEXT_SONG:
-				window.$j('#player_skip_button').trigger('click');
-				break;
-			case Nuvola.CMD_FAVORITE:
-				window.$j('#like_button input[type="submit"]').trigger("click");
-				break;
+
+			case Nuvola.ACTION_NEXT_SONG:
+				$j('#player_skip_button').trigger('click');
+				break;
+
+			case Nuvola.ACTION_FAVORITE:
+				get_favorite_button().trigger('click');
+
 			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);
-		}
-	}
-	
-	
- Nuvola.integration = new Integration(); // Singleton ;-)
-})(window._Nuvola);
+				throw this.name + ': Action not supported';
+
+			console.log(this.name + ": command '" + cmd + "' executed.");
+		}
+	};
+
+	Nuvola.integration = new Integration();
+
+})(this, window.jQuery);
 

=== modified file 'data/nuvolaplayer/services/eighttracks/metadata.conf'
--- data/nuvolaplayer/services/eighttracks/metadata.conf	2012-07-31 13:51:32 +0000
+++ data/nuvolaplayer/services/eighttracks/metadata.conf	2013-02-26 15:23:23 +0000
@@ -1,8 +1,9 @@
 name = 8tracks
 home_page = http://8tracks.com/
 sandbox_pattern = https?://8tracks.com/
-maintainer_name = Orphaned service
-maintainer_link = https://answers.launchpad.net/nuvola-player/+faq/2012
-version = 3
+maintainer_name = Michael J Coyne
+maintainer_link = https://launchpad.net/~mikeycgto
+version = 4
 version_minor = 0
+api_major= 2
 flash_plugin = no