peteforde-scrobbler 0.2.3

data/lib/scrobbler/artist.rb

@@ -0,0 +1,127 @@
+# Below are examples of how to find an artists top tracks and similar artists.
+# 
+#   artist = Scrobbler::Artist.new('Carrie Underwood')
+# 
+#   puts 'Top Tracks'
+#   puts "=" * 10
+#   artist.top_tracks.each { |t| puts "(#{t.reach}) #{t.name}" }
+# 
+#   puts
+# 
+#   puts 'Similar Artists'
+#   puts "=" * 15
+#   artist.similar.each { |a| puts "(#{a.match}%) #{a.name}" }
+# 
+# Would output something similar to:
+# 
+#   Top Tracks
+#   ==========
+#   (8797) Before He Cheats
+#   (3574) Don't Forget to Remember Me
+#   (3569) Wasted
+#   (3246) Some Hearts
+#   (3142) Jesus, Take the Wheel
+#   (2600) Starts With Goodbye
+#   (2511) Jesus Take The Wheel
+#   (2423) Inside Your Heaven
+#   (2328) Lessons Learned
+#   (2040) I Just Can't Live a Lie
+#   (1899) Whenever You Remember
+#   (1882) We're Young and Beautiful
+#   (1854) That's Where It Is
+#   (1786) I Ain't in Checotah Anymore
+#   (1596) The Night Before (Life Goes On)
+#   
+#   Similar Artists
+#   ===============
+#   (100%) Rascal Flatts
+#   (84.985%) Keith Urban
+#   (84.007%) Kellie Pickler
+#   (82.694%) Katharine McPhee
+#   (81.213%) Martina McBride
+#   (79.397%) Faith Hill
+#   (77.121%) Tim McGraw
+#   (75.191%) Jessica Simpson
+#   (75.182%) Sara Evans
+#   (75.144%) The Wreckers
+#   (73.034%) Kenny Chesney
+#   (71.765%) Dixie Chicks
+#   (71.084%) Kelly Clarkson
+#   (69.535%) Miranda Lambert
+#   (66.952%) LeAnn Rimes
+#   (66.398%) Mandy Moore
+#   (65.817%) Bo Bice
+#   (65.279%) Diana DeGarmo
+#   (65.115%) Gretchen Wilson
+#   (62.982%) Clay Aiken
+#   (62.436%) Ashlee Simpson
+#   (62.160%) Christina Aguilera
+module Scrobbler
+  class Artist < Base
+    attr_accessor :name, :mbid, :playcount, :rank, :url, :thumbnail, :image, :reach, :count, :streamable
+    attr_accessor :chartposition
+    
+    # used for similar artists
+    attr_accessor :match
+    
+    class << self
+      def new_from_xml(xml, doc=nil)
+        name             = (xml).at(:name).inner_html           if (xml).at(:name)
+        # occasionally name can be found in root of artist element (<artist name="">) rather than as an element (<name>)
+        name             = xml['name']                          if name.nil? && xml['name']
+        a                = Artist.new(name)
+        a.mbid           = (xml).at(:mbid).inner_html           if (xml).at(:mbid)
+        a.playcount      = (xml).at(:playcount).inner_html      if (xml).at(:playcount)
+        a.rank           = (xml).at(:rank).inner_html           if (xml).at(:rank)
+        a.url            = (xml).at(:url).inner_html            if (xml).at(:url)
+        a.thumbnail      = (xml).at(:thumbnail).inner_html      if (xml).at(:thumbnail)
+        a.thumbnail      = (xml).at(:image_small).inner_html    if a.thumbnail.nil? && (xml).at(:image_small)
+        a.image          = (xml).at(:image).inner_html          if (xml).at(:image)
+        a.reach          = (xml).at(:reach).inner_html          if (xml).at(:reach)
+        a.match          = (xml).at(:match).inner_html          if (xml).at(:match)
+        a.chartposition = (xml).at(:chartposition).inner_html  if (xml).at(:chartposition)
+
+        # in top artists for tag
+        a.count          = xml['count']                         if xml['count']
+        a.streamable     = xml['streamable']                    if xml['streamable']
+        a.streamable     = (xml).at(:streamable).inner_html == '1' ? 'yes' : 'no' if a.streamable.nil? && (xml).at(:streamable)
+        a
+      end
+    end
+    
+    def initialize(name)
+      raise ArgumentError, "Name is required" if name.blank?
+      @name = name
+    end
+    
+    def api_path(version=nil)
+      "/#{version || API_VERSION}/artist/#{CGI::escape(name)}"
+    end
+    
+    def current_events(format=:ics)
+      format = :ics if format.to_s == 'ical'
+      raise ArgumentError unless ['ics', 'rss'].include?(format.to_s)
+      "#{API_URL.chop}#{api_path}/events.#{format}"
+    end
+    
+    def similar(force=false)
+      get_instance(:similar, :similar, :artist, force)
+    end
+    
+    def top_fans(force=false)
+      get_instance(:fans, :top_fans, :user, force)
+    end
+    
+    def top_tracks(force=false)
+      get_instance(:toptracks, :top_tracks, :track, force)
+    end
+    
+    def top_albums(force=false)
+      get_instance(:topalbums, :top_albums, :album, force)
+    end
+    
+    def top_tags(force=false)
+      get_instance(:toptags, :top_tags, :tag, force)
+    end
+  end
+end

data/lib/scrobbler/base.rb

@@ -0,0 +1,29 @@
+module Scrobbler
+  
+  API_URL     = 'http://ws.audioscrobbler.com/'
+  API_VERSION = '1.0'
+  
+  class Base
+    class << self
+      def connection
+        @connection ||= REST::Connection.new(API_URL)
+      end
+      
+      def fetch_and_parse(resource)
+        Hpricot::XML(connection.get(resource))
+      end
+    end
+    
+    private
+      # in order for subclass to use, it must have api_path method
+      def get_instance(api_method, instance_name, element, force=false, version=nil)
+        scrobbler_class = "scrobbler/#{element.to_s}".camelize.constantize
+        if instance_variable_get("@#{instance_name}").nil? || force
+          doc      = self.class.fetch_and_parse("#{api_path(version)}/#{api_method}.xml")
+          elements = (doc/element).inject([]) { |elements, el| elements << scrobbler_class.new_from_xml(el, doc); elements }
+          instance_variable_set("@#{instance_name}", elements)
+        end
+        instance_variable_get("@#{instance_name}")
+      end
+  end
+end

data/lib/scrobbler/chart.rb

@@ -0,0 +1,31 @@
+module Scrobbler
+  class Chart < Base
+    class << self
+      def new_from_xml(xml, doc)
+        Chart.new(xml['from'], xml['to'])
+      end
+    end
+    def initialize(from, to)
+      raise ArgumentError, "From is required" if from.blank?
+      raise ArgumentError, "To is required" if to.blank?
+      @from = from
+      @to = to
+    end
+    
+    def from=(value)
+      @from = value.to_i
+    end
+    
+    def to=(value)
+      @to = value.to_i
+    end
+    
+    def from
+      @from.to_i
+    end
+    
+    def to
+      @to.to_i
+    end
+  end
+end

data/lib/scrobbler/playing.rb

@@ -0,0 +1,49 @@
+module Scrobbler
+  class Playing
+    # you should read last.fm/api/submissions#np first!
+
+    attr_accessor :session_id, :now_playing_url, :artist, :track,
+                  :album, :length, :track_number, :mb_track_id
+    attr_reader :status
+
+    def initialize(args = {})
+      @session_id = args[:session_id] # from Scrobbler::SimpleAuth
+      @now_playing_url = args[:now_playing_url] # from Scrobbler::SimpleAuth (can change)
+      @artist = args[:artist] # track artist
+      @track = args[:track] # track name
+      @album = args[:album] || '' # track album (optional)
+      @length = args[:length] || '' # track length in seconds (optional)
+      @track_number = args[:track_number] || '' # track number (optional)
+      @mb_track_id = args[:mb_track_id] || '' # MusicBrainz track ID (optional)
+
+      if [@session_id, @now_playing_url, @artist, @track].any?(&:blank?)
+        raise ArgumentError, 'Missing required argument'
+      elsif !@length.to_s.empty? && @length.to_i <= 30 # see last.fm/api
+        raise ArgumentError, 'Length must be greater than 30 seconds'
+      end 
+
+      @connection = REST::Connection.new(@now_playing_url)
+    end
+
+    def submit!
+      query = { :s => @session_id,
+                :a => @artist,
+                :t => @track,
+                :b => @album,
+                :l => @length,
+                :n => @track_number,
+                :m => @mb_track_id }
+
+      @status = @connection.post('', query)
+
+      case @status
+      when /OK/
+
+      when /BADSESSION/
+        raise BadSessionError # rerun Scrobbler::SimpleAuth#handshake!
+      else
+        raise RequestFailedError
+      end
+    end
+  end
+end

data/lib/scrobbler/rest.rb

@@ -0,0 +1,51 @@
+require 'net/https'
+
+module Scrobbler
+  module REST
+  	class Connection
+  		def initialize(base_url, args = {})
+  			@base_url = base_url
+  			@username = args[:username]
+  			@password = args[:password]
+  		end
+
+  		def get(resource, args = nil)
+  			request(resource, "get", args)
+  		end
+
+  		def post(resource, args = nil)
+  			request(resource, "post", args)
+  		end
+
+  		def request(resource, method = "get", args = nil)
+  			url = URI.join(@base_url, resource)
+
+  			if args
+  				url.query = args.map { |k,v| "%s=%s" % [escape(k.to_s), escape(v.to_s)] }.join("&")
+  			end
+
+  			case method
+  			when "get"
+  				req = Net::HTTP::Get.new(url.request_uri)
+  			when "post"
+  				req = Net::HTTP::Post.new(url.request_uri)
+  			end
+
+  			if @username and @password
+  				req.basic_auth(@username, @password)
+  			end
+
+  			http = Net::HTTP.new(url.host, url.port)
+  			http.use_ssl = (url.port == 443)
+
+  			res = http.start() { |conn| conn.request(req) }
+  			res.body
+  		end
+  		
+  		private
+  		  def escape(str)
+  		    URI.escape(str, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+  		  end
+  	end
+  end
+end

data/lib/scrobbler/scrobble.rb

@@ -0,0 +1,66 @@
+# exception definitions
+class BadSessionError < StandardError; end
+class RequestFailedError < StandardError; end
+
+module Scrobbler
+  class Scrobble
+    # you need to read last.fm/api/submissions#subs first!
+
+    attr_accessor :session_id, :submission_url, :artist, :track, :time,
+                  :source, :length, :album, :track_number, :mb_track_id
+    attr_reader :status
+
+    def initialize(args = {})
+      @session_id = args[:session_id] # from Scrobbler::SimpleAuth
+      @submission_url = args[:submission_url] # from Scrobbler::SimpleAuth (can change)
+      @artist = args[:artist] # track artist
+      @track = args[:track] # track name
+      @time = args[:time] # a Time object set to the time the track started playing
+      @source = args[:source] || 'P' # track source, see last.fm/api/submissions#subs
+      @length = args[:length].to_s || '' # track length in seconds
+      @album = args[:album] || '' # track album name (optional)
+      @track_number = args[:track_number] || '' # track number (optional)
+      @mb_track_id = args[:mb_track_id] || '' # MusicBrainz track ID (optional)
+
+      if [@session_id, @submission_url, @artist, @track].any?(&:blank?)
+        raise ArgumentError, 'Missing required argument'
+      elsif @time.class.to_s != 'Time'
+        raise ArgumentError, ":time must be a Time object"
+      elsif !['P','R','E','U'].include?(@source) # see last.fm/api/submissions#subs
+        raise ArgumentError, "Invalid source"
+      elsif @source == 'P' && @length.blank? # length is not optional if source is P
+        raise ArgumentError, 'Length must be set'
+      elsif !@length.blank? && @length.to_i <= 30 # see last.fm/api/submissions#subs
+        raise ArgumentError, 'Length must be greater than 30 seconds'
+      end
+
+      @connection = REST::Connection.new(@submission_url)
+    end
+
+    def submit!
+      query = { :s => @session_id,
+                'a[0]' => @artist,
+                't[0]' => @track,
+                'i[0]' => @time.utc.to_i,
+                'o[0]' => @source,
+                'r[0]' => '',
+                'l[0]' => @length,
+                'b[0]' => @album,
+                'n[0]' => @track_number,
+                'm[0]' => @mb_track_id }
+                
+      @status = @connection.post('', query)
+
+      case @status
+      when /OK/
+
+      when /BADSESSION/
+        raise BadSessionError # rerun Scrobbler::SimpleAuth#handshake!
+      when /FAILED/
+        raise RequestFailedError, @status
+      else
+        raise RequestFailedError
+      end
+    end
+  end
+end

data/lib/scrobbler/simpleauth.rb

@@ -0,0 +1,59 @@
+require 'digest/md5'
+
+# exception definitions
+class BadAuthError < StandardError; end
+class BannedError < StandardError; end
+class BadTimeError < StandardError; end
+module Scrobbler
+  AUTH_URL = 'http://post.audioscrobbler.com'
+  AUTH_VER = '1.2.1'
+  
+  class SimpleAuth
+    # you should read last.fm/api/submissions#handshake
+
+    attr_accessor :user, :password, :client_id, :client_ver
+    attr_reader :status, :session_id, :now_playing_url, :submission_url
+
+    def initialize(args = {})
+      @user = args[:user] # last.fm username
+      @password = args[:password] # last.fm password
+      @client_id = 'rbs' # Client ID assigned by last.fm; Don't change this!
+      @client_ver = Scrobbler::Version
+
+      raise ArgumentError, 'Missing required argument' if @user.blank? || @password.blank?
+
+      @connection = REST::Connection.new(AUTH_URL)
+    end
+
+    def handshake!
+      password_hash = Digest::MD5.hexdigest(@password)
+      timestamp = Time.now.to_i.to_s
+      token = Digest::MD5.hexdigest(password_hash + timestamp)
+
+      query = { :hs => 'true',
+                :p => AUTH_VER,
+                :c => @client_id,
+                :v => @client_ver,
+                :u => @user,
+                :t => timestamp,
+                :a => token }
+      result = @connection.get('/', query)
+
+      @status = result.split(/\n/)[0]
+      case @status
+      when /OK/
+        @session_id, @now_playing_url, @submission_url = result.split(/\n/)[1,3]
+      when /BANNED/
+        raise BannedError # something is wrong with the gem, check for an update
+      when /BADAUTH/
+        raise BadAuthError # invalid user/password
+      when /FAILED/
+        raise RequestFailedError, @status
+      when /BADTIME/
+        raise BadTimeError # system time is way off
+      else
+        raise RequestFailedError
+      end  
+    end
+  end
+end

data/lib/scrobbler/tag.rb

@@ -0,0 +1,104 @@
+# Below is code samples for how to find the top albums and tracks for a tag.
+# 
+#   tag = Scrobbler::Tag.new('country')
+# 
+#   puts 'Top Albums'
+#   tag.top_albums.each { |a| puts "(#{a.count}) #{a.name} by #{a.artist}" }
+# 
+#   puts
+# 
+#   puts 'Top Tracks'
+#   tag.top_tracks.each { |t| puts "(#{t.count}) #{t.name} by #{t.artist}" }
+#   
+# Which would output something similar to:
+# 
+#   Top Albums
+#   (29) American IV: The Man Comes Around by Johnny Cash
+#   (14) Folks Pop In at the Waterhouse by Various Artists
+#   (13) Hapless by Flowers From The Man Who Shot Your Cousin
+#   (9) Taking The Long Way by Dixie Chicks
+#   (8) Unchained by Johnny Cash
+#   (8) American III: Solitary Man by Johnny Cash
+#   (8) Wide Open Spaces by Dixie Chicks
+#   (7) It's Now or Later by Tangled Star
+#   (7) Greatest Hits by Hank Williams
+#   (7) American Recordings by Johnny Cash
+#   (6) Forgotten Landscape by theNoLifeKing
+#   (6) At Folsom Prison by Johnny Cash
+#   (6) Fox Confessor Brings the Flood by Neko Case
+#   (6) Murder by Johnny Cash
+#   (5) Gloom by theNoLifeKing
+#   (5) Set This Circus Down by Tim McGraw
+#   (5) Blacklisted by Neko Case
+#   (5) Breathe by Faith Hill
+#   (5) Unearthed (disc 4: My Mother's Hymn Book) by Johnny Cash
+#   (4) Home by Dixie Chicks
+# 
+#   Top Tracks
+#   (221) Hurt by Johnny Cash
+#   (152) I Walk the Line by Johnny Cash
+#   (147) Ring of Fire by Johnny Cash
+#   (125) Folsom Prison Blues by Johnny Cash
+#   (77) The Man Comes Around by Johnny Cash
+#   (67) Personal Jesus by Johnny Cash
+#   (65) Not Ready To Make Nice by Dixie Chicks
+#   (63) Before He Cheats by Carrie Underwood
+#   (62) Give My Love to Rose by Johnny Cash
+#   (49) Jackson by Johnny Cash
+#   (49) What Hurts The Most by Rascal Flatts
+#   (48) Big River by Johnny Cash
+#   (46) Man in Black by Johnny Cash
+#   (46) Jolene by Dolly Parton
+#   (46) Friends in Low Places by Garth Brooks
+#   (46) One by Johnny Cash
+#   (44) Cocaine Blues by Johnny Cash
+#   (41) Get Rhythm by Johnny Cash
+#   (41) I Still Miss Someone by Johnny Cash
+#   (40) The Devil Went Down to Georgia by Charlie Daniels Band
+module Scrobbler
+  class Tag < Base
+    attr_accessor :name, :count, :url
+    
+    class << self
+      def new_from_xml(xml, doc=nil)
+        name    = (xml).at(:name).inner_html
+        t       = Tag.new(name)
+        t.count = (xml).at(:count).inner_html
+        t.url   = (xml).at(:url).inner_html
+        t
+      end
+      
+      def top_tags
+        doc = fetch_and_parse("/#{API_VERSION}/tag/toptags.xml")
+        @top_tags = (doc/:tag).inject([]) do |tags, tag|
+          t       = Tag.new(tag['name'])
+          t.count = tag['count']
+          t.url   = tag['url']
+          tags << t
+          tags
+        end
+      end
+    end
+    
+    def initialize(name)
+      raise ArgumentError, "Name is required" if name.blank?
+      @name = name
+    end
+    
+    def api_path(version=nil)
+      "/#{version || API_VERSION}/tag/#{CGI::escape(name)}"
+    end
+    
+    def top_artists(force=false)
+      get_instance(:topartists, :top_artists, :artist, force)
+    end
+    
+    def top_albums(force=false)
+      get_instance(:topalbums, :top_albums, :album, force)
+    end
+
+    def top_tracks(force=false)
+      get_instance(:toptracks, :top_tracks, :track, force)
+    end
+  end
+end