grape 1.0.0 → 1.6.0

data/lib/grape/error_formatter/json.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 module Grape
   module ErrorFormatter
     module Json
       extend Base
 
       class << self
-        def call(message, backtrace, options = {}, env = nil)
+        def call(message, backtrace, options = {}, env = nil, original_exception = nil)
           result = wrap_message(present(message, env))
 
-          if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
-            result = result.merge(backtrace: backtrace)
-          end
+          rescue_options = options[:rescue_options] || {}
+          result = result.merge(backtrace: backtrace) if rescue_options[:backtrace] && backtrace && !backtrace.empty?
+          result = result.merge(original_exception: original_exception.inspect) if rescue_options[:original_exception] && original_exception
           ::Grape::Json.dump(result)
         end
 

data/lib/grape/error_formatter/txt.rb

@@ -1,17 +1,24 @@
+# frozen_string_literal: true
+
 module Grape
   module ErrorFormatter
     module Txt
       extend Base
 
       class << self
-        def call(message, backtrace, options = {}, env = nil)
+        def call(message, backtrace, options = {}, env = nil, original_exception = nil)
           message = present(message, env)
 
           result = message.is_a?(Hash) ? ::Grape::Json.dump(message) : message
-          if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
-            result += "\r\n "
+          rescue_options = options[:rescue_options] || {}
+          if rescue_options[:backtrace] && backtrace && !backtrace.empty?
+            result += "\r\n backtrace:"
             result += backtrace.join("\r\n ")
           end
+          if rescue_options[:original_exception] && original_exception
+            result += "\r\n original exception:"
+            result += "\r\n #{original_exception.inspect}"
+          end
           result
         end
       end

data/lib/grape/error_formatter/xml.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Grape
   module ErrorFormatter
     module Xml
       extend Base
 
       class << self
-        def call(message, backtrace, options = {}, env = nil)
+        def call(message, backtrace, options = {}, env = nil, original_exception = nil)
           message = present(message, env)
 
           result = message.is_a?(Hash) ? message : { message: message }
-          if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
-            result = result.merge(backtrace: backtrace)
-          end
+          rescue_options = options[:rescue_options] || {}
+          result = result.merge(backtrace: backtrace) if rescue_options[:backtrace] && backtrace && !backtrace.empty?
+          result = result.merge(original_exception: original_exception.inspect) if rescue_options[:original_exception] && original_exception
           result.respond_to?(:to_xml) ? result.to_xml(root: :error) : result.to_s
         end
       end

data/lib/grape/error_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module ErrorFormatter
     extend Util::Registrable
@@ -13,8 +15,8 @@ module Grape
         }
       end
 
-      def formatters(options)
-        builtin_formatters.merge(default_elements).merge(options[:error_formatters] || {})
+      def formatters(**options)
+        builtin_formatters.merge(default_elements).merge!(options[:error_formatters] || {})
       end
 
       def formatter_for(api_format, **options)

data/lib/grape/exceptions/base.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class Base < StandardError
-      BASE_MESSAGES_KEY = 'grape.errors.messages'.freeze
-      BASE_ATTRIBUTES_KEY = 'grape.errors.attributes'.freeze
+      BASE_MESSAGES_KEY = 'grape.errors.messages'
+      BASE_ATTRIBUTES_KEY = 'grape.errors.attributes'
       FALLBACK_LOCALE = :en
 
       attr_reader :status, :message, :headers
@@ -28,7 +30,7 @@ module Grape
           @problem = problem(key, **attributes)
           @summary = summary(key, **attributes)
           @resolution = resolution(key, **attributes)
-          [['Problem', @problem], ['Summary', @summary], ['Resolution', @resolution]].reduce('') do |message, detail_array|
+          [['Problem', @problem], ['Summary', @summary], ['Resolution', @resolution]].each_with_object(+'') do |detail_array, message|
             message << "\n#{detail_array[0]}:\n  #{detail_array[1]}" unless detail_array[1].blank?
             message
           end
@@ -37,16 +39,16 @@ module Grape
         end
       end
 
-      def problem(key, attributes)
-        translate_message("#{key}.problem".to_sym, attributes)
+      def problem(key, **attributes)
+        translate_message("#{key}.problem".to_sym, **attributes)
       end
 
-      def summary(key, attributes)
-        translate_message("#{key}.summary".to_sym, attributes)
+      def summary(key, **attributes)
+        translate_message("#{key}.summary".to_sym, **attributes)
       end
 
-      def resolution(key, attributes)
-        translate_message("#{key}.resolution".to_sym, attributes)
+      def resolution(key, **attributes)
+        translate_message("#{key}.resolution".to_sym, **attributes)
       end
 
       def translate_attributes(keys, **options)
@@ -55,10 +57,6 @@ module Grape
         end.join(', ')
       end
 
-      def translate_attribute(key, **options)
-        translate("#{BASE_ATTRIBUTES_KEY}.#{key}", default: key, **options)
-      end
-
       def translate_message(key, **options)
         case key
         when Symbol
@@ -71,8 +69,18 @@ module Grape
       end
 
       def translate(key, **options)
+        options = options.dup
+        options[:default] &&= options[:default].to_s
         message = ::I18n.translate(key, **options)
-        message.present? ? message : ::I18n.translate(key, locale: FALLBACK_LOCALE, **options)
+        message.present? ? message : fallback_message(key, **options)
+      end
+
+      def fallback_message(key, **options)
+        if ::I18n.enforce_available_locales && !::I18n.available_locales.include?(FALLBACK_LOCALE)
+          key
+        else
+          ::I18n.translate(key, locale: FALLBACK_LOCALE, **options)
+        end
       end
     end
   end

data/lib/grape/exceptions/empty_message_body.rb

@@ -0,0 +1,11 @@
+# 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/incompatible_option_values.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class IncompatibleOptionValues < Base

data/lib/grape/exceptions/invalid_accept_header.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class InvalidAcceptHeader < Base

data/lib/grape/exceptions/invalid_formatter.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class InvalidFormatter < Base

data/lib/grape/exceptions/invalid_message_body.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class InvalidMessageBody < Base

data/lib/grape/exceptions/invalid_response.rb

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

data/lib/grape/exceptions/invalid_version_header.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class InvalidVersionHeader < Base

data/lib/grape/exceptions/invalid_versioner_option.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class InvalidVersionerOption < Base

data/lib/grape/exceptions/invalid_with_option_for_represent.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class InvalidWithOptionForRepresent < Base

data/lib/grape/exceptions/method_not_allowed.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class MethodNotAllowed < Base

data/lib/grape/exceptions/missing_group_type.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class MissingGroupTypeError < Base

data/lib/grape/exceptions/missing_mime_type.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class MissingMimeType < Base

data/lib/grape/exceptions/missing_option.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class MissingOption < Base

data/lib/grape/exceptions/missing_vendor_option.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class MissingVendorOption < Base

data/lib/grape/exceptions/unknown_options.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class UnknownOptions < Base

data/lib/grape/exceptions/unknown_parameter.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class UnknownParameter < Base

data/lib/grape/exceptions/unknown_validator.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class UnknownValidator < Base

data/lib/grape/exceptions/unsupported_group_type.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class UnsupportedGroupTypeError < Base

data/lib/grape/exceptions/validation.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'grape/exceptions/base'
 
 module Grape
   module Exceptions
     class Validation < Grape::Exceptions::Base
-      attr_accessor :params
-      attr_accessor :message_key
+      attr_accessor :params, :message_key
 
       def initialize(params:, message: nil, **args)
         @params = params
@@ -12,10 +13,10 @@ module Grape
           @message_key = message if message.is_a?(Symbol)
           args[:message] = translate_message(message)
         end
-        super(args)
+        super(**args)
       end
 
-      # remove all the unnecessary stuff from Grape::Exceptions::Base like status
+      # Remove all the unnecessary stuff from Grape::Exceptions::Base like status
       # and headers when converting a validation error to json or string
       def as_json(*_args)
         to_s

data/lib/grape/exceptions/validation_array_errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Exceptions
     class ValidationArrayErrors < Base

data/lib/grape/exceptions/validation_errors.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 require 'grape/exceptions/base'
 
 module Grape
   module Exceptions
     class ValidationErrors < Grape::Exceptions::Base
+      ERRORS_FORMAT_KEY = 'grape.errors.format'
+      DEFAULT_ERRORS_FORMAT = '%{attributes} %{message}'
+
       include Enumerable
 
       attr_reader :errors
@@ -34,23 +39,21 @@ module Grape
         end
       end
 
-      def to_json(**_opts)
+      def to_json(*_opts)
         as_json.to_json
       end
 
       def full_messages
-        map { |attributes, error| full_message(attributes, error) }.uniq
-      end
-
-      private
-
-      def full_message(attributes, error)
-        I18n.t(
-          'grape.errors.format'.to_sym,
-          default: '%{attributes} %{message}',
-          attributes: attributes.count == 1 ? translate_attribute(attributes.first) : translate_attributes(attributes),
-          message: error.message
-        )
+        messages = map do |attributes, error|
+          I18n.t(
+            ERRORS_FORMAT_KEY,
+            default: DEFAULT_ERRORS_FORMAT,
+            attributes: translate_attributes(attributes),
+            message: error.message
+          )
+        end
+        messages.uniq!
+        messages
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Extensions
     module ActiveSupport
@@ -14,10 +16,9 @@ module Grape
           end
 
           def build_params
-            params = ::ActiveSupport::HashWithIndifferentAccess[rack_params]
+            params = ::ActiveSupport::HashWithIndifferentAccess.new(rack_params)
             params.deep_merge!(grape_routing_args) if env[Grape::Env::GRAPE_ROUTING_ARGS]
-            # TODO: remove, in Rails 4 or later ::ActiveSupport::HashWithIndifferentAccess converts nested Hashes into indifferent access ones
-            DeepHashWithIndifferentAccess.deep_hash_with_indifferent_access(params)
+            params
           end
         end
       end

data/lib/grape/extensions/deep_mergeable_hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Extensions
     class DeepMergeableHash < ::Hash

data/lib/grape/extensions/deep_symbolize_hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Extensions
     module DeepSymbolizeHash

data/lib/grape/extensions/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Extensions
     module Hash

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Extensions
     module Hashie

data/lib/grape/formatter/json.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Grape
   module Formatter
     module Json
       class << self
         def call(object, _env)
           return object.to_json if object.respond_to?(:to_json)
+
           ::Grape::Json.dump(object)
         end
       end

data/lib/grape/formatter/serializable_hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Formatter
     module SerializableHash
@@ -6,13 +8,14 @@ module Grape
           return object if object.is_a?(String)
           return ::Grape::Json.dump(serialize(object)) if serializable?(object)
           return object.to_json if object.respond_to?(:to_json)
+
           ::Grape::Json.dump(object)
         end
 
         private
 
         def serializable?(object)
-          object.respond_to?(:serializable_hash) || object.is_a?(Array) && object.all? { |o| o.respond_to? :serializable_hash } || object.is_a?(Hash)
+          object.respond_to?(:serializable_hash) || (object.is_a?(Array) && object.all? { |o| o.respond_to? :serializable_hash }) || object.is_a?(Hash)
         end
 
         def serialize(object)

data/lib/grape/formatter/txt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Formatter
     module Txt

data/lib/grape/formatter/xml.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 module Grape
   module Formatter
     module Xml
       class << self
         def call(object, _env)
           return object.to_xml if object.respond_to?(:to_xml)
+
           raise Grape::Exceptions::InvalidFormatter.new(object.class, 'xml')
         end
       end

data/lib/grape/formatter.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Grape
   module Formatter
     extend Util::Registrable
 
     class << self
-      def builtin_formmaters
+      def builtin_formatters
         @builtin_formatters ||= {
           json: Grape::Formatter::Json,
           jsonapi: Grape::Formatter::Json,
@@ -13,8 +15,8 @@ module Grape
         }
       end
 
-      def formatters(options)
-        builtin_formmaters.merge(default_elements).merge(options[:formatters] || {})
+      def formatters(**options)
+        builtin_formatters.merge(default_elements).merge!(options[:formatters] || {})
       end
 
       def formatter_for(api_format, **options)

data/lib/grape/http/headers.rb

@@ -1,29 +1,61 @@
+# frozen_string_literal: true
+
+require 'grape/util/lazy_object'
+
 module Grape
   module Http
     module Headers
       # https://github.com/rack/rack/blob/master/lib/rack.rb
-      HTTP_VERSION    = 'HTTP_VERSION'.freeze
-      PATH_INFO       = 'PATH_INFO'.freeze
-      REQUEST_METHOD  = 'REQUEST_METHOD'.freeze
-      QUERY_STRING    = 'QUERY_STRING'.freeze
-      CONTENT_TYPE    = 'Content-Type'.freeze
-
-      GET     = 'GET'.freeze
-      POST    = 'POST'.freeze
-      PUT     = 'PUT'.freeze
-      PATCH   = 'PATCH'.freeze
-      DELETE  = 'DELETE'.freeze
-      HEAD    = 'HEAD'.freeze
-      OPTIONS = 'OPTIONS'.freeze
+      HTTP_VERSION    = 'HTTP_VERSION'
+      PATH_INFO       = 'PATH_INFO'
+      REQUEST_METHOD  = 'REQUEST_METHOD'
+      QUERY_STRING    = 'QUERY_STRING'
+      CONTENT_TYPE    = 'Content-Type'
+
+      GET     = 'GET'
+      POST    = 'POST'
+      PUT     = 'PUT'
+      PATCH   = 'PATCH'
+      DELETE  = 'DELETE'
+      HEAD    = 'HEAD'
+      OPTIONS = 'OPTIONS'
 
       SUPPORTED_METHODS = [GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS].freeze
+      SUPPORTED_METHODS_WITHOUT_OPTIONS = Grape::Util::LazyObject.new { [GET, POST, PUT, PATCH, DELETE, HEAD].freeze }
+
+      HTTP_ACCEPT_VERSION    = 'HTTP_ACCEPT_VERSION'
+      X_CASCADE              = 'X-Cascade'
+      HTTP_TRANSFER_ENCODING = 'HTTP_TRANSFER_ENCODING'
+      HTTP_ACCEPT            = 'HTTP_ACCEPT'
+
+      FORMAT                 = 'format'
 
-      HTTP_ACCEPT_VERSION    = 'HTTP_ACCEPT_VERSION'.freeze
-      X_CASCADE              = 'X-Cascade'.freeze
-      HTTP_TRANSFER_ENCODING = 'HTTP_TRANSFER_ENCODING'.freeze
-      HTTP_ACCEPT            = 'HTTP_ACCEPT'.freeze
+      HTTP_HEADERS = Grape::Util::LazyObject.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
 
-      FORMAT                 = 'format'.freeze
+      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/locale/en.yml

@@ -9,6 +9,7 @@ en:
         blank: 'is empty'
         values: 'does not have a valid value'
         except_values: 'has a value not allowed'
+        same_as: 'is not the same as %{parameter}'
         missing_vendor_option:
           problem: 'missing :vendor option.'
           summary: 'when version using header, you must specify :vendor option. '
@@ -43,10 +44,11 @@ en:
             "when specifying %{body_format} as content-type, you must pass valid
             %{body_format} in the request's 'body'
             "
+        empty_message_body: 'Empty message body supplied with %{body_format} content-type'
         invalid_accept_header:
           problem: 'Invalid accept header'
           resolution: '%{message}'
         invalid_version_header:
           problem: 'Invalid version header'
           resolution: '%{message}'
-
+        invalid_response: 'Invalid response'