hornairs-scrobbler 0.2.3

data/lib/scrobbler/artist.rb

@@ -0,0 +1,165 @@
+# 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
+    mixins :image, :streamable
+    
+    attr_accessor :name, :mbid, :playcount, :rank, :url, :count
+    attr_accessor :chartposition
+    attr_accessor :match, :tagcount, :listeners
+    
+    class << self
+      def new_from_xml(xml, o={})
+        data = data_from_xml(xml, o)
+        return nil if data[:name].nil?
+        Artist.new(data[:name], data)
+      end
+      
+      def data_from_xml(xml, o={})
+        data = {}
+      
+        # Get all information from the root's children nodes
+        xml.children.each do |child|
+          data[:playcount] = child.content.to_i if child.name == 'playcount'
+          data[:mbid] = child.content if child.name == 'mbid'
+          data[:url] = child.content if child.name == 'url'
+          data[:match] = child.content.to_i if child.name == 'match'
+          data[:tagcount] = child.content.to_i if child.name == 'tagcount'
+          data[:chartposition] = child.content if child.name == 'chartposition'
+          data[:name] = child.content if child.name == 'name'
+          maybe_streamable_node(data, child)
+          maybe_image_node(data, child)
+        end        
+        
+        # If we have not found anything in the content of this node yet then
+        # this must be a simple artist node which has the name of the artist
+        # as its content
+        data[:name] = xml.content if data == {}
+        
+        # Get all information from the root's attributes
+        data[:name] = xml['name'] if xml['name']
+        data[:rank] = xml['rank'].to_i if xml['rank']
+        maybe_streamable_attribute data, xml
+        data[:mbid] = xml['mbid'] if xml['mbid']
+        data
+      end
+    end
+    
+    def initialize(name, data = {})
+      super()
+      raise ArgumentError, "Name is required" if name.blank?
+      @name = name
+      populate_data(data)
+    end
+    
+    @info_loaded = false
+    # Get the metadata
+    def load_info
+        doc = Base.request('artist.getinfo', {'artist' => @name})
+        doc.root.children.each do |child|
+            next unless child.name == 'artist'
+            data = self.class.data_from_xml(child)
+            populate_data(data)
+            @info_loaded = true
+            break
+        end
+    end # load_info
+    
+    
+    # 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 similar(force=false)
+      get_response('artist.getsimilar', :similar, 'similarartists', 'artist', {'artist' => @name}, force)
+    end
+    
+    def top_fans(force=false)
+      get_response('artist.gettopfans', :top_fans, 'topfans', 'user', {'artist' => @name}, force)
+    end
+    
+    def top_tracks(force=false)
+      get_response('artist.gettoptracks', :top_tracks, 'toptracks', 'track', {'artist'=>@name}, force)
+    end
+    
+    def top_albums(force=false)
+      get_response('artist.gettopalbums', :top_albums, 'topalbums', 'album', {'artist'=>@name}, force)
+    end
+    
+    def top_tags(force=false)
+      get_response('artist.gettoptags', :top_tags, 'toptags', 'tag', {'artist' => @name}, force)
+    end
+        
+    def ==(otherArtist)
+      if otherArtist.is_a?(Scrobbler::Artist)
+        return (@name == otherArtist.name)
+      end
+      false
+    end
+    
+  end
+end

data/lib/scrobbler/auth.rb

@@ -0,0 +1,47 @@
+module Scrobbler
+  # @todo everything
+  class Auth < Base
+  
+    def initialize(username)
+      super()
+      @username = username
+    end
+    
+    def session(token)
+      doc = Base.request('auth.getsession', :signed => true, :token => token)
+      asession = {}
+      doc.root.children.each do |child1|
+        next unless child1.name == 'session'
+        child1.children.each do |child2|
+          if child2.name == 'name'
+            asession[:name] = child2.content
+          elsif child2.name == 'key'
+            asession[:key] = child2.content
+          elsif child2.name == 'subscriber'
+            asession[:subscriber] = true if child2.content == '1'
+            asession[:subscriber] = false unless child2.content == '1'
+          end   
+        end
+      end
+      Scrobbler::Session.new(asession)
+    end
+    
+    def token
+      doc = Base.request('auth.gettoken', :signed => true)
+      stoken = ''
+      doc.root.children.each do |child|
+        next unless child.name == 'token'
+        stoken = child.content
+      end
+      stoken
+    end
+    
+    def url(options={})
+      options[:token] = token if options[:token].nil?
+      options[:api_key] = @@api_key
+      "http://www.last.fm/api/auth/?api_key=#{options[:api_key]}&token=#{options[:token]}"
+    end
+    
+  end
+end
+

data/lib/scrobbler/base.rb

@@ -0,0 +1,105 @@
+require 'digest/md5'
+
+$KCODE = 'u'
+
+include LibXML
+
+module Scrobbler
+  
+  API_URL     = 'http://ws.audioscrobbler.com/'
+  
+class Base
+    def Base.api_key=(api_key) 
+        @@api_key = api_key
+    end
+
+    def Base.secret=(secret)
+        @@secret = secret
+    end
+
+    def Base.connection
+        @connection ||= REST::Connection.new(API_URL)
+    end
+    
+    def Base.sanitize(param)
+      URI.escape(param.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+    
+    def Base.get(api_method, parent, element, parameters = {})
+        scrobbler_class = "scrobbler/#{element.to_s}".camelize.constantize
+        doc = request(api_method, parameters)
+        elements = []
+        doc.root.children.each do |child|
+            next unless child.name == parent.to_s
+            child.children.each do |child2|
+                next unless child2.name == element.to_s
+                elements << scrobbler_class.new_from_xml(child2)
+            end
+        end
+        elements
+    end
+
+    def Base.post_request(api_method, parameters = {}, request_method = 'get')
+      Base.request(api_method, parameters, 'post')
+    end
+
+    def Base.request(api_method, parameters = {}, request_method = 'get')
+      parameters = {:signed => false}.merge(parameters)
+      parameters['api_key'] = @@api_key
+      parameters['method'] = api_method.to_s
+      paramlist = []
+      # Check if we want a signed call and pop :signed
+      if parameters.delete :signed
+        #1: Sort alphabetically
+        params = parameters.sort{|a,b| a[0].to_s<=>b[0].to_s}
+        #2: concat them into one string
+        str = params.join('')
+        #3: Append secret
+        str = str + @@secret
+        #4: Make a md5 hash
+        md5 = Digest::MD5.hexdigest(str)
+        params << [:api_sig, md5]
+        params.each do |a|
+          paramlist << "#{sanitize(a[0])}=#{sanitize(a[1])}"
+        end
+      else
+        parameters.each do |key, value|
+          paramlist << "#{sanitize(key)}=#{sanitize(value)}"
+        end
+      end
+      url = '/2.0/?' + paramlist.join('&')
+      XML::Document.string(self.connection.send(request_method,url))
+    end
+    
+    
+    private
+      
+    def Base.mixins(*args)
+      args.each do |arg|
+        if arg == :image
+          extend Scrobbler::ImageClassFuncs
+          include Scrobbler::ImageObjectFuncs
+        elsif arg == :streamable
+          attr_reader :streamable
+          extend StreamableClassFuncs
+          include StreamableObjectFuncs
+        else
+          raise ArgumentError, "#{arg} is not a known mixin"
+        end
+      end
+    end
+    
+      def populate_data(data = {})
+        data.each do |key, value|
+          instance_variable_set("@#{key.to_s}", value)
+        end
+      end
+
+      def get_response(api_method, instance_name, parent, element, params, force=false)
+        if instance_variable_get("@#{instance_name}").nil? || force
+            instance_variable_set("@#{instance_name}", Base.get(api_method, parent, element, params))
+        end
+        instance_variable_get("@#{instance_name}")
+      end
+end # class Base
+end # module Scrobbler

data/lib/scrobbler/event.rb

@@ -0,0 +1,105 @@
+module Scrobbler
+  class Event < Base
+    # Load Helper modules
+    include ImageObjectFuncs
+    extend  ImageClassFuncs
+    
+    attr_accessor :id, :title, :start_date, :start_time, :description
+    attr_accessor :reviews, :tag, :url, :artists, :headliner, :image_small
+    attr_accessor :image_medium, :image_large, :attendance, :venue
+    
+    class << self
+
+      def update_or_create_from_xml(xml, event=nil)
+        data = {}
+        artists = []
+        headliner = nil
+        venue = nil
+
+        xml.children.each do |child|
+          data[:id] = child.content.to_i if child.name == 'id'
+          data[:title] = child.content if child.name == 'title'
+
+          if child.name == 'artists'
+            child.children.each do |artist_element|
+              artists << Artist.new(artist_element.content) if artist_element.name == 'artist'
+              headliner = Artist.new(artist_element.content) if artist_element.name == 'headliner'
+            end
+            artists << headliner unless headliner.nil? || headliner_alrady_listed_in_artist_list?(artists,headliner)
+          end
+
+          maybe_image_node(data, child)
+          data[:url] = child.content if child.name == 'url'
+          data[:description] = child.content if child.name == 'description'
+          data[:attendance] = child.content.to_i if child.name == 'attendance'
+          data[:reviews]    = child.content.to_i if child.name == 'reviews'
+          data[:tag]        = child.content if child.name == 'tag'
+          data[:start_date] = Time.parse(child.content) if child.name == 'startDate'
+          data[:start_time] = child.content if child.name == 'startTime'
+          venue = Venue.new_from_xml(child) if child.name == 'venue'
+        end
+
+        if event.nil?
+          event = Event.new(data[:id],data)
+        else
+          event.send :populate_data, data
+        end
+
+        event.artists = artists.uniq
+        event.headliner = headliner
+        event.venue = venue
+        event
+      end
+
+      def headliner_alrady_listed_in_artist_list?(artists,headliner)
+        artists.each do |artist|
+          return true if artist.name == headliner.name
+        end
+        false
+      end
+
+      def new_from_libxml(xml)
+        update_or_create_from_xml(xml)
+      end
+    end
+
+    def initialize(id,input={})
+      raise ArgumentError if id.blank?
+      @id = id
+      populate_data(input)
+      load_info() if input[:include_info]
+    end
+
+    def shouts(force = false)
+      get_response('event.getshouts', :shouts, 'shouts', 'shout', {'event'=>@id}, force)
+    end
+
+    def attendees(force = false)
+      get_response('event.getattendees', :attendees, 'attendees', 'user', {'event'=>@id}, force)
+    end
+
+    def shout
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def attend(session, attendance_status)
+      doc = Base.post_request('event.attend',{:event => @id, :signed => true, :status => attendance_status, :sk => session.key})
+    end
+
+    def share
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    # Load additional informatalbumion about this event
+    #
+    # Calls "event.getinfo" REST method
+    def load_info
+      doc = Base.request('event.getinfo', {'event' => @id})
+      doc.root.children.each do |child|        
+        Event.update_or_create_from_xml(child, self) if child.name == 'event'
+      end      
+    end
+  end
+end

data/lib/scrobbler/geo.rb

@@ -0,0 +1,27 @@
+module Scrobbler
+  class Geo < Base
+
+    # Gets a list of events based on the location that
+    # the Geo object is set to
+    def events(options={})
+      options = set_default_options(options)
+      get_response('geo.getevents', :events, 'events', 'event', options, options[:force])
+    end
+
+    def top_artists(options={})
+      options = set_default_options(options)
+      get_response('geo.gettopartists', :artists, 'topartists', 'artist', options, options[:force])
+    end
+
+    def top_tracks(options={})
+      options = set_default_options(options)
+      get_response('geo.gettoptracks', :tracks, 'toptracks', 'track', options, options[:force])
+    end
+
+    private
+
+    def set_default_options(options={})
+      {:force => false, :page => 1}.merge options
+    end
+  end
+end