easy-jsonapi 1.0.0 → 1.0.5

data/.rubocop.yml

@@ -0,0 +1,64 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: '3.0.0'
+  SuggestExtensions: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Layout/TrailingWhitespace:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLines:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: false
+
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+easy-jsonapi

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,28 @@
 # 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
+- Updated README files
+
+## 1.0.3 - 2020-03-25
+
+- Updated JSONAPI::Exceptions::HeadersExceptions to allow wildcard matching for Accept header
+
+## 1.0.2 - 2020-03-25
+
+- Updated README and fix READE broken links
+- Reorganization of README files into docs file.
+- Make easy-jsonapi compatible with ruby versions >= 2.5
+- Added wrapper around Oj usage so all raised errors are found in the JSONAPI::Exceptions module
+
 ## 1.0.0 - 2020-03-24
 
 - This is the first release with a version of 1.0.0. All main features supported, but user configurations can be developed to provide greater adherence to the spec and more developer features.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easy-jsonapi (1.0.0)
+    easy-jsonapi (1.0.5)
       oj (~> 3.10)
 
 GEM
@@ -10,23 +10,19 @@ GEM
     ast (2.4.2)
     backport (1.1.2)
     benchmark (0.1.1)
+    codecov (0.5.1)
+      simplecov (>= 0.15, < 0.22)
     diff-lcs (1.4.4)
+    docile (1.3.5)
     e2mmap (0.1.0)
     jaro_winkler (1.5.4)
     kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    license_finder (6.12.0)
-      bundler
-      rubyzip (>= 1, < 3)
-      thor (~> 1.0.1)
-      tomlrb (>= 1.3, < 2.1)
-      with_env (= 1.1.0)
-      xml-simple (~> 1.1.5)
-    mini_portile2 (2.5.0)
-    nokogiri (1.11.2)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.11.2-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.11.2-x86_64-linux)
       racc (~> 1.4)
     oj (3.11.3)
     parallel (1.20.1)
@@ -54,7 +50,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.11.0)
+    rubocop (1.12.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -66,7 +62,12 @@ GEM
     rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
-    rubyzip (2.3.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
     solargraph (0.40.4)
       backport (~> 1.1)
       benchmark
@@ -81,20 +82,18 @@ GEM
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
-    thor (1.0.1)
+    thor (1.1.0)
     tilt (2.0.10)
-    tomlrb (2.0.1)
     unicode-display_width (2.0.0)
-    with_env (1.1.0)
-    xml-simple (1.1.8)
     yard (0.9.26)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
+  codecov (~> 0.4)
   easy-jsonapi!
-  license_finder (~> 6.10)
   rack (~> 2.2)
   rake (~> 13.0)
   redcarpet (~> 3.5)
@@ -103,4 +102,4 @@ DEPENDENCIES
   solargraph (~> 0.39)
 
 BUNDLED WITH
-   2.2.11
+   2.2.15

data/README.md

@@ -5,9 +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)
-<!-- [![Build Status](https://secure.travis-ci.org/jsonapi-rb/jsonapi-parser.svg?branch=master)](http://travis-ci.org/jsonapi-rb/parser?branch=master) -->
+![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***!
 
@@ -17,19 +21,19 @@ 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 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
 
-- [*Documentation*](tbd)
+- [*Documentation*](https://rubydoc.info/github/Curatess/easy-jsonapi/production)
 
-- [*RubyGems* *repo*](tbd)
+- [*RubyGems* *Repository*](https://rubygems.org/search?query=easy-jsonapi)
 
 ## Installation
 
-Add this ine to your applications' Gemfile:
+Add this line to your applications' Gemfile:
 
 ```bash
 # Gemfile
@@ -52,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)
@@ -68,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
@@ -84,7 +90,7 @@ $ gem install easy-jsonapi
 
 Add the middleware to the stack in order to activate it.
 
-Sintra:
+Sinatra:
 
 ```ruby
 # app.rb
@@ -118,15 +124,15 @@ 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.
 
 The types of exceptions it will raise are:
 
-- `Oj::ParserError` when an included body is not valid JSON
+- `JSONAPI::Exceptions::JSONParseError` when an included body is not valid JSON
 - `JSONAPI::Exceptions::HeaderExceptions::InvalidHeader` when an included header is non-compliant
 - `JSONAPI::Exceptions::QueryParamExceptions::InvalidQueryParam` when an included query parameter is non-compliant
 - `JSONAPI::Exceptions::DocumentExceptions::InvalidDocument` when the body is included and non-compliant
@@ -135,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/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
 
@@ -167,7 +173,7 @@ require 'easy/jsonapi'
 jsonapi_req = JSONAPI::Parser.parse_request(env)
 ```
 
-This returns a `JSONAPI::Request` object that can be used to access the collection of query params, collection of headers, and the body of the request. To see example usage, see [Using the Request Object](https://github.com/Curatess/easy-jsonapi/UsingTheRequestObject.md).
+This returns a `JSONAPI::Request` object that can be used to access the collection of query params, collection of headers, and the body of the request. To see example usage, see [Using the Request Object](https://github.com/Curatess/easy-jsonapi/blob/production/docs/UsingTheRequestObject.md).
 
 ## Using the Serialized Response Validator
 
@@ -190,11 +196,15 @@ end
 The `headers` param is a hash of `String => String` or `Symbol => String` of the header keys and values.
 The `body` param is either the JSON body or a ruby hash representation of the body.
 
-See the [rubydocs](tbd) for more on the Serialized Response Validator.
+See the [rubydocs](https://rubydoc.info/github/Curatess/easy-jsonapi/proudction) for more on the Serialized Response Validator.
+
+## Acknowledgements
+
+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
 
-See [{file:CHANGELOG.md}](https://github.com/Curatess/easy-jsonapi/CHANGELOG.md)
+See [{file:CHANGELOG.md}](https://github.com/Curatess/easy-jsonapi/blob/production/CHANGELOG.md).
 
 ## License
 
@@ -202,8 +212,8 @@ See [{file:CHANGELOG.md}](https://github.com/Curatess/easy-jsonapi/CHANGELOG.md)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Curatess/easy-jsonapi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Curatess/easy-jsonapi/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome [here on Github](https://github.com/Curatess/easy-jsonapi). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Code of Conduct](https://github.com/Curatess/easy-jsonapi/blob/production/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
-Everyone interacting in the easy-jsonapi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Curatess/easy-jsonapi/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the easy-jsonapi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [Code of Conduct](https://github.com/Curatess/easy-jsonapi/blob/production/CODE_OF_CONDUCT.md).

data/{UsingTheRequestObject.md → 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/{UsingUserConfigurations.md → 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,14 +2,14 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'easy-jsonapi'
-  spec.version       = '1.0.0'
+  spec.version       = '1.0.5'
   spec.authors       = ['Joshua DeMoss, Joe Viscomi']
   spec.email         = ['demoss.joshua@gmail.com']
 
   spec.summary       = 'Middleware, Parser, and Validator for JSONAPI requests and serialized resopnses'
   spec.description   = 'Middleware to screen non-JSONAPI-compliant requests, a parser to provide Object Oriented access to requests, and a validator for validating JSONAPI Serialized responses.'
   spec.homepage      = 'https://rubygems.org/gems/easy-jsonapi'
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.metadata["source_code_uri"] = "https://github.com/Curatess/easy-jsonapi"
   spec.metadata["changelog_uri"] = "https://github.com/Curatess/easy-jsonapi/CHANGELOG.mg"
@@ -24,13 +24,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Dev Dependencies
-  spec.add_development_dependency 'license_finder', '~> 6.10'
   spec.add_development_dependency 'rack', '~> 2.2'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'redcarpet', '~> 3.5'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rubocop', '~> 1.11'
   spec.add_development_dependency 'solargraph', '~> 0.39'
+  spec.add_development_dependency 'codecov', '~> 0.4'
 
   # Dependencies
   spec.add_dependency 'oj', '~> 3.10'

data/lib/easy/jsonapi/config_manager/config.rb

@@ -35,8 +35,8 @@ module JSONAPI
       #   dynamically creates accessor methods for instance variables
       #   created in the initialize
       def method_missing(method_name, *args, &block)
-        super unless READER_METHODS.include?(method_name.to_s[..-2].to_sym)
-        instance_variable_set("@#{method_name}"[..-2].to_sym, args[0])
+        super unless READER_METHODS.include?(method_name.to_s[0..-2].to_sym)
+        instance_variable_set("@#{method_name}"[0..-2].to_sym, args[0])
         @default = false 
       end
 

data/lib/easy/jsonapi/exceptions.rb

@@ -4,6 +4,8 @@ require 'easy/jsonapi/exceptions/document_exceptions'
 require 'easy/jsonapi/exceptions/headers_exceptions'
 require 'easy/jsonapi/exceptions/naming_exceptions'
 require 'easy/jsonapi/exceptions/query_params_exceptions'
+require 'easy/jsonapi/exceptions/user_defined_exceptions'
+require 'easy/jsonapi/exceptions/json_parse_error'
 
 module JSONAPI
   # Namespace for the gem's Exceptions
@@ -23,5 +25,9 @@ module JSONAPI
     # Checking for JSONAPI naming rules compliance
     module NamingExceptions
     end
+
+    # Checking for User Defined Exceptions
+    module UserDefinedExceptions
+    end
   end
 end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'easy/jsonapi/parser/json_parser'
 require 'easy/jsonapi/exceptions/naming_exceptions'
 require 'easy/jsonapi/exceptions/user_defined_exceptions'
 
@@ -57,7 +58,7 @@ module JSONAPI
       # @param opts [Hash] Includes path, http_method, sparse_fieldsets
       # @raise InvalidDocument if any part of the spec is not observed
       def self.check_compliance(document, config_manager = nil, opts = {})
-        document = Oj.load(document, symbol_keys: true) if document.is_a? String
+        document = JSONAPI::Parser::JSONParser.parse(document) if document.is_a? String
         ensure!(!document.nil?, 'A document cannot be nil')
         
         check_essentials(document, opts[:http_method])

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
@@ -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
@@ -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,16 +127,10 @@ 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|
-            if mt == 'application/vnd.api+json'
+            if JSONAPI_MEDIA_TYPES.include? mt
               return true
             end
           end