rdio_api 0.1.0

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.yardoc
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rdio_api.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,20 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end

data/README.md

@@ -0,0 +1,115 @@
+Rdio 
+====================
+Ruby wrapper for the [Rdio](http://rdio.com) API. Inspired from [Linkedin gem](https://github.com/pengwynn/linkedin) & [Twitter gem](https://github.com/jnunemaker/twitter). 
+
+
+Installation
+------------
+    gem install rdio_api
+
+
+Usage
+-----
+
+Register for developer keys at [http://developer.rdio.com/](http://developer.rdio.com/).
+
+All the methods are exactly as in the [API docs](http://developer.rdio.com/docs/read/rest/Methods), camel cased and all the endpoints are also exactly the same.
+
+OAuth flow is not part of this gem. Recommend using [OmniAuth](https://github.com/intridea/omniauth). Also check Rdio [OAuth documentation](http://developer.rdio.com/docs/read/rest/oauth).
+
+
+Usage Examples
+--------------
+    require "rubygems"
+    require "rdio_api"
+
+    # Initialize a new Rdio client
+    client = RdioApi.new(:consumer_key => CONSUMER_KEY, :consumer_secret => CONSUMER_SECRET)
+
+    # Get songs in heavy rotation
+    client.getHeavyRotation(:type => "albums")
+
+	# Get top playlists
+	client.getTopCharts(:type => "Playlist")
+	
+	# Search for a query and and pass in the type
+	client.search(:query => "michael giacchino", :types => "album")
+	
+	# Get activity stream of a user
+	client.getActivityStream(:user => "s12345", :scope => "user")
+	
+	# Find a user by email address 
+	client.findUser(:email => "email@example.com")
+	
+	# Methods that act on behalf of a user require an access token, OmniAuth is best for this
+	
+	# Access token can be set at initialization 
+	client = RdioApi.new(:consumer_key => CONSUMER_KEY, 
+						 :consumer_secret => CONSUMER_SECRET, 
+						 :access_token => ACCESS_TOKEN)
+						
+	# Access token can also be set at the clien't access_token instance variable
+	client.access_token = ACCESS_TOKEN
+	
+	# Get info about the current user 
+	client.currentUser
+	
+	# Add a friend
+	client.addFriend(:user => "s12345")
+	
+	# Create a Playlist
+	client.createPlaylist(:name => "RubyGem", 
+	                      :description => "Testing", 
+	                      :tracks => "t1945474, t3483614")	
+
+Available Methods
+-----------------	
+	
+	# Unauthenticated methods, which only require registering for developer keys
+	client.get
+    client.getAlbumsForArtist
+    client.getTracksForArtist
+    client.search
+    client.searchSuggestions
+    client.getAlbumsForArtistInCollection
+    client.getAlbumsInCollection
+    client.getArtistsInCollection
+    client.getTracksForAlbumInCollection
+    client.getTracksForArtistInCollection
+    client.getTracksInCollection
+    client.findUser
+    client.userFollowers
+    client.userFollowing
+    client.getActivityStream
+    client.getHeavyRotation
+    client.getNewReleases
+    client.getTopCharts
+    client.getPlaybackToken
+
+	# Authenticated methods, which require an access token , obtained with user permission
+	client.getObjectFromShortCode
+    client.getObjectFromUrl
+    client.addToCollection
+    client.removeFromCollection
+    client.setAvailableOffline
+    client.addToPlaylist
+    client.createPlaylist
+    client.deletePlaylist
+    client.getPlaylists
+    client.removeFromPlaylist
+    client.setPlaylistCollaborating
+    client.setPlaylistCollaborationMode
+    client.setPlaylistFields
+    client.setPlaylistOrder
+    client.addFriend
+    client.currentUser
+    client.removeFriend
+
+TODO
+----
+* Explore moving methods from camel case to snake case and update tests accordingly
+* OAuth flow
+* More tests for methods and for each endpoints
+* Test and Support multiple Rubies
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/rdio_api/api.rb

@@ -0,0 +1,81 @@
+require 'multi_json'
+require 'hashie'
+
+module RdioApi
+  
+  module Api
+    
+    def method_missing(method_sym, *arguments)
+      if UNAUTHENTICATED.include?(method_sym)
+        unauthenticated_request(method_sym, *arguments)
+      elsif AUTHENTICATED.include?(method_sym)
+        authenticated_request(method_sym, *arguments)
+      else
+        raise NoMethodError.new("Undefined method '#{method_sym}' for #{self}")
+      end
+    end
+
+    def respond_to?(method)
+      AUTHENTICATED.include?(method.to_sym) || UNAUTHENTICATED.include?(method.to_sym) ? true : false
+    end
+    
+    private
+      
+    def unauthenticated_request(method_sym, *arguments)
+      response = unauthenticated_connection.post do |request|
+        request.body = {:method => method_sym.to_s}.merge!(Hash[*arguments.flatten])
+      end
+      response.body.result
+    end
+    
+    def authenticated_request(method_sym, *arguments)
+      if authenticated_connection
+        response = MultiJson.decode(authenticated_connection.post(api_url, 
+                                    {:method => method_sym.to_s}.merge!(Hash[*arguments.flatten])).body)['result']
+        response.is_a?(Hash) ? Hashie::Mash.new(response) : response
+      else
+        "Set access token at initialization or the client's access_token instance variable"
+      end
+    end
+
+    UNAUTHENTICATED = [
+      :get,
+      :getAlbumsForArtist,
+      :getTracksForArtist,
+      :search,
+      :searchSuggestions,
+      :getAlbumsForArtistInCollection,
+      :getAlbumsInCollection,
+      :getArtistsInCollection,
+      :getTracksForAlbumInCollection,
+      :getTracksForArtistInCollection,
+      :getTracksInCollection,
+      :findUser,
+      :userFollowers,
+      :userFollowing,
+      :getActivityStream,
+      :getHeavyRotation,
+      :getNewReleases,
+      :getTopCharts,
+      :getPlaybackToken]
+      
+    AUTHENTICATED = [
+      :getObjectFromShortCode,
+      :getObjectFromUrl,
+      :addToCollection,
+      :removeFromCollection,
+      :setAvailableOffline,
+      :addToPlaylist,
+      :createPlaylist,
+      :deletePlaylist,
+      :getPlaylists,
+      :removeFromPlaylist,
+      :setPlaylistCollaborating,
+      :setPlaylistCollaborationMode,
+      :setPlaylistFields,
+      :setPlaylistOrder,
+      :addFriend,
+      :currentUser,
+      :removeFriend]
+  end
+end

data/lib/rdio_api/client.rb

@@ -0,0 +1,48 @@
+module RdioApi
+  
+  class Client
+    
+    include Api
+    
+    attr_reader   :consumer_key, :consumer_secret 
+    attr_accessor :access_token
+    
+    # Initialize the client for API request. A consumer key and consumer secret are required. 
+    # Requests on behalf of the user require access_token (oauth token)
+    
+    def initialize(options={})
+      @consumer_key    = options[:consumer_key]
+      @consumer_secret = options[:consumer_secret]
+      @access_token    = options[:access_token]
+    end
+    
+    private
+
+    # Set up the connection to use for all requests based on the options from intialization. 
+
+    def unauthenticated_connection
+      params = {}
+      params[:consumer_key] = @consumer_key 
+      params[:consumer_secret] = @consumer_secret 
+      @connection ||= Faraday.new(:url => api_url) do |builder|
+        builder.use Faraday::Request::OAuth, params
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Response::Mashify 
+        builder.use Faraday::Response::ParseJson
+        builder.adapter Faraday.default_adapter
+      end
+    end
+    
+    # Sets the access token to make authenticated calls
+    
+    def authenticated_connection
+      @access_token
+    end
+
+    # Base URL for api requests
+
+    def api_url
+      ("http://api.rdio.com/1/").freeze
+    end
+  end
+end

data/lib/rdio_api/version.rb

@@ -0,0 +1,3 @@
+module RdioApi
+  VERSION = "0.1.0"
+end

data/lib/rdio_api.rb

@@ -0,0 +1,14 @@
+require "rdio_api/version"
+require 'faraday'
+require 'faraday_middleware'
+
+require 'rdio_api/api'
+require 'rdio_api/client'
+
+module RdioApi
+  
+  # RdioApi::Client.new alias
+  def self.new(options={})
+    RdioApi::Client.new(options)
+  end
+end

data/rdio_api.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rdio_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rdio_api"
+  s.version     = RdioApi::VERSION
+  s.authors     = ["Anil"]
+  s.homepage    = "http://github.com/anilv/rdio_api"
+  s.summary     = %q{A Ruby wrapper for the Rdio API}
+  s.description = %q{A Ruby wrapper for the Rdio API}
+  
+  s.add_development_dependency 'rake', '~> 0.9'
+  s.add_development_dependency 'rspec', '~> 2.6'
+  s.add_development_dependency 'webmock', '~>1.6'
+  s.add_development_dependency 'oauth', '~>0.4.5'
+  s.add_development_dependency 'rb-fsevent'
+  s.add_development_dependency 'guard-rspec'
+  
+  s.add_runtime_dependency 'faraday', '~> 0.6.1'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.6.5'
+  s.add_runtime_dependency 'hashie', '~> 1.0.0'
+  s.add_runtime_dependency 'multi_json', '~> 1.0.3'
+  s.add_runtime_dependency 'simple_oauth', '~> 0.1.5'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/fixtures/addFriend.json

@@ -0,0 +1,4 @@
+{
+    "status" :"ok",
+    "result" : "true"
+}

data/spec/fixtures/addToCollection.json

@@ -0,0 +1,4 @@
+{
+    "status" :"ok",
+    "result" : "true"
+}

data/spec/fixtures/addToPlaylist.json

@@ -0,0 +1,4 @@
+{
+    "status" :"ok",
+    "result" : "true"
+}

data/spec/fixtures/createPlaylist.json

@@ -0,0 +1,19 @@
+{
+    "status" :"ok",
+    "result" : {
+	 "ownerKey": "s27093", 
+	 "name": "RubyGem", 
+	 "baseIcon": "album/f/4/8/000000000002784f/square-200.jpg", 
+	 "ownerIcon": "user/no-user-image-square.jpg", 
+	 "owner": "Anil V", 
+	 "lastUpdated": 1312411563.0, 
+	 "shortUrl": "http://rd.io/x/QDaXL0BSKw", 
+	 "length": 2, 
+	 "url": "/people/anilv/playlists/200057/RubyGem/", 
+	 "key": "p200057", 
+	 "ownerUrl": "/people/anilv/", 
+	 "embedUrl": "http://rd.io/e/QDaXL0BSKw", 
+	 "type": "p", 
+	 "icon": "http://m.rdio.com/_is/?aid=284243,161871&w=200&h=200"
+	}
+}

data/spec/fixtures/currentUser.json

@@ -0,0 +1,14 @@
+{
+    "status" :"ok",
+    "result" : {
+	 "firstName": "Anil", 
+	 "baseIcon": "user/no-user-image-square.jpg", 
+	 "gender": "m", 
+	 "url": "/people/anilv/", 
+	 "key": "s27093", 
+	 "lastName": "V", 
+	 "libraryVersion": 110, 
+	 "type": "s", 
+	 "icon": "http://media.rd.io/user/no-user-image-square.jpg"
+	}
+}

data/spec/fixtures/deletePlaylist.json

@@ -0,0 +1,4 @@
+{
+    "status" :"ok",
+    "result" : "true"
+}

data/spec/fixtures/findUser.json

@@ -0,0 +1,14 @@
+{
+    "status" :"ok",
+    "result" : {
+	 "firstName": "Anil", 
+	 "baseIcon": "user/no-user-image-square.jpg", 
+	 "gender": "m", 
+	 "url": "/people/anilv/", 
+	 "key": "s27093", 
+	 "lastName": "V", 
+	 "libraryVersion": 110, 
+	 "type": "s", 
+	 "icon": "http://media.rd.io/user/no-user-image-square.jpg"
+	}
+}

data/spec/fixtures/get.json

@@ -0,0 +1,16 @@
+{
+    "status" :"ok",
+    "result" : {
+        "r13700" : {
+                "name" : "John Williams",
+            "hasRadio" : false,
+            "baseIcon" : "artist/4/8/5/0000000000003584/square-200.jpg",
+            "shortUrl" : "http://rd.io/x/Qi132w",
+              "length" : 2075,
+                 "url" : "/artist/John_Williams/",
+                 "key" : "r13700",
+                "type" : "r",
+                "icon" : "http://media.rd.io/artist/4/8/5/0000000000003584/square-200.jpg"
+        }
+    }
+}

data/spec/fixtures/getActivityStream.json

@@ -0,0 +1,18 @@
+{
+    "status" :"ok",
+    "result" : {
+	 "last_id": 0, 
+	 "user": {
+	  "firstName": "Anil", 
+	  "baseIcon": "user/no-user-image-square.jpg", 
+	  "gender": "m", 
+	  "url": "/people/anilv/", 
+	  "key": "s27093", 
+	  "lastName": "V", 
+	  "libraryVersion": 110, 
+	  "type": "s", 
+	  "icon": "http://media.rd.io/user/no-user-image-square.jpg"
+	 }, 
+	 "updates": []
+	}
+}