Project

usda_ndb

0.01
No commit activity in last 3 years
No release in over 3 years
Wrapper for USDA National Nutrient Database API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.8
~> 0
~> 10.0
~> 3.0
~> 3.0
~> 2.0

Runtime

< 3, > 1.7
 Project Readme

UsdaNdb

A ruby gem wrapping API of USDA National Nutrient Database which will let you instantly search for nutrition data. You may also consider importing the database with usda-nutrient-database gem.

Installation

Add this line to your application's Gemfile:

gem 'usda_ndb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install usda_ndb

Usage

Visit https://api.data.gov/signup/ and get a free data.gov API key. Then create initializer

$ rails generate usda_ndb:install

and set your key in /config/initializers/usda_ndb.rb.

UsdaNdb.configure do |config|
  config.api_key = 'Your API key'
end

Then you can use it.

# to search for products
UsdaNdb.search('apple raw')
# => {"list"=>{"q"=>"apple raw", "sr"=>"28", "ds"=>"any", "start"=>0, "end"=>22, "total"=>22, "group"=>"", "sort"=>"r", "item"=>[{"offset"=>0, "group"=>"Fruits and Fruit Juices", "name"=>"Apples, raw, with skin", "ndbno"=>"09003", "ds"=>"SR"}, ...

# to get nutrition data about product with concrete id(ndbno)
UsdaNdb.reports('09003')
# => {"report"=>{"sr"=>"28", "type"=>"Basic", "food"=>{"ndbno"=>"09003", "name"=>"Apples, raw, with skin", "ds"=>"Standard Reference", "ru"=>"g", "nutrients"=>[{"nutrient_id"=>"255", "name"=>"Water", ...

# to list products
UsdaNdb.list
# => {"list"=>{"lt"=>"f", "start"=>0, "end"=>50, "total"=>50, "sr"=>"28", "sort"=>"n", "item"=>[{"offset"=>0, "id"=>"09427", "name"=>"Abiyuch, raw"}, {"offset"=>1, "id"=>"09002", "name"=>"Acerola juice, raw"}, ...

You can specify additional params. A reference is here

# to list product groups instead of products
UsdaNdb.list(lt: 'g')
# => {"list"=>{"lt"=>"g", "start"=>0, "end"=>25, "total"=>25, "sr"=>"28", "sort"=>"n", "item"=>[{"offset"=>0, "id"=>"3500", "name"=>"American Indian/Alaska Native Foods"}, {"offset"=>1, "id"=>"0300", "name"=>"Baby Foods"}, ...

Contributing

  1. Fork it ( https://github.com/aTeapot/usda_ndb/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request