rscrobbler 0.2.2 → 0.3.0

data/lib/lastfm/venue.rb

@@ -1,25 +1,60 @@
-module LastFM
-  class Venue < Struct.new(:id, :name, :location, :url, :website, :phone_number, :images)
-
-    def update_from_node(node)
-      case node.name.to_sym
-        when :id
-          self.id = node.content.to_i
-        when :name
-          self.name = node.content
-        when :location
-          # ??? city, country, street, postalcode, geo:lat, geo:long
-        when :url
-          self.url = node.content
-        when :website
-          self.website = node.content
-        when :phoneNumber
-          self.phone_number = node.content
-        when :image
-          self.images ||= {}
-          self.images.merge!({node['size'].to_sym => node.content})
-      end
-    end
-
-  end
-end
+module LastFM
+  class Venue < Struct.new(:id, :name, :location, :url, :website, :phone_number, :images)
+
+    def update_from_node(node)
+      case node.name.to_sym
+        when :id
+          self.id = node.content.to_i
+        when :name
+          self.name = node.content
+        when :location
+          # ??? city, country, street, postalcode, geo:lat, geo:long
+        when :url
+          self.url = node.content
+        when :website
+          self.website = node.content
+        when :phoneNumber
+          self.phone_number = node.content
+        when :image
+          self.images ||= {}
+          self.images.merge!({node['size'].to_sym => node.content})
+      end
+    end
+
+    # API Methods
+    class << self
+
+      # Get a list of upcoming events for a venue.
+      #
+      # @option params [Fixnum,  required] :venue           the id for the venue to fetch event listings for
+      # @option params [Boolean, optional] :festivalsonly   whether only festivals should be returned, or all events
+      # @see http://www.last.fm/api/show?service=394
+      def get_events( params )
+        LastFM.get( "venue.getEvents", params )
+      end
+
+      # Get a paginated list of all the events held at this venue in the past.
+      #
+      # @option params [Fixnum,  required] :venue           the id for the venue to fetch event listings for
+      # @option params [Boolean, optional] :festivalsonly   whether only festivals should be returned, or all events
+      # @option params [Fixnum,  optional] :page            the page number to fetch. defaults to first page
+      # @option params [Fixnum,  optional] :limit           the number of results to fetch per page. defaults to 50
+      # @see http://www.last.fm/api/show?service=395
+      def get_past_events( params )
+        LastFM.get( "venue.getPastEvents", params )
+      end
+
+      # Search for a venue by venue name.
+      #
+      # @option params [String, required] :venue      the venue name to search for
+      # @option params [String, optional] :country    a country name used to limit results, as defined by ISO 3166-1
+      # @option params [Fixnum, optional] :page       the page number to fetch. defaults to first page
+      # @option params [Fixnum, optional] :limit      the number of results to fetch per page. defaults to 50
+      # @see http://www.last.fm/api/show?service=396
+      def search( params )
+        LastFM.get( "venue.search", params )
+      end
+
+    end
+  end
+end

data/lib/lastfm/wiki.rb

@@ -1,20 +1,20 @@
-module LastFM
-
-  # @attr [Time] published  Date the information in this entry was published
-  # @attr [String] summary  Short summary of the information in this entry
-  # @attr [String] content  Full content of this entry
-  class Wiki < Struct.new(:published, :summary, :content)
-
-    def update_from_node(node)
-      case node.name.to_sym
-        when :published
-          self.published = Time.parse(node.content) rescue nil
-        when :summary #TODO: Remove CDATA wrapper
-          self.summary = node.content
-        when :content #TODO: Remove CDATA wrapper
-          self.content = node.content
-      end
-    end
-
-  end
-end
+module LastFM
+
+  # @attr [Time] published  Date the information in this entry was published
+  # @attr [String] summary  Short summary of the information in this entry
+  # @attr [String] content  Full content of this entry
+  class Wiki < Struct.new(:published, :summary, :content)
+
+    def update_from_node(node)
+      case node.name.to_sym
+        when :published
+          self.published = Time.parse(node.content) rescue nil
+        when :summary #TODO: Remove CDATA wrapper
+          self.summary = node.content
+        when :content #TODO: Remove CDATA wrapper
+          self.content = node.content
+      end
+    end
+
+  end
+end

data/lib/rscrobbler.rb

@@ -1,214 +1,207 @@
-require 'digest/md5'
-require 'json'
-require 'libxml'
-require 'net/http'
-require 'time'
-require 'uri'
-
-$:.unshift(File.dirname(__FILE__))
-
-require 'lastfm/struct'
-
-require 'lastfm/album'
-require 'lastfm/artist'
-require 'lastfm/buylink'
-require 'lastfm/event'
-require 'lastfm/shout'
-require 'lastfm/tag'
-require 'lastfm/track'
-require 'lastfm/venue'
-require 'lastfm/wiki'
-
-require 'lastfm/api/album'
-require 'lastfm/api/artist'
-require 'lastfm/api/auth'
-require 'lastfm/api/chart'
-require 'lastfm/api/event'
-require 'lastfm/api/geo'
-require 'lastfm/api/group'
-require 'lastfm/api/library'
-require 'lastfm/api/playlist'
-require 'lastfm/api/radio'
-require 'lastfm/api/tag'
-require 'lastfm/api/tasteometer'
-require 'lastfm/api/track'
-require 'lastfm/api/user'
-require 'lastfm/api/venue'
-
-module LastFM
-  VERSION = '0.2.2'
-
-  HOST = 'ws.audioscrobbler.com'
-  API_VERSION = '2.0'
-
-  class LastFMError < StandardError; end
-  class AuthenticationError < StandardError; end
-
-  class << self
-    attr_accessor :api_key, :api_secret, :username, :auth_token, :session_key, :logger
-
-    # Configure the module and begin a session. Once established (and successfully
-    # executed), the module is ready to send api calls to Last.fm.
-    #
-    # @example
-    #     LastFM.establish_session do |session|
-    #       session.username = ...
-    #       session.auth_token = ...
-    #       session.api_key = ...
-    #       session.api_secret = ...
-    #     end
-    #
-    # @param [Block] &block  block used to configure the module's attributes
-    # @return [String] session key if successfully connected
-    # @raise [AuthenticationError] if any authentication attributes are missing
-    # @raise [LastFMError] if the HTTP request to Last.fm returns an error
-    def establish_session(&block)
-      yield self
-      self.authenticate!
-    end
-
-    # Authenticate the service with provided login credentials. Use mobile
-    # authentication to avoid redirecting to the website to log in.
-    #
-    # @see http://www.last.fm/api/authspec last.fm auth spec
-    # @return [String] session key provided from authentication
-    def authenticate!
-      [:api_key, :api_secret, :username, :auth_token].each do |cred|
-        raise AuthenticationError, "Missing credential: #{cred}" unless LastFM.send(cred)
-      end
-      self.session_key = Api::Auth.get_mobile_session( username: username, auth_token: auth_token ).find_first('session/key').content
-    end
-
-    # Has the service been authenticated?
-    #
-    # @return [Boolean] whether the service has been authenticated
-    def authenticated?
-      !!session_key
-    end
-
-    # Ensure the service has been authenticated; raise an error if it hasn't.
-    #
-    # @raise [AuthenticationError] if the service hasn't been authenticated.
-    def requires_authentication
-      raise AuthenticationError, 'LastFM Authentication Required' unless authenticated?
-    end
-
-    # Generate auth token from username and given password.
-    #
-    # @param [String] password  password to use
-    # @return [String] md5 digest of the username and password
-    def generate_auth_token( password )
-      self.auth_token = Digest::MD5.hexdigest( username.dup << Digest::MD5.hexdigest(password) )
-    end
-
-    # Construct an HTTP GET call from params, and load the response into a LibXML Document.
-    #
-    # @param [String] method  last.fm api method to call
-    # @param [Boolean] secure  whether to sign the request with a method signature and session key
-    #   (one exception being auth methods, which require a method signature but no session key)
-    # @param [Hash] params  parameters to send, excluding method, api_key, api_sig, and sk
-    # @return [LibXML::XML::Document] xml document of the data contained in the response
-    # @raise [LastFMError] if the request fails
-    def get( method, params = {}, secure = false )
-      path = generate_path(method, secure, params)
-      logger.debug( "Last.fm HTTP GET: #{HOST}#{path}" ) if logger
-      response = Net::HTTP.get_response( HOST, path )
-      validate( LibXML::XML::Parser.string( response.body ).parse )
-    end
-
-    # Construct an HTTP POST call from params, and check the response status.
-    #
-    # @param [String] method  last.fm api method to call
-    # @param [Hash] params  parameters to send, excluding method, api_key, api_sig, and sk
-    # @return [LibXML::XML::Document] xml document of the data contained in the response
-    # @raise [LastFMError] if the request fails
-    def post( method, params )
-      post_uri = URI.parse("http://#{HOST}/#{API_VERSION}/")
-      params = construct_params( method, :secure, params )
-      logger.debug( "Last.fm HTTP POST: #{post_uri}, #{params.to_s}" ) if logger
-      response = Net::HTTP.post_form( post_uri, params )
-      validate( LibXML::XML::Parser.string( response.body ).parse )
-    end
-
-  private
-
-    # Check an XML document for status = failed, and throw a descriptive error if it's found.
-    #
-    # @param [LibXML::XML::Document] xml  xml document to check for errors
-    # @return [LibXML::XML::Document] the xml document if no errors were found
-    # @raise [LastFMError] if an error is found
-    # @private
-    def validate( xml )
-      raise LastFMError, xml.find_first('error').content if xml.root.attributes['status'] == 'failed'
-      xml
-    end
-
-    # Normalize the parameter list by converting boolean values to 0 or 1, array values to
-    # comma-separated strings, and all other values to a string. Remove any nil values, and
-    # camel-case the parameter keys. Add method, api key, session key, and api signature
-    # parameters where necessary.
-    #
-    # @param [String] method  last.fm api method
-    # @param [Boolean] secure  whether to include session key and api signature in the parameters
-    # @param [Hash] params  parameters to normalize and add to
-    # @return [Hash] complete, normalized parameters
-    # @private
-    def construct_params( method, secure, params )
-      params = params.each_with_object({}) do |(k,v), h|
-        v = v ? 1 : 0 if !!v == v                 # convert booleans into 0 or 1
-        v = v.compact.join(',') if v.is_a?(Array) # convert arrays into comma-separated strings
-        v = v.to_i if v.is_a?(Time)               # convert times into integer unix timestamps
-        h[camel_case(k)] = v.to_s unless v.nil?
-      end
-      params['method'] = method
-      params['api_key'] = api_key
-      params['sk'] = session_key if authenticated? && secure
-      params['api_sig'] = generate_method_signature( params ) if secure
-      params
-    end
-
-    # Return a the camelCased version of the given string or symbol, with underscores removed,
-    # word capitalized, and the first letter lower case.
-    #
-    # @param [String] str  the string (or symbol) to camel case
-    # @return [String] the camelcased version of the given string
-    def camel_case(key)
-      exceptions = {playlist_id: 'playlistID', playlist_url: 'playlistURL',
-        speed_multiplier: 'speed_multiplier', fingerprint_id: 'fingerprintid'}
-      return exceptions[key] if exceptions.include?(key)
-      camel = key.to_s.split('_').map{|s| s.capitalize}.join
-      camel[0].downcase + camel[1..-1]
-    end
-
-    # Generate the path for a particular method call given params.
-    #
-    # @param [String] method  last.fm method to call
-    # @param [Boolean] secure  whether to include session key and api signature in the call
-    # @param [optional, Hash] params  parameters to include in the api call
-    # @return [String] path for the api call
-    # @private
-    def generate_path( method, secure, params={} )
-      params = construct_params( method, secure, params )
-      url = "/#{API_VERSION}/?method=#{params.delete('method')}"
-      params.keys.each do |key|
-        url << "&#{key}=#{params[key]}"
-      end
-      URI.encode(url)
-    end
-
-    # Generate a method signature based on given parameters.
-    #
-    # @param [Hash] parameters to combine into a method signature
-    # @return [String] method signature based on all the parameters
-    # @see http://www.last.fm/api/authspec#8
-    # @private
-    def generate_method_signature( params )
-      str = ''
-      params.keys.sort.each do |key|
-        str << key << params[key]
-      end
-      Digest::MD5.hexdigest( str << api_secret )
-    end
-
-  end
-end
+require 'cgi'
+require 'digest/md5'
+require 'json'
+require 'libxml'
+require 'net/http'
+require 'time'
+require 'uri'
+
+$:.unshift(File.dirname(__FILE__))
+
+[
+  :struct,
+  :album,
+  :artist,
+  :auth,
+  :buylink,
+  :chart,
+  :event,
+  :geo,
+  :group,
+  :library,
+  :playlist,
+  :radio,
+  :shout,
+  :tag,
+  :tasteometer,
+  :track,
+  :user,
+  :venue,
+  :wiki
+].each{|model| require "lastfm/#{model}"}
+
+module LastFM
+  VERSION = '0.3.0'
+
+  HOST = 'ws.audioscrobbler.com'
+  API_VERSION = '2.0'
+
+  class LastFMError < StandardError; end
+  class AuthenticationError < StandardError; end
+
+  class << self
+    attr_accessor :api_key, :api_secret, :username, :auth_token, :session_key, :logger
+
+    # Configure the module and begin a session. Once established (and successfully
+    # executed), the module is ready to send api calls to Last.fm.
+    #
+    # @example
+    #     LastFM.establish_session do |session|
+    #       session.username = ...
+    #       session.auth_token = ...
+    #       session.api_key = ...
+    #       session.api_secret = ...
+    #     end
+    #
+    # @param [Block] &block  block used to configure the module's attributes
+    # @return [String] session key if successfully connected
+    # @raise [AuthenticationError] if any authentication attributes are missing
+    # @raise [LastFMError] if the HTTP request to Last.fm returns an error
+    def establish_session(&block)
+      yield self
+      self.authenticate!
+    end
+
+    # Authenticate the service with provided login credentials. Use mobile
+    # authentication to avoid redirecting to the website to log in.
+    #
+    # @see http://www.last.fm/api/authspec last.fm auth spec
+    # @return [String] session key provided from authentication
+    def authenticate!
+      [:api_key, :api_secret, :username, :auth_token].each do |cred|
+        raise AuthenticationError, "Missing credential: #{cred}" unless LastFM.send(cred)
+      end
+      self.session_key = Auth.get_mobile_session( username: username, auth_token: auth_token ).find_first('session/key').content
+    end
+
+    # Has the service been authenticated?
+    #
+    # @return [Boolean] whether the service has been authenticated
+    def authenticated?
+      !!session_key
+    end
+
+    # Ensure the service has been authenticated; raise an error if it hasn't.
+    #
+    # @raise [AuthenticationError] if the service hasn't been authenticated.
+    def requires_authentication
+      raise AuthenticationError, 'LastFM Authentication Required' unless authenticated?
+    end
+
+    # Generate auth token from username and given password.
+    #
+    # @param [String] password  password to use
+    # @return [String] md5 digest of the username and password
+    def generate_auth_token( password )
+      self.auth_token = Digest::MD5.hexdigest( username + Digest::MD5.hexdigest(password) )
+    end
+
+    # Construct an HTTP GET call from params, and load the response into a LibXML Document.
+    #
+    # @param [String] method  last.fm api method to call
+    # @param [Boolean] secure  whether to sign the request with a method signature and session key
+    #   (one exception being auth methods, which require a method signature but no session key)
+    # @param [Hash] params  parameters to send, excluding method, api_key, api_sig, and sk
+    # @return [LibXML::XML::Document] xml document of the data contained in the response
+    # @raise [LastFMError] if the request fails
+    def get( method, params = {}, secure = false )
+      path = generate_path(method, secure, params)
+      logger.debug( "Last.fm HTTP GET: #{HOST}#{path}" ) if logger
+      response = Net::HTTP.get_response( HOST, path )
+      validate( LibXML::XML::Parser.string( response.body ).parse )
+    end
+
+    # Construct an HTTP POST call from params, and check the response status.
+    #
+    # @param [String] method  last.fm api method to call
+    # @param [Hash] params  parameters to send, excluding method, api_key, api_sig, and sk
+    # @return [LibXML::XML::Document] xml document of the data contained in the response
+    # @raise [LastFMError] if the request fails
+    def post( method, params )
+      post_uri = URI.parse("http://#{HOST}/#{API_VERSION}/")
+      params = construct_params( method, :secure, params )
+      logger.debug( "Last.fm HTTP POST: #{post_uri}, #{params.to_s}" ) if logger
+      response = Net::HTTP.post_form( post_uri, params )
+      validate( LibXML::XML::Parser.string( response.body ).parse )
+    end
+
+  private
+
+    # Check an XML document for status = failed, and throw a descriptive error if it's found.
+    #
+    # @param [LibXML::XML::Document] xml  xml document to check for errors
+    # @return [LibXML::XML::Document] the xml document if no errors were found
+    # @raise [LastFMError] if an error is found
+    # @private
+    def validate( xml )
+      raise LastFMError, xml.find_first('error').content if xml.root.attributes['status'] == 'failed'
+      xml
+    end
+
+    # Normalize the parameter list by converting boolean values to 0 or 1, array values to
+    # comma-separated strings, and all other values to a string. Remove any nil values, and
+    # camel-case the parameter keys. Add method, api key, session key, and api signature
+    # parameters where necessary.
+    #
+    # @param [String] method  last.fm api method
+    # @param [Boolean] secure  whether to include session key and api signature in the parameters
+    # @param [Hash] params  parameters to normalize and add to
+    # @return [Hash] complete, normalized parameters
+    # @private
+    def construct_params( method, secure, params )
+      params = params.each_with_object({}) do |(k,v), h|
+        v = v ? 1 : 0 if !!v == v                 # convert booleans into 0 or 1
+        v = v.compact.join(',') if v.is_a?(Array) # convert arrays into comma-separated strings
+        v = v.to_i if v.is_a?(Time)               # convert times into integer unix timestamps
+        h[camel_case(k)] = v.to_s unless v.nil?
+      end
+      params['method'] = method
+      params['api_key'] = api_key
+      params['sk'] = session_key if authenticated? && secure
+      params['api_sig'] = generate_method_signature( params ) if secure
+      params
+    end
+
+    # Return a the camelCased version of the given string or symbol, with underscores removed,
+    # word capitalized, and the first letter lower case.
+    #
+    # @param [String] str  the string (or symbol) to camel case
+    # @return [String] the camelcased version of the given string
+    def camel_case(key)
+      exceptions = { playlist_id: 'playlistID', playlist_url: 'playlistURL',
+        speed_multiplier: 'speed_multiplier', fingerprint_id: 'fingerprintid' }
+      return exceptions[key] if exceptions.include?(key)
+      camel = key.to_s.split('_').map{|s| s.capitalize}.join
+      camel[0].downcase + camel[1..-1]
+    end
+
+    # Generate the path for a particular method call given params.
+    #
+    # @param [String] method  last.fm method to call
+    # @param [Boolean] secure  whether to include session key and api signature in the call
+    # @param [optional, Hash] params  parameters to include in the api call
+    # @return [String] path for the api call
+    # @private
+    def generate_path( method, secure, params={} )
+      params = construct_params( method, secure, params )
+      url = "/#{API_VERSION}/?method=#{params.delete('method')}"
+      params.inject(url) do |url, (key, value)|
+        url << "&#{key}=#{CGI.escape value}"
+      end
+    end
+
+    # Generate a method signature based on given parameters.
+    #
+    # @param [Hash] parameters to combine into a method signature
+    # @return [String] method signature based on all the parameters
+    # @see http://www.last.fm/api/authspec#8
+    # @private
+    def generate_method_signature( params )
+      str = params.keys.sort.inject('') do |str, key|
+        str << key << params[key]
+      end
+      Digest::MD5.hexdigest( str << api_secret )
+    end
+
+  end
+end

data/test/test_album.rb

@@ -1,36 +1,36 @@
-require 'test/unit'
-load 'lib/rscrobbler.rb'
-
-def check_attributes(model, attrs)
-  attrs.each do |attr|
-    assert_not_nil model.send(attr), "#{attr} expected to be set."
-  end
-end
-
-class LastFM::AlbumTest < Test::Unit::TestCase
-
-  def setup
-    LastFM.api_key = 'b25b959554ed76058ac220b7b2e0a026'
-    @artist = 'Cher'
-    @album = 'Believe'
-  end
-
-  def test_search
-    albums = LastFM::Album.search :album => @album, :limit => 1
-    assert_equal 1, albums.size
-    assert albums.first.is_a? LastFM::Album
-    check_attributes albums.first, [:name, :artist, :id, :url, :images, :streamable, :mbid]
-  end
-
-  def test_get_info
-    assert_raise LastFM::LastFMError do
-      LastFM::Album.get_info :album => @album
-    end
-    album = LastFM::Album.get_info :artist => @artist, :album => @album
-    assert_equal @artist, album.artist
-    assert_equal @album, album.name
-    assert album.wiki.is_a? LastFM::Wiki
-    check_attributes album, [:artist, :id, :images, :listeners, :mbid, :name, :playcount, :release_date, :tags, :tracks, :url, :wiki]
-  end
-
+require 'test/unit'
+load 'lib/rscrobbler.rb'
+
+def check_attributes(model, attrs)
+  attrs.each do |attr|
+    assert_not_nil model.send(attr), "#{attr} expected to be set."
+  end
+end
+
+class LastFM::AlbumTest < Test::Unit::TestCase
+
+  def setup
+    LastFM.api_key = 'b25b959554ed76058ac220b7b2e0a026'
+    @artist = 'Cher'
+    @album = 'Believe'
+  end
+
+  def test_search
+    albums = LastFM::Album.search :album => @album, :limit => 1
+    assert_equal 1, albums.size
+    assert albums.first.is_a? LastFM::Album
+    check_attributes albums.first, [:name, :artist, :id, :url, :images, :streamable, :mbid]
+  end
+
+  def test_get_info
+    assert_raise LastFM::LastFMError do
+      LastFM::Album.get_info :album => @album
+    end
+    album = LastFM::Album.get_info :artist => @artist, :album => @album
+    assert_equal @artist, album.artist
+    assert_equal @album, album.name
+    assert album.wiki.is_a? LastFM::Wiki
+    check_attributes album, [:artist, :id, :images, :listeners, :mbid, :name, :playcount, :release_date, :tags, :tracks, :url, :wiki]
+  end
+
 end