GTFS DataExchange API
A ruby wrapper for the gtfs-data-exchange.com api.
List all agencies, or find a specific agency by its data exchange identifier.
Installation
Add this line to your application's Gemfile:
gem 'gtfs_data_exchange_api'
And then execute:
$ bundle
Or install it yourself as:
$ gem install gtfs_data_exchange_api
Usage
Agencies
List all agencies.
agencies = GTFSDataExchangeAPI.agencies
By default, this will return an Array
of Ruby Hash
objects. Pass the 'csv' format option to return a CSV String
instead.
agencies = GTFSDataExchangeAPI.agencies(:format => "csv")
Agency
Find an agency by its data exchange identifier.
agency = GTFSDataExchangeAPI.agency(:dataexchange_id => "shore-line-east")
By default, this will return a Ruby Hash
object.
Contributing
- Fork the repo
- Create your feature branch (
git checkout -b my-new-feature
) - Test your changes (optional, but encouraged
rspec spec/
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Releasing
For instructions below, X.X.X refers to the gem version.
- Build gem (
gem build gtfs_data_exchange_api.gemspec
) - Install gem locally (
gem install ./gtfs_data_exchange_api-X.X.X.gem
) - Run tests (
bundle exec rspec spec/
) - Manually test, as desired:
pry
require 'gtfs_data_exchange_api'
- test functionality
- Create a new release tag
- Push gem build to rubygems (
gem push gtfs_data_exchange_api-X.X.X.gem
) - Merge version-named branch into master, if applicable