grape 1.1.0 → 1.7.1

data/lib/grape.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'rack'
 require 'rack/builder'
@@ -5,24 +7,27 @@ 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/core_ext/hash/indifferent_access'
-require 'active_support/core_ext/object/blank'
+require 'active_support/isolated_execution_state' if ActiveSupport::VERSION::MAJOR > 6
+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/reverse_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/hash/conversions'
+require 'active_support/core_ext/object/blank'
 require 'active_support/dependencies/autoload'
 require 'active_support/notifications'
 require 'i18n'
-require 'thread'
-
-require 'virtus'
 
-I18n.load_path << File.expand_path('../grape/locale/en.yml', __FILE__)
+I18n.load_path << File.expand_path('grape/locale/en.yml', __dir__)
 
 module Grape
   extend ::ActiveSupport::Autoload
@@ -34,7 +39,6 @@ module Grape
     autoload :Namespace
 
     autoload :Path
-
     autoload :Cookies
     autoload :Validations
     autoload :ErrorFormatter
@@ -44,6 +48,7 @@ module Grape
     autoload :Env, 'grape/util/env'
     autoload :Json, 'grape/util/json'
     autoload :Xml, 'grape/util/xml'
+    autoload :DryTypes
   end
 
   module Http
@@ -55,105 +60,128 @@ module Grape
 
   module Exceptions
     extend ::ActiveSupport::Autoload
-    autoload :Base
-    autoload :Validation
-    autoload :ValidationArrayErrors
-    autoload :ValidationErrors
-    autoload :MissingVendorOption
-    autoload :MissingMimeType
-    autoload :MissingOption
-    autoload :InvalidFormatter
-    autoload :InvalidVersionerOption
-    autoload :UnknownValidator
-    autoload :UnknownOptions
-    autoload :UnknownParameter
-    autoload :InvalidWithOptionForRepresent
-    autoload :IncompatibleOptionValues
-    autoload :MissingGroupTypeError,          'grape/exceptions/missing_group_type'
-    autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
-    autoload :InvalidMessageBody
-    autoload :InvalidAcceptHeader
-    autoload :InvalidVersionHeader
-    autoload :MethodNotAllowed
+    eager_autoload do
+      autoload :Base
+      autoload :Validation
+      autoload :ValidationArrayErrors
+      autoload :ValidationErrors
+      autoload :MissingVendorOption
+      autoload :MissingMimeType
+      autoload :MissingOption
+      autoload :InvalidFormatter
+      autoload :InvalidVersionerOption
+      autoload :UnknownValidator
+      autoload :UnknownOptions
+      autoload :UnknownParameter
+      autoload :InvalidWithOptionForRepresent
+      autoload :IncompatibleOptionValues
+      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
 
   module Extensions
     extend ::ActiveSupport::Autoload
-
-    autoload :DeepMergeableHash
-    autoload :DeepSymbolizeHash
-    autoload :DeepHashWithIndifferentAccess
-    autoload :Hash
-
+    eager_autoload do
+      autoload :DeepMergeableHash
+      autoload :DeepSymbolizeHash
+      autoload :Hash
+    end
     module ActiveSupport
       extend ::ActiveSupport::Autoload
-
-      autoload :HashWithIndifferentAccess
+      eager_autoload do
+        autoload :HashWithIndifferentAccess
+      end
     end
 
     module Hashie
       extend ::ActiveSupport::Autoload
-
-      autoload :Mash
+      eager_autoload do
+        autoload :Mash
+      end
     end
   end
 
   module Middleware
     extend ::ActiveSupport::Autoload
-    autoload :Base
-    autoload :Versioner
-    autoload :Formatter
-    autoload :Error
-    autoload :Globals
-    autoload :Stack
+    eager_autoload do
+      autoload :Base
+      autoload :Versioner
+      autoload :Formatter
+      autoload :Error
+      autoload :Globals
+      autoload :Stack
+      autoload :Helpers
+    end
 
     module Auth
       extend ::ActiveSupport::Autoload
-      autoload :Base
-      autoload :DSL
-      autoload :StrategyInfo
-      autoload :Strategies
+      eager_autoload do
+        autoload :Base
+        autoload :DSL
+        autoload :StrategyInfo
+        autoload :Strategies
+      end
     end
 
     module Versioner
       extend ::ActiveSupport::Autoload
-      autoload :Path
-      autoload :Header
-      autoload :Param
-      autoload :AcceptVersionHeader
+      eager_autoload do
+        autoload :Path
+        autoload :Header
+        autoload :Param
+        autoload :AcceptVersionHeader
+      end
     end
   end
 
   module Util
     extend ::ActiveSupport::Autoload
-    autoload :InheritableValues
-    autoload :StackableValues
-    autoload :ReverseStackableValues
-    autoload :InheritableSetting
-    autoload :StrictHashConfiguration
-    autoload :Registrable
+    eager_autoload do
+      autoload :InheritableValues
+      autoload :StackableValues
+      autoload :ReverseStackableValues
+      autoload :InheritableSetting
+      autoload :StrictHashConfiguration
+      autoload :Registrable
+    end
   end
 
   module ErrorFormatter
     extend ::ActiveSupport::Autoload
-    autoload :Base
-    autoload :Json
-    autoload :Txt
-    autoload :Xml
+    eager_autoload do
+      autoload :Base
+      autoload :Json
+      autoload :Txt
+      autoload :Xml
+    end
   end
 
   module Formatter
     extend ::ActiveSupport::Autoload
-    autoload :Json
-    autoload :SerializableHash
-    autoload :Txt
-    autoload :Xml
+    eager_autoload do
+      autoload :Json
+      autoload :SerializableHash
+      autoload :Txt
+      autoload :Xml
+    end
   end
 
   module Parser
     extend ::ActiveSupport::Autoload
-    autoload :Json
-    autoload :Xml
+    eager_autoload do
+      autoload :Json
+      autoload :Xml
+    end
   end
 
   module DSL
@@ -177,40 +205,93 @@ module Grape
 
   class API
     extend ::ActiveSupport::Autoload
-    autoload :Helpers
+    eager_autoload do
+      autoload :Helpers
+    end
   end
 
   module Presenters
     extend ::ActiveSupport::Autoload
-    autoload :Presenter
+    eager_autoload do
+      autoload :Presenter
+    end
   end
 
-  module ServeFile
+  module ServeStream
     extend ::ActiveSupport::Autoload
-    autoload :FileResponse
-    autoload :FileBody
-    autoload :SendfileResponse
+    eager_autoload do
+      autoload :FileBody
+      autoload :SendfileResponse
+      autoload :StreamResponse
+    end
+  end
+
+  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 :DryTypeCoercer
+        autoload :ArrayCoercer
+        autoload :SetCoercer
+        autoload :PrimitiveCoercer
+        autoload :CustomTypeCoercer
+        autoload :CustomTypeCollectionCoercer
+        autoload :MultipleTypeCoercer
+        autoload :VariantCollectionCoercer
+      end
+    end
+
+    module Validators
+      extend ::ActiveSupport::Autoload
+
+      eager_autoload do
+        autoload :Base
+        autoload :MultipleParamsBase
+        autoload :AllOrNoneOfValidator
+        autoload :AllowBlankValidator
+        autoload :AsValidator
+        autoload :AtLeastOneOfValidator
+        autoload :CoerceValidator
+        autoload :DefaultValidator
+        autoload :ExactlyOneOfValidator
+        autoload :ExceptValuesValidator
+        autoload :MutualExclusionValidator
+        autoload :PresenceValidator
+        autoload :RegexpValidator
+        autoload :SameAsValidator
+        autoload :ValuesValidator
+      end
+    end
+  end
+
+  module Types
+    extend ::ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :InvalidValue
+    end
   end
 end
 
-require 'grape/util/content_types'
-
-require 'grape/validations/validators/base'
-require 'grape/validations/attributes_iterator'
-require 'grape/validations/validators/allow_blank'
-require 'grape/validations/validators/as'
-require 'grape/validations/validators/at_least_one_of'
-require 'grape/validations/validators/coerce'
-require 'grape/validations/validators/default'
-require 'grape/validations/validators/exactly_one_of'
-require 'grape/validations/validators/mutual_exclusion'
-require 'grape/validations/validators/presence'
-require 'grape/validations/validators/regexp'
-require 'grape/validations/validators/values'
-require 'grape/validations/validators/except_values'
-require 'grape/validations/params_scope'
-require 'grape/validations/validators/all_or_none'
-require 'grape/validations/types'
-require 'grape/validations/validator_factory'
+require 'grape/config'
+require 'grape/content_types'
+
+require 'grape/util/lazy_value'
+require 'grape/util/lazy_block'
+require 'grape/util/endpoint_configuration'
 
 require 'grape/version'

data/spec/grape/api/custom_validations_spec.rb

@@ -1,18 +1,48 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Grape::Validations do
-  context 'using a custom length validator' do
-    before do
-      module CustomValidationsSpec
-        class DefaultLength < Grape::Validations::Base
-          def validate_param!(attr_name, params)
-            @option = params[:max].to_i if params.key?(:max)
-            return if params[attr_name].length <= @option
-            raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long"
-          end
+  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
         params do
@@ -24,6 +54,25 @@ describe Grape::Validations do
       end
     end
 
+    let(:default_length_validator) do
+      Class.new(Grape::Validations::Validators::Base) do
+        def validate_param!(attr_name, params)
+          @option = params[:max].to_i if params.key?(:max)
+          return if params[attr_name].length <= @option
+
+          raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long")
+        end
+      end
+    end
+
+    before do
+      described_class.register_validator('default_length', default_length_validator)
+    end
+
+    after do
+      described_class.deregister_validator('default_length')
+    end
+
     def app
       subject
     end
@@ -33,11 +82,13 @@ describe Grape::Validations do
       expect(last_response.status).to eq 200
       expect(last_response.body).to eq 'bacon'
     end
+
     it 'over 140 characters' do
       get '/', text: 'a' * 141
       expect(last_response.status).to eq 400
       expect(last_response.body).to eq 'text must be at the most 140 characters long'
     end
+
     it 'specified in the query string' do
       get '/', text: 'a' * 141, max: 141
       expect(last_response.status).to eq 200
@@ -46,15 +97,6 @@ describe Grape::Validations do
   end
 
   context 'using a custom body-only validator' do
-    before do
-      module CustomValidationsSpec
-        class InBody < Grape::Validations::PresenceValidator
-          def validate(request)
-            validate!(request.env['api.request.body'])
-          end
-        end
-      end
-    end
     subject do
       Class.new(Grape::API) do
         params do
@@ -66,6 +108,22 @@ describe Grape::Validations do
       end
     end
 
+    let(:in_body_validator) do
+      Class.new(Grape::Validations::Validators::PresenceValidator) do
+        def validate(request)
+          validate!(request.env['api.request.body'])
+        end
+      end
+    end
+
+    before do
+      described_class.register_validator('in_body', in_body_validator)
+    end
+
+    after do
+      described_class.deregister_validator('in_body')
+    end
+
     def app
       subject
     end
@@ -75,6 +133,7 @@ describe Grape::Validations do
       expect(last_response.status).to eq 200
       expect(last_response.body).to eq 'bacon'
     end
+
     it 'ignores field in query' do
       get '/', nil, text: 'abc'
       expect(last_response.status).to eq 400
@@ -83,15 +142,6 @@ describe Grape::Validations do
   end
 
   context 'using a custom validator with message_key' do
-    before do
-      module CustomValidationsSpec
-        class WithMessageKey < Grape::Validations::PresenceValidator
-          def validate_param!(attr_name, _params)
-            raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: :presence
-          end
-        end
-      end
-    end
     subject do
       Class.new(Grape::API) do
         params do
@@ -103,6 +153,22 @@ describe Grape::Validations do
       end
     end
 
+    let(:message_key_validator) do
+      Class.new(Grape::Validations::Validators::PresenceValidator) do
+        def validate_param!(attr_name, _params)
+          raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: :presence)
+        end
+      end
+    end
+
+    before do
+      described_class.register_validator('with_message_key', message_key_validator)
+    end
+
+    after do
+      described_class.deregister_validator('with_message_key')
+    end
+
     def app
       subject
     end
@@ -115,22 +181,6 @@ describe Grape::Validations do
   end
 
   context 'using a custom request/param validator' do
-    before do
-      module CustomValidationsSpec
-        class Admin < Grape::Validations::Base
-          def validate(request)
-            # return if the param we are checking was not in request
-            # @attrs is a list containing the attribute we are currently validating
-            return unless request.params.key? @attrs.first
-            # check if admin flag is set to true
-            return unless @option
-            # check if user is admin or not
-            # as an example get a token from request and check if it's admin or not
-            raise Grape::Exceptions::Validation, params: @attrs, message: 'Can not set Admin only field.' unless request.headers['X-Access-Token'] == 'admin'
-          end
-        end
-      end
-    end
     subject do
       Class.new(Grape::API) do
         params do
@@ -144,6 +194,29 @@ describe Grape::Validations do
       end
     end
 
+    let(:admin_validator) do
+      Class.new(Grape::Validations::Validators::Base) do
+        def validate(request)
+          # return if the param we are checking was not in request
+          # @attrs is a list containing the attribute we are currently validating
+          return unless request.params.key? @attrs.first
+          # check if admin flag is set to true
+          return unless @option
+          # check if user is admin or not
+          # as an example get a token from request and check if it's admin or not
+          raise Grape::Exceptions::Validation.new(params: @attrs, message: 'Can not set Admin only field.') unless request.headers['X-Access-Token'] == 'admin'
+        end
+      end
+    end
+
+    before do
+      described_class.register_validator('admin', admin_validator)
+    end
+
+    after do
+      described_class.deregister_validator('admin')
+    end
+
     def app
       subject
     end

data/spec/grape/api/deeply_included_options_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
 module DeeplyIncludedOptionsSpec
   module Defaults
@@ -39,18 +39,18 @@ describe Grape::API do
 
   it 'works for unspecified format' do
     get '/users'
-    expect(last_response.status).to eql 200
+    expect(last_response.status).to be 200
     expect(last_response.content_type).to eql 'application/json'
   end
 
   it 'works for specified format' do
     get '/users.json'
-    expect(last_response.status).to eql 200
+    expect(last_response.status).to be 200
     expect(last_response.content_type).to eql 'application/json'
   end
 
   it "doesn't work for format different than specified" do
     get '/users.txt'
-    expect(last_response.status).to eql 404
+    expect(last_response.status).to be 404
   end
 end

data/spec/grape/api/defines_boolean_in_params_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+describe Grape::API::Instance do
+  describe 'boolean constant' do
+    module DefinesBooleanInstanceSpec
+      class API < Grape::API
+        params do
+          requires :message, type: Boolean
+        end
+        post :echo do
+          { class: params[:message].class.name, value: params[:message] }
+        end
+      end
+    end
+
+    def app
+      DefinesBooleanInstanceSpec::API
+    end
+
+    let(:expected_body) do
+      { class: 'TrueClass', value: true }.to_s
+    end
+
+    it 'sets Boolean as a type' do
+      post '/echo?message=true'
+      expect(last_response.status).to eq(201)
+      expect(last_response.body).to eq expected_body
+    end
+
+    context 'Params endpoint type' do
+      subject { DefinesBooleanInstanceSpec::API.new.router.map['POST'].first.options[:params]['message'][:type] }
+
+      it 'params type is a boolean' do
+        expect(subject).to eq 'Grape::API::Boolean'
+      end
+    end
+  end
+end