open_fda_api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2a7513c32091c436f4641cf0e32a64b51e0ad8ae1f600579a54526c868ece7c
-  data.tar.gz: 797198f936396fbe4a1610996ab7a58fe2fc744017ed4634c0347f345659ce15
+  metadata.gz: b43a53d3d7cd5c3390f024979ac198ba6ee4d79ac0bd43cdf60caaaebfe230bc
+  data.tar.gz: 7720bc8e73810774e0a88b2b0579b3cfa91d320952d6ab090dac1215c596164e
 SHA512:
-  metadata.gz: 468e135f99f59470fdad06055b1849978f9b95fe40aa4b415a8b9485ecc6a17fa4b18f23a06e233dd108f193e5cf2ef335756e327be8ecf5eebd94fd2b8ccb4a
-  data.tar.gz: 2d42fdf47f92181a0d4ebaaaae6eab84c8d5e868ffec47fd2cfa30b41e66ac036bd2c0bb9cdf40eaf0fc1b5f597ad16921a786c5a883c60561a81f594b989556
+  metadata.gz: c2616cbb3fa9a3c648d6e46084a81e0e5f03e14ab57ca5b08628a3cfb7e16b1fa3b99fddea95d4e1b5ba749e4e946092ccb20b0e5caa6806ba3769a3b95d6839
+  data.tar.gz: 902d27c4d41762a2557f5ac2a6126df84d3b71ffbe7b82a209210bb88b1acc5783e77f35506ec4d4f50758399a8adfb782c110a1f1b022c8eb975d6c2641b9d5

data/CHANGELOG.md

@@ -1,9 +1,12 @@
 ## [Unreleased]
 
+## [0.0.5] - 2022-01-20
+- Validate, against search fields given to us from openFDA API, when building queries.
+
 ## [0.0.4] - 2022-01-19
-- Fix version string in changelog
-- Update Query Builder to group search arguments properly
-- Update Query Builder to replace spaces with pluses in search values as openFDA API documentation requires
+- Fix version string in changelog.
+- Update Query Builder to group search arguments properly.
+- Update Query Builder to replace spaces with pluses in search values as openFDA API documentation requires.
 
 ## [0.0.3] - 2022-01-19
 - Update version again because CHANGELOG wasn't updated along with the 0.0.2 release.

data/Gemfile.lock

@@ -7,10 +7,15 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    coderay (1.1.3)
     diff-lcs (1.5.0)
+    method_source (1.0.0)
     parallel (1.21.0)
     parser (3.1.0.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.2.0)
@@ -47,6 +52,7 @@ PLATFORMS
 
 DEPENDENCIES
   open_fda_api!
+  pry
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)

data/lib/open_fda_api/drugs.rb

@@ -2,6 +2,7 @@
 
 require "net/http"
 require "json"
+require "yaml"
 require "open_fda_api/query_builder"
 
 module OpenFdaApi
@@ -25,19 +26,23 @@ module OpenFdaApi
     # @return Response from the API parsed as JSON
     def adverse_events(search_arguments: [])
       endpoint = "/event.json"
-      query    = build_query(search_arguments)
+      query    = build_query(search_arguments, self.class.valid_adverse_events_fields)
       url      = build_url(endpoint, query)
       make_request(url)
     end
 
+    def self.valid_adverse_events_fields
+      @valid_adverse_events_fields ||= ::YAML.load_file("#{__dir__}/adverse_events_fields.yml")
+    end
+
     private
 
     def build_url(endpoint, query)
       URI::HTTPS.build(host: @host, path: @path_base + endpoint, query: query)
     end
 
-    def build_query(search_arguments)
-      QueryBuilder.new(search: search_arguments).build_query
+    def build_query(search_arguments, valid_search_fields)
+      QueryBuilder.new(search: search_arguments, valid_search_fields: valid_search_fields).build_query
     end
 
     def make_request(url)

data/lib/open_fda_api/query_builder.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module OpenFdaApi
+  class InvalidQueryArgument < ArgumentError; end
+
   # A helper to build queries against the openFDA API
   #
   # The API supports five query parameters. The basic building block of queries is the search parameter.
@@ -24,7 +26,8 @@ module OpenFdaApi
   #   is 25000. See Paging if you require paging through larger result sets.
   class QueryBuilder
     # @param [Array<Hash>] search
-    def initialize(search: [])
+    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)
     end
 
@@ -39,6 +42,25 @@ module OpenFdaApi
 
     private
 
+    def validate_arguments!(valid_search_fields, search:, sort:, count:, skip:)
+      # `search` keys must exist in adverse_events_fields.yml
+      invalid_fields = get_invalid_fields(valid_search_fields: valid_search_fields, fields: search)
+      raise InvalidQueryArgument, "'search' has invalid fields: #{invalid_fields}" if invalid_fields.any?
+
+      # `sort` keys must exist in adverse_events_fields.yml
+      invalid_fields = get_invalid_fields(valid_search_fields: valid_search_fields, fields: sort)
+      raise InvalidQueryArgument, "'sort' has invalid fields: #{invalid_fields}" if invalid_fields.any?
+
+      # `count` keys must exist in adverse_events_fields.yml
+      invalid_fields = get_invalid_fields(valid_search_fields: valid_search_fields, fields: count)
+      raise InvalidQueryArgument, "'count' has invalid fields: #{invalid_fields}" if invalid_fields.any?
+
+      # `count` and `skip` cannot be set at the same time
+      return unless count_and_skip_set?(count, skip)
+
+      raise InvalidQueryArgument, "'count' and 'skip' cannot both be set at the same time!"
+    end
+
     def build_search_string(search)
       return "" if search.empty?
 
@@ -48,5 +70,20 @@ module OpenFdaApi
 
       "search=#{value}"
     end
+
+    def get_invalid_fields(valid_search_fields:, fields:)
+      fields.map(&:keys).flatten.select do |field|
+        if field.include?(".") # nested field (e.g. patient.patientagegroup)
+          dig_values = field.split(".").join(",properties,").split(",")
+          valid_search_fields["properties"].dig(*dig_values).nil?
+        else
+          !valid_search_fields["properties"].keys.include?(field.to_s)
+        end
+      end
+    end
+
+    def count_and_skip_set?(count, skip)
+      skip.positive? && !count.empty?
+    end
   end
 end

data/lib/open_fda_api/version.rb

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

data/open_fda_api.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_development_dependency "pry"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: open_fda_api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Hebron George
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
-dependencies: []
+date: 2022-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - hebrontgeorge@gmail.com