usda_fdc 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4796ad6e9de7996f19018c9e89c90386b74313d6ea5661877060aa1a71d4db8b
-  data.tar.gz: cbebe212275b3834bf07731efca382a5e9a67b21e7878905f1ff787d125d3aa1
+  metadata.gz: 3259d937f8cab77f84475be7d9cc4871efed34326604ceeb0aa2fb6f3e217546
+  data.tar.gz: 88c52fdab8c2bd8fc4d6492fdc81d594dd477d63c49cac8c77b216a35bd21926
 SHA512:
-  metadata.gz: d14e949edd29832fc9a02d5ed4884b0b9c11e3b8ede97a9eb8ea1f27fe3b0f141cfb1e5a504f1256a828c472415f9cd9dbaa773ba302e6237897d45493d76d12
-  data.tar.gz: 5993a9ef8cdb28c88ec35390970880c08416e897ec93ae955d019381f1aa02ffc679690754c2ae28ca5d05938cc4d98aaacda51b864a0d4e2391b6296ee8d677
+  metadata.gz: b9804c6de9e90e962dafb4cc9184165c85f6f1b9bbf20a8e6551ab45b817319c87266b82b85cc12988bd2d714ba9db192127739d559ab6eb49d968e4cbcb61d6
+  data.tar.gz: 97dcb6d90428858f511c413e59faab3faa14e056377cab0da0ebb96427371d93132507b24b6220c17aba592ac82059ace8d053a648dc7a177cf770b49786c4e3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [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

data/README.md

@@ -1,5 +1,7 @@
 # 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
@@ -27,6 +29,14 @@ client.food(534358)
 #=> { "dataType" => "Branded", "description" => "NUT 'N BERRY MIX", "fdcId" => 534358, ... }
 ```
 
+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

data/lib/usda_fdc/client.rb

@@ -2,29 +2,31 @@
 
 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 = {})
@@ -32,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'
+      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
 
-      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'
+      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
 
-      JSON.parse(response.body)
+      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/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.1'
+  VERSION = '0.2.0'
 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.1
+  version: 0.2.0
 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