== Upcoming API Library for Ruby

Copyright Dan Webb (dan@vivabit.com) 2006

A rich API for Upcoming.org REST services that supports token based authentication and has a more
Ruby-ish active record style interface.

  Upcoming.authenticate_with_frob('<api_key>', '<user_frob>')
  event = Upcoming::Event.get_info 45346

  new_venue = Venue.new( :name => 'My Event', 
                         :city => 'London', 
                         :address => '1 Some St',
                         :metro => Metro.search('london').first )
  new_venue.add

This library closely mimics the API itself but is translated to Ruby style so:
 
Upcoming methods like event.getWatchlist and auth.checkToken
can be accessed with Event.get_watchlist and Auth.check_token

However, many of the ruby objects provide extra utility methods, getters
and setters:

  event = Event.get_info 35454
  event.private? #=> false
  event.start #=> (A Time object)
  event.metro #=> (A Metro Object)
  event.metro = Metro.search('santa monica').first

If in doubt check the Upcoming docs at:

http://upcoming.org/services/api

=== Installation and Usage

To install:

	sudo gem install path/to/upcoming-xxx.gem
	
To use:

	require 'rubygems'
	require_gem 'upcoming'