rockstar 0.4.2 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/examples/scrobble.rb

@@ -19,37 +19,27 @@ gets
 
 session = a.session(token)
 
-auth = Rockstar::TokenAuth.new({:username => session.username, :token => session.key})
-auth.handshake!
-
-puts "Auth Status: #{auth.status}"
-puts "Session ID: #{auth.session_id}"
-puts "Now Playing URL: #{auth.now_playing_url}"
-puts "Submission URL: #{auth.submission_url}"
-
-scrobble = Rockstar::Scrobble.new(:session_id => auth.session_id,
-                                   :submission_url => auth.submission_url,
-                                   :artist => 'Coldplay',
-                                   :track => 'Viva La Vida',
-                                   :album => 'Viva La Vida',
-                                   :time => Time.new,
-                                   :length => 244,
-                                   :track_number => 7)
-scrobble.submit!
-puts "Rockstar Submission Status: #{scrobble.status}"
+Rockstar::Track.scrobble(
+  :session_key  => session.key,
+  :track        => "Viva La Vida",
+  :artist       => "Coldplay",
+  :album        => "Viva La Vida",
+  :time         => Time.new,
+  :length       => 244,
+  :track_number => 7
+)
 
 # Love the Song :
 l_status = Rockstar::Track.new('Coldplay', 'Viva La Vida').love(session.key)
 
 puts "Love track status : #{l_status}"
 
-playing = Rockstar::Playing.new(:session_id => auth.session_id,
-                                 :now_playing_url => auth.now_playing_url,
-                                 :artist => 'Anberlin',
-                                 :track => 'A Day Late',
-                                 :album => 'Never Take Friendship Personal',
-                                 :length => 214,
-                                 :track_number => 5)
-                                 
-playing.submit!         
-puts "Playing Submission Status: #{playing.status}"      
+Rockstar::Track.updateNowPlaying(
+  :session_key  => session.key,
+  :track        => "Viva La Vida",
+  :artist       => "Coldplay",
+  :album        => "Viva La Vida",
+  :time         => Time.new,
+  :length       => 244,
+  :track_number => 7
+)

data/lib/rockstar.rb

@@ -1,10 +1,13 @@
-%w{cgi rubygems hpricot active_support}.each { |x| require x }
-
 $: << File.expand_path(File.dirname(__FILE__))
 
 require 'rubygems'
-require 'active_record'
+require 'cgi'
+require 'hpricot'
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
 require 'time'
+require 'yaml'
 
 require 'rockstar/base'
 require 'rockstar/version'

data/lib/rockstar/playing.rb

@@ -26,7 +26,8 @@ module Rockstar
     end
 
     def submit!
-      query = { :s => @session_id,
+       warn "[DEPRECATION] the `playing` class is deprecated. Please use track.updateNowPlaying"
+       query = { :s => @session_id,
                 :a => @artist,
                 :t => @track,
                 :b => @album,

data/lib/rockstar/track.rb

@@ -33,6 +33,12 @@
 #   (2449) mlmjcace
 #   (2302) tiNEey
 #   (2169) ajsbabiegirl
+
+class BadSessionError < StandardError; end
+class UnavailableError < StandardError; end
+class RequestFailedError < StandardError; end
+
+
 module Rockstar
   class Track < Base
     attr_accessor :artist, :artist_mbid, :name, :mbid, :playcount, :rank, :url
@@ -77,6 +83,102 @@ module Rockstar
         t.image     = t.images['medium']
         t
       end
+
+      def love(artist, track, session_key)
+        doc = Hpricot::XML(Track.connection.post("track.love", true, {:track => track, :artist => artist, :sk => session_key}))
+        doc.at("lfm")["status"]
+      end
+
+      # Scrobble a song
+      #
+      # Possible parameters:
+      #    session_key (required) : the session key you got during authentification
+      #    track       (required) : name of the track
+      #    artist      (required) : name of the artist of the track
+      #    time        (required) : a time object set to the time the track started playing
+      #    album                  : Name of the album
+      #    albumArtist            : Name of the album artist if artist differs
+      #    trackNumber            : Number of the track
+      #    mbid                   : MusicBrainz ID of the track
+      #    duration               : track length
+      def scrobble(params = {})
+        if params[:session_key].blank? || params[:track].blank? || params[:time].nil? || params[:artist].blank?
+          raise ArgumentError, "Missing required argument"
+        end
+
+        query = {
+          :sk           => params[:session_key],
+          "track[0]"    => params[:track],
+          "timestamp[0]"=> params[:time].utc.to_i,
+          "artist[0]"   => params[:artist]
+        }
+
+        query["album[0]"]       = params[:album] if !params[:album].blank?
+        query["albumArtist[0]"] = params[:albumArtist] if !params[:albumArtist].blank?
+        query["trackNumber[0]"] = params[:trackNumber] if !params[:trackNumber].blank?
+        query["mbid[0]"]        = params[:mbid] if !params[:mbid].blank?
+        query["duration[0]"]    = params[:duration] if !params[:duration].blank?
+        
+        doc = Hpricot::XML(Track.connection.post("track.scrobble", true, query))
+
+        if doc.at("lfm")["status"] == "failed"
+          case doc.at("lfm").at("error")["code"].to_i
+            when 9
+              raise BadSessionError, doc.at("lfm").at("error").inner_html
+            when 11, 16
+              raise UnavailableError, doc.at("lfm").at("error").inner_html
+           else
+              raise RequestFailedError, doc.at("lfm").at("error").inner_html
+           end
+        end
+ 
+        doc.at("lfm")["status"]
+       end
+
+      # Update the current playing song
+      #
+      # Possible parameters:
+      #    session_key (required) : the session key you got during authentification
+      #    track       (required) : name of the track
+      #    artist      (required) : name of the artist of the track
+      #    album                  : Name of the album
+      #    albumArtist            : Name of the album artist if artist differs
+      #    trackNumber            : Number of the track
+      #    mbid                   : MusicBrainz ID of the track
+      #    duration               : track length
+      def updateNowPlaying(params = {})
+        if params[:session_key].blank? || params[:track].blank? || params[:artist].blank?
+          raise ArgumentError, "Missing required argument"
+        end
+
+        query = {
+          :sk        => params[:session_key],
+          "track"    => params[:track],
+          "artist"   => params[:artist]
+        }
+
+        query["album"]       = params[:album] if !params[:album].blank?
+        query["albumArtist"] = params[:albumArtist] if !params[:albumArtist].blank?
+        query["trackNumber"] = params[:trackNumber] if !params[:trackNumber].blank?
+        query["mbid"]        = params[:mbid] if !params[:mbid].blank?
+        query["duration"]    = params[:duration] if !params[:duration].blank?
+        
+        doc = Hpricot::XML(Track.connection.post("track.updateNowPlaying", true, query))
+
+        if doc.at("lfm")["status"] == "failed"
+          case doc.at("lfm").at("error")["code"].to_i
+            when 9
+              raise BadSessionError, doc.at("lfm").at("error").inner_html
+            when 11, 16
+              raise UnavailableError, doc.at("lfm").at("error").inner_html
+           else
+              raise RequestFailedError, doc.at("lfm").at("error").inner_html
+           end
+        end
+        
+        doc.at("lfm")["status"]
+      end
+ 
     end
     
     def initialize(artist, name)
@@ -96,8 +198,36 @@ module Rockstar
     
     # The session_key is returned by auth.session.key
     def love(session_key)
-      doc = Hpricot::XML(self.class.connection.post("track.love", true, {:track => @name, :artist => @artist, :sk => session_key}))
-      doc.at("lfm")["status"]
+      Track.love(@artist, @name, session_key)
+    end
+
+    # scrobble this track
+    #   time :       a time object set to the time the track started playing
+    #   session_key: the session key you got during authentification
+    def scrobble(time, session_key)
+      Track.scrobble({
+        :session_key => session_key,
+        :time        => time,
+        :track       => @name,
+        :artist      => @artist,
+        :album       => @album,
+        :mbid        => @mbid
+      })
+    end
+
+    # inform last.fm that this track is currently playing
+    #   time :       a time object set to the time the track started playing
+    #   session_key: the session key you got during authentification
+    def updateNowPlaying(time, session_key)
+      Track.updateNowPlaying({
+        :session_key => session_key,
+        :time        => time,
+        :track       => @name,
+        :artist      => @artist,
+        :album       => @album,
+        :mbid        => @mbid
+      })
     end
+
   end
 end

data/rockstar.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rockstar}
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bodo Tasche"]
-  s.date = %q{2010-09-07}
+  s.date = %q{2010-11-23}
   s.description = %q{This gem is an updated version of jnunemakers scrobbler gem. Rockstar uses v2.0 of the last.fm api.}
   s.email = %q{bodo@bitboxer.de}
   s.extra_rdoc_files = [
@@ -68,6 +68,7 @@ Gem::Specification.new do |s|
      "test/fixtures/xml/track/gettopfans_artist_Carrie_Underwood_track_Before_He_Cheats.xml",
      "test/fixtures/xml/track/gettoptags_artist_Carrie_Underwood_track_Before_He_Cheats.xml",
      "test/fixtures/xml/track/love_artist_Carrie_Underwood_sk_tag_track_Before_He_Cheats.xml",
+     "test/fixtures/xml/track/updatenowplaying_artist_Carrie_Underwood_sk_tag_track_Before_He_Cheats.xml",
      "test/fixtures/xml/user/getevents_sk_token_user_bodot.xml",
      "test/fixtures/xml/user/getfriends_user_jnunemaker.xml",
      "test/fixtures/xml/user/getinfo_user_jnunemaker.xml",

data/test/fixtures/xml/track/updatenowplaying_artist_Carrie_Underwood_sk_tag_track_Before_He_Cheats.xml

@@ -0,0 +1,10 @@
+<?xml version='1.0' encoding='utf-8'?>
+<lfm status="ok">
+  <nowplaying>
+    <track corrected="0">Test Track</track>
+    <artist corrected="0">Test Artist</artist>
+    <album corrected="0"></album>
+    <albumArtist corrected="0"></albumArtist>
+    <ignoredMessage code="0"></ignoredMessage>
+  </nowplaying>
+</lfm>

data/test/unit/test_track.rb

@@ -41,4 +41,20 @@ class TestTrack < Test::Unit::TestCase
     assert_equal('ok', @track.love("tag"))  
   end
 
+  test 'raise missing parameter error' do
+    assert_raises(ArgumentError) { Rockstar::Track.scrobble() }
+  end
+
+  test 'can scrobble tracks' do
+    assert_equal('ok', @track.scrobble(Time.new(2010,10,10,10,10), 'tag'))
+  end
+
+  test 'raise missing parameter error' do
+    assert_raises(ArgumentError) { Rockstar::Track.updateNowPlaying() }
+  end
+
+  test 'can send current playing track' do
+    assert_equal('ok', @track.updateNowPlaying(Time.new(2010,10,10,10,10), 'tag'))
+  end
+
 end

data/test/unit/test_user.rb

@@ -264,7 +264,7 @@ class TestUser < Test::Unit::TestCase
     assert_equal("2raumwohnung", first.headliners.first)
     assert_equal(Time.local(2010, 8, 20, 17, 50, 1), first.start_date)
     assert_equal(Time.local(2010, 8, 22, 17, 50, 1), first.end_date)
-    assert_equal(827, first.description.length)
+    assert_equal(814, first.description.length)
     assert_equal(200, first.attendance) 
     assert_equal(0, first.reviews)
     assert_equal("lastfm:event=1575046", first.tag)

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rockstar
 version: !ruby/object:Gem::Version 
-  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Bodo Tasche
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-07 00:00:00 +02:00
+date: 2010-11-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 163
         segments: 
         - 0
         - 4
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 1
         - 4
@@ -111,6 +108,7 @@ files:
 - test/fixtures/xml/track/gettopfans_artist_Carrie_Underwood_track_Before_He_Cheats.xml
 - test/fixtures/xml/track/gettoptags_artist_Carrie_Underwood_track_Before_He_Cheats.xml
 - test/fixtures/xml/track/love_artist_Carrie_Underwood_sk_tag_track_Before_He_Cheats.xml
+- test/fixtures/xml/track/updatenowplaying_artist_Carrie_Underwood_sk_tag_track_Before_He_Cheats.xml
 - test/fixtures/xml/user/getevents_sk_token_user_bodot.xml
 - test/fixtures/xml/user/getfriends_user_jnunemaker.xml
 - test/fixtures/xml/user/getinfo_user_jnunemaker.xml
@@ -158,7 +156,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -167,7 +164,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"