open_fda_api 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b43a53d3d7cd5c3390f024979ac198ba6ee4d79ac0bd43cdf60caaaebfe230bc
-  data.tar.gz: 7720bc8e73810774e0a88b2b0579b3cfa91d320952d6ab090dac1215c596164e
+  metadata.gz: 98cb0c21f6d0b4f002d0e913b36eab334ed077d5db0e34cab62b7fc02d735f79
+  data.tar.gz: b35f1e48a6be0fa33f2695e01223095ca33dff89e5d97d340e768e86fb4690ba
 SHA512:
-  metadata.gz: c2616cbb3fa9a3c648d6e46084a81e0e5f03e14ab57ca5b08628a3cfb7e16b1fa3b99fddea95d4e1b5ba749e4e946092ccb20b0e5caa6806ba3769a3b95d6839
-  data.tar.gz: 902d27c4d41762a2557f5ac2a6126df84d3b71ffbe7b82a209210bb88b1acc5783e77f35506ec4d4f50758399a8adfb782c110a1f1b022c8eb975d6c2641b9d5
+  metadata.gz: 5bbdf5fbd2c3244b6f9952e8caf1734b63c96f4ad4977a276b8fecb3d043ffff1c2f66a5de1afdd477aa8d1dd1caf742634d763d13fd1cfa1bae4cd9c0ded735
+  data.tar.gz: 12ef328cbc3216b3c9643131ca2656c62f91103a062c0ae555c6736a0683dd62dc015b75920db90ca70afe8b19d5d51b21a72cb4afc76fb11dccd575dd6e76b9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    open_fda_api (0.0.4)
+    open_fda_api (0.0.6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -36,14 +36,14 @@ require 'open_fda_api'
 client = OpenFdaApi.client
 drugs_api = client.drugs
 
-arguments = [{"patient.reaction.reactionmeddrapt"=>"fatigue"}, {"occurcountry"=>"ca"}]
-drugs_api.adverse_events(search_arguments: arguments) # => {"meta" => {...}, "results" => [...]}
+search_args = [{"patient.patientweight"=>"50", "occurcountry"=>"ca"}]
+drugs_api.adverse_events(search: search_args, skip: 1) # => {"meta" => {...}, "results" => [...]}
 ```
 
-### Device (Not Implemented Yet)
-### Food (Not Implemented Yet)
-### Other (Not Implemented Yet)
-### Tobacco (Not Implemented Yet)
+#### Device (Not Implemented Yet)
+#### Food (Not Implemented Yet)
+#### Other (Not Implemented Yet)
+#### Tobacco (Not Implemented Yet)
 
 
 

data/lib/open_fda_api/drugs.rb

@@ -22,11 +22,14 @@ module OpenFdaApi
     # FDA Adverse Event Reporting System (FAERS), a database that contains information on
     # adverse event and medication error reports submitted to FDA.
     #
-    # @param search_arguments [Array<Hash>] Search fields defined in https://open.fda.gov/apis/drug/event/searchable-fields/
+    # @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/
+    # @param skip   [Integer]     Number of results to skip
     # @return Response from the API parsed as JSON
-    def adverse_events(search_arguments: [])
+    def adverse_events(search: [], sort: [], count: [], skip: 0)
       endpoint = "/event.json"
-      query    = build_query(search_arguments, self.class.valid_adverse_events_fields)
+      query    = build_query(search, sort, count, skip, self.class.valid_adverse_events_fields)
       url      = build_url(endpoint, query)
       make_request(url)
     end
@@ -41,8 +44,9 @@ module OpenFdaApi
       URI::HTTPS.build(host: @host, path: @path_base + endpoint, query: query)
     end
 
-    def build_query(search_arguments, valid_search_fields)
-      QueryBuilder.new(search: search_arguments, valid_search_fields: valid_search_fields).build_query
+    def build_query(search, sort, count, skip, valid_search_fields)
+      QueryBuilder.new(search: search, sort: sort, count: count, skip: skip,
+                       valid_search_fields: valid_search_fields).build_query
     end
 
     def make_request(url)

data/lib/open_fda_api/query_builder.rb

@@ -25,19 +25,22 @@ module OpenFdaApi
   #   Use in combination with limit to paginate results. Currently, the largest allowed value for the skip parameter
   #   is 25000. See Paging if you require paging through larger result sets.
   class QueryBuilder
+    # @param [Hash] valid_search_fields
     # @param [Array<Hash>] search
+    # @param [Array<Hash>] sort
+    # @param [Array<Hash>] count
+    # @param [Integer] skip
     def initialize(valid_search_fields:, search: [], sort: [], count: [], skip: 0)
       validate_arguments!(valid_search_fields, search: search, sort: sort, count: count, skip: skip)
-      @search = build_search_string(search)
+      @search = build_query_string(query_type: "search", query_fields: search)
+      @sort   = build_query_string(query_type: "sort",   query_fields: sort)
+      @count  = build_query_string(query_type: "count",  query_fields: count)
+      @skip   = build_skip_string(skip)
     end
 
     # @return [String] the query string portion of a request
     def build_query
-      # TODO: We currently just build a very basic search string for simple examples like "search=a:b+AND+c:d",
-      # but it is possible to construct more complex queries and we will need to support that. Sorting, counting,
-      # setting limits, skipping records, pagination, converting spaces, phrase matching, grouping, and using dates and
-      # ranges are examples of more complex queries that can be built.
-      @search
+      [@search, @sort, @count, @skip].reject! { |v| v.nil? || v.empty? }.join("&")
     end
 
     private
@@ -61,17 +64,24 @@ module OpenFdaApi
       raise InvalidQueryArgument, "'count' and 'skip' cannot both be set at the same time!"
     end
 
-    def build_search_string(search)
-      return "" if search.empty?
+    def build_query_string(query_type:, query_fields:)
+      return "" if query_fields.empty?
 
-      value = search.map do |and_args|
+      "#{query_type}=#{build_groupings(query_fields)}"
+    end
+
+    def build_skip_string(skip)
+      skip.positive? ? "skip=#{skip}" : ""
+    end
+
+    def build_groupings(fields)
+      fields.map do |and_args|
         "(#{and_args.map { |k, v| "#{k}:#{v.gsub(" ", "+")}" }.join("+AND+")})"
       end.join("+")
-
-      "search=#{value}"
     end
 
     def get_invalid_fields(valid_search_fields:, fields:)
+      # TODO: valid_search_fields define types and we need to check against those
       fields.map(&:keys).flatten.select do |field|
         if field.include?(".") # nested field (e.g. patient.patientagegroup)
           dig_values = field.split(".").join(",properties,").split(",")

data/lib/open_fda_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_fda_api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Hebron George
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry