officialfm 0.0.2 → 0.0.3

data/LICENSE

@@ -1,20 +1,24 @@
-Copyright (c) 2011 Amos Wenger
+Copyright (c) 2011, Amos Wenger
+All rights reserved.
 
-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:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
 
-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.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -81,7 +81,9 @@ the gem allows you to access it like this:
 
 ## Copyright
 
-Copyright (c) 2011 Amos Wenger. See LICENSE for details.
+Copyright (c) 2011 Amos Wenger.
+
+This project is distributed under the New BSD License. See LICENSE for details.
 
 Based on [@pengwynn's Gowalla API wrapper](https://github.com/pengwynn/gowalla)
 

data/Rakefile

@@ -7,6 +7,7 @@ Bundler::GemHelper.install_tasks
 
 Rake::TestTask.new(:test) do |test|
   test.ruby_opts = ["-rubygems"] if defined? Gem
+  #test.ruby_opts << "-w"
   test.libs << "lib" << "test"
   test.pattern = "test/**/*_test.rb"
 end

data/changelog.md

@@ -1,13 +1,15 @@
 # Changelog
 
+## 0.0.3 May 18, 2011
+  * Added support for voted_playlists and voted_tracks requests
+
 ## 0.0.2 April 21, 2011
   * s/Unofficial/Official, this gem is now endorsed by official.fm
   * Playlist IDs no longer escaped
   * Removed dependency on OAuth2, as it's not needed for the Simple API
   * Better README
 
-## 0.0.1 March 22, 2011
+## 0.0.1 March 23, 2011
   * Initial version
   * Supports tracks, users, playlists
   * Improved playlist support: tracks, running_time
-

data/lib/officialfm/users.rb

@@ -40,6 +40,20 @@ module OfficialFM
       response.body
     end
     
+    # Retrieve a list of the tracks this user has voted for
+    #
+    # @param [String] user_id: id or login
+    # @param [Integer] limit (50) limit per page
+    # @param [Bool] embed (false) should embed codes be included in the response
+    # @return [Hashie::Mash] Track list
+    def voted_tracks(user_id, options={})
+      response = connection.get do |req|
+        req.url "/user/#{user_id}/voted_tracks",
+          :api_embed_codes => options[:embed], :api_max_responses => options[:limit]
+      end
+      response.body
+    end
+    
     # Retrieve a list of the playlists of this user
     #
     # @param [String] user_id: id or login
@@ -54,6 +68,20 @@ module OfficialFM
       response.body
     end
     
+    # Retrieve a list of the playlists this user has voted for
+    #
+    # @param [String] user_id: id or login
+    # @param [Integer] limit (50) limit per page
+    # @param [Bool] embed (false) should embed codes be included in the response
+    # @return [Hashie::Mash] Playlist list
+    def voted_playlists(user_id, options={})
+      response = connection.get do |req|
+        req.url "/user/#{user_id}/voted_playlists",
+          :api_embed_codes => options[:embed], :api_max_responses => options[:limit]
+      end
+      response.body
+    end
+    
     # Retrieve a list of the contacts of this user
     #
     # @param [String] user_id: id or login
@@ -95,3 +123,4 @@ module OfficialFM
 
   end
 end
+

data/lib/officialfm/version.rb

@@ -1,3 +1,3 @@
 module OfficialFM
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/test/fixtures/voted_playlists.json

@@ -0,0 +1,50 @@
+[
+	  {
+  "artwork_embed_code":"<iframe name=\"fairplayer\" width=\"220\" height=\"220\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/playlist/50786?fairplayer=artwork\"></iframe>",
+  "comments_count":0,
+  "created_at":"2011-01-02 17:24:34 UTC",
+  "description":"",
+  "id":50786,
+  "large_embed_code":"<iframe name=\"fairplayer\" width=\"220\" height=\"350\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/playlist/50786?fairplayer=large\"></iframe>",
+  "length":3757,
+  "mini_embed_code":"<iframe name=\"fairplayer\" width=\"34\" height=\"18\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/playlist/50786?fairplayer=mini\"></iframe>",
+  "name":"Top 20 (Most played) cover songs in 2010 ",
+  "password":null,
+  "picture_absolute_url":"http://cdn.official.fm/playlist_pictures/50/50786_small.jpg",
+  "plays_count":43,
+  "private":false,
+  "shuffle":false,
+  "small_embed_code":"<iframe name=\"fairplayer\" width=\"100%\" height=\"40\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/playlist/50786?fairplayer=small\"></iframe>",
+  "standard_embed_code":"<iframe name=\"fairplayer\" width=\"160\" height=\"240\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/playlist/50786?fairplayer=standard\"></iframe>",
+  "tracks":[1155,11519,64985,81107,19550,35878,70976,2408,12349,67940,12093,4149,67938,12645,78956,8277,15914],
+  "tracks_count":17,
+  "tracks_list":"1155,11519,64985,81107,19550,35878,70976,2408,12349,67940,12093,4149,67938,12645,78956,8277,15914",
+  "user_id":152,
+  "votes_count":7
+}
+	  ,
+	  {
+  "artwork_embed_code":"<iframe name=\"fairplayer\" width=\"220\" height=\"220\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/playlist/50195?fairplayer=artwork\"></iframe>",
+  "comments_count":0,
+  "created_at":"2010-12-23 18:17:14 UTC",
+  "description":null,
+  "id":50195,
+  "large_embed_code":"<iframe name=\"fairplayer\" width=\"220\" height=\"350\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/playlist/50195?fairplayer=large\"></iframe>",
+  "length":1322,
+  "mini_embed_code":"<iframe name=\"fairplayer\" width=\"34\" height=\"18\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/playlist/50195?fairplayer=mini\"></iframe>",
+  "name":"top 5 2010",
+  "password":null,
+  "picture_absolute_url":"http://cdn.official.fm/track_pictures/175/175408_small.jpg",
+  "plays_count":9,
+  "private":false,
+  "shuffle":false,
+  "small_embed_code":"<iframe name=\"fairplayer\" width=\"100%\" height=\"40\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/playlist/50195?fairplayer=small\"></iframe>",
+  "standard_embed_code":"<iframe name=\"fairplayer\" width=\"160\" height=\"240\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/playlist/50195?fairplayer=standard\"></iframe>",
+  "tracks":[175408,143269,139463,184871,184620],
+  "tracks_count":5,
+  "tracks_list":"175408,143269,139463,184871,184620",
+  "user_id":39714,
+  "votes_count":3
+}
+	  
+]

data/test/fixtures/voted_tracks.json

@@ -0,0 +1,96 @@
+[
+    {
+  "artist_string":"Various Artist",
+  "artwork_embed_code":"<iframe name=\"fairplayer\" width=\"220\" height=\"220\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/track/60526?fairplayer=artwork\"></iframe>",
+  "buy_url":"",
+  "comments_count":3,
+  "concatinated_genres":"Electronic",
+  "concatinated_tags":null,
+  "country_id":"FR",
+  "created_at":"2009-11-01 01:07:10 UTC",
+  "derived_by":null,
+  "derived_type":"original",
+  "description":"",
+  "downloadable":true,
+  "downloads_count":276,
+  "genres":["Electronic"],
+  "id":60526,
+  "isrc":null,
+  "label":"No Label",
+  "label_none":false,
+  "large_embed_code":"<iframe name=\"fairplayer\" width=\"220\" height=\"350\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/track/60526?fairplayer=large\"></iframe>",
+  "length":2694,
+  "license_type":1,
+  "lyrics":null,
+  "mini_embed_code":"<iframe name=\"fairplayer\" width=\"34\" height=\"18\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/track/60526?fairplayer=mini\"></iframe>",
+  "original_track_id":null,
+  "original_track_string":null,
+  "password":null,
+  "picture_absolute_url":"http://cdn.official.fm/track_pictures/60/60526_small.jpg",
+  "playlists_count":3,
+  "plays_count":716,
+  "pr_url":"",
+  "private":false,
+  "require_valid_email":false,
+  "small_embed_code":"<iframe name=\"fairplayer\" width=\"100%\" height=\"40\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/track/60526?fairplayer=small\"></iframe>",
+  "standard_embed_code":"<iframe name=\"fairplayer\" width=\"160\" height=\"240\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/track/60526?fairplayer=standard\"></iframe>",
+  "status":"Complete",
+  "tags":[],
+  "title":"QuelqueChosed'HasBeen",
+  "url_1":"",
+  "url_1_name":"",
+  "url_2":"",
+  "url_2_name":"",
+  "user_id":35966,
+  "votes_count":18,
+  "web_url":""
+}
+    ,
+    {
+  "artist_string":"Various Artist",
+  "artwork_embed_code":"<iframe name=\"fairplayer\" width=\"220\" height=\"220\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/track/48163?fairplayer=artwork\"></iframe>",
+  "buy_url":"",
+  "comments_count":2,
+  "concatinated_genres":"Electronic,Mixtape,Pop",
+  "concatinated_tags":null,
+  "country_id":"FR",
+  "created_at":"2009-08-08 16:12:33 UTC",
+  "derived_by":null,
+  "derived_type":"original",
+  "description":"",
+  "downloadable":true,
+  "downloads_count":591,
+  "genres":["Electronic","Mixtape","Pop"],
+  "id":48163,
+  "isrc":null,
+  "label":null,
+  "label_none":true,
+  "large_embed_code":"<iframe name=\"fairplayer\" width=\"220\" height=\"350\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/track/48163?fairplayer=large\"></iframe>",
+  "length":3482,
+  "license_type":1,
+  "lyrics":null,
+  "mini_embed_code":"<iframe name=\"fairplayer\" width=\"34\" height=\"18\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/track/48163?fairplayer=mini\"></iframe>",
+  "original_track_id":null,
+  "original_track_string":null,
+  "password":null,
+  "picture_absolute_url":"http://cdn.official.fm/track_pictures/48/48163_small.jpg",
+  "playlists_count":10,
+  "plays_count":896,
+  "pr_url":"",
+  "private":false,
+  "require_valid_email":false,
+  "small_embed_code":"<iframe name=\"fairplayer\" width=\"100%\" height=\"40\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/track/48163?fairplayer=small\"></iframe>",
+  "standard_embed_code":"<iframe name=\"fairplayer\" width=\"160\" height=\"240\" scrolling=\"no\" frameborder=\"0\" src=\"http://official.fm/track/48163?fairplayer=standard\"></iframe>",
+  "status":"Complete",
+  "tags":[],
+  "title":"SummerALaMode Mix by SALM",
+  "url_1":"",
+  "url_1_name":"",
+  "url_2":"",
+  "url_2_name":"",
+  "user_id":35966,
+  "votes_count":18,
+  "web_url":""
+}
+    
+]

data/test/users_test.rb

@@ -36,6 +36,13 @@ class UsersTest < Test::Unit::TestCase
       tracks[0].artist_string.should == 'Hercules and Love Affair'
     end
     
+    should "retrieve the first two tracks nddrylliog has voted for" do
+      stub_get('http://api.official.fm/user/nddrylliog/voted_tracks?key=GNXbH3zYb25F1I7KVEEN&format=json&api_embed_codes=&api_max_responses=2', 'voted_tracks.json')
+      tracks = @client.voted_tracks('nddrylliog', :limit => 2)
+      tracks.size.should == 2
+      tracks[0].title.should == "QuelqueChosed'HasBeen"
+    end
+    
     should "retrieve the first two playlists of chab" do
       stub_get('http://api.official.fm/user/chab/playlists?key=GNXbH3zYb25F1I7KVEEN&format=json&api_embed_codes=&api_max_responses=2', 'user_playlists.json')
       playlists = @client.user_playlists('chab', :limit => 2)
@@ -44,6 +51,13 @@ class UsersTest < Test::Unit::TestCase
       playlists[1].user_id.should == 8735 # chab's user id
     end
     
+    should "retrieve the first two playlists bencolon has voted for" do
+      stub_get('http://api.official.fm/user/bencolon/voted_playlists?key=GNXbH3zYb25F1I7KVEEN&format=json&api_embed_codes=&api_max_responses=2', 'voted_playlists.json')
+      playlists = @client.voted_playlists('bencolon', :limit => 2)
+      playlists.size.should == 2
+      playlists[1].id.should == 50195
+    end
+    
     should "retrieve the first two contacts of chab" do
       stub_get('http://api.official.fm/user/chab/contacts?key=GNXbH3zYb25F1I7KVEEN&format=json&api_max_responses=2', 'user_contacts.json')
       contacts = @client.user_contacts('chab', :limit => 2)

metadata

@@ -2,7 +2,7 @@
 name: officialfm
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Amos Wenger
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-21 00:00:00 +02:00
+date: 2011-05-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -161,6 +161,8 @@ files:
 - test/fixtures/user_subscribers.json
 - test/fixtures/user_subscriptions.json
 - test/fixtures/user_tracks.json
+- test/fixtures/voted_playlists.json
+- test/fixtures/voted_tracks.json
 - test/helper.rb
 - test/playlists_test.rb
 - test/tracks_test.rb
@@ -208,6 +210,8 @@ test_files:
 - test/fixtures/user_subscribers.json
 - test/fixtures/user_subscriptions.json
 - test/fixtures/user_tracks.json
+- test/fixtures/voted_playlists.json
+- test/fixtures/voted_tracks.json
 - test/helper.rb
 - test/playlists_test.rb
 - test/tracks_test.rb