open_fda_api 0.0.9 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adc99f4c0266329d56ee1cbc6592789908b09a98580136813e3d8033e33c2328
-  data.tar.gz: 6fc8dc376b266e216e5f263248cbae5342c655a50ba3aa1c9d37245a6b521bdf
+  metadata.gz: 3f55d1b8140f12ed25ecf99fd227e0c053a50455abcc2153e03ba7a5f5d724bb
+  data.tar.gz: 74f2219cfd2812e2576e9e748132332f049d9925b5afd763609528f0fa1a049e
 SHA512:
-  metadata.gz: 95da4769cc677e55b92f682bc4b7f05d98543cfcfa05f2d4786c8254e52a6399235e3850a11c7d70ba63dd61ea28e42fda25fc336e8ac1fb3710e9e9a4dc29ca
-  data.tar.gz: f93d3fa2ffc26fad6f9460333326d32f97f51f99dcd567b85ddd62b5ed4e5f868d4aff4bcc8183b37214927e7a03ff4e64fee534c8a98a1c2f5ffc3fe7ee619c
+  metadata.gz: '06953c4682f9bd4948c23a24035094452b85ee73bcb9c3a37f5e16151c39bedb90afab6b11881f73d9106cdf052dcc4d3bb98747b4126409fcbf9fb57eb59082'
+  data.tar.gz: acbddbb9dc475a1243ef8415e411d1c365de227509d3dc7ceddd3221136b96329dea226acad155b4d87269dd754fcf59166ea880f2a053acccfc987b2374dc37

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.0.12] - 2022-01-24
+- Animal & Veterinary Endpoint
+- Tobacco Endpoint
+- Other Endpoint
+
+## [0.0.11] - 2022-01-24
+- Include Food endpoints
+
+## [0.0.10] - 2022-01-24
+- Include Device endpoints
+- Pull out Endpoint common behavior to a base class
+
 ## [0.0.9] - 2022-01-24
 - Filled out the following Drug endpoints:
   - product_labeling

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    open_fda_api (0.0.9)
+    open_fda_api (0.0.12)
       faraday (~> 1.9)
       faraday_middleware (~> 1.2)
 

data/README.md

@@ -31,6 +31,9 @@ args = {
   limit: 20 
 }
 
+# Animal & Veterinary API
+client.animal_and_veterinary.adverse_events(args)
+
 # Drug API
 client.drugs.adverse_events(args)
 client.drugs.product_labeling(args)

data/lib/open_fda_api/animal_and_veterinary.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenFdaApi
+  # Interact with the Animal & Veterinary API Endpoint:
+  #  - Adverse Events
+  class AnimalAndVeterinary < Endpoint
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/animalandveterinary/event/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/animalandveterinary/event/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/animalandveterinary/event/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def adverse_events(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "event.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    private
+
+    def endpoint_path
+      "/animalandveterinary"
+    end
+  end
+end

data/lib/open_fda_api/client.rb

@@ -20,6 +20,26 @@ module OpenFdaApi
       OpenFdaApi::Drugs.new(self)
     end
 
+    def device
+      OpenFdaApi::Device.new(self)
+    end
+
+    def food
+      OpenFdaApi::Food.new(self)
+    end
+
+    def animal_and_veterinary
+      OpenFdaApi::AnimalAndVeterinary.new(self)
+    end
+
+    def tobacco
+      OpenFdaApi::Tobacco.new(self)
+    end
+
+    def other
+      OpenFdaApi::Other.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         conn.request :json

data/lib/open_fda_api/device.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module OpenFdaApi
+  # Interact with the Device API Endpoint:
+  #  - 501(k)
+  #  - Classification
+  #  - Recall Enforcement Reports
+  #  - Adverse Events
+  #  - Pre-market Approval
+  #  - Recalls
+  #  - Registrations and Listings
+  #  - Covid19 Serological Testing Evaluations
+  #  - Unique Device Identifier
+  class Device < Endpoint
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/device/event/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/device/event/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/device/event/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def adverse_events(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "event.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {})
+      make_request(endpoint, query)
+    end
+
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/device/classification/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/device/classification/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/device/classification/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def classification(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "classification.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/device/510k/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/device/510k/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/device/510k/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def premarket_510ks(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "510k.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/device/enforcement/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/device/enforcement/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/device/enforcement/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def recall_enforcement_reports(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "enforcement.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/device/pma/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/device/pma/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/device/pma/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def premarket_approval(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "pma.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/device/recall/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/device/recall/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/device/recall/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def recalls(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "recall.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/device/registrationlisting/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/device/registrationlisting/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/device/registrationlisting/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def registrations_and_listings(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "registrationlisting.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/device/covid19serology/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/device/covid19serology/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/device/covid19serology/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def covid19_serological_tests(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "covid19serology.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/device/udi/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/device/udi/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/device/udi/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def unique_device_identifier(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "udi.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    private
+
+    def endpoint_path
+      "/device"
+    end
+  end
+end

data/lib/open_fda_api/drugs.rb

@@ -1,25 +1,15 @@
 # frozen_string_literal: true
 
-require "net/http"
-require "json"
 require "yaml"
 
 module OpenFdaApi
   # Interact with the Drugs API Endpoint:
-  # - Adverse Events
+  #  - Adverse Events
   #  - Product Labeling
   #  - NDC Directory
   #  - Recall Enforcement Reports
   #  - Drugs@FDA)
-  class Drugs
-    attr_reader :client, :path_base
-
-    def initialize(client)
-      @client = client
-      @host = "api.fda.gov"
-      @path_base = "/drug"
-    end
-
+  class Drugs < Endpoint
     # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/drug/event/searchable-fields/
     # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/drug/event/searchable-fields/
     # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/drug/event/searchable-fields/
@@ -91,21 +81,8 @@ module OpenFdaApi
 
     private
 
-    def build_query(query_input, valid_search_fields)
-      QueryBuilder.new(query_input: query_input, valid_search_fields: valid_search_fields).build_query
-    end
-
-    def build_inputs(search:, sort:, count:, skip:, limit:)
-      QueryInputs.new(search: search, sort: sort, count: count, skip: skip, limit: limit)
-    end
-
-    def make_request(endpoint, query)
-      url = "#{path_base}/#{endpoint}"
-      if query.empty?
-        client.connection.get(url)
-      else
-        client.connection.get(url, query)
-      end.body
+    def endpoint_path
+      "/drug"
     end
   end
 end

data/lib/open_fda_api/endpoint.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OpenFdaApi
+  # Base class for all endpoints to share behavior like building queries and making requests
+  class Endpoint
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def build_query(query_input, valid_search_fields)
+      QueryBuilder.new(query_input: query_input, valid_search_fields: valid_search_fields).build_query
+    end
+
+    def build_inputs(search:, sort:, count:, skip:, limit:)
+      QueryInputs.new(search: search, sort: sort, count: count, skip: skip, limit: limit)
+    end
+
+    def make_request(endpoint, query)
+      url = "#{endpoint_path}/#{endpoint}"
+      if query.empty?
+        client.connection.get(url)
+      else
+        client.connection.get(url, query)
+      end.body
+    end
+  end
+end

data/lib/open_fda_api/food.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenFdaApi
+  # Interact with the Food API Endpoint:
+  #  - Adverse Events
+  #  - Recall Enforcement Reports
+  class Food < Endpoint
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/food/enforcement/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/food/enforcement/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/food/enforcement/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def adverse_events(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "event.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/food/enforcement/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/food/enforcement/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/food/enforcement/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def recall_enforcement_reports(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "enforcement.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    private
+
+    def endpoint_path
+      "/food"
+    end
+  end
+end

data/lib/open_fda_api/other.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenFdaApi
+  # Interact with the Other API Endpoint:
+  #  - NSDE
+  #  - Substance Data Reports
+  class Other < Endpoint
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/other/nsde/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/other/nsde/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/other/nsde/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def nsde(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "nsde.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/other/substance/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/other/substance/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/other/substance/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def substance_data_reports(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "substance.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    private
+
+    def endpoint_path
+      "/other"
+    end
+  end
+end

data/lib/open_fda_api/tobacco.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenFdaApi
+  # Interact with the Tobacco API Endpoint:
+  #  - Problem Reports
+  class Tobacco < Endpoint
+    # @param search [Array<Hash>] Search fields defined in https://open.fda.gov/apis/tobacco/problem/searchable-fields/
+    # @param sort   [Array<Hash>] Sort fields defined in https://open.fda.gov/apis/tobacco/problem/searchable-fields/
+    # @param count  [Array<Hash>] Count fields defined https://open.fda.gov/apis/tobacco/problem/searchable-fields/
+    # @param skip   [Integer]     Number of results to skip
+    # @param limit  [Integer]     Number of results to return
+    # @return Response from the API parsed as JSON
+    def problem_reports(search: [], sort: [], count: [], skip: 0, limit: 1)
+      endpoint = "problem.json"
+      inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      query    = build_query(inputs, {}) # TODO: Upload valid fields
+      make_request(endpoint, query)
+    end
+
+    private
+
+    def endpoint_path
+      "/tobacco"
+    end
+  end
+end

data/lib/open_fda_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenFdaApi
-  VERSION = "0.0.9"
+  VERSION = "0.0.12"
 end

data/lib/open_fda_api.rb

@@ -7,7 +7,13 @@ module OpenFdaApi
   class Error < StandardError; end
 
   autoload :Client, "open_fda_api/client"
-  autoload :Drugs,  "open_fda_api/drugs"
+  autoload :Endpoint, "open_fda_api/endpoint"
+  autoload :AnimalAndVeterinary, "open_fda_api/animal_and_veterinary"
+  autoload :Drugs, "open_fda_api/drugs"
+  autoload :Device, "open_fda_api/device"
+  autoload :Food, "open_fda_api/food"
+  autoload :Other, "open_fda_api/other"
+  autoload :Tobacco, "open_fda_api/tobacco"
   autoload :QueryInputs, "open_fda_api/query_inputs"
   autoload :QueryBuilder, "open_fda_api/query_builder"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_fda_api
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.12
 platform: ruby
 authors:
 - Hebron George
@@ -74,10 +74,16 @@ files:
 - bin/setup
 - lib/open_fda_api.rb
 - lib/open_fda_api/adverse_events_fields.yml
+- lib/open_fda_api/animal_and_veterinary.rb
 - lib/open_fda_api/client.rb
+- lib/open_fda_api/device.rb
 - lib/open_fda_api/drugs.rb
+- lib/open_fda_api/endpoint.rb
+- lib/open_fda_api/food.rb
+- lib/open_fda_api/other.rb
 - lib/open_fda_api/query_builder.rb
 - lib/open_fda_api/query_inputs.rb
+- lib/open_fda_api/tobacco.rb
 - lib/open_fda_api/version.rb
 - open_fda_api.gemspec
 homepage: https://github.com/hebron-george/open_fda_api