rdio_api 0.1.0

data/spec/fixtures/userFollowing.json

@@ -0,0 +1,27 @@
+{
+    "status" :"ok",
+    "result" : [
+	 {
+	  "firstName": "Ruby", 
+	  "baseIcon": "user/no-user-image-square.jpg", 
+	  "gender": "m", 
+	  "url": "/people/rubygithubber/", 
+	  "key": "s12346", 
+	  "lastName": "Githubber", 
+	  "libraryVersion": 0, 
+	  "type": "s", 
+	  "icon": "http://media.rd.io/user/no-user-image-square.jpg"
+	 }, 
+	 {
+	  "firstName": "Rdio", 
+	  "baseIcon": "user/no-user-image-square.jpg", 
+	  "gender": "f", 
+	  "url": "/people/rdioapi/", 
+	  "key": "s12347", 
+	  "lastName": "Api", 
+	  "libraryVersion": 80, 
+	  "type": "s", 
+	  "icon": "http://media.rd.io/user/no-user-image-square.jpg"
+	 }
+	]
+}

data/spec/helper.rb

@@ -0,0 +1,26 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'rdio_api'
+require 'rspec'
+require 'webmock/rspec'
+require 'oauth'
+
+def stub_post
+  stub_request(:post, "http://api.rdio.com/1/")
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+def test_consumer
+  @test_consumer ||= OAuth::Consumer.new("consumer_key", "consumer_secret")
+end
+
+def test_access_token
+  @test_access_token ||= OAuth::AccessToken.new(test_consumer, "auth_token", "auth_secret")
+end

data/spec/rdio_api/activity_spec.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+describe RdioApi::Client do
+  
+  context "when working with the Activity methods" do
+    before do
+      @client = RdioApi.new(:consumer_key => "consumerkey", :consumer_secret => "consumersecret")
+    end
+   
+    describe "'getActivityStream'" do
+      before do
+        stub_post.with(:body => {:method => 'getActivityStream', :user => "s27093", :scope => "user"}).
+          to_return(:body => fixture("getActivityStream.json"))
+      end
+      
+      it "should have the correct user library version" do
+        results = @client.getActivityStream(:user => "s27093", :scope => "user")
+        results.user.libraryVersion.should eq(110)
+      end
+    end
+    
+    describe "'getHeavyRotation'" do
+      before do
+        stub_post.with(:body => {:method => 'getHeavyRotation', :type => "albums"}).
+          to_return(:body => fixture("getHeavyRotation.json"))
+      end
+      
+      it "should return all 10 albums" do
+        results = @client.getHeavyRotation(:type => "albums")
+        results.count.should eq(10)
+      end
+    end
+    
+    describe "'getNewReleases'" do
+      before do
+        stub_post.with(:body => {:method => 'getNewReleases', :type => "thisweek"}).
+          to_return(:body => fixture("getNewReleases.json"))
+      end
+      
+      it "should return the correct name for the first album" do
+        results = @client.getNewReleases(:type => "thisweek")
+        results.first.name.should eq("King (Deluxe Version)")
+      end
+    end
+    
+    describe "'getTopCharts'" do
+      before do
+        stub_post.with(:body => {:method => 'getTopCharts', :type => "Playlist"}).
+          to_return(:body => fixture("getTopCharts.json"))
+      end
+      
+      it "should return the correct Playlists" do
+        results = @client.getTopCharts(:type => "Playlist")
+        results.count.should eq(11)
+        results.first.name.should eq("Billboard Top 100")
+      end
+    end
+  end
+end

data/spec/rdio_api/catalog_spec.rb

@@ -0,0 +1,77 @@
+require 'helper'
+
+describe RdioApi::Client do
+  
+  context "when working with the Catalog methods" do
+    before do
+      @client = RdioApi.new(:consumer_key => "consumerkey", :consumer_secret => "consumersecret")
+    end
+    
+    describe "'getAlbumsForArtist'" do
+      
+      context "with artist key passed" do
+        before do
+          stub_post.with(:body => {:method => 'getAlbumsForArtist', :artist => "r20227"}).
+            to_return(:body => fixture("getAlbumsForArtist.json"))
+        end
+
+        it "should return Array of Albums" do
+          albums = @client.getAlbumsForArtist(:artist => "r20227")
+          albums.should be_an Array
+          albums.first.name.should eq("My Beautiful Dark Twisted Fantasy")
+        end
+      end
+    end
+    
+    describe "'getTracksForArtist'" do
+      
+      context "with artist key passed" do
+        before do
+          stub_post.with(:body => {:method => 'getTracksForArtist', :artist => "r311065"}).
+            to_return(:body => fixture("getTracksForArtist.json"))
+        end
+        
+        it "should return Array of Tracks" do
+          tracks = @client.getTracksForArtist(:artist => "r311065")
+          tracks.should be_an Array
+          tracks.last.duration.should eq(121)
+        end
+      end
+    end
+    
+    describe "'search'" do
+      
+      context "with query and types passed" do
+        before do
+          stub_post.with(:body => {:method => 'search', :query => "michael giacchino", :types => "album"}).
+            to_return(:body => fixture("search.json"))
+        end
+        
+        it "should have correct track count" do
+          results = @client.search(:query => "michael giacchino", :types => "album")
+          results.track_count.should eq(708)
+        end
+        
+        it "should include correct track for a result" do
+          results = @client.search(:query => "michael giacchino", :types => "album")
+          results.results.first.trackKeys.should include("t9506546")
+        end
+      end
+    end
+    
+    describe "'searchSuggestions'" do
+      
+      context "with query passed" do
+        before do
+          stub_post.with(:body => {:method => 'searchSuggestions', :query => "yoav"}).
+            to_return(:body => fixture("searchSuggestions.json"))
+        end
+        
+        it "should the correct radioKey" do
+          suggestions = @client.searchSuggestions(:query => "yoav")
+          suggestions.first.radioKey.should eq("rr316321")
+        end
+      end
+    end
+  end
+end

data/spec/rdio_api/client_spec.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+describe RdioApi::Client do
+  
+  context "When initializing a new instance" do
+    
+    it "should keep oauth token for requests" do
+      @client = RdioApi.new(:access_token => 'rdiooauth')
+      @client.access_token.should eq('rdiooauth')
+    end
+
+    it "should keep consumer key/secret for requests" do
+      @client = RdioApi.new(:consumer_key => "consumerkey", :consumer_secret => "consumersecret")
+      @client.consumer_key.should eq("consumerkey")
+      @client.consumer_secret.should eq("consumersecret")
+    end
+  end
+end

data/spec/rdio_api/collection_spec.rb

@@ -0,0 +1,127 @@
+require 'helper'
+
+describe RdioApi::Client do
+  
+  context "when working with the Collection methods" do
+    before do
+      @client = RdioApi.new(:consumer_key => "consumerkey", :consumer_secret => "consumersecret")
+    end
+    
+    context "and methods that require authentication " do
+      before do
+        @client.access_token = test_access_token
+      end
+      
+      describe "'addToCollection'" do
+        before do
+          stub_post.with(:body => {:method => 'addToCollection', :keys => "t3802391"}).
+            to_return(:body => fixture("addToCollection.json"))
+        end
+        
+        it "should add track to Collection" do
+          results = @client.addToCollection(:keys => "t3802391")
+          results.should eq("true")
+        end
+      end
+      
+      describe "'removeFromCollection'" do
+        before do
+          stub_post.with(:body => {:method => 'removeFromCollection', :keys => "t3802391"}).
+            to_return(:body => fixture('removeFromCollection.json'))
+        end
+        
+        it "should remove track from Collection" do
+          results = @client.removeFromCollection(:keys => "t3802391")
+          results.should eq("true")
+        end
+      end
+      
+      describe "'setAvailableOffline'" do
+        before do
+          stub_post.with(:body => {:method => 'setAvailableOffline', :keys => "t1945474", :offline => "true"}).
+            to_return(:body => fixture("setAvailableOffline.json"))
+        end
+        
+        it "should return true with setting track available offline" do
+          results = @client.setAvailableOffline(:keys => "t1945474", :offline => "true")
+          results.should eq("true")
+        end
+      end
+    end
+    
+    context "and methods that do not require authentication" do
+      
+      describe "'getAlbumsForArtistInCollection'" do
+        before do
+          stub_post.with(:body => {:method => 'getAlbumsForArtistInCollection', :artist => "r350868"}).
+            to_return(:body => fixture("getAlbumsForArtistInCollection.json"))
+        end
+        
+        it "should have the correct first track name" do
+          results = @client.getAlbumsForArtistInCollection(:artist => "r350868")
+          results.first.tracks.first.name.should eq("A Game of Thrones")
+        end
+      end
+      
+      describe "'getAlbumsInCollection'" do
+        before do
+          stub_post.with(:body => {:method => 'getAlbumsInCollection', :user => "s27093"}).
+            to_return(:body => fixture("getAlbumsInCollection.json"))
+        end
+        
+        it "should have the correct artist name for the last album in collection" do
+          results = @client.getAlbumsInCollection(:user => "s27093")
+          results.last.artist.should eq("Ennio Morricone")
+        end
+      end
+      
+      describe "'getArtistsInCollection'" do
+        before do
+          stub_post.with(:body => {:method => 'getArtistsInCollection', :user => "s27093"}).
+            to_return(:body => fixture("getArtistsInCollection.json"))
+        end
+        
+        it "should have the correct artist for the first artist in collection" do
+          results = @client.getArtistsInCollection(:user => "s27093")
+          results.first.name.should eq("Arkngthand")
+        end
+      end
+      
+      describe "'getTracksForAlbumInCollection'" do
+        before do
+          stub_post.with(:body => {:method => 'getTracksForAlbumInCollection', :album => "al216556", :user => "s27093" }).
+            to_return(:body => fixture("getTracksForAlbumInCollection.json"))
+        end
+        
+        it "should have the correct short url for the third track in collection" do
+          results = @client.getTracksForAlbumInCollection(:album => "al216556", :user => "s27093")
+          results[2].shortUrl.should eq("http://rd.io/x/QDaXK2t_hQ")
+        end
+      end
+      
+      describe "'getTracksForArtistInCollection'" do
+        before do
+          stub_post.with(:body => {:method => 'getTracksForArtistInCollection', :artist => "r350868"}).
+            to_return(:body => fixture('getTracksForArtistInCollection.json'))
+        end
+        
+        it "should have the correct price for track" do
+          results = @client.getTracksForArtistInCollection(:artist => "r350868")
+          results.first.price.should eq("0.99")
+        end
+      end
+      
+      describe "'getTracksInCollection'" do
+        before do
+          stub_post.with(:body => {:method => 'getTracksInCollection', :user => "s27093"}).
+            to_return(:body => fixture('getTracksInCollection.json'))
+        end
+        
+        it "should return 4 tracks in the Collection" do
+          results = @client.getTracksInCollection(:user => "s27093")
+          results.count.should eq(4)
+        end
+      end
+    end  
+  end
+end

data/spec/rdio_api/core_spec.rb

@@ -0,0 +1,59 @@
+require 'helper'
+
+describe RdioApi::Client do
+  
+  context "when working with the Core methods" do
+    before do
+      @client = RdioApi.new(:consumer_key => "consumerkey", :consumer_secret => "consumersecret")
+    end
+    
+    context "and methods that do not require authentication" do
+      
+      describe "'get'" do
+
+        context "with keys passed" do
+          before do
+            stub_post.with(:body => {:method => 'get', :keys => "r13700"}).
+              to_return(:body => fixture("get.json"))
+          end
+
+          it "should have the correct Artist name" do
+            results = @client.get(:keys => "r13700")
+            results.r13700.name.should eq("John Williams")
+          end
+        end
+      end
+    end
+
+    
+    context "and methods that require authentication " do
+      before do
+        @client.access_token = test_access_token
+      end
+      
+      describe "'getObjectFromShortCode'" do
+        before do
+          stub_post.with(:body => {:method => 'getObjectFromShortCode', :short_code => "QisyLj0"}).
+            to_return(:body => fixture("getObjectFromShortCode.json"))
+        end
+        
+        it "should have the correct Track name " do
+          results = @client.getObjectFromShortCode(:short_code => "QisyLj0")
+          results.name.should eq("Loud Pipes")
+        end
+      end
+      
+      describe "'getObjectFromUrl'" do
+        before do
+          stub_post.with(:body => {:method => 'getObjectFromUrl', :url => "/artist/James_Horner/" }).
+            to_return(:body => fixture("getObjectFromUrl.json"))
+        end
+        
+        it "should have the corrent topSongsKey" do
+          results = @client.getObjectFromUrl(:url => "/artist/James_Horner/")
+          results.topSongsKey.should eq("tr35187")
+        end
+      end
+    end
+  end
+end

data/spec/rdio_api/playback_spec.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+describe RdioApi::Client do
+  
+  context "when working with the Playback methods" do
+    before do
+      @client = RdioApi.new(:consumer_key => "consumerkey", :consumer_secret => "consumersecret")
+    end
+    
+    describe "'getPlaybackToken'" do
+      before do
+        stub_post.with(:body => {:method => 'getPlaybackToken'}).
+          to_return(:body => fixture("getPlaybackToken.json"))
+      end
+
+      it "should return a Playback Token" do
+        results = @client.getPlaybackToken
+        results.should eq("flkasdjFA5lkdjf90asdfli2l9cnlkasdj9")
+      end
+    end
+  end
+end

data/spec/rdio_api/playlists_spec.rb

@@ -0,0 +1,122 @@
+require 'helper'
+
+describe RdioApi::Client do
+  
+  context "when working with the Playlist methods" do
+    before do
+      @client = RdioApi.new(:consumer_key => "consumerkey", 
+                            :consumer_secret => "consumersecret",
+                            :access_token => test_access_token)
+    end
+    
+    describe "'createPlaylist'" do
+      before do
+        stub_post.with(:body => {:method => 'createPlaylist', :name => "RubyGem", 
+                                 :description => "Testing", :track => "t1945474, t3483614"}).
+          to_return(:body => fixture("createPlaylist.json"))
+      end
+      
+      it "should create the playlist and have the correct name" do
+        results = @client.createPlaylist(:name => "RubyGem", :description => "Testing", :track => "t1945474, t3483614")
+        results.name.should eq("RubyGem")
+      end
+    end
+    
+    describe "'addToPlaylist'" do
+      before do
+        stub_post.with(:body => {:method => 'addToPlaylist', :playlist => "p200057", :tracks => "t1945475"}).
+          to_return(:body => fixture("addToPlaylist.json"))
+      end
+      
+      it "should add to track to playlist" do
+        results = @client.addToPlaylist(:playlist => "p200057", :tracks => "t1945475")
+        results.should eq("true")
+      end
+    end
+    
+    describe "'getPlaylists'" do
+      before do
+        stub_post.with(:body => {:method => 'getPlaylists'}).to_return(:body => fixture("getPlaylists.json"))
+      end
+      
+      it "should return the playlist created in 'createPlaylist'" do
+        results = @client.getPlaylists
+        results.owned.first.name.should eq("RubyGem")
+      end
+    end
+    
+    describe "'setPlaylistCollaborating'" do
+      before do
+        stub_post.with(:body => {:method => 'setPlaylistCollaborating', :playlist => "p200057", :collaborating => "false"}).
+          to_return(:body => fixture("setPlaylistCollaborating.json"))
+      end
+      
+      it "should return true(collaborating should be false)" do
+        results = @client.setPlaylistCollaborating(:playlist => "p200057", :collaborating => "false")
+        results.should eq("true")
+      end
+    end
+    
+    describe "'setPlaylistCollaborationMode'" do
+      before do
+        stub_post.with(:body => {:method => 'setPlaylistCollaborationMode', :playlist => "p200057", :mode => "2"}).
+          to_return(:body => fixture("setPlaylistCollaborationMode.json"))
+      end
+      
+      it "should set collaboration mode to playlist followers and return true" do
+        results = @client.setPlaylistCollaborationMode(:playlist => "p200057", :mode => "2")
+        results.should eq("true")
+      end
+    end
+    
+    describe "'setPlaylistFields'" do
+      before do
+        stub_post.with(:body => {:method => 'setPlaylistFields', :playlist => "p200057",
+                                 :name => "RdioApi RubyGem", :description => "A Test Playlist"}).
+          to_return(:body => fixture("setPlaylistFields.json"))
+      end
+      
+      it "should change Playlist fields" do
+        results = @client.setPlaylistFields(:playlist => "p200057", :name => "RdioApi RubyGem", :description => "A Test Playlist")
+        results.should eq("true")
+      end
+    end
+    
+    describe "'setPlaylistOrder'" do
+      before do
+        stub_post.with(:body => {:method => 'setPlaylistOrder', :playlist => "p200057", :track => "t3483614, t1945474, t1945475"}).
+          to_return(:body => fixture("setPlaylistOrder.json"))
+      end
+      
+      it "should set new Playlist order " do
+        results = @client.setPlaylistOrder(:playlist => "p200057", :track => "t3483614, t1945474, t1945475")
+        results.should eq("true")
+      end
+    end
+    
+    describe "'removeFromPlaylist'" do
+      before do
+        stub_post.with(:body => {:method => 'removeFromPlaylist', :playlist => "p200057", :index => "2",
+                                 :count => "1", :tracks => "t1945475"}).
+          to_return(:body => fixture("removeFromPlaylist.json"))
+      end
+      
+      it "should remove track from Playlist" do
+        results = @client.removeFromPlaylist(:playlist => "p200057", :index => "2", :count => "1", :tracks => "t1945475")
+        results.should eq("true")
+      end
+    end
+    
+    describe "'deletePlaylist'" do
+      before do
+        stub_post.with(:body => {:method => 'deletePlaylist', :playlist => "p200057"}).
+          to_return(:body => fixture("deletePlaylist.json"))
+      end
+      
+      it "should delete the playlist" do
+        results = @client.deletePlaylist(:playlist => "p200057")
+        results.should eq("true")
+      end
+    end
+  end
+end

data/spec/rdio_api/social_spec.rb

@@ -0,0 +1,92 @@
+require 'helper'
+
+describe RdioApi::Client do
+  
+  context "when working with the Social methods" do
+    before do
+      @client = RdioApi.new(:consumer_key => "consumerkey", :consumer_secret => "consumersecret")
+    end
+    
+    context "and methods that require authentication " do
+      before do
+        @client.access_token = test_access_token
+      end
+      
+      describe "'addFriend'" do
+        before do
+          stub_post.with(:body => {:method => 'addFriend', :user => "s12345"}).
+            to_return(:body => fixture("addFriend.json"))
+        end
+        
+        it "should add Friend" do
+          results = @client.addFriend(:user => "s12345")
+          results.should eq("true")
+        end
+      end
+      
+      describe "'removeFriend'" do
+        before do
+          stub_post.with(:body => {:method => 'removeFriend', :user => "s12345"}).
+            to_return(:body => fixture("removeFriend.json"))
+        end
+        
+        it "should remove Friend" do
+          results = @client.removeFriend(:user => "s12345")
+          results.should eq("true")
+        end
+      end
+      
+      describe "'currentUser'" do
+        before do
+          stub_post.with(:body => {:method => 'currentUser'}).to_return(:body => fixture("currentUser.json"))
+        end
+        
+        it "should have the current First Name" do
+          results = @client.currentUser
+          results.firstName.should eq("Anil")
+        end
+      end
+    end
+    
+    context "and methods that do not require authentication" do
+      
+      describe "'findUser'" do
+        before do
+          stub_post.with(:body => {:method => 'findUser', :vanityName => "anilv"}).
+            to_return(:body => fixture("findUser.json"))
+        end
+        
+        it "should have the correct firt name" do
+          results = @client.findUser(:vanityName => "anilv")
+          results.firstName.should eq("Anil")
+        end
+      end
+      
+      describe "'userFollowers'" do
+        before do
+          stub_post.with(:body => {:method => 'userFollowers', :user => "s12345"}).
+            to_return(:body => fixture("userFollowers.json"))
+        end
+        
+        it "should have the correct Name for the first follower" do
+          results = @client.userFollowers(:user => "s12345")
+          results.count.should eq(2)
+          (results.first.firstName + " " + results.first.lastName).should eq("Ruby Githubber")
+        end
+      end
+      
+      describe "'userFollowing'" do
+        before do
+          stub_post.with(:body => {:method => 'userFollowing', :user => "s12345"}).
+            to_return(:body => fixture("userFollowing.json"))
+        end
+        
+        it "should have the correct Name for the last follower" do
+          results = @client.userFollowing(:user => "s12345")
+          results.count.should eq(2)
+          (results.last.firstName + " " + results.last.lastName).should eq("Rdio Api")
+        end
+      end
+    end
+  end
+end