grape 2.4.0 → 3.2.1

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

@@ -4,24 +4,15 @@ module Grape
   module Validations
     module Validators
       class SameAsValidator < Base
-        def validate_param!(attr_name, params)
-          confirmation = options_key?(:value) ? @option[:value] : @option
-          return if params[attr_name] == params[confirmation]
-
-          raise Grape::Exceptions::Validation.new(
-            params: [@scope.full_name(attr_name)],
-            message: build_message
-          )
+        def initialize(attrs, options, required, scope, opts)
+          super
+          @value = option_value
         end
 
-        private
+        def validate_param!(attr_name, params)
+          return if params[attr_name] == params[@value]
 
-        def build_message
-          if options_key?(:message)
-            @option[:message]
-          else
-            format I18n.t(:same_as, scope: 'grape.errors.messages'), parameter: @option
-          end
+          validation_error!(attr_name, message { translate(:same_as, parameter: @value) })
         end
       end
     end

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

@@ -4,45 +4,53 @@ module Grape
   module Validations
     module Validators
       class ValuesValidator < Base
+        default_message_key :values
+
         def initialize(attrs, options, required, scope, opts)
-          @values = options.is_a?(Hash) ? options[:value] : options
           super
+          values = option_value
+
+          # Zero-arity procs return a collection per-request (e.g. DB-backed lists).
+          # Non-zero-arity procs are per-element predicates, called directly at validation time.
+          # Non-Proc values are wrapped in a zero-arity lambda for a uniform call interface.
+          if values.is_a?(Proc)
+            @values_call = values
+            @values_is_predicate = !values.arity.zero?
+          else
+            @values_call = -> { values }
+            @values_is_predicate = false
+          end
         end
 
         def validate_param!(attr_name, params)
-          return unless params.is_a?(Hash)
+          return unless hash_like?(params)
 
-          val = params[attr_name]
+          val = scrub(params[attr_name])
 
           return if val.nil? && !required_for_root_scope?
-
-          val = val.scrub if val.respond_to?(:scrub)
-
-          # don't forget that +false.blank?+ is true
           return if val != false && val.blank? && @allow_blank
-
           return if check_values?(val, attr_name)
 
-          raise Grape::Exceptions::Validation.new(
-            params: [@scope.full_name(attr_name)],
-            message: message(:values)
-          )
+          validation_error!(attr_name)
         end
 
         private
 
         def check_values?(val, attr_name)
-          values = @values.is_a?(Proc) && @values.arity.zero? ? @values.call : @values
-          return true if values.nil?
-
           param_array = val.nil? ? [nil] : Array.wrap(val)
-          return param_array.all? { |param| values.include?(param) } unless values.is_a?(Proc)
 
-          begin
-            param_array.all? { |param| values.call(param) }
-          rescue StandardError => e
-            warn "Error '#{e}' raised while validating attribute '#{attr_name}'"
-            false
+          if @values_is_predicate
+            begin
+              param_array.all? { |param| @values_call.call(param) }
+            rescue StandardError => e
+              warn "Error '#{e}' raised while validating attribute '#{attr_name}'"
+              false
+            end
+          else
+            values = @values_call.call
+            return true if values.nil?
+
+            param_array.all? { |param| values.include?(param) }
           end
         end
 

data/lib/grape/version.rb

@@ -2,5 +2,5 @@
 
 module Grape
   # The current version of Grape.
-  VERSION = '2.4.0'
+  VERSION = '3.2.1'
 end

data/lib/grape.rb

@@ -2,28 +2,19 @@
 
 require 'logger'
 require 'active_support'
-require 'active_support/concern'
-require 'active_support/configurable'
 require 'active_support/version'
-require 'active_support/isolated_execution_state' if ActiveSupport::VERSION::MAJOR > 6
-require 'active_support/core_ext/array/conversions'
-require 'active_support/core_ext/array/extract_options'
+require 'active_support/isolated_execution_state'
+require 'active_support/core_ext/array/conversions' # to_xml
 require 'active_support/core_ext/array/wrap'
-require 'active_support/core_ext/enumerable'
-require 'active_support/core_ext/hash/conversions'
+require 'active_support/core_ext/hash/conversions' # to_xml
 require 'active_support/core_ext/hash/deep_merge'
-require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/hash/deep_transform_values'
 require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/hash/reverse_merge'
-require 'active_support/core_ext/hash/slice'
-require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/delegation' # delegate_missing_to
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/deep_dup'
-require 'active_support/core_ext/object/try'
 require 'active_support/core_ext/object/duplicable'
-require 'active_support/core_ext/string/output_safety'
-require 'active_support/core_ext/string/exclude'
 require 'active_support/deprecation'
 require 'active_support/inflector'
 require 'active_support/ordered_options'
@@ -33,6 +24,7 @@ require 'English'
 require 'bigdecimal'
 require 'date'
 require 'dry-types'
+require 'dry-configurable'
 require 'forwardable'
 require 'json'
 require 'mustermann/grape'
@@ -41,7 +33,6 @@ require 'rack'
 require 'rack/auth/basic'
 require 'rack/builder'
 require 'rack/head'
-require 'set'
 require 'singleton'
 require 'zeitwerk'
 
@@ -57,7 +48,10 @@ loader.setup
 I18n.load_path << File.expand_path('grape/locale/en.yml', __dir__)
 
 module Grape
-  include ActiveSupport::Configurable
+  extend Dry::Configurable
+
+  setting :param_builder, default: :hash_with_indifferent_access
+  setting :lint, default: false
 
   HTTP_SUPPORTED_METHODS = [
     Rack::GET,
@@ -69,18 +63,30 @@ module Grape
     Rack::OPTIONS
   ].freeze
 
+  # Rack errors that should be rescued and wrapped as Grape::Exceptions::RequestError.
+  # Rack 3.1.0 introduced Rack::BadRequest as a marker module included by all bad request
+  # exception classes, allowing a single rescue entry to cover them all.
+  # Before, these errors are raised as individual exception classes.
+  RACK_ERRORS =
+    if Gem::Version.new(Rack.release) >= Gem::Version.new('3.1.0')
+      [EOFError, Rack::BadRequest]
+    else
+      [
+        EOFError,
+        Rack::Multipart::MultipartPartLimitError,
+        Rack::Multipart::MultipartTotalPartLimitError,
+        Rack::Utils::ParameterTypeError,
+        Rack::Utils::InvalidParameterError,
+        Rack::QueryParser::ParamsTooDeepError
+      ]
+    end.freeze
+
   def self.deprecator
     @deprecator ||= ActiveSupport::Deprecation.new('2.0', 'Grape')
   end
-
-  configure do |config|
-    config.param_builder = :hash_with_indifferent_access
-    config.lint = false
-    config.compile_methods!
-  end
 end
 
 # https://api.rubyonrails.org/classes/ActiveSupport/Deprecation.html
 # adding Grape.deprecator to Rails App if any
-require 'grape/railtie' if defined?(Rails::Railtie) && ActiveSupport.gem_version >= Gem::Version.new('7.1')
+require 'grape/railtie' if defined?(Rails::Railtie)
 loader.eager_load

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Michael Bleigh
@@ -15,14 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
@@ -95,14 +109,13 @@ files:
 - grape.png
 - lib/grape.rb
 - lib/grape/api.rb
-- lib/grape/api/helpers.rb
 - lib/grape/api/instance.rb
 - lib/grape/content_types.rb
 - lib/grape/cookies.rb
+- lib/grape/declared_params_handler.rb
 - lib/grape/dry_types.rb
-- lib/grape/dsl/api.rb
 - lib/grape/dsl/callbacks.rb
-- lib/grape/dsl/configuration.rb
+- lib/grape/dsl/declared.rb
 - lib/grape/dsl/desc.rb
 - lib/grape/dsl/headers.rb
 - lib/grape/dsl/helpers.rb
@@ -123,13 +136,10 @@ files:
 - lib/grape/error_formatter/txt.rb
 - lib/grape/error_formatter/xml.rb
 - lib/grape/exceptions/base.rb
-- lib/grape/exceptions/conflicting_types.rb
-- lib/grape/exceptions/empty_message_body.rb
 - lib/grape/exceptions/incompatible_option_values.rb
 - lib/grape/exceptions/invalid_accept_header.rb
 - lib/grape/exceptions/invalid_formatter.rb
 - lib/grape/exceptions/invalid_message_body.rb
-- lib/grape/exceptions/invalid_parameters.rb
 - lib/grape/exceptions/invalid_response.rb
 - lib/grape/exceptions/invalid_version_header.rb
 - lib/grape/exceptions/invalid_versioner_option.rb
@@ -137,12 +147,9 @@ files:
 - lib/grape/exceptions/method_not_allowed.rb
 - lib/grape/exceptions/missing_group_type.rb
 - lib/grape/exceptions/missing_mime_type.rb
-- lib/grape/exceptions/missing_option.rb
 - lib/grape/exceptions/missing_vendor_option.rb
-- lib/grape/exceptions/too_deep_parameters.rb
-- lib/grape/exceptions/too_many_multipart_files.rb
+- lib/grape/exceptions/request_error.rb
 - lib/grape/exceptions/unknown_auth_strategy.rb
-- lib/grape/exceptions/unknown_options.rb
 - lib/grape/exceptions/unknown_parameter.rb
 - lib/grape/exceptions/unknown_params_builder.rb
 - lib/grape/exceptions/unknown_validator.rb
@@ -150,9 +157,6 @@ files:
 - lib/grape/exceptions/validation.rb
 - lib/grape/exceptions/validation_array_errors.rb
 - lib/grape/exceptions/validation_errors.rb
-- lib/grape/extensions/active_support/hash_with_indifferent_access.rb
-- lib/grape/extensions/hash.rb
-- lib/grape/extensions/hashie/mash.rb
 - lib/grape/formatter.rb
 - lib/grape/formatter/base.rb
 - lib/grape/formatter/json.rb
@@ -199,9 +203,10 @@ files:
 - lib/grape/serve_stream/file_body.rb
 - lib/grape/serve_stream/sendfile_response.rb
 - lib/grape/serve_stream/stream_response.rb
-- lib/grape/types/invalid_value.rb
+- lib/grape/util/api_description.rb
 - lib/grape/util/base_inheritable.rb
 - lib/grape/util/cache.rb
+- lib/grape/util/deep_freeze.rb
 - lib/grape/util/endpoint_configuration.rb
 - lib/grape/util/header.rb
 - lib/grape/util/inheritable_setting.rb
@@ -215,12 +220,13 @@ files:
 - lib/grape/util/registry.rb
 - lib/grape/util/reverse_stackable_values.rb
 - lib/grape/util/stackable_values.rb
-- lib/grape/util/strict_hash_configuration.rb
+- lib/grape/util/translation.rb
 - lib/grape/validations.rb
-- lib/grape/validations/attributes_doc.rb
 - lib/grape/validations/attributes_iterator.rb
 - lib/grape/validations/contract_scope.rb
 - lib/grape/validations/multiple_attributes_iterator.rb
+- lib/grape/validations/param_scope_tracker.rb
+- lib/grape/validations/params_documentation.rb
 - lib/grape/validations/params_scope.rb
 - lib/grape/validations/single_attribute_iterator.rb
 - lib/grape/validations/types.rb
@@ -235,7 +241,6 @@ files:
 - lib/grape/validations/types/primitive_coercer.rb
 - lib/grape/validations/types/set_coercer.rb
 - lib/grape/validations/types/variant_collection_coercer.rb
-- lib/grape/validations/validator_factory.rb
 - lib/grape/validations/validators/all_or_none_of_validator.rb
 - lib/grape/validations/validators/allow_blank_validator.rb
 - lib/grape/validations/validators/as_validator.rb
@@ -248,7 +253,7 @@ files:
 - lib/grape/validations/validators/except_values_validator.rb
 - lib/grape/validations/validators/length_validator.rb
 - lib/grape/validations/validators/multiple_params_base.rb
-- lib/grape/validations/validators/mutual_exclusion_validator.rb
+- lib/grape/validations/validators/mutually_exclusive_validator.rb
 - lib/grape/validations/validators/presence_validator.rb
 - lib/grape/validations/validators/regexp_validator.rb
 - lib/grape/validations/validators/same_as_validator.rb
@@ -260,9 +265,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.4.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/2.4.0
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.4.0
+  changelog_uri: https://github.com/ruby-grape/grape/blob/v3.2.1/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/grape/3.2.1
+  source_code_uri: https://github.com/ruby-grape/grape/tree/v3.2.1
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -271,14 +276,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
 test_files: []

data/lib/grape/api/helpers.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  class API
-    module Helpers
-      include Grape::DSL::Helpers::BaseHelper
-    end
-  end
-end

data/lib/grape/dsl/api.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module DSL
-    module API
-      extend ActiveSupport::Concern
-
-      include Grape::DSL::Validations
-      include Grape::DSL::Callbacks
-      include Grape::DSL::Configuration
-      include Grape::DSL::Helpers
-      include Grape::DSL::Middleware
-      include Grape::DSL::RequestResponse
-      include Grape::DSL::Routing
-    end
-  end
-end

data/lib/grape/dsl/configuration.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module DSL
-    module Configuration
-      extend ActiveSupport::Concern
-
-      module ClassMethods
-        include Grape::DSL::Settings
-        include Grape::DSL::Logger
-        include Grape::DSL::Desc
-      end
-    end
-  end
-end

data/lib/grape/exceptions/conflicting_types.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Exceptions
-    class ConflictingTypes < Base
-      def initialize
-        super(message: compose_message(:conflicting_types), status: 400)
-      end
-    end
-  end
-end

data/lib/grape/exceptions/empty_message_body.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Exceptions
-    class EmptyMessageBody < Base
-      def initialize(body_format)
-        super(message: compose_message(:empty_message_body, body_format: body_format), status: 400)
-      end
-    end
-  end
-end

data/lib/grape/exceptions/invalid_parameters.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Exceptions
-    class InvalidParameters < Base
-      def initialize
-        super(message: compose_message(:invalid_parameters), status: 400)
-      end
-    end
-  end
-end

data/lib/grape/exceptions/missing_option.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Exceptions
-    class MissingOption < Base
-      def initialize(option)
-        super(message: compose_message(:missing_option, option: option))
-      end
-    end
-  end
-end

data/lib/grape/exceptions/too_deep_parameters.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Exceptions
-    class TooDeepParameters < Base
-      def initialize(limit)
-        super(message: compose_message(:too_deep_parameters, limit: limit), status: 400)
-      end
-    end
-  end
-end

data/lib/grape/exceptions/too_many_multipart_files.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Exceptions
-    class TooManyMultipartFiles < Base
-      def initialize(limit)
-        super(message: compose_message(:too_many_multipart_files, limit: limit), status: 413)
-      end
-    end
-  end
-end

data/lib/grape/exceptions/unknown_options.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Exceptions
-    class UnknownOptions < Base
-      def initialize(options)
-        super(message: compose_message(:unknown_options, options: options))
-      end
-    end
-  end
-end

data/lib/grape/extensions/active_support/hash_with_indifferent_access.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Extensions
-    module ActiveSupport
-      module HashWithIndifferentAccess
-        module ParamBuilder
-          extend ::ActiveSupport::Concern
-
-          included do
-            Grape.deprecator.warn 'This concern has been deprecated. Use `build_with` with one of the following short_name (:hash, :hash_with_indifferent_access, :hashie_mash) instead.'
-            namespace_inheritable(:build_params_with, :hash_with_indifferent_access)
-          end
-
-          def build_params
-            ::ActiveSupport::HashWithIndifferentAccess.new(rack_params).tap do |params|
-              params.deep_merge!(grape_routing_args) if env.key?(Grape::Env::GRAPE_ROUTING_ARGS)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/grape/extensions/hash.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Extensions
-    module Hash
-      module ParamBuilder
-        extend ::ActiveSupport::Concern
-
-        included do
-          Grape.deprecator.warn 'This concern has been deprecated. Use `build_with` with one of the following short_name (:hash, :hash_with_indifferent_access, :hashie_mash) instead.'
-          namespace_inheritable(:build_params_with, :hash)
-        end
-
-        def build_params
-          rack_params.deep_dup.tap do |params|
-            params.deep_symbolize_keys!
-
-            if env.key?(Grape::Env::GRAPE_ROUTING_ARGS)
-              grape_routing_args.deep_symbolize_keys!
-              params.deep_merge!(grape_routing_args)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/grape/extensions/hashie/mash.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Extensions
-    module Hashie
-      module Mash
-        module ParamBuilder
-          extend ::ActiveSupport::Concern
-
-          included do
-            Grape.deprecator.warn 'This concern has been deprecated. Use `build_with` with one of the following short_name (:hash, :hash_with_indifferent_access, :hashie_mash) instead.'
-            namespace_inheritable(:build_params_with, :hashie_mash)
-          end
-
-          def build_params
-            ::Hashie::Mash.new(rack_params).tap do |params|
-              params.deep_merge!(grape_routing_args) if env.key?(Grape::Env::GRAPE_ROUTING_ARGS)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/grape/types/invalid_value.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-# only exists to make it shorter for external use
-module Grape
-  module Types
-    InvalidValue = Class.new(Grape::Validations::Types::InvalidValue)
-  end
-end