grape 0.6.1 → 0.7.0

data/lib/grape/middleware/error.rb

@@ -3,18 +3,18 @@ require 'grape/middleware/base'
 module Grape
   module Middleware
     class Error < Base
-
       def default_options
         {
-          default_status: 403, # default status returned on error
+          default_status: 500, # default status returned on error
           default_message: "",
           format: :txt,
           formatters: {},
           error_formatters: {},
           rescue_all: false, # true to rescue all exceptions
+          rescue_subclasses: true, # rescue subclasses of exceptions listed
           rescue_options: { backtrace: false }, # true to display backtrace
           rescue_handlers: {}, # rescue handler blocks
-          rescued_errors: []
+          base_only_rescue_handlers: {} # rescue handler blocks rescuing only the base class
         }
       end
 
@@ -31,15 +31,21 @@ module Grape
             handler = lambda { |arg| error_response(arg) }
           else
             raise unless is_rescuable
-            handler = options[:rescue_handlers][e.class] || options[:rescue_handlers][:all]
+            handler = find_handler(e.class)
           end
 
           handler.nil? ? handle_error(e) : exec_handler(e, &handler)
         end
       end
 
+      def find_handler(klass)
+        handler = options[:rescue_handlers].find(-> { [] }) { |error, _| klass <= error }[1]
+        handler = options[:base_only_rescue_handlers][klass] || options[:base_only_rescue_handlers][:all] unless handler
+        handler
+      end
+
       def rescuable?(klass)
-        options[:rescue_all] || (options[:rescued_errors] || []).include?(klass)
+        options[:rescue_all] || (options[:rescue_handlers] || []).any? { |error, handler| klass <= error } || (options[:base_only_rescue_handlers] || []).include?(klass)
       end
 
       def exec_handler(e, &handler)
@@ -73,7 +79,6 @@ module Grape
         throw :error, status: 406, message: "The requested format '#{format}' is not supported." unless formatter
         formatter.call(message, backtrace, options, env)
       end
-
     end
   end
 end

data/lib/grape/middleware/formatter.rb

@@ -3,7 +3,6 @@ require 'grape/middleware/base'
 module Grape
   module Middleware
     class Formatter < Base
-
       def default_options
         {
           default_format: :txt,
@@ -42,107 +41,110 @@ module Grape
 
       private
 
-        # store read input in env['api.request.input']
-        def read_body_input
-          if (request.post? || request.put? || request.patch? || request.delete?) &&
-            (!request.form_data? || !request.media_type) &&
-            (!request.parseable_data?) &&
-            (request.content_length.to_i > 0 || request.env['HTTP_TRANSFER_ENCODING'] == 'chunked')
+      def request
+        @request ||= Rack::Request.new(env)
+      end
 
-            if (input = env['rack.input'])
+      # store read input in env['api.request.input']
+      def read_body_input
+        if (request.post? || request.put? || request.patch? || request.delete?) &&
+          (!request.form_data? || !request.media_type) &&
+          (!request.parseable_data?) &&
+          (request.content_length.to_i > 0 || request.env['HTTP_TRANSFER_ENCODING'] == 'chunked')
+
+          if (input = env['rack.input'])
+            input.rewind
+            body = env['api.request.input'] = input.read
+            begin
+              read_rack_input(body) if body && body.length > 0
+            ensure
               input.rewind
-              body = env['api.request.input'] = input.read
-              begin
-                read_rack_input(body) if body && body.length > 0
-              ensure
-                input.rewind
-              end
             end
           end
         end
+      end
 
-        # store parsed input in env['api.request.body']
-        def read_rack_input(body)
-          fmt = mime_types[request.media_type] if request.media_type
-          fmt ||= options[:default_format]
-          if content_type_for(fmt)
-            parser = Grape::Parser::Base.parser_for fmt, options
-            if parser
-              begin
-                body = (env['api.request.body'] = parser.call(body, env))
-                if body.is_a?(Hash)
-                  if env['rack.request.form_hash']
-                    env['rack.request.form_hash'] = env['rack.request.form_hash'].merge(body)
-                  else
-                    env['rack.request.form_hash'] = body
-                  end
-                  env['rack.request.form_input'] = env['rack.input']
+      # store parsed input in env['api.request.body']
+      def read_rack_input(body)
+        fmt = mime_types[request.media_type] if request.media_type
+        fmt ||= options[:default_format]
+        if content_type_for(fmt)
+          parser = Grape::Parser::Base.parser_for fmt, options
+          if parser
+            begin
+              body = (env['api.request.body'] = parser.call(body, env))
+              if body.is_a?(Hash)
+                if env['rack.request.form_hash']
+                  env['rack.request.form_hash'] = env['rack.request.form_hash'].merge(body)
+                else
+                  env['rack.request.form_hash'] = body
                 end
-              rescue StandardError => e
-                throw :error, status: 400, message: e.message
+                env['rack.request.form_input'] = env['rack.input']
               end
-            else
-              env['api.request.body'] = body
+            rescue StandardError => e
+              throw :error, status: 400, message: e.message
             end
           else
-            throw :error, status: 406, message: "The requested content-type '#{request.media_type}' is not supported."
+            env['api.request.body'] = body
           end
+        else
+          throw :error, status: 406, message: "The requested content-type '#{request.media_type}' is not supported."
         end
+      end
 
-        def negotiate_content_type
-          fmt = format_from_extension || format_from_params || options[:format] || format_from_header || options[:default_format]
-          if content_type_for(fmt)
-            env['api.format'] = fmt
-          else
-            throw :error, status: 406, message: "The requested format '#{fmt}' is not supported."
-          end
+      def negotiate_content_type
+        fmt = format_from_extension || format_from_params || options[:format] || format_from_header || options[:default_format]
+        if content_type_for(fmt)
+          env['api.format'] = fmt
+        else
+          throw :error, status: 406, message: "The requested format '#{fmt}' is not supported."
         end
+      end
 
-        def format_from_extension
-          parts = request.path.split('.')
+      def format_from_extension
+        parts = request.path.split('.')
 
-          if parts.size > 1
-            extension = parts.last
-            # avoid symbol memory leak on an unknown format
-            return extension.to_sym if content_type_for(extension)
-          end
-          nil
-        end
-
-        def format_from_params
-          fmt = Rack::Utils.parse_nested_query(env['QUERY_STRING'])["format"]
+        if parts.size > 1
+          extension = parts.last
           # avoid symbol memory leak on an unknown format
-          return fmt.to_sym if content_type_for(fmt)
-          fmt
+          return extension.to_sym if content_type_for(extension)
         end
+        nil
+      end
 
-        def format_from_header
-          mime_array.each do |t|
-            return mime_types[t] if mime_types.key?(t)
-          end
-          nil
-        end
+      def format_from_params
+        fmt = Rack::Utils.parse_nested_query(env['QUERY_STRING'])["format"]
+        # avoid symbol memory leak on an unknown format
+        return fmt.to_sym if content_type_for(fmt)
+        fmt
+      end
 
-        def mime_array
-          accept = headers['accept']
-          return [] unless accept
+      def format_from_header
+        mime_array.each do |t|
+          return mime_types[t] if mime_types.key?(t)
+        end
+        nil
+      end
 
-          accept_into_mime_and_quality = %r(
-            (
-              \w+/[\w+.-]+)     # eg application/vnd.example.myformat+xml
-            (?:
-             (?:;[^,]*?)?       # optionally multiple formats in a row
-             ;\s*q=([\d.]+)     # optional "quality" preference (eg q=0.5)
-            )?
-          )x
+      def mime_array
+        accept = headers['accept']
+        return [] unless accept
 
-          vendor_prefix_pattern = /vnd\.[^+]+\+/
+        accept_into_mime_and_quality = %r(
+          (
+            \w+/[\w+.-]+)     # eg application/vnd.example.myformat+xml
+          (?:
+           (?:;[^,]*?)?       # optionally multiple formats in a row
+           ;\s*q=([\d.]+)     # optional "quality" preference (eg q=0.5)
+          )?
+        )x
 
-          accept.scan(accept_into_mime_and_quality)
-            .sort_by { |_, quality_preference| -quality_preference.to_f }
-            .map { |mime, _| mime.sub(vendor_prefix_pattern, '') }
-        end
+        vendor_prefix_pattern = /vnd\.[^+]+\+/
 
+        accept.scan(accept_into_mime_and_quality)
+          .sort_by { |_, quality_preference| -quality_preference.to_f }
+          .map { |mime, _| mime.sub(vendor_prefix_pattern, '') }
+      end
     end
   end
 end

data/lib/grape/middleware/globals.rb

@@ -0,0 +1,13 @@
+require 'grape/middleware/base'
+
+module Grape
+  module Middleware
+    class Globals < Base
+      def before
+        @env['grape.request'] = Grape::Request.new(@env)
+        @env['grape.request.headers'] = request.headers
+        @env['grape.request.params'] = request.params if @env['rack.input']
+      end
+    end
+  end
+end

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

@@ -17,7 +17,6 @@ module Grape
       # X-Cascade header to alert Rack::Mount to attempt the next matched
       # route.
       class AcceptVersionHeader < Base
-
         def before
           potential_version = (env['HTTP_ACCEPT_VERSION'] || '').strip
 
@@ -62,7 +61,6 @@ module Grape
         def error_headers
           cascade? ? { 'X-Cascade' => 'pass' } : {}
         end
-
       end
     end
   end

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

@@ -22,9 +22,12 @@ module Grape
       # X-Cascade header to alert Rack::Mount to attempt the next matched
       # route.
       class Header < Base
-
         def before
-          header = Rack::Accept::MediaType.new env['HTTP_ACCEPT']
+          begin
+            header = Rack::Accept::MediaType.new env['HTTP_ACCEPT']
+          rescue RuntimeError => e
+            throw :error, status: 406, headers: error_headers, message: e.message
+          end
 
           if strict?
             # If no Accept header:
@@ -123,7 +126,6 @@ module Grape
           _, subtype = Rack::Accept::Header.parse_media_type media_type
           subtype[/\Avnd\.[a-z0-9*.]+-[a-z0-9*\-.]+/]
         end
-
       end
     end
   end

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

@@ -27,17 +27,15 @@ module Grape
 
         def before
           paramkey = options[:parameter]
-          potential_version = request.params[paramkey]
-
+          potential_version = Rack::Utils.parse_nested_query(env['QUERY_STRING'])[paramkey]
           unless potential_version.nil?
             if options[:versions] && !options[:versions].find { |v| v.to_s == potential_version }
               throw :error, status: 404, message: "404 API Version Not Found", headers: { 'X-Cascade' => 'pass' }
             end
             env['api.version'] = potential_version
-            env['rack.request.query_hash'].delete(paramkey)
+            env['rack.request.query_hash'].delete(paramkey) if env.key? 'rack.request.query_hash'
           end
         end
-
       end
     end
   end

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

@@ -43,10 +43,9 @@ module Grape
 
         private
 
-          def prefix
-            Rack::Mount::Utils.normalize_path(options[:prefix].to_s) if options[:prefix]
-          end
-
+        def prefix
+          Rack::Mount::Utils.normalize_path(options[:prefix].to_s) if options[:prefix]
+        end
       end
     end
   end

data/lib/grape/namespace.rb

@@ -19,6 +19,5 @@ module Grape
     def self.joined_space_path(settings)
       Rack::Mount::Utils.normalize_path(joined_space(settings))
     end
-
   end
 end

data/lib/grape/parser/base.rb

@@ -1,9 +1,7 @@
 module Grape
   module Parser
     module Base
-
       class << self
-
         PARSERS = {
           json: Grape::Parser::Json,
           jsonapi: Grape::Parser::Json,
@@ -25,7 +23,6 @@ module Grape
             spec
           end
         end
-
       end
     end
   end

data/lib/grape/parser/json.rb

@@ -2,11 +2,9 @@ module Grape
   module Parser
     module Json
       class << self
-
         def call(object, env)
           MultiJson.load(object)
         end
-
       end
     end
   end

data/lib/grape/parser/xml.rb

@@ -2,11 +2,9 @@ module Grape
   module Parser
     module Xml
       class << self
-
         def call(object, env)
           MultiXml.parse(object)
         end
-
       end
     end
   end

data/lib/grape/path.rb

@@ -1,6 +1,5 @@
 module Grape
   class Path
-
     def self.prepare(raw_path, namespace, settings)
       Path.new(raw_path, namespace, settings).path_with_suffix
     end
@@ -22,7 +21,7 @@ module Grape
     end
 
     def uses_path_versioning?
-      settings[:version] && settings[:version_options][:using] == :path
+      !!(settings[:version] && settings[:version_options][:using] == :path)
     end
 
     def has_namespace?
@@ -67,6 +66,5 @@ module Grape
       return if settings[key].nil?
       settings[key].to_s.split("/")
     end
-
   end
 end

data/lib/grape/route.rb

@@ -1,8 +1,6 @@
 module Grape
-
   # A compiled route for inspection.
   class Route
-
     def initialize(options = {})
       @options = options || {}
     end
@@ -25,6 +23,5 @@ module Grape
     def to_ary
       nil
     end
-
   end
 end

data/lib/grape/util/hash_stack.rb

@@ -100,7 +100,7 @@ module Grape
       # @param key [Symbol] The key to gather
       # @return [Array]
       def gather(key)
-        stack.map { |s| s[key] }.flatten.compact.uniq
+        stack.flat_map { |s| s[key] }.compact.uniq
       end
 
       def to_s

data/lib/grape/validations.rb

@@ -1,7 +1,5 @@
 module Grape
-
   module Validations
-
     ##
     # All validators must inherit from this class.
     #
@@ -64,7 +62,6 @@ module Grape
         @option = options
         super
       end
-
     end
 
     # We define Validator::inherited here so SingleOptionValidator
@@ -94,6 +91,7 @@ module Grape
         @parent   = opts[:parent]
         @api      = opts[:api]
         @optional = opts[:optional] || false
+        @type     = opts[:type]
         @declared_params = []
 
         instance_eval(&block)
@@ -102,41 +100,68 @@ module Grape
       end
 
       def should_validate?(parameters)
-        return false if @optional && params(parameters).blank?
+        return false if @optional && params(parameters).respond_to?(:all?) && params(parameters).all?(&:blank?)
         return true if parent.nil?
         parent.should_validate?(parameters)
       end
 
       def requires(*attrs, &block)
-        return new_scope(attrs, &block) if block_given?
+        orig_attrs = attrs.clone
 
-        validations = { presence: true }
-        validations.merge!(attrs.pop) if attrs.last.is_a?(Hash)
+        opts = attrs.last.is_a?(Hash) ? attrs.pop : nil
 
-        push_declared_params(attrs)
-        validates(attrs, validations)
+        if opts && 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)
+        end
       end
 
       def optional(*attrs, &block)
-        return new_scope(attrs, true, &block) if block_given?
+        orig_attrs = attrs
 
         validations = {}
         validations.merge!(attrs.pop) if attrs.last.is_a?(Hash)
-
-        push_declared_params(attrs)
+        validations[:type] ||= Array if block_given?
         validates(attrs, validations)
+
+        block_given? ? new_scope(orig_attrs, true, &block) :
+          push_declared_params(attrs)
       end
 
-      def group(element, &block)
-        requires(element, &block)
+      def group(*attrs, &block)
+        requires(*attrs, &block)
       end
 
       def params(params)
         params = @parent.params(params) if @parent
-        params = params[@element] || {} if @element
+        if @element
+          if params.is_a?(Array)
+            params = params.flat_map { |el| el[@element] || {} }
+          elsif params.is_a?(Hash)
+            params = params[@element] || {}
+          else
+            params = {}
+          end
+        end
         params
       end
 
+      def use(*names)
+        named_params = @api.settings[:named_params] || {}
+        names.each do |name|
+          params_block = named_params.fetch(name) do
+            raise "Params :#{name} not found!"
+          end
+          instance_eval(&params_block)
+        end
+      end
+      alias_method :use_scope, :use
+      alias_method :includes, :use
+
       def full_name(name)
         return "#{@parent.full_name(@element)}[#{name}]" if @parent
         name.to_s
@@ -150,9 +175,33 @@ module Grape
 
       private
 
+      def require_required_and_optional_fields(context, opts)
+        if context == :all
+          optional_fields = Array(opts[:except])
+          required_fields = opts[:using].keys - optional_fields
+        else # context == :none
+          required_fields = Array(opts[:except])
+          optional_fields = opts[:using].keys - required_fields
+        end
+        required_fields.each do |field|
+          requires(field, opts[:using][field])
+        end
+        optional_fields.each do |field|
+          optional(field, opts[:using][field])
+        end
+      end
+
+      def validate_attributes(attrs, opts, &block)
+        validations = { presence: true }
+        validations.merge!(opts) if opts
+        validations[:type] ||= Array if block
+        validates(attrs, validations)
+      end
+
       def new_scope(attrs, optional = false, &block)
-        raise ArgumentError unless attrs.size == 1
-        ParamsScope.new(api: @api, element: attrs.first, parent: self, optional: optional, &block)
+        opts = attrs[1] || { type: Array }
+        raise ArgumentError unless opts.keys.to_set.subset? [:type].to_set
+        ParamsScope.new(api: @api, element: attrs.first, parent: self, optional: optional, type: opts[:type], &block)
       end
 
       # Pushes declared params to parent or settings
@@ -183,16 +232,20 @@ module Grape
         values = validations[:values]
         doc_attrs[:values] = values if values
 
+        values = (values.is_a?(Proc) ? values.call : values)
+
         # default value should be present in values array, if both exist
         if default && values && !values.include?(default)
           raise Grape::Exceptions::IncompatibleOptionValues.new(:default, default, :values, values)
         end
 
         # type should be compatible with values array, if both exist
-        if coerce_type && values && values.any? { |v| !v.instance_of?(coerce_type) }
+        if coerce_type && values && values.any? { |v| !v.kind_of?(coerce_type) }
           raise Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values)
         end
 
+        doc_attrs[:documentation] = validations.delete(:documentation) if validations.key?(:documentation)
+
         full_attrs = attrs.collect { |name| { name: name, full_name: full_name(name) } }
         @api.document_attribute(full_attrs, doc_attrs)
 
@@ -224,7 +277,6 @@ module Grape
           raise Grape::Exceptions::UnknownValidator.new(type)
         end
       end
-
     end
 
     # This module is mixed into the API Class.
@@ -235,7 +287,7 @@ module Grape
       end
 
       def params(&block)
-        ParamsScope.new(api: self, &block)
+        ParamsScope.new(api: self, type: Hash, &block)
       end
 
       def document_attribute(names, opts)
@@ -246,9 +298,7 @@ module Grape
           @last_description[:params][name[:full_name].to_s].merge!(opts)
         end
       end
-
     end
-
   end
 end