rdio 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Jeffrey Palm
+
+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.

data/README

@@ -0,0 +1,26 @@
+-*- outline -*-
+
+* ABOUT
+
+This is a ruby implementation of the rd.io API here:
+
+  http:/developer.rdio.com
+
+
+* USAGE
+
+To use it you have to get an api key and secret here:
+
+And then, currently, you can do something like the following:
+
+  key = <RDIO_KEY>
+  secret = <RDIO_SECRET>
+  Rdio::init key,sec
+  user = Rdio::User.find_by_email 'jeff@jeffpalm.com'
+  'Jeffrey' == user.first_name
+  'Palm' == user.last_name
+
+
+* TODO
+
+Lots

data/lib/rdio.rb

@@ -0,0 +1,87 @@
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+
+# core
+
+# stdlib
+require 'logger'
+
+# third party
+
+# internal requires
+require 'rdio/base'
+require 'rdio/api'
+require 'rdio/oauth'
+require 'rdio/datatypes'
+require 'rdio/types'
+
+module Rdio
+  VERSION = '0.0.1'
+
+  RDIO_KEY = 'RDIO_KEY'
+  RDIO_SECRET = 'RDIO_SECRET'
+
+  class << self
+    attr_accessor :debug
+    attr_accessor :logger
+    attr_accessor :log_json
+    attr_accessor :log_methods
+    attr_accessor :log_symbols
+    attr_accessor :log_posts
+    def log(str)
+      logger.debug { str }
+    end
+  end
+  self.debug = false
+  self.log_json = false
+  self.log_methods = false
+  self.log_symbols = false
+  self.log_posts = false
+
+  @logger ||= ::Logger.new(STDERR)
+  @api = nil
+
+  def self.version
+    VERSION
+  end
+
+  # Initializes and returns the shared Api instance and overwrites the
+  # existing one.
+  def self.init(key,secret)
+    @api = Api.new key,secret
+  end
+
+  # Resets -- mainly for oauth
+  def self.reset
+    @api = nil
+  end
+
+  # Returns the shared Rdio::Api instance.  If it hasn't been set, we
+  # try to construct it from thte environment
+  def self.api
+    return @api if @api
+    key = ENV[RDIO_KEY]
+    secret = ENV[RDIO_SECRET]
+    if key and secret
+      @api = init key,secret
+    else
+      msg = <<HERE
+Could not construct an Api instance.  You must first call init(key,secret)
+or set the following environmental variables:
+- #{RDIO_KEY}
+- #{RDIO_SECRET}
+HERE
+      raise Exception.new msg
+    end
+    return @api
+  end
+end
+
+# Silly syntax so you can say Rd::io...blah...blah...blah
+module Rd
+  
+  # Returns the shared Rdio::Api instance from Rdio::api
+  def self.io
+    Rdio::api
+  end
+
+end

data/lib/rdio/api.rb

@@ -0,0 +1,339 @@
+module Rdio
+  
+  # ----------------------------------------------------------------------
+  # Provides main API functionality by translating Ruby calls to REST
+  # calls to the super class
+  # ----------------------------------------------------------------------
+  class Api < BaseApi
+    
+    def initialize(key,secret)
+      super key,secret
+    end
+    
+    # Add a friend to the current user.
+    def addFriend(user)
+      method = 'addFriend'
+      type = true
+      args = {:user=>user}
+      return_object type,method,args,true
+    end
+    
+    # Add tracks or playlists to the current user's collection.
+    def addToCollection(objs)
+      method = 'addToCollection'
+      type = true
+      args = {:keys=>keys(objs)}
+      return_object type,method,args,true
+    end
+    
+    # Add a track to a playlist.
+    def addToPlaylist(playlist,tracks)
+      method = 'addToPlaylist'
+      type = true
+      args = {:playlist=>playlist, :tracks=>keys(tracks)}
+      return_object type,method,args,true
+    end
+    
+    # Create a new playlist in the current user's collection.  The new
+    # playlist will be returned if the creation is successful, otherwise
+    # null will be returned.
+    def createPlaylist(name,description,tracks,extras=nil)
+      method = 'createPlaylist'
+      type = Playlist
+      args = {:name=>name,:description=>description,
+        :tracks=>keys(tracks)}
+      args[:extras] = extras if extras
+      return_object type,method,args,true
+    end
+    
+    # Get information about the currently logged in user.
+    def currentUser(extras=nil)
+      method = 'currentUser'
+      type = User
+      args = {}
+      args[:extras] = extras if extras
+      return_object type,method,args,true
+    end
+    
+    # Delete a playlist.
+    def deletePlaylist(playlist)
+      method = 'deletePlaylist'
+      type = Boolean
+      args = {:playlist=>playlist}
+      return_object type,method,args,true
+    end
+    
+    # Find a user either by email address or by their username.  Exactly
+    # one of email or vanityName must be supplied.
+    def findUserByEmail(email)
+      method = 'findUser'
+      type = User
+      args = {:email=>email}
+      return_object type,method,args
+    end
+    
+    # Find a user either by email address or by their username.  Exactly
+    # one of email or vanityName must be supplied.
+    def findUserByVanityName(name)
+      method = 'findUser'
+      type = User
+      args = {:vanityName=>name}
+      return_object type,method,args
+    end
+    
+    # Fetch one or more objects from Rdio.
+    def get(objs,type=nil)
+      if not objs.is_a? Array
+        objs = [objs]
+      end
+      method = 'get'
+      cls = type
+      args = {:keys=>keys(objs)}
+      json = call method,args
+      create_object type,json,true
+    end
+    
+    # Get the activity events for a user, a user's friends, or
+    # everyone on Rdio.
+    def getActivityStream(user,scope,last_id=nil)
+      method = 'getActivityStream'
+      type = ActivityStream
+      args = {:user=>user,:scope=>scope}
+      args[:last_id] = last_id if last_id
+      return_object type,method,args
+    end
+    
+    # Return the albums by (or featuring) an artist.
+    def getAlbumsForArtist(artist,featuring=nil,extras=nil,start=nil,count=nil)
+      method = 'getAlbumsForArtist'
+      type = Album
+      args = {:artist=>artist}
+      args[:featuring] = featuring if featuring
+      args[:extras] = extras if extras
+      args[:start] = start if start
+      args[:count] = count if count
+      return_object type,method,args
+    end
+    
+    # Get the albums in the user's collection by a particular artist.
+    def getAlbumsForArtistInCollection(artist,user=nil)
+      method = 'getAlbumsForArtistInCollection'
+      type = Album
+      args = {:artist=>artist}
+      args[:user] = user if user
+      return_object type,method,args
+    end
+    
+    # Get all of the albums in the user's collection.
+    def getAlbumsInCollection(user=nil,start=nil,count=nil,sort=nil,query=nil)
+      method = 'getAlbumsInCollection'
+      type = Album
+      args = {}
+      args[:user] = user if user
+      args[:start] = start if start
+      args[:count] = count if count
+      args[:sort] = sort if sort
+      args[:query] = query if query
+      return_object type,method,args
+    end
+    
+    # Get all of the artist in a user's collection.
+    def getArtistsInCollection(user=nil,start=nil,count=nil,sort=nil,query=nil)
+      method = 'getArtistsInCollection'
+      type = Artist
+      args = {}
+      args[:user] = user if user
+      args[:start] = start if start
+      args[:count] = count if count
+      args[:sort] = sort if sort
+      args[:query] = query if query
+      return_object type,method,args
+    end
+    
+    # Find the most popular artists or albums for a user, their friends
+    # or the whole site.
+    def getHeavyRotation(user=nil,type=nil,friends=nil,limit=nil)
+      method = 'getHeavyRotation'
+      cls = TODO
+      if type == 'artist'
+        cls = Artist
+      elsif type == 'album'
+        cls = Album
+      end
+      args = {}
+      args[:user] = user if user
+      args[:type] = type if type
+      args[:friends] = friends if friends
+      args[:limit] = limit if limit
+      return_object cls,method,args
+    end
+    
+    # Return new albums released across a timeframe.
+    def getNewReleases(time=nil,start=nil,count=nil,extras=nil)
+      method = 'getNewReleases'
+      type = Album
+      args = {}
+      args[:time] = time if time
+      args[:start] = start if start
+      args[:count] = count if count
+      args[:extras] = extras if extras
+      return_object type,method,args
+    end
+    
+    # Return the object that the supplied Rdio short-code is a
+    # representation of, or null if the short-code is invalid.
+    def getObjectFromShortCode(short_code,type=nil)
+      method = 'getObjectFromShortCode'
+      type = BaseObj if not type
+      args = {:short_code=>short_code}
+      return_object type,method,args,true
+    end
+    
+    # Return the object that the supplied Rdio url is a representation
+    # of, or null if the url doesn't represent an object.
+    def getObjectFromUrl(url,type=nil)
+      method = 'getObjectFromUrl'
+      type = BaseObj if not type
+      args = {:url=>url}
+      return_object type,method,args,true
+    end
+    
+    # Get an playback token. If you are using this for web playback you
+    # must supply a domain.
+    def getPlaybackToken(domain=nil)
+      method = 'getPlaybackToken'
+      type = String
+      args = {}
+      args[:domain] = domain if domain
+      return_object type,method,args,true
+    end
+      
+    # Get the current user's playlists.
+    def getPlaylists(extras=nil)
+      method = 'getPlaylists'
+      type = Playlist
+      args = {}
+      args[:extras] = extras if extras
+      return_object type,method,args,true
+    end
+    
+    # Return the site-wide most popular items for a given type.
+    def getTopCharts(type,start=nil,count=nil,extras=nil)
+      method = 'getTopCharts'
+      cls = TODO
+      case type
+      when 'Artist':
+          cls = Artist
+      when 'Album':
+          cls = Album
+      when 'Track':
+          cls = Track
+      when 'Playlist':
+          cls = Playlist
+      end
+      args = {:type=>type}
+      return_object cls,method,args
+    end
+    
+    # Which tracks on the given album are in the user's collection.
+    def getTracksForAlbumInCollection(album,user=nil,extras=nil)
+      method = 'getTracksForAlbumInCollection'
+      type = Track
+      args = {:album=>album}
+      args[:user] = user if user
+      args[:extras] = extras if extras
+      return_object type,method,args
+    end
+    
+    # Get all of the tracks by this artist.
+    def getTracksForArtist(artist,appears_on=nil,start=nil,count=nil,extras=nil)
+      method = 'getTracksForArtist'
+      type = Track
+      args = {:artist=>artist}
+      args[:appears_on] = appears_on if appears_on
+      args[:start] = start if start
+      args[:count] = count if count
+      args[:extras] = extras if extras
+      return_object type,method,args
+    end
+    
+    # Which tracks from the given artist are in the user's collection.
+    def getTracksForArtistInCollection(artist,user=nil,extras=nil)
+      method = 'getTracksForArtistInCollection'
+      type = Track
+      args = {:artist=>artist}
+      args[:user] = user if user
+      args[:extras] = extras if extras
+      return_object type,method,args
+    end
+    
+    # Get all of the tracks in the user's collection.
+    def getTracksInCollection(user=nil,start=nil,count=nil,sort=nil,query=nil)
+      method = 'getTracksInCollection'
+      type = Track
+      args = {}
+      args[:user] = user if user
+      args[:start] = start if start
+      args[:count] = count if count
+      args[:sort] = sort if sort
+      args[:query] = query if query
+      return_object type,method,args
+    end
+    
+    # Remove a friend from the current user.
+    def removeFriend(user)
+      method = 'removeFriend'
+      type = Boolean
+      args = {:user=>user}
+      return_object type,method,args,true
+    end
+    
+    # Remove tracks or playlists from the current user's collection.
+    def removeFromCollection(objs)
+      method = 'removeFromCollection'
+      type = Boolean
+      args = {:keys=>keys(objs)}
+      return_object type,method,args
+    end
+    
+    # Remove an item from a playlist by its position in the playlist.
+    def removeFromPlaylist(playlist,index,count,tracks)
+      method = 'removeFromPlaylist'
+      type = TODO
+      args = {:playlist=>playlist,:index=>index,
+        :count=>count,:tracks=>keys(tracks)}
+      return_object type,method,args,truex
+    end
+    
+    # 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)
+      method = 'search'
+      type = TODO
+      args = {:query=>query}
+      args[:types] = types if types
+      args[:never_or] = never_or if never_or
+      args[:extras] = extras if extras
+      args[:start] = start if start
+      args[:count] = count if count
+      
+      json = call method,args
+      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
+    end
+    
+  end
+
+end