drillbit 2.11.0 → 3.0.0

data/lib/drillbit/errors/invalid_api_request.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'erratum'
 
 module  Drillbit

data/lib/drillbit/errors/invalid_request_body.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'erratum'
 
 module  Drillbit

data/lib/drillbit/errors/invalid_subdomain.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'erratum'
 
 module  Drillbit

data/lib/drillbit/errors/invalid_token.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'erratum'
 
 module  Drillbit

data/lib/drillbit/errors/unpermitted_inclusions.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'erratum'
 
 module  Drillbit

data/lib/drillbit/matchers/accept_header.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/matchers/generic'
 
 module  Drillbit

data/lib/drillbit/matchers/generic.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
+
 require 'drillbit/requests/base'
 
 module  Drillbit
 module  Matchers
 module  Generic
-  attr_accessor :application,
-                :accept_header,
-                :request
+  attr_accessor :request
+  attr_writer   :application,
+                :accept_header
 
   def initialize(**args)
     args.each do |variable, value|

data/lib/drillbit/matchers/subdomain.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
+
 module  Drillbit
 module  Matchers
 class   Subdomain
+  attr_accessor :allowed_api_subdomains,
+                :allowed_subdomains,
+                :request
+
   def initialize(allowed_subdomains:     Drillbit.configuration.allowed_subdomains,
                  allowed_api_subdomains: Drillbit.configuration.allowed_api_subdomains)
 
@@ -20,12 +25,6 @@ class   Subdomain
 
     allowed_api_subdomains.include? request.subdomain
   end
-
-  protected
-
-  attr_accessor :allowed_subdomains,
-                :allowed_api_subdomains,
-                :request
 end
 end
 end

data/lib/drillbit/matchers/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/configuration'
 require 'drillbit/matchers/generic'
 
@@ -7,8 +8,8 @@ module  Matchers
 class   Version
   include Generic
 
-  attr_accessor :version_constraint,
-                :default_version
+  attr_accessor :version_constraint
+  attr_writer   :default_version
 
   def matches?(request)
     super

data/lib/drillbit/middleware/api_request_validator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/configuration'
 require 'drillbit/matchers/subdomain'
 require 'drillbit/matchers/accept_header'
@@ -27,9 +28,9 @@ class   ApiRequestValidator
     return Responses::InvalidApiRequest.call(env) if     subdomain_matcher.matches_api_subdomain?(request) &&
                                                          !accept_header_matcher.matches?(request)
 
-    env['CONTENT_TYPE'] = env['CONTENT_TYPE'].
-                          to_s.
-                          gsub(JSON_API_MIME_TYPE_PATTERN, 'application/json')
+    env['CONTENT_TYPE'] = env['CONTENT_TYPE']
+                            .to_s
+                            .gsub(JSON_API_MIME_TYPE_PATTERN, 'application/json')
 
     @app.call(env)
   end

data/lib/drillbit/middleware/parameter_parser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'json'
 require 'stringio'
 require 'drillbit/responses/invalid_request_body'

data/lib/drillbit/middleware/token_processor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/requests/base'
 require 'drillbit/responses/invalid_token'
 

data/lib/drillbit/parameters/filter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module  Drillbit
 class   Parameters
 class   Filter
@@ -29,9 +30,9 @@ class   Filter
 
   def compacted_parameters
     @compacted_parameters ||= raw_parameters.reject do |name, value|
-                                name == 'query' ||
-                                value == '' ||
-                                value.nil?
+      name == 'query' ||
+      value == '' ||
+      value.nil?
     end
   end
 
@@ -39,20 +40,20 @@ class   Filter
   def format_value(value)
     return value unless value.is_a?(String)
 
-    if range_points = value.match(DATE_RANGE)
+    if range_points  = value.match(DATE_RANGE)
       exclusive      = value.include? '...'
       starting_point = Time.iso8601(range_points[1])
       ending_point   = Time.iso8601(range_points[2])
 
       Range.new(starting_point, ending_point, exclusive)
     elsif range_points = value.match(NUMERICAL_RANGE)
-      exclusive      = value.include? '...'
-      starting_point = range_points[1].to_f
-      ending_point   = if range_points[2] == 'Infinity'
-                         9_999_999
-                       else
-                         range_points[2].to_f
-                       end
+      exclusive        = value.include? '...'
+      starting_point   = range_points[1].to_f
+      ending_point     = if range_points[2] == 'Infinity'
+                           9_999_999
+                         else
+                           range_points[2].to_f
+                         end
 
       Range.new(starting_point, ending_point, exclusive)
     else

data/lib/drillbit/parameters/index.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module  Drillbit
 class   Parameters
 class   Index
@@ -22,8 +23,8 @@ class   Index
 
   def compacted_parameters
     @compacted_parameters ||= raw_parameters.reject do |_name, value|
-                                value == '' ||
-                                value.nil?
+      value == '' ||
+      value.nil?
     end
   end
 end

data/lib/drillbit/parameters/page.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module  Drillbit
 class   Parameters
 class   Page

data/lib/drillbit/parameters/sort.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module  Drillbit
 class   Parameters
 class   Sort

data/lib/drillbit/requests/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/tokens/json_web_tokens/invalid'
 require 'drillbit/tokens/json_web_token'
 
@@ -32,7 +33,6 @@ class   Base
     end
   end
 
-  # rubocop:disable Style/ClosingParenthesisIndentation
   def authorization_token
     if (
          !authorization_token_from_header.blank? &&

data/lib/drillbit/requests/rack.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/configuration'
 require 'drillbit/requests/base'
 require 'drillbit/accept_header'
@@ -35,9 +36,11 @@ class   Rack < Base
     request['HTTP_ACCEPT']
   end
 
+  # rubocop:disable Lint/UriEscapeUnescape
   def raw_accept_header_from_params
     URI.unescape(request['QUERY_STRING'][ACCEPT_PARAM_PATTERN, 1] || '')
   end
+  # rubocop:enable Lint/UriEscapeUnescape
 
   def raw_authorization_header
     request['HTTP_AUTHORIZATION'] || ''

data/lib/drillbit/requests/rails.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/configuration'
 require 'drillbit/requests/base'
 require 'drillbit/accept_header'

data/lib/drillbit/resource.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/authorizable_resource'
 require 'erratum/rescuable_resource'
 require 'erratum/verifiable_resource'

data/lib/drillbit/resource/model.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/resource/processors/filtering'
 require 'drillbit/resource/processors/sorting'
 require 'drillbit/resource/processors/paging'
@@ -10,8 +11,8 @@ class   Model
   DEFAULT_PROCESSORS = %w{filtering sorting paging indexing}.freeze
 
   attr_accessor :resource,
-                :parameters,
-                :processors
+                :parameters
+  attr_reader   :processors
 
   def initialize(resource:, parameters:, **options)
     self.resource   = resource
@@ -21,13 +22,13 @@ class   Model
 
   def processed
     @processed ||= processors.inject(resource) do |processed_resource, processor|
-        processor.processed(processed_resource, parameters)
+      processor.processed(processed_resource, parameters)
     end
   end
 
   def meta
     @meta ||= processors.inject({}) do |metadata, processor|
-        metadata.merge processor.meta(processed, parameters)
+      metadata.merge processor.meta(processed, parameters)
     end
   end
 

data/lib/drillbit/resource/naming.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # rubocop:disable Metrics/LineLength
 module  Drillbit
 module  Resource
@@ -7,22 +8,22 @@ module  Naming
 
   module ClassMethods
     def plural_resource_name
-      @plural_resource_name ||= name[CONTROLLER_RESOURCE_NAME_PATTERN, 3].
-                                underscore.
-                                pluralize.
-                                downcase
+      @plural_resource_name ||= name[CONTROLLER_RESOURCE_NAME_PATTERN, 3]
+                                  .underscore
+                                  .pluralize
+                                  .downcase
     end
 
     def singular_resource_name
-      @singular_resource_name ||= name[CONTROLLER_RESOURCE_NAME_PATTERN, 3].
-                                  underscore.
-                                  singularize.
-                                  downcase
+      @singular_resource_name ||= name[CONTROLLER_RESOURCE_NAME_PATTERN, 3]
+                                    .underscore
+                                    .singularize
+                                    .downcase
     end
 
     def resource_class_name
-      @resource_class_name ||= singular_resource_name.
-                               camelize
+      @resource_class_name ||= singular_resource_name
+                                 .camelize
     end
   end
 

data/lib/drillbit/resource/processors/filtering.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/parameters/filter'
 
 module Drillbit

data/lib/drillbit/resource/processors/indexing.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/parameters/index'
 
 module Drillbit

data/lib/drillbit/resource/processors/paging.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/parameters/page'
 
 module  Drillbit
@@ -26,9 +27,9 @@ class   Paging
   def processed
     return resource unless parameters.present?
 
-    resource.
-    page(parameters.page_number).
-    per(parameters.per_page)
+    resource
+      .page(parameters.page_number)
+      .per(parameters.per_page)
   end
 
   def meta

data/lib/drillbit/resource/processors/sorting.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'drillbit/parameters/sort'
 
 module  Drillbit

data/lib/drillbit/responses/invalid_api_request.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
+
 require 'drillbit/errors/invalid_api_request'
 
 module  Drillbit
 module  Responses
 class   InvalidApiRequest
+  # rubocop:disable Style/InlineComment
   def self.call(env)
     error = Drillbit::Errors::InvalidApiRequest.new(accept_header: env['HTTP_ACCEPT'])
 
@@ -13,6 +15,7 @@ class   InvalidApiRequest
       ["{\"errors\": [#{error.to_json}]}"], # Message
     ]
   end
+  # rubocop:enable Style/InlineComment
 end
 end
 end

data/lib/drillbit/responses/invalid_request_body.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
+
 require 'drillbit/errors/invalid_request_body'
 
 module  Drillbit
 module  Responses
 class   InvalidRequestBody
+  # rubocop:disable Style/InlineComment
   def self.call(env)
     error = Drillbit::Errors::InvalidRequestBody.new(request_body: env['RACK_INPUT'])
 
@@ -13,6 +15,7 @@ class   InvalidRequestBody
       ["{\"errors\": [#{error.to_json}]}"], # Message
     ]
   end
+  # rubocop:enable Style/InlineComment
 end
 end
 end

data/lib/drillbit/responses/invalid_subdomain.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
+
 require 'drillbit/errors/invalid_subdomain'
 
 module  Drillbit
 module  Responses
 class   InvalidSubdomain
+  # rubocop:disable Style/InlineComment
   def self.call(env)
     error = Drillbit::Errors::InvalidSubdomain.new(http_host: env['HTTP_HOST'])
 
@@ -13,6 +15,7 @@ class   InvalidSubdomain
       ["{\"errors\": [#{error.to_json}]}"], # Message
     ]
   end
+  # rubocop:enable Style/InlineComment
 end
 end
 end

data/lib/drillbit/responses/invalid_token.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
+
 require 'drillbit/errors/invalid_token'
 
 module  Drillbit
 module  Responses
 class   InvalidToken
+  # rubocop:disable Style/InlineComment
   def self.call(_env, application_name:)
     error = Drillbit::Errors::InvalidToken.new
 
@@ -15,6 +17,7 @@ class   InvalidToken
       ["{\"errors\": [#{error.to_json}]}"], # Message
     ]
   end
+  # rubocop:enable Style/InlineComment
 end
 end
 end