officialfm 0.0.4 → 0.1.0

data/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.1.0 Aug 03, 2011
+  * Advanced API is now fully supported, see docs here: http://official.fm/developers/advanced
+  * OAuth sign-in demo can be found here: https://github.com/officialfm/sign-in-with-officialfm-ruby
+
 ## 0.0.4 May 20, 2011
   * Removed 'tracks' workaround, as the official API now includes it by default
 

data/lib/faraday/request/officialfm_oauth.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+
+module Faraday
+  class Request::OfficialFMOAuth < Faraday::Middleware
+    dependency 'simple_oauth'
+
+    def call(env)
+      params = env[:body] || {}
+      signature_params = params
+
+      params.map{ |k,v| signature_params = {} if v.respond_to?(:content_type) }
+      
+      header = SimpleOAuth::Header.new(env[:method], env[:url], signature_params, @options)
+      env[:request_headers]['Authorization'] = header.to_s
+
+      @app.call(env)
+    end
+
+    def initialize(app, options)
+      @app, @options = app, options
+    end
+  end
+end

data/lib/officialfm/authentication.rb

@@ -0,0 +1,31 @@
+module OfficialFM
+  # @private
+  module Authentication
+    private
+
+    # Authentication hash
+    #
+    # @return [Hash]
+    def authentication
+      {
+        :consumer_key     => @api_key,
+        :consumer_secret  => @api_secret,
+        :token            => @access_token,
+        :token_secret     => @access_secret,
+      }
+    end
+
+    # Check whether user is authenticated
+    #
+    # @return [Boolean]
+    def authenticated?
+      authentication[:token] != nil
+    end
+    
+    private
+      
+    def check_auth(name)
+      raise "#{name} is an advanced API method - lacking OAuth credentials." unless authenticated?
+    end
+  end
+end

data/lib/officialfm/client.rb

@@ -1,7 +1,7 @@
 require 'forwardable'
-
-# Note: this gem only supports the Simple API, since the Advanced API
-# is still in development
+require 'faraday/request/officialfm_oauth'
+require 'officialfm/authentication'
+require 'officialfm/version'
 
 module OfficialFM
   class Client
@@ -10,31 +10,64 @@ module OfficialFM
     include Users
     include Tracks
     include Playlists
+    include Authentication
     
-    attr_reader :api_key
+    attr_reader :api_key, :api_secret
 
-    def_delegators :web_server
+    def_delegators :web_server, :authorize_url, :access_token_url
 
     def initialize(options={})
       @api_key = options[:api_key] || OfficialFM.api_key
+      @api_secret = options[:api_secret] || OfficialFM.api_secret
+      @access_token = options[:access_token]
+      @access_secret = options[:access_secret]
       # Note: Although the default of the API is to return XML, I think
       # json is more appropriate in the Ruby world
       
-      # Note: I really don't understand how js_callback_function works,
-      # so I'm not exposing it here. (Is it for AJAX client-side requests?)
       @format = options[:format] || :json
-      connection
+      connection unless @access_token
+    end
+
+    # GET request arguments for simple API calls
+    def simple_params (options = nil)
+      params = {
+        :key    => @api_key,
+        :format => @format,
+      }
+      if options
+          options.each { |key, value|
+            case key
+            when 'limit'
+              params['api_max_responses'] = value
+            when 'embed'
+              params['api_embed_codes'] = value
+            else
+              params[key] = value
+            end
+          }
+      end
+      params
     end
 
     # Raw HTTP connection, either Faraday::Connection
     #
     # @return [Faraday::Connection]
     def connection
-      params = {:key => @api_key, :format => @format}
-      @connection ||= Faraday::Connection.new(:url => api_url, :params => params, :headers => default_headers) do |builder|
-        builder.adapter Faraday.default_adapter
-        builder.use Faraday::Response::ParseJson
+      params = 
+    
+      options = {
+        :url => api_url,
+        :headers => default_headers
+      }
+    
+      @connection ||= Faraday.new(options) do |builder|
+        builder.use Faraday::Request::OfficialFMOAuth, authentication if authenticated?
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::UrlEncoded
+        
         builder.use Faraday::Response::Mashify
+        builder.use Faraday::Response::ParseJson
+        builder.adapter Faraday.default_adapter
       end
 
     end
@@ -43,7 +76,7 @@ module OfficialFM
     def default_headers
       headers = {
         :accept =>  'application/json',
-        :user_agent => 'officialfm Ruby gem'
+        :user_agent => "officialfm ruby gem version #{OfficialFM::VERSION}"
       }
     end
 

data/lib/officialfm/playlists.rb

@@ -10,8 +10,7 @@ module OfficialFM
     # @return [Hashie::Mash] Playlist list
     def playlists(search_param, options={})
       response = connection.get do |req|
-        req.url "/search/playlists/#{CGI::escape(search_param)}",
-          :api_max_responses => options[:limit]
+        req.url "/search/playlists/#{CGI::escape(search_param)}", simple_params(options)
       end
       
       response.body.map do |pl| improve(pl) end
@@ -24,8 +23,7 @@ module OfficialFM
     # @return [Hashie::Mash] Playlist
     def playlist(playlist_id, options={})
       response = connection.get do |req|
-        req.url "/playlist/#{playlist_id}",
-          :api_embed_codes => options[:embed]
+        req.url "/playlist/#{playlist_id}", simple_params(options)
       end
       improve(response.body[0])
     end
@@ -37,8 +35,7 @@ module OfficialFM
     # @return [Hashie::Mash] User list
     def playlist_votes(playlist_id, options={})
       response = connection.get do |req|
-        req.url "/playlist/#{playlist_id}/votes",
-          :api_max_responses => options[:limit]
+        req.url "/playlist/#{playlist_id}/votes", simple_params(options)
       end
       response.body
     end
@@ -48,6 +45,101 @@ module OfficialFM
       playlist.running_time = playlist["length"]
       playlist
     end
+       
+    ####################################################################
+    ######################### Advanced API methods #####################
+    ####################################################################
+
+    # Update information of a given playlist
+    #
+    # @param [String] playlist_id: id
+    # @param [String] description (optional)
+    # @param [String] name (optional)
+    # @param [String] password (optional)
+    # @param [String] private (optional)
+    # @return [Hashie::Mash] Playlist
+    def update_playlist! (playlist_id, data = {})
+      check_auth :update_playlist
+    
+      response = connection.put do |req|
+        req.url "/playlist/update/#{playlist_id}", data
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Upload a picture for a given playlist
+    #
+    # @param [String] playlist_id: id
+    # @param [String] path: path to a picture
+    # @param [String] mime: the mime-type of the picture (e.g. image/jpeg, image/png, etc.)
+    # @return [Hashie::Mash] Success or error message
+    def playlist_picture! (playlist_id, path, mime)
+      check_auth :playlist_picture
+    
+      response = connection.post  do |req|
+        req.url "/playlist/picture/#{playlist_id}"
+        req.body = { :file => Faraday::UploadIO.new(path, mime), :format => @format }
+      end
+      response
+    end
+    
+    # Remove a playlist
+    #
+    # @param [String] playlist_id: id
+    # @return [Hashie::Mash] Success or error message
+    def playlist_remove! (playlist_id)
+      check_auth :playlist_remove
+    
+      response = connection.delete  do |req|
+        req.url "/playlist/remove/#{playlist_id}"
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Create a playlist
+    #
+    # @param [String] name: playlist name
+    # @param [String] track_id: first track id of the new playlist
+    # @return [Hashie::Mash] Playlist object
+    def playlist_create! (name, track_id)
+      check_auth :playlist_create
+    
+      response = connection.post  do |req|
+        req.url "/playlist/create"
+        req.body = { :format => @format, :name => name, :track_id => track_id }
+      end
+      response
+    end
+    
+    # Vote for a playlist
+    #
+    # @param [String] playlist_id: id
+    # @return [Hashie::Mash] Success or error message
+    def playlist_vote! (playlist_id)
+      check_auth :playlist_vote
+    
+      response = connection.post  do |req|
+        req.url "/playlist/vote/#{playlist_id}"
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Remote vote for a playlist
+    #
+    # @param [String] playlist_id: id
+    # @return [Hashie::Mash] Success or error message
+    def playlist_unvote! (playlist_id)
+      check_auth :playlist_unvote
+    
+      response = connection.post  do |req|
+        req.url "/playlist/unvote/#{playlist_id}"
+        req.body = { :format => @format }
+      end
+      response
+    end
     
   end
 end

data/lib/officialfm/tracks.rb

@@ -10,8 +10,7 @@ module OfficialFM
     # @return [Hashie::Mash] Track list
     def tracks(search_param, options={})
       response = connection.get do |req|
-        req.url "/search/tracks/#{CGI::escape(search_param)}",
-          :api_max_responses => options[:limit]
+        req.url "/search/tracks/#{CGI::escape(search_param)}", simple_params(options)
       end
       response.body
     end
@@ -26,8 +25,7 @@ module OfficialFM
     # @return [Hashie::Mash] Track
     def track(track_id, options={})
       response = connection.get do |req|
-        req.url "/track/#{track_id}",
-          :api_embed_codes => options[:embed]
+        req.url "/track/#{track_id}", simple_params(options)
       end
       response.body[0]
     end
@@ -39,8 +37,7 @@ module OfficialFM
     # @return [Hashie::Mash] User list
     def track_votes(track_id, options={})
       response = connection.get do |req|
-        req.url "/track/#{track_id}/votes",
-          :api_max_responses => options[:limit]
+        req.url "/track/#{track_id}/votes", simple_params(options)
       end
       response.body
     end
@@ -55,9 +52,7 @@ module OfficialFM
     # @return [Hashie::Mash] Track list
     def charts(charting, options={})
       response = connection.get do |req|
-        req.url "/tracks/charts",
-          :charting => charting, :genre => options[:genre], :country => options[:country],
-          :api_embed_codes => options[:embed], :api_max_responses => options[:limit]
+        req.url "/tracks/charts", simple_params(options)
       end
       response.body
     end
@@ -71,12 +66,142 @@ module OfficialFM
     # @return [Hashie::Mash] Track list
     def latest(options={})
       response = connection.get do |req|
-        req.url "/tracks/latest", :genre => options[:genre],
-          :country => options[:country], :api_embed_codes => options[:embed],
-          :api_max_responses => options[:limit]
+        req.url "/tracks/latest", simple_params(options)
       end
       response.body
     end
-  
+    
+    ####################################################################
+    ######################### Advanced API methods #####################
+    ####################################################################
+
+    # Update information of a given track
+    #
+    # @param [String] track_id: id
+    # @param [String] artist_name (optional)
+    # @param [String] buy_url (optional)
+    # @param [String] country_id (optional)
+    # @param [String] downloadable (optional)
+    # @param [String] derived_by (optional)
+    # @param [String] derived_type (optional)
+    # @param [String] description (optional)
+    # @param [String] isrc (optional)
+    # @param [String] label_name (optional)
+    # @param [String] label_none (optional)
+    # @param [String] license_type (optional)
+    # @param [String] lyrics (optional)
+    # @param [String] genre_string (optional)
+    # @param [String] original_track_id (optional)
+    # @param [String] password (optional)
+    # @param [String] pr_url (optional)
+    # @param [String] private (optional)
+    # @param [String] require_valid_email (optional)
+    # @param [String] tag_string (optional)
+    # @param [String] title (optional)
+    # @param [String] url_1_name (optional)
+    # @param [String] url_1 (optional)
+    # @param [String] url_2_name (optional)
+    # @param [String] url_2 (optional)
+    # @param [String] web_url (optional)
+    # @return [Hashie::Mash] Track
+    def update_track! (track_id, data = {})
+      check_auth :update_track
+    
+      response = connection.put do |req|
+        req.url "/track/update/#{track_id}", data
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Upload a picture for a given track
+    #
+    # @param [String] track_id: id
+    # @param [String] path: path to a picture
+    # @param [String] mime: the mime-type of the picture (e.g. image/jpeg, image/png, etc.)
+    # @return [Hashie::Mash] Success or error message
+    def track_picture! (track_id, path, mime)
+      check_auth :track_picture
+    
+      response = connection.post  do |req|
+        req.url "/track/picture/#{track_id}"
+        req.body = { :file => Faraday::UploadIO.new(path, mime), :format => @format }
+      end
+      response
+    end
+    
+    # Vote for a track
+    #
+    # @param [String] track_id: id
+    # @return [Hashie::Mash] Success or error message
+    def track_vote! (track_id)
+      check_auth :track_vote
+    
+      response = connection.post  do |req|
+        req.url "/track/vote/#{track_id}"
+        req.body = { :format => @format }
+      end
+      response
+    end
+
+    # Remove vote for a track
+    #
+    # @param [String] track_id: id
+    # @return [Hashie::Mash] Success or error message
+    def track_unvote! (track_id)
+      check_auth :track_unvote
+    
+      response = connection.post  do |req|
+        req.url "/track/unvote/#{track_id}"
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Add a track to a playlist
+    #
+    # @param [String] track_id: id
+    # @param [String] playlist_id: id
+    # @return [Hashie::Mash] Success or error message
+    def add_track_to_playlist! (track_id)
+      check_auth :add_track_to_playlist!
+    
+      response = connection.post  do |req|
+        req.url "/track/#{track_id}/addto/#{playlist_id}"
+        req.body = { :format => @format }
+      end
+      response
+    end
+
+    # Remove a track from a playlist
+    #
+    # @param [String] track_id: id
+    # @param [String] playlist_id: id
+    # @return [Hashie::Mash] Success or error message
+    def remove_track_from_playlist! (track_id)
+      check_auth :remove_track_from_playlist!
+    
+      response = connection.delete  do |req|
+        req.url "/track/#{track_id}/removefrom/#{playlist_id}"
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Upload a new track to Official.fm
+    #
+    # @param [String] path: path to an mp3, 44.1Khz file
+    # @param [String] mime: the mime-type of the file (e.g. audio/mpeg, etc.)
+    # @return [Hashie::Mash] Track
+    def upload! (path, mime)
+      check_auth :upload
+    
+      response = connection.post  do |req|
+        req.url "/track/upload"
+        req.body = { :file => Faraday::UploadIO.new(path, mime), :format => @format }
+      end
+      response
+    end
+
   end
 end

data/lib/officialfm/users.rb

@@ -10,7 +10,7 @@ module OfficialFM
     # @return [Hashie::Mash] User list
     def users(search_param, options={})
       response = connection.get do |req|
-        req.url "/search/users/#{CGI::escape(search_param)}", :api_max_responses => options[:limit]
+        req.url "/search/users/#{CGI::escape(search_param)}", simple_params(options)
       end
       response.body
     end
@@ -21,12 +21,12 @@ module OfficialFM
     # @return [Hashie::Mash] User
     def user(user_id)
       response = connection.get do |req|
-        req.url "/user/#{user_id}"
+        req.url "/user/#{user_id}", simple_params
       end
       response.body[0]
     end
 
-    # Retrieve a list of the tracks of this user
+    # Retrieve a list of the tracks of a given user
     #
     # @param [String] user_id: id or login
     # @param [Integer] limit (50) limit per page
@@ -34,13 +34,12 @@ module OfficialFM
     # @return [Hashie::Mash] Track list
     def user_tracks(user_id, options={})
       response = connection.get do |req|
-        req.url "/user/#{user_id}/tracks",
-          :api_embed_codes => options[:embed], :api_max_responses => options[:limit]
+        req.url "/user/#{user_id}/tracks", simple_params(options)
       end
       response.body
     end
     
-    # Retrieve a list of the tracks this user has voted for
+    # Retrieve a list of the tracks a given user has voted for
     #
     # @param [String] user_id: id or login
     # @param [Integer] limit (50) limit per page
@@ -48,13 +47,12 @@ module OfficialFM
     # @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]
+        req.url "/user/#{user_id}/voted_tracks", simple_params(options)
       end
       response.body
     end
     
-    # Retrieve a list of the playlists of this user
+    # Retrieve a list of the playlists of a given user
     #
     # @param [String] user_id: id or login
     # @param [Integer] limit (50) limit per page
@@ -62,13 +60,12 @@ module OfficialFM
     # @return [Hashie::Mash] Playlist list
     def user_playlists(user_id, options={})
       response = connection.get do |req|
-        req.url "/user/#{user_id}/playlists",
-          :api_embed_codes => options[:embed], :api_max_responses => options[:limit]
+        req.url "/user/#{user_id}/playlists", simple_params(options)
       end
       response.body
     end
     
-    # Retrieve a list of the playlists this user has voted for
+    # Retrieve a list of the playlists a given user has voted for
     #
     # @param [String] user_id: id or login
     # @param [Integer] limit (50) limit per page
@@ -76,50 +73,178 @@ module OfficialFM
     # @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]
+        req.url "/user/#{user_id}/voted_playlists", simple_params(options)
       end
       response.body
     end
     
-    # Retrieve a list of the contacts of this user
+    # Retrieve a list of the contacts of a given user
     #
     # @param [String] user_id: id or login
     # @param [Integer] limit (50) limit per page
     # @return [Hashie::Mash] User list
     def user_contacts(user_id, options={})
       response = connection.get do |req|
-        req.url "/user/#{user_id}/contacts",
-          :api_max_responses => options[:limit]
+        req.url "/user/#{user_id}/contacts", simple_params(options)
       end
       response.body
     end
     
-    # Retrieve a list of the subscribers of this user
+    # Retrieve a list of the subscribers of a given user
     #
     # @param [String] user_id: id or login
     # @param [Integer] limit (50) limit per page
     # @return [Hashie::Mash] User list
     def user_subscribers(user_id, options={})
       response = connection.get do |req|
-        req.url "/user/#{user_id}/subscribers",
-          :api_max_responses => options[:limit]
+        req.url "/user/#{user_id}/subscribers", simple_params(options)
       end
       response.body
     end
     
-    # Retrieve a list of the subscriptions of this user
+    # Retrieve a list of the subscriptions of a given user
     #
     # @param [String] user_id: id or login
     # @param [Integer] limit (50) limit per page
     # @return [Hashie::Mash] User list
     def user_subscriptions(user_id, options={})
       response = connection.get do |req|
-        req.url "/user/#{user_id}/subscriptions",
-          :api_max_responses => options[:limit]
+        req.url "/user/#{user_id}/subscriptions", simple_params(options)
       end
       response.body
     end
+    
+    ####################################################################
+    ######################### Advanced API methods #####################
+    ####################################################################
+
+    # Retrieve information about the logged in user
+    #
+    # @return [Hashie::Mash] User
+    def profile
+      check_auth :profile
+    
+      response = connection.post do |req|
+        req.url '/user/profile'
+        req.body = { :format => @format }
+      end
+      response.body[0]
+    end
+    
+    # Retrieve tracks of the logged in user
+    #
+    # @return [Hashie::Mash] Track list
+    def own_tracks
+      check_auth :own_tracks
+      
+      response = connection.post do |req|
+        req.url '/user/tracks'
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Retrieve dropbox tracks of the logged in user
+    #
+    # @return [Hashie::Mash] Track list
+    def dropbox
+      check_auth :dropbox
+      
+      response = connection.post do |req|
+        req.url '/user/dropbox'
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Retrieve playlists of the logged in user
+    #
+    # @return [Hashie::Mash] Playlist list
+    def own_playlists
+      check_auth :own_playlists
+      
+      response = connection.post do |req|
+        req.url '/user/playlists'
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Retrieve events of the logged in user's newsfeed
+    #
+    # @return [Hashie::Mash] Event list
+    def newsfeed
+      check_auth :newsfeed
+      
+      response = connection.post do |req|
+        req.url '/user/newsfeed'
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Update information of the logged in user
+    #
+    # @param [String] email (optional)
+    # @param [String] city (optional)
+    # @param [String] country_id (optional)
+    # @param [String] url (optional)
+    # @param [String] profile (optional)
+    # @param [String] birthdate (optional)
+    # @param [String] gender (optional)
+    # @return [Hashie::Mash] User
+    def update_profile! (data = {})
+      check_auth :update
+    
+      response = connection.put do |req|
+        req.url '/user/update'
+        req.body = { :format => @format }.merge(data)
+      end
+      response
+    end
+    
+    # Subscribe the logged in user to a given user
+    #
+    # @param [String] user_id: the user to subscribe to
+    # @return [Hashie::Mash] Success or error message
+    def subscribe! (user_id)
+      check_auth :subscribe
+    
+      response = connection.post  do |req|
+        req.url "/user/subscribe/#{user_id}"
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Unsubscribe the logged in user from a given user
+    #
+    # @param [String] user_id: the user to unsubscribe from
+    # @return [Hashie::Mash] Success or error message
+    def unsubscribe! (user_id)
+      check_auth :unsubscribe
+    
+      response = connection.post  do |req|
+        req.url "/user/unsubscribe/#{user_id}"
+        req.body = { :format => @format }
+      end
+      response
+    end
+    
+    # Upload a picture for authenticated user
+    #
+    # @param [String] path: path to a picture
+    # @param [String] mime: the mime-type of the picture (e.g. image/jpeg, image/png, etc.)
+    # @return [Hashie::Mash] Success or error message
+    def picture! (path, mime)
+      check_auth :picture
+    
+      response = connection.post  do |req|
+        req.url "/user/picture"
+        req.body = { :file => Faraday::UploadIO.new(path, mime), :format => @format }
+      end
+      response
+    end
 
   end
 end

data/lib/officialfm/version.rb

@@ -1,3 +1,3 @@
 module OfficialFM
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/lib/officialfm.rb

@@ -7,10 +7,11 @@ module OfficialFM
 
   class << self
     attr_accessor :api_key
+    attr_accessor :api_secret
     attr_accessor :test_mode
 
     # Configures default credentials easily
-    # @yield [api_key]
+    # @yield [api_key, username, password]
     def configure
       yield self
       true

data/officialfm.gemspec

@@ -1,31 +1,43 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/officialfm/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = 'officialfm'
-  s.version = OfficialFM::VERSION
-  s.authors = ["Amos Wenger"]
-  s.email = ['amos@official.fm']
-  s.summary = %q{Official Ruby bindings for the official.fm API}
-  s.description = %q{Official Ruby bindings for the official.fm API}
-  s.homepage = 'http://github.com/officialfm/officialfm-ruby'
+Gem::Specification.new do |gem|
+  gem.name = 'officialfm'
+  gem.version = OfficialFM::VERSION
+  gem.authors = ["Amos Wenger"]
+  gem.email = ['amos@official.fm']
+  gem.summary = %q{Official Ruby bindings for the official.fm API}
+  gem.description = %q{Official Ruby bindings for the official.fm API}
+  gem.post_install_message =<<eos
+********************************************************************************
 
-  s.add_runtime_dependency 'faraday', '~> 0.5.3'
-  s.add_runtime_dependency 'faraday_middleware', '~> 0.3.0'
-  s.add_runtime_dependency 'hashie', '~> 1.0.0'
+  Follow @ofmdev on Twitter for announcements, updates, and news.
+  https://twitter.com/ofmdev
 
-  s.add_development_dependency 'bundler', '~> 1.0'
-  s.add_development_dependency 'fakeweb', '~> 1.3'
-  s.add_development_dependency 'jnunemaker-matchy', '~> 0.4'
-  s.add_development_dependency 'json_pure', '~> 1.4'
-  s.add_development_dependency 'rake', '~> 0.8'
-  s.add_development_dependency 'shoulda', '~> 2.11'
-  s.add_development_dependency 'test-unit', '~> 2.1'
+  Don't forget to get your API key here:
+  http://official.fm/developers/manager
 
-  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
-  s.platform = Gem::Platform::RUBY
-  s.require_paths = ['lib']
-  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)}
+********************************************************************************
+eos
+  gem.homepage = 'http://github.com/officialfm/officialfm-ruby'
+
+  gem.add_runtime_dependency 'faraday', '~> 0.6'
+  gem.add_runtime_dependency 'faraday_middleware', '~> 0.6'
+  gem.add_runtime_dependency 'hashie', '~> 1.0.0'
+  gem.add_runtime_dependency 'simple_oauth', '~> 0.1.5'
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'fakeweb', '~> 1.3'
+  gem.add_development_dependency 'jnunemaker-matchy', '~> 0.4'
+  gem.add_development_dependency 'json_pure', '~> 1.5'
+  gem.add_development_dependency 'rake', '~> 0.8'
+  gem.add_development_dependency 'shoulda', '~> 2.11'
+  gem.add_development_dependency 'test-unit', '~> 2.1'
+
+  gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if gem.respond_to? :required_rubygems_version=
+  gem.platform = Gem::Platform::RUBY
+  gem.require_paths = ['lib']
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
 end

data/test/fixtures/playlists.json

@@ -1,92 +1,122 @@
 [
-  {
-    "comments_count":0,
-    "created_at":"2011-03-01 00:33:20 UTC",
-    "description":"",
-    "id":55569,
-    
-    "length":4167,
-    
-    "name":"HLSTRS – Timeless (Mixtape for HARTZINE)",
-    "picture_absolute_url":"http://cdn.official.fm/playlist_pictures/55/55569_small.jpg",
-    "plays_count":50,
-    "shuffle":false,
-    
-    
-    "tracks_count":16,
-    "tracks_list":"216372,216374,216378,216381,216384,216385,216388,216389,216392,216390,216395,216394,216396,216398,216400,216399",
-    "user_id":46269,
-    "votes_count":1  },
-  {
-    "comments_count":0,
-    "created_at":"2011-02-02 12:12:39 UTC",
-    "description":null,
-    "id":53202,
-    
-    "length":1575,
-    
-    "name":"MIXTAPE BOOTIE RIO NATAL",
-    "picture_absolute_url":"http://cdn.official.fm/playlist_pictures/53/53202_small.jpg",
-    "plays_count":4,
-    "shuffle":false,
-    
-    
-    "tracks_count":1,
-    "tracks_list":"183448",
-    "user_id":98816,
-    "votes_count":0  },
-  {
-    "comments_count":0,
-    "created_at":"2011-02-02 12:12:59 UTC",
-    "description":null,
-    "id":53203,
-    
-    "length":3768,
-    
-    "name":"MIXTAPE TEM GRINGO NO MASHUP",
-    "picture_absolute_url":"http://cdn.official.fm/playlist_pictures/53/53203_small.jpg",
-    "plays_count":1,
-    "shuffle":false,
-    
-    
-    "tracks_count":1,
-    "tracks_list":"178977",
-    "user_id":98816,
-    "votes_count":0  },
-  {
-    "comments_count":0,
-    "created_at":"2008-09-20 17:36:33 UTC",
-    "description":"",
-    "id":5801,
-    
-    "length":940,
-    
-    "name":"Rap",
-    "picture_absolute_url":"http://cdn.official.fm/playlist_pictures/5/5801_small.jpg",
-    "plays_count":3,
-    "shuffle":false,
-    
-    
-    "tracks_count":4,
-    "tracks_list":"57854,40057,11290,12818",
-    "user_id":6603,
-    "votes_count":0  },
-  {
-    "comments_count":0,
-    "created_at":"2011-01-24 14:25:27 UTC",
-    "description":"",
-    "id":52439,
-    
-    "length":1055,
-    
-    "name":"pop4",
-    "picture_absolute_url":"http://cdn.official.fm/playlist_pictures/52/52439_small.jpg",
-    "plays_count":1,
-    "shuffle":false,
-    
-    
-    "tracks_count":4,
-    "tracks_list":"24970,26036,26032,25520",
-    "user_id":51638,
-    "votes_count":0  }
+	  {
+  
+  "comments_count":0,
+  "created_at":"2011-03-01 00:33:20 UTC",
+  "description":"",
+  "id":55569,
+  
+  "length":4167,
+  
+  "name":"HLSTRS – Timeless (Mixtape for HARTZINE)",
+  "password":null,
+  "picture_absolute_url":"http://cdn.official.fm/playlist_pictures/55/55569_small.jpg",
+  "plays_count":74,
+  "private":false,
+  "shuffle":false,
+  
+  
+  "tracks":[216372,216374,216378,216381,216384,216385,216388,216389,216392,216390,216395,216394,216396,216398,216400,216399],
+  "tracks_count":16,
+  "tracks_list":"216372,216374,216378,216381,216384,216385,216388,216389,216392,216390,216395,216394,216396,216398,216400,216399",
+  "user_id":46269,
+  "votes_count":1
+}
+	  ,
+	  {
+  
+  "comments_count":0,
+  "created_at":"2011-06-11 06:12:57 UTC",
+  "description":null,
+  "id":64801,
+  
+  "length":1946,
+  
+  "name":"Guruguru",
+  "password":null,
+  "picture_absolute_url":"http://cdn.official.fm/track_pictures/252/252818_small.jpg",
+  "plays_count":0,
+  "private":false,
+  "shuffle":false,
+  
+  
+  "tracks":[252818],
+  "tracks_count":1,
+  "tracks_list":"252818",
+  "user_id":119997,
+  "votes_count":0
+}
+	  ,
+	  {
+  
+  "comments_count":0,
+  "created_at":"2011-02-02 12:12:39 UTC",
+  "description":null,
+  "id":53202,
+  
+  "length":1575,
+  
+  "name":"MIXTAPE BOOTIE RIO NATAL",
+  "password":null,
+  "picture_absolute_url":"http://cdn.official.fm/track_pictures/183/183448_small.jpg",
+  "plays_count":4,
+  "private":false,
+  "shuffle":false,
+  
+  
+  "tracks":[183448],
+  "tracks_count":1,
+  "tracks_list":"183448",
+  "user_id":98816,
+  "votes_count":0
+}
+	  ,
+	  {
+  
+  "comments_count":0,
+  "created_at":"2011-02-02 12:12:59 UTC",
+  "description":null,
+  "id":53203,
+  
+  "length":3768,
+  
+  "name":"MIXTAPE TEM GRINGO NO MASHUP",
+  "password":null,
+  "picture_absolute_url":"http://cdn.official.fm/track_pictures/178/178977_small.jpg",
+  "plays_count":2,
+  "private":false,
+  "shuffle":false,
+  
+  
+  "tracks":[178977],
+  "tracks_count":1,
+  "tracks_list":"178977",
+  "user_id":98816,
+  "votes_count":0
+}
+	  ,
+	  {
+  
+  "comments_count":0,
+  "created_at":"2008-09-20 17:36:33 UTC",
+  "description":"",
+  "id":5801,
+  
+  "length":940,
+  
+  "name":"Rap",
+  "password":null,
+  "picture_absolute_url":"http://cdn.official.fm/track_pictures/57/57854_small.jpg",
+  "plays_count":3,
+  "private":false,
+  "shuffle":false,
+  
+  
+  "tracks":[57854,40057,11290,12818],
+  "tracks_count":4,
+  "tracks_list":"57854,40057,11290,12818",
+  "user_id":6603,
+  "votes_count":0
+}
+	  
 ]

data/test/playlists_test.rb

@@ -12,7 +12,7 @@ class PlaylistsTests < Test::Unit::TestCase
       tracks = @client.playlists('R&B Mixtape', :limit => 5)
       tracks.length.should == 5
       tracks[0].running_time.should == 4167
-      tracks[3].tracks[1].should == 40057
+      tracks[4].tracks[3].should == 12818
     end
     
     should "get info on HLSTRS Timeless mixtape" do

metadata

@@ -1,138 +1,144 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: officialfm
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Amos Wenger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-20 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: faraday
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &73388740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.5.3
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: faraday_middleware
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *73388740
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &73388490 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.3.0
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: hashie
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *73388490
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &73388260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *73388260
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: &73388030 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *73388030
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &73387800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: fakeweb
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *73387800
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &73387570 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: jnunemaker-matchy
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *73387570
+- !ruby/object:Gem::Dependency
+  name: jnunemaker-matchy
+  requirement: &73387340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.4"
+      - !ruby/object:Gem::Version
+        version: '0.4'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: json_pure
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *73387340
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: &73387110 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.4"
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *73387110
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &73386880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "0.8"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *73386880
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &73386650 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.11"
+      - !ruby/object:Gem::Version
+        version: '2.11'
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: test-unit
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: *73386650
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &73386420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.1"
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :development
-  version_requirements: *id010
+  prerelease: false
+  version_requirements: *73386420
 description: Official Ruby bindings for the official.fm API
-email: 
+email:
 - amos@official.fm
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .document
 - .gitignore
 - Gemfile
@@ -140,7 +146,9 @@ files:
 - README.md
 - Rakefile
 - changelog.md
+- lib/faraday/request/officialfm_oauth.rb
 - lib/officialfm.rb
+- lib/officialfm/authentication.rb
 - lib/officialfm/client.rb
 - lib/officialfm/playlists.rb
 - lib/officialfm/tracks.rb
@@ -167,52 +175,30 @@ files:
 - test/playlists_test.rb
 - test/tracks_test.rb
 - test/users_test.rb
-has_rdoc: true
 homepage: http://github.com/officialfm/officialfm-ruby
 licenses: []
-
-post_install_message: 
+post_install_message: ! "********************************************************************************\n\n
+  \ Follow @ofmdev on Twitter for announcements, updates, and news.\n  https://twitter.com/ofmdev\n\n
+  \ Don't forget to get your API key here:\n  http://official.fm/developers/manager\n\n********************************************************************************\n"
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Official Ruby bindings for the official.fm API
-test_files: 
-- test/fixtures/charts.json
-- test/fixtures/latest.json
-- test/fixtures/playlist.json
-- test/fixtures/playlist_votes.json
-- test/fixtures/playlists.json
-- test/fixtures/track.json
-- test/fixtures/track_votes.json
-- test/fixtures/tracks.json
-- test/fixtures/user.json
-- test/fixtures/user_contacts.json
-- test/fixtures/user_playlists.json
-- 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
-- test/users_test.rb
+test_files: []