grape 1.2.5 → 1.4.0

data/lib/grape/exceptions/invalid_versioner_option.rb

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

data/lib/grape/exceptions/invalid_with_option_for_represent.rb

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

data/lib/grape/exceptions/method_not_allowed.rb

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

data/lib/grape/exceptions/missing_group_type.rb

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

data/lib/grape/exceptions/missing_mime_type.rb

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

data/lib/grape/exceptions/missing_option.rb

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

data/lib/grape/exceptions/missing_vendor_option.rb

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

data/lib/grape/exceptions/unknown_options.rb

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

data/lib/grape/exceptions/unknown_parameter.rb

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

data/lib/grape/exceptions/unknown_validator.rb

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

data/lib/grape/exceptions/unsupported_group_type.rb

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

data/lib/grape/exceptions/validation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/exceptions/base'
 
 module Grape
@@ -12,7 +14,7 @@ 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

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
@@ -39,21 +44,17 @@ module Grape
       end
 
       def full_messages
-        messages = map { |attributes, error| full_message(attributes, error) }
+        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
-
-      private
-
-      def full_message(attributes, error)
-        I18n.t(
-          'grape.errors.format',
-          default: '%{attributes} %{message}',
-          attributes: attributes.count == 1 ? translate_attribute(attributes.first) : translate_attributes(attributes),
-          message: error.message
-        )
-      end
     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.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/formatter/json.rb

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

data/lib/grape/formatter/serializable_hash.rb

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

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Formatter
     module Xml

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/middleware/auth/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/auth/basic'
 
 module Grape

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/auth/basic'
 require 'active_support/concern'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Middleware
     module Auth

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Middleware
     module Auth

data/lib/grape/middleware/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/dsl/headers'
 
 module Grape
@@ -6,15 +8,15 @@ module Grape
       include Helpers
 
       attr_reader :app, :env, :options
-      TEXT_HTML = 'text/html'.freeze
+      TEXT_HTML = 'text/html'
 
       include Grape::DSL::Headers
 
       # @param [Rack Application] app The standard argument for a Rack middleware.
       # @param [Hash] options A hash of options, simply stored for use by subclasses.
-      def initialize(app, **options)
+      def initialize(app, options = {})
         @app = app
-        @options = default_options.merge(**options)
+        @options = default_options.merge(options)
         @app_response = nil
       end
 
@@ -23,7 +25,7 @@ module Grape
       end
 
       def call(env)
-        dup.call!(env)
+        dup.call!(env).to_a
       end
 
       def call!(env)
@@ -72,11 +74,9 @@ module Grape
       end
 
       def mime_types
-        types_without_params = {}
-        content_types.each_pair do |k, v|
+        @mime_type ||= content_types.each_pair.with_object({}) do |(k, v), types_without_params|
           types_without_params[v.split(';').first] = k
         end
-        types_without_params
       end
 
       private

data/lib/grape/middleware/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape/middleware/base'
 require 'active_support/core_ext/string/output_safety'
 
@@ -77,7 +79,7 @@ module Grape
 
       def format_message(message, backtrace, original_exception = nil)
         format = env[Grape::Env::API_FORMAT] || options[:format]
-        formatter = Grape::ErrorFormatter.formatter_for(format, options)
+        formatter = Grape::ErrorFormatter.formatter_for(format, **options)
         throw :error,
               status: 406,
               message: "The requested format '#{format}' is not supported.",

data/lib/grape/middleware/filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module Middleware
     # This is a simple middleware for adding before and after filters

data/lib/grape/middleware/formatter.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'grape/middleware/base'
 
 module Grape
   module Middleware
     class Formatter < Base
-      CHUNKED = 'chunked'.freeze
+      CHUNKED = 'chunked'
 
       def default_options
         {
@@ -34,9 +36,9 @@ module Grape
       def build_formatted_response(status, headers, bodies)
         headers = ensure_content_type(headers)
 
-        if bodies.is_a?(Grape::ServeFile::FileResponse)
-          Grape::ServeFile::SendfileResponse.new([], status, headers) do |resp|
-            resp.body = bodies.file
+        if bodies.is_a?(Grape::ServeStream::StreamResponse)
+          Grape::ServeStream::SendfileResponse.new([], status, headers) do |resp|
+            resp.body = bodies.stream
           end
         else
           # Allow content-type to be explicitly overwritten
@@ -52,7 +54,7 @@ module Grape
 
       def fetch_formatter(headers, options)
         api_format = mime_types[headers[Grape::Http::Headers::CONTENT_TYPE]] || env[Grape::Env::API_FORMAT]
-        Grape::Formatter.formatter_for(api_format, options)
+        Grape::Formatter.formatter_for(api_format, **options)
       end
 
       # Set the content type header for the API format if it is not already present.
@@ -97,7 +99,7 @@ module Grape
         unless content_type_for(fmt)
           throw :error, status: 415, message: "The provided content-type '#{request.media_type}' is not supported."
         end
-        parser = Grape::Parser.parser_for fmt, options
+        parser = Grape::Parser.parser_for fmt, **options
         if parser
           begin
             body = (env[Grape::Env::API_REQUEST_BODY] = parser.call(body, env))