FaaApra

A Ruby gem for interacting with the FAA's Aeronautical Products Release API (APRA).

Installation

Add this line to your application's Gemfile:

gem 'faa_apra'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install faa_apra

Usage

First, obtain your API credentials from the FAA External API Portal.

Basic Usage

require 'faa_apra'

# Initialize with client credentials
client = FaaApra.new(
  'your_client_id',
  'your_client_secret'
)

# Or use environment variables
# export FAA_APRA_CLIENT_ID=your_client_id
# export FAA_APRA_CLIENT_SECRET=your_client_secret
client = FaaApra.new

# Get Coded Instrument Flight Procedures (CIFP)
cifp_data = client.cifp_chart
cifp_info = client.cifp_info(edition: 'current')

# Get Terminal Procedure Publication (TPP) chart
tpp_data = client.dtpp_chart(
  edition: 'current',
  area: 'US',
  format: 'all'
)

# Get Sectional Chart data
chart_data = client.sectional_chart(
  edition: 'current',
  geoname: 'NEW_YORK',
  format: 'pdf'
)

# Get IFR Enroute Chart data
ifr_data = client.ifr_enroute_chart(
  edition: 'current',
  altitude: 'high',
  format: 'pdf'
)

Available Endpoints

The gem provides access to the following FAA APRA API endpoints:

Coded Instrument Flight Procedures (CIFP)

• cifp_chart(edition: 'current') - Get CIFP chart download link
• cifp_info(edition: 'current') - Get CIFP edition information

Daily Digital Obstacle File (DDOF)

• ddof_chart - Get DDOF download link
• ddof_info - Get DDOF edition information

Digital Enroute Charts (DEC)

• dec_chart(edition: 'current') - Get DEC chart download link
• dec_info(edition: 'current') - Get DEC edition information

Terminal Procedures Publication (TPP)

• dtpp_chart(edition: 'current', area: 'US', format: 'all') - Get TPP chart download link
• dtpp_info(edition: 'current', area: 'US') - Get TPP edition information

Sectional Charts

• sectional_chart(edition: 'current', geoname: nil, format: 'pdf') - Get Sectional Chart download link
• sectional_info(edition: 'current', geoname: nil, format: 'pdf') - Get Sectional Chart edition information

Grand Canyon VFR Charts

• grand_canyon_chart(edition: 'current', format: 'pdf') - Get Grand Canyon VFR Chart download link
• grand_canyon_info(edition: 'current', format: 'pdf') - Get Grand Canyon VFR Chart edition information

IFR Enroute Charts

• ifr_enroute_chart(edition: 'current', geoname: nil, altitude:, format: 'pdf') - Get IFR Enroute Chart download link
• ifr_enroute_info(edition: 'current', geoname: nil, altitude:, format: 'pdf') - Get IFR Enroute Chart edition information

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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 the created tag, and push the .gem file to rubygems.org.

Contributing

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

License

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

Code of Conduct

Everyone interacting in the FaaApra project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.