usda_fdc 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efffc201f528c1a723bc29b4442da66156487f4b208870a026bd1fad23491899
-  data.tar.gz: 2c75291bcd2c6d121aa741c14d8485228fb52e9cf4654f216f3442f1e6717bea
+  metadata.gz: b834a400890953356c7e7a6265bd5f5126724d2a5009295160fc0a9fcabfecf1
+  data.tar.gz: 7d41308bc4ca5d3f1ffaf3be668b9f910f1cde9422727bc5592224776b30ae36
 SHA512:
-  metadata.gz: b10bd1373720d91eb06477ee47abb8b179c8b0c73818f8ba12e5af21c84599d7e8cb1ef85aa67929f6093834e11b34b1c62332180a09b83e42d0d590af1c2db8
-  data.tar.gz: 942c1728a46b7f4a6f8cbc745623f223811bd5a2f81febbd1bfa3c693e5091e17ec9d8433be88c22df7d08b0e0d796ef2b7f2840a183df2d6d4d0d045a34cb4a
+  metadata.gz: b52fc6edacaada7389148783465473e4d73b86089f289ed9208ba99ac8fd3457e7acdb8a42184aa789f9c509d37785c0250c2a0705484814cf20c12835376413
+  data.tar.gz: b59138eb82af2fd0611d8869a63cff8e2f04bb922228ba549b9bb749c5152fa41302fe1fda7b7b9cb8ff1b16b0a3258ee328bd4580efde9306e7f446af406803

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.2.1] - 2022-07-15
+
+- Some internal cleanup
+
+## [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

data/README.md

@@ -1,26 +1,43 @@
 # UsdaFdc
 
+[![Gem Version](https://badge.fury.io/rb/usda_fdc.svg)](https://badge.fury.io/rb/usda_fdc)
+
 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, ... }
+```
+
+You can also configure the default API key globally for all `UsdaFdc::Client` instances:
 
-TBD
+```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
 
@@ -28,10 +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).

data/lib/usda_fdc/client.rb

@@ -1,29 +1,32 @@
 # 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)
+    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 = {})
-      get("/fdc/v1/food/#{fdc_id}", params)
+    def food(fdc_id, params = {}, &block)
+      get("/fdc/v1/food/#{fdc_id}", params, &block)
     end
 
-    def foods(body)
-      post('/fdc/v1/foods', body)
+    def foods(body = {}, &block)
+      post('/fdc/v1/foods', body, &block)
     end
 
-    def foods_list(body)
-      post('/fdc/v1/foods/list', body)
+    def foods_list(body = {}, &block)
+      post('/fdc/v1/foods/list', body, &block)
     end
 
-    def foods_search(body)
-      post('/fdc/v1/foods/search', body)
+    def foods_search(body = {}, &block)
+      post('/fdc/v1/foods/search', body, &block)
     end
 
     def get(path, params = {})
@@ -31,29 +34,52 @@ module UsdaFdc
       uri.query = URI.encode_www_form(params) if params.any?
 
       request = Net::HTTP::Get.new(uri)
-      request['X-Api-Key'] = @api_key
-      request['Content-Type'] = 'application/json'
+      assign_default_headers(request)
+
+      yield(request) if block_given?
 
       response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
         http.request(request)
       end
 
-      JSON.parse(response.body)
+      handle_response(response)
     end
 
     def post(path, body = {})
       uri = URI("#{API_URL}#{path}")
 
       request = Net::HTTP::Post.new(uri)
-      request['X-Api-Key'] = @api_key
-      request['Content-Type'] = 'application/json'
+      assign_default_headers(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
 
-      JSON.parse(response.body)
+      handle_response(response)
+    end
+
+    private
+
+    def assign_default_headers(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/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.1.0'
+  VERSION = '0.2.1'
 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.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Zoran Pesic
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-24 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: []
@@ -27,6 +26,7 @@ files:
 - 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