scrobbler-ng 2.0.0 → 2.0.1

data/.gitignore

@@ -9,3 +9,6 @@ coverage
 spec.html
 catalog.xml
 .yardoc
+scrobbler-ng.gemspec
+tmp
+.project

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
 :minor: 0
-:patch: 0
+:patch: 1
 :major: 2
+:build: 

data/lib/scrobbler/album.rb

@@ -1,112 +1,106 @@
-# Getting information about an album such as release date and the tracks on it is very easy.
-# 
-#   album = Scrobbler::Album.new('Carrie Underwood', 'Some Hearts', :include_info => true)
-# 
-#   puts "Album: #{album.name}"
-#   puts "Artist: #{album.artist}"
-#   puts "Reach: #{album.reach}"
-#   puts "URL: #{album.url}"
-#   puts "Release Date: #{album.release_date.strftime('%m/%d/%Y')}"
-# 
-#   puts
-#   puts
-# 
-#   puts "Tracks"
-#   longest_track_name = album.tracks.collect(&:name).sort { |x, y| y.length <=> x.length }.first.length
-#   puts "=" * longest_track_name
-#   album.tracks.each { |t| puts t.name }
-#
-# Would output:
-#
-#   Album: Some Hearts
-#   Artist: Carrie Underwood
-#   Reach: 18729
-#   URL: http://www.last.fm/music/Carrie+Underwood/Some+Hearts
-#   Release Date: 11/15/2005
-# 
-# 
-#   Tracks
-#   ===============================
-#   Wasted
-#   Don't Forget to Remember Me
-#   Some Hearts
-#   Jesus, Take the Wheel
-#   The Night Before (Life Goes On)
-#   Lessons Learned
-#   Before He Cheats
-#   Starts With Goodbye
-#   I Just Can't Live a Lie
-#   We're Young and Beautiful
-#   That's Where It Is
-#   Whenever You Remember
-#   I Ain't in Checotah Anymore
-#   Inside Your Heaven
-#
+# encoding: utf-8
+
+require File.expand_path('basexml.rb', File.dirname(__FILE__))
+
 module Scrobbler
   # @todo Add missing functions that require authentication
-  class Album < Base
-    mixins :image
+  class Album < BaseXml
+    include Scrobbler::ImageObjectFuncs
     
     attr_reader :artist, :artist_mbid, :name, :mbid, :playcount, :rank, :url
     attr_reader :reach, :release_date, :listeners, :playcount, :top_tags
-    attr_reader :image_large, :image_medium, :image_small, :tagcount
-    
-    # needed on top albums for tag
-    attr_reader :count
+    attr_reader :count, :chartposition, :position, :tagcount
     
-    # needed for weekly album charts
-    attr_reader :chartposition, :position
-    
-    class << self
-      def new_from_libxml(xml)
-        data = {}
-
-        xml.children.each do |child|
-          data[:name] = child.content if ['name', 'title'].include?(child.name)
-          data[:playcount] = child.content.to_i if child.name == 'playcount'
-          data[:tagcount] = child.content.to_i if child.name == 'tagcount'
-          data[:mbid] = child.content if child.name == 'mbid'
-          data[:url] = child.content if child.name == 'url'
-          data[:artist] = Artist.new_from_libxml(child) if child.name == 'artist'
-          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[:mbid] = xml['mbid'] if xml['mbid']
-        data[:rank] = xml['rank'].to_i if xml['rank']
-        data[:position] = xml['position'].to_i if xml['position']
-        
-        # If there is no name defined, than this was an empty album tag
-        return nil if data[:name].empty?
-        
-        Album.new(data[:name], data)
-      end
+    # Alias for Album.new(:xml => xml)
+    #
+    # @deprecated
+    def self.new_from_libxml(xml)
+      Album.new(:xml => xml)
     end
       
+    def search
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    # Create a new Scrobbler::Artist instance
+    #
     # If the additional parameter :include_info is set to true, additional 
     # information is loaded
     #
     # @todo Albums should be able to be created via a MusicBrainz id too
-    def initialize(name, input={})
-      super()      
-      # Support old version of initialize where we had (artist_name, album_name)
-      if input.class == String
-        data = {:artist => name, :name => input}
-        name = input, input = data
-      end
-      data = {:include_profile => false}.merge(input)
-      raise ArgumentError, "Artist or mbid is required" if data[:artist].nil? && data[:mbid].nil?
-      raise ArgumentError, "Name is required" if name.empty?
-      @name = name
-      populate_data(data)
-      load_info() if data[:include_info]
+    #
+    # @param [Hash] data The options to initialize the class
+    def initialize(data={})
+      raise ArgumentError unless data.kind_of?(Hash)
+      super(data)
+      data = {:include_info => false}.merge(data)
+      # Load data given as method-parameter
+      load_info() if data.delete(:include_info)
+      populate_data(data)      
+      
+      raise ArgumentError, "Artist or mbid is required" if @artist.nil? && @mbid.nil?
+      raise ArgumentError, "Name is required" if @name.empty?
     end
     
+    # Load the data for this object out of a XML-Node
+    #
+    # @param [LibXML::XML::Node] node The XML node containing the information
+    # @return [nil]
+    def load_from_xml(node)
+      # Get all information from the root's children nodes
+      node.children.each do |child|
+        case child.name.to_s
+          when 'name'
+            @name = child.content
+          when 'title'
+            @name = child.content
+          when 'playcount'
+            @playcount = child.content.to_i
+          when 'tagcount'
+            @tagcount = child.content.to_i
+          when 'mbid'
+            @mbid = child.content
+          when 'url'
+            @url = child.content
+          when 'artist'
+            @artist = Artist.new(:xml => child)
+          when 'image'
+            check_image_node(child)
+          when 'id'
+            @id = child.content.to_s
+          when 'releasedate'
+            @release_date = Time.parse(child.content.strip)
+          when 'listeners'
+            @listeners = child.content.to_i
+          when 'toptags'
+            @top_tags = [] if @top_tags.nil?
+            child.children.each do |tag|
+              next unless tag.name == 'tag'
+              @top_tags << Tag.new_from_libxml(tag)
+            end
+          when 'wiki'
+            # @todo Handle wiki entries
+          when 'text'
+            # ignore, these are only blanks
+          when '#text'
+            # libxml-jruby version of blanks
+          else
+            raise NotImplementedError, "Field '#{child.name}' not known (#{child.content})"
+        end #^ case
+      end #^ do |child|
+
+      # Get all information from the root's attributes
+      @mbid = node['mbid'].to_s unless node['mbid'].nil?
+      @rank = node['rank'].to_i unless node['rank'].nil?
+      @position = node['position'].to_i unless node['position'].nil?
+
+      # 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
+      @name = node.content if @name.nil?
+    end #^ load_from_xml
+
     # Indicates if the info was already loaded
     @info_loaded = false 
     
@@ -118,27 +112,11 @@ module Scrobbler
     # @todo Add language code for wiki translation
     def load_info
       return nil if @info_loaded
-      xml = Base.request('album.getinfo', {'artist' => @artist, 'album' => @name})
+      xml = Base.request('album.getinfo', {:artist => @artist, :album => @name})
       unless xml.root['status'] == 'failed'
         xml.root.children.each do |childL1|
           next unless childL1.name == 'album'
-          
-          childL1.children.each do |childL2|
-            @url = childL2.content if childL2.name == 'url'
-            @id = childL2.content if childL2.name == 'id'
-            @mbid = childL2.content if childL2.name == 'mbid'
-            @release_date = Time.parse(childL2.content.strip) if childL2.name == 'releasedate'
-            check_image_node childL2
-            @listeners = childL2.content.to_i if childL2.name == 'listeners'
-            @playcount = childL2.content.to_i if childL2.name == 'playcount'
-            if childL2.name == 'toptags'
-              @top_tags = []
-              childL2.children.each do |childL3|
-                next unless childL3.name == 'tag'
-                @top_tags << Tag.new_from_libxml(childL3)
-              end # childL2.children.each do |childL3|
-            end # if childL2.name == 'toptags'
-          end # childL1.children.each do |childL2|
+          load_from_xml(childL1)
         end # xml.children.each do |childL1|
         @info_loaded  = true
       end

data/lib/scrobbler/artist.rb

@@ -1,169 +1,209 @@
-# 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
+# encoding: utf-8
+
+require File.expand_path('basexml.rb', File.dirname(__FILE__))
+
 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
+  class Artist < BaseXml
+    include Scrobbler::ImageObjectFuncs
+    include Scrobbler::StreamableObjectFuncs
     
-    attr_accessor :name, :mbid, :playcount, :rank, :url, :count
-    attr_accessor :chartposition
-    attr_accessor :match, :tagcount, :listeners
+    attr_reader :name, :mbid, :playcount, :rank, :url, :count, :listeners
+    attr_reader :chartposition, :streamable, :match, :tagcount
     
-    class << self
-      def new_from_libxml(xml)
-        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']
-        
-        # Step 3 fill the object
-        Artist.new(data[:name], data)
-      end
+    # Alias for Artist.new(:xml => xml)
+    #
+    # @deprecated
+    def self.new_from_libxml(xml)
+      Artist.new(:xml => xml)
     end
-    
-    def initialize(name, data = {})
-      super()
-      raise ArgumentError, "Name is required" if name.empty?
-      @name = name
+
+    # Create a new Scrobbler::Artist instance
+    #
+    # @param [Hash] data The options to initialize the class
+    def initialize(data = {})
+      raise ArgumentError unless data.kind_of?(Hash)
+      super(data)
+      # Load data given as method-parameter
       populate_data(data)
+      raise ArgumentError, "Name is required" if @name.nil? || @name.strip.empty?
     end
     
+    # Load the data for this object out of a XML-Node
+    #
+    # @param [LibXML::XML::Node] node The XML node containing the information
+    # @return [nil]
+    def load_from_xml(node)
+      # Get all information from the root's children nodes
+      node.children.each do |child|
+        case child.name
+          when 'playcount'
+            @playcount = child.content.to_i
+          when 'mbid'
+            @mbid = child.content
+          when 'url'
+            @url = child.content
+          when 'match'
+            @match = child.content.to_i
+          when 'tagcount'
+            @tagcount = child.content.to_i
+          when 'chartposition'
+            @chartposition = child.content
+          when 'name'
+            @name = child.content.to_s
+          when 'image'
+            check_image_node(child)
+          when 'streamable'
+            check_streamable_node(child)
+          when 'stats'
+            child.children.each do |childL2|
+              @listeners = childL2.content.to_i if childL2.name == 'listeners'
+              @playcount = childL2.content.to_i if childL2.name == 'playcount'
+            end
+          when 'similar'
+            # Ignore them for the moment, they are not stored.
+          when 'bio'
+            child.children.each do |childL2|
+              @bio = childL2.content if childL2.name == 'content'
+            end
+          when 'text'
+            # ignore, these are only blanks
+          when '#text'
+            # libxml-jruby version of blanks
+          else
+            raise NotImplementedError, "Field '#{child.name}' not known (#{child.content})"
+        end #^ case
+      end #^ do |child|
+
+      # Get all information from the root's attributes
+      @name = node['name'].to_s unless node['name'].nil?
+      @rank = node['rank'].to_i unless node['rank'].nil?
+      maybe_streamable_attribute(node)
+      @mbid = node['mbid'] unless node['mbid'].nil?
+
+      # 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
+      @name = node.content if @name.nil?
+    end #^ load_from_xml
+    
     # 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
+    # @return [String]
     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}"
+      "#{API_URL.chop}/2.0/artist/#{CGI::escape(@name)}/events.#{format.to_s}"
     end
     
-    def similar(force=false)
-      get_response('artist.getsimilar', :similar, 'similarartists', 'artist', {'artist' => @name}, force)
+    # Get all the artists similar to this artist
+    #
+    # @return [Array<Scrobbler::Artist>]
+    def similar
+      call('artist.getsimilar', :similarartists, Artist, {:artist => @name})
     end
-    
-    def top_fans(force=false)
-      get_response('artist.gettopfans', :top_fans, 'topfans', 'user', {'artist' => @name}, force)
+
+    # Get the top fans for an artist on Last.fm, based on listening data.
+    #
+    # @return [Array<Scrobbler::User>]
+    def top_fans
+      call('artist.gettopfans', :topfans, User, {:artist => @name})
     end
     
-    def top_tracks(force=false)
-      get_response('artist.gettoptracks', :top_tracks, 'toptracks', 'track', {'artist'=>@name}, force)
+    # Get the top tracks by an artist on Last.fm, ordered by popularity
+    #
+    # @return [Array<Scrobbler:Track>]
+    def top_tracks
+      call('artist.gettoptracks', :toptracks, Track, {:artist => @name})
     end
     
-    def top_albums(force=false)
-      get_response('artist.gettopalbums', :top_albums, 'topalbums', 'album', {'artist'=>@name}, force)
+    # Get the top albums for an artist on Last.fm, ordered by popularity.
+    #
+    # @return [Array<Scrobbler::Album>]
+    def top_albums
+      call('artist.gettopalbums', :topalbums, Album, {:artist => @name})
     end
     
-    def top_tags(force=false)
-      get_response('artist.gettoptags', :top_tags, 'toptags', 'tag', {'artist' => @name}, force)
+    # Get the top tags for an artist on Last.fm, ordered by popularity.
+    #
+    # @return [Array<Scrobbler::Tags>]
+    def top_tags
+      call('artist.gettoptags', :toptags, Tag, {:artist => @name})
     end
     
     @info_loaded = false
-    # Get the metadata
+    
+    # Get the metadata for an artist on Last.fm. Includes biography.
+    #
+    # @return [nil]
     def load_info
-        doc = Base.request('artist.getinfo', {'artist' => @name})
-        doc.root.children.each do |childL1|
-            next unless childL1.name == 'artist'
-            childL1.children.each do |child|
-                @mbid = child.content if child.name == 'mbid'
-                @url = child.content if child.name == 'url'
-                check_image_node child
-                check_streamable_node child
-                if child.name == 'stats'
-                    child.children.each do |childL3|
-                        @listeners = childL3.content.to_i if childL3.name == 'listeners'
-                        @playcount = childL3.content.to_i if childL3.name == 'playcount'
-                    end
-                end
-            end
-        end
-        @info_loaded = true
+      doc = request('artist.getinfo', {:artist => @name})
+      doc.root.children.each do |childL1|
+        next unless childL1.name == 'artist'
+        load_from_xml(childL1)
+      end
+      @info_loaded = true
     end # load_info
-    
-    def ==(otherArtist)
-      if otherArtist.is_a?(Scrobbler::Artist)
-        return (@name == otherArtist.name)
+
+    # Compare two Artists
+    #
+    # They are equal if their names are equal.
+    #
+    # @param [Scrobbler::Artist] other_artist
+    # @return [Boolean]
+    def ==(other_artist)
+      if other_artist.is_a?(Scrobbler::Artist)
+        return (@name == other_artist.name)
       end
       false
     end
+
+    def search
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def share
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def shout
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def add_tags
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def events
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def images
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def shouts
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def tags
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+    def remove_tag
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
     
   end
 end

data/lib/scrobbler/auth.rb

@@ -41,6 +41,18 @@ module Scrobbler
       options[:api_key] = @@api_key
       "http://www.last.fm/api/auth/?api_key=#{options[:api_key]}&token=#{options[:token]}"
     end
+
+    def mobile_session
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+    
+    def websession
+      # This function require authentication, but SimpleAuth is not yet 2.0
+      raise NotImplementedError
+    end
+
+
     
   end
 end