an open transit data client
Clone or download
Pull request Compare This branch is 9 commits ahead of s2t2:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
lib
log
public
spec
vendor/assets
.gitignore
.rspec
CREDITS.md
Gemfile
Gemfile.lock
LICENSE
Procfile
README.md
README.rdoc
Rakefile
config.ru

README.md

Branford Station

This application finds sources of General Transit Feed Specification (GTFS) open transit data from community-maintained sites like the GTFS Data Exchange and the Google Transit Data Feed Wiki, periodically checks feed sources to confirm current data or download new data, and makes the data available for public consumption through an API and front-end interface.

Usage

View Web Application

Visit next-train.info in a web browser.

Use Web Service API Endpoints

You may make HTTP requests or view GTFS data in a browser using the endpoint urls listed below.

  • /agencies (lists all participating transit agencies)
  • /agencies/:agency_abbrev (lists all train stations serviced by a given agency)
  • /agencies/:agency_abbrev/stations/:station_abbrev (lists upcoming departures from a given station)

These endpoints return HTML by default. To request a JSON response instead, suffix .json to the endpoint url.

Schedule Background Tasks

You may schedule tasks to load all known GTFS data, or just the data you specify.

All Data Sources

Identify
bundle exec rake station_attendant:find_data_exchange_feeds
bundle exec rake station_attendant:find_google_transit_data_feeds
Identify and Load
bundle exec rake station_attendant:find_and_consume_and_load

Ad-hoc Data Sources

You may download GTFS data from specified source(s) into a filesystem or a database.

Filesystem
FeedConsumer.perform(:source_urls => ["http://www.shorelineeast.com/google_transit.zip", "http://web.mta.info/developers/data/mnr/google_transit.zip"])
Database
FeedConsumer.perform(:load => true, :source_urls => ["http://www.shorelineeast.com/google_transit.zip", "http://web.mta.info/developers/data/mnr/google_transit.zip"])

Contributing

To request a new feature, create an issue.

To deliver a new feature, fork the repo, make your changes, add tests if possible, and submit a pull request.

Development Environment Setup

Install dependencies for a Ruby on Rails application.

  • ruby (via rbenv)
  • bundler
  • rails
  • mysql (or postgres, etc. according to database.yml)

Obtain source code.

git clone git@github.com:data-creative/branford_station.git
cd branford_station

Install gem dependencies.

bundle install

Create database user.

-- mysql:
CREATE USER 'branford_station'@'localhost' IDENTIFIED BY 'branford_station';
GRANT ALL ON *.* to 'branford_station'@'localhost';

Create database.

bundle exec rake db:create
bundle exec rake db:migrate

Populate database.

bundle exec rake:db:seed

Start web server.

rails server

View in browser at localhost:3000.

Production Environment Setup

Reference "Deploying a Rails app to Heroku" and "Working with Databases on Heroku".

git push heroku master

View in browser at https://branford-station.herokuapp.com/.