open_fda_api 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f55d1b8140f12ed25ecf99fd227e0c053a50455abcc2153e03ba7a5f5d724bb
-  data.tar.gz: 74f2219cfd2812e2576e9e748132332f049d9925b5afd763609528f0fa1a049e
+  metadata.gz: ea876aa2b2ba1588293e37e59f95271ec0361215a5fa68ce1cbfb447eba764d0
+  data.tar.gz: 1c19caa9c5e140dcefa5cbeee8acaa1fd1c48d6553b36f55b86505664ef10301
 SHA512:
-  metadata.gz: '06953c4682f9bd4948c23a24035094452b85ee73bcb9c3a37f5e16151c39bedb90afab6b11881f73d9106cdf052dcc4d3bb98747b4126409fcbf9fb57eb59082'
-  data.tar.gz: acbddbb9dc475a1243ef8415e411d1c365de227509d3dc7ceddd3221136b96329dea226acad155b4d87269dd754fcf59166ea880f2a053acccfc987b2374dc37
+  metadata.gz: 73786ceb0a046b754ad438c67393f3c7baa5c8205266d21df276be6e69ba06bbd5ed94488941364347bbccf0e69ca93874f7db1ad7f1c2bb942a5ae81798413c
+  data.tar.gz: 2f5b335ae39a62f77d72e436caf06a9b7304e02c3c0c81057a082ceb416ad2dff936003c98b7ac36c57fef47a3d64c58b6c4c215c0cbf7acc2ad6e2ecf33798c

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-## [Unreleased]
+## openFDA API
+
+## [0.0.13] - 2022-01-27
+- Set API key if it is available and send it in with every request
 
 ## [0.0.12] - 2022-01-24
 - Animal & Veterinary Endpoint

data/README.md

@@ -19,7 +19,9 @@ bundle install
 ## Usage
 
 ```ruby
-client = OpenFdaApi.client
+client = OpenFdaApi::Client.new
+# or if you have registered an API key
+client = OpenFdaApi::Client.new(api_key: ENV['OPEN_FDA_API_KEY'])
 
 # First 20 results where (fieldA=foo AND fieldB=bar) OR (fieldC=baz AND fieldA exists)
 # Sorted by (fieldD) in descending order
@@ -42,7 +44,7 @@ client.drugs.recall_enforcement_reports(args)
 client.drugs.drugs_at_fda(args)
 
 # Device API
-client.device.premarket_501ks(args)
+client.device.premarket_510ks(args)
 client.device.classification(args)
 client.device.recall_enforcement_reports(args)
 client.device.adverse_events(args)
@@ -72,9 +74,35 @@ The openFDA API can be queried with these arguments: `search`, `sort`, `count`,
 that are ANDed together and all the elements in the array are ORed together. Here are some examples to illustrate:
 
 ```ruby
-search = [{"patient.drug.openfda.pharm_class_epc" => "nonsteroidal+anti-inflammatory+drug" }]
+# Default arguments
+args = {
+  search: [],
+  sort:   [],
+  count:  [],
+  skip:   0,
+  limit:  1,
+}
+
+# Search for a single field
+args = {
+  search: [{ fieldA: "value" }]
+}
+
+# Search for field A AND field B
+args = {
+  search: [{ fieldA: "value", fieldB: "other value" }]
+}
+
+# Search for field A OR field B
+args = {
+  search: [{ fieldA: "value"}, { fieldB: "other value" }]
+}
 
-# patient.drug.openfda.pharm_class_epc:"nonsteroidal+anti-inflammatory+drug"&count=patient.reaction.reactionmeddrapt.exact
+# Search for field A or field B, and skip the first 10 results
+args = {
+  search: [{ fieldA: "value"}, { fieldB: "other value" }],
+  skip: 10
+}
 ```
 
 ## Development

data/lib/open_fda_api/endpoint.rb

@@ -14,7 +14,7 @@ module OpenFdaApi
     end
 
     def build_inputs(search:, sort:, count:, skip:, limit:)
-      QueryInputs.new(search: search, sort: sort, count: count, skip: skip, limit: limit)
+      QueryInputs.new(search: search, sort: sort, count: count, skip: skip, limit: limit, api_key: client.api_key)
     end
 
     def make_request(endpoint, query)

data/lib/open_fda_api/query_builder.rb

@@ -26,21 +26,23 @@ module OpenFdaApi
   #   is 25000. See Paging if you require paging through larger result sets.
   class QueryBuilder
     # @param [Hash] valid_search_fields
-    # @param [QueryInput] query_input
+    # @param [QueryInputs] query_input
     def initialize(query_input:, valid_search_fields:)
       # TODO: Turn validations back on once we get basic functionality working; need to flex on different field types
       # validate_arguments!(valid_search_fields, query_input: query_input)
       warn "You've passed in a valid_search_fields arg but it isn't being used right now..." if valid_search_fields
-      @search = build_query_string(query_fields: query_input.search)
-      @sort   = build_query_string(query_fields: query_input.sort)
-      @count  = build_query_string(query_fields: query_input.count)
-      @skip   = build_skip_string(query_input.skip)
-      @limit  = query_input.limit
+      @search  = build_query_string(query_fields: query_input.search)
+      @sort    = build_query_string(query_fields: query_input.sort)
+      @count   = build_query_string(query_fields: query_input.count)
+      @skip    = build_skip_string(query_input.skip)
+      @limit   = query_input.limit
+      @api_key = query_input.api_key
     end
 
     # @return [Hash] the query string portion of a request
     def build_query
       {
+        api_key: @api_key,
         search: @search,
         sort: @sort,
         count: @count,

data/lib/open_fda_api/query_inputs.rb

@@ -3,14 +3,15 @@
 module OpenFdaApi
   # Group of inputs to build the query against the API with
   class QueryInputs
-    attr_reader :search, :sort, :count, :skip, :limit
+    attr_reader :search, :sort, :count, :skip, :limit, :api_key
 
     def initialize(**params)
-      @search = params[:search] || []
-      @sort   = params[:sort]   || []
-      @count  = params[:count]  || []
-      @skip   = params[:skip]   || 0
-      @limit  = params[:limit]  || nil
+      @search  = params[:search]  || []
+      @sort    = params[:sort]    || []
+      @count   = params[:count]   || []
+      @skip    = params[:skip]    || 0
+      @limit   = params[:limit]   || nil
+      @api_key = params[:api_key] || nil
     end
   end
 end

data/lib/open_fda_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_fda_api
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Hebron George
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday