README_HEA_API.md

This is Joe's Bus Library Tool Thing.

This is a tiny Ruby library for driving TheBus' public API. To find out more, check out the official HEA API docs.

Requirements

This libarary requires the Ruby Nokogiri Gem to parse the XML that comes back from TheBus' HEA API. You can install it like so:

$ gem install nokogiri

This library requires Ruby version >= 1.9.

Do the following:

• Sign up for an API key at http://api.thebus.org
• Copy config/config.yml.template to config/config.yml
• Enter your API key into the development section of config.yml

Example Usage:

$ irb -r './client.rb'

> client = JoesBus::Client.new
 => #<JoesBus::Client:0x007f86ad07f770 @user_config={:hea=>{:api_key=>"####"}}, @config={:api_key=>"#####"}>

> client.arrivals_at_stop 123
using api key: #####
url is: http://api.thebus.org/arrivals/?key=#####&stop=123
 => [#<Nokogiri::XML::Element:0x3ff41d8996e8 name="arrival"

> a.size
 => 25
 
> a.first
 => #<Nokogiri::XML::Element:0x3ff41d8996e8 name="arrival"...

More to come.

LICENSE

I'm using the Eclipse Public License for now. This is the same license used by Clojure. Please let me know if you have other preferences. Or, send a pull request.

See LICENSE.txt for license text (or the link above).

Copyright (c) 2013 The People of Hawaii