grape 0.11.0 → 0.12.0

data/lib/grape/formatter/base.rb

@@ -18,7 +18,7 @@ module Grape
           spec = formatters(options)[api_format]
           case spec
           when nil
-            lambda { |obj, env| obj }
+            ->(obj, _env) { obj }
           when Symbol
             method(spec)
           else

data/lib/grape/formatter/json.rb

@@ -2,7 +2,7 @@ module Grape
   module Formatter
     module Json
       class << self
-        def call(object, env)
+        def call(object, _env)
           return object.to_json if object.respond_to?(:to_json)
           MultiJson.dump(object)
         end

data/lib/grape/formatter/serializable_hash.rb

@@ -2,7 +2,7 @@ module Grape
   module Formatter
     module SerializableHash
       class << self
-        def call(object, env)
+        def call(object, _env)
           return object if object.is_a?(String)
           return MultiJson.dump(serialize(object)) if serializable?(object)
           return object.to_json if object.respond_to?(:to_json)
@@ -12,15 +12,15 @@ module Grape
         private
 
         def serializable?(object)
-          object.respond_to?(:serializable_hash) || object.kind_of?(Array) && !object.map { |o| o.respond_to? :serializable_hash }.include?(false) || object.kind_of?(Hash)
+          object.respond_to?(:serializable_hash) || object.is_a?(Array) && !object.map { |o| o.respond_to? :serializable_hash }.include?(false) || object.is_a?(Hash)
         end
 
         def serialize(object)
           if object.respond_to? :serializable_hash
             object.serializable_hash
-          elsif object.kind_of?(Array) && !object.map { |o| o.respond_to? :serializable_hash }.include?(false)
+          elsif object.is_a?(Array) && !object.map { |o| o.respond_to? :serializable_hash }.include?(false)
             object.map(&:serializable_hash)
-          elsif object.kind_of?(Hash)
+          elsif object.is_a?(Hash)
             object.inject({}) do |h, (k, v)|
               h[k] = serialize(v)
               h

data/lib/grape/formatter/txt.rb

@@ -2,7 +2,7 @@ module Grape
   module Formatter
     module Txt
       class << self
-        def call(object, env)
+        def call(object, _env)
           object.respond_to?(:to_txt) ? object.to_txt : object.to_s
         end
       end

data/lib/grape/formatter/xml.rb

@@ -2,7 +2,7 @@ module Grape
   module Formatter
     module Xml
       class << self
-        def call(object, env)
+        def call(object, _env)
           return object.to_xml if object.respond_to?(:to_xml)
           fail Grape::Exceptions::InvalidFormatter.new(object.class, 'xml')
         end

data/lib/grape/http/headers.rb

@@ -0,0 +1,27 @@
+module Grape
+  module Http
+    module Headers
+      # https://github.com/rack/rack/blob/master/lib/rack.rb
+      HTTP_VERSION    = 'HTTP_VERSION'.freeze
+      PATH_INFO       = 'PATH_INFO'.freeze
+      QUERY_STRING    = 'QUERY_STRING'.freeze
+      CONTENT_TYPE    = 'Content-Type'.freeze
+
+      GET     = 'GET'.freeze
+      POST    = 'POST'.freeze
+      PUT     = 'PUT'.freeze
+      PATCH   = 'PATCH'.freeze
+      DELETE  = 'DELETE'.freeze
+      HEAD    = 'HEAD'.freeze
+      OPTIONS = 'OPTIONS'.freeze
+
+      HTTP_ACCEPT_VERSION    = 'HTTP_ACCEPT_VERSION'.freeze
+      X_CASCADE              = 'X-Cascade'.freeze
+      HTTP_TRANSFER_ENCODING = 'HTTP_TRANSFER_ENCODING'.freeze
+      HTTP_ACCEPT            = 'HTTP_ACCEPT'.freeze
+
+      ACCEPT                 = 'accept'.freeze
+      FORMAT                 = 'format'.freeze
+    end
+  end
+end

data/lib/grape/http/request.rb

@@ -17,7 +17,7 @@ module Grape
     def headers
       @headers ||= env.dup.inject({}) do |h, (k, v)|
         if k.to_s.start_with? 'HTTP_'
-          k = k[5..-1].gsub('_', '-').downcase.gsub(/^.|[-_\s]./) { |x| x.upcase }
+          k = k[5..-1].tr('_', '-').downcase.gsub(/^.|[-_\s]./) { |x| x.upcase }
           h[k] = v
         end
         h

data/lib/grape/middleware/error.rb

@@ -29,7 +29,7 @@ module Grape
         rescue StandardError => e
           is_rescuable = rescuable?(e.class)
           if e.is_a?(Grape::Exceptions::Base) && !is_rescuable
-            handler = lambda { |arg| error_response(arg) }
+            handler = ->(arg) { error_response(arg) }
           else
             raise unless is_rescuable
             handler = find_handler(e.class)
@@ -47,7 +47,7 @@ module Grape
       end
 
       def rescuable?(klass)
-        options[:rescue_all] || (options[:rescue_handlers] || []).any? { |error, handler| klass <= error } || (options[:base_only_rescue_handlers] || []).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)
@@ -58,20 +58,26 @@ module Grape
         end
       end
 
+      def error!(message, status = options[:default_status], headers = {}, backtrace = [])
+        headers = { Grape::Http::Headers::CONTENT_TYPE => content_type }.merge(headers)
+        rack_response(format_message(message, backtrace), status, headers)
+      end
+
       def handle_error(e)
         error_response(message: e.message, backtrace: e.backtrace)
       end
 
+      # TODO: This method is deprecated. Refactor out.
       def error_response(error = {})
         status = error[:status] || options[:default_status]
         message = error[:message] || options[:default_message]
-        headers = { 'Content-Type' => content_type }
+        headers = { Grape::Http::Headers::CONTENT_TYPE => content_type }
         headers.merge!(error[:headers]) if error[:headers].is_a?(Hash)
         backtrace = error[:backtrace] || []
         rack_response(format_message(message, backtrace), status, headers)
       end
 
-      def rack_response(message, status = options[:default_status], headers = { 'Content-Type' => content_type })
+      def rack_response(message, status = options[:default_status], headers = { Grape::Http::Headers::CONTENT_TYPE => content_type })
         Rack::Response.new([message], status, headers).finish
       end
 

data/lib/grape/middleware/formatter.rb

@@ -26,17 +26,21 @@ module Grape
       def after
         status, headers, bodies = *@app_response
         # allow content-type to be explicitly overwritten
-        api_format = mime_types[headers['Content-Type']] || env['api.format']
+        api_format = mime_types[headers[Grape::Http::Headers::CONTENT_TYPE]] || env['api.format']
         formatter = Grape::Formatter::Base.formatter_for api_format, options
         begin
-          bodymap = bodies.collect do |body|
-            formatter.call body, env
-          end
+          bodymap = if bodies.respond_to?(:collect)
+                      bodies.collect do |body|
+                        formatter.call body, env
+                      end
+                    else
+                      bodies
+                    end
         rescue Grape::Exceptions::InvalidFormatter => e
           throw :error, status: 500, message: e.message
         end
-        headers['Content-Type'] = content_type_for(env['api.format']) unless headers['Content-Type']
-        Rack::Response.new(bodymap, status, headers).to_a
+        headers[Grape::Http::Headers::CONTENT_TYPE] = content_type_for(env['api.format']) unless headers[Grape::Http::Headers::CONTENT_TYPE]
+        Rack::Response.new(bodymap, status, headers)
       end
 
       private
@@ -50,7 +54,7 @@ module Grape
         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')
+           (request.content_length.to_i > 0 || request.env[Grape::Http::Headers::HTTP_TRANSFER_ENCODING] == 'chunked')
 
           if (input = env['rack.input'])
             input.rewind
@@ -115,7 +119,7 @@ module Grape
       end
 
       def format_from_params
-        fmt = Rack::Utils.parse_nested_query(env['QUERY_STRING'])['format']
+        fmt = Rack::Utils.parse_nested_query(env[Grape::Http::Headers::QUERY_STRING])[Grape::Http::Headers::FORMAT]
         # avoid symbol memory leak on an unknown format
         return fmt.to_sym if content_type_for(fmt)
         fmt
@@ -129,7 +133,7 @@ module Grape
       end
 
       def mime_array
-        accept = headers['accept']
+        accept = headers[Grape::Http::Headers::ACCEPT]
         return [] unless accept
 
         accept_into_mime_and_quality = %r{

data/lib/grape/middleware/globals.rb

@@ -4,7 +4,8 @@ module Grape
   module Middleware
     class Globals < Base
       def before
-        @env['grape.request'] = Grape::Request.new(@env)
+        request = Grape::Request.new(@env)
+        @env['grape.request'] = request
         @env['grape.request.headers'] = request.headers
         @env['grape.request.params'] = request.params if @env['rack.input']
       end

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

@@ -18,7 +18,7 @@ module Grape
       # route.
       class AcceptVersionHeader < Base
         def before
-          potential_version = (env['HTTP_ACCEPT_VERSION'] || '').strip
+          potential_version = (env[Grape::Http::Headers::HTTP_ACCEPT_VERSION] || '').strip
 
           if strict?
             # If no Accept-Version header:
@@ -59,7 +59,7 @@ module Grape
         end
 
         def error_headers
-          cascade? ? { 'X-Cascade' => 'pass' } : {}
+          cascade? ? { Grape::Http::Headers::X_CASCADE => 'pass' } : {}
         end
       end
     end

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

@@ -67,8 +67,8 @@ module Grape
         def available_media_types
           available_media_types = []
 
-          content_types.each do |extension, media_type|
-            versions.reverse.each do |version|
+          content_types.each do |extension, _media_type|
+            versions.reverse_each do |version|
               available_media_types += ["application/vnd.#{vendor}-#{version}+#{extension}", "application/vnd.#{vendor}-#{version}"]
             end
             available_media_types << "application/vnd.#{vendor}+#{extension}"
@@ -84,7 +84,7 @@ module Grape
         end
 
         def rack_accept_header
-          Rack::Accept::MediaType.new env['HTTP_ACCEPT']
+          Rack::Accept::MediaType.new env[Grape::Http::Headers::HTTP_ACCEPT]
         rescue RuntimeError => e
           raise Grape::Exceptions::InvalidAcceptHeader.new(e.message, error_headers)
         end
@@ -113,7 +113,7 @@ module Grape
         end
 
         def error_headers
-          cascade? ? { 'X-Cascade' => 'pass' } : {}
+          cascade? ? { Grape::Http::Headers::X_CASCADE => 'pass' } : {}
         end
 
         # @param [String] media_type a content type

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

@@ -27,10 +27,10 @@ module Grape
 
         def before
           paramkey = options[:parameter]
-          potential_version = Rack::Utils.parse_nested_query(env['QUERY_STRING'])[paramkey]
+          potential_version = Rack::Utils.parse_nested_query(env[Grape::Http::Headers::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' }
+              throw :error, status: 404, message: '404 API Version Not Found', headers: { Grape::Http::Headers::X_CASCADE => 'pass' }
             end
             env['api.version'] = potential_version
             env['rack.request.query_hash'].delete(paramkey) if env.key? 'rack.request.query_hash'

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

@@ -24,7 +24,7 @@ module Grape
         end
 
         def before
-          path = env['PATH_INFO'].dup
+          path = env[Grape::Http::Headers::PATH_INFO].dup
 
           if prefix && path.index(prefix) == 0
             path.sub!(prefix, '')

data/lib/grape/namespace.rb

@@ -5,7 +5,8 @@ module Grape
     # options:
     #   requirements: a hash
     def initialize(space, options = {})
-      @space, @options = space.to_s, options
+      @space = space.to_s
+      @options = options
     end
 
     def requirements

data/lib/grape/parser/json.rb

@@ -2,7 +2,7 @@ module Grape
   module Parser
     module Json
       class << self
-        def call(object, env)
+        def call(object, _env)
           MultiJson.load(object)
         rescue MultiJson::ParseError
           # handle JSON parsing errors via the rescue handlers or provide error message

data/lib/grape/parser/xml.rb

@@ -2,7 +2,7 @@ module Grape
   module Parser
     module Xml
       class << self
-        def call(object, env)
+        def call(object, _env)
           MultiXml.parse(object)
         rescue MultiXml::ParseError
           # handle XML parsing errors via the rescue handlers or provide error message

data/lib/grape/path.rb

@@ -17,7 +17,7 @@ module Grape
     end
 
     def root_prefix
-      split_setting(:root_prefix, '/')
+      split_setting(:root_prefix)
     end
 
     def uses_specific_format?
@@ -38,7 +38,7 @@ module Grape
 
     def suffix
       if uses_specific_format?
-        ''
+        "(.#{settings[:format]})"
       elsif !uses_path_versioning? || (has_namespace? || has_path?)
         '(.:format)'
       else
@@ -68,7 +68,7 @@ module Grape
       parts.flatten.reject { |part| part == '/' }
     end
 
-    def split_setting(key, delimiter)
+    def split_setting(key)
       return if settings[key].nil?
       settings[key].to_s.split('/')
     end

data/lib/grape/presenters/presenter.rb

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

data/lib/grape/validations/params_scope.rb

@@ -117,7 +117,7 @@ module Grape
         doc_attrs[:desc] = desc if desc
 
         default = validations[:default]
-        doc_attrs[:default] = default if default
+        doc_attrs[:default] = default if validations.key?(:default)
 
         values = validations[:values]
         doc_attrs[:values] = values if values
@@ -181,9 +181,9 @@ module Grape
       def validate_value_coercion(coerce_type, values)
         return unless coerce_type && values
         return if values.is_a?(Proc)
-        coerce_type = coerce_type.first if coerce_type.kind_of?(Array)
+        coerce_type = coerce_type.first if coerce_type.is_a?(Array)
         value_types = values.is_a?(Range) ? [values.begin, values.end] : values
-        if value_types.any? { |v| !v.kind_of?(coerce_type) }
+        if value_types.any? { |v| !v.is_a?(coerce_type) }
           fail Grape::Exceptions::IncompatibleOptionValues.new(:type, coerce_type, :values, values)
         end
       end

data/lib/grape/validations/validators/allow_blank.rb

@@ -21,7 +21,7 @@ module Grape
 
         return unless should_validate
 
-        unless value.present?
+        unless value == false || value.present?
           fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message_key: :blank
         end
       end

data/lib/grape/validations/validators/coerce.rb

@@ -32,7 +32,7 @@ module Grape
           val.is_a?(TrueClass) || val.is_a?(FalseClass) || (val.is_a?(String) && val.empty?)
         elsif klass == Rack::Multipart::UploadedFile
           val.is_a?(Hashie::Mash) && val.key?(:tempfile)
-        elsif [DateTime, Date, Numeric].any?{ |vclass| vclass >= klass }
+        elsif [DateTime, Date, Numeric].any? { |vclass| vclass >= klass }
           return true if val.is_a?(String) && val.empty?
           val.is_a?(klass)
         else
@@ -41,8 +41,8 @@ module Grape
       end
 
       def valid_type?(val)
-        if @option.is_a?(Array)
-          _valid_array_type?(@option[0], val)
+        if @option.is_a?(Array) || @option.is_a?(Set)
+          _valid_array_type?(@option.first, val)
         else
           _valid_single_type?(@option, val)
         end
@@ -50,8 +50,9 @@ module Grape
 
       def coerce_value(type, val)
         # Don't coerce things other than nil to Arrays or Hashes
-        return val || [] if type == Array
-        return val || {} if type == Hash
+        return val || []      if type == Array
+        return val || Set.new if type == Set
+        return val || {}      if type == Hash
 
         converter = Virtus::Attribute.build(type)
         converter.coerce(val)

data/lib/grape/validations/validators/default.rb

@@ -11,12 +11,12 @@ module Grape
       end
 
       def validate!(params)
+        return unless @scope.should_validate?(params)
+
         attrs = AttributesIterator.new(self, @scope, params)
-        parent_element = @scope.element
         attrs.each do |resource_params, attr_name|
           if resource_params[attr_name].nil?
             validate_param!(attr_name, resource_params)
-            params[parent_element] = resource_params if parent_element && params[parent_element].nil?
           end
         end
       end

data/lib/grape/validations/validators/multiple_params_base.rb

@@ -15,6 +15,7 @@ module Grape
       end
 
       def keys_in_common(resource_params)
+        return [] unless resource_params.is_a?(Hash)
         (all_keys & resource_params.stringify_keys.keys).map(&:to_s)
       end