grape 1.6.1 → 1.7.0

data/lib/grape/validations/types.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'grape/validations/types/json'
+require 'grape/validations/types/file'
+
 module Grape
   module Validations
     # Module for code related to grape's system for
@@ -13,7 +16,8 @@ module Grape
     # and {Grape::Dsl::Parameters#optional}. The main
     # entry point for this process is {Types.build_coercer}.
     module Types
-      # Types representing a single value, which are coerced.
+      module_function
+
       PRIMITIVES = [
         # Numerical
         Integer,
@@ -35,33 +39,23 @@ module Grape
       ].freeze
 
       # Types representing data structures.
-      STRUCTURES = [
-        Hash,
-        Array,
-        Set
-      ].freeze
+      STRUCTURES = [Hash, Array, Set].freeze
 
-      # Special custom types provided by Grape.
       SPECIAL = {
-        JSON => Json,
+        ::JSON => Json,
         Array[JSON] => JsonArray,
         ::File => File,
         Rack::Multipart::UploadedFile => File
       }.freeze
 
-      GROUPS = [
-        Array,
-        Hash,
-        JSON,
-        Array[JSON]
-      ].freeze
+      GROUPS = [Array, Hash, JSON, Array[JSON]].freeze
 
       # Is the given class a primitive type as recognized by Grape?
       #
       # @param type [Class] type to check
       # @return [Boolean] whether or not the type is known by Grape as a valid
       #   type for a single value
-      def self.primitive?(type)
+      def primitive?(type)
         PRIMITIVES.include?(type)
       end
 
@@ -71,7 +65,7 @@ module Grape
       # @param type [Class] type to check
       # @return [Boolean] whether or not the type is known by Grape as a valid
       #   data structure type
-      def self.structure?(type)
+      def structure?(type)
         STRUCTURES.include?(type)
       end
 
@@ -83,7 +77,7 @@ module Grape
       # @param type [Array<Class>,Set<Class>] type (or type list!) to check
       # @return [Boolean] +true+ if the given value will be treated as
       #   a list of types.
-      def self.multiple?(type)
+      def multiple?(type)
         (type.is_a?(Array) || type.is_a?(Set)) && type.size > 1
       end
 
@@ -94,7 +88,7 @@ module Grape
       #
       # @param type [Class] type to check
       # @return [Boolean] +true+ if special routines are available
-      def self.special?(type)
+      def special?(type)
         SPECIAL.key? type
       end
 
@@ -103,7 +97,7 @@ module Grape
       #
       # @param type [Array<Class>,Class] type to check
       # @return [Boolean] +true+ if the type is a supported group type
-      def self.group?(type)
+      def group?(type)
         GROUPS.include? type
       end
 
@@ -112,7 +106,7 @@ module Grape
       #
       # @param type [Class] type to check
       # @return [Boolean] whether or not the type can be used as a custom type
-      def self.custom?(type)
+      def custom?(type)
         !primitive?(type) &&
           !structure?(type) &&
           !multiple?(type) &&
@@ -125,13 +119,13 @@ module Grape
       # @param type [Array<Class>,Class] type to check
       # @return [Boolean] true if +type+ is a collection of a type that implements
       #   its own +#parse+ method.
-      def self.collection_of_custom?(type)
+      def collection_of_custom?(type)
         (type.is_a?(Array) || type.is_a?(Set)) &&
           type.length == 1 &&
           (custom?(type.first) || special?(type.first))
       end
 
-      def self.map_special(type)
+      def map_special(type)
         SPECIAL.fetch(type, type)
       end
 
@@ -163,13 +157,13 @@ module Grape
       # @param method [Class,#call] the coercion method to use
       # @return [Object] object to be used
       #   for coercion and type validation
-      def self.build_coercer(type, method: nil, strict: false)
+      def build_coercer(type, method: nil, strict: false)
         cache_instance(type, method, strict) do
           create_coercer_instance(type, method, strict)
         end
       end
 
-      def self.create_coercer_instance(type, method, strict)
+      def create_coercer_instance(type, method, strict)
         # Maps a custom type provided by Grape, it doesn't map types wrapped by collections!!!
         type = Types.map_special(type)
 
@@ -193,7 +187,7 @@ module Grape
         end
       end
 
-      def self.cache_instance(type, method, strict, &_block)
+      def cache_instance(type, method, strict, &_block)
         key = cache_key(type, method, strict)
 
         return @__cache[key] if @__cache.key?(key)
@@ -207,7 +201,7 @@ module Grape
         instance
       end
 
-      def self.cache_key(type, method, strict)
+      def cache_key(type, method, strict)
         [type, method, strict].each_with_object(+'_') do |val, memo|
           next if val.nil?
 

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

@@ -93,3 +93,10 @@ module Grape
     end
   end
 end
+
+Grape::Validations::Base = Class.new(Grape::Validations::Validators::Base) do
+  def initialize(*)
+    super
+    warn '[DEPRECATION] `Grape::Validations::Base` is deprecated. Use `Grape::Validations::Validators::Base` instead.'
+  end
+end

data/lib/grape/validations.rb

@@ -3,22 +3,32 @@
 module Grape
   # Registry to store and locate known Validators.
   module Validations
-    class << self
-      attr_accessor :validators
-    end
+    module_function
 
-    self.validators = {}
+    def validators
+      @validators ||= {}
+    end
 
     # Register a new validator, so it can be used to validate parameters.
     # @param short_name [String] all lower-case, no spaces
     # @param klass [Class] the validator class. Should inherit from
     #   Validations::Base.
-    def self.register_validator(short_name, klass)
+    def register_validator(short_name, klass)
       validators[short_name] = klass
     end
 
-    def self.deregister_validator(short_name)
+    def deregister_validator(short_name)
       validators.delete(short_name)
     end
+
+    # Find a validator and if not found will try to load it
+    def require_validator(short_name)
+      str_name = short_name.to_s
+      validators.fetch(str_name) do
+        Grape::Validations::Validators.const_get("#{str_name.camelize}Validator")
+      end
+    rescue NameError
+      raise Grape::Exceptions::UnknownValidator.new(short_name)
+    end
   end
 end

data/lib/grape/version.rb

@@ -2,5 +2,5 @@
 
 module Grape
   # The current version of Grape.
-  VERSION = '1.6.1'
+  VERSION = '1.7.0'
 end

data/lib/grape.rb

@@ -7,19 +7,22 @@ require 'rack/accept'
 require 'rack/auth/basic'
 require 'rack/auth/digest/md5'
 require 'set'
+require 'bigdecimal'
+require 'date'
 require 'active_support'
+require 'active_support/concern'
 require 'active_support/version'
 require 'active_support/isolated_execution_state' if ActiveSupport::VERSION::MAJOR > 6
-require 'active_support/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/array/conversions'
 require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/array/wrap'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/core_ext/hash/deep_merge'
 require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/hash/reverse_merge'
 require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/object/blank'
 require 'active_support/dependencies/autoload'
 require 'active_support/notifications'
 require 'i18n'
@@ -72,14 +75,17 @@ module Grape
       autoload :UnknownParameter
       autoload :InvalidWithOptionForRepresent
       autoload :IncompatibleOptionValues
-      autoload :MissingGroupTypeError,          'grape/exceptions/missing_group_type'
-      autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
+      autoload :MissingGroupType
+      autoload :UnsupportedGroupType
       autoload :InvalidMessageBody
       autoload :InvalidAcceptHeader
       autoload :InvalidVersionHeader
       autoload :MethodNotAllowed
       autoload :InvalidResponse
       autoload :EmptyMessageBody
+      autoload :TooManyMultipartFiles
+      autoload :MissingGroupTypeError, 'grape/exceptions/missing_group_type'
+      autoload :UnsupportedGroupTypeError, 'grape/exceptions/unsupported_group_type'
     end
   end
 
@@ -223,13 +229,21 @@ module Grape
   module Validations
     extend ::ActiveSupport::Autoload
 
+    eager_autoload do
+      autoload :AttributesIterator
+      autoload :MultipleAttributesIterator
+      autoload :SingleAttributeIterator
+      autoload :Types
+      autoload :ParamsScope
+      autoload :ValidatorFactory
+      autoload :Base, 'grape/validations/validators/base'
+    end
+
     module Types
       extend ::ActiveSupport::Autoload
 
       eager_autoload do
         autoload :InvalidValue
-        autoload :File
-        autoload :Json
         autoload :DryTypeCoercer
         autoload :ArrayCoercer
         autoload :SetCoercer
@@ -241,15 +255,6 @@ module Grape
       end
     end
 
-    eager_autoload do
-      autoload :AttributesIterator
-      autoload :MultipleAttributesIterator
-      autoload :SingleAttributeIterator
-      autoload :ParamsScope
-      autoload :Types
-      autoload :ValidatorFactory
-    end
-
     module Validators
       extend ::ActiveSupport::Autoload
 

data/spec/grape/api/custom_validations_spec.rb

@@ -1,8 +1,47 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations do
+  context 'deprecated Grape::Validations::Base' do
+    subject do
+      Class.new(Grape::API) do
+        params do
+          requires :text, validator_with_old_base: true
+        end
+        get do
+        end
+      end
+    end
+
+    let(:validator_with_old_base) do
+      Class.new(Grape::Validations::Base) do
+        def validate_param!(_attr_name, _params)
+          true
+        end
+      end
+    end
+
+    before do
+      described_class.register_validator('validator_with_old_base', validator_with_old_base)
+      allow(Warning).to receive(:warn)
+    end
+
+    after do
+      described_class.deregister_validator('validator_with_old_base')
+    end
+
+    def app
+      subject
+    end
+
+    it 'puts a deprecation warning' do
+      expect(Warning).to receive(:warn) do |message|
+        expect(message).to include('`Grape::Validations::Base` is deprecated')
+      end
+
+      get '/'
+    end
+  end
+
   context 'using a custom length validator' do
     subject do
       Class.new(Grape::API) do

data/spec/grape/api/deeply_included_options_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module DeeplyIncludedOptionsSpec
   module Defaults
     extend ActiveSupport::Concern

data/spec/grape/api/defines_boolean_in_params_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Instance do
   describe 'boolean constant' do
     module DefinesBooleanInstanceSpec

data/spec/grape/api/documentation_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::API do
+  subject { Class.new(described_class) }
+
+  let(:app) { subject }
+
+  context 'an endpoint with documentation' do
+    it 'documents parameters' do
+      subject.params do
+        requires 'price', type: Float, desc: 'Sales price'
+      end
+      subject.get '/'
+
+      expect(subject.routes.first.params['price']).to eq(required: true,
+                                                         type: 'Float',
+                                                         desc: 'Sales price')
+    end
+
+    it 'allows documentation with a hash' do
+      documentation = { example: 'Joe' }
+
+      subject.params do
+        requires 'first_name', documentation: documentation
+      end
+      subject.get '/'
+
+      expect(subject.routes.first.params['first_name'][:documentation]).to eq(documentation)
+    end
+  end
+
+  context 'an endpoint without documentation' do
+    before do
+      subject.do_not_document!
+
+      subject.params do
+        requires :city, type: String, desc: 'Should be ignored'
+        optional :postal_code, type: Integer
+      end
+      subject.post '/' do
+        declared(params).to_json
+      end
+    end
+
+    it 'does not document parameters for the endpoint' do
+      expect(subject.routes.first.params).to eq({})
+    end
+
+    it 'still declares params internally' do
+      data = { city: 'Berlin', postal_code: 10_115 }
+
+      post '/', data
+
+      expect(last_response.body).to eq(data.to_json)
+    end
+  end
+end

data/spec/grape/api/inherited_helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   let(:user) { 'Miguel Caneo' }
   let(:id)   { '42' }

data/spec/grape/api/instance_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 require 'shared/versioning_examples'
 
 describe Grape::API::Instance do

data/spec/grape/api/invalid_format_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/namespace_parameters_in_route_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/nested_helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   module NestedHelpersSpec
     module HelperMethods

data/spec/grape/api/optional_parameters_in_route_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/parameters_modification_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/patch_method_helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   module PatchHelpersSpec
     class PatchPublic < Grape::API

data/spec/grape/api/recognize_path_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API do
   describe '.recognize_path' do
     subject { Class.new(described_class) }

data/spec/grape/api/required_parameters_in_route_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/required_parameters_with_invalid_method_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/routes_with_requirements_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Endpoint do
   subject { Class.new(Grape::API) }
 

data/spec/grape/api/shared_helpers_exactly_one_of_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   let(:app) do
     Class.new(Grape::API) do

data/spec/grape/api/shared_helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::API::Helpers do
   subject do
     shared_params = Module.new do

data/spec/grape/api_remount_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 require 'shared/versioning_examples'
 
 describe Grape::API do

data/spec/grape/api_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 require 'shared/versioning_examples'
 
 describe Grape::API do
@@ -1217,7 +1216,7 @@ describe Grape::API do
 
     it 'does not set Cache-Control' do
       get '/foo'
-      expect(last_response.headers['Cache-Control']).to eq(nil)
+      expect(last_response.headers['Cache-Control']).to be_nil
     end
 
     it 'sets content type for xml' do
@@ -1242,7 +1241,7 @@ describe Grape::API do
 
     it 'returns raw data when content type binary' do
       image_filename = 'grape.png'
-      file = File.open(image_filename, 'rb', &:read)
+      file = File.binread(image_filename)
       subject.format :binary
       subject.get('/binary_file') { File.binread(image_filename) }
       get '/binary_file'
@@ -1274,7 +1273,7 @@ describe Grape::API do
       get '/stream', {}, 'HTTP_VERSION' => 'HTTP/1.1', 'SERVER_PROTOCOL' => 'HTTP/1.1'
 
       expect(last_response.headers['Content-Type']).to eq('text/plain')
-      expect(last_response.headers['Content-Length']).to eq(nil)
+      expect(last_response.headers['Content-Length']).to be_nil
       expect(last_response.headers['Cache-Control']).to eq('no-cache')
       expect(last_response.headers['Transfer-Encoding']).to eq('chunked')
 
@@ -2292,7 +2291,7 @@ describe Grape::API do
       subject.rescue_from :all, with: :not_exist_method
       subject.get('/rescue_method') { raise StandardError }
 
-      expect { get '/rescue_method' }.to raise_error(NoMethodError, /^undefined method `not_exist_method'/)
+      expect { get '/rescue_method' }.to raise_error(NoMethodError, /^undefined method 'not_exist_method'/)
     end
 
     it 'correctly chooses exception handler if :all handler is specified' do
@@ -4158,6 +4157,20 @@ describe Grape::API do
     end
   end
 
+  context 'with non-UTF-8 characters in specified format' do
+    it 'converts the characters' do
+      subject.format :json
+      subject.content_type :json, 'application/json'
+      subject.get '/something' do
+        'foo'
+      end
+      get '/something?format=%0A%0B%BF'
+      expect(last_response.status).to eq(406)
+      message = "The requested format '\n\u000b\357\277\275' is not supported."
+      expect(last_response.body).to eq({ error: message }.to_json)
+    end
+  end
+
   context 'body' do
     context 'false' do
       before do

data/spec/grape/config_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe '.configure' do
   before do
     Grape.configure do |config|

data/spec/grape/dsl/callbacks_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module CallbacksSpec

data/spec/grape/dsl/configuration_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module ConfigurationSpec

data/spec/grape/dsl/desc_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module DescSpec

data/spec/grape/dsl/headers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module HeadersSpec
@@ -54,8 +52,8 @@ module Grape
       context 'when no headers are set' do
         describe '#header' do
           it 'returns nil' do
-            expect(subject.header['First Key']).to be nil
-            expect(subject.header('First Key')).to be nil
+            expect(subject.header['First Key']).to be_nil
+            expect(subject.header('First Key')).to be_nil
           end
         end
       end

data/spec/grape/dsl/helpers_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module DSL
     module HelpersSpec