grape 2.4.0 → 3.2.1

data/lib/grape/exceptions/base.rb

@@ -3,9 +3,9 @@
 module Grape
   module Exceptions
     class Base < StandardError
-      BASE_MESSAGES_KEY = 'grape.errors.messages'
-      BASE_ATTRIBUTES_KEY = 'grape.errors.attributes'
-      FALLBACK_LOCALE = :en
+      include Grape::Util::Translation
+
+      MESSAGE_STEPS = %w[problem summary resolution].to_h { |s| [s, s.capitalize] }.freeze
 
       attr_reader :status, :headers
 
@@ -17,58 +17,32 @@ module Grape
       end
 
       def [](index)
-        send index
+        __send__ index
       end
 
-      protected
+      private
 
-      # TODO: translate attribute first
-      # if BASE_ATTRIBUTES_KEY.key respond to a string message, then short_message is returned
-      # if BASE_ATTRIBUTES_KEY.key respond to a Hash, means it may have problem , summary and resolution
-      def compose_message(key, **attributes)
-        short_message = translate_message(key, attributes)
+      def compose_message(key, **)
+        short_message = translate_message(key, **)
         return short_message unless short_message.is_a?(Hash)
 
-        each_steps(key, attributes).with_object(+'') do |detail_array, message|
-          message << "\n#{detail_array[0]}:\n  #{detail_array[1]}" unless detail_array[1].blank?
-        end
-      end
-
-      def each_steps(key, attributes)
-        return enum_for(:each_steps, key, attributes) unless block_given?
-
-        yield 'Problem', translate_message(:"#{key}.problem", attributes)
-        yield 'Summary', translate_message(:"#{key}.summary", attributes)
-        yield 'Resolution', translate_message(:"#{key}.resolution", attributes)
-      end
-
-      def translate_attributes(keys, options = {})
-        keys.map do |key|
-          translate("#{BASE_ATTRIBUTES_KEY}.#{key}", options.merge(default: key.to_s))
-        end.join(', ')
+        MESSAGE_STEPS.filter_map do |step, label|
+          detail = translate_message(:"#{key}.#{step}", **)
+          "\n#{label}:\n  #{detail}" if detail.present?
+        end.join
       end
 
-      def translate_message(key, options = {})
-        case key
+      def translate_message(translation_key, **)
+        case translation_key
         when Symbol
-          translate("#{BASE_MESSAGES_KEY}.#{key}", options.merge(default: ''))
+          translate(translation_key, **)
+        when Hash
+          translation_key => { key:, **opts }
+          translate(key, **opts)
         when Proc
-          key.call
-        else
-          key
-        end
-      end
-
-      def translate(key, options)
-        message = ::I18n.translate(key, **options)
-        message.presence || fallback_message(key, options)
-      end
-
-      def fallback_message(key, options)
-        if ::I18n.enforce_available_locales && ::I18n.available_locales.exclude?(FALLBACK_LOCALE)
-          key
+          translation_key.call
         else
-          ::I18n.translate(key, locale: FALLBACK_LOCALE, **options)
+          translation_key
         end
       end
     end

data/lib/grape/exceptions/incompatible_option_values.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class IncompatibleOptionValues < Base
       def initialize(option1, value1, option2, value2)
-        super(message: compose_message(:incompatible_option_values, option1: option1, value1: value1, option2: option2, value2: value2))
+        super(message: compose_message(:incompatible_option_values, option1:, value1:, option2:, value2:))
       end
     end
   end

data/lib/grape/exceptions/invalid_accept_header.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class InvalidAcceptHeader < Base
       def initialize(message, headers)
-        super(message: compose_message(:invalid_accept_header, message: message), status: 406, headers: headers)
+        super(message: compose_message(:invalid_accept_header, message:), status: 406, headers:)
       end
     end
   end

data/lib/grape/exceptions/invalid_formatter.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class InvalidFormatter < Base
       def initialize(klass, to_format)
-        super(message: compose_message(:invalid_formatter, klass: klass, to_format: to_format))
+        super(message: compose_message(:invalid_formatter, klass:, to_format:))
       end
     end
   end

data/lib/grape/exceptions/invalid_message_body.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class InvalidMessageBody < Base
       def initialize(body_format)
-        super(message: compose_message(:invalid_message_body, body_format: body_format), status: 400)
+        super(message: compose_message(:invalid_message_body, body_format:), status: 400)
       end
     end
   end

data/lib/grape/exceptions/invalid_version_header.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class InvalidVersionHeader < Base
       def initialize(message, headers)
-        super(message: compose_message(:invalid_version_header, message: message), status: 406, headers: headers)
+        super(message: compose_message(:invalid_version_header, message:), status: 406, headers:)
       end
     end
   end

data/lib/grape/exceptions/invalid_versioner_option.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class InvalidVersionerOption < Base
       def initialize(strategy)
-        super(message: compose_message(:invalid_versioner_option, strategy: strategy))
+        super(message: compose_message(:invalid_versioner_option, strategy:))
       end
     end
   end

data/lib/grape/exceptions/method_not_allowed.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class MethodNotAllowed < Base
       def initialize(headers)
-        super(message: '405 Not Allowed', status: 405, headers: headers)
+        super(message: '405 Not Allowed', status: 405, headers:)
       end
     end
   end

data/lib/grape/exceptions/missing_group_type.rb

@@ -9,5 +9,3 @@ module Grape
     end
   end
 end
-
-Grape::Exceptions::MissingGroupTypeError = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('Grape::Exceptions::MissingGroupTypeError', 'Grape::Exceptions::MissingGroupType', Grape.deprecator)

data/lib/grape/exceptions/missing_mime_type.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class MissingMimeType < Base
       def initialize(new_format)
-        super(message: compose_message(:missing_mime_type, new_format: new_format))
+        super(message: compose_message(:missing_mime_type, new_format:))
       end
     end
   end

data/lib/grape/exceptions/request_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Grape
+  module Exceptions
+    class RequestError < Base
+      def initialize(status: 400)
+        super(message: $ERROR_INFO&.message, status:)
+      end
+    end
+  end
+end

data/lib/grape/exceptions/unknown_auth_strategy.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class UnknownAuthStrategy < Base
       def initialize(strategy:)
-        super(message: compose_message(:unknown_auth_strategy, strategy: strategy))
+        super(message: compose_message(:unknown_auth_strategy, strategy:))
       end
     end
   end

data/lib/grape/exceptions/unknown_parameter.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class UnknownParameter < Base
       def initialize(param)
-        super(message: compose_message(:unknown_parameter, param: param))
+        super(message: compose_message(:unknown_parameter, param:))
       end
     end
   end

data/lib/grape/exceptions/unknown_params_builder.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class UnknownParamsBuilder < Base
       def initialize(params_builder_type)
-        super(message: compose_message(:unknown_params_builder, params_builder_type: params_builder_type))
+        super(message: compose_message(:unknown_params_builder, params_builder_type:))
       end
     end
   end

data/lib/grape/exceptions/unknown_validator.rb

@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class UnknownValidator < Base
       def initialize(validator_type)
-        super(message: compose_message(:unknown_validator, validator_type: validator_type))
+        super(message: compose_message(:unknown_validator, validator_type:))
       end
     end
   end

data/lib/grape/exceptions/unsupported_group_type.rb

@@ -9,5 +9,3 @@ module Grape
     end
   end
 end
-
-Grape::Exceptions::UnsupportedGroupTypeError = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('Grape::Exceptions::UnsupportedGroupTypeError', 'Grape::Exceptions::UnsupportedGroupType', Grape.deprecator)

data/lib/grape/exceptions/validation.rb

@@ -3,16 +3,19 @@
 module Grape
   module Exceptions
     class Validation < Base
-      attr_accessor :params, :message_key
+      attr_reader :params, :message_key
 
       def initialize(params:, message: nil, status: nil, headers: nil)
-        @params = params
+        @params = Array(params)
         if message
-          @message_key = message if message.is_a?(Symbol)
+          @message_key = case message
+                         when Symbol then message
+                         when Hash then message[:key]
+                         end
           message = translate_message(message)
         end
 
-        super(status: status, message: message, headers: headers)
+        super(status:, message:, headers:)
       end
 
       # Remove all the unnecessary stuff from Grape::Exceptions::Base like status

data/lib/grape/exceptions/validation_errors.rb

@@ -3,16 +3,13 @@
 module Grape
   module Exceptions
     class ValidationErrors < Base
-      ERRORS_FORMAT_KEY = 'grape.errors.format'
-      DEFAULT_ERRORS_FORMAT = '%<attributes>s %<message>s'
-
       include Enumerable
 
       attr_reader :errors
 
       def initialize(errors: [], headers: {})
         @errors = errors.group_by(&:params)
-        super(message: full_messages.join(', '), status: 400, headers: headers)
+        super(message: full_messages.join(', '), status: 400, headers:)
       end
 
       def each
@@ -38,9 +35,10 @@ module Grape
 
       def full_messages
         messages = map do |attributes, error|
-          I18n.t(
-            ERRORS_FORMAT_KEY,
-            default: DEFAULT_ERRORS_FORMAT,
+          translate(
+            :format,
+            scope: 'grape.errors',
+            default: '%<attributes>s %<message>s',
             attributes: translate_attributes(attributes),
             message: error.message
           )
@@ -48,6 +46,14 @@ module Grape
         messages.uniq!
         messages
       end
+
+      private
+
+      def translate_attributes(keys)
+        keys.map do |key|
+          translate(key, scope: 'grape.errors.attributes', default: key.to_s)
+        end.join(', ')
+      end
     end
   end
 end

data/lib/grape/locale/en.yml

@@ -8,8 +8,6 @@ en:
         at_least_one: 'are missing, at least one parameter must be provided'
         blank: 'is empty'
         coerce: 'is invalid'
-        conflicting_types: 'query params contains conflicting types'
-        empty_message_body: 'empty message body supplied with %{body_format} content-type'
         exactly_one: 'are missing, exactly one parameter must be provided'
         except_values: 'has a value not allowed'
         incompatible_option_values: '%{option1}: %{value1} is incompatible with %{option2}: %{value2}'
@@ -20,7 +18,6 @@ en:
         invalid_message_body:
           problem: 'message body does not match declared format'
           resolution: 'when specifying %{body_format} as content-type, you must pass valid %{body_format} in the request''s ''body'' '
-        invalid_parameters: 'query params contains invalid format or byte sequence'
         invalid_response: 'Invalid response'
         invalid_version_header:
           problem: 'invalid version header'
@@ -48,8 +45,6 @@ en:
         presence: 'is missing'
         regexp: 'is invalid'
         same_as: 'is not the same as %{parameter}'
-        too_deep_parameters: 'query params are recursively nested over the specified limit (%{limit})'
-        too_many_multipart_files: 'the number of uploaded files exceeded the system''s configured limit (%{limit})'
         unknown_auth_strategy: 'unknown auth strategy: %{strategy}'
         unknown_options: 'unknown options: %{options}'
         unknown_parameter: 'unknown parameter: %{param}'

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

@@ -6,6 +6,8 @@ module Grape
       class Base < Grape::Middleware::Base
         def initialize(app, **options)
           super
+          return unless options.key?(:type)
+
           @auth_strategy = Grape::Middleware::Auth::Strategies[options[:type]].tap do |auth_strategy|
             raise Grape::Exceptions::UnknownAuthStrategy.new(strategy: options[:type]) unless auth_strategy
           end

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

@@ -5,24 +5,23 @@ module Grape
     module Auth
       module DSL
         def auth(type = nil, options = {}, &block)
-          if type
-            namespace_inheritable(:auth, options.reverse_merge(type: type.to_sym, proc: block))
-            use Grape::Middleware::Auth::Base, namespace_inheritable(:auth)
-          else
-            namespace_inheritable(:auth)
-          end
+          namespace_inheritable = inheritable_setting.namespace_inheritable
+          return namespace_inheritable[:auth] unless type
+
+          namespace_inheritable[:auth] = options.reverse_merge(type: type.to_sym, proc: block)
+          use Grape::Middleware::Auth::Base, namespace_inheritable[:auth]
         end
 
         # Add HTTP Basic authorization to the API.
         #
         # @param [Hash] options A hash of options.
         # @option options [String] :realm "API Authorization" The HTTP Basic realm.
-        def http_basic(options = {}, &block)
+        def http_basic(options = {}, &)
           options[:realm] ||= 'API Authorization'
-          auth :http_basic, options, &block
+          auth(:http_basic, options, &)
         end
 
-        def http_digest(options = {}, &block)
+        def http_digest(options = {}, &)
           options[:realm] ||= 'API Authorization'
 
           if options[:realm].respond_to?(:values_at)
@@ -31,7 +30,7 @@ module Grape
             options[:opaque] ||= 'secret'
           end
 
-          auth :http_digest, options, &block
+          auth(:http_digest, options, &)
         end
       end
     end

data/lib/grape/middleware/base.rb

@@ -79,10 +79,8 @@ module Grape
 
       def query_params
         rack_request.GET
-      rescue Rack::QueryParser::ParamsTooDeepError
-        raise Grape::Exceptions::TooDeepParameters.new(Rack::Utils.param_depth_limit)
-      rescue Rack::Utils::ParameterTypeError
-        raise Grape::Exceptions::ConflictingTypes
+      rescue *Grape::RACK_ERRORS
+        raise Grape::Exceptions::RequestError
       end
 
       private
@@ -109,6 +107,10 @@ module Grape
           options
         end
       end
+
+      def try_scrub(obj)
+        obj.respond_to?(:valid_encoding?) && !obj.valid_encoding? ? obj.scrub : obj
+      end
     end
   end
 end

data/lib/grape/middleware/error.rb

@@ -16,11 +16,6 @@ module Grape
         }.freeze
       }.freeze
 
-      def initialize(app, **options)
-        super
-        self.class.include(options[:helpers]) if options[:helpers]
-      end
-
       def call!(env)
         @env = env
         error_response(catch(:error) { return @app.call(@env) })
@@ -43,8 +38,8 @@ module Grape
         throw :error,
               status: 406,
               message: "The requested format '#{format}' is not supported.",
-              backtrace: backtrace,
-              original_exception: original_exception
+              backtrace:,
+              original_exception:
       end
 
       def find_handler(klass)
@@ -63,7 +58,7 @@ module Grape
           h.merge!(error[:headers]) if error[:headers].is_a?(Hash)
         end
         backtrace = error[:backtrace] || error[:original_exception]&.backtrace || []
-        original_exception = error.is_a?(Exception) ? error : error[:original_exception] || nil
+        original_exception = error.is_a?(Exception) ? error : error[:original_exception]
         rack_response(status, headers, format_message(message, backtrace, original_exception))
       end
 
@@ -103,12 +98,7 @@ module Grape
       end
 
       def run_rescue_handler(handler, error, endpoint)
-        if handler.instance_of?(Symbol)
-          raise NoMethodError, "undefined method '#{handler}'" unless respond_to?(handler)
-
-          handler = public_method(handler)
-        end
-
+        handler = endpoint.public_method(handler) if handler.instance_of?(Symbol)
         response = catch(:error) do
           handler.arity.zero? ? endpoint.instance_exec(&handler) : endpoint.instance_exec(error, &handler)
         end

data/lib/grape/middleware/formatter.rb

@@ -7,6 +7,8 @@ module Grape
         default_format: :txt
       }.freeze
 
+      ALL_MEDIA_TYPES = '*/*'
+
       def before
         negotiate_content_type
         read_body_input
@@ -36,7 +38,7 @@ module Grape
         else
           # Allow content-type to be explicitly overwritten
           formatter = fetch_formatter(headers, options)
-          bodymap = ActiveSupport::Notifications.instrument('format_response.grape', formatter: formatter, env: env) do
+          bodymap = ActiveSupport::Notifications.instrument('format_response.grape', formatter:, env:) do
             bodies.collect { |body| formatter.call(body, env) }
           end
           Rack::Response.new(bodymap, status, headers)
@@ -67,12 +69,14 @@ module Grape
         return if input.nil?
         return unless read_body_input?
 
-        input.try(:rewind)
+        rewind = input.respond_to?(:rewind)
+
+        input.rewind if rewind
         body = env[Grape::Env::API_REQUEST_INPUT] = input.read
         begin
           read_rack_input(body)
         ensure
-          input.try(:rewind)
+          input.rewind if rewind
         end
       end
 
@@ -128,17 +132,17 @@ module Grape
       end
 
       def format_from_extension
-        request_path = rack_request.path.try(:scrub)
+        request_path = try_scrub(rack_request.path)
         dot_pos = request_path.rindex('.')
         return unless dot_pos
 
-        extension = request_path[dot_pos + 1..]
+        extension = request_path[(dot_pos + 1)..]
         extension if content_type_for(extension)
       end
 
       def format_from_header
-        accept_header = env['HTTP_ACCEPT'].try(:scrub)
-        return if accept_header.blank?
+        accept_header = try_scrub(env['HTTP_ACCEPT'])
+        return if accept_header.blank? || accept_header == ALL_MEDIA_TYPES
 
         media_type = Rack::Utils.best_q_match(accept_header, mime_types.keys)
         mime_types[media_type] if media_type

data/lib/grape/middleware/stack.rb

@@ -6,6 +6,7 @@ module Grape
     # It allows to insert and insert after
     class Stack
       extend Forwardable
+
       class Middleware
         attr_reader :args, :block, :klass
 
@@ -59,9 +60,9 @@ module Grape
 
       alias insert_before insert
 
-      def insert_after(index, *args, &block)
+      def insert_after(index, ...)
         index = assert_index(index, :after)
-        insert(index + 1, *args, &block)
+        insert(index + 1, ...)
       end
 
       def use(klass, *args, &block)

data/lib/grape/middleware/versioner/accept_version_header.rb

@@ -18,8 +18,8 @@ module Grape
       # route.
       class AcceptVersionHeader < Base
         def before
-          potential_version = env['HTTP_ACCEPT_VERSION'].try(:scrub)
-          not_acceptable!('Accept-Version header must be set.') if strict? && potential_version.blank?
+          potential_version = try_scrub(env['HTTP_ACCEPT_VERSION'])
+          not_acceptable!('Accept-Version header must be set.') if strict && potential_version.blank?
 
           return if potential_version.blank?
 
@@ -30,7 +30,7 @@ module Grape
         private
 
         def not_acceptable!(message)
-          throw :error, status: 406, headers: error_headers, message: message
+          throw :error, status: 406, headers: error_headers, message:
         end
       end
     end