rdio 0.0.96 → 0.0.98b

data/README

@@ -1,4 +1,4 @@
--*- outline -*-
+-*- org -*-
 
 * ABOUT
 
@@ -35,7 +35,7 @@ variables to the appropriate values:
  RDIO_KEY
  RDIO_SECRET
 
-You must also serialize an authrozied access token to the file
+There is a sample .rc file in dot-rdio.  You must also serialize an authorized access token to the file
 .rdio_access_token.  This can be done with:
 
  make .rdio_access_token
@@ -44,3 +44,11 @@ You must also serialize an authrozied access token to the file
 
  ./create_access_token
 
+There is a sample in dot-rdio_access_token.
+
+* CONTRIBUTORS
+
+  Thanks for the pull requests that have been merged to the following:
+
+  - Scott Hyndman ( https://github.com/shyndman )
+  - Rick Fletcher ( https://github.com/rfletcher )

data/lib/rdio.rb

@@ -20,6 +20,17 @@ module Rdio
     attr_accessor :log_methods
     attr_accessor :log_symbols
     attr_accessor :log_posts
+    attr_accessor :log_fill
+    #
+    # Specific setting to turn off warnings like the following:
+    #
+    #   Couldn't find symbol: radio_key => rr31531 for type: Rdio::Artist
+    #
+    # during tests, because we see it constantly and isn't really a
+    # problem.  By default it is true, but it is turned off for all
+    # tests.
+    attr_accessor :log_couldnt_find_symbols
+    
     def log(str)
       logger.debug { str }
     end
@@ -29,6 +40,8 @@ module Rdio
   self.log_methods = false
   self.log_symbols = false
   self.log_posts = false
+  self.log_couldnt_find_symbols = false
+  self.log_fill = false
 
   @logger ||= ::Logger.new(STDERR)
   @api = nil
@@ -89,7 +102,11 @@ require 'rdio/datatypes'
 require 'rdio/types'
 require 'rdio/call'
 
-# Silly syntax so you can say Rd::io...blah...blah...blah
+# simple additions
+require 'rdio/simple_om'
+require 'rdio/simple_rdio'
+
+# Silly syntax so you can say Rd::io.<method>
 module Rd
   
   # Returns the shared Rdio::Api instance from Rdio::api

data/lib/rdio/base.rb

@@ -148,7 +148,17 @@ module Rdio
 
     def fill(x)
       return self if not x
+      if Rdio::log_fill
+        Rdio::log "#{self.class}.fill #{x.class} : #{x}"
+      end
       syms_to_types = Rdio::symbols_to_types || {}
+      #
+      # https://github.com/spudtrooper/rdiorb/issues/9: Certain rubys
+      # don't declare 'each' on String.  In this case and others where
+      # the key is a mapped type and the resulting body isn't a Hash,
+      # make x a Hash
+      #
+      x = {x => nil} if not x.is_a? Hash
       x.each do |k,v|
         sym = Rdio::camel2underscores(k).to_sym
         #
@@ -158,9 +168,9 @@ module Rdio
         #
         type = syms_to_types[sym]
         if Rdio::log_symbols
-          Rdio::log "#{self.class}.#{sym} => #{type}"
+          Rdio::log "#{self.class}.#{sym} => #{type} v=#{v.class}"
         end
-        if type
+        if type and v.is_a? Enumerable
           #
           # Allow simple types that are used for arrays
           #
@@ -177,8 +187,10 @@ module Rdio
           sym_eq = (Rdio::camel2underscores(k)+'=').to_sym
           self.send sym_eq,o
         rescue Exception => e
-          Rdio::logger.warn "Couldn't find symbol: " +
-            "#{sym} => #{o} for type: #{self.class}"
+          if Rdio::log_couldnt_find_symbols
+            Rdio::logger.warn "Couldn't find symbol: " +
+              "#{sym} => #{o} for type: #{self.class}"
+          end
         end
       end
       self
@@ -297,7 +309,15 @@ module Rdio
       if Rdio::log_posts
         Rdio::log "Post to url=#{url} method=#{method} args=#{args}"
       end
+      #
+      # For backwards compatibility the response may have a 'body'
+      # attribute or a tuple could be returned.  Handle both cases.
+      #
       resp,data = access_token(requires_auth).post url,new_args
+      begin
+        return resp.body
+      rescue
+      end
       return data
     end
 

data/lib/rdio/oauth.rb

@@ -32,9 +32,9 @@ module Rdio
           require 'launchy'
           Launchy.open url
         rescue Exception => e
-          Rdio::log.error e
-          Rdio::log.info 'Install the \'launchy\' gem to avoid this error'
-          Rdio::log.info 'Trying system \'open\''
+          Rdio::logger.error e
+          Rdio::logger.info 'Install the \'launchy\' gem to avoid this error'
+          Rdio::logger.info 'Trying system \'open\''
           system 'open',url
         end
         

data/lib/rdio/simple_om.rb

@@ -0,0 +1,151 @@
+# om is oauth-mini - a simple implementation of a useful subset of OAuth.
+# It's designed to be useful and reusable but not general purpose.
+#
+# (c) 2011 Rdio Inc
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+# A simple OAuth client implementation. Do less better.
+# Here are the restrictions:
+#   - only HMAC-SHA1 is supported
+#   - only WWW-Authentiate form signatures are generated
+#
+# To sign a request:
+#   auth = om([consumer_key,consumer_secret], url, params)
+#     send Authorization: <auth>
+#     when POSTing <params> to <url>
+# Optional additional arguments are:
+#   token = [oauth_token, oauth_token_secret]
+#   method = "POST"
+#   realm = "Realm-for-authorization-header"
+#
+# Changes by jeff@jeffpalm.com:
+#
+# - added module Rdio
+#
+
+require 'uri'
+require 'cgi'
+require 'digest'
+require 'digest/sha1'
+
+module Rdio
+
+  class OM
+
+    def self.om(consumer, url, post_params, token=nil, method='POST', realm=nil)
+      # A one-shot simple OAuth signature generator
+
+      # the method must be upper-case
+      method.upcase!
+
+      # we want params as an Array of name / value pairs
+      if post_params.is_a?(Array)
+        params = post_params
+      else
+        params = post_params.collect
+      end
+
+      # normalize the URL
+      url = URI.parse(url)
+      # scheme is lower-case
+      url.scheme = url.scheme.downcase
+      # remove username & password
+      url.user = url.password = nil
+      # host is lowercase
+      url.host.downcase!
+
+      # add URL params to the params
+      if url.query
+        CGI.parse(url.query).each { |k,vs| vs.each { |v| params.push([k,v]) } }
+      end
+
+      # remove the params and fragment
+      url.query = nil
+      url.fragment = nil
+
+      # add OAuth params
+      params = params + [
+                         ['oauth_version', '1.0'],
+                         ['oauth_timestamp', Time.now.to_i.to_s],
+                         ['oauth_nonce', rand(1000000).to_s],
+                         ['oauth_signature_method', 'HMAC-SHA1'],
+                         ['oauth_consumer_key', consumer[0]],
+                        ]
+
+      # the consumer secret is the first half of the HMAC-SHA1 key
+      hmac_key = consumer[1] + '&'
+
+      if token != nil
+        # include a token in params
+        params.push ['oauth_token', token[0]]
+        # and the token secret in the HMAC-SHA1 key
+        hmac_key += token[1]
+      end
+
+      # Sort lexicographically, first after key, then after value.
+      params.sort!
+      # escape the key/value pairs and combine them into a string
+      normalized_params = (params.collect {|p| percent_encode(p[0])+'='+percent_encode(p[1])}).join '&'
+
+      # build the signature base string
+      signature_base_string = (percent_encode(method) +
+                               '&' + percent_encode(url.to_s) +
+                               '&' + percent_encode(normalized_params))
+
+      # HMAC-SHA1
+      hmac = Digest::HMAC.new(hmac_key, Digest::SHA1)
+      hmac.update(signature_base_string)
+
+      # Calculate the digest base 64. Drop the trailing \n
+      oauth_signature = [hmac.digest].pack('m0').strip
+
+      # Build the Authorization header
+      if realm
+        authorization_params = [['realm', realm]]
+      else
+        authorization_params = []
+      end
+      authorization_params.push(['oauth_signature', oauth_signature])
+
+      # we only want certain params in the auth header
+      oauth_params = ['oauth_version', 'oauth_timestamp', 'oauth_nonce',
+                      'oauth_signature_method', 'oauth_signature',
+                      'oauth_consumer_key', 'oauth_token']
+      authorization_params.concat(params.select { |param| nil != oauth_params.index(param[0]) })
+
+      return 'OAuth ' + (authorization_params.collect {|param| '%s="%s"' % param}).join(', ')
+    end
+
+    def self.percent_encode(s)
+      chars = s.chars.map do |c|
+        if ((c >= '0' and c <= '9') or
+            (c >= 'A' and c <= 'Z') or
+            (c >= 'a' and c <= 'z') or
+            c == '-' or c == '.' or c == '_' or c == '~')
+          c
+        else
+          '%%%02X' % c[0]
+        end
+      end
+      chars.join
+    end
+
+  end
+
+end

data/lib/rdio/simple_rdio.rb

@@ -0,0 +1,87 @@
+# (c) 2011 Rdio Inc
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Changes by jeff@jeffpalm.com:
+#
+# - added module Rdio
+# - changed class named from Rdio to SimpleRdio
+#
+
+require 'uri'
+require 'net/http'
+require 'cgi'
+require 'json'
+
+module Rdio
+
+  class SimpleRdio
+    # the consumer and token can be accessed
+    attr_accessor :consumer, :token
+
+    def initialize(consumer, token=nil)
+      @consumer = consumer
+      @token = token
+    end
+
+    def begin_authentication(callback_url)
+      # request a request token from the server
+      response = signed_post('http://api.rdio.com/oauth/request_token',
+                             {'oauth_callback' => callback_url})
+      # parse the response
+      parsed = CGI.parse(response)
+      # save the token
+      @token = [parsed['oauth_token'][0], parsed['oauth_token_secret'][0]]
+      # return an URL that the user can use to authorize this application
+      return parsed['login_url'][0] + '?oauth_token=' + parsed['oauth_token'][0]
+    end
+
+    def complete_authentication(verifier)
+      # request an access token
+      response = signed_post('http://api.rdio.com/oauth/access_token',
+                             {'oauth_verifier' => verifier})
+      # parse the response
+      parsed = CGI.parse(response)
+      # save the token
+      @token = [parsed['oauth_token'][0], parsed['oauth_token_secret'][0]]
+    end
+
+    def call(method, params={})
+      # make a copy of the dict
+      params = params.clone
+      # put the method in the dict
+      params['method'] = method
+      # call to the server and parse the response
+      return JSON.load(signed_post('http://api.rdio.com/1/', params))
+    end
+
+    private
+
+    def signed_post(url, params)
+      auth = OM::om(@consumer, url, params, @token)
+      url = URI.parse(url)
+      http = Net::HTTP.new(url.host, url.port)
+      req = Net::HTTP::Post.new(url.path, {'Authorization' => auth})
+      req.set_form_data(params)
+      res = http.request(req)
+      return res.body
+    end
+
+  end
+
+end

data/lib/rdio/types.rb

@@ -30,7 +30,7 @@ module Rdio
 
     attr_accessor :album_keys
 
-    # Returns an array of Album for the query and other params
+    # Returns an array of Artist for the query and other params
     def self.search(query,never_or=nil,extras=nil,start=nil,count=nil)
       extras = Rdio::add_to_array extras,'artists'
       Search.search query,Artist,never_or,extras,start,count

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: rdio
 version: !ruby/object:Gem::Version 
-  hash: 223
-  prerelease: 
+  hash: 419
+  prerelease: 6
   segments: 
   - 0
   - 0
-  - 96
-  version: 0.0.96
+  - 98
+  - b
+  version: 0.0.98b
 platform: ruby
 authors: 
 - Jeffrey Palm
@@ -15,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-15 00:00:00 Z
+date: 2012-03-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: oauth
@@ -52,6 +53,8 @@ files:
 - lib/rdio/datatypes.rb
 - lib/rdio/types.rb
 - lib/rdio/call.rb
+- lib/rdio/simple_om.rb
+- lib/rdio/simple_rdio.rb
 homepage: http://github.com/spudtrooper/rdiorb
 licenses: []
 
@@ -72,15 +75,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: 
 - launchy gem to use authorized calls
-rubyforge_project: "%NAME"
+rubyforge_project: rdio
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 2