rdio 0.0.5 → 0.0.6

data/lib/rdio/api.rb

@@ -82,13 +82,14 @@ module Rdio
     end
     
     # Fetch one or more objects from Rdio.
-    def get(objs,type=nil)
+    def get(objs,type=nil,extras=nil)
       if not objs.is_a? Array
         objs = [objs]
       end
       method = 'get'
       cls = type
       args = {:keys=>keys(objs)}
+      args[:extras] = extras if extras
       json = call method,args
       if Rdio::log_json
         Rdio::log "json: #{json}"
@@ -103,7 +104,8 @@ module Rdio
       type = ActivityStream
       args = {:user=>user,:scope=>scope}
       args[:last_id] = last_id if last_id
-      return_object type,method,args
+      auth = user
+      return_object type,method,args,auth
     end
     
     # Return the albums by (or featuring) an artist.
@@ -124,7 +126,8 @@ module Rdio
       type = Album
       args = {:artist=>artist}
       args[:user] = user if user
-      return_object type,method,args
+      auth = !!user
+      return_object type,method,args,auth
     end
     
     # Get all of the albums in the user's collection.
@@ -137,7 +140,8 @@ module Rdio
       args[:count] = count if count
       args[:sort] = sort if sort
       args[:query] = query if query
-      return_object type,method,args
+      auth = !!user
+      return_object type,method,args,auth
     end
     
     # Get all of the artist in a user's collection.
@@ -150,7 +154,8 @@ module Rdio
       args[:count] = count if count
       args[:sort] = sort if sort
       args[:query] = query if query
-      return_object type,method,args
+      auth = !!user
+      return_object type,method,args,auth
     end
     
     # Find the most popular artists or albums for a user, their friends
@@ -310,8 +315,54 @@ module Rdio
     
     # Search for artists, albums, tracks, users or all kinds of objects.
     def search(query,types=nil,never_or=nil,extras=nil,start=nil,count=nil)
+      result = search_json query,types,never_or,extras,start,count
+      return result if not result
+      results = result['results'] || []
+      api = self
+      #
+      # This start out nil, because we need to reference classes in
+      # types.rb and this gets loaded after this file.  There's
+      # probably a better way to do this.
+      #
+      if not @@types2classes
+        @@types2classes = {
+          'r' => Artist,
+          'a' => Album,
+          's' => User,
+          't' => Track,
+          'p' => Playlist
+        }
+      end
+      results.map {|o| @@types2classes[o['type']].new(api).fill o}
+    end
+
+    def counts(query,types=nil,never_or=nil,extras=nil,start=nil,count=nil)
+      obj = search_json query,types,never_or,extras,start,count
+      return JSONObj.new obj
+    end
+    
+    # Match the supplied prefix against artists, albums, tracks and
+    # people in the Rdio system.  Return the first ten matches.
+    def searchSuggestions(query,extras)
+      method = 'searchSuggestions'
+      type = TODO
+      args = {:query=>query}
+      args[:extras] = extras if extras
+      return_object type,method,args
+    end
+
+    private
+
+    # Initialize this after types.rb has been loaded (this stinks!)
+    @@types2classes = nil
+
+    # Search for artists, albums, tracks, users or all kinds of objects.
+    def search_json(query,types=nil,never_or=nil,extras=nil,start=nil,count=nil)
       method = 'search'
       type = TODO
+      if not types
+        types = 'Artist,Album,Track,Playlist,User'
+      end
       args = {:query=>query}
       args[:types] = types if types
       args[:never_or] = never_or if never_or
@@ -323,18 +374,7 @@ module Rdio
       if Rdio::log_json
         Rdio::log json
       end
-      obj = unwrap_json json
-      return JSONObj.new obj
-    end
-    
-    # Match the supplied prefix against artists, albums, tracks and
-    # people in the Rdio system.  Return the first ten matches.
-    def searchSuggestions(query,extras)
-      method = 'searchSuggestions'
-      type = TODO
-      args = {:query=>query}
-      args[:extras] = extras if extras
-      return_object type,method,args
+      return unwrap_json json
     end
     
   end

data/lib/rdio/base.rb

@@ -1,14 +1,39 @@
 require 'rubygems'
 require 'json'
 
+# Make sure objects return 'self' by default to 'to_k', then we can
+# override this for subsequent types -- like Artist, Track, etc --
+# that need to use their key for this value
 class Object
   def to_k
     return self
   end
 end
 
+# When putting classes into arguments to BaseApi.call we want to use a
+# classes simple name for the argument value
+class Class
+  def to_k
+    name.gsub /.*\:\:/,''
+  end
+end
+
 module Rdio
 
+  # Adds 'str' to the array or string 'arr'
+  def add_to_array(arr,str)
+    if arr == nil
+      return [str.to_s]
+    end
+    if arr == ''
+      return [str.to_s]
+    end
+    if arr.is_a? Array
+      return arr + [str.to_s]
+    end
+    return arr.to_s + ',' + str.to_s
+  end
+
   # string -> string
   #
   # Converts camel-case string to underscore-delimited one.
@@ -26,7 +51,15 @@ module Rdio
     s
   end
 
+  # hash -> hash
+  #
+  # Uses the value of 'to_k' for all the iput hash values in the
+  # result hash. This is used to make sure that the arguments passed
+  # to create urls use keys for the values of objects like Artist,
+  # Track, etc.  Also, we use the simple name of classes.
+  #
   def convert_args(args)
+    return nil if not args
     res = {}
     args.each do |k,v|
       if v.is_a? Array
@@ -39,8 +72,13 @@ module Rdio
     return res
   end
   
+  # array -> string
+  #
+  # Creates a ','-separated string of the value of 'to_k' from all the
+  # values in 'objs'.  We also remove the nils from the input array.
+  #
   def keys(objs)
-    objs.map {|x| x.to_k}.join ','
+    (not objs) ? '' : objs.compact.map {|x| x.to_k}.join(',')
   end
 
   # object -> value
@@ -49,7 +87,7 @@ module Rdio
   # can have primitives other than strings as attributes of BaseObjs.
   #
   def to_o(v)
-    if not v
+    if v == nil
       return nil
     end
     s = v.to_s
@@ -59,7 +97,7 @@ module Rdio
     if s == 'nil'
       return nil
     end
-    if s =~ /^\d+/
+    if s =~ /^\d+$/
       return s.to_i
     end
     if s =~ /^\d+\.?\d*$/
@@ -79,9 +117,11 @@ module Rdio
     return s
   end
 
-  # Override this to declare how certain attributes are constructed.
-  # This is done at the end of types.rb.
   class << self
+    #
+    # Override this to declare how certain attributes are constructed.
+    # This is done at the end of types.rb.
+    #
     attr_accessor :symbols_to_types
   end
   self.symbols_to_types = {}
@@ -116,11 +156,7 @@ module Rdio
           # Allow simple types that are used for arrays
           #
           if v.is_a? Array
-            o = v.map do |x|
-              obj = type.new api
-              obj.fill x
-              obj
-            end
+            o = v.map {|x| type.new(api).fill x}
           else
             o = type.new api
             o.fill v
@@ -132,10 +168,11 @@ module Rdio
           sym_eq = (camel2underscores(k)+'=').to_sym
           self.send sym_eq,o
         rescue Exception => e
-          STDERR.puts "Couldn't find symbol: " +
+          Rdio::logger.warn "Couldn't find symbol: " +
             "#{sym} => #{o} for type: #{self.class}"
         end
       end
+      self
     end
 
   end
@@ -181,8 +218,7 @@ module Rdio
 
     # Compares only by key
     def eql?(that)  
-      self.class.equal?(that.class) and 
-        self.key.equal?(that.key)
+      self.class.equal? that.class and self.key.equal? that.key
     end
 
     def to_k
@@ -198,12 +234,29 @@ module Rdio
   # ----------------------------------------------------------------------
   class BaseApi
 
+    PATH = '/1/'
+
+    attr_reader :oauth
+
     def initialize(key,secret)
       @oauth = RdioOAuth.new key,secret
       @access_token_auth = nil
       @access_token_no_auth = nil
     end
 
+    # (string -> string) -> (string -> string)
+    #
+    # Sets the function that will return a pin given an authorization
+    # url for the contained RdioOAuth instance
+    #
+    def get_pin=(get_pin)
+        @oauth.get_pin = get_pin
+    end
+
+    def get_pin
+      @oauth.get_pin
+    end
+
     def call(method,args,requires_auth=false)
       #
       # Convert object with keys just to use their keys
@@ -217,7 +270,7 @@ module Rdio
       args.each do |k,v|
         new_args[k] = v.to_k.to_s
       end
-      url = '/1/'
+      url = PATH
       if Rdio::log_posts
         Rdio::log "Post to url=#{url} method=#{method} args=#{args}"
       end

data/lib/rdio/oauth.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'oauth'
-require 'open-uri'
 
 module Rdio
 
@@ -10,10 +9,39 @@ module Rdio
   class RdioOAuth
 
     SITE = 'http://api.rdio.com'
+    
+    # string[url] -> string
+    #
+    # Set this to allow a different way to enter the pin found for
+    # authorization.  By default it will open a browser and repeatedly
+    # ask the user for input from the console.
+    #
+    attr_accessor :get_pin
 
     def initialize(key,secret)
       @key = key
       @secret = secret
+      @get_pin = lambda do |url|
+
+        # Try to open using launchy, then if this doesn't work us open
+        begin
+          require 'rubygems'
+          require 'launchy'
+          Launchy.open url
+        rescue Exception => e
+          Rdio::log.error e
+          Rdio::log.info 'Install the \'launchy\' gem to avoid this error'
+          system 'open',url
+        end
+        
+        oauth_verifier = nil
+        while not oauth_verifier or oauth_verifier == ''
+          print 'Enter the 4-digit PIN> '
+          STDOUT.flush
+          oauth_verifier = gets.strip
+        end
+        return oauth_verifier
+      end
     end
 
     def access_token(requires_auth=false)
@@ -36,17 +64,11 @@ module Rdio
                               :authorize_path => "/oauth/authorize",
                               :access_token_path => "/oauth/access_token",
                               :http_method => :post})
-
+      consumer.http.read_timeout = 600
       request_token = consumer.get_request_token({:oauth_callback => 'oob'})
       url = 'https://www.rdio.com/oauth/authorize?oauth_token=' + 
-        request_token.token.to_s
-      system 'open',url
-
-      oauth_verifier = nil
-      while not oauth_verifier or oauth_verifier == ''
-        print 'Enter the PIN> '
-        oauth_verifier = gets.strip
-      end
+        request_token.token.to_s      
+      oauth_verifier = @get_pin.call url
       request_token.get_access_token({:oauth_verifier => oauth_verifier})
     end
   end

data/lib/rdio/types.rb

@@ -27,6 +27,14 @@ module Rdio
 
     attr_accessor :tracks
 
+    attr_accessor :album_keys
+
+    # Returns an array of Album for the query and other params
+    def self.search(query,never_or=nil,extras=nil,start=nil,count=nil)
+      extras = add_to_array extras,'artists'
+      Search.search query,Artist,never_or,extras,start,count
+    end
+
     # Get all of the tracks by this artist.
     def tracks(appears_on=nil,start=nil,count=nil,extras=nil)
       api.getTracksForArtist self,appears_on,start,count,extras
@@ -43,13 +51,13 @@ module Rdio
     end
 
     # Fetch one or more objects from Rdio of type Artist.
-    def self.all(keys)
-      Rdio::api.get keys,Artist
+    def self.all(keys,extras=nil)
+      Rdio::api.get keys,Artist,extras
     end
 
     # Fetch one object from Rdio of type Artist.
-    def self.get(key)
-      arr = all [key]
+    def self.get(key,extras=nil)
+      arr = all [key],extras
       (arr and not arr.empty?) ? arr[0] : nil
     end
 
@@ -97,14 +105,45 @@ module Rdio
     # the tracks
     attr_accessor :tracks
 
+    # is the album explicit?
+    def explicit?
+      is_explicit
+    end
+
+    # is the album clean
+    def clean?
+      is_clean
+    end
+    
+    # Returns the Artist
+    def artist
+      Artist.get artist_key
+    end
+
+    # Returns the String artist name
+    def artist_name
+      @artist
+    end
+
+    # Return an array of Track
+    def tracks(extras=nil)
+      Track.all @tracks,extras
+    end
+
+    # Returns an array of Album for the query and other params
+    def self.search(query,never_or=nil,extras=nil,start=nil,count=nil)
+      extras = add_to_array extras,'albums'
+      Search.search query,Album,never_or,extras,start,count
+    end
+
     # Fetch one or more objects from Rdio of type Album.
-    def self.all(keys)
-      Rdio::api.get keys,Album
+    def self.all(keys,extras=nil)
+      Rdio::api.get keys,Album,extras
     end
 
     # Fetch one object from Rdio of type Album.
-    def self.get(key)
-      arr = all [key]
+    def self.get(key,extras=nil)
+      arr = all [key],extras
       (arr and not arr.empty?) ? arr[0] : nil
     end
 
@@ -168,6 +207,42 @@ module Rdio
     # the secondary id
     attr_accessor :secondary_id
 
+    # Returns the Album
+    def album(extras=nil)
+      Album.get @album_key,extras
+    end
+
+    # Returns the Artist
+    def artist(extras=nil)
+      Artist.get @artist_key,extras
+    end
+
+    # Returns the album Artist
+    def album_artist(extras=nil)
+      Artist.get @album_artist_key,extras
+    end
+
+    # Returns the String album name
+    def album_name
+      @album
+    end
+
+    # Returns the string artist name
+    def artist_name
+      @artist
+    end
+
+    # Returns the string album artist name
+    def album_artist_name
+      @album_artist
+    end
+
+    # Returns an array of Track for the query and other params
+    def self.search(query,never_or=nil,extras=nil,start=nil,count=nil)
+      extras = add_to_array extras,'tracks'
+      Search.search query,Track,never_or,extras,start,count
+    end
+
     # Get all of the tracks in the user's collection.
     def self.in_collection(user=nil,start=nil,count=nil,sort=nil,query=nil)
       Rdio::api.getTracksInCollection user,start,count,sort,query
@@ -185,13 +260,13 @@ module Rdio
     end
 
     # Fetch one or more objects from Rdio of type Track.
-    def self.all(keys)
-      Rdio::api.get keys,Track
+    def self.all(keys,extras=nil)
+      Rdio::api.get keys,Track,extras
     end
 
     # Fetch one object from Rdio of type Track.
-    def self.get(key)
-      arr = all [key]
+    def self.get(key,extras=nil)
+      arr = all [key],extras
       return (arr and not arr.empty?) ? arr[0] : nil
     end
 
@@ -233,6 +308,11 @@ module Rdio
       api.removeFromPlaylist self,index,count,tracks
     end
 
+    # Returns an array of Playlist for the query and other params
+    def self.search(query,never_or=nil,extras=nil,start=nil,count=nil)
+      extras = add_to_array extras,'playlists'
+      Search.search query,Playlist,never_or,extras,start,count
+    end
 
     # Add a track to a playlist.
     def add_to_playlist(tracks)
@@ -252,13 +332,13 @@ module Rdio
     end
 
     # Fetch one or more objects from Rdio of type Playlist.
-    def self.all(keys)
-      Rdio::api.get keys,Playlist
+    def self.all(keys,extras=nil)
+      Rdio::api.get keys,Playlist,extras
     end
 
     # Fetch one object from Rdio of type Playlist.
-    def self.get(key)
-      arr = all [key]
+    def self.get(key,extras=nil)
+      arr = all [key],extras
       return (arr and not arr.empty?) ? arr[0] : nil
     end
 
@@ -296,6 +376,12 @@ module Rdio
       api.getActivityStream self,scope,last_id
     end
 
+    # Returns an array of User for the query and other params
+    def self.search(query,never_or=nil,extras=nil,start=nil,count=nil)
+      extras = add_to_array extras,'users'
+      Search.search query,User,never_or,extras,start,count
+    end
+
     # Get information about the currently logged in user.
     def self.current(extras=nil)
       Rdio::api.currentUser extras
@@ -317,19 +403,18 @@ module Rdio
     end
 
     # Fetch one or more objects from Rdio of type User.
-    def self.all(keys)
-      Rdio::api.get keys,User
+    def self.all(keys,extras=nil)
+      Rdio::api.get keys,User,extras
     end
 
     # Fetch one object from Rdio of type User.
-    def self.get(key)
-      arr = all [key]
+    def self.get(key,extras=nil)
+      arr = all [key],extras
       return (arr and not arr.empty?) ? arr[0] : nil
     end
 
     # Get all of the albums in the user's collection.
-    def albums_in_collection(start=nil,count=nil,
-                                 sort=nil,query=nil)
+    def albums_in_collection(start=nil,count=nil,sort=nil,query=nil)
       api.getAlbumsInCollection self,start,count,sort,query
     end
 
@@ -498,6 +583,13 @@ module Rdio
   # Wrapper for search
   class Search
     
+    # Search for 'query' and other parameters
+    def self.counts(query,types=nil,never_or=nil,extras=nil,start=nil,count=nil)
+      Rdio::api.counts query,types,never_or,extras,start,count
+    end
+
+    # Searches for objects with type 'type' and 'query' and other
+    # parameters
     def self.search(query,types=nil,never_or=nil,extras=nil,start=nil,count=nil)
       Rdio::api.search query,types,never_or,extras,start,count
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rdio
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Jeffrey Palm
@@ -15,10 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-19 00:00:00 -04:00
+date: 2011-03-23 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id001
 description: Ruby implementation of rd.io REST api
 email: jeff@jeffpalm.com
 executables: []
@@ -38,7 +53,7 @@ files:
 - lib/rdio/datatypes.rb
 - lib/rdio/types.rb
 has_rdoc: true
-homepage: http://github.com/spudtrooper/rdio
+homepage: http://github.com/spudtrooper/rdiorb
 licenses: []
 
 post_install_message: 
@@ -64,8 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       segments: 
       - 0
       version: "0"
-requirements: []
-
+requirements: 
+- launchy gem to use authorized calls
 rubyforge_project: "%NAME"
 rubygems_version: 1.6.1
 signing_key: