easy-jsonapi 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ba6257960cd5fce1e43183afd073ef8effb8de8a7fa2d162eed112948be93e4
-  data.tar.gz: 3f33c8373a9015e27a426a92d64c8939bbe8a7caabc7a2eb190c4a60d04135bf
+  metadata.gz: f07199316723dad3e81762871162c088abf1a0d4a6c5096e2033bace38ab2339
+  data.tar.gz: 58691051c1a6e488155ddc878695a3c186a4c852aedd967f0e914fb5dfe2fa0b
 SHA512:
-  metadata.gz: 496393be7c0e4f1bd1914c724ddb560e0439d048644c09d73093391a75a837956626c1f9ae077da993875a7ed72dde22abe117ad84be56afb6999a51461b4560
-  data.tar.gz: 5558d5124d369612ac2482d6a1bbb2e2fbf7e0c5b0cec9a5515fcf1bc93c20d2b098d1a016998eab0371730c67ee026381db7d66a15e7e8e97808fd62912d659
+  metadata.gz: 6922ea8ef89f1ac9c28943ddb946bc12066268aec49ac402a997367e945388453fb09b3f67c1155c40a622b9df19c62dfa28e95bc087c978c65f7aa7545c4b66
+  data.tar.gz: 99b888ed918f0b783b4bf22a61b76b6b44ac0fffc8b4fc414727a32e5ac621f1573233526a37f1efb54394be7618d52afe7401309c63523018a8d9ee2457b5a3

data/.github/workflows/publish.yml

@@ -51,7 +51,7 @@ jobs:
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
       with:
-        tag_name: ${{ github.ref }}
-        release_name: Release ${{ github.ref }}
+        tag_name: 1.0.5
+        release_name: Release 1.0.5
         draft: false
         prerelease: false

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 1.0.5 - 2020-03-30
+
+- Fixed bug in JSONAPI::Exceptions::HeadersExceptions that didn't check for user required headers requirements
+- Fixed bug in JSONAPI::Exceptions::QueryParamExceptions that didn't check for user required query param requirements
+- Added more tests to the middleware
+- Updated Documentation
+
 ## 1.0.4 - 2020-03-28
 
 - Fixed JSONAPI::ExceptionsHeadersExceptions bug

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy-jsonapi (1.0.4)
+    easy-jsonapi (1.0.5)
       oj (~> 3.10)
 
 GEM

data/README.md

@@ -21,7 +21,7 @@ Ever wanted the benefits of [JSONAPI](https://jsonapi.org/) without the learning
 2. A `parser` to interact with requests in a typical Object-Oriented Fashion, providing convenient and efficient access to headers, query parameters, and document members.
 3. A `validator` to check your serialized responses for [JSONAPI](https://jsonapi.org/) compliance.
 
-With its only gem dependency being [Oj](https://github.com/ohler55/oj), ***easy-jsonapi*** is a lightweight, dependable tool, featuring comprehensive error messages and over ***500 unit tests*** allowing developers to spend less time debugging and more time creating.
+With its only gem dependency being [Oj](https://github.com/ohler55/oj), ***easy-jsonapi*** is a lightweight, dependable tool, featuring comprehensive error messages and over ***525 unit tests*** allowing developers to spend less time debugging and more time creating.
 
 As a bonus, flexible user configurations can be added to the middleware providing custom screening on all requests or individual requests depending on the resource type of the endpoint and the user-defined document, header, or query param restrictions.
 

data/easy-jsonapi.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'easy-jsonapi'
-  spec.version       = '1.0.4'
+  spec.version       = '1.0.5'
   spec.authors       = ['Joshua DeMoss, Joe Viscomi']
   spec.email         = ['demoss.joshua@gmail.com']
 

data/lib/easy/jsonapi/exceptions/headers_exceptions.rb

@@ -39,7 +39,7 @@ module JSONAPI
         hdrs = JSONAPI::Parser::HeadersParser.parse(env)
         usr_opts = { http_method: opts[:http_method], path: opts[:path] }
         err_msg = JSONAPI::Exceptions::UserDefinedExceptions.check_user_header_requirements(hdrs, config_manager, usr_opts)
-        return err_msg unless err_msg.nil?
+        raise err_msg unless err_msg.nil?
       end
 
       class << self

data/lib/easy/jsonapi/exceptions/query_params_exceptions.rb

@@ -33,7 +33,7 @@ module JSONAPI
         end
         
         err_msg = JSONAPI::Exceptions::UserDefinedExceptions.check_user_query_param_requirements(rack_req_params, config_manager, opts)
-        return err_msg unless err_msg.nil?
+        raise err_msg unless err_msg.nil?
 
         nil
       end

data/lib/easy/jsonapi/exceptions/user_defined_exceptions.rb

@@ -62,8 +62,10 @@ module JSONAPI
         #   with underscores instead of dashes.
         # @param config (see #check_user_document_requirements)
         def check_user_header_requirements(headers, config_manager, opts)
-          return if config_manager.nil? || config_manager.default?
+          return if config_manager.nil?
+          
           config = get_config(config_manager, opts[:http_method], opts[:path])
+          return if config.default? && config_manager.size.positive?
 
           err = 
             check_for_required_headers(headers, config.required_headers)
@@ -77,8 +79,10 @@ module JSONAPI
         # @param rack_req_params [Hash]  The hash of the query parameters given by Rack::Request
         # @param config (see #check_user_document_requirements)
         def check_user_query_param_requirements(rack_req_params, config_manager, opts)
-          return if config_manager.nil? || config_manager.default?
+          return if config_manager.nil?
+          
           config = get_config(config_manager, opts[:http_method], opts[:path])
+          return if config.default? && config_manager.size.positive?
 
           err = 
             check_for_required_params(rack_req_params, config.required_query_params)

data/lib/easy/jsonapi/middleware.rb

@@ -111,7 +111,7 @@ module JSONAPI
     # @return [NilClass | Array] Nil meaning no error or a 400 level http response
     def check_headers_compliance(env, body, config_manager, opts)
       JSONAPI::Exceptions::HeadersExceptions.check_request(env, body, config_manager, opts)
-    rescue JSONAPI::Exceptions::HeadersExceptions::InvalidHeader || JSONAPI::Exceptions::UserDefinedExceptions::InvalidHeader => e
+    rescue JSONAPI::Exceptions::HeadersExceptions::InvalidHeader, JSONAPI::Exceptions::UserDefinedExceptions::InvalidHeader => e
       raise if environment_development?(env)
 
       [e.status_code, {}, []]
@@ -122,7 +122,7 @@ module JSONAPI
     # @return [NilClass | Array] Nil meaning no error or a 400 level http response
     def check_query_param_compliance(env, query_params, config_manager, opts)
       JSONAPI::Exceptions::QueryParamsExceptions.check_compliance(query_params, config_manager, opts)
-    rescue JSONAPI::Exceptions::QueryParamsExceptions::InvalidQueryParameter || JSONAPI::Exceptions::UserDefinedExceptions::InvalidQueryParam => e
+    rescue JSONAPI::Exceptions::QueryParamsExceptions::InvalidQueryParameter, JSONAPI::Exceptions::UserDefinedExceptions::InvalidQueryParam => e
       raise if environment_development?(env)
       
       [e.status_code, {}, []]
@@ -133,7 +133,7 @@ module JSONAPI
     # @raise If the document body is not JSONAPI compliant
     def check_req_body_compliance(env, body, config_manager, opts)
       JSONAPI::Exceptions::DocumentExceptions.check_compliance(body, config_manager, opts)
-    rescue JSONAPI::Exceptions::DocumentExceptions::InvalidDocument || JSONAPI::Exceptions::UserDefinedExceptions::InvalidDocument => e
+    rescue JSONAPI::Exceptions::DocumentExceptions::InvalidDocument, JSONAPI::Exceptions::UserDefinedExceptions::InvalidDocument => e
       raise if environment_development?(env)
 
       [e.status_code, {}, []]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy-jsonapi
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Joshua DeMoss, Joe Viscomi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-29 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack