grape 2.3.0 → 2.4.0

data/lib/grape/router.rb

@@ -4,12 +4,30 @@ module Grape
   class Router
     attr_reader :map, :compiled
 
+    # Taken from Rails
+    #     normalize_path("/foo")  # => "/foo"
+    #     normalize_path("/foo/") # => "/foo"
+    #     normalize_path("foo")   # => "/foo"
+    #     normalize_path("")      # => "/"
+    #     normalize_path("/%ab")  # => "/%AB"
+    # https://github.com/rails/rails/blob/00cc4ff0259c0185fe08baadaa40e63ea2534f6e/actionpack/lib/action_dispatch/journey/router/utils.rb#L19
     def self.normalize_path(path)
+      return +'/' unless path
+
+      # Fast path for the overwhelming majority of paths that don't need to be normalized
+      return path.dup if path == '/' || (path.start_with?('/') && !(path.end_with?('/') || path.match?(%r{%|//})))
+
+      # Slow path
+      encoding = path.encoding
       path = +"/#{path}"
       path.squeeze!('/')
-      path.sub!(%r{/+\Z}, '')
-      path = '/' if path == ''
-      path
+
+      unless path == '/'
+        path.delete_suffix!('/')
+        path.gsub!(/(%[a-f0-9]{2})/) { ::Regexp.last_match(1).upcase }
+      end
+
+      path.force_encoding(encoding)
     end
 
     def initialize
@@ -24,7 +42,7 @@ module Grape
 
       @union = Regexp.union(@neutral_regexes)
       @neutral_regexes = nil
-      (Grape::Http::Headers::SUPPORTED_METHODS + ['*']).each do |method|
+      (Grape::HTTP_SUPPORTED_METHODS + ['*']).each do |method|
         next unless map.key?(method)
 
         routes = map[method]
@@ -93,7 +111,7 @@ module Grape
             return response unless cascade
 
             # we need to close the body if possible before dismissing
-            response[2].close if response[2].respond_to?(:close)
+            response[2].try(:close)
           end
         end
       end
@@ -138,7 +156,7 @@ module Grape
     end
 
     def default_response
-      headers = Grape::Util::Header.new.merge(Grape::Http::Headers::X_CASCADE => 'pass')
+      headers = Grape::Util::Header.new.merge('X-Cascade' => 'pass')
       [404, headers, ['404 Not Found']]
     end
 
@@ -162,7 +180,7 @@ module Grape
     end
 
     def cascade?(response)
-      response && response[1][Grape::Http::Headers::X_CASCADE] == 'pass'
+      response && response[1]['X-Cascade'] == 'pass'
     end
 
     def string_for(input)

data/lib/grape/validations/params_scope.rb

@@ -4,7 +4,7 @@ module Grape
   module Validations
     class ParamsScope
       attr_accessor :element, :parent, :index
-      attr_reader :type
+      attr_reader :type, :params_meeting_dependency
 
       include Grape::DSL::Parameters
 
@@ -67,6 +67,7 @@ module Grape
         @type             = opts[:type]
         @group            = opts[:group]
         @dependent_on     = opts[:dependent_on]
+        @params_meeting_dependency = []
         @declared_params = []
         @index = nil
 
@@ -94,7 +95,11 @@ module Grape
       def meets_dependency?(params, request_params)
         return true unless @dependent_on
         return false if @parent.present? && !@parent.meets_dependency?(@parent.params(request_params), request_params)
-        return params.any? { |param| meets_dependency?(param, request_params) } if params.is_a?(Array)
+
+        if params.is_a?(Array)
+          @params_meeting_dependency = params.flatten.filter { |param| meets_dependency?(param, request_params) }
+          return @params_meeting_dependency.present?
+        end
 
         meets_hash_dependency?(params)
       end
@@ -127,7 +132,7 @@ module Grape
       def full_name(name, index: nil)
         if nested?
           # Find our containing element's name, and append ours.
-          "#{@parent.full_name(@element)}#{brackets(@index || index)}#{brackets(name)}"
+          "#{@parent.full_name(@element)}#{brackets(index || @index)}#{brackets(name)}"
         elsif lateral?
           # Find the name of the element as if it was at the same nesting level
           # as our parent. We need to forward our index upward to achieve this.

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

@@ -49,7 +49,7 @@ module Grape
             next if !@scope.required? && empty_val
             next unless @scope.meets_dependency?(val, params)
 
-            validate_param!(attr_name, val) if @required || (val.respond_to?(:key?) && val.key?(attr_name))
+            validate_param!(attr_name, val) if @required || val.try(:key?, attr_name)
           rescue Grape::Exceptions::Validation => e
             array_errors << e
           end
@@ -69,7 +69,7 @@ module Grape
 
         def options_key?(key, options = nil)
           options = instance_variable_get(:@option) if options.nil?
-          options.respond_to?(:key?) && options.key?(key) && !options[key].nil?
+          options.try(:key?, key) && !options[key].nil?
         end
 
         def fail_fast?

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

@@ -10,7 +10,7 @@ module Grape
         end
 
         def validate_param!(attr_name, params)
-          return unless params.respond_to?(:key?) && params.key?(attr_name)
+          return unless params.try(:key?, attr_name)
 
           excepts = @except.is_a?(Proc) ? @except.call : @except
           return if excepts.nil?

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

@@ -5,7 +5,7 @@ module Grape
     module Validators
       class PresenceValidator < Base
         def validate_param!(attr_name, params)
-          return if params.respond_to?(:key?) && params.key?(attr_name)
+          return if params.try(:key?, attr_name)
 
           raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:presence))
         end

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

@@ -5,7 +5,7 @@ module Grape
     module Validators
       class RegexpValidator < Base
         def validate_param!(attr_name, params)
-          return unless params.respond_to?(:key?) && params.key?(attr_name)
+          return unless params.try(:key?, attr_name)
           return if Array.wrap(params[attr_name]).all? { |param| param.nil? || param.to_s.scrub.match?((options_key?(:value) ? @option[:value] : @option)) }
 
           raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message(:regexp))

data/lib/grape/version.rb

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

data/lib/grape.rb

@@ -20,6 +20,7 @@ require 'active_support/core_ext/hash/slice'
 require 'active_support/core_ext/module/delegation'
 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'
@@ -58,12 +59,23 @@ I18n.load_path << File.expand_path('grape/locale/en.yml', __dir__)
 module Grape
   include ActiveSupport::Configurable
 
+  HTTP_SUPPORTED_METHODS = [
+    Rack::GET,
+    Rack::POST,
+    Rack::PUT,
+    Rack::PATCH,
+    Rack::DELETE,
+    Rack::HEAD,
+    Rack::OPTIONS
+  ].freeze
+
   def self.deprecator
     @deprecator ||= ActiveSupport::Deprecation.new('2.0', 'Grape')
   end
 
   configure do |config|
-    config.param_builder = Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+    config.param_builder = :hash_with_indifferent_access
+    config.lint = false
     config.compile_methods!
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Michael Bleigh
 bindir: bin
 cert_chain: []
-date: 2025-02-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
@@ -119,16 +119,17 @@ files:
 - lib/grape/error_formatter.rb
 - lib/grape/error_formatter/base.rb
 - lib/grape/error_formatter/json.rb
-- lib/grape/error_formatter/jsonapi.rb
 - lib/grape/error_formatter/serializable_hash.rb
 - 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
@@ -138,9 +139,12 @@ files:
 - 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/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
 - lib/grape/exceptions/unsupported_group_type.rb
 - lib/grape/exceptions/validation.rb
@@ -155,7 +159,6 @@ files:
 - lib/grape/formatter/serializable_hash.rb
 - lib/grape/formatter/txt.rb
 - lib/grape/formatter/xml.rb
-- lib/grape/http/headers.rb
 - lib/grape/json.rb
 - lib/grape/locale/en.yml
 - lib/grape/middleware/auth/base.rb
@@ -167,7 +170,6 @@ files:
 - lib/grape/middleware/filter.rb
 - lib/grape/middleware/formatter.rb
 - lib/grape/middleware/globals.rb
-- lib/grape/middleware/helpers.rb
 - lib/grape/middleware/stack.rb
 - lib/grape/middleware/versioner.rb
 - lib/grape/middleware/versioner/accept_version_header.rb
@@ -176,10 +178,14 @@ files:
 - lib/grape/middleware/versioner/param.rb
 - lib/grape/middleware/versioner/path.rb
 - lib/grape/namespace.rb
+- lib/grape/params_builder.rb
+- lib/grape/params_builder/base.rb
+- lib/grape/params_builder/hash.rb
+- lib/grape/params_builder/hash_with_indifferent_access.rb
+- lib/grape/params_builder/hashie_mash.rb
 - lib/grape/parser.rb
 - lib/grape/parser/base.rb
 - lib/grape/parser/json.rb
-- lib/grape/parser/jsonapi.rb
 - lib/grape/parser/xml.rb
 - lib/grape/path.rb
 - lib/grape/presenters/presenter.rb
@@ -201,7 +207,6 @@ files:
 - lib/grape/util/inheritable_setting.rb
 - lib/grape/util/inheritable_values.rb
 - lib/grape/util/lazy/block.rb
-- lib/grape/util/lazy/object.rb
 - lib/grape/util/lazy/value.rb
 - lib/grape/util/lazy/value_array.rb
 - lib/grape/util/lazy/value_enumerable.rb
@@ -255,9 +260,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape/issues
-  changelog_uri: https://github.com/ruby-grape/grape/blob/v2.3.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/grape/2.3.0
-  source_code_uri: https://github.com/ruby-grape/grape/tree/v2.3.0
+  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
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -273,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A simple Ruby framework for building REST-like APIs.
 test_files: []

data/lib/grape/error_formatter/jsonapi.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module ErrorFormatter
-    class Jsonapi < Json; end
-  end
-end

data/lib/grape/http/headers.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Http
-    module Headers
-      HTTP_ACCEPT_VERSION = 'HTTP_ACCEPT_VERSION'
-      HTTP_ACCEPT = 'HTTP_ACCEPT'
-      HTTP_TRANSFER_ENCODING = 'HTTP_TRANSFER_ENCODING'
-      HTTP_VERSION = 'HTTP_VERSION'
-
-      ALLOW = 'Allow'
-      LOCATION = 'Location'
-      X_CASCADE = 'X-Cascade'
-      TRANSFER_ENCODING = 'Transfer-Encoding'
-
-      SUPPORTED_METHODS = [
-        Rack::GET,
-        Rack::POST,
-        Rack::PUT,
-        Rack::PATCH,
-        Rack::DELETE,
-        Rack::HEAD,
-        Rack::OPTIONS
-      ].freeze
-
-      SUPPORTED_METHODS_WITHOUT_OPTIONS = (SUPPORTED_METHODS - [Rack::OPTIONS]).freeze
-
-      HTTP_HEADERS = Grape::Util::Lazy::Object.new do
-        common_http_headers = %w[
-          Version
-          Host
-          Connection
-          Cache-Control
-          Dnt
-          Upgrade-Insecure-Requests
-          User-Agent
-          Sec-Fetch-Dest
-          Accept
-          Sec-Fetch-Site
-          Sec-Fetch-Mode
-          Sec-Fetch-User
-          Accept-Encoding
-          Accept-Language
-          Cookie
-        ].freeze
-        common_http_headers.each_with_object({}) do |header, response|
-          response["HTTP_#{header.upcase.tr('-', '_')}"] = header
-        end.freeze
-      end
-
-      def self.find_supported_method(route_method)
-        Grape::Http::Headers::SUPPORTED_METHODS.detect { |supported_method| supported_method.casecmp(route_method).zero? }
-      end
-    end
-  end
-end

data/lib/grape/middleware/helpers.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Middleware
-    # Common methods for all types of Grape middleware
-    module Helpers
-      def context
-        env[Grape::Env::API_ENDPOINT]
-      end
-    end
-  end
-end

data/lib/grape/parser/jsonapi.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Grape
-  module Parser
-    class Jsonapi < Json; end
-  end
-end

data/lib/grape/util/lazy/object.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# Based on https://github.com/HornsAndHooves/lazy_object
-
-module Grape
-  module Util
-    module Lazy
-      class Object < BasicObject
-        attr_reader :callable
-
-        def initialize(&callable)
-          @callable = callable
-        end
-
-        def __target_object__
-          @__target_object__ ||= callable.call
-        end
-
-        def ==(other)
-          __target_object__ == other
-        end
-
-        def !=(other)
-          __target_object__ != other
-        end
-
-        def !
-          !__target_object__
-        end
-
-        def method_missing(method_name, *args, &block)
-          if __target_object__.respond_to?(method_name)
-            __target_object__.send(method_name, *args, &block)
-          else
-            super
-          end
-        end
-
-        def respond_to_missing?(method_name, include_priv = false)
-          __target_object__.respond_to?(method_name, include_priv)
-        end
-      end
-    end
-  end
-end