nutritionix-mod 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9728df65e13f4fcb5b33222c3b2468c2bb1c5f8f
+  data.tar.gz: 76fdcb697b85af2caea421f65512bddf0047ae81
+SHA512:
+  metadata.gz: 23f87b852586677f2e0575e9ad4943961664fc99db777cc9058464e927065544634f8a5cd56d1175d5610b8f1d56c97c8649be181381bef81e0234d92c843699
+  data.tar.gz: 9900c73387e31decd42df166d5eab6800cb3f6fcd48a131dfb0853b88bcac195a5bebac94efc440f37b57030479fce98e62d01c05af094681a1752944837ddc1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nutritionix.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fazle Taher
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Nutritionix
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nutritionix'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nutritionix
+
+## Usage
+
+* For NXQL Supported search:
+
+        app_id = '<YOUR_APP_ID>'
+        app_key = '<YOUR_APP_KEY>'
+        provider = Nutritionix::Api_1_1.new(app_id, app_key)
+        search_params = {
+          offset: 0,
+          limit: 50,
+          fields: ['brand_id', 'brand_name', 'item_id', 'item_name', 'nf_calories'],
+          query: 'potato'
+        }
+        results_json = provider.nxql_search(search_params)
+        puts "Results: #{results_json}"
+
+* Note:
+  * There is a standalone test script **/script/test_api_1_1.rb** available
+    which can be readily used for testing.You only need to replace &lt;YOUR_APP_ID&gt;
+    and &lt;YOUR_APP_KEY&gt; with your nutritionix app credentials.
+
+  * Logs generated can be found at default location &lt;HOME_DIRECTORY&gt;/nutritionix_api_logs.txt
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/nutritionix-mod/version.rb

@@ -0,0 +1,3 @@
+module Nutritionix
+  VERSION = "1.1.0"
+end

data/lib/nutritionix-mod.rb

@@ -0,0 +1,203 @@
+require "rest-client"
+require "cgi"
+require 'logger'
+require 'active_support/json'
+
+module Nutritionix
+  # Reference: https://github.com/mftaher/nutritionix-api-ruby-library/blob/master/lib/nutritionix.rb
+  class Api_1_1
+    attr_accessor :app_id, :app_key, :app_url
+    attr_accessor :logger
+
+    #
+    # Create the Nutritionix API client.
+    #
+    # @param id Nutritionix application ID
+    # @param key Nutritionix API key
+    # @param url (Optional) Nutritionix API url
+    #
+    def initialize(id, key, url="https://api.nutritionix.com/v1_1", logger=APILogger.default_logger)
+      @app_id = id
+      @app_key = key
+      @app_url = url
+      @logger = logger
+    end
+
+    # Sends a POST request to the Nutritionix API Server
+    #
+    # @param endpoint The endpoint to send the request to.Current valid type is: search
+    #
+    # @param params a hash containing required query, filters, etc options as defined
+    # by https://developer.nutritionix.com/docs/v1_1 Nutritionix Querying Language
+    # (NXQL) convertible to a valid JSON.
+    #
+    # @return The request result or error as json string
+    #
+    def post_request(endpoint, params={})
+      params = sanitize_params(params)
+      add_creds_to_params(params)
+
+      params_json = params.to_json
+      logger.debug "======POST Request Params Json: #{params_json}"
+
+      url = [@app_url, endpoint].join('/')
+      logger.debug "POST request URL: #{url}"
+      begin
+        # Reference: http://rubydoc.info/gems/rest-client/1.6.7/RestClient.post
+        response = RestClient.post(url, params_json, content_type: 'application/json')
+      rescue Exception => e
+        logger.error "==================================================="
+        logger.debug "An exception occured while processing POST request to url: #{url}"
+        logger.error e.to_s
+        logger.error "==================================================="
+        response = { error: e.message}.to_json
+      end
+
+      response
+    end
+
+    # Sends a GET request to the Nutritionix API Server
+    #
+    # @param query string Query or search term / phrase
+    # @param endpoint The endpoint to send the request to.Current valid type is: search, item, brand
+    #
+    # @param params a hash containing required query, filters, etc options as defined
+    # by https://developer.nutritionix.com/docs/v1_1 Nutritionix Querying Language
+    # (NXQL) convertible to a valid JSON.
+    #
+    # @return The request result or error as json string
+    #
+    def get_request(query, endpoint, params={})
+      query = ::CGI::escape(query)
+      params = sanitize_params(params)
+      add_creds_to_params(params)
+
+      serialized_params = serialize_params(params)
+
+      url_components = [@app_url, endpoint]
+      if 'item' == endpoint
+        # Heroku using older version of Ruby prepend method on String is
+        # not available.Thus using String's insert method
+        serialized_params.insert(0, "id=#{query}&")
+      else
+        url_components << query
+      end
+
+      url =  "#{url_components.join('/')}?#{serialized_params}"
+      logger.debug "GET request URL: #{url}"
+      header = {}
+      begin
+        response = RestClient.get url, header
+      rescue Exception => e
+        logger.error "==================================================="
+        logger.debug "An exception occured while processing GET request to url: #{url}"
+        logger.error e.to_s
+        logger.error "==================================================="
+        response = { error: e.message}.to_json
+      end
+
+      response
+    end
+
+    #
+    # Pass a search term into the API like taco, or cheese fries, and the
+    # NutritionIX API will return an array of matching foods.
+    #
+    # @param term string The phrase or terms you would like to search by
+    # @param range_start integer (Optional)Start of the range of results to view a section of up to 500 items in the "hits" array
+    # @param range_end integer (Optional)End of the range of results to view a section of up to 500 items in the "hits" array
+    # by default, the api will fetch the first 10 results
+    # @param cal_min integer (Optional)The minimum number of calories you want to be in an item returned in the results
+    # @param cal_max integer (Optional)The maximum number of calories you want to be in an item returned in the results
+    # @param fields strings (Optional)The fields from an item you would like to return in the results.
+    # Supports all item properties in comma delimited format.
+    # A null parameter will return the following item fields only: item_name, brand_name, item_id.
+    # NOTE-- passing "*" as a value will return all item fields.
+    # @param brand_id string (Optional)Filter your results by a specific brand by passing in a brand_id
+    #
+    # @return The search results as json string
+    #
+    def search(term, range_start = 0, range_end = 10, cal_min = 0, cal_max = 0, fields = NIL, brand_id = NIL)
+      get_request(term, 'search', {
+          :results => "#{range_start}:#{range_end}",
+          :cal_min => "#{cal_min}",
+          :cal_max => "#{cal_max}",
+          :fields => fields,
+          :brand_id => brand_id,
+      })
+    end
+
+    def nxql_search(search_params={})
+      # Default sort options
+      sort_options = {
+        sort: {
+          field: "_score",
+          order: "desc"
+        }
+      }
+
+      search_params.merge!(sort_options) unless search_params[:sort].nil?
+
+      logger.debug "Nutritionix::Api_1_1 NXQL search params: #{search_params}"
+
+      post_request('search', search_params)
+    end
+
+    #
+    # This operation returns an item object that contains data on all its nutritional content
+    #
+    # @param id string The id of the food item whose details are needed
+    #
+    # @return the item details as json string
+    #
+    def get_item(id)
+      get_request(id, 'item', {})
+    end
+
+    private
+
+    def add_creds_to_params(params)
+      params[:appId] = @app_id
+      params[:appKey] = @app_key
+    end
+
+    def sanitize_params(params)
+      params = {} unless params.is_a? Hash
+      params
+    end
+
+     def serialize_params(params)
+       request_params = []
+       params.each do |key, value|
+          request_params << "#{key}=#{::CGI::escape(value)}" unless value.nil?
+       end
+       request_params.join('&')
+     end
+
+  end
+
+  class APIException < Exception
+
+  end
+
+  # http://ruby.about.com/od/tasks/a/logger.htm
+  class APILogger
+    attr_reader :logger_instance
+    attr_accessor :file
+
+    # @param logger the logger instance to be used for logging
+    # @param file. Default outputs log to <HOME_DIR>/nutritionix_api_logs.txt
+    def initialize(logger=nil, file=File.join(Dir.home, 'nutritionix_api_logs.txt'))
+      @file = file
+      @logger_instance = logger || Logger.new(@file)
+    end
+
+    # Returns the default logger(Logger) instance distributed by Ruby in its
+    # standard library.
+    def self.default_logger
+      logger = APILogger.new
+      logger.logger_instance
+    end
+
+  end
+end

data/nutritionix-mod.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nutritionix-mod/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nutritionix-mod"
+  spec.version       = Nutritionix::VERSION
+  spec.authors       = ["Fazle Taher"]
+  spec.email         = ["ftaher@gmail.com"]
+  spec.description   = %q{Nutritionix API ruby wrapper, with API 1.1 as default}
+  spec.summary       = %q{ruby gem for nutritionix API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+end

data/script/test_api_1_1.rb

@@ -0,0 +1,21 @@
+require_relative '../lib/nutritionix/api_1_1'
+
+def nxql_search_params
+  fields = %w(brand_id brand_name item_id item_name nf_serving_size_qty nf_serving_size_unit)
+  fields << %w(nf_calories nf_total_carbohydrate nf_sodium nf_dietary_fiber nf_protein)
+  default_fields = fields.flatten
+
+  {
+    offset: 0,
+    limit: 50,
+    fields: default_fields
+  }
+end
+
+app_id = '<YOUR_APP_ID>'
+app_key = '<YOUR_APP_KEY>'
+provider = Nutritionix::Api_1_1.new(app_id, app_key)
+search_params = nxql_search_params
+search_params.merge!(query: 'potato')
+results_json = provider.nxql_search(search_params)
+puts "Results: #{results_json}"

data/spec/nutritionix_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'Nutritionix API' do
+  let(:agent){ Nutritionix::API.new(APP_ID,APP_KEY)}
+  subject(:search_params){{:results => "0:10",
+                    :cal_min => nil,
+                    :cal_max => nil,
+                    :fields => nil,
+                    :brand_id => nil}}
+  it 'should return serialized parameters from hash' do
+    serialized = agent.get_serialized_params(search_params)
+    serialized.should == "results=0%3A10&appId=#{agent.app_id}&appKey=#{agent.app_key}"
+  end
+
+  it 'should search for a food nutrition' do
+    results = JSON.parse(agent.search('tacos', 0, 5, 0, 0, '*'))
+    results.should_not be_nil
+  end
+
+  it 'should return an item object that contains data on all its nutritional content' do
+    results = JSON.parse(agent.get_item('eajmz6GbcLXtMluFNhEr'))
+    results.should_not be_nil
+  end
+
+  it 'should return a brand object that contains data on all its nutritional content' do
+    results = JSON.parse(agent.get_brand('SQksuzwib4H1h9'))
+    results.should_not be_nil
+  end
+
+  it 'should return application error without app id and key' do
+    #{"error_message"=>"application with id=\"\" was not found", "error_code"=>"application_not_found"}
+    pending
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'rspec'
+require 'json'
+require_relative "../lib/nutritionix"
+
+APP_ID=''
+APP_KEY=''
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: nutritionix-mod
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Fazle Taher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Nutritionix API ruby wrapper, with API 1.1 as default
+email:
+- ftaher@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nutritionix-mod.rb
+- lib/nutritionix-mod/version.rb
+- nutritionix-mod.gemspec
+- script/test_api_1_1.rb
+- spec/nutritionix_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: ruby gem for nutritionix API
+test_files:
+- spec/nutritionix_spec.rb
+- spec/spec_helper.rb