grape 0.17.0 → 0.18.0

data/UPGRADING.md

@@ -526,7 +526,7 @@ Permitted and default parameter values are now only evaluated lazily for each re
 
 ```ruby
 params do
-  optional :v, values: -> { [:x, :y] }, default: -> { :z } }
+  optional :v, values: -> { [:x, :y] }, default: -> { :z }
 end
 ```
 
@@ -534,7 +534,7 @@ Remove the proc to get the previous behavior.
 
 ```ruby
 params do
-  optional :v, values: [:x, :y], default: :z }
+  optional :v, values: [:x, :y], default: :z
 end
 ```
 

data/grape.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
 
   s.add_runtime_dependency 'rack', '>= 1.3.0'
-  s.add_runtime_dependency 'mustermann19', '~> 0.4.3'
+  s.add_runtime_dependency 'mustermann-grape', '~> 0.4.0'
   s.add_runtime_dependency 'rack-accept'
   s.add_runtime_dependency 'activesupport'
   s.add_runtime_dependency 'multi_json', '>= 1.3.2'

data/lib/grape/api.rb

@@ -173,7 +173,6 @@ module Grape
         without_versioning do
           routes_map.each do |_, config|
             methods = config[:methods]
-            path = config[:path]
             allowed_methods = methods.dup
 
             unless self.class.namespace_inheritable(:do_not_route_head)
@@ -182,8 +181,8 @@ module Grape
 
             allow_header = (self.class.namespace_inheritable(:do_not_route_options) ? allowed_methods : [Grape::Http::Headers::OPTIONS] | allowed_methods).join(', ')
 
-            unless self.class.namespace_inheritable(:do_not_route_options)
-              generate_options_method(path, allow_header, config) unless allowed_methods.include?(Grape::Http::Headers::OPTIONS)
+            unless self.class.namespace_inheritable(:do_not_route_options) || allowed_methods.include?(Grape::Http::Headers::OPTIONS)
+              config[:endpoint].options[:options_route_enabled] = true
             end
 
             attributes = config.merge(allowed_methods: allowed_methods, allow_header: allow_header)
@@ -193,24 +192,15 @@ module Grape
       end
     end
 
-    # Generate an 'OPTIONS' route for a pre-exisiting user defined route
-    def generate_options_method(path, allow_header, options = {})
-      self.class.options(path, options) do
-        header 'Allow', allow_header
-        status 204
-        ''
-      end
-    end
-
     # Generate a route that returns an HTTP 405 response for a user defined
     # path on methods not specified
-    def generate_not_allowed_method(pattern, attributes = {})
-      not_allowed_methods = %w(GET PUT POST DELETE PATCH HEAD) - attributes[:allowed_methods]
+    def generate_not_allowed_method(pattern, allowed_methods: [], **attributes)
+      not_allowed_methods = %w(GET PUT POST DELETE PATCH HEAD) - allowed_methods
       not_allowed_methods << Grape::Http::Headers::OPTIONS if self.class.namespace_inheritable(:do_not_route_options)
 
       return if not_allowed_methods.empty?
 
-      @router.associate_routes(pattern, attributes.merge(not_allowed_methods: not_allowed_methods))
+      @router.associate_routes(pattern, not_allowed_methods: not_allowed_methods, **attributes)
     end
 
     # Allows definition of endpoints that ignore the versioning configuration

data/lib/grape/cookies.rb

@@ -31,7 +31,7 @@ module Grape
       @cookies.each(&block)
     end
 
-    def delete(name, opts = {})
+    def delete(name, **opts)
       options = opts.merge(value: 'deleted', expires: Time.at(0))
       self.[]=(name, options)
     end

data/lib/grape/dsl/inside_route.rb

@@ -97,9 +97,8 @@ module Grape
       # @param options [Hash] The options used when redirect.
       #                       :permanent, default false.
       #                       :body, default a short message including the URL.
-      def redirect(url, options = {})
-        permanent = options.fetch(:permanent, false)
-        body_message = options.fetch(:body, nil)
+      def redirect(url, permanent: false, body: nil, **_options)
+        body_message = body
         if permanent
           status 301
           body_message ||= "This resource has been moved permanently to #{url}."

data/lib/grape/dsl/request_response.rb

@@ -88,7 +88,7 @@ module Grape
         #       rescue_from CustomError
         #     end
         #
-        # @overload rescue_from(*exception_classes, options = {})
+        # @overload rescue_from(*exception_classes, **options)
         #   @param [Array] exception_classes A list of classes that you want to rescue, or
         #     the symbol :all to rescue from all exceptions.
         #   @param [Block] block Execution block to handle the given exception.

data/lib/grape/endpoint.rb

@@ -194,8 +194,8 @@ module Grape
       version.length == 1 ? version.first.to_s : version
     end
 
-    def merge_route_options(default = {})
-      options[:route_options].clone.reverse_merge(default)
+    def merge_route_options(**default)
+      options[:route_options].clone.reverse_merge(**default)
     end
 
     def map_routes
@@ -248,16 +248,21 @@ module Grape
 
         run_filters befores, :before
 
-        allowed_methods = env[Grape::Env::GRAPE_METHOD_NOT_ALLOWED]
-        raise Grape::Exceptions::MethodNotAllowed, header.merge('Allow' => allowed_methods) if allowed_methods
+        allowed_methods = env[Grape::Env::GRAPE_ALLOWED_METHODS]
+        raise Grape::Exceptions::MethodNotAllowed, header.merge('Allow' => allowed_methods) if !options? && allowed_methods
 
         run_filters before_validations, :before_validation
-
         run_validators validations, request
-
         run_filters after_validations, :after_validation
 
-        response_object = @block ? @block.call(self) : nil
+        response_object =
+          if options?
+            header 'Allow', allowed_methods
+            status 204
+            ''
+          else
+            @block ? @block.call(self) : nil
+          end
         run_filters afters, :after
         cookies.write(header)
 
@@ -338,8 +343,10 @@ module Grape
           validator.validate(request)
         rescue Grape::Exceptions::Validation => e
           validation_errors << e
+          break if validator.fail_fast?
         rescue Grape::Exceptions::ValidationArrayErrors => e
           validation_errors += e.errors
+          break if validator.fail_fast?
         end
       end
 
@@ -373,5 +380,10 @@ module Grape
     def validations
       route_setting(:saved_validations) || []
     end
+
+    def options?
+      options[:options_route_enabled] &&
+        env[Grape::Http::Headers::REQUEST_METHOD] == Grape::Http::Headers::OPTIONS
+    end
   end
 end

data/lib/grape/error_formatter.rb

@@ -17,8 +17,8 @@ module Grape
         builtin_formatters.merge(default_elements).merge(options[:error_formatters] || {})
       end
 
-      def formatter_for(api_format, options = {})
-        spec = formatters(options)[api_format]
+      def formatter_for(api_format, **options)
+        spec = formatters(**options)[api_format]
         case spec
         when nil
           options[:default_error_formatter] || Grape::ErrorFormatter::Txt

data/lib/grape/exceptions/base.rb

@@ -7,10 +7,10 @@ module Grape
 
       attr_reader :status, :message, :headers
 
-      def initialize(args = {})
-        @status = args[:status] || nil
-        @message = args[:message] || nil
-        @headers = args[:headers] || nil
+      def initialize(status: nil, message: nil, headers: nil, **_options)
+        @status  = status
+        @message = message
+        @headers = headers
       end
 
       def [](index)
@@ -22,12 +22,12 @@ module Grape
       # 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, **attributes)
+        short_message = translate_message(key, **attributes)
         if short_message.is_a? Hash
-          @problem = problem(key, attributes)
-          @summary = summary(key, attributes)
-          @resolution = resolution(key, attributes)
+          @problem = problem(key, **attributes)
+          @summary = summary(key, **attributes)
+          @resolution = resolution(key, **attributes)
           [['Problem', @problem], ['Summary', @summary], ['Resolution', @resolution]].reduce('') do |message, detail_array|
             message << "\n#{detail_array[0]}:\n  #{detail_array[1]}" unless detail_array[1].blank?
             message
@@ -49,20 +49,20 @@ module Grape
         translate_message("#{key}.resolution".to_sym, attributes)
       end
 
-      def translate_attributes(keys, options = {})
+      def translate_attributes(keys, **options)
         keys.map do |key|
-          translate("#{BASE_ATTRIBUTES_KEY}.#{key}", options.reverse_merge(default: key))
+          translate("#{BASE_ATTRIBUTES_KEY}.#{key}", default: key, **options)
         end.join(', ')
       end
 
-      def translate_attribute(key, options = {})
-        translate("#{BASE_ATTRIBUTES_KEY}.#{key}", options.reverse_merge(default: key))
+      def translate_attribute(key, **options)
+        translate("#{BASE_ATTRIBUTES_KEY}.#{key}", default: key, **options)
       end
 
-      def translate_message(key, options = {})
+      def translate_message(key, **options)
         case key
         when Symbol
-          translate("#{BASE_MESSAGES_KEY}.#{key}", options.reverse_merge(default: ''))
+          translate("#{BASE_MESSAGES_KEY}.#{key}", default: '', **options)
         when Proc
           key.call
         else
@@ -70,9 +70,9 @@ module Grape
         end
       end
 
-      def translate(key, options = {})
-        message = ::I18n.translate(key, options)
-        message.present? ? message : ::I18n.translate(key, options.merge(locale: FALLBACK_LOCALE))
+      def translate(key, **options)
+        message = ::I18n.translate(key, **options)
+        message.present? ? message : ::I18n.translate(key, locale: FALLBACK_LOCALE, **options)
       end
     end
   end

data/lib/grape/exceptions/validation.rb

@@ -6,14 +6,13 @@ module Grape
       attr_accessor :params
       attr_accessor :message_key
 
-      def initialize(args = {})
-        raise 'Params are missing:' unless args.key? :params
-        @params = args[:params]
-        if args.key?(:message)
-          @message_key = args[:message] if args[:message].is_a?(Symbol)
-          args[:message] = translate_message(args[:message])
+      def initialize(params:, message: nil, **args)
+        @params = params
+        if message
+          @message_key = message if message.is_a?(Symbol)
+          args[:message] = translate_message(message)
         end
-        super
+        super(args)
       end
 
       # remove all the unnecessary stuff from Grape::Exceptions::Base like status

data/lib/grape/exceptions/validation_errors.rb

@@ -7,14 +7,14 @@ module Grape
 
       attr_reader :errors
 
-      def initialize(args = {})
+      def initialize(errors: [], headers: {}, **_options)
         @errors = {}
-        args[:errors].each do |validation_error|
+        errors.each do |validation_error|
           @errors[validation_error.params] ||= []
           @errors[validation_error.params] << validation_error
         end
 
-        super message: full_messages.join(', '), status: 400, headers: args[:headers]
+        super message: full_messages.join(', '), status: 400, headers: headers
       end
 
       def each
@@ -25,7 +25,7 @@ module Grape
         end
       end
 
-      def as_json(_opts = {})
+      def as_json(**_opts)
         errors.map do |k, v|
           {
             params: k,
@@ -34,7 +34,7 @@ module Grape
         end
       end
 
-      def to_json(_opts = {})
+      def to_json(**_opts)
         as_json.to_json
       end
 

data/lib/grape/formatter.rb

@@ -17,8 +17,8 @@ module Grape
         builtin_formmaters.merge(default_elements).merge(options[:formatters] || {})
       end
 
-      def formatter_for(api_format, options = {})
-        spec = formatters(options)[api_format]
+      def formatter_for(api_format, **options)
+        spec = formatters(**options)[api_format]
         case spec
         when nil
           ->(obj, _env) { obj }

data/lib/grape/locale/en.yml

@@ -8,6 +8,7 @@ en:
         regexp: 'is invalid'
         blank: 'is empty'
         values: 'does not have a valid value'
+        except: 'has a value not allowed'
         missing_vendor_option:
           problem: 'missing :vendor option.'
           summary: 'when version using header, you must specify :vendor option. '

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

@@ -6,9 +6,9 @@ module Grape
       class Base
         attr_accessor :options, :app, :env
 
-        def initialize(app, options = {})
+        def initialize(app, **options)
           @app = app
-          @options = options || {}
+          @options = options
         end
 
         def context

data/lib/grape/middleware/base.rb

@@ -10,9 +10,9 @@ module Grape
 
       # @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)
       end
 
       def default_options

data/lib/grape/middleware/error.rb

@@ -21,7 +21,7 @@ module Grape
         }
       end
 
-      def initialize(app, options = {})
+      def initialize(app, **options)
         super
         self.class.send(:include, @options[:helpers]) if @options[:helpers]
       end

data/lib/grape/middleware/stack.rb

@@ -21,7 +21,7 @@ module Grape
           when Middleware
             klass == other.klass
           when Class
-            klass == other
+            klass == other || (name.nil? && klass.superclass == other)
           end
         end
 

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

@@ -32,7 +32,7 @@ module Grape
         def before
           strict_header_checks if strict?
 
-          if media_type || env[Grape::Env::GRAPE_METHOD_NOT_ALLOWED]
+          if media_type || env[Grape::Env::GRAPE_ALLOWED_METHODS]
             media_type_header_handler
           elsif headers_contain_wrong_vendor?
             fail_with_invalid_accept_header!('API vendor not found.')

data/lib/grape/namespace.rb

@@ -10,7 +10,7 @@ module Grape
     # @option options :requirements [Hash] param-regex pairs, all of which must
     #   be met by a request's params for all endpoints in this namespace, or
     #   validation will fail and return a 422.
-    def initialize(space, options = {})
+    def initialize(space, **options)
       @space = space.to_s
       @options = options
     end

data/lib/grape/parser.rb

@@ -15,8 +15,8 @@ module Grape
         builtin_parsers.merge(default_elements).merge(options[:parsers] || {})
       end
 
-      def parser_for(api_format, options = {})
-        spec = parsers(options)[api_format]
+      def parser_for(api_format, **options)
+        spec = parsers(**options)[api_format]
         case spec
         when nil
           nil

data/lib/grape/presenters/presenter.rb

@@ -1,7 +1,7 @@
 module Grape
   module Presenters
     class Presenter
-      def self.represent(object, _options = {})
+      def self.represent(object, **_options)
         object
       end
     end

data/lib/grape/router.rb

@@ -5,7 +5,7 @@ module Grape
     attr_reader :map, :compiled
 
     class Any < AttributeTranslator
-      def initialize(pattern, attributes = {})
+      def initialize(pattern, **attributes)
         @pattern = pattern
         super(attributes)
       end
@@ -42,9 +42,9 @@ module Grape
       map[route.request_method.to_s.upcase] << route
     end
 
-    def associate_routes(pattern, options = {})
+    def associate_routes(pattern, **options)
       regexp = /(?<_#{@neutral_map.length}>)#{pattern.to_regexp}/
-      @neutral_map << Any.new(pattern, options.merge(regexp: regexp, index: @neutral_map.length))
+      @neutral_map << Any.new(pattern, regexp: regexp, index: @neutral_map.length, **options)
     end
 
     def call(env)
@@ -95,7 +95,7 @@ module Grape
       neighbor = greedy_match?(input)
       return unless neighbor
 
-      (!cascade && neighbor) ? method_not_allowed(env, neighbor.allow_header, neighbor.endpoint) : nil
+      (!cascade && neighbor) ? call_with_allow_headers(env, neighbor.allow_header, neighbor.endpoint) : nil
     end
 
     def make_routing_args(default_args, route, input)
@@ -132,8 +132,8 @@ module Grape
       @neutral_map.detect { |route| last_match["_#{route.index}"] }
     end
 
-    def method_not_allowed(env, methods, endpoint)
-      env[Grape::Env::GRAPE_METHOD_NOT_ALLOWED] = methods
+    def call_with_allow_headers(env, methods, endpoint)
+      env[Grape::Env::GRAPE_ALLOWED_METHODS] = methods
       endpoint.call(env)
     end