officialfm 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,26 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gem
+.yardopts
+.yardoc
+.bundle
+Gemfile.lock
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Amos Wenger
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# official.fm
+
+Unofficial Ruby wrapper for the [official.fm Simple API](http://official.fm/developers).
+
+## Installation
+
+    sudo gem install officialfm
+
+## Get your API key
+
+Be sure and get your API key: [http://official.fm/developers/manage](http://official.fm/developers/manage)
+
+## Usage
+
+### Instantiate a client
+
+    officialfm = OfficialFM::Client.new(:api_key => 'your_api_key')
+
+#### Examples
+
+    officialfm.user('chab')
+    puts user.name
+
+    officialfm.tracks('Dare', {:limit => 10, :embed => false}).each |track| do
+      puts "#{track.name} by #{track.artist_string}"
+    end
+    
+For a complete example of web-app using Sinatra in conjunction with
+this gem, see [ofmtweet](https://github.com/nddrylliog/ofmtweet).
+
+## Additions to the original API
+
+### playlist.tracks
+
+For the time being, the structure of playlists in the JSON response of the official.fm
+server is:
+
+		{   
+				"tracks_count":4,
+				"tracks_list":"57854,40057,11290,12818",
+		}
+
+It'd be more convenient to have something like:
+
+		{   
+				"tracks": [ 57854, 40057, 11290, 12818 ],
+		}
+
+But until it's fixed, this gem emulates it, so you can still write pretty code like:
+
+    officialfm.playlists('R&B', :limit => 1)[0].tracks.do |track|
+			puts "  * #{officialfm.track(track).title}"
+		end
+
+### playlist.running\_time
+
+The original API has a `length` attribute in playlists, but unfortunately
+we can't use it from the Ruby side with Hashie, because it's already the number
+of fields of the hash (as I understand it).
+
+It can still be accessed with `playlist["length"]` but since it's not pretty,
+the gem allows you to access it like this:
+
+		puts "#{playlist.running_time}s of pure bliss"
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Amos Wenger. See LICENSE for details.
+
+Based on [@pengwynn's Gowalla API wrapper](https://github.com/pengwynn/gowalla)
+
+A huge load of thanks to pengwynn for releasing it open-source! It was wonderful
+to work from his extra-clean codebase.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rake'
+require "shoulda/tasks"
+require "rake/testtask"
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |test|
+  test.ruby_opts = ["-rubygems"] if defined? Gem
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/changelog.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.0.1 March 23, 2011
+  * Initial version
+  * Supports tracks, users, playlists
+  * Improved playlist support: tracks, running_time

data/lib/officialfm/client.rb

@@ -0,0 +1,57 @@
+require 'forwardable'
+
+# Note: this gem only supports the Simple API, since the Advanced API
+# is still in development
+
+module OfficialFM
+  class Client
+    extend Forwardable
+
+    include Users
+    include Tracks
+    include Playlists
+    
+    attr_reader :api_key
+
+    def_delegators :web_server
+
+    def initialize(options={})
+      @api_key = options[:api_key] || OfficialFM.api_key
+      # 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
+    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
+        builder.use Faraday::Response::Mashify
+      end
+
+    end
+    
+    # @private
+    def default_headers
+      headers = {
+        :accept =>  'application/json',
+        :user_agent => 'officialfm Ruby gem'
+      }
+    end
+
+    # Provides the URL for accessing the API
+    #
+    # @return [String]
+    def api_url
+      "http://api.official.fm"
+    end
+  end
+end

data/lib/officialfm/playlists.rb

@@ -0,0 +1,55 @@
+require 'cgi'
+
+module OfficialFM
+  module Playlists
+  
+    # Search for playlists
+    #
+    # @param [String] search_param: a search parameter (eg. name of the playlist)
+    # @param [Integer] limit (50) limit per page (optional)
+    # @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]
+      end
+      
+      response.body.map do |pl| improve(pl) end
+    end
+  
+    # Retrieve information about a specific playlist
+    #
+    # @param [String] track_id: id
+    # @param [Bool] embed (false) should embed codes be included in the response
+    # @return [Hashie::Mash] Playlist
+    def playlist(playlist_id, options={})
+      response = connection.get do |req|
+        req.url "/playlist/#{CGI::escape(playlist_id.to_s)}",
+          :api_embed_codes => options[:embed]
+      end
+      improve(response.body[0])
+    end
+    
+    # Retrieve users that have voted for this playlist
+    #
+    # @param [String] track_id: id
+    # @param [Integer] limit (50) limit per page
+    # @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]
+      end
+      response.body
+    end
+    
+    def improve(playlist)
+      # the length field is already used. Note: running_time is in seconds
+      playlist.running_time = playlist["length"]
+      # Our own little hack to make it a lot easier to handle, until the API is improved.
+      playlist.tracks = playlist.tracks_list.split(',').map do |x| x.to_i end
+      playlist
+    end
+    
+  end
+end

data/lib/officialfm/tracks.rb

@@ -0,0 +1,82 @@
+require 'cgi'
+
+module OfficialFM
+  module Tracks
+  
+    # Search for tracks
+    #
+    # @param [String] search_param: a search parameter (eg. name of the track)
+    # @param [Integer] limit (50) limit per page (optional)
+    # @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]
+      end
+      response.body
+    end
+  
+    # Retrieve information about a specific track
+    #
+    # Note: http://official.fm/developers/simple_api#track_show
+    # says that api_max_responses is a valid parameter. Why escapes me.
+    #
+    # @param [String] track_id: id
+    # @param [Bool] embed (false) should embed codes be included in the response
+    # @return [Hashie::Mash] Track
+    def track(track_id, options={})
+      response = connection.get do |req|
+        req.url "/track/#{track_id}",
+          :api_embed_codes => options[:embed]
+      end
+      response.body[0]
+    end
+    
+    # Retrieve users that have voted for this track
+    #
+    # @param [String] track_id: id
+    # @param [Integer] limit (50) limit per page
+    # @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]
+      end
+      response.body
+    end
+    
+    # Retrieve 200 tracks of selected chart
+    #
+    # @param [String] charting: :today, :week, :month, :year or :all_time
+    # @param [String] genre: Genre string (Electronic, Rock, Jazz, ...) (optional)
+    # @param [String] country: ISO country id (CH, FR, UK) (optional)
+    # @param [Bool] embed (false) should embed codes be included in the response (optional)
+    # @param [Integer] limit (200) limit per page (optional)
+    # @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]
+      end
+      response.body
+    end
+    
+    # Retrieve 200 latest tracks
+    #
+    # @param [String] genre: Genre string (Electronic, Rock, Jazz, ...) (optional)
+    # @param [String] country: ISO country id (CH, FR, UK) (optional)
+    # @param [Bool] embed (false) should embed codes be included in the response (optional)
+    # @param [Integer] limit (200) limit per page (optional)
+    # @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]
+      end
+      response.body
+    end
+  
+  end
+end

data/lib/officialfm/users.rb

@@ -0,0 +1,97 @@
+require 'cgi'
+
+module OfficialFM
+  module Users
+
+    # Search for users
+    #
+    # @param [String] search_param: a search parameter (eg. name of the user)
+    # @param [Integer] limit (50) limit per page
+    # @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]
+      end
+      response.body
+    end
+
+    # Retrieve information about a specific user
+    #
+    # @param [String] user_id: id or login
+    # @return [Hashie::Mash] User
+    def user(user_id)
+      response = connection.get do |req|
+        req.url "/user/#{user_id}"
+      end
+      response.body[0]
+    end
+
+    # Retrieve a list of the tracks of this user
+    #
+    # @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 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]
+      end
+      response.body
+    end
+    
+    # Retrieve a list of the playlists of this user
+    #
+    # @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 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]
+      end
+      response.body
+    end
+    
+    # Retrieve a list of the contacts of this 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]
+      end
+      response.body
+    end
+    
+    # Retrieve a list of the subscribers of this 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]
+      end
+      response.body
+    end
+    
+    # Retrieve a list of the subscriptions of this 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]
+      end
+      response.body
+    end
+
+  end
+end

data/lib/officialfm/version.rb

@@ -0,0 +1,3 @@
+module OfficialFM
+  VERSION = '0.0.1'
+end

data/lib/officialfm.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'oauth2'
+require 'faraday_middleware'
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+module OfficialFM
+
+  class << self
+    attr_accessor :api_key
+    attr_accessor :test_mode
+
+    # Configures default credentials easily
+    # @yield [api_key]
+    def configure
+      yield self
+      true
+    end
+
+    def test_mode?
+      !!self.test_mode
+    end
+  end
+
+  require 'officialfm/users'
+  require 'officialfm/tracks'
+  require 'officialfm/playlists'
+  require 'officialfm/client'
+
+end

data/officialfm.gemspec

@@ -0,0 +1,32 @@
+# -*- 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 = ['ndd@rylliog.cz']
+  s.summary = %q{Unofficial wrapper for the official.fm API}
+  s.description = %q{Unofficial Ruby wrapper for the official.fm API}
+  s.homepage = 'http://github.com/nddrylliog/officialfm-ruby'
+
+  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'
+  s.add_runtime_dependency 'oauth2', '~> 0.1.0'
+
+  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'
+
+  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)}
+end