rscrobbler 0.0.5 → 0.0.6

data/lib/rscrobbler.rb

@@ -22,7 +22,7 @@ require 'lastfm/user'
 require 'lastfm/venue'
 
 module LastFM
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 
   HOST = 'ws.audioscrobbler.com'
   API_VERSION = '2.0'
@@ -33,6 +33,26 @@ module LastFM
   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.
+    #
+    # Expected usage:
+    #     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.
     #
@@ -42,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
-      session_key = Auth.get_mobile_session( username, auth_token ).find_first('session/key').content
+      self.session_key = Auth.get_mobile_session( username, auth_token ).find_first('session/key').content
     end
 
     # Has the service been authenticated?
@@ -136,7 +156,7 @@ module LastFM
     # @private
     def generate_path( method, secure, params={} )
       params = construct_params( method, secure, params )
-      url = "/2.0/?method=#{params.delete('method')}"
+      url = "/#{API_VERSION}/?method=#{params.delete('method')}"
       params.keys.each do |key|
         url << "&#{key}=#{params[key]}"
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rscrobbler
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &2154789180 !ruby/object:Gem::Requirement
+  requirement: &2168494000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154789180
+  version_requirements: *2168494000
 description: rscrobbler is a Ruby gem for accessing Last.fm's API (http://www.last.fm/api).
 email:
 - sgt.floydpepper@gmail.com