xhochy-scrobbler 0.2.14

data/lib/scrobbler/artist.rb

@@ -0,0 +1,134 @@
+# 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
+  # @todo Add missing functions that require authentication
+  # @todo Integrate search functionality into this class which is already implemented in Scrobbler::Search
+  class Artist < Base
+    attr_accessor :name, :mbid, :playcount, :rank, :url, :count, :streamable
+    attr_accessor :chartposition, :image_small, :image_medium, :image_large
+    
+    # used for similar artists
+    attr_accessor :match
+    
+    class << self
+      def new_from_xml(xml, doc=nil)
+        # occasionally name can be found in root of artist element (<artist name="">) rather than as an element (<name>)
+        name             = Base::sanitize(xml['name'])          if name.nil? && xml['name']
+        name         = Base::sanitize(xml.at('/name').inner_html) if name.nil? && (xml).at(: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           = Base::sanitize(xml['rank'])           if xml['rank']
+        a.url            = xml.at(:url).inner_html            if xml.at(:url)
+        a.image_small  = xml.at("image[@size='small']").inner_html   if xml.at("image[@size='small']")
+        a.image_medium = xml.at("image[@size='medium']'").inner_html if xml.at("image[@size='medium']'")
+        a.image_large  = xml.at("image[@size='large']'").inner_html  if xml.at("image[@size='large']'")
+        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.at('/tagcount').inner_html    if xml.at('/tagcount')
+        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
+    
+    # Get the URL to the ical or rss representation of the current events that
+    # a artist will play
+    #
+    # @todo Use the API function and parse that into a common ruby structure
+    def current_events(format=:ics)
+      format = :ics if format.to_s == 'ical'
+      raise ArgumentError unless ['ics', 'rss'].include?(format.to_s)
+      "#{API_URL.chop}/2.0/artist/#{CGI::escape(name)}/events.#{format}"
+    end
+    
+    def image(which=:small)
+      which = which.to_s
+      raise ArgumentError unless ['small', 'medium', 'large'].include?(which)      
+      instance_variable_get("@image_#{which}")
+    end
+    
+    def similar(force=false)
+      get_instance2('artist.getsimilar', :similar, :artist, {'artist'=>@name}, force)
+    end
+    
+    def top_fans(force=false)
+      get_instance2('artist.gettopfans', :top_fans, :user, {'artist'=>@name}, force)
+    end
+    
+    def top_tracks(force=false)
+      get_instance2('artist.gettoptracks', :top_tracks, :track, {'artist'=>@name}, force)
+    end
+    
+    def top_albums(force=false)
+      get_instance2('artist.gettopalbums', :top_albums, :album, {'artist'=>@name}, force)
+    end
+    
+    def top_tags(force=false)
+      get_instance2('artist.gettoptags', :top_tags, :tag, {'artist'=>@name}, force)
+    end
+  end
+end

data/lib/scrobbler/base.rb

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'cgi'
+require 'htmlentities'
+
+$KCODE = 'u'
+
+module Scrobbler
+  
+  API_URL     = 'http://ws.audioscrobbler.com/'
+  API_VERSION = '1.0'
+  
+  class Base
+    def Base.api_key=(api_key)
+        @@api_key = api_key
+    end
+
+    @@coder = HTMLEntities.new
+    
+    # Decode HTML Entities so that we have plain strings in out code
+    def Base.sanitize(string)
+       @@coder.decode(string)
+    end
+
+    class << self
+      def connection
+        @connection ||= REST::Connection.new(API_URL)
+      end
+      
+      def fetch_and_parse(resource)
+        Hpricot::XML(connection.get(resource))
+      end
+      
+    end
+    
+    private
+      def request(api_method, parameters)
+        parameters['api_key'] = @@api_key
+        parameters['method'] = api_method.to_s
+        paramlist = []
+        parameters.each do |key, value|
+          paramlist <<  "#{CGI::escape(key)}=#{CGI::escape(value)}"
+        end
+        
+        self.class.fetch_and_parse('/2.0/?' + paramlist.join('&'))
+      end
+
+      def get_instance2(api_method, instance_name, element, parameters = {}, force=false)
+        scrobbler_class = "scrobbler/#{element.to_s}".camelize.constantize
+        if instance_variable_get("@#{instance_name}").nil? || force
+          # Add the API key and the method to the parameters, they are always required
+          parameters['api_key'] = @@api_key
+          parameters['method'] = api_method.to_s
+
+          # url-escape all parameters
+          paramlist = []
+          parameters.each do |key, value|
+            paramlist <<  "#{CGI::escape(key)}=#{CGI::escape(value)}"
+          end
+          
+          # Fetch data
+          doc = self.class.fetch_and_parse('/2.0/?' + paramlist.join('&'));
+          elements = (doc/element).inject([]) do |elements, el|
+            elements << scrobbler_class.new_from_xml(el, doc);
+            elements
+          end
+          instance_variable_set("@#{instance_name}", elements)
+        end
+        instance_variable_get("@#{instance_name}")
+      end
+
+      # in order for subclass to use, it must have api_path method
+      def get_instance(api_method, instance_name, element, force=false)
+        scrobbler_class = "scrobbler/#{element.to_s}".camelize.constantize
+        if instance_variable_get("@#{instance_name}").nil? || force
+          doc      = self.class.fetch_and_parse("#{api_path}/#{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,47 @@
+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
+  				# TODO: What about keys without value?
+  				url.query = args.map { |k,v| "%s=%s" % [URI.encode(k.to_s), URI.encode(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
+  	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/search.rb

@@ -0,0 +1,60 @@
+#
+# This is an interface to the Last.FM Search API.
+# It currently allows you to search by album, artist, or track.
+#
+
+module Scrobbler
+  class Search < Base
+    attr_accessor :type, :query, :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def execute
+      doc = self.class.fetch_and_parse(api_path)
+      results = []
+      if type == 'album'
+        (doc/"//album").each do |album|
+          artist = album/"artist"
+          name = album/"name"
+          results << Album.new(artist.inner_html, name.inner_html, :include_info => true)
+        end
+      elsif type == 'artist'
+        (doc/"//artist/name").each do |name|
+          results << Artist.new(name.inner_html)
+        end
+      elsif type == 'track'
+        (doc/"//track").each do |track|
+          artist = track/"artist"
+          name = track/"name"
+          results << Track.new(artist.inner_html, name.inner_html)
+        end
+      end
+      results
+    end
+
+    def by_album(album_name)
+      @type = 'album'
+      @query = album_name
+      execute
+    end
+
+    def by_artist(artist_name)
+      @type = 'artist'
+      @query = artist_name
+      execute
+    end
+
+    def by_track(track_name)
+      @type = 'track'
+      @query = track_name
+      execute
+    end
+
+    def api_path
+      "/2.0/?method=#{type}.search&#{type}=#{CGI::escape(query)}&api_key=#{api_key}"
+    end
+
+  end
+end