Amtrak Stations

Provides geographical and timezone data on Amtrak stations.

Date is from the Federal Railroad Administration, with time zone information added.

Usage

Install the gem by adding it to your Gemfile:

gem 'amtrak_stations', '~> 1.0.0'

You can then look up a station by its station code (e.g. BFX for Buffalo (Exchange Street), New York using Amtrak.find_by_station_code, which returns an object with a bunch of accessors like name and city:

AmtrakStations.find_by_station_code("BFX")
=> #<AmtrakStations::Station:0x00000000035c7990 @city="Buffalo-Depew", @latitude="42.907017000270038", @longitude="-78.726584000234652", @name="Buffalo (Depew), New York", @state="NY", @station_code="BUF", @timezone="-5">

A couple of other methods provide access to aggregate data.

You can call AmtrakStations.station_codes for a list of valid IATA codes, perfect for Rails validations:

validates :destination_station, inclusion: { in: AmtrakStations.station_codes, message: "is not a valid station" }

Or Amtrak.all will provide Amtrak::Station objects representing all the stations the gem knows about.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/agirling/amtrak_stations. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Acknowledgements

The data in this gem is made possible by the Office of the Assistant Secretary for Research and Technology/Bureau of Transportation Statistics (BTS) National Transportation Atlas Database (NTAD)

This gem is heavily modeled after Tim Rogers's Airports gem. Thank you for your inspiration.

License

The gem is available as open source under the terms of the MIT License.