official.fm

Ruby wrapper for the official.fm Simple API.

Installation

sudo gem install officialfm

Get your API key

Be sure and get your API key: http://official.fm/developers/manage

Usage

Include the relevant files

require 'rubygems'
require 'officialfm'

Instantiate a client

officialfm = OfficialFM::Client.new(:api_key => 'your_api_key')

Examples

user = 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.

Additions to the original API

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.

This project is distributed under the New BSD License. See LICENSE for details.

Based on @pengwynn's Gowalla API wrapper

A huge load of thanks to pengwynn for releasing it open-source! It was wonderful to work from his extra-clean codebase.