usda_fdc 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c953718a90e8cc39639ed57400d3b22bf689381f0fd3bd734149216f9d541f26
-  data.tar.gz: a45ec9a472df7e292833f825a42a3e81b0b2b9d686dd01c2c366a179d255ca07
+  metadata.gz: 3259d937f8cab77f84475be7d9cc4871efed34326604ceeb0aa2fb6f3e217546
+  data.tar.gz: 88c52fdab8c2bd8fc4d6492fdc81d594dd477d63c49cac8c77b216a35bd21926
 SHA512:
-  metadata.gz: 2c2db45624943439fdff3d8f92498660062a454a2617beb7d2999b55d5add1bee31b4016ddc24e27540cb0c02b6c18dcbb961ec57f8130ed121053e92ebf2f74
-  data.tar.gz: d24b77cd1a3e7cbd6aec8200a6a3f96c5f56a3462f9ad020ee17a9568ce37faa7e9d2b7d882bfc5dee7b09aa71602a8745aa8c098363a8b1825e1b98c9627903
+  metadata.gz: b9804c6de9e90e962dafb4cc9184165c85f6f1b9bbf20a8e6551ab45b817319c87266b82b85cc12988bd2d714ba9db192127739d559ab6eb49d968e4cbcb61d6
+  data.tar.gz: 97dcb6d90428858f511c413e59faab3faa14e056377cab0da0ebb96427371d93132507b24b6220c17aba592ac82059ace8d053a648dc7a177cf770b49786c4e3

data/.rubocop.yml

@@ -6,3 +6,6 @@ Layout/LineLength:
 
 Style/Documentation:
   Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-01-26
+## [0.2.0] - 2022-07-15
+
+- Allow request methods to accept block to manage request
+- Improve response handling (e.g. raise on 4xx/5xx responses)
+
+## [0.1.1] - 2022-06-24
+
+- Ensure `json` module is available to Client
+
+## [0.1.0] - 2022-06-24
+
+- Add basic support for interacting with USDA FDC endpoints
+
+## [0.0.1] - 2022-01-26
 
 - Initial release

data/README.md

@@ -1,28 +1,43 @@
 # UsdaFdc
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/usda_fdc`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/usda_fdc.svg)](https://badge.fury.io/rb/usda_fdc)
 
-TODO: Delete this and the text above, and describe your gem
+A Ruby interface to the USDA [FoodData Central](https://fdc.nal.usda.gov) API.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To install the latest release:
+
+    $ gem install usda_fdc
+
+To include in a Rails project, add it to the Gemfile:
 
 ```ruby
 gem 'usda_fdc'
 ```
 
-And then execute:
+## Usage
 
-    $ bundle install
+An API key is required to access the service. You can find details on how to obtain a key [here](https://fdc.nal.usda.gov/api-guide.html#bkmk-3).
 
-Or install it yourself as:
+Once you have an API key, you're able to make API calls via the client object:
 
-    $ gem install usda_fdc
+```ruby
+client = UsdaFdc::Client.new('your_api_key')
+client.food(534358)
 
-## Usage
+#=> { "dataType" => "Branded", "description" => "NUT 'N BERRY MIX", "fdcId" => 534358, ... }
+```
 
-TODO: Write usage instructions here
+You can also configure the default API key globally for all `UsdaFdc::Client` instances:
+
+```ruby
+UsdaFdc.configure do |config|
+  config.api_key = 'your_api_key'
+end
+```
+
+For more information on interacting with the API, including accepted parameters and response formats, check out the official USDA FDC [API guide](https://fdc.nal.usda.gov/api-guide.html).
 
 ## Development
 
@@ -30,14 +45,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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](https://rubygems.org).
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/usda_fdc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/usda_fdc/blob/master/CODE_OF_CONDUCT.md).
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the UsdaFdc project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/usda_fdc/blob/master/CODE_OF_CONDUCT.md).

data/lib/usda_fdc/client.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require_relative 'helpers/errors'
+
+module UsdaFdc
+  class Client
+    API_URL = 'https://api.nal.usda.gov'
+
+    def initialize(api_key = nil)
+      @api_key = api_key || UsdaFdc.api_key
+      raise UsdaFdc::ArgumentError, 'An API key is required.' if @api_key.nil?
+    end
+
+    def food(fdc_id, params = {}, &block)
+      get("/fdc/v1/food/#{fdc_id}", params, &block)
+    end
+
+    def foods(body = {}, &block)
+      post('/fdc/v1/foods', body, &block)
+    end
+
+    def foods_list(body = {}, &block)
+      post('/fdc/v1/foods/list', body, &block)
+    end
+
+    def foods_search(body = {}, &block)
+      post('/fdc/v1/foods/search', body, &block)
+    end
+
+    def get(path, params = {})
+      uri = URI("#{API_URL}#{path}")
+      uri.query = URI.encode_www_form(params) if params.any?
+
+      request = Net::HTTP::Get.new(uri)
+      set_default_headers_for(request)
+
+      yield(request) if block_given?
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+
+      handle_response(response)
+    end
+
+    def post(path, body = {})
+      uri = URI("#{API_URL}#{path}")
+
+      request = Net::HTTP::Post.new(uri)
+      set_default_headers_for(request)
+      request.body = body.to_json
+
+      yield(request) if block_given?
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+
+      handle_response(response)
+    end
+
+    private
+
+    def set_default_headers_for(request)
+      request['X-Api-Key'] = @api_key
+      request['Content-Type'] = 'application/json'
+      request['User-Agent'] = "usda_fdc gem (v#{UsdaFdc::VERSION})"
+    end
+
+    def handle_response(response)
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      when Net::HTTPClientError
+        raise UsdaFdc::ClientError.new(response.message, response.code)
+      when Net::HTTPServerError
+        raise UsdaFdc::ServerError.new(response.message, response.code)
+      else
+        response
+      end
+    end
+  end
+end

data/lib/usda_fdc/configuration.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'helpers/configurable'
+
+module UsdaFdc
+  extend Configurable
+
+  define_setting :api_key
+end

data/lib/usda_fdc/helpers/configurable.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module UsdaFdc
+  module Configurable
+    def configure
+      yield(self)
+    end
+
+    def define_setting(name, default = nil)
+      instance_variable_set("@#{name}", default)
+
+      define_singleton_method("#{name}=") do |value|
+        instance_variable_set("@#{name}", value)
+      end
+
+      define_singleton_method(name) do
+        instance_variable_get("@#{name}")
+      end
+    end
+  end
+end

data/lib/usda_fdc/helpers/errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module UsdaFdc
+  class ArgumentError < ::ArgumentError
+  end
+
+  class ResponseError < StandardError
+    attr_reader :code
+
+    def initialize(message = '', code = nil)
+      @code = code
+      super(message)
+    end
+  end
+
+  # For 4xx responses
+  class ClientError < ResponseError
+  end
+
+  # For 5xx responses
+  class ServerError < ResponseError
+  end
+end

data/lib/usda_fdc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UsdaFdc
-  VERSION = '0.0.1'
+  VERSION = '0.2.0'
 end

data/lib/usda_fdc.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'usda_fdc/version'
+require_relative 'usda_fdc/configuration'
+require_relative 'usda_fdc/client'
 
-module UsdaFdc
-end
+module UsdaFdc; end

data/usda_fdc.gemspec

@@ -6,7 +6,6 @@ Gem::Specification.new do |spec|
   spec.name = 'usda_fdc'
   spec.version = UsdaFdc::VERSION
   spec.authors = ['Zoran Pesic']
-  spec.email = ['zspesic@gmail.com']
 
   spec.summary = 'A Ruby interface to the USDA FoodData Central API.'
   spec.homepage = 'https://github.com/zokioki/usda_fdc'

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: usda_fdc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Zoran Pesic
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
-- zspesic@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -24,6 +23,10 @@ files:
 - README.md
 - Rakefile
 - lib/usda_fdc.rb
+- lib/usda_fdc/client.rb
+- lib/usda_fdc/configuration.rb
+- lib/usda_fdc/helpers/configurable.rb
+- lib/usda_fdc/helpers/errors.rb
 - lib/usda_fdc/version.rb
 - sig/usda_fdc.rbs
 - usda_fdc.gemspec