A simple API web app for Transperth
Ruby JavaScript HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
db
doc
js-api
lib
log
public
script
spec
transit_data
vendor
.gitignore
.rspec
.ruby-version
Gemfile
Gemfile.lock
LICENSE
Procfile
README.md
Rakefile
config.ru

README.md

Transperth API

Want to use the API?

Howdy partner! This API is for building applications that consume data from the Perth Transit API.

To find out more, visit the hosted API documentation. We currently provide a hosted instance of this API on http://api.perthtransit.com/ that you can use and experiment with.

About

This sample app is an example application for RocketPants and makes use of ActiveRecord, RocketPants and API Smith for an API client.

Please note that this applicaton requires Ruby 1.9.3.

Getting Started

To get started, clone this repository and enter it. Next:

cp config/database.yml.sample config/database.yml
# Edit the database.yml.sample
rake db:create db:setup
rails s

And next, visit:

  • http://localhost:3000/1/train_stations - A list of all stations
  • http://localhost:3000/1/bus_stops/12345 - The bus stop with stop number 12345.
  • http://localhost:3000/1/smart_rider/12345 - The smart rider with id 12345.

Contributing

We encourage all community contributions. Keeping this in mind, please follow these general guidelines when contributing:

  • Fork the project
  • Create a topic branch for what you’re working on (git checkout -b awesome_feature)
  • Commit away, push that up (git push your_remote awesome_feature)
  • Create a new GitHub Issue with the commit, asking for review. Alternatively, send a pull request with details of what you added.
  • Once it’s accepted, if you want access to the core repository feel free to ask! Otherwise, you can continue to hack away in your own fork.

Other than that, our guidelines very closely match the GemCutter guidelines here.

(Thanks to GemCutter for the contribution guide)

License

Transperth API is released under the MIT License (see the license file) and is copyright Darcy Laycock, 2012.

You're welcome to use and modify the code as you see fit.

This client is in no way affiliated with / endorsed by Transperth. Please note that Transperth and it's associated terms are property of Transperth itself and there is no association between this code, myself and Transperth.