Skip to content

Access data on airports from around the world using Ruby

License

Notifications You must be signed in to change notification settings

lukaVarga/airports

 
 

Repository files navigation

Airports

Gem Version Build Status

Airports gives you access to data on airports around the world.

Usage

Install the gem (Ruby 2.1.0 and later only):

$ gem install airports

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:0x007fd9a1bbd550 @name="Heathrow", @city="London", @country="United Kingdom", @iata="LHR", @icao="EGLL", @latitude="51.4775", @longitude="-0.461389", @altitude="83", @timezone="0", @dst="E">

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 Airport.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

Bug reports and pull requests are welcome on GitHub at https://github.com/timrogers/mummy. 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 is taken from https://github.com/ram-nadella/airport-codes, which uses source data from OpenFlights. Source data is included using Git submodules.

License

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

About

Access data on airports from around the world using Ruby

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 98.7%
  • Shell 1.3%