grape 0.11.0 → 0.12.0

data/lib/grape/dsl/configuration.rb

@@ -48,13 +48,13 @@ module Grape
       def desc_container
         Module.new do
           include Grape::Util::StrictHashConfiguration.module(
-                      :description,
-                      :detail,
-                      :params,
-                      :entity,
-                      :http_codes,
-                      :named,
-                      :headers
+            :description,
+            :detail,
+            :params,
+            :entity,
+            :http_codes,
+            :named,
+            :headers
           )
 
           def config_context.success(*args)

data/lib/grape/dsl/helpers.rb

@@ -51,7 +51,7 @@ module Grape
 
         protected
 
-        def inject_api_helpers_to_mod(mod, &block)
+        def inject_api_helpers_to_mod(mod, &_block)
           mod.extend(BaseHelper)
           yield if block_given?
           mod.api_changed(self)
@@ -59,12 +59,12 @@ module Grape
       end
 
       # This module extends user defined helpers
-      # to provide some API-specific functionality
+      # to provide some API-specific functionality.
       module BaseHelper
         attr_accessor :api
         def params(name, &block)
           @named_params ||= {}
-          @named_params.merge! name => block
+          @named_params[name] = block
         end
 
         def api_changed(new_api)

data/lib/grape/dsl/inside_route.rb

@@ -9,12 +9,12 @@ module Grape
       # A filtering method that will return a hash
       # consisting only of keys that have been declared by a
       # `params` statement against the current/target endpoint or parent
-      # namespaces
+      # namespaces.
       #
       # @param params [Hash] The initial hash to filter. Usually this will just be `params`
       # @param options [Hash] Can pass `:include_missing`, `:stringify` and `:include_parent_namespaces`
       # options. `:include_parent_namespaces` defaults to true, hence must be set to false if
-      # you want only to return params declared against the current/target endpoint
+      # you want only to return params declared against the current/target endpoint.
       def declared(params, options = {}, declared_params = nil)
         options[:include_missing] = true unless options.key?(:include_missing)
         options[:include_parent_namespaces] = true unless options.key?(:include_parent_namespaces)
@@ -39,15 +39,14 @@ module Grape
             key.each_pair do |parent, children|
               output_key = options[:stringify] ? parent.to_s : parent.to_sym
 
-              next unless options[:include_missing] || children || params.key?(parent)
+              next unless options[:include_missing] || params.key?(parent)
 
-              if params.key?(parent) || options[:include_missing]
-                hash[output_key] = if children
-                                     declared(params[parent] || {}, options, Array(children))
-                                   else
-                                     params[parent]
-                                   end
-              end
+              hash[output_key] = if children
+                                   children_params = params[parent] || (children.is_a?(Array) ? [] : {})
+                                   declared(children_params, options, Array(children))
+                                 else
+                                   params[parent]
+                                 end
             end
 
             hash
@@ -80,7 +79,7 @@ module Grape
         if merged_options[:permanent]
           status 301
         else
-          if env['HTTP_VERSION'] == 'HTTP/1.1' && request.request_method.to_s.upcase != 'GET'
+          if env[Grape::Http::Headers::HTTP_VERSION] == 'HTTP/1.1' && request.request_method.to_s.upcase != Grape::Http::Headers::GET
             status 303
           else
             status 302
@@ -94,16 +93,25 @@ module Grape
       #
       # @param status [Integer] The HTTP Status Code to return for this request.
       def status(status = nil)
-        if status
+        case status
+        when Symbol
+          if Rack::Utils::SYMBOL_TO_STATUS_CODE.keys.include?(status)
+            @status = Rack::Utils.status_code(status)
+          else
+            fail ArgumentError, "Status code :#{status} is invalid."
+          end
+        when Fixnum
           @status = status
-        else
+        when nil
           return @status if @status
           case request.request_method.to_s.upcase
-          when 'POST'
+          when Grape::Http::Headers::POST
             201
           else
             200
           end
+        else
+          fail ArgumentError, 'Status code must be Fixnum or Symbol.'
         end
       end
 
@@ -120,9 +128,9 @@ module Grape
       # Set response content-type
       def content_type(val = nil)
         if val
-          header('Content-Type', val)
+          header(Grape::Http::Headers::CONTENT_TYPE, val)
         else
-          header['Content-Type']
+          header[Grape::Http::Headers::CONTENT_TYPE]
         end
       end
 
@@ -159,6 +167,22 @@ module Grape
         end
       end
 
+      # Allows you to define the response as a file-like object.
+      #
+      # @example
+      #   get '/file' do
+      #     file FileStreamer.new(...)
+      #   end
+      #
+      #   GET /file # => "contents of file"
+      def file(value = nil)
+        if value
+          @file = value
+        else
+          @file
+        end
+      end
+
       # Allows you to make use of Grape Entities by setting
       # the response body to the serializable hash of the
       # entity provided in the `:with` option. This has the
@@ -186,9 +210,7 @@ module Grape
         root = options.delete(:root)
 
         representation = if entity_class
-                           embeds = { env: env }
-                           embeds[:version] = env['api.version'] if env['api.version']
-                           entity_class.represent(object, embeds.merge(options))
+                           entity_representation_for(entity_class, object, options)
                          else
                            object
                          end
@@ -196,8 +218,9 @@ module Grape
         representation = { root => representation } if root
         if key
           representation = (@body || {}).merge(key => representation)
-        elsif entity_class.present? && representation.respond_to?('merge')
-          representation = (@body || {}).merge(representation)
+        elsif entity_class.present? && @body
+          fail ArgumentError, "Representation of type #{representation.class} cannot be merged." unless representation.respond_to?('merge')
+          representation = @body.merge(representation)
         end
 
         body representation
@@ -235,6 +258,12 @@ module Grape
 
         entity_class
       end
+
+      def entity_representation_for(entity_class, object, options)
+        embeds = { env: env }
+        embeds[:version] = env['api.version'] if env['api.version']
+        entity_class.represent(object, embeds.merge(options))
+      end
     end
   end
 end

data/lib/grape/dsl/parameters.rb

@@ -5,6 +5,27 @@ module Grape
     module Parameters
       extend ActiveSupport::Concern
 
+      # Include reusable params rules among current.
+      # You can define reusable params with helpers method.
+      #
+      # @example
+      #
+      #     class API < Grape::API
+      #       helpers do
+      #         params :pagination do
+      #           optional :page, type: Integer
+      #           optional :per_page, type: Integer
+      #         end
+      #       end
+      #
+      #       desc "Get collection"
+      #       params do
+      #         use :pagination
+      #       end
+      #       get do
+      #         Collection.page(params[:page]).per(params[:per_page])
+      #       end
+      #     end
       def use(*names)
         named_params = Grape::DSL::Configuration.stacked_hash_to_hash(@api.namespace_stackable(:named_params)) || {}
         options = names.last.is_a?(Hash) ? names.pop : {}
@@ -21,8 +42,8 @@ module Grape
       def requires(*attrs, &block)
         orig_attrs = attrs.clone
 
-        opts = attrs.last.is_a?(Hash) ? attrs.pop : {}
-        opts.merge!(presence: true)
+        opts = attrs.last.is_a?(Hash) ? attrs.pop.clone : {}
+        opts[:presence] = true
 
         if opts[:using]
           require_required_and_optional_fields(attrs.first, opts)
@@ -37,7 +58,7 @@ module Grape
       def optional(*attrs, &block)
         orig_attrs = attrs.clone
 
-        opts = attrs.last.is_a?(Hash) ? attrs.pop : {}
+        opts = attrs.last.is_a?(Hash) ? attrs.pop.clone : {}
         type = opts[:type]
 
         # check type for optional parameter group
@@ -72,9 +93,7 @@ module Grape
         validates(attrs, all_or_none_of: true)
       end
 
-      def group(*attrs, &block)
-        requires(*attrs, &block)
-      end
+      alias_method :group, :requires
 
       def params(params)
         params = @parent.params(params) if @parent

data/lib/grape/dsl/request_response.rb

@@ -96,7 +96,7 @@ module Grape
         #   @option options [Boolean] :backtrace Include a backtrace in the rescue response.
         #   @option options [Boolean] :rescue_subclasses Also rescue subclasses of exception classes
         #   @param [Proc] handler Execution proc to handle the given exception as an
-        #     alternative to passing a block
+        #     alternative to passing a block.
         def rescue_from(*args, &block)
           if args.last.is_a?(Proc)
             handler = args.pop

data/lib/grape/dsl/routing.rb

@@ -59,12 +59,12 @@ module Grape
           namespace_inheritable(:root_prefix, prefix)
         end
 
-        # Do not route HEAD requests to GET requests automatically
+        # Do not route HEAD requests to GET requests automatically.
         def do_not_route_head!
           namespace_inheritable(:do_not_route_head, true)
         end
 
-        # Do not automatically route OPTIONS
+        # Do not automatically route OPTIONS.
         def do_not_route_options!
           namespace_inheritable(:do_not_route_options, true)
         end
@@ -89,11 +89,11 @@ module Grape
             end
 
             endpoints << Grape::Endpoint.new(
-                in_setting,
-                method: :any,
-                path: path,
-                app: app,
-                for: self
+              in_setting,
+              method: :any,
+              path: path,
+              app: app,
+              for: self
             )
           end
         end
@@ -120,13 +120,14 @@ module Grape
             }).deep_merge(route_setting(:description) || {}).deep_merge(route_options || {})
           }
 
-          endpoints << Grape::Endpoint.new(inheritable_setting, endpoint_options, &block)
+          new_endpoint = Grape::Endpoint.new(inheritable_setting, endpoint_options, &block)
+          endpoints << new_endpoint unless endpoints.any? { |e| e.equals?(new_endpoint) }
 
           route_end
           reset_validations!
         end
 
-        %w"get post put head delete options patch".each do |meth|
+        %w(get post put head delete options patch).each do |meth|
           define_method meth do |*args, &block|
             options = args.extract_options!
             paths = args.first || ['/']
@@ -134,7 +135,7 @@ module Grape
           end
         end
 
-        def namespace(space = nil, options = {},  &block)
+        def namespace(space = nil, options = {}, &block)
           if space || block_given?
             within_namespace do
               previous_namespace_description = @namespace_description

data/lib/grape/dsl/settings.rb

@@ -95,7 +95,7 @@ module Grape
         reset_validations!
       end
 
-      def within_namespace(&block)
+      def within_namespace(&_block)
         namespace_start
 
         result = yield if block_given?

data/lib/grape/endpoint.rb

@@ -83,7 +83,7 @@ module Grape
        Namespace.joined_space(namespace_stackable(:namespace)),
        (namespace_stackable(:mount_path) || []).join('/'),
        options[:path].join('/')
-     ].join(' ')
+      ].join(' ')
     end
 
     def routes
@@ -106,8 +106,8 @@ module Grape
 
         routes.each do |route|
           methods = [route.route_method]
-          if !namespace_inheritable(:do_not_route_head) && route.route_method == 'GET'
-            methods << 'HEAD'
+          if !namespace_inheritable(:do_not_route_head) && route.route_method == Grape::Http::Headers::GET
+            methods << Grape::Http::Headers::HEAD
           end
           methods.each do |method|
             route_set.add_route(self, {
@@ -151,14 +151,14 @@ module Grape
           request_method = (method.to_s.upcase unless method == :any)
 
           Route.new(options[:route_options].clone.merge(
-            prefix: namespace_inheritable(:root_prefix),
-            version: namespace_inheritable(:version) ? namespace_inheritable(:version).join('|') : nil,
-            namespace: namespace,
-            method: request_method,
-            path: prepared_path,
-            params: prepare_routes_path_params(path),
-            compiled: path,
-            settings: inheritable_setting.route.except(:saved_declared_params, :saved_validations)
+                      prefix: namespace_inheritable(:root_prefix),
+                      version: namespace_inheritable(:version) ? namespace_inheritable(:version).join('|') : nil,
+                      namespace: namespace,
+                      method: request_method,
+                      path: prepared_path,
+                      params: prepare_routes_path_params(path),
+                      compiled: path,
+                      settings: inheritable_setting.route.except(:saved_declared_params, :saved_validations)
           ))
         end
       end.flatten
@@ -192,7 +192,7 @@ module Grape
         options[:app].call(env)
       else
         builder = build_middleware
-        builder.run lambda { |arg| run(arg) }
+        builder.run ->(arg) { run(arg) }
         builder.call(env)
       end
     end
@@ -200,11 +200,11 @@ module Grape
     # Return the collection of endpoints within this endpoint.
     # This is the case when an Grape::API mounts another Grape::API.
     def endpoints
-      if options[:app] && options[:app].respond_to?(:endpoints)
-        options[:app].endpoints
-      else
-        nil
-      end
+      options[:app].endpoints if options[:app] && options[:app].respond_to?(:endpoints)
+    end
+
+    def equals?(e)
+      (options == e.options) && (inheritable_setting.to_hash == e.inheritable_setting.to_hash)
     end
 
     protected
@@ -244,11 +244,13 @@ module Grape
 
       run_filters after_validations
 
-      response_text = @block ? @block.call(self) : nil
+      response_object = @block ? @block.call(self) : nil
       run_filters afters
       cookies.write(header)
 
-      [status, header, [body || response_text]]
+      # The Body commonly is an Array of Strings, the application instance itself, or a File-like object.
+      response_object = file || [body || response_object]
+      [status, header, response_object]
     end
 
     def build_middleware

data/lib/grape/error_formatter/json.rb

@@ -5,7 +5,7 @@ module Grape
         def call(message, backtrace, options = {}, env = nil)
           message = Grape::ErrorFormatter::Base.present(message, env)
 
-          result = message.is_a?(Hash) ? message : { error: message }
+          result = message.is_a?(String) ? { error: message } : message
           if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
             result = result.merge(backtrace: backtrace)
           end

data/lib/grape/exceptions/base.rb

@@ -29,7 +29,7 @@ module Grape
           @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 << "\n#{detail_array[0]}:\n  #{detail_array[1]}" unless detail_array[1].blank?
             message
           end
         else

data/lib/grape/exceptions/validation.rb

@@ -14,7 +14,7 @@ module Grape
 
       # 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)
+      def as_json(*_args)
         to_s
       end
 

data/lib/grape/exceptions/validation_errors.rb

@@ -24,7 +24,7 @@ module Grape
         end
       end
 
-      def as_json
+      def as_json(_opts = {})
         errors.map do |k, v|
           {
             params: k,
@@ -33,7 +33,7 @@ module Grape
         end
       end
 
-      def to_json
+      def to_json(_opts = {})
         as_json.to_json
       end