rscrobbler 0.0.6 → 0.1.0

data/lib/lastfm/venue.rb

@@ -4,19 +4,35 @@ module LastFM
 
       TYPE = 'venue'
 
+      # 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( venue, festivals_only = nil )
-        LastFM.get( "#{TYPE}.getEvents", !:secure, 'venue'=>venue, 'festivalsonly'=>festivals_only )
+      def get_events( params )
+        LastFM.get( "#{TYPE}.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( venue, festivals_only = nil, limit = nil, page = nil )
-        LastFM.get( "#{TYPE}.getPastEvents", !:secure, 'venue'=>venue, 'festivalsonly'=>festivals_only, 'limit'=>limit, 'page'=>page )
+      def get_past_events( params )
+        LastFM.get( "#{TYPE}.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( venue, country = nil, limit = nil, page = nil )
-        LastFM.get( "#{TYPE}.search", !:secure, 'venue'=>venue, 'country'=>country, 'limit'=>limit, 'page'=>page )
+      def search( params )
+        LastFM.get( "#{TYPE}.search", params )
       end
 
     end

data/lib/rscrobbler.rb

@@ -22,7 +22,7 @@ require 'lastfm/user'
 require 'lastfm/venue'
 
 module LastFM
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 
   HOST = 'ws.audioscrobbler.com'
   API_VERSION = '2.0'
@@ -36,7 +36,7 @@ module LastFM
     # Configure the module and begin a session. Once established (and successfully
     # executed), the module is ready to send api calls to Last.fm.
     #
-    # Expected usage:
+    # @example
     #     LastFM.establish_session do |session|
     #       session.username = ...
     #       session.auth_token = ...
@@ -62,7 +62,7 @@ module LastFM
       [: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, auth_token ).find_first('session/key').content
+      self.session_key = Auth.get_mobile_session( username: username, auth_token: auth_token ).find_first('session/key').content
     end
 
     # Has the service been authenticated?
@@ -90,14 +90,14 @@ module LastFM
     # 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 [optional, Boolean] secure  whether sign the request with a method signature and session key
+    # @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, secure = false, params = {} )
+    def get( method, params = {}, secure = false )
       path = generate_path(method, secure, params)
-      logger.debug( "Last.fm HTTP GET: #{HOST+path}" ) if logger
+      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
@@ -129,8 +129,10 @@ module LastFM
       xml
     end
 
-    # Normalize the parameter list by converting values to a string and removing any nils. Add method,
-    # api key, session key, and api signature parameters where necessary.
+    # 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
@@ -138,8 +140,12 @@ module LastFM
     # @return [Hash] complete, normalized parameters
     # @private
     def construct_params( method, secure, params )
-      params.delete_if{|k,v| v.nil? }
-      params.each{|k,v| params[k] = params[k].to_s }
+      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
@@ -147,6 +153,19 @@ module LastFM
       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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rscrobbler
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-22 00:00:00.000000000Z
+date: 2012-01-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &2168494000 !ruby/object:Gem::Requirement
+  requirement: &2164437020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2168494000
+  version_requirements: *2164437020
 description: rscrobbler is a Ruby gem for accessing Last.fm's API (http://www.last.fm/api).
 email:
 - sgt.floydpepper@gmail.com
@@ -46,6 +46,22 @@ files:
 - lib/lastfm/user.rb
 - lib/lastfm/venue.rb
 - lib/rscrobbler.rb
+- test/unit/lib/lastfm/album_test.rb
+- test/unit/lib/lastfm/artist_test.rb
+- test/unit/lib/lastfm/auth_test.rb
+- test/unit/lib/lastfm/chart_test.rb
+- test/unit/lib/lastfm/event_test.rb
+- test/unit/lib/lastfm/geo_test.rb
+- test/unit/lib/lastfm/group_test.rb
+- test/unit/lib/lastfm/library_test.rb
+- test/unit/lib/lastfm/playlist_test.rb
+- test/unit/lib/lastfm/radio_test.rb
+- test/unit/lib/lastfm/tag_test.rb
+- test/unit/lib/lastfm/tasteometer_test.rb
+- test/unit/lib/lastfm/track_test.rb
+- test/unit/lib/lastfm/user_test.rb
+- test/unit/lib/lastfm/venue_test.rb
+- test/unit/lib/rscrobbler_test.rb
 - bin/generate_lastfm_auth_token
 homepage: https://github.com/sgtFloyd/rscrobbler
 licenses: []
@@ -71,5 +87,21 @@ rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
 summary: Last.fm API wrapper
-test_files: []
+test_files:
+- test/unit/lib/lastfm/album_test.rb
+- test/unit/lib/lastfm/artist_test.rb
+- test/unit/lib/lastfm/auth_test.rb
+- test/unit/lib/lastfm/chart_test.rb
+- test/unit/lib/lastfm/event_test.rb
+- test/unit/lib/lastfm/geo_test.rb
+- test/unit/lib/lastfm/group_test.rb
+- test/unit/lib/lastfm/library_test.rb
+- test/unit/lib/lastfm/playlist_test.rb
+- test/unit/lib/lastfm/radio_test.rb
+- test/unit/lib/lastfm/tag_test.rb
+- test/unit/lib/lastfm/tasteometer_test.rb
+- test/unit/lib/lastfm/track_test.rb
+- test/unit/lib/lastfm/user_test.rb
+- test/unit/lib/lastfm/venue_test.rb
+- test/unit/lib/rscrobbler_test.rb
 has_rdoc: