grape 1.1.0 → 1.2.5

data/lib/grape/dsl/middleware.rb

@@ -21,6 +21,13 @@ module Grape
           namespace_stackable(:middleware, arr)
         end
 
+        def insert(*args, &block)
+          arr = [:insert, *args]
+          arr << block if block_given?
+
+          namespace_stackable(:middleware, arr)
+        end
+
         def insert_before(*args, &block)
           arr = [:insert_before, *args]
           arr << block if block_given?

data/lib/grape/dsl/parameters.rb

@@ -211,10 +211,15 @@ module Grape
       # block yet.
       # @return [Boolean] whether the parameter has been defined
       def declared_param?(param)
-        # @declared_params also includes hashes of options and such, but those
-        # won't be flattened out.
-        @declared_params.flatten.any? do |declared_param|
-          first_hash_key_or_param(declared_param) == param
+        if lateral?
+          # Elements of @declared_params of lateral scope are pushed in @parent. So check them in @parent.
+          @parent.declared_param?(param)
+        else
+          # @declared_params also includes hashes of options and such, but those
+          # won't be flattened out.
+          @declared_params.flatten.any? do |declared_param|
+            first_hash_key_or_param(declared_param) == param
+          end
         end
       end
 

data/lib/grape/dsl/routing.rb

@@ -77,9 +77,13 @@ module Grape
           namespace_inheritable(:do_not_route_options, true)
         end
 
-        def mount(mounts)
+        def mount(mounts, opts = {})
           mounts = { mounts => '/' } unless mounts.respond_to?(:each_pair)
           mounts.each_pair do |app, path|
+            if app.respond_to?(:mount_instance)
+              mount(app.mount_instance(configuration: opts[:with] || {}) => path)
+              next
+            end
             in_setting = inheritable_setting
 
             if app.respond_to?(:inheritable_setting, true)

data/lib/grape/dsl/validations.rb

@@ -27,10 +27,11 @@ module Grape
           setting = description_field(:params)
           setting ||= description_field(:params, {})
           Array(names).each do |name|
-            setting[name[:full_name].to_s] ||= {}
-            setting[name[:full_name].to_s].merge!(opts)
+            full_name = name[:full_name].to_s
+            setting[full_name] ||= {}
+            setting[full_name].merge!(opts)
 
-            namespace_stackable(:params, name[:full_name].to_s => opts)
+            namespace_stackable(:params, full_name => opts)
           end
         end
       end

data/lib/grape/eager_load.rb

@@ -0,0 +1,18 @@
+Grape.eager_load!
+Grape::Http.eager_load!
+Grape::Exceptions.eager_load!
+Grape::Extensions.eager_load!
+Grape::Extensions::ActiveSupport.eager_load!
+Grape::Extensions::Hashie.eager_load!
+Grape::Middleware.eager_load!
+Grape::Middleware::Auth.eager_load!
+Grape::Middleware::Versioner.eager_load!
+Grape::Util.eager_load!
+Grape::ErrorFormatter.eager_load!
+Grape::Formatter.eager_load!
+Grape::Parser.eager_load!
+Grape::DSL.eager_load!
+Grape::API.eager_load!
+Grape::Presenters.eager_load!
+Grape::ServeFile.eager_load!
+Rack::Head # AutoLoads the Rack::Head

data/lib/grape/endpoint.rb

@@ -200,7 +200,7 @@ module Grape
     end
 
     def merge_route_options(**default)
-      options[:route_options].clone.reverse_merge(**default)
+      options[:route_options].clone.merge!(**default)
     end
 
     def map_routes
@@ -245,32 +245,37 @@ module Grape
         @request = Grape::Request.new(env, build_params_with: namespace_inheritable(:build_params_with))
         @params = @request.params
         @headers = @request.headers
+        begin
+          cookies.read(@request)
+          self.class.run_before_each(self)
+          run_filters befores, :before
+
+          if (allowed_methods = env[Grape::Env::GRAPE_ALLOWED_METHODS])
+            raise Grape::Exceptions::MethodNotAllowed, header.merge('Allow' => allowed_methods) unless options?
+            header 'Allow', allowed_methods
+            response_object = ''
+            status 204
+          else
+            run_filters before_validations, :before_validation
+            run_validators validations, request
+            remove_renamed_params
+            run_filters after_validations, :after_validation
+            response_object = @block ? @block.call(self) : nil
+          end
 
-        cookies.read(@request)
-        self.class.run_before_each(self)
-        run_filters befores, :before
+          run_filters afters, :after
+          cookies.write(header)
 
-        if (allowed_methods = env[Grape::Env::GRAPE_ALLOWED_METHODS])
-          raise Grape::Exceptions::MethodNotAllowed, header.merge('Allow' => allowed_methods) unless options?
-          header 'Allow', allowed_methods
-          response_object = ''
-          status 204
-        else
-          run_filters before_validations, :before_validation
-          run_validators validations, request
-          run_filters after_validations, :after_validation
-          response_object = @block ? @block.call(self) : nil
-        end
+          # status verifies body presence when DELETE
+          @body ||= response_object
 
-        run_filters afters, :after
-        cookies.write(header)
+          # The body commonly is an Array of Strings, the application instance itself, or a File-like object
+          response_object = file || [body]
 
-        # status verifies body presence when DELETE
-        @body ||= response_object
-
-        # The Body commonly is an Array of Strings, the application instance itself, or a File-like object
-        response_object = file || [body]
-        [status, header, response_object]
+          [status, header, response_object]
+        ensure
+          run_filters finallies, :finally
+        end
       end
     end
 
@@ -319,7 +324,14 @@ module Grape
       Module.new { helpers.each { |mod_to_include| include mod_to_include } }
     end
 
-    private :build_stack, :build_helpers
+    def remove_renamed_params
+      return unless route_setting(:renamed_params)
+      route_setting(:renamed_params).flat_map(&:keys).each do |renamed_param|
+        @params.delete(renamed_param)
+      end
+    end
+
+    private :build_stack, :build_helpers, :remove_renamed_params
 
     def helpers
       lazy_initialize! && @helpers
@@ -341,7 +353,7 @@ module Grape
     def run_validators(validator_factories, request)
       validation_errors = []
 
-      validators = validator_factories.map(&:create_validator)
+      validators = validator_factories.map { |options| Grape::Validations::ValidatorFactory.create_validator(options) }
 
       ActiveSupport::Notifications.instrument('endpoint_run_validators.grape', endpoint: self, validators: validators, request: request) do
         validators.each do |validator|
@@ -351,7 +363,7 @@ module Grape
             validation_errors << e
             break if validator.fail_fast?
           rescue Grape::Exceptions::ValidationArrayErrors => e
-            validation_errors += e.errors
+            validation_errors.concat e.errors
             break if validator.fail_fast?
           end
         end
@@ -384,6 +396,10 @@ module Grape
       namespace_stackable(:afters) || []
     end
 
+    def finallies
+      namespace_stackable(:finallies) || []
+    end
+
     def validations
       route_setting(:saved_validations) || []
     end

data/lib/grape/error_formatter.rb

@@ -14,7 +14,7 @@ module Grape
       end
 
       def formatters(options)
-        builtin_formatters.merge(default_elements).merge(options[:error_formatters] || {})
+        builtin_formatters.merge(default_elements).merge!(options[:error_formatters] || {})
       end
 
       def formatter_for(api_format, **options)

data/lib/grape/exceptions/base.rb

@@ -74,7 +74,15 @@ module Grape
         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/invalid_response.rb

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

data/lib/grape/exceptions/validation_errors.rb

@@ -39,14 +39,16 @@ module Grape
       end
 
       def full_messages
-        map { |attributes, error| full_message(attributes, error) }.uniq
+        messages = map { |attributes, error| full_message(attributes, error) }
+        messages.uniq!
+        messages
       end
 
       private
 
       def full_message(attributes, error)
         I18n.t(
-          'grape.errors.format'.to_sym,
+          'grape.errors.format',
           default: '%{attributes} %{message}',
           attributes: attributes.count == 1 ? translate_attribute(attributes.first) : translate_attributes(attributes),
           message: error.message

data/lib/grape/formatter.rb

@@ -14,7 +14,7 @@ module Grape
       end
 
       def formatters(options)
-        builtin_formmaters.merge(default_elements).merge(options[:formatters] || {})
+        builtin_formmaters.merge(default_elements).merge!(options[:formatters] || {})
       end
 
       def formatter_for(api_format, **options)

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. '
@@ -49,4 +50,5 @@ en:
         invalid_version_header:
           problem: 'Invalid version header'
           resolution: '%{message}'
+        invalid_response: 'Invalid response'
 

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

@@ -4,6 +4,8 @@ module Grape
   module Middleware
     module Auth
       class Base
+        include Helpers
+
         attr_accessor :options, :app, :env
 
         def initialize(app, **options)
@@ -11,10 +13,6 @@ module Grape
           @options = options
         end
 
-        def context
-          env[Grape::Env::API_ENDPOINT]
-        end
-
         def call(env)
           dup._call(env)
         end

data/lib/grape/middleware/base.rb

@@ -3,6 +3,8 @@ require 'grape/dsl/headers'
 module Grape
   module Middleware
     class Base
+      include Helpers
+
       attr_reader :app, :env, :options
       TEXT_HTML = 'text/html'.freeze
 

data/lib/grape/middleware/error.rb

@@ -21,7 +21,7 @@ module Grape
           },
           rescue_handlers: {}, # rescue handler blocks
           base_only_rescue_handlers: {}, # rescue handler blocks rescuing only the base class
-          all_rescue_handler: nil # rescue handler block to rescue from all exceptions
+          all_rescue_handler: nil, # rescue handler block to rescue from all exceptions
         }
       end
 
@@ -32,7 +32,6 @@ module Grape
 
       def call!(env)
         @env = env
-
         begin
           error_response(catch(:error) do
             return @app.call(@env)
@@ -73,7 +72,7 @@ module Grape
         if headers[Grape::Http::Headers::CONTENT_TYPE] == TEXT_HTML
           message = ERB::Util.html_escape(message)
         end
-        Rack::Response.new([message], status, headers).finish
+        Rack::Response.new([message], status, headers)
       end
 
       def format_message(message, backtrace, original_exception = nil)
@@ -127,7 +126,13 @@ module Grape
           handler = public_method(handler)
         end
 
-        handler.arity.zero? ? instance_exec(&handler) : instance_exec(error, &handler)
+        response = handler.arity.zero? ? instance_exec(&handler) : instance_exec(error, &handler)
+
+        if response.is_a?(Rack::Response)
+          response
+        else
+          run_rescue_handler(:default_rescue_handler, Grape::Exceptions::InvalidResponse.new)
+        end
       end
     end
   end

data/lib/grape/middleware/helpers.rb

@@ -0,0 +1,10 @@
+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/middleware/stack.rb

@@ -96,7 +96,7 @@ module Grape
       # @param [Array] other_specs An array of middleware specifications (e.g. [[:use, klass], [:insert_before, *args]])
       def concat(other_specs)
         @others << Array(other_specs).reject { |o| o.first == :use }
-        merge_with Array(other_specs).select { |o| o.first == :use }
+        merge_with(Array(other_specs).select { |o| o.first == :use })
       end
 
       protected

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

@@ -99,7 +99,7 @@ module Grape
         def available_media_types
           available_media_types = []
 
-          content_types.each do |extension, _media_type|
+          content_types.each_key do |extension|
             versions.reverse_each do |version|
               available_media_types += [
                 "application/vnd.#{vendor}-#{version}+#{extension}",
@@ -111,7 +111,7 @@ module Grape
 
           available_media_types << "application/vnd.#{vendor}"
 
-          content_types.each do |_, media_type|
+          content_types.each_value do |media_type|
             available_media_types << media_type
           end
 
@@ -173,7 +173,7 @@ module Grape
         # @return [Boolean] whether the content type sets a vendor
         def vendor?(media_type)
           _, subtype = Rack::Accept::Header.parse_media_type(media_type)
-          subtype[HAS_VENDOR_REGEX]
+          subtype.present? && subtype[HAS_VENDOR_REGEX]
         end
 
         def request_vendor(media_type)
@@ -190,7 +190,7 @@ module Grape
         # @return [Boolean] whether the content type sets an API version
         def version?(media_type)
           _, subtype = Rack::Accept::Header.parse_media_type(media_type)
-          subtype[HAS_VERSION_REGEX]
+          subtype.present? && subtype[HAS_VERSION_REGEX]
         end
       end
     end

data/lib/grape/parser.rb

@@ -12,7 +12,7 @@ module Grape
       end
 
       def parsers(options)
-        builtin_parsers.merge(default_elements).merge(options[:parsers] || {})
+        builtin_parsers.merge(default_elements).merge!(options[:parsers] || {})
       end
 
       def parser_for(api_format, **options)

data/lib/grape/request.rb

@@ -5,7 +5,7 @@ module Grape
     alias rack_params params
 
     def initialize(env, options = {})
-      extend options[:build_params_with] || Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder
+      extend options[:build_params_with] || Grape.config.param_builder
       super(env)
     end
 

data/lib/grape/router/attribute_translator.rb

@@ -15,6 +15,8 @@ module Grape
           @attributes[m[0..-1]] = *args
         elsif m[-1] != '='
           @attributes[m]
+        else
+          super
         end
       end
 

data/lib/grape/router/route.rb

@@ -98,9 +98,9 @@ module Grape
         path, line = *location.scan(SOURCE_LOCATION_REGEXP).first
         path = File.realpath(path) if Pathname.new(path).relative?
         expected ||= name
-        warn <<-EOS
+        warn <<-WARNING
 #{path}:#{line}: The route_xxx methods such as route_#{name} have been deprecated, please use #{expected}.
-        EOS
+        WARNING
       end
     end
   end