request_handler 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b88d675dc64b12fded56d60d939381a1d41fa888e96ea2110a656099fb0f4c8e
-  data.tar.gz: 4884507eced978bb57ebdd46595f7fabfde30b4d71b107c41926f0fb4de447c9
+  metadata.gz: 9cd60a65f2b6671656e48956fe626d577227bca6c2c6ce2b2466253c37280ec8
+  data.tar.gz: f9f1dd6bf0640d85d3b4a8cf866c9858efdaa81a1402dec33e0255f0e66e5d55
 SHA512:
-  metadata.gz: 1c634f7d572ff681fb4e6576ce5a8e86105aa635591c0643eb7a42b8d71a9910d12b0bff33cf49b7b8fcd6be2a340b48491e326b7912e31753079ecada26e4cf
-  data.tar.gz: 6bedbe868de000a1e8981907d8341cfaccf4f028580fc5f9ee10ec4497c69101d1b18618e43cfb59eb5eaaf20fceeed62402a0e1671d7b9ffb1d6587568cad1c
+  metadata.gz: a964f7b554f9e6f93bf35194c8218f5676e44d28478eff33406d1756ca4375da8728908fcd5d7db4d183e0d14d4a2999e57f0124ef0fc082f23b9a8204d84ab8
+  data.tar.gz: 8b7ff0664d168c0a69fd0fec0cf70dca96ca8848e5442b998e97226ba44f066336685ba405c2bfffd4d737ef96b0fffd1ecc9293c18b5f0777bb9a89010529d2

data/.circleci/config.yml

@@ -53,7 +53,7 @@ jobs:
       *common_steps
   ruby-3.0:
     docker:
-      - image: circleci/ruby:3.0
+      - image: circleci/ruby:3.0.3
     steps:
       *common_steps
   jruby-9.3:

data/.rubocop.yml

@@ -1,21 +1,20 @@
+inherit_from: .rubocop_todo.yml
+
 # minitest specifics
+require:
+  - rubocop-rake
+  - rubocop-rspec
+  - rt_rubocop_defaults
+
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.6
   Exclude:
     - Dangerfile
-Metrics/LineLength:
-  Max: 119
-Metrics/MethodLength:
-  Exclude:
-    - test/**/*
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+
 Metrics/ClassLength:
   Exclude:
     - lib/request_handler/base.rb
-Style/ClassAndModuleChildren:
-  Exclude:
-    - test/**/*
-
-Metrics/BlockLength:
-  Enabled: false
-Style/Documentation:
-  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,105 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-02-03 11:33:42 UTC using RuboCop version 1.44.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/request_handler/schema_parser_spec.rb'
+
+# Offense count: 18
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/integration/page_parser_spec.rb'
+    - 'spec/request_handler/base_spec.rb'
+    - 'spec/request_handler/body_parser_spec.rb'
+    - 'spec/request_handler/filter_parser_spec.rb'
+    - 'spec/request_handler/json_api_document_parser_spec.rb'
+    - 'spec/request_handler/multipart_parser_spec.rb'
+    - 'spec/request_handler/query_parser_spec.rb'
+    - 'spec/request_handler/sidecar_parser_spec.rb'
+    - 'spec/request_handler_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/request_handler/schema_parser.rb'
+
+# Offense count: 118
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Enabled: false
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: CustomTransform, IgnoredWords, DisallowedExamples.
+# IgnoredWords: only
+# DisallowedExamples: works
+RSpec/ExampleWording:
+  Exclude:
+    - 'spec/request_handler_spec.rb'
+
+# Offense count: 3
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/request_handler/schema_parser_spec.rb'
+
+# Offense count: 13
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 4
+RSpec/OverwritingSetup:
+  Exclude:
+    - 'spec/request_handler/include_option_parser_spec.rb'
+    - 'spec/request_handler/sort_option_parser_spec.rb'
+
+# Offense count: 2
+RSpec/RepeatedExampleGroupDescription:
+  Exclude:
+    - 'spec/request_handler/sort_option_parser_spec.rb'
+
+# Offense count: 6
+RSpec/StubbedMock:
+  Exclude:
+    - 'spec/request_handler/base_spec.rb'
+    - 'spec/request_handler/body_parser_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/request_handler/base_spec.rb'
+
+# Offense count: 1
+Style/MixinUsage:
+  Exclude:
+    - 'spec/support/helper.rb'
+
+# Offense count: 41
+Style/OpenStructUse:
+  Exclude:
+    - 'lib/request_handler/builder/fieldsets_resource_builder.rb'
+    - 'lib/request_handler/builder/multipart_builder.rb'
+    - 'lib/request_handler/builder/page_builder.rb'
+    - 'lib/request_handler/concerns/config_helper.rb'
+    - 'lib/request_handler/config.rb'
+    - 'spec/integration/fieldsets_parser_spec.rb'
+    - 'spec/integration/header_parser_spec.rb'
+    - 'spec/integration/option_parser_spec.rb'
+    - 'spec/integration/page_parser_spec.rb'
+    - 'spec/integration/schema_parser_spec.rb'
+    - 'spec/request_handler/base_spec.rb'
+    - 'spec/request_handler_spec.rb'

data/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## ## [3.0.0] - 2023-02-07
+### Added
+- JSONAPI data member validation
+
+### Changed
+- Update rubocop to 1.44
+
 ## [2.3.0] - 2022-06-29
 ### Changed
 - Explicitly pass kwargs to support ruby 3.0

data/Gemfile

@@ -1,15 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in dry-request_handler.gemspec
 gemspec
-
-group :development, :test do
-  gem 'danger'
-  gem 'danger-commit_lint'
-  gem 'danger-rubocop'
-  gem 'dry-types', '~> 1.0'
-  gem 'dry-validation', '~> 1.0'
-  gem 'rspec_junit_formatter'
-end

data/Guardfile

@@ -18,8 +18,8 @@
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
 group :red_green_refactor, halt_on_fail: true do
-  guard :rspec, cmd: 'bundle exec rspec', all_after_pass: true do
-    require 'guard/rspec/dsl'
+  guard :rspec, cmd: "bundle exec rspec", all_after_pass: true do
+    require "guard/rspec/dsl"
     dsl = Guard::RSpec::Dsl.new(self)
 
     # Feel free to open issues for suggestions and improvements
@@ -37,11 +37,11 @@ group :red_green_refactor, halt_on_fail: true do
     # Turnip features and steps
     watch(%r{^spec/acceptance/(.+)\.feature$})
     watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
-      Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance'
+      Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
     end
   end
 
-  guard :rubocop, all_on_start: false, cli: ['--auto-correct'] do
+  guard :rubocop, all_on_start: false, cli: ["--auto-correct"] do
     watch(/.+\.rb$/)
     watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
   end

data/Rakefile

@@ -1,22 +1,23 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
+desc "Init repo"
 task :init do
-  Rake::Task['rubocop:install'].execute
+  Rake::Task["rubocop:install"].execute
 end
 
-require 'rubocop/rake_task'
+require "rubocop/rake_task"
 RuboCop::RakeTask.new
 namespace :rubocop do
-  desc 'Install Rubocop as pre-commit hook'
+  desc "Install Rubocop as pre-commit hook"
   task :install do
-    require 'rubocop_runner'
+    require "rubocop_runner"
     RubocopRunner.install
   end
 end
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'request_handler'
+require "bundler/setup"
+require "request_handler"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'request_handler'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start

data/lib/request_handler/base.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'request_handler/filter_parser'
-require 'request_handler/page_parser'
-require 'request_handler/include_option_parser'
-require 'request_handler/sort_option_parser'
-require 'request_handler/header_parser'
-require 'request_handler/body_parser'
-require 'request_handler/multipart_parser'
-require 'request_handler/fieldsets_parser'
-require 'request_handler/query_parser'
-require 'request_handler/helper'
-require 'request_handler/builder/options_builder'
-require 'request_handler/concerns/config_helper'
-require 'request_handler/config'
+require "request_handler/filter_parser"
+require "request_handler/page_parser"
+require "request_handler/include_option_parser"
+require "request_handler/sort_option_parser"
+require "request_handler/header_parser"
+require "request_handler/body_parser"
+require "request_handler/multipart_parser"
+require "request_handler/fieldsets_parser"
+require "request_handler/query_parser"
+require "request_handler/helper"
+require "request_handler/builder/options_builder"
+require "request_handler/concerns/config_helper"
+require "request_handler/config"
 
 module RequestHandler
   class Base
@@ -27,7 +27,8 @@ module RequestHandler
     end
 
     def initialize(request:)
-      raise MissingArgumentError, request: 'is missing' if request.nil?
+      raise MissingArgumentError.new(request: "is missing") if request.nil?
+
       @request = request
     end
 
@@ -38,7 +39,7 @@ module RequestHandler
     def page_params
       @page_params ||= PageParser.new(
         params:      params,
-        page_config: config.lookup!('page')
+        page_config: config.lookup!("page")
       ).run
     end
 
@@ -79,21 +80,21 @@ module RequestHandler
     attr_reader :request
 
     def parse_filter_params
-      defaults = fetch_defaults('filter.defaults', {})
+      defaults = fetch_defaults("filter.defaults", {})
       defaults.merge(FilterParser.new(
         params:                params,
-        schema:                config.lookup!('filter.schema'),
-        additional_url_filter: config.lookup('filter.additional_url_filter'),
-        schema_options:        execute_options(config.lookup('filter.options'))
+        schema:                config.lookup!("filter.schema"),
+        additional_url_filter: config.lookup("filter.additional_url_filter"),
+        schema_options:        execute_options(config.lookup("filter.options"))
       ).run)
     end
 
     def parse_include_params
-      parse_options(type: 'include_options', parser: IncludeOptionParser)
+      parse_options(type: "include_options", parser: IncludeOptionParser)
     end
 
     def parse_sort_params
-      parse_options(type: 'sort_options', parser: SortOptionParser)
+      parse_options(type: "sort_options", parser: SortOptionParser)
     end
 
     def parse_options(type:, parser:)
@@ -115,38 +116,38 @@ module RequestHandler
       return params if config.nil?
 
       params.merge(
-        schema:         config.lookup('headers.schema'),
-        schema_options: execute_options(config.lookup('headers.options'))
+        schema:         config.lookup("headers.schema"),
+        schema_options: execute_options(config.lookup("headers.options"))
       )
     end
 
     def parse_body_params
       BodyParser.new(
-        request:          request,
-        schema:           config.lookup!('body.schema'),
-        schema_options:   execute_options(config.lookup('body.options')),
-        type:             config.lookup('body.type')
+        request:        request,
+        schema:         config.lookup!("body.schema"),
+        schema_options: execute_options(config.lookup("body.options")),
+        type:           config.lookup("body.type")
       ).run
     end
 
     def parse_multipart_params
       MultipartsParser.new(
-        request:           request,
-        multipart_config: config.lookup!('multipart').to_h
+        request:          request,
+        multipart_config: config.lookup!("multipart").to_h
       ).run
     end
 
     def parse_fieldsets_params
       FieldsetsParser.new(params:   params,
-                          allowed:  config.lookup!('fieldsets.allowed'),
-                          required: config.lookup('fieldsets.required') || []).run
+                          allowed:  config.lookup!("fieldsets.allowed"),
+                          required: config.lookup("fieldsets.required") || []).run
     end
 
     def parse_query_params
       QueryParser.new(
         params:         params,
-        schema:         config.lookup!('query.schema'),
-        schema_options: execute_options(config.lookup('query.options'))
+        schema:         config.lookup!("query.schema"),
+        schema_options: execute_options(config.lookup("query.options"))
       ).run
     end
 
@@ -154,25 +155,28 @@ module RequestHandler
       value = config.lookup(key)
       return default if value.nil?
       return value unless value.respond_to?(:call)
+
       value.call(request)
     end
 
     def execute_options(options)
       return {} if options.nil?
       return options unless options.respond_to?(:call)
+
       options.call(self, request)
     end
 
     def params
-      raise MissingArgumentError, params: 'is missing' if request.params.nil?
-      raise ExternalArgumentError, [] unless request.params.is_a?(Hash)
+      raise MissingArgumentError.new(params: "is missing") if request.params.nil?
+      raise ExternalArgumentError.new([]) unless request.params.is_a?(Hash)
+
       @params ||= Helper.deep_transform_keys_in_object(request.params) do |k|
-        k.to_s.gsub('.', separator)
+        k.to_s.gsub(".", separator)
       end
     end
 
     def config
-      self.class.instance_variable_get('@config')
+      self.class.instance_variable_get("@config")
     end
 
     def separator

data/lib/request_handler/body_parser.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require 'request_handler/schema_parser'
-require 'request_handler/error'
-require 'request_handler/document_parser'
+require "request_handler/schema_parser"
+require "request_handler/error"
+require "request_handler/document_parser"
 
 module RequestHandler
   class BodyParser
     def initialize(request:, schema:, type: nil, schema_options: {})
-      raise MissingArgumentError, "request.body": 'is missing' if request.body.nil?
+      raise MissingArgumentError.new("request.body": "is missing") if request.body.nil?
+
       @request = request
       @schema = schema
       @schema_options = schema_options

data/lib/request_handler/builder/base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ostruct'
+require "ostruct"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/body_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
+require "request_handler/builder/base"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/fieldsets_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
-require 'request_handler/builder/fieldsets_resource_builder'
+require "request_handler/builder/base"
+require "request_handler/builder/fieldsets_resource_builder"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/fieldsets_resource_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
+require "request_handler/builder/base"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/filter_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
+require "request_handler/builder/base"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/headers_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
+require "request_handler/builder/base"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/include_options_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
+require "request_handler/builder/base"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/multipart_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
-require 'request_handler/builder/multipart_resource_builder'
+require "request_handler/builder/base"
+require "request_handler/builder/multipart_resource_builder"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/multipart_resource_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
+require "request_handler/builder/base"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/options_builder.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
-require 'request_handler/builder/headers_builder'
-require 'request_handler/builder/page_builder'
-require 'request_handler/builder/include_options_builder'
-require 'request_handler/builder/sort_options_builder'
-require 'request_handler/builder/filter_builder'
-require 'request_handler/builder/query_builder'
-require 'request_handler/builder/body_builder'
-require 'request_handler/builder/multipart_builder'
-require 'request_handler/builder/fieldsets_builder'
+require "request_handler/builder/base"
+require "request_handler/builder/headers_builder"
+require "request_handler/builder/page_builder"
+require "request_handler/builder/include_options_builder"
+require "request_handler/builder/sort_options_builder"
+require "request_handler/builder/filter_builder"
+require "request_handler/builder/query_builder"
+require "request_handler/builder/body_builder"
+require "request_handler/builder/multipart_builder"
+require "request_handler/builder/fieldsets_builder"
 
 module RequestHandler
   module Builder
+    # rubocop:disable Lint/StructNewOverride
     class OptionsBuilder < Base
       Options = Struct.new(:page, :include_options, :sort_options, :filter, :query, :body,
                            :multipart, :fieldsets, :headers)
@@ -93,5 +94,6 @@ module RequestHandler
         Docile.dsl_eval(HeadersBuilder.new, &block).build
       end
     end
+    # rubocop:enable Lint/StructNewOverride
   end
 end

data/lib/request_handler/builder/page_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
-require 'request_handler/builder/page_resource_builder'
+require "request_handler/builder/base"
+require "request_handler/builder/page_resource_builder"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/page_resource_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
+require "request_handler/builder/base"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/query_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
+require "request_handler/builder/base"
 
 module RequestHandler
   module Builder

data/lib/request_handler/builder/sort_options_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'request_handler/builder/base'
+require "request_handler/builder/base"
 
 module RequestHandler
   module Builder

data/lib/request_handler/concerns/config_helper.rb

@@ -4,7 +4,7 @@ module RequestHandler
   module Concerns
     module ConfigHelper
       def lookup!(hash, key)
-        lookup(hash, key) || (raise NoConfigAvailableError, key.to_sym => 'is not configured')
+        lookup(hash, key) || (raise NoConfigAvailableError.new(key.to_sym => "is not configured"))
       end
 
       def lookup(config, key)
@@ -12,7 +12,7 @@ module RequestHandler
       end
 
       def symbolize_key(key)
-        key.split('.').map(&:to_sym)
+        key.split(".").map(&:to_sym)
       end
 
       def deep_to_h(obj)