easy-jsonapi 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dbdd582dac586432d3e4fe1d8391c0ab1df95bc10cfdd5aae9e7e10b08c7aba
-  data.tar.gz: b4df4e547456f7b8e7e5677d77b3dd215bb8901a6da92eb0dcac1ae79b30327d
+  metadata.gz: 0ba6257960cd5fce1e43183afd073ef8effb8de8a7fa2d162eed112948be93e4
+  data.tar.gz: 3f33c8373a9015e27a426a92d64c8939bbe8a7caabc7a2eb190c4a60d04135bf
 SHA512:
-  metadata.gz: 3d3ddd3a04daa40058d1d2e18c59f3b4e345e5a2e077bfcc4fc24e4ff305c0fb0ae409b9f4c694ee6fd6ebb8e84477a4e20c7e994015f50cb771af5e95c57144
-  data.tar.gz: 95e4dbd65c938767ac44a1aa2a9972c6e95e9d94e5e76acf8b027f7feaeb33d0aae4cfefecbdd9dfb01c4a6f7d3e474b10fcfbdd1e9394fa09de606197708c45
+  metadata.gz: 496393be7c0e4f1bd1914c724ddb560e0439d048644c09d73093391a75a837956626c1f9ae077da993875a7ed72dde22abe117ad84be56afb6999a51461b4560
+  data.tar.gz: 5558d5124d369612ac2482d6a1bbb2e2fbf7e0c5b0cec9a5515fcf1bc93c20d2b098d1a016998eab0371730c67ee026381db7d66a15e7e8e97808fd62912d659

data/.github/workflows/codecov.yml

@@ -25,5 +25,6 @@ jobs:
         gem install bundler
         bundler install
         bundle exec rspec
+        bash <(curl -s https://codecov.io/bash)
       env:
         CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}

data/.github/workflows/publish.yml

@@ -53,8 +53,5 @@ jobs:
       with:
         tag_name: ${{ github.ref }}
         release_name: Release ${{ github.ref }}
-        body: |
-          Changes in this Release
-          - Updated JSONAPI::Exceptions::HeadersExceptions to allow wildcard matching for Accept header
         draft: false
         prerelease: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+  - 3.0.0
+before_install:
+- gem install bundler
+- bundler install
+script: bundle exec rake build

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.0.4 - 2020-03-28
+
+- Fixed JSONAPI::ExceptionsHeadersExceptions bug
+- Updated README files
+
 ## 1.0.3 - 2020-03-25
 
 - Updated JSONAPI::Exceptions::HeadersExceptions to allow wildcard matching for Accept header

data/Gemfile.lock

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

data/README.md

@@ -5,11 +5,13 @@
 
 # easy-jsonapi
 
-[![Gem Version](https://badge.fury.io/rb/easy-jsonapi.svg)](https://badge.fury.io/rb/easy-jsonapi)
-![](https://ruby-gem-downloads-badge.herokuapp.com/easy-jsonapi?type=total&color=brightgreen)
-[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
-[![License](https://img.shields.io/github/license/Curatess/easy-jsonapi)](https://img.shields.io)
-[![Build Status](https://img.shields.io/codecov/c/github/curatess/easy-jsonapi)](https://img.shields.io/codecov/c/github/curatess/easy-jsonapi)
+![Gem Version](https://badge.fury.io/rb/easy-jsonapi.svg)
+![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/easy-jsonapi?type=total&color=brightgreen)
+![Build Status](https://img.shields.io/travis/Curatess/easy-jsonapi/production)
+![Code Coverage](https://img.shields.io/codecov/c/github/curatess/easy-jsonapi)
+![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)
+![License](https://img.shields.io/github/license/Curatess/easy-jsonapi)
+
 
 The gem that makes using [JSON:API](https://jsonapi.org/) ***EASY***!
 
@@ -19,9 +21,9 @@ 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 ***500 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 given document, header, or query param restrictions from the user.
+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.
 
 ## Links
 
@@ -54,13 +56,15 @@ $ gem install easy-jsonapi
 
 ## Quick Start
 
-1. Set up the middleware
+***easy-jsonapi's*** 3 main use cases can be used together or separately, so to get started quickly, do any of the 3 below to begin enjoying the convenience of the library.
+
+- Set up the middleware
 
     ```ruby
     use JSONAPI::Middleware
     ```
 
-2. Parse the rack environment variable and get access to request components
+- Parse the rack environment variable and get access to request components (assumes valid JSON:API requests -- use with middleware to ensure valid requests)
 
     ```ruby
     j_req = JSONAPI::Parser.parse_request(env)
@@ -70,7 +74,7 @@ $ gem install easy-jsonapi
     j_req.body.data.type         # => "person"
     ```
 
-3. Validate your serialized JSON:API before returning it to your clients.
+- Validate your serialized JSON:API before returning it to your clients.
 
     ```ruby
     begin
@@ -120,9 +124,9 @@ use JSONAPI::Middleware
 
 ### Functionality
 
-The easy-jsonapi middleware can opperate in development or production mode.
+The easy-jsonapi middleware can operate in development or production mode.
 
-If `ENV['RACK_ENV']` is set to `:development` or not set at all, the middleware will be opperating in development mode.
+If `ENV['RACK_ENV']` is set to `:development` or not set at all, the middleware will be operating in development mode.
 
 When the middleware is in development mode it will raise an exception wherever it finds the http request to be non JSONAPI compliant.
 
@@ -137,7 +141,7 @@ If `ENV['RACK_ENV']` is set to something other than  `:development`, then the mi
 
 ### User Configurations
 
-***easy-jsonapi*** has a fair amount of flexibility when it comes to user configurations and plenty of room for extending the current user configurations to include more features. To see the currently available configurations see [UsingUserConfigurations](https://github.com/Curatess/easy-jsonapi/blob/production/docs/UsingUserConfigurations.md) and to propose a new feature create a pull request or ticket on [the github repository](https://github.com/Curatess/easy-jsonapi)
+***easy-jsonapi*** has a fair amount of flexibility when it comes to user configurations but also plenty of room for to add more features. To see the currently available configurations see [UsingUserConfigurations](https://github.com/Curatess/easy-jsonapi/blob/production/docs/UsingUserConfigurations.md) and to propose a new feature create a pull request or ticket on the [dev repository](https://github.com/Curatess/easy-jsonapi/tree/dev).
 
 ## Using the Request Parser
 
@@ -196,7 +200,7 @@ See the [rubydocs](https://rubydoc.info/github/Curatess/easy-jsonapi/proudction)
 
 ## Acknowledgements
 
-The exception checking strategy for `JSONAPI::Exceptions::DocumentExceptions` and some innitial compliance checks are based off [jsonapi-parser](https://github.com/jsonapi-rb/jsonapi-parser). We would like to thank the [jsonapi-rb](https://github.com/jsonapi-rb) team for the document validation work and to all our contributors and users for the continuous support!
+The exception checking strategy for `JSONAPI::Exceptions::DocumentExceptions` and some initial compliance checks are based off [jsonapi-parser](https://github.com/jsonapi-rb/jsonapi-parser). We would like to thank the [jsonapi-rb](https://github.com/jsonapi-rb) team for the document validation work and to all our contributors and users for the continuous support!
 
 ## Releases
 

data/docs/UsingTheRequestObject.md

@@ -69,6 +69,6 @@ j_req.body.jsonapi # The JSONAPI jsonapi member
 j_req.body.to_s # serialized JSONAPI
 j_req.body.to_h # ruby hash representation of JSONAPI 
 
-# NOTE: j_req.body.data returns a resoure or an array of resources depending on the request
+# NOTE: j_req.body.data returns a resource or an array of resources depending on the request
 j_req.body.data # JSONAPI::Document::Resource or [JSONAPI::Document::Resource]
 ```

data/docs/UsingUserConfigurations.md

@@ -17,7 +17,7 @@ use JSONAPI::Middleware do |config_manager|
 end
 ```
 
-To add restrictions to ALL requests use default global config included with the Config Manager:
+To add restrictions to ALL requests use the default global config included with the Config Manager:
 
 ```ruby
 use JSONAPI::Middleware do |config_manager|

data/easy-jsonapi.gemspec

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

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

@@ -25,9 +25,9 @@ module JSONAPI
 
       # Check http verb vs included headers
       # @param env [Hash] The rack environment variable
-      def self.check_request(env, config_manager = nil, opts = {})
+      def self.check_request(env, body, config_manager = nil, opts = {})
         check_compliance(env, config_manager, opts)
-        check_http_method_against_headers(env)
+        check_http_method_against_headers(env, body)
       end
 
       # Check jsonapi compliance
@@ -78,30 +78,30 @@ module JSONAPI
         #   error if the combination doesn't make sense
         # @param (see #compliant?)
         # @raise InvalidHeader the invalid header incombination with the http verb
-        def check_http_method_against_headers(env)
+        def check_http_method_against_headers(env, body)
           case env['REQUEST_METHOD']
           when 'GET'
-            check_get_against_hdrs(env)
+            check_get_against_hdrs(env, body)
           when 'POST' || 'PATCH' || 'PUT'
-            check_post_against_hdrs(env)
+            check_post_against_hdrs(env, body)
           when 'DELETE'
-            check_delete_against_hdrs(env)
+            check_delete_against_hdrs(env, body)
           end
         end
 
         # Raise error if a GET request has a body or a content type header
         # @param (see #compliant?)
-        def check_get_against_hdrs(env)
-          raise_error('GET requests cannot have a body.') unless env['rack.input'].nil?
+        def check_get_against_hdrs(env, body)
+          raise_error('GET requests cannot have a body.') unless body == ""
           raise_error("GET request cannot have a 'CONTENT_TYPE' http header.") unless env['CONTENT_TYPE'].nil?
         end
 
         # POST, PUT, and PATCH request must have a content type header,
         #   a body, and a content-type and accept header that accepts jsonapi
         # @param (see #compliant?)
-        def check_post_against_hdrs(env)
+        def check_post_against_hdrs(env, body)
           raise_error("POST, PUT, and PATCH requests must have a 'CONTENT_TYPE' header.") unless env['CONTENT_TYPE']
-          raise_error('POST, PUT, and PATCH requests must have a body.') unless env['rack.input']
+          raise_error('POST, PUT, and PATCH requests must have a body.') if body == ""
           
           return if env['CONTENT_TYPE'] == 'application/vnd.api+json' && accepts_jsonapi?(env)
           
@@ -109,6 +109,12 @@ module JSONAPI
                       "JSON:API media type, if they include a JSON:API 'CONTENT_TYPE' header")
         end
 
+        # Raise error if DELETE hdr has a body or a content type header
+        def check_delete_against_hdrs(env, body)
+          raise_error('DELETE requests cannot have a body.') unless body == ""
+          raise_error("DELETE request cannot have a 'CONTENT_TYPE' http header.") unless env['CONTENT_TYPE'].nil?
+        end
+        
         # Check the accept header to see if any of the provided media types indicate that
         #   jsonapi is accepted
         # @param (see #compliant?)
@@ -121,12 +127,6 @@ module JSONAPI
           false
         end
 
-        # Raise error if DELETE hdr has a body or a content type header
-        def check_delete_against_hdrs(env)
-          raise_error('DELETE requests cannot have a body.') unless env['rack.input'].nil?
-          raise_error("DELETE request cannot have a 'CONTENT_TYPE' http header.") unless env['CONTENT_TYPE'].nil?
-        end
-
         # @param accept_hdr [String] The value of the http accept header
         def contains_at_least_one_jsonapi_media_type_without_params?(accept_hdr)
           accept_hdr.split(',').each do |mt|

data/lib/easy/jsonapi/middleware.rb

@@ -88,9 +88,12 @@ module JSONAPI
     # @param config_manager [JSONAPI::ConfigManager::Config] The config object to use modify compliance checking
     # @return [NilClass | Array] Nil meaning no error or a 400 level http response
     def check_compliance(env, config_manager)
+      # Store separately so you can rewind for next middleware or app
+      body = env['rack.input'].read
+      env['rack.input'].rewind
       opts = { http_method: env['REQUEST_METHOD'], path: env['PATH_INFO'] }
 
-      header_error = check_headers_compliance(env, config_manager, opts)
+      header_error = check_headers_compliance(env, body, config_manager, opts)
       return header_error unless header_error.nil?
 
       req = Rack::Request.new(env)
@@ -99,15 +102,15 @@ module JSONAPI
       
       return unless env['CONTENT_TYPE']
 
-      body_error = check_req_body_compliance(env, config_manager, opts)
+      body_error = check_req_body_compliance(env, body, config_manager, opts)
       return body_error unless body_error.nil?
     end
 
     # Checks whether the http headers are jsonapi compliant
     # @param (see #call)
     # @return [NilClass | Array] Nil meaning no error or a 400 level http response
-    def check_headers_compliance(env, config_manager, opts)
-      JSONAPI::Exceptions::HeadersExceptions.check_request(env, config_manager, opts)
+    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
       raise if environment_development?(env)
 
@@ -128,10 +131,7 @@ module JSONAPI
     # @param env (see #call)
     # @param req (see #check_query_param_compliance)
     # @raise If the document body is not JSONAPI compliant
-    def check_req_body_compliance(env, config_manager, opts)
-      # Store separately so you can rewind for next middleware or app
-      body = env['rack.input'].read
-      env['rack.input'].rewind
+    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
       raise if environment_development?(env)

data/lib/easy/jsonapi/request/query_param_collection.rb

@@ -8,10 +8,12 @@ module JSONAPI
     # A collection of QueryParam objects 
     class QueryParamCollection < JSONAPI::NameValuePairCollection
 
+      # The special query params defined by the JSON:API specification
+      SPECIAL_QUERY_PARAMS = %i[sorts filters fields page includes].freeze
+
       # @param param_arr [Array<JSONAPI::Request::QueryParamCollection::QueryParam] The
       #   query params to initialize the collection with
       def initialize(param_arr = [])
-        @param_names = []
         super(param_arr, item_type: JSONAPI::Request::QueryParamCollection::QueryParam)
       end
   
@@ -43,8 +45,12 @@ module JSONAPI
       # @param args If any arguments were passed to the method called
       # @param block If a block was passed to the method called
       def method_missing(method_name, *args, &block)
-        super unless include?(method_name)
-        get(method_name)
+        included = include?(method_name)
+        super unless included || SPECIAL_QUERY_PARAMS.include?(method_name)
+        if included
+          return get(method_name)
+        end
+        nil
       end
 
       # Whether or not method missing should be called.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy-jsonapi
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Joshua DeMoss, Joe Viscomi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -140,6 +140,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile