purzelrakete / boomloop

the boomloop api. get some oauth action with boomloop.

This URL has Read+Write access

name age
history
message
file .gitignore Tue May 06 04:53:21 -0700 2008 first commit [rany]
file History.txt Thu Jun 05 07:23:31 -0700 2008 Revert "all done." This reverts commit 4eea352... [purzelrakete]
file README.txt Wed May 21 07:52:04 -0700 2008 added config option for api base [rany]
directory bin/ Wed Jun 04 03:41:38 -0700 2008 tidied up url issues [purzelrakete]
file boomloop.gemspec Wed Jul 02 00:16:10 -0700 2008 final 1.0 [purzelrakete]
directory lib/ Wed Jul 02 00:16:10 -0700 2008 final 1.0 [purzelrakete]
directory test/ Wed Jul 02 00:16:10 -0700 2008 final 1.0 [purzelrakete]
README.txt
This is a Ruby API with which you can access boomloop.com. 

== API Documentation

You can find documentation about the underlying boomloop REST api here: http://boomloop.com/api.

== Getting started

You have to register your api client on boomloop.com before using the api. This is 
a 3 step process. 

1.  Start by signing up on boomloop.com and register your application. You can do that
    here: http://boomloop.com/oauth/new. When you have registered your application, you will 
    receive a consumer key and a consumer secret. 

2.  Setup the api like this: boomloop -k <your consumer key> -s <your consumer secret>
    You will be given a URL – go there and authorize your application. 

3.  Go back to your terminal window and press <enter>. You're registered :).

== Example API Call

Once you have authorized your client, you can make the first API client call. 

require 'boomloop'
events = Boomloop::Resources::Event.index(:order => :proximity, :origin => "opernplatz, frankfurt am main")

This returns a list of the top 10 closest upcoming events, where the origin is opernplatz, frankfurt am main. 

For a full description of options, see boomloop.com/api. The ruby lib is just a thin wrapper around the REST api, so 
what goes up rthere, must come down here ;)