hebron-george/open_fda_api

Ruby wrapper for the openFDA API

OpenFdaApi

A simple Ruby wrapper for the openFDA API.

Installation

Add this line to your application's Gemfile:

gem 'open_fda_api'

And then execute:

bundle install

Usage

client = OpenFdaApi::Client.new
# or if you have registered an API key
client = OpenFdaApi::Client.new(api_key: ENV['OPEN_FDA_API_KEY'])

# First 20 results where (fieldA=foo AND fieldB=bar) OR (fieldC=baz AND fieldA exists)
# Sorted by (fieldD) in descending order
# Skip the first 8 results
args = { 
  search: [{"fieldA" => "foo", "fieldB" => "bar"}, {"fieldC" => "baz", "_exists_" => "fieldA"}],
  sort: [{"fieldD" => "desc"}],
  skip: 8,
  limit: 20 
}

# Animal & Veterinary API
client.animal_and_veterinary.adverse_events(args)

# Drug API
client.drugs.adverse_events(args)
client.drugs.product_labeling(args)
client.drugs.ndc_directory(args)
client.drugs.recall_enforcement_reports(args)
client.drugs.drugs_at_fda(args)

# Device API
client.device.premarket_510ks(args)
client.device.classification(args)
client.device.recall_enforcement_reports(args)
client.device.adverse_events(args)
client.device.premarket_approval(args)
client.device.recalls(args)
client.device.registrations_and_listings(args)
client.device.covid19_serological_tests(args)
client.device.unique_device_identifier(args)

# Food API
client.food.recall_enforcement_reports(args)
client.food.adverse_events(args)

# Other API
client.other.nsde(args)
client.other.substance_data_reports(args)

# Tobacco API
client.tobacco.problem_reports(args)

Querying

The openFDA API can be queried with these arguments: search, sort, count, skip, and limit.

search, sort, and count have the same format. They are arrays of hashes. Each hash has a set of fields and values that are ANDed together and all the elements in the array are ORed together. Here are some examples to illustrate:

# Default arguments
args = {
  search: [],
  sort:   [],
  count:  [],
  skip:   0,
  limit:  1,
}

# Search for a single field
args = {
  search: [{ fieldA: "value" }]
}

# Search for field A AND field B
args = {
  search: [{ fieldA: "value", fieldB: "other value" }]
}

# Search for field A OR field B
args = {
  search: [{ fieldA: "value"}, { fieldB: "other value" }]
}

# Search for field A or field B, and skip the first 10 results
args = {
  search: [{ fieldA: "value"}, { fieldB: "other value" }],
  skip: 10
}

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 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/hebron-george/open_fda_api . 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 OpenFdaApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

open_fda_api's Issues

Rate Limiting Features

openFDA API Documentation says there is a limit to how many requests can be sent to their API:

With no API key: 240 requests per minute, per IP address. 1,000 requests per day, per IP address.

With an API key: 240 requests per minute, per key. 120,000 requests per day, per key.

Should we build rate limit features or leave that to the user to deal with?

Search field validations

Each endpoint provides us a YAML definition of search fields. (e.g. food.adverse_events search fields)

Should we validate user query fields against those?

Set & Send API Key

The client's constructor currently accepts an api_key but does nothing with it.

The key needs to be sent with requests following the openFDA API Documentation