search

timrogers / airports

Access data on airports from around the world using Ruby
MIT License
32 stars 20 forks source link

readme

Airports

Gem Version

Airports gives you access to data on airports around the world from your Ruby applications.

It's based on data from OpenFlights, with a bit of massaging on the way (dropping airports without an IATA code, giving Doha its IATA code and adding HYD and BER which are missing entirely).

Usage

Install the gem by adding it to your Gemfile:

gem "airports", "~> 1.9.0"

You can then look up an airport by its IATA code (e.g. LHR for London Heathrow) using Airports.find_by_iata_code, which returns an object with a bunch of accessors like name and city:

Airports.find_by_iata_code("LHR")
=> #<Airports::Airport:0x00007fdbd1df68d0 @name="London Heathrow Airport", @city="London", @country="United Kingdom", @iata="LHR", @icao="EGLL", @latitude="51.4706", @longitude="-0.461941", @altitude="83", @timezone="0", @dst="E", @tz_name="Europe/London">

You can also look up an airport by its ICAO code.

Airports.find_by_icao_code("KCRG")
=> #<Airports::Airport:0x00007fdbd1d955d0 @name="Jacksonville Executive at Craig Airport", @city="Jacksonville", @country="United States", @iata="CRG", @icao="KCRG", @latitude="30.3362998962", @longitude="-81.51439666750001", @altitude="41", @timezone="\\N", @dst="\\N", @tz_name="\\N">

A couple of other methods provide access to aggregate data.

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

validates :destination_airport, inclusion: { in: Airports.iata_codes, message: "is not a valid airport" }

Or Airports.all will provide Airports::Airport objects representing all the airports 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

To update the data included in the gem, just run bundle exec rake update and make a pull request with the changes. This will pull the latest data from OpenFlights.

Bug reports and pull requests are welcome on GitHub at https://github.com/timrogers/airports. 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

Big thanks to OpenFlights for collecting and making this data available. Check out their website for additional data about airlines, routes etc.

License

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