grape 1.6.0 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7af0abe5fd1cb203ceda93732e74ded372552f7a859c6a3c6b847d1ac31c9c97
-  data.tar.gz: 103a38ad4d41eccbfef3240cd8b04fe17f2bc080a4265e4353b43076ce03fb15
+  metadata.gz: d182a6dfa2a571345d24a6a2b7286b4a2b34eeedc6570334ba2259fdda59faac
+  data.tar.gz: c365091e871e7ad78dd46dc0aab52cdd41d1e5ddb5a46503fcf0020af45f4324
 SHA512:
-  metadata.gz: 8c8fb085cbaa5ea150e072a54e98546f4336966871225ae5587d70d115da62d420e1f67b2459f83c39c5d29717f311e93d09e0440dd4bf4a75d1f1cec7573022
-  data.tar.gz: c0f6eb027e3f43c309c59643ceb28c8f7d783466c0663f3b65e93be52a0c3148123110d9aa81dda842027ace7f0f319519b5cdc1fec7102d65811a84fbc2b2ed
+  metadata.gz: 539fdf761a5058dfcb3bab993a7fac3c7223ec06e0b828e102cb52095ac79f63668ebab1c1c4b47bf16984990c94f9a291537e7b2a1359626736b7abdd2c34ec
+  data.tar.gz: 2b30d941ab114aab53c4f4630742adedd037856ecc63b65f87b0df506349a13eed092964d9f53c003774006e74b9800043178b2ad2e6c55b0d5d42f6039a7e71

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+### 1.6.2 (2021/12/30)
+
+#### Features
+
+#### Fixes
+
+* [#2219](https://github.com/ruby-grape/grape/pull/2219): Revert the changes for autoloading provided in 1.6.1 - [@dm1try](https://github.com/dm1try).
+
+### 1.6.1 (2021/12/28)
+
+#### Features
+
+* [#2196](https://github.com/ruby-grape/grape/pull/2196): Add support for `passwords_hashed` param for `digest_auth` - [@lHydra](https://github.com/lhydra).
+* [#2208](https://github.com/ruby-grape/grape/pull/2208): Added Rails 7 support - [@ericproulx](https://github.com/ericproulx).
+
+#### Fixes
+
+* [#2206](https://github.com/ruby-grape/grape/pull/2206): Require main active_support lib before any of its extension definitions - [@annih](https://github.com/Annih).
+* [#2193](https://github.com/ruby-grape/grape/pull/2193): Fixed the broken ruby-head NoMethodError spec - [@Jack12816](https://github.com/Jack12816).
+* [#2192](https://github.com/ruby-grape/grape/pull/2192): Memoize the result of Grape::Middleware::Base#response - [@Jack12816](https://github.com/Jack12816).
+* [#2200](https://github.com/ruby-grape/grape/pull/2200): Add validators module to all validators - [@ericproulx](https://github.com/ericproulx).
+* [#2202](https://github.com/ruby-grape/grape/pull/2202): Fix random mock spec error - [@ericproulx](https://github.com/ericproulx).
+* [#2203](https://github.com/ruby-grape/grape/pull/2203): Add rubocop-rspec - [@ericproulx](https://github.com/ericproulx).
+* [#2207](https://github.com/ruby-grape/grape/pull/2207): Autoload Validations/Validators - [@ericproulx](https://github.com/ericproulx).
+* [#2209](https://github.com/ruby-grape/grape/pull/2209): Autoload Validations/Types - [@ericproulx](https://github.com/ericproulx).
+
 ### 1.6.0 (2021/10/04)
 
 #### Features

data/CONTRIBUTING.md

@@ -35,6 +35,7 @@ bundle exec rake
 Run tests against all supported versions of Rails.
 
 ```
+gem install appraisal
 appraisal install
 appraisal rake spec
 ```
@@ -118,7 +119,7 @@ Go back to your pull request after a few minutes and see whether it passed muste
 
 #### Be Patient
 
-It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang in there!
 
 #### Thank You
 

data/README.md

@@ -158,7 +158,7 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-You're reading the documentation for the stable release of Grape, **1.6.0**.
+You're reading the documentation for the stable release of Grape, **1.6.2**.
 Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 ## Project Resources
@@ -3296,12 +3296,20 @@ http_basic do |username, password|
 end
 ```
 
+Digest auth supports clear-text passwords and password hashes.
+
 ```ruby
 http_digest({ realm: 'Test Api', opaque: 'app secret' }) do |username|
   # lookup the user's password here
 end
 ```
 
+```ruby
+http_digest(realm: { realm: 'Test Api', opaque: 'app secret', passwords_hashed: true }) do |username|
+  # lookup the user's password hash here
+end
+```
+
 ### Register custom middleware for authentication
 
 Grape can use custom Middleware for authentication. How to implement these

data/UPGRADING.md

@@ -27,7 +27,7 @@ declared(params, include_missing: false)
 # actual   => { b: '5' } (uncasted, unvalidated, <= 1.5.3)
 ```
 
-Another implication of this change is the dependent parameter resolution. Prior to 1.6.0 the following code produced an `Grape::Exceptions::UnknownParameter` because `:a` was replace by `:b`:
+Another implication of this change is the dependent parameter resolution. Prior to 1.6.0 the following code produced a `Grape::Exceptions::UnknownParameter` because `:a` was replaced by `:b`:
 
 ```ruby
 params do
@@ -47,7 +47,7 @@ See [#2189](https://github.com/ruby-grape/grape/pull/2189) for more information.
 #### Nil value and coercion
 
 Prior to 1.2.5 version passing a `nil` value for a parameter with a custom coercer would invoke the coercer, and not passing a parameter would not invoke it.
-This behavior was not tested or documented. Version 1.3.0 quietly changed this behavior, in such that `nil` values skipped the coercion. Version 1.5.3 fixes and documents this as follows:
+This behavior was not tested or documented. Version 1.3.0 quietly changed this behavior, in that `nil` values skipped the coercion. Version 1.5.3 fixes and documents this as follows:
 
 ```ruby
 class Api < Grape::API
@@ -197,13 +197,13 @@ end
 
 #### Nil values for structures
 
-Nil values always been a special case when dealing with types especially with the following structures:
+Nil values have always been a special case when dealing with types, especially with the following structures:
 
 - Array
 - Hash
 - Set
 
-The behavior for these structures has change through out the latest releases. For example:
+The behavior for these structures has changed throughout the latest releases. For example:
 
 ```ruby
 class Api < Grape::API

data/lib/grape/api.rb

@@ -10,6 +10,18 @@ module Grape
     # Class methods that we want to call on the API rather than on the API object
     NON_OVERRIDABLE = (Class.new.methods + %i[call call! configuration compile! inherited]).freeze
 
+    class Boolean
+      def self.build(val)
+        return nil if val != true && val != false
+
+        new
+      end
+    end
+
+    class Instance
+      Boolean = Grape::API::Boolean
+    end
+
     class << self
       attr_accessor :base_instance, :instances
 

data/lib/grape/dsl/headers.rb

@@ -3,8 +3,11 @@
 module Grape
   module DSL
     module Headers
-      # Set an individual header or retrieve
-      # all headers that have been set.
+      # This method has four responsibilities:
+      # 1. Set a specifc header value by key
+      # 2. Retrieve a specifc header value by key
+      # 3. Retrieve all headers that have been set
+      # 4. Delete a specifc header key-value pair
       def header(key = nil, val = nil)
         if key
           val ? header[key.to_s] = val : header.delete(key.to_s)

data/lib/grape/dsl/helpers.rb

@@ -68,7 +68,7 @@ module Grape
         def define_boolean_in_mod(mod)
           return if defined? mod::Boolean
 
-          mod.const_set('Boolean', Grape::API::Boolean)
+          mod.const_set(:Boolean, Grape::API::Boolean)
         end
 
         def inject_api_helpers_to_mod(mod, &block)

data/lib/grape/middleware/auth/dsl.rb

@@ -32,7 +32,13 @@ module Grape
 
           def http_digest(options = {}, &block)
             options[:realm] ||= 'API Authorization'
-            options[:opaque] ||= 'secret'
+
+            if options[:realm].respond_to?(:values_at)
+              options[:realm][:opaque] ||= 'secret'
+            else
+              options[:opaque] ||= 'secret'
+            end
+
             auth :http_digest, options, &block
           end
         end

data/lib/grape/middleware/base.rb

@@ -60,7 +60,7 @@ module Grape
       def response
         return @app_response if @app_response.is_a?(Rack::Response)
 
-        Rack::Response.new(@app_response[2], @app_response[0], @app_response[1])
+        @app_response = Rack::Response.new(@app_response[2], @app_response[0], @app_response[1])
       end
 
       def content_type_for(format)

data/lib/grape/util/strict_hash_configuration.rb

@@ -65,7 +65,7 @@ module Grape
             end
           end
 
-          define_method 'to_hash' do
+          define_method :to_hash do
             merge_hash = {}
             setting_name.each_key { |k| merge_hash[k] = send("#{k}_context").to_hash }
 

data/lib/grape/validations/validators/all_or_none.rb

@@ -4,12 +4,14 @@ require 'grape/validations/validators/multiple_params_base'
 
 module Grape
   module Validations
-    class AllOrNoneOfValidator < MultipleParamsBase
-      def validate_params!(params)
-        keys = keys_in_common(params)
-        return if keys.empty? || keys.length == all_keys.length
+    module Validators
+      class AllOrNoneOfValidator < MultipleParamsBase
+        def validate_params!(params)
+          keys = keys_in_common(params)
+          return if keys.empty? || keys.length == all_keys.length
 
-        raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:all_or_none))
+          raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:all_or_none))
+        end
       end
     end
   end

data/lib/grape/validations/validators/allow_blank.rb

@@ -2,16 +2,18 @@
 
 module Grape
   module Validations
-    class AllowBlankValidator < Base
-      def validate_param!(attr_name, params)
-        return if (options_key?(:value) ? @option[:value] : @option) || !params.is_a?(Hash)
+    module Validators
+      class AllowBlankValidator < Base
+        def validate_param!(attr_name, params)
+          return if (options_key?(:value) ? @option[:value] : @option) || !params.is_a?(Hash)
 
-        value = params[attr_name]
-        value = value.strip if value.respond_to?(:strip)
+          value = params[attr_name]
+          value = value.strip if value.respond_to?(:strip)
 
-        return if value == false || value.present?
+          return if value == false || value.present?
 
-        raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:blank))
+          raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:blank))
+        end
       end
     end
   end

data/lib/grape/validations/validators/as.rb

@@ -2,11 +2,13 @@
 
 module Grape
   module Validations
-    class AsValidator < Base
-      # We use a validator for renaming parameters. This is just a marker for
-      # the parameter scope to handle the renaming. No actual validation
-      # happens here.
-      def validate_param!(*); end
+    module Validators
+      class AsValidator < Base
+        # We use a validator for renaming parameters. This is just a marker for
+        # the parameter scope to handle the renaming. No actual validation
+        # happens here.
+        def validate_param!(*); end
+      end
     end
   end
 end

data/lib/grape/validations/validators/at_least_one_of.rb

@@ -4,11 +4,13 @@ require 'grape/validations/validators/multiple_params_base'
 
 module Grape
   module Validations
-    class AtLeastOneOfValidator < MultipleParamsBase
-      def validate_params!(params)
-        return unless keys_in_common(params).empty?
+    module Validators
+      class AtLeastOneOfValidator < MultipleParamsBase
+        def validate_params!(params)
+          return unless keys_in_common(params).empty?
 
-        raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:at_least_one))
+          raise Grape::Exceptions::Validation.new(params: all_keys, message: message(:at_least_one))
+        end
       end
     end
   end

data/lib/grape/validations/validators/base.rb

@@ -2,91 +2,93 @@
 
 module Grape
   module Validations
-    class Base
-      attr_reader :attrs
+    module Validators
+      class Base
+        attr_reader :attrs
 
-      # Creates a new Validator from options specified
-      # by a +requires+ or +optional+ directive during
-      # parameter definition.
-      # @param attrs [Array] names of attributes to which the Validator applies
-      # @param options [Object] implementation-dependent Validator options
-      # @param required [Boolean] attribute(s) are required or optional
-      # @param scope [ParamsScope] parent scope for this Validator
-      # @param opts [Array] additional validation options
-      def initialize(attrs, options, required, scope, *opts)
-        @attrs = Array(attrs)
-        @option = options
-        @required = required
-        @scope = scope
-        opts = opts.any? ? opts.shift : {}
-        @fail_fast = opts.fetch(:fail_fast, false)
-        @allow_blank = opts.fetch(:allow_blank, false)
-      end
+        # Creates a new Validator from options specified
+        # by a +requires+ or +optional+ directive during
+        # parameter definition.
+        # @param attrs [Array] names of attributes to which the Validator applies
+        # @param options [Object] implementation-dependent Validator options
+        # @param required [Boolean] attribute(s) are required or optional
+        # @param scope [ParamsScope] parent scope for this Validator
+        # @param opts [Array] additional validation options
+        def initialize(attrs, options, required, scope, *opts)
+          @attrs = Array(attrs)
+          @option = options
+          @required = required
+          @scope = scope
+          opts = opts.any? ? opts.shift : {}
+          @fail_fast = opts.fetch(:fail_fast, false)
+          @allow_blank = opts.fetch(:allow_blank, false)
+        end
 
-      # Validates a given request.
-      # @note Override #validate! unless you need to access the entire request.
-      # @param request [Grape::Request] the request currently being handled
-      # @raise [Grape::Exceptions::Validation] if validation failed
-      # @return [void]
-      def validate(request)
-        return unless @scope.should_validate?(request.params)
+        # Validates a given request.
+        # @note Override #validate! unless you need to access the entire request.
+        # @param request [Grape::Request] the request currently being handled
+        # @raise [Grape::Exceptions::Validation] if validation failed
+        # @return [void]
+        def validate(request)
+          return unless @scope.should_validate?(request.params)
 
-        validate!(request.params)
-      end
+          validate!(request.params)
+        end
 
-      # Validates a given parameter hash.
-      # @note Override #validate if you need to access the entire request.
-      # @param params [Hash] parameters to validate
-      # @raise [Grape::Exceptions::Validation] if validation failed
-      # @return [void]
-      def validate!(params)
-        attributes = SingleAttributeIterator.new(self, @scope, params)
-        # we collect errors inside array because
-        # there may be more than one error per field
-        array_errors = []
+        # Validates a given parameter hash.
+        # @note Override #validate if you need to access the entire request.
+        # @param params [Hash] parameters to validate
+        # @raise [Grape::Exceptions::Validation] if validation failed
+        # @return [void]
+        def validate!(params)
+          attributes = SingleAttributeIterator.new(self, @scope, params)
+          # we collect errors inside array because
+          # there may be more than one error per field
+          array_errors = []
 
-        attributes.each do |val, attr_name, empty_val, skip_value|
-          next if skip_value
-          next if !@scope.required? && empty_val
-          next unless @scope.meets_dependency?(val, params)
+          attributes.each do |val, attr_name, empty_val, skip_value|
+            next if skip_value
+            next if !@scope.required? && empty_val
+            next unless @scope.meets_dependency?(val, params)
 
-          begin
-            validate_param!(attr_name, val) if @required || (val.respond_to?(:key?) && val.key?(attr_name))
-          rescue Grape::Exceptions::Validation => e
-            array_errors << e
+            begin
+              validate_param!(attr_name, val) if @required || (val.respond_to?(:key?) && val.key?(attr_name))
+            rescue Grape::Exceptions::Validation => e
+              array_errors << e
+            end
           end
-        end
 
-        raise Grape::Exceptions::ValidationArrayErrors.new(array_errors) if array_errors.any?
-      end
+          raise Grape::Exceptions::ValidationArrayErrors.new(array_errors) if array_errors.any?
+        end
 
-      def self.convert_to_short_name(klass)
-        ret = klass.name.gsub(/::/, '/')
-        ret.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-        ret.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-        ret.tr!('-', '_')
-        ret.downcase!
-        File.basename(ret, '_validator')
-      end
+        def self.convert_to_short_name(klass)
+          ret = klass.name.gsub(/::/, '/')
+          ret.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          ret.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+          ret.tr!('-', '_')
+          ret.downcase!
+          File.basename(ret, '_validator')
+        end
 
-      def self.inherited(klass)
-        return unless klass.name.present?
+        def self.inherited(klass)
+          return unless klass.name.present?
 
-        Validations.register_validator(convert_to_short_name(klass), klass)
-      end
+          Validations.register_validator(convert_to_short_name(klass), klass)
+        end
 
-      def message(default_key = nil)
-        options = instance_variable_get(:@option)
-        options_key?(:message) ? options[:message] : default_key
-      end
+        def message(default_key = nil)
+          options = instance_variable_get(:@option)
+          options_key?(:message) ? options[:message] : default_key
+        end
 
-      def options_key?(key, options = nil)
-        options = instance_variable_get(:@option) if options.nil?
-        options.respond_to?(:key?) && options.key?(key) && !options[key].nil?
-      end
+        def options_key?(key, options = nil)
+          options = instance_variable_get(:@option) if options.nil?
+          options.respond_to?(:key?) && options.key?(key) && !options[key].nil?
+        end
 
-      def fail_fast?
-        @fail_fast
+        def fail_fast?
+          @fail_fast
+        end
       end
     end
   end

data/lib/grape/validations/validators/coerce.rb

@@ -1,86 +1,74 @@
 # frozen_string_literal: true
 
 module Grape
-  class API
-    class Boolean
-      def self.build(val)
-        return nil if val != true && val != false
-
-        new
-      end
-    end
-
-    class Instance
-      Boolean = Grape::API::Boolean
-    end
-  end
-
   module Validations
-    class CoerceValidator < Base
-      def initialize(attrs, options, required, scope, **opts)
-        super
-
-        @converter = if type.is_a?(Grape::Validations::Types::VariantCollectionCoercer)
-                       type
-                     else
-                       Types.build_coercer(type, method: @option[:method])
-                     end
-      end
-
-      def validate_param!(attr_name, params)
-        raise validation_exception(attr_name) unless params.is_a? Hash
-
-        new_value = coerce_value(params[attr_name])
-
-        raise validation_exception(attr_name, new_value.message) unless valid_type?(new_value)
-
-        # Don't assign a value if it is identical. It fixes a problem with Hashie::Mash
-        # which looses wrappers for hashes and arrays after reassigning values
+    module Validators
+      class CoerceValidator < Base
+        def initialize(attrs, options, required, scope, **opts)
+          super
+
+          @converter = if type.is_a?(Grape::Validations::Types::VariantCollectionCoercer)
+                         type
+                       else
+                         Types.build_coercer(type, method: @option[:method])
+                       end
+        end
+
+        def validate_param!(attr_name, params)
+          raise validation_exception(attr_name) unless params.is_a? Hash
+
+          new_value = coerce_value(params[attr_name])
+
+          raise validation_exception(attr_name, new_value.message) unless valid_type?(new_value)
+
+          # Don't assign a value if it is identical. It fixes a problem with Hashie::Mash
+          # which looses wrappers for hashes and arrays after reassigning values
+          #
+          #     h = Hashie::Mash.new(list: [1, 2, 3, 4])
+          #     => #<Hashie::Mash list=#<Hashie::Array [1, 2, 3, 4]>>
+          #     list = h.list
+          #     h[:list] = list
+          #     h
+          #     => #<Hashie::Mash list=[1, 2, 3, 4]>
+          return if params[attr_name].instance_of?(new_value.class) && params[attr_name] == new_value
+
+          params[attr_name] = new_value
+        end
+
+        private
+
+        # @!attribute [r] converter
+        # Object that will be used for parameter coercion and type checking.
         #
-        #     h = Hashie::Mash.new(list: [1, 2, 3, 4])
-        #     => #<Hashie::Mash list=#<Hashie::Array [1, 2, 3, 4]>>
-        #     list = h.list
-        #     h[:list] = list
-        #     h
-        #     => #<Hashie::Mash list=[1, 2, 3, 4]>
-        return if params[attr_name].instance_of?(new_value.class) && params[attr_name] == new_value
-
-        params[attr_name] = new_value
-      end
-
-      private
-
-      # @!attribute [r] converter
-      # Object that will be used for parameter coercion and type checking.
-      #
-      # See {Types.build_coercer}
-      #
-      # @return [Object]
-      attr_reader :converter
-
-      def valid_type?(val)
-        !val.is_a?(Types::InvalidValue)
-      end
+        # See {Types.build_coercer}
+        #
+        # @return [Object]
+        attr_reader :converter
 
-      def coerce_value(val)
-        converter.call(val)
-      # Some custom types might fail, so it should be treated as an invalid value
-      rescue StandardError
-        Types::InvalidValue.new
-      end
+        def valid_type?(val)
+          !val.is_a?(Types::InvalidValue)
+        end
 
-      # Type to which the parameter will be coerced.
-      #
-      # @return [Class]
-      def type
-        @option[:type].is_a?(Hash) ? @option[:type][:value] : @option[:type]
-      end
+        def coerce_value(val)
+          converter.call(val)
+          # Some custom types might fail, so it should be treated as an invalid value
+        rescue StandardError
+          Types::InvalidValue.new
+        end
 
-      def validation_exception(attr_name, custom_msg = nil)
-        Grape::Exceptions::Validation.new(
-          params: [@scope.full_name(attr_name)],
-          message: custom_msg || message(:coerce)
-        )
+        # Type to which the parameter will be coerced.
+        #
+        # @return [Class]
+        def type
+          @option[:type].is_a?(Hash) ? @option[:type][:value] : @option[:type]
+        end
+
+        def validation_exception(attr_name, custom_msg = nil)
+          Grape::Exceptions::Validation.new(
+            params: [@scope.full_name(attr_name)],
+            message: custom_msg || message(:coerce)
+          )
+        end
       end
     end
   end