rdio 0.0.94 → 0.0.96

data/README

@@ -27,6 +27,20 @@ see the options.  Here's an example:
   ....
 
 
-* TODO
+* TESTS
+
+In order to run the rests, you must define the following environmental
+variables to the appropriate values:
+
+ RDIO_KEY
+ RDIO_SECRET
+
+You must also serialize an authrozied access token to the file
+.rdio_access_token.  This can be done with:
+
+ make .rdio_access_token
+
+  -or-
+
+ ./create_access_token
 
-Lots

data/lib/rdio.rb

@@ -37,14 +37,26 @@ module Rdio
     VERSION
   end
 
+  # String[key] String[secret] -> Api
+  #
   # Initializes and returns the shared Api instance and overwrites the
   # existing one.
+  #
   def self.init(key,secret)
     @api = Api.new key,secret
   end
 
+  # AccessToken[token] => Api
+  #
+  # Initializes and returns the shared Api instance from the passed in
+  # access_token instance
+  #
+  def self.init_with_token(token)
+    @api = Api.from_token token
+  end
+
   # Resets shared API to nil
-  def reset
+  def self.reset
     @api = nil
   end
 

data/lib/rdio/api.rb

@@ -6,9 +6,20 @@ module Rdio
   # ----------------------------------------------------------------------
   class Api < BaseApi
     
-    def initialize(key,secret)
+    def initialize(key=nil,secret=nil)
       super key,secret
     end
+
+    # AccessToken[token] -> Api
+    #
+    # Returns a new instance initialized from the passed in access
+    # token
+    #
+    def self.from_token(token)
+      api = Api.new
+      api.access_token = token
+      return api
+    end
     
     # Add a friend to the current user.
     def addFriend(user)

data/lib/rdio/base.rb

@@ -247,7 +247,12 @@ module Rdio
 
     attr_reader :oauth
 
-    def initialize(key,secret)
+    # string[key] string[secret]
+    #
+    # key and secret can be 'nil' because users can now set the
+    # access_token directly
+    #
+    def initialize(key=nil,secret=nil)
       @oauth = RdioOAuth.new key,secret
       @access_token_auth = nil
       @access_token_no_auth = nil
@@ -266,6 +271,15 @@ module Rdio
       @oauth.get_pin
     end
 
+    # Token -> Void
+    #
+    # Sets both unauthorized and authorized tokens to token
+    #
+    def access_token=(token)
+      @access_token_auth = token
+      @access_token_no_auth = token
+    end
+
     def call(method,args,requires_auth=false)
       #
       # Convert object with keys just to use their keys
@@ -295,6 +309,11 @@ module Rdio
       create_object type,json
     end
 
+    # Forces authorization
+    def authorize
+      access_token true
+    end
+
     private
 
     def fill_obj(type,x)
@@ -359,16 +378,28 @@ module Rdio
     def access_token(requires_auth)
       if requires_auth
         if not @access_token_auth
+          if not @oauth.key or not @oauth.secret
+            raise 'You must set the access_token directly or ' +
+              'initialize this instance with a valid key/secret pair'
+          end
           @access_token_auth = @oauth.access_token requires_auth
         end
         res = @access_token_auth
       else
-        if not @access_token_no_auth
-          @access_token_no_auth = @oauth.access_token requires_auth
+        if @access_token_auth
+          res = @access_token_auth
+        else
+          if not @access_token_no_auth
+            if not @oauth.key or not @oauth.secret
+              raise 'You must set the access_token directly or ' +
+                'initialize this instance with a valid key/secret pair'
+            end
+            @access_token_no_auth = @oauth.access_token requires_auth
+          end
+          res = @access_token_no_auth
         end
-        res = @access_token_no_auth
       end
-      res
+      return res
     end
 
   end

data/lib/rdio/oauth.rb

@@ -4,11 +4,13 @@ require 'oauth'
 module Rdio
 
   # ----------------------------------------------------------------------
-  # Performs OAuth authentication based on a key and secret
+  # Performs oob OAuth authentication based on a key and secret
   # ----------------------------------------------------------------------
   class RdioOAuth
 
     SITE = 'http://api.rdio.com'
+
+    attr_accessor :key, :secret
     
     # string[url] -> string
     #
@@ -23,7 +25,8 @@ module Rdio
       @secret = secret
       @get_pin = lambda do |url|
 
-        # Try to open using launchy, then if this doesn't work us open
+        # Try to open using launchy, then if this doesn't work use
+        # system open
         begin
           require 'rubygems'
           require 'launchy'
@@ -31,6 +34,7 @@ module Rdio
         rescue Exception => e
           Rdio::log.error e
           Rdio::log.info 'Install the \'launchy\' gem to avoid this error'
+          Rdio::log.info 'Trying system \'open\''
           system 'open',url
         end
         
@@ -44,6 +48,13 @@ module Rdio
       end
     end
 
+    # boolean[requires_auth] -> AccessToken
+    #
+    # Returns an appropriate oob access token. If requires_auth is
+    # true we'll return one needed for authenticated requests.
+    # Otherwise (default), we'll return one needed for unauthenticated
+    # requests.
+    #
     def access_token(requires_auth=false)
       requires_auth ? access_token_auth : access_token_no_auth
     end
@@ -53,7 +64,7 @@ module Rdio
     def access_token_no_auth
       consumer = OAuth::Consumer.new @key, @secret, {:site => SITE}
       consumer.http.read_timeout = 600
-      OAuth::AccessToken.new consumer
+      return OAuth::AccessToken.new consumer
     end
     
     def access_token_auth
@@ -69,7 +80,7 @@ module Rdio
       url = 'https://www.rdio.com/oauth/authorize?oauth_token=' + 
         request_token.token.to_s      
       oauth_verifier = @get_pin.call url
-      request_token.get_access_token({:oauth_verifier => oauth_verifier})
+      return request_token.get_access_token({:oauth_verifier => oauth_verifier})
     end
   end
 

data/lib/rdio/types.rb

@@ -511,7 +511,8 @@ module Rdio
     end
 
     # Get all of the tracks in the user's collection.
-    def tracks_in_collection(start=nil,count=nil,sort=nil,query=nil,extras=nil)
+    def tracks_in_collection(start=nil,count=nil,sort=nil,
+                             query=nil,extras=nil)
       api.getTracksInCollection self,start,count,sort,query,extras
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rdio
 version: !ruby/object:Gem::Version 
-  hash: 163
+  hash: 223
   prerelease: 
   segments: 
   - 0
   - 0
-  - 94
-  version: 0.0.94
+  - 96
+  version: 0.0.96
 platform: ruby
 authors: 
 - Jeffrey Palm
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-03 00:00:00 -04:00
-default_executable: 
+date: 2011-08-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: oauth
@@ -53,7 +52,6 @@ files:
 - lib/rdio/datatypes.rb
 - lib/rdio/types.rb
 - lib/rdio/call.rb
-has_rdoc: true
 homepage: http://github.com/spudtrooper/rdiorb
 licenses: []
 
@@ -83,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: 
 - launchy gem to use authorized calls
 rubyforge_project: "%NAME"
-rubygems_version: 1.6.1
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 2
 summary: Rdio