grape 1.2.5 → 1.4.0

data/lib/grape/dsl/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module DSL
     module Logger

data/lib/grape/dsl/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape

data/lib/grape/dsl/parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape
@@ -125,13 +127,13 @@ module Grape
 
         opts = attrs.extract_options!.clone
         opts[:presence] = { value: true, message: opts[:message] }
-        opts = @group.merge(opts) if @group
+        opts = @group.merge(opts) if instance_variable_defined?(:@group) && @group
 
         if opts[:using]
           require_required_and_optional_fields(attrs.first, opts)
         else
           validate_attributes(attrs, opts, &block)
-          block_given? ? new_scope(orig_attrs, &block) : push_declared_params(attrs, opts.slice(:as))
+          block_given? ? new_scope(orig_attrs, &block) : push_declared_params(attrs, **opts.slice(:as))
         end
       end
 
@@ -144,7 +146,7 @@ module Grape
 
         opts = attrs.extract_options!.clone
         type = opts[:type]
-        opts = @group.merge(opts) if @group
+        opts = @group.merge(opts) if instance_variable_defined?(:@group) && @group
 
         # check type for optional parameter group
         if attrs && block_given?
@@ -157,7 +159,7 @@ module Grape
         else
           validate_attributes(attrs, opts, &block)
 
-          block_given? ? new_scope(orig_attrs, true, &block) : push_declared_params(attrs, opts.slice(:as))
+          block_given? ? new_scope(orig_attrs, true, &block) : push_declared_params(attrs, **opts.slice(:as))
         end
       end
 
@@ -241,8 +243,8 @@ module Grape
       # @return hash of parameters relevant for the current scope
       # @api private
       def params(params)
-        params = @parent.params(params) if @parent
-        params = map_params(params, @element) if @element
+        params = @parent.params(params) if instance_variable_defined?(:@parent) && @parent
+        params = map_params(params, @element) if instance_variable_defined?(:@element) && @element
         params
       end
 

data/lib/grape/dsl/request_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape
@@ -20,7 +22,7 @@ module Grape
           if new_format
             namespace_inheritable(:format, new_format.to_sym)
             # define the default error formatters
-            namespace_inheritable(:default_error_formatter, Grape::ErrorFormatter.formatter_for(new_format, {}))
+            namespace_inheritable(:default_error_formatter, Grape::ErrorFormatter.formatter_for(new_format, **{}))
             # define a single mime type
             mime_type = content_types[new_format.to_sym]
             raise Grape::Exceptions::MissingMimeType.new(new_format) unless mime_type
@@ -43,7 +45,7 @@ module Grape
         # Specify a default error formatter.
         def default_error_formatter(new_formatter_name = nil)
           if new_formatter_name
-            new_formatter = Grape::ErrorFormatter.formatter_for(new_formatter_name, {})
+            new_formatter = Grape::ErrorFormatter.formatter_for(new_formatter_name, **{})
             namespace_inheritable(:default_error_formatter, new_formatter)
           else
             namespace_inheritable(:default_error_formatter)

data/lib/grape/dsl/routing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape
@@ -49,7 +51,7 @@ module Grape
             end
           end
 
-          @versions.last unless @versions.nil?
+          @versions.last if instance_variable_defined?(:@versions) && @versions
         end
 
         # Define a root URL prefix for your entire API.
@@ -140,11 +142,11 @@ module Grape
           reset_validations!
         end
 
-        %w[get post put head delete options patch].each do |meth|
-          define_method meth do |*args, &block|
+        Grape::Http::Headers::SUPPORTED_METHODS.each do |supported_method|
+          define_method supported_method.downcase do |*args, &block|
             options = args.extract_options!
             paths = args.first || ['/']
-            route(meth.upcase, paths, options, &block)
+            route(supported_method, paths, options, &block)
           end
         end
 
@@ -161,13 +163,15 @@ module Grape
         #       end
         #     end
         def namespace(space = nil, options = {}, &block)
+          @namespace_description = nil unless instance_variable_defined?(:@namespace_description) && @namespace_description
+
           if space || block_given?
             within_namespace do
               previous_namespace_description = @namespace_description
               @namespace_description = (@namespace_description || {}).deep_merge(namespace_setting(:description) || {})
               nest(block) do
                 if space
-                  namespace_stackable(:namespace, Namespace.new(space, options))
+                  namespace_stackable(:namespace, Namespace.new(space, **options))
                 end
               end
               @namespace_description = previous_namespace_description

data/lib/grape/dsl/settings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape
@@ -169,7 +171,11 @@ module Grape
       # the superclass's :inheritable_setting.
       def build_top_level_setting
         Grape::Util::InheritableSetting.new.tap do |setting|
-          if defined?(superclass) && superclass.respond_to?(:inheritable_setting) && superclass != Grape::API
+          # Doesn't try to inherit settings from +Grape::API::Instance+ which also responds to
+          # +inheritable_setting+, however, it doesn't contain any user-defined settings.
+          # Otherwise, it would lead to an extra instance of +Grape::Util::InheritableSetting+
+          # in the chain for every endpoint.
+          if defined?(superclass) && superclass.respond_to?(:inheritable_setting) && superclass != Grape::API::Instance
             setting.inherit_from superclass.inheritable_setting
           end
         end

data/lib/grape/dsl/validations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module Grape
@@ -8,7 +10,24 @@ module Grape
       include Grape::DSL::Configuration
 
       module ClassMethods
-        # Clears all defined parameters and validations.
+        # Clears all defined parameters and validations. The main purpose of it is to clean up
+        # settings, so next endpoint won't interfere with previous one.
+        #
+        #    params do
+        #      # params for the endpoint below this block
+        #    end
+        #    post '/current' do
+        #      # whatever
+        #    end
+        #
+        #    # somewhere between them the reset_validations! method gets called
+        #
+        #    params do
+        #      # params for the endpoint below this block
+        #    end
+        #    post '/next' do
+        #      # whatever
+        #    end
         def reset_validations!
           unset_namespace_stackable :declared_params
           unset_namespace_stackable :validations

data/lib/grape/eager_load.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Grape.eager_load!
 Grape::Http.eager_load!
 Grape::Exceptions.eager_load!
@@ -14,5 +16,5 @@ Grape::Parser.eager_load!
 Grape::DSL.eager_load!
 Grape::API.eager_load!
 Grape::Presenters.eager_load!
-Grape::ServeFile.eager_load!
+Grape::ServeStream.eager_load!
 Rack::Head # AutoLoads the Rack::Head

data/lib/grape/endpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   # An Endpoint is the proxy scope in which all routing
   # blocks are executed. In other words, any methods
@@ -78,7 +80,10 @@ module Grape
 
       self.inheritable_setting = new_settings.point_in_time_copy
 
-      route_setting(:saved_declared_params, namespace_stackable(:declared_params))
+      # now +namespace_stackable(:declared_params)+ contains all params defined for
+      # this endpoint and its parents, but later it will be cleaned up,
+      # see +reset_validations!+ in lib/grape/dsl/validations.rb
+      route_setting(:declared_params, namespace_stackable(:declared_params).flatten)
       route_setting(:saved_validations, namespace_stackable(:validations))
 
       namespace_stackable(:representations, []) unless namespace_stackable(:representations)
@@ -97,7 +102,7 @@ module Grape
       @block = nil
 
       @status = nil
-      @file = nil
+      @stream = nil
       @body = nil
       @proc = nil
 
@@ -114,7 +119,6 @@ module Grape
       parent_declared_params = namespace_stackable[:declared_params]
 
       if parent_declared_params
-        inheritable_setting.route[:declared_params] ||= []
         inheritable_setting.route[:declared_params].concat(parent_declared_params.flatten)
       end
 
@@ -154,8 +158,8 @@ module Grape
             methods << Grape::Http::Headers::HEAD
           end
           methods.each do |method|
-            unless route.request_method.to_s.upcase == method
-              route = Grape::Router::Route.new(method, route.origin, route.attributes.to_h)
+            unless route.request_method == method
+              route = Grape::Router::Route.new(method, route.origin, **route.attributes.to_h)
             end
             router.append(route.apply(self))
           end
@@ -167,8 +171,8 @@ module Grape
       route_options = prepare_default_route_attributes
       map_routes do |method, path|
         path = prepare_path(path)
-        params = merge_route_options(route_options.merge(suffix: path.suffix))
-        route = Router::Route.new(method, path.path, params)
+        params = merge_route_options(**route_options.merge(suffix: path.suffix))
+        route = Router::Route.new(method, path.path, **params)
         route.apply(self)
       end.flatten
     end
@@ -188,7 +192,7 @@ module Grape
         requirements: prepare_routes_requirements,
         prefix: namespace_inheritable(:root_prefix),
         anchor: options[:route_options].fetch(:anchor, true),
-        settings: inheritable_setting.route.except(:saved_declared_params, :saved_validations),
+        settings: inheritable_setting.route.except(:declared_params, :saved_validations),
         forward_match: options[:forward_match]
       }
     end
@@ -260,7 +264,7 @@ module Grape
             run_validators validations, request
             remove_renamed_params
             run_filters after_validations, :after_validation
-            response_object = @block ? @block.call(self) : nil
+            response_object = execute
           end
 
           run_filters afters, :after
@@ -269,8 +273,8 @@ module Grape
           # 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]
+          # The body commonly is an Array of Strings, the application instance itself, or a Stream-like object
+          response_object = stream || [body]
 
           [status, header, response_object]
         ensure
@@ -333,6 +337,10 @@ module Grape
 
     private :build_stack, :build_helpers, :remove_renamed_params
 
+    def execute
+      @block ? @block.call(self) : nil
+    end
+
     def helpers
       lazy_initialize! && @helpers
     end
@@ -353,7 +361,7 @@ module Grape
     def run_validators(validator_factories, request)
       validation_errors = []
 
-      validators = validator_factories.map { |options| Grape::Validations::ValidatorFactory.create_validator(options) }
+      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|
@@ -369,7 +377,7 @@ module Grape
         end
       end
 
-      validation_errors.any? && raise(Grape::Exceptions::ValidationErrors, errors: validation_errors, headers: header)
+      validation_errors.any? && raise(Grape::Exceptions::ValidationErrors.new(errors: validation_errors, headers: header))
     end
 
     def run_filters(filters, type = :other)

data/lib/grape/error_formatter.rb

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

data/lib/grape/error_formatter/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module ErrorFormatter
     module Base

data/lib/grape/error_formatter/json.rb

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

data/lib/grape/error_formatter/txt.rb

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

data/lib/grape/error_formatter/xml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Grape
   module ErrorFormatter
     module Xml

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

data/lib/grape/exceptions/incompatible_option_values.rb

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

data/lib/grape/exceptions/invalid_accept_header.rb

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

data/lib/grape/exceptions/invalid_formatter.rb

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

data/lib/grape/exceptions/invalid_message_body.rb

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

data/lib/grape/exceptions/invalid_response.rb

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

data/lib/grape/exceptions/invalid_version_header.rb

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