easy-jsonapi 1.0.0 → 1.0.5

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module JSONAPI
+  module Exceptions
+
+    # Error to raise when error found while parsing json
+    class JSONParseError < StandardError
+    end
+  end
+end

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/item.rb

@@ -49,7 +49,7 @@ module JSONAPI
       return super unless is_a? JSONAPI::Item
       return super unless @item.is_a? Hash
       if should_update_var?(method_name)
-        @item[method_name[..-2].to_sym] = args[0]
+        @item[method_name[0..-2].to_sym] = args[0]
       elsif should_get_var?(method_name)
         @item[method_name]
       else
@@ -75,7 +75,7 @@ module JSONAPI
     #   variable.
     # @param (see #method_missing)
     def should_update_var?(method_name)
-      method_name.to_s[-1] == '=' && @item[method_name[..-2].to_sym].nil? == false
+      method_name.to_s[-1] == '=' && @item[method_name[0..-2].to_sym].nil? == false
     end
     
     # Checks to see if the method has the same name as an existing instance

data/lib/easy/jsonapi/middleware.rb

@@ -2,7 +2,7 @@
 
 require 'easy/jsonapi/exceptions'
 require 'easy/jsonapi/config_manager'
-require 'oj'
+require 'easy/jsonapi/parser/json_parser'
 
 module JSONAPI
 
@@ -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,16 +102,16 @@ 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)
-    rescue JSONAPI::Exceptions::HeadersExceptions::InvalidHeader || JSONAPI::Exceptions::UserDefinedExceptions::InvalidHeader => e
+    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)
 
       [e.status_code, {}, []]
@@ -119,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, {}, []]
@@ -128,16 +131,13 @@ 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
+    rescue JSONAPI::Exceptions::DocumentExceptions::InvalidDocument, JSONAPI::Exceptions::UserDefinedExceptions::InvalidDocument => e
       raise if environment_development?(env)
 
       [e.status_code, {}, []]
-    rescue Oj::ParseError
+    rescue JSONAPI::Exceptions::JSONParseError
       raise if environment_development?(env)
 
       [400, {}, []]

data/lib/easy/jsonapi/parser/document_parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'easy/jsonapi/document'
-require 'oj'
+require 'easy/jsonapi/parser/json_parser'
 
 module JSONAPI
   module Parser
@@ -16,7 +16,7 @@ module JSONAPI
       # @raise [JSONAPI::Parser::InvalidDocument] if document is invalid.
       def self.parse(req_body)
         return if req_body.nil?
-        document_hash = Oj.load(req_body, symbol_keys: true) # parse json string into hash
+        document_hash = JSONAPI::Parser::JSONParser.parse(req_body) # parse json string into hash
         parse_hash(document_hash)
       end
 

data/lib/easy/jsonapi/parser/headers_parser.rb

@@ -20,7 +20,7 @@ module JSONAPI
         h_collection = JSONAPI::HeaderCollection.new
         env.each_key do |k|
           if k.start_with?('HTTP_') && (k != 'HTTP_VERSION')
-            h_collection << JSONAPI::HeaderCollection::Header.new(k[5..], env[k])
+            h_collection << JSONAPI::HeaderCollection::Header.new(k[5..-1], env[k])
           elsif k == 'CONTENT_TYPE'
             h_collection << JSONAPI::HeaderCollection::Header.new(k, env[k])
           end

data/lib/easy/jsonapi/parser/json_parser.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'oj'
+require 'easy/jsonapi/exceptions/json_parse_error'
+
+module JSONAPI
+  module Parser
+    # A wrapper class for OJ parser
+    module JSONParser
+
+      # Parse JSON string into a ruby hash
+      # @param document [String] The JSON string to parse
+      # @raise [JSONAPI::Exceptions::JSONParseError]
+      def self.parse(document, symbol_keys: true)
+        Oj.load(document, symbol_keys: symbol_keys)
+        
+      rescue Oj::ParseError => e
+        raise JSONAPI::Exceptions::JSONParseError, e.message
+      end
+
+      # Convert ruby hash into JSON
+      # @param ruby_hash [Hash] THe hash to convert into JSON
+      def self.dump(ruby_hash)
+        Oj.dump(ruby_hash)
+      end
+
+    end
+  end
+end

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.

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

@@ -82,7 +82,7 @@ module JSONAPI
             add_member(loc_in_h, res_name, included: true)
           else
             add_member(loc_in_h, res_name, included: res_included?(i_arr))
-            store_include(loc_in_h[res_name][:relationships], i_arr[2..])
+            store_include(loc_in_h[res_name][:relationships], i_arr[2..-1])
           end
         end
 

data/lib/easy/jsonapi/utility.rb

@@ -151,7 +151,7 @@ module JSONAPI
       def all_hash_path?(hash, args)
         return false if (args.size.positive? && !hash.is_a?(Hash)) || hash.nil?
         return true if args.size.zero? && !hash.nil?
-        all_hash_path?(hash[args.first], args[1..])
+        all_hash_path?(hash[args.first], args[1..-1])
       end
     end
   end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: easy-jsonapi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - Joshua DeMoss, Joe Viscomi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: license_finder
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.10'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.39'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -131,10 +131,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/publish-gem.yml"
-- ".github/workflows/rake.yml"
+- ".dockerignore"
+- ".github/workflows/codecov.yml"
+- ".github/workflows/publish.yml"
+- ".gitignore"
 - ".rspec"
+- ".rspec_status"
+- ".rubocop.yml"
+- ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -142,8 +148,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- UsingTheRequestObject.md
-- UsingUserConfigurations.md
 - bin/bundle
 - bin/console
 - bin/htmldiff
@@ -170,6 +174,8 @@ files:
 - bin/yard
 - bin/yardoc
 - bin/yri
+- docs/UsingTheRequestObject.md
+- docs/UsingUserConfigurations.md
 - easy-jsonapi.gemspec
 - lib/easy/jsonapi.rb
 - lib/easy/jsonapi/collection.rb
@@ -193,6 +199,7 @@ files:
 - lib/easy/jsonapi/exceptions.rb
 - lib/easy/jsonapi/exceptions/document_exceptions.rb
 - lib/easy/jsonapi/exceptions/headers_exceptions.rb
+- lib/easy/jsonapi/exceptions/json_parse_error.rb
 - lib/easy/jsonapi/exceptions/naming_exceptions.rb
 - lib/easy/jsonapi/exceptions/query_params_exceptions.rb
 - lib/easy/jsonapi/exceptions/user_defined_exceptions.rb
@@ -206,6 +213,7 @@ files:
 - lib/easy/jsonapi/parser.rb
 - lib/easy/jsonapi/parser/document_parser.rb
 - lib/easy/jsonapi/parser/headers_parser.rb
+- lib/easy/jsonapi/parser/json_parser.rb
 - lib/easy/jsonapi/parser/rack_req_params_parser.rb
 - lib/easy/jsonapi/request.rb
 - lib/easy/jsonapi/request/query_param_collection.rb
@@ -234,7 +242,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/rake.yml

@@ -1,35 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.7', '3.0']
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake