grape 1.5.2 → 1.6.2

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

@@ -2,81 +2,86 @@
 
 module Grape
   module Validations
-    class ValuesValidator < Base
-      def initialize(attrs, options, required, scope, **opts)
-        if options.is_a?(Hash)
-          @excepts = options[:except]
-          @values = options[:value]
-          @proc = options[:proc]
-
-          warn '[DEPRECATION] The values validator except option is deprecated. ' \
-               'Use the except validator instead.' if @excepts
-
-          raise ArgumentError, 'proc must be a Proc' if @proc && !@proc.is_a?(Proc)
-          warn '[DEPRECATION] The values validator proc option is deprecated. ' \
-               'The lambda expression can now be assigned directly to values.' if @proc
-        else
-          @excepts = nil
-          @values = nil
-          @proc = nil
-          @values = options
+    module Validators
+      class ValuesValidator < Base
+        def initialize(attrs, options, required, scope, **opts)
+          if options.is_a?(Hash)
+            @excepts = options[:except]
+            @values = options[:value]
+            @proc = options[:proc]
+
+            warn '[DEPRECATION] The values validator except option is deprecated. ' \
+                 'Use the except validator instead.' if @excepts
+
+            raise ArgumentError, 'proc must be a Proc' if @proc && !@proc.is_a?(Proc)
+
+            warn '[DEPRECATION] The values validator proc option is deprecated. ' \
+                 'The lambda expression can now be assigned directly to values.' if @proc
+          else
+            @excepts = nil
+            @values = nil
+            @proc = nil
+            @values = options
+          end
+          super
         end
-        super
-      end
 
-      def validate_param!(attr_name, params)
-        return unless params.is_a?(Hash)
+        def validate_param!(attr_name, params)
+          return unless params.is_a?(Hash)
 
-        val = params[attr_name]
+          val = params[attr_name]
 
-        return if val.nil? && !required_for_root_scope?
+          return if val.nil? && !required_for_root_scope?
 
-        # don't forget that +false.blank?+ is true
-        return if val != false && val.blank? && @allow_blank
+          # don't forget that +false.blank?+ is true
+          return if val != false && val.blank? && @allow_blank
 
-        param_array = val.nil? ? [nil] : Array.wrap(val)
+          param_array = val.nil? ? [nil] : Array.wrap(val)
 
-        raise validation_exception(attr_name, except_message) \
+          raise validation_exception(attr_name, except_message) \
           unless check_excepts(param_array)
 
-        raise validation_exception(attr_name, message(:values)) \
+          raise validation_exception(attr_name, message(:values)) \
           unless check_values(param_array, attr_name)
 
-        raise validation_exception(attr_name, message(:values)) \
+          raise validation_exception(attr_name, message(:values)) \
           if @proc && !param_array.all? { |param| @proc.call(param) }
-      end
+        end
+
+        private
 
-      private
+        def check_values(param_array, attr_name)
+          values = @values.is_a?(Proc) && @values.arity.zero? ? @values.call : @values
+          return true if values.nil?
 
-      def check_values(param_array, attr_name)
-        values = @values.is_a?(Proc) && @values.arity.zero? ? @values.call : @values
-        return true if values.nil?
-        begin
-          return param_array.all? { |param| values.call(param) } if values.is_a? Proc
-        rescue StandardError => e
-          warn "Error '#{e}' raised while validating attribute '#{attr_name}'"
-          return false
+          begin
+            return param_array.all? { |param| values.call(param) } if values.is_a? Proc
+          rescue StandardError => e
+            warn "Error '#{e}' raised while validating attribute '#{attr_name}'"
+            return false
+          end
+          param_array.all? { |param| values.include?(param) }
         end
-        param_array.all? { |param| values.include?(param) }
-      end
 
-      def check_excepts(param_array)
-        excepts = @excepts.is_a?(Proc) ? @excepts.call : @excepts
-        return true if excepts.nil?
-        param_array.none? { |param| excepts.include?(param) }
-      end
+        def check_excepts(param_array)
+          excepts = @excepts.is_a?(Proc) ? @excepts.call : @excepts
+          return true if excepts.nil?
 
-      def except_message
-        options = instance_variable_get(:@option)
-        options_key?(:except_message) ? options[:except_message] : message(:except_values)
-      end
+          param_array.none? { |param| excepts.include?(param) }
+        end
 
-      def required_for_root_scope?
-        @required && @scope.root?
-      end
+        def except_message
+          options = instance_variable_get(:@option)
+          options_key?(:except_message) ? options[:except_message] : message(:except_values)
+        end
 
-      def validation_exception(attr_name, message)
-        Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message)
+        def required_for_root_scope?
+          @required && @scope.root?
+        end
+
+        def validation_exception(attr_name, message)
+          Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: message)
+        end
       end
     end
   end

data/lib/grape/validations.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require 'grape/validations/attributes_iterator'
+require 'grape/validations/single_attribute_iterator'
+require 'grape/validations/multiple_attributes_iterator'
+require 'grape/validations/params_scope'
+require 'grape/validations/types'
+
 module Grape
   # Registry to store and locate known Validators.
   module Validations

data/lib/grape/version.rb

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

data/lib/grape.rb

@@ -7,7 +7,9 @@ require 'rack/accept'
 require 'rack/auth/basic'
 require 'rack/auth/digest/md5'
 require 'set'
+require 'active_support'
 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/extract_options'
@@ -22,7 +24,7 @@ require 'active_support/dependencies/autoload'
 require 'active_support/notifications'
 require 'i18n'
 
-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
@@ -76,6 +78,7 @@ module Grape
       autoload :InvalidVersionHeader
       autoload :MethodNotAllowed
       autoload :InvalidResponse
+      autoload :EmptyMessageBody
     end
   end
 

data/spec/grape/api/custom_validations_spec.rb

@@ -4,17 +4,6 @@ require 'spec_helper'
 
 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.new(params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long")
-          end
-        end
-      end
-    end
     subject do
       Class.new(Grape::API) do
         params do
@@ -26,6 +15,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
@@ -35,11 +43,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
@@ -48,15 +58,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
@@ -68,6 +69,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
@@ -77,6 +94,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
@@ -85,15 +103,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.new(params: [@scope.full_name(attr_name)], message: :presence)
-          end
-        end
-      end
-    end
     subject do
       Class.new(Grape::API) do
         params do
@@ -105,6 +114,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
@@ -117,22 +142,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.new(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
@@ -146,6 +155,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

@@ -41,18 +41,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

@@ -31,8 +31,9 @@ describe Grape::API::Instance do
 
     context 'Params endpoint type' do
       subject { DefinesBooleanInstanceSpec::API.new.router.map['POST'].first.options[:params]['message'][:type] }
+
       it 'params type is a boolean' do
-        is_expected.to eq 'Grape::API::Boolean'
+        expect(subject).to eq 'Grape::API::Boolean'
       end
     end
   end

data/spec/grape/api/invalid_format_spec.rb

@@ -31,11 +31,13 @@ describe Grape::Endpoint do
       expect(last_response.status).to eq 200
       expect(last_response.body).to eq(::Grape::Json.dump(id: 'foo', format: nil))
     end
+
     it 'json format' do
       get '/foo.json'
       expect(last_response.status).to eq 200
       expect(last_response.body).to eq(::Grape::Json.dump(id: 'foo', format: 'json'))
     end
+
     it 'invalid format' do
       get '/foo.invalid'
       expect(last_response.status).to eq 200

data/spec/grape/api/recognize_path_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 describe Grape::API do
   describe '.recognize_path' do
-    subject { Class.new(Grape::API) }
+    subject { Class.new(described_class) }
 
     it 'fetches endpoint by given path' do
       subject.get('/foo/:id') {}

data/spec/grape/api/routes_with_requirements_spec.rb

@@ -11,7 +11,7 @@ describe Grape::Endpoint do
 
   context 'get' do
     it 'routes to a namespace param with dots' do
-      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^\/]+} } do
+      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^/]+} } do
         get '/' do
           params[:ns_with_dots]
         end
@@ -23,8 +23,8 @@ describe Grape::Endpoint do
     end
 
     it 'routes to a path with multiple params with dots' do
-      subject.get ':id_with_dots/:another_id_with_dots', requirements: { id_with_dots: %r{[^\/]+},
-                                                                         another_id_with_dots: %r{[^\/]+} } do
+      subject.get ':id_with_dots/:another_id_with_dots', requirements: { id_with_dots: %r{[^/]+},
+                                                                         another_id_with_dots: %r{[^/]+} } do
         "#{params[:id_with_dots]}/#{params[:another_id_with_dots]}"
       end
 
@@ -34,9 +34,9 @@ describe Grape::Endpoint do
     end
 
     it 'routes to namespace and path params with dots, with overridden requirements' do
-      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^\/]+} } do
-        get ':another_id_with_dots',     requirements: { ns_with_dots: %r{[^\/]+},
-                                                         another_id_with_dots: %r{[^\/]+} } do
+      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^/]+} } do
+        get ':another_id_with_dots',     requirements: { ns_with_dots: %r{[^/]+},
+                                                         another_id_with_dots: %r{[^/]+} } do
           "#{params[:ns_with_dots]}/#{params[:another_id_with_dots]}"
         end
       end
@@ -47,8 +47,8 @@ describe Grape::Endpoint do
     end
 
     it 'routes to namespace and path params with dots, with merged requirements' do
-      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^\/]+} } do
-        get ':another_id_with_dots',     requirements: { another_id_with_dots: %r{[^\/]+} } do
+      subject.namespace ':ns_with_dots', requirements: { ns_with_dots: %r{[^/]+} } do
+        get ':another_id_with_dots',     requirements: { another_id_with_dots: %r{[^/]+} } do
           "#{params[:ns_with_dots]}/#{params[:another_id_with_dots]}"
         end
       end

data/spec/grape/api/shared_helpers_exactly_one_of_spec.rb

@@ -3,19 +3,17 @@
 require 'spec_helper'
 
 describe Grape::API::Helpers do
-  subject do
-    shared_params = Module.new do
-      extend Grape::API::Helpers
+  let(:app) do
+    Class.new(Grape::API) do
+      helpers Module.new do
+        extend Grape::API::Helpers
 
-      params :drink do
-        optional :beer
-        optional :wine
-        exactly_one_of :beer, :wine
+        params :drink do
+          optional :beer
+          optional :wine
+          exactly_one_of :beer, :wine
+        end
       end
-    end
-
-    Class.new(Grape::API) do
-      helpers shared_params
       format :json
 
       params do
@@ -35,10 +33,6 @@ describe Grape::API::Helpers do
     end
   end
 
-  def app
-    subject
-  end
-
   it 'defines parameters' do
     get '/', orderType: 'food', pizza: 'mista'
     expect(last_response.status).to eq 200

data/spec/grape/api_remount_spec.rb

@@ -4,8 +4,9 @@ require 'spec_helper'
 require 'shared/versioning_examples'
 
 describe Grape::API do
-  subject(:a_remounted_api) { Class.new(Grape::API) }
-  let(:root_api) { Class.new(Grape::API) }
+  subject(:a_remounted_api) { Class.new(described_class) }
+
+  let(:root_api) { Class.new(described_class) }
 
   def app
     root_api
@@ -68,7 +69,7 @@ describe Grape::API do
     describe 'with dynamic configuration' do
       context 'when mounting an endpoint conditional on a configuration' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             get 'always' do
               'success'
             end
@@ -101,7 +102,7 @@ describe Grape::API do
 
       context 'when using an expression derived from a configuration' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             get(mounted { "api_name_#{configuration[:api_name]}" }) do
               'success'
             end
@@ -126,7 +127,7 @@ describe Grape::API do
 
         context 'when the expression lives in a namespace' do
           subject(:a_remounted_api) do
-            Class.new(Grape::API) do
+            Class.new(described_class) do
               namespace :base do
                 get(mounted { "api_name_#{configuration[:api_name]}" }) do
                   'success'
@@ -149,7 +150,7 @@ describe Grape::API do
 
       context 'when executing a standard block within a `mounted` block with all dynamic params' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             mounted do
               desc configuration[:description] do
                 headers configuration[:headers]
@@ -191,7 +192,7 @@ describe Grape::API do
 
       context 'when executing a custom block on mount' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             get 'always' do
               'success'
             end
@@ -215,7 +216,7 @@ describe Grape::API do
 
       context 'when the configuration is part of the arguments of a method' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             get configuration[:endpoint_name] do
               'success'
             end
@@ -237,7 +238,7 @@ describe Grape::API do
 
         context 'when the configuration is the value in a key-arg pair' do
           subject(:a_remounted_api) do
-            Class.new(Grape::API) do
+            Class.new(described_class) do
               version 'v1', using: :param, parameter: configuration[:version_param]
               get 'endpoint' do
                 'version 1'
@@ -267,7 +268,7 @@ describe Grape::API do
 
       context 'on the DescSCope' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             desc 'The description of this' do
               tags ['not_configurable_tag', configuration[:a_configurable_tag]]
             end
@@ -284,7 +285,7 @@ describe Grape::API do
 
       context 'on the ParamScope' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             params do
               requires configuration[:required_param], type: configuration[:required_type]
             end
@@ -314,7 +315,7 @@ describe Grape::API do
 
         context 'on dynamic checks' do
           subject(:a_remounted_api) do
-            Class.new(Grape::API) do
+            Class.new(described_class) do
               params do
                 optional :restricted_values, values: -> { [configuration[:allowed_value], 'always'] }
               end
@@ -363,7 +364,7 @@ describe Grape::API do
 
       context 'a very complex configuration example' do
         before do
-          top_level_api = Class.new(Grape::API) do
+          top_level_api = Class.new(described_class) do
             remounted_api = Class.new(Grape::API) do
               get configuration[:endpoint_name] do
                 configuration[:response]
@@ -431,7 +432,7 @@ describe Grape::API do
 
       context 'when the configuration is read in a helper' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             helpers do
               def printed_response
                 configuration[:some_value]
@@ -454,7 +455,7 @@ describe Grape::API do
 
       context 'when the configuration is read within the response block' do
         subject(:a_remounted_api) do
-          Class.new(Grape::API) do
+          Class.new(described_class) do
             get 'location' do
               configuration[:some_value]
             end