grape 1.1.0 → 1.7.1

data/spec/grape/validations/validators/allow_blank_spec.rb

@@ -1,23 +1,138 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Grape::Validations::AllowBlankValidator do
-  module ValidationsSpec
-    module AllowBlankValidatorSpec
-      class API < Grape::API
-        default_format :json
+describe Grape::Validations::Validators::AllowBlankValidator do
+  let_it_be(:app) do
+    Class.new(Grape::API) do
+      default_format :json
 
-        params do
+      params do
+        requires :name, allow_blank: false
+      end
+      get '/disallow_blank'
+
+      params do
+        optional :name, type: String, allow_blank: false
+      end
+      get '/opt_disallow_string_blank'
+
+      params do
+        optional :name, allow_blank: false
+      end
+      get '/disallow_blank_optional_param'
+
+      params do
+        requires :name, allow_blank: true
+      end
+      get '/allow_blank'
+
+      params do
+        requires :val, type: DateTime, allow_blank: true
+      end
+      get '/allow_datetime_blank'
+
+      params do
+        requires :val, type: DateTime, allow_blank: false
+      end
+      get '/disallow_datetime_blank'
+
+      params do
+        requires :val, type: DateTime
+      end
+      get '/default_allow_datetime_blank'
+
+      params do
+        requires :val, type: Date, allow_blank: true
+      end
+      get '/allow_date_blank'
+
+      params do
+        requires :val, type: Integer, allow_blank: true
+      end
+      get '/allow_integer_blank'
+
+      params do
+        requires :val, type: Float, allow_blank: true
+      end
+      get '/allow_float_blank'
+
+      params do
+        requires :val, type: Integer, allow_blank: true
+      end
+      get '/allow_integer_blank'
+
+      params do
+        requires :val, type: Symbol, allow_blank: true
+      end
+      get '/allow_symbol_blank'
+
+      params do
+        requires :val, type: Grape::API::Boolean, allow_blank: true
+      end
+      get '/allow_boolean_blank'
+
+      params do
+        requires :val, type: Grape::API::Boolean, allow_blank: false
+      end
+      get '/disallow_boolean_blank'
+
+      params do
+        optional :user, type: Hash do
+          requires :name, allow_blank: false
+        end
+      end
+      get '/disallow_blank_required_param_in_an_optional_group'
+
+      params do
+        optional :user, type: Hash do
+          requires :name, type: Date, allow_blank: true
+        end
+      end
+      get '/allow_blank_date_param_in_an_optional_group'
+
+      params do
+        optional :user, type: Hash do
+          optional :name, allow_blank: false
+          requires :age
+        end
+      end
+      get '/disallow_blank_optional_param_in_an_optional_group'
+
+      params do
+        requires :user, type: Hash do
           requires :name, allow_blank: false
         end
-        get '/disallow_blank'
+      end
+      get '/disallow_blank_required_param_in_a_required_group'
+
+      params do
+        requires :user, type: Hash do
+          requires :name, allow_blank: false
+        end
+      end
+      get '/disallow_string_value_in_a_required_hash_group'
+
+      params do
+        requires :user, type: Hash do
+          optional :name, allow_blank: false
+        end
+      end
+      get '/disallow_blank_optional_param_in_a_required_group'
+
+      params do
+        optional :user, type: Hash do
+          optional :name, allow_blank: false
+        end
+      end
+      get '/disallow_string_value_in_an_optional_hash_group'
 
+      resources :custom_message do
         params do
-          optional :name, type: String, allow_blank: false
+          requires :name, allow_blank: { value: false, message: 'has no value' }
         end
-        get '/opt_disallow_string_blank'
+        get
 
         params do
-          optional :name, allow_blank: false
+          optional :name, allow_blank: { value: false, message: 'has no value' }
         end
         get '/disallow_blank_optional_param'
 
@@ -32,7 +147,7 @@ describe Grape::Validations::AllowBlankValidator do
         get '/allow_datetime_blank'
 
         params do
-          requires :val, type: DateTime, allow_blank: false
+          requires :val, type: DateTime, allow_blank: { value: false, message: 'has no value' }
         end
         get '/disallow_datetime_blank'
 
@@ -67,18 +182,18 @@ describe Grape::Validations::AllowBlankValidator do
         get '/allow_symbol_blank'
 
         params do
-          requires :val, type: Boolean, allow_blank: true
+          requires :val, type: Grape::API::Boolean, allow_blank: true
         end
         get '/allow_boolean_blank'
 
         params do
-          requires :val, type: Boolean, allow_blank: false
+          requires :val, type: Grape::API::Boolean, allow_blank: { value: false, message: 'has no value' }
         end
         get '/disallow_boolean_blank'
 
         params do
           optional :user, type: Hash do
-            requires :name, allow_blank: false
+            requires :name, allow_blank: { value: false, message: 'has no value' }
           end
         end
         get '/disallow_blank_required_param_in_an_optional_group'
@@ -92,7 +207,7 @@ describe Grape::Validations::AllowBlankValidator do
 
         params do
           optional :user, type: Hash do
-            optional :name, allow_blank: false
+            optional :name, allow_blank: { value: false, message: 'has no value' }
             requires :age
           end
         end
@@ -100,156 +215,35 @@ describe Grape::Validations::AllowBlankValidator do
 
         params do
           requires :user, type: Hash do
-            requires :name, allow_blank: false
+            requires :name, allow_blank: { value: false, message: 'has no value' }
           end
         end
         get '/disallow_blank_required_param_in_a_required_group'
 
         params do
           requires :user, type: Hash do
-            requires :name, allow_blank: false
+            requires :name, allow_blank: { value: false, message: 'has no value' }
           end
         end
         get '/disallow_string_value_in_a_required_hash_group'
 
         params do
           requires :user, type: Hash do
-            optional :name, allow_blank: false
+            optional :name, allow_blank: { value: false, message: 'has no value' }
           end
         end
         get '/disallow_blank_optional_param_in_a_required_group'
 
         params do
           optional :user, type: Hash do
-            optional :name, allow_blank: false
-          end
-        end
-        get '/disallow_string_value_in_an_optional_hash_group'
-
-        resources :custom_message do
-          params do
-            requires :name, allow_blank: { value: false, message: 'has no value' }
-          end
-          get
-
-          params do
             optional :name, allow_blank: { value: false, message: 'has no value' }
           end
-          get '/disallow_blank_optional_param'
-
-          params do
-            requires :name, allow_blank: true
-          end
-          get '/allow_blank'
-
-          params do
-            requires :val, type: DateTime, allow_blank: true
-          end
-          get '/allow_datetime_blank'
-
-          params do
-            requires :val, type: DateTime, allow_blank: { value: false, message: 'has no value' }
-          end
-          get '/disallow_datetime_blank'
-
-          params do
-            requires :val, type: DateTime
-          end
-          get '/default_allow_datetime_blank'
-
-          params do
-            requires :val, type: Date, allow_blank: true
-          end
-          get '/allow_date_blank'
-
-          params do
-            requires :val, type: Integer, allow_blank: true
-          end
-          get '/allow_integer_blank'
-
-          params do
-            requires :val, type: Float, allow_blank: true
-          end
-          get '/allow_float_blank'
-
-          params do
-            requires :val, type: Integer, allow_blank: true
-          end
-          get '/allow_integer_blank'
-
-          params do
-            requires :val, type: Symbol, allow_blank: true
-          end
-          get '/allow_symbol_blank'
-
-          params do
-            requires :val, type: Boolean, allow_blank: true
-          end
-          get '/allow_boolean_blank'
-
-          params do
-            requires :val, type: Boolean, allow_blank: { value: false, message: 'has no value' }
-          end
-          get '/disallow_boolean_blank'
-
-          params do
-            optional :user, type: Hash do
-              requires :name, allow_blank: { value: false, message: 'has no value' }
-            end
-          end
-          get '/disallow_blank_required_param_in_an_optional_group'
-
-          params do
-            optional :user, type: Hash do
-              requires :name, type: Date, allow_blank: true
-            end
-          end
-          get '/allow_blank_date_param_in_an_optional_group'
-
-          params do
-            optional :user, type: Hash do
-              optional :name, allow_blank: { value: false, message: 'has no value' }
-              requires :age
-            end
-          end
-          get '/disallow_blank_optional_param_in_an_optional_group'
-
-          params do
-            requires :user, type: Hash do
-              requires :name, allow_blank: { value: false, message: 'has no value' }
-            end
-          end
-          get '/disallow_blank_required_param_in_a_required_group'
-
-          params do
-            requires :user, type: Hash do
-              requires :name, allow_blank: { value: false, message: 'has no value' }
-            end
-          end
-          get '/disallow_string_value_in_a_required_hash_group'
-
-          params do
-            requires :user, type: Hash do
-              optional :name, allow_blank: { value: false, message: 'has no value' }
-            end
-          end
-          get '/disallow_blank_optional_param_in_a_required_group'
-
-          params do
-            optional :user, type: Hash do
-              optional :name, allow_blank: { value: false, message: 'has no value' }
-            end
-          end
-          get '/disallow_string_value_in_an_optional_hash_group'
         end
+        get '/disallow_string_value_in_an_optional_hash_group'
       end
     end
   end
 
-  def app
-    ValidationsSpec::AllowBlankValidatorSpec::API
-  end
-
   context 'invalid input' do
     it 'refuses empty string' do
       get '/disallow_blank', name: ''
@@ -287,10 +281,12 @@ describe Grape::Validations::AllowBlankValidator do
         get '/custom_message', name: ''
         expect(last_response.body).to eq('{"error":"name has no value"}')
       end
+
       it 'refuses empty string for an optional param' do
         get '/custom_message/disallow_blank_optional_param', name: ''
         expect(last_response.body).to eq('{"error":"name has no value"}')
       end
+
       it 'refuses only whitespaces' do
         get '/custom_message', name: '   '
         expect(last_response.body).to eq('{"error":"name has no value"}')

data/spec/grape/validations/validators/at_least_one_of_spec.rb

@@ -1,66 +1,204 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Grape::Validations::AtLeastOneOfValidator do
-  describe '#validate!' do
-    let(:scope) do
-      Struct.new(:opts) do
-        def params(arg)
-          arg
+describe Grape::Validations::Validators::AtLeastOneOfValidator do
+  let_it_be(:app) do
+    Class.new(Grape::API) do
+      rescue_from Grape::Exceptions::ValidationErrors do |e|
+        error!(e.errors.transform_keys! { |key| key.join(',') }, 400)
+      end
+
+      params do
+        optional :beer, :wine, :grapefruit
+        at_least_one_of :beer, :wine, :grapefruit
+      end
+      post do
+      end
+
+      params do
+        optional :beer, :wine, :grapefruit, :other
+        at_least_one_of :beer, :wine, :grapefruit
+      end
+      post 'mixed-params' do
+      end
+
+      params do
+        optional :beer, :wine, :grapefruit
+        at_least_one_of :beer, :wine, :grapefruit, message: 'you should choose something'
+      end
+      post '/custom-message' do
+      end
+
+      params do
+        requires :item, type: Hash do
+          optional :beer, :wine, :grapefruit
+          at_least_one_of :beer, :wine, :grapefruit, message: 'fail'
         end
+      end
+      post '/nested-hash' do
+      end
 
-        def required?; end
+      params do
+        requires :items, type: Array do
+          optional :beer, :wine, :grapefruit
+          at_least_one_of :beer, :wine, :grapefruit, message: 'fail'
+        end
+      end
+      post '/nested-array' do
+      end
+
+      params do
+        requires :items, type: Array do
+          requires :nested_items, type: Array do
+            optional :beer, :wine, :grapefruit
+            at_least_one_of :beer, :wine, :grapefruit, message: 'fail'
+          end
+        end
+      end
+      post '/deeply-nested-array' do
       end
     end
-    let(:at_least_one_of_params) { %i[beer wine grapefruit] }
-    let(:validator) { described_class.new(at_least_one_of_params, {}, false, scope.new) }
+  end
+
+  describe '#validate!' do
+    subject(:validate) { post path, params }
 
     context 'when all restricted params are present' do
+      let(:path) { '/' }
       let(:params) { { beer: true, wine: true, grapefruit: true } }
 
-      it 'does not raise a validation exception' do
-        expect(validator.validate!(params)).to eql params
+      it 'does not return a validation error' do
+        validate
+        expect(last_response.status).to eq 201
       end
 
       context 'mixed with other params' do
-        let(:mixed_params) { params.merge!(other: true, andanother: true) }
+        let(:path) { '/mixed-params' }
+        let(:params) { { beer: true, wine: true, grapefruit: true, other: true } }
 
-        it 'does not raise a validation exception' do
-          expect(validator.validate!(mixed_params)).to eql mixed_params
+        it 'does not return a validation error' do
+          validate
+          expect(last_response.status).to eq 201
         end
       end
     end
 
     context 'when a subset of restricted params are present' do
+      let(:path) { '/' }
       let(:params) { { beer: true, grapefruit: true } }
 
-      it 'does not raise a validation exception' do
-        expect(validator.validate!(params)).to eql params
+      it 'does not return a validation error' do
+        validate
+        expect(last_response.status).to eq 201
       end
     end
 
-    context 'when params keys come as strings' do
-      let(:params) { { 'beer' => true, 'grapefruit' => true } }
+    context 'when none of the restricted params is selected' do
+      let(:path) { '/' }
+      let(:params) { { other: true } }
 
-      it 'does not raise a validation exception' do
-        expect(validator.validate!(params)).to eql params
+      it 'returns a validation error' do
+        validate
+        expect(last_response.status).to eq 400
+        expect(JSON.parse(last_response.body)).to eq(
+          'beer,wine,grapefruit' => ['are missing, at least one parameter must be provided']
+        )
       end
-    end
 
-    context 'when none of the restricted params is selected' do
-      let(:params) { { somethingelse: true } }
+      context 'when custom message is specified' do
+        let(:path) { '/custom-message' }
 
-      it 'raises a validation exception' do
-        expect do
-          validator.validate! params
-        end.to raise_error(Grape::Exceptions::Validation)
+        it 'returns a validation error' do
+          validate
+          expect(last_response.status).to eq 400
+          expect(JSON.parse(last_response.body)).to eq(
+            'beer,wine,grapefruit' => ['you should choose something']
+          )
+        end
       end
     end
 
     context 'when exactly one of the restricted params is selected' do
-      let(:params) { { beer: true, somethingelse: true } }
+      let(:path) { '/' }
+      let(:params) { { beer: true } }
 
-      it 'does not raise a validation exception' do
-        expect(validator.validate!(params)).to eql params
+      it 'does not return a validation error' do
+        validate
+        expect(last_response.status).to eq 201
+      end
+    end
+
+    context 'when restricted params are nested inside hash' do
+      let(:path) { '/nested-hash' }
+
+      context 'when at least one of them is present' do
+        let(:params) { { item: { beer: true, wine: true } } }
+
+        it 'does not return a validation error' do
+          validate
+          expect(last_response.status).to eq 201
+        end
+      end
+
+      context 'when none of them are present' do
+        let(:params) { { item: { other: true } } }
+
+        it 'returns a validation error with full names of the params' do
+          validate
+          expect(last_response.status).to eq 400
+          expect(JSON.parse(last_response.body)).to eq(
+            'item[beer],item[wine],item[grapefruit]' => ['fail']
+          )
+        end
+      end
+    end
+
+    context 'when restricted params are nested inside array' do
+      let(:path) { '/nested-array' }
+
+      context 'when at least one of them is present' do
+        let(:params) { { items: [{ beer: true, wine: true }, { grapefruit: true }] } }
+
+        it 'does not return a validation error' do
+          validate
+          expect(last_response.status).to eq 201
+        end
+      end
+
+      context 'when none of them are present' do
+        let(:params) { { items: [{ beer: true, other: true }, { other: true }] } }
+
+        it 'returns a validation error with full names of the params' do
+          validate
+          expect(last_response.status).to eq 400
+          expect(JSON.parse(last_response.body)).to eq(
+            'items[1][beer],items[1][wine],items[1][grapefruit]' => ['fail']
+          )
+        end
+      end
+    end
+
+    context 'when restricted params are deeply nested' do
+      let(:path) { '/deeply-nested-array' }
+
+      context 'when at least one of them is present' do
+        let(:params) { { items: [{ nested_items: [{ wine: true }] }] } }
+
+        it 'does not return a validation error' do
+          validate
+          expect(last_response.status).to eq 201
+        end
+      end
+
+      context 'when none of them are present' do
+        let(:params) { { items: [{ nested_items: [{ other: true }] }] } }
+
+        it 'returns a validation error with full names of the params' do
+          validate
+          expect(last_response.status).to eq 400
+          expect(JSON.parse(last_response.body)).to eq(
+            'items[0][nested_items][0][beer],items[0][nested_items][0][wine],items[0][nested_items][0][grapefruit]' => ['fail']
+          )
+        end
       end
     end
   end