grape 1.0.0 → 1.6.0

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

@@ -1,62 +1,221 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Validations::MutualExclusionValidator do
   describe '#validate!' do
-    let(:scope) do
-      Struct.new(:opts) do
-        def params(arg)
-          arg
+    subject(:validate) { post path, params }
+
+    module ValidationsSpec
+      module MutualExclusionValidatorSpec
+        class API < Grape::API
+          rescue_from Grape::Exceptions::ValidationErrors do |e|
+            error!(e.errors.transform_keys! { |key| key.join(',') }, 400)
+          end
+
+          params do
+            optional :beer
+            optional :wine
+            optional :grapefruit
+            mutually_exclusive :beer, :wine, :grapefruit
+          end
+          post do
+          end
+
+          params do
+            optional :beer
+            optional :wine
+            optional :grapefruit
+            optional :other
+            mutually_exclusive :beer, :wine, :grapefruit
+          end
+          post 'mixed-params' do
+          end
+
+          params do
+            optional :beer
+            optional :wine
+            optional :grapefruit
+            mutually_exclusive :beer, :wine, :grapefruit, message: 'you should not mix beer and wine'
+          end
+          post '/custom-message' do
+          end
+
+          params do
+            requires :item, type: Hash do
+              optional :beer
+              optional :wine
+              optional :grapefruit
+              mutually_exclusive :beer, :wine, :grapefruit
+            end
+          end
+          post '/nested-hash' do
+          end
+
+          params do
+            optional :item, type: Hash do
+              optional :beer
+              optional :wine
+              optional :grapefruit
+              mutually_exclusive :beer, :wine, :grapefruit
+            end
+          end
+          post '/nested-optional-hash' do
+          end
+
+          params do
+            requires :items, type: Array do
+              optional :beer
+              optional :wine
+              optional :grapefruit
+              mutually_exclusive :beer, :wine, :grapefruit
+            end
+          end
+          post '/nested-array' do
+          end
+
+          params do
+            requires :items, type: Array do
+              requires :nested_items, type: Array do
+                optional :beer, :wine, :grapefruit, type: Boolean
+                mutually_exclusive :beer, :wine, :grapefruit
+              end
+            end
+          end
+          post '/deeply-nested-array' do
+          end
         end
       end
     end
-    let(:mutually_exclusive_params) { [:beer, :wine, :grapefruit] }
-    let(:validator) { described_class.new(mutually_exclusive_params, {}, false, scope.new) }
+
+    def app
+      ValidationsSpec::MutualExclusionValidatorSpec::API
+    end
 
     context 'when all mutually exclusive params are present' do
+      let(:path) { '/' }
       let(:params) { { beer: true, wine: true, grapefruit: true } }
 
-      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' => ['are mutually exclusive']
+        )
       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 'still raises a validation exception' do
-          expect do
-            validator.validate! mixed_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' => ['are mutually exclusive']
+          )
         end
       end
     end
 
     context 'when a subset of mutually exclusive params are present' do
+      let(:path) { '/' }
       let(:params) { { beer: true, grapefruit: true } }
 
-      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,grapefruit' => ['are mutually exclusive']
+        )
       end
     end
 
-    context 'when params keys come as strings' do
-      let(:params) { { 'beer' => true, 'grapefruit' => true } }
+    context 'when custom message is specified' do
+      let(:path) { '/custom-message' }
+      let(:params) { { beer: true, wine: true } }
 
-      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' => ['you should not mix beer and wine']
+        )
       end
     end
 
     context 'when no mutually exclusive params are present' do
+      let(:path) { '/' }
       let(:params) { { beer: true, somethingelse: true } }
 
-      it 'params' 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 mutually exclusive params are nested inside required hash' do
+      let(:path) { '/nested-hash' }
+      let(:params) { { item: { beer: true, wine: 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]' => ['are mutually exclusive']
+        )
+      end
+    end
+
+    context 'when mutually exclusive params are nested inside optional hash' do
+      let(:path) { '/nested-optional-hash' }
+
+      context 'when params are passed' do
+        let(:params) { { item: { beer: true, wine: 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]' => ['are mutually exclusive']
+          )
+        end
+      end
+
+      context 'when params are empty' do
+        let(:params) { {} }
+
+        it 'does not return a validation error' do
+          validate
+          expect(last_response.status).to eq 201
+        end
+      end
+    end
+
+    context 'when mutually exclusive params are nested inside array' do
+      let(:path) { '/nested-array' }
+      let(:params) { { items: [{ beer: true, wine: true }, { wine: true, grapefruit: 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][beer],items[0][wine]' => ['are mutually exclusive'],
+          'items[1][wine],items[1][grapefruit]' => ['are mutually exclusive']
+        )
+      end
+    end
+
+    context 'when mutually exclusive params are deeply nested' do
+      let(:path) { '/deeply-nested-array' }
+      let(:params) { { items: [{ nested_items: [{ beer: true, wine: 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]' => ['are mutually exclusive']
+        )
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Validations::PresenceValidator do
@@ -269,4 +271,32 @@ describe Grape::Validations::PresenceValidator do
       expect(last_response.body).to eq('Hello optional'.to_json)
     end
   end
+
+  context 'with a custom type' do
+    it 'does not validate their type when it is missing' do
+      class CustomType
+        def self.parse(value)
+          return if value.blank?
+
+          new
+        end
+      end
+
+      subject.params do
+        requires :custom, type: CustomType
+      end
+      subject.get '/custom' do
+        'custom'
+      end
+
+      get 'custom'
+
+      expect(last_response.status).to eq(400)
+      expect(last_response.body).to eq('{"error":"custom is missing"}')
+
+      get 'custom', custom: 'filled'
+
+      expect(last_response.status).to eq(200)
+    end
+  end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Validations::RegexpValidator do

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Grape::Validations::SameAsValidator do
+  module ValidationsSpec
+    module SameAsValidatorSpec
+      class API < Grape::API
+        params do
+          requires :password
+          requires :password_confirmation, same_as: :password
+        end
+        post do
+        end
+
+        params do
+          requires :password
+          requires :password_confirmation, same_as: { value: :password, message: 'not match' }
+        end
+        post '/custom-message' do
+        end
+      end
+    end
+  end
+
+  def app
+    ValidationsSpec::SameAsValidatorSpec::API
+  end
+
+  describe '/' do
+    context 'is the same' do
+      it do
+        post '/', password: '987654', password_confirmation: '987654'
+        expect(last_response.status).to eq(201)
+        expect(last_response.body).to eq('')
+      end
+    end
+
+    context 'is not the same' do
+      it do
+        post '/', password: '123456', password_confirmation: 'whatever'
+        expect(last_response.status).to eq(400)
+        expect(last_response.body).to eq('password_confirmation is not the same as password')
+      end
+    end
+  end
+
+  describe '/custom-message' do
+    context 'is the same' do
+      it do
+        post '/custom-message', password: '987654', password_confirmation: '987654'
+        expect(last_response.status).to eq(201)
+        expect(last_response.body).to eq('')
+      end
+    end
+
+    context 'is not the same' do
+      it do
+        post '/custom-message', password: '123456', password_confirmation: 'whatever'
+        expect(last_response.status).to eq(400)
+        expect(last_response.body).to eq('password_confirmation not match')
+      end
+    end
+  end
+end

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Grape::Validations::ValuesValidator do
   module ValidationsSpec
     class ValuesModel
-      DEFAULT_VALUES = ['valid-type1', 'valid-type2', 'valid-type3'].freeze
-      DEFAULT_EXCEPTS = ['invalid-type1', 'invalid-type2', 'invalid-type3'].freeze
+      DEFAULT_VALUES = %w[valid-type1 valid-type2 valid-type3].freeze
+      DEFAULT_EXCEPTS = %w[invalid-type1 invalid-type2 invalid-type3].freeze
       class << self
         def values
           @values ||= []
@@ -25,6 +27,10 @@ describe Grape::Validations::ValuesValidator do
           @excepts ||= []
           @excepts << except
         end
+
+        def include?(value)
+          values.include?(value)
+        end
       end
     end
 
@@ -104,12 +110,19 @@ describe Grape::Validations::ValuesValidator do
         end
 
         params do
-          requires :type, values: ->(v) { ValuesModel.values.include? v }
+          requires :type, values: ->(v) { ValuesModel.include? v }
         end
         get '/lambda_val' do
           { type: params[:type] }
         end
 
+        params do
+          requires :number, type: Integer, values: ->(v) { v > 0 }
+        end
+        get '/lambda_int_val' do
+          { number: params[:number] }
+        end
+
         params do
           requires :type, values: -> { [] }
         end
@@ -152,7 +165,7 @@ describe Grape::Validations::ValuesValidator do
 
         params do
           optional :optional, type: Array do
-            requires :type, values: %w(a b)
+            requires :type, values: %w[a b]
           end
         end
         get '/optional_with_required_values'
@@ -200,21 +213,26 @@ describe Grape::Validations::ValuesValidator do
         end
 
         params do
-          optional :optional, type: Array[String], values: %w(a b c)
+          optional :optional, type: Array[String], values: %w[a b c]
         end
         put '/optional_with_array_of_string_values'
 
         params do
-          requires :type, values: { proc: ->(v) { ValuesModel.values.include? v } }
+          requires :type, values: { proc: ->(v) { ValuesModel.include? v } }
         end
         get '/proc' do
           { type: params[:type] }
         end
 
         params do
-          requires :type, values: { proc: ->(v) { ValuesModel.values.include? v }, message: 'failed check' }
+          requires :type, values: { proc: ->(v) { ValuesModel.include? v }, message: 'failed check' }
         end
         get '/proc/message'
+
+        params do
+          optional :name, type: String, values: %w[a b], allow_blank: true
+        end
+        get '/allow_blank'
       end
     end
   end
@@ -305,7 +323,7 @@ describe Grape::Validations::ValuesValidator do
       expect(last_response.status).to eq 200
     end
 
-    it 'allows for an optional param with a list of values' do
+    it 'accepts for an optional param with a list of values' do
       put('/optional_with_array_of_string_values', optional: nil)
       expect(last_response.status).to eq 200
     end
@@ -357,6 +375,24 @@ describe Grape::Validations::ValuesValidator do
     expect(last_response.body).to eq({ error: 'type does not have a valid value' }.to_json)
   end
 
+  it 'does not allow non-numeric string value for int value using lambda' do
+    get('/lambda_int_val', number: 'foo')
+    expect(last_response.status).to eq 400
+    expect(last_response.body).to eq({ error: 'number is invalid, number does not have a valid value' }.to_json)
+  end
+
+  it 'does not allow nil for int value using lambda' do
+    get('/lambda_int_val', number: nil)
+    expect(last_response.status).to eq 400
+    expect(last_response.body).to eq({ error: 'number does not have a valid value' }.to_json)
+  end
+
+  it 'allows numeric string for int value using lambda' do
+    get('/lambda_int_val', number: '3')
+    expect(last_response.status).to eq 200
+    expect(last_response.body).to eq({ number: 3 }.to_json)
+  end
+
   it 'allows value using lambda' do
     get('/lambda_val', type: 'valid-type1')
     expect(last_response.status).to eq 200
@@ -388,29 +424,39 @@ describe Grape::Validations::ValuesValidator do
   it 'raises IncompatibleOptionValues on an invalid default value from proc' do
     subject = Class.new(Grape::API)
     expect do
-      subject.params { optional :type, values: ['valid-type1', 'valid-type2', 'valid-type3'], default: ValidationsSpec::ValuesModel.values.sample + '_invalid' }
+      subject.params { optional :type, values: %w[valid-type1 valid-type2 valid-type3], default: "#{ValidationsSpec::ValuesModel.values.sample}_invalid" }
     end.to raise_error Grape::Exceptions::IncompatibleOptionValues
   end
 
   it 'raises IncompatibleOptionValues on an invalid default value' do
     subject = Class.new(Grape::API)
     expect do
-      subject.params { optional :type, values: ['valid-type1', 'valid-type2', 'valid-type3'], default: 'invalid-type' }
+      subject.params { optional :type, values: %w[valid-type1 valid-type2 valid-type3], default: 'invalid-type' }
     end.to raise_error Grape::Exceptions::IncompatibleOptionValues
   end
 
   it 'raises IncompatibleOptionValues when type is incompatible with values array' do
     subject = Class.new(Grape::API)
     expect do
-      subject.params { optional :type, values: ['valid-type1', 'valid-type2', 'valid-type3'], type: Symbol }
+      subject.params { optional :type, values: %w[valid-type1 valid-type2 valid-type3], type: Symbol }
     end.to raise_error Grape::Exceptions::IncompatibleOptionValues
   end
 
-  it 'allows values to be true or false when setting the type to boolean' do
-    get('/values/optional_boolean', type: true)
-    expect(last_response.status).to eq 200
-    expect(last_response.body).to eq({ type: true }.to_json)
+  context 'boolean values' do
+    it 'allows a value from the list' do
+      get('/values/optional_boolean', type: true)
+
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq({ type: true }.to_json)
+    end
+
+    it 'rejects a value which is not in the list' do
+      get('/values/optional_boolean', type: false)
+
+      expect(last_response.body).to eq({ error: 'type does not have a valid value' }.to_json)
+    end
   end
+
   it 'allows values to be a kind of the coerced type not just an instance of it' do
     get('/values/coercion', type: 10)
     expect(last_response.status).to eq 200
@@ -437,6 +483,14 @@ describe Grape::Validations::ValuesValidator do
     end.to raise_error Grape::Exceptions::IncompatibleOptionValues
   end
 
+  it 'allows a blank value when the allow_blank option is true' do
+    get 'allow_blank', name: nil
+    expect(last_response.status).to eq(200)
+
+    get 'allow_blank', name: ''
+    expect(last_response.status).to eq(200)
+  end
+
   context 'with a lambda values' do
     subject do
       Class.new(Grape::API) do
@@ -530,7 +584,7 @@ describe Grape::Validations::ValuesValidator do
     end
 
     it 'rejects an array of values if any of them matches except' do
-      get '/except/exclusive', type: %w(valid1 valid2 invalid-type1 valid4)
+      get '/except/exclusive', type: %w[valid1 valid2 invalid-type1 valid4]
       expect(last_response.status).to eq 400
       expect(last_response.body).to eq({ error: 'type has a value not allowed' }.to_json)
     end
@@ -598,9 +652,9 @@ describe Grape::Validations::ValuesValidator do
     end
 
     it 'accepts multiple valid values' do
-      get '/proc', type: ['valid-type1', 'valid-type3']
+      get '/proc', type: %w[valid-type1 valid-type3]
       expect(last_response.status).to eq 200
-      expect(last_response.body).to eq({ type: ['valid-type1', 'valid-type3'] }.to_json)
+      expect(last_response.body).to eq({ type: %w[valid-type1 valid-type3] }.to_json)
     end
 
     it 'rejects a single invalid value' do
@@ -610,7 +664,7 @@ describe Grape::Validations::ValuesValidator do
     end
 
     it 'rejects an invalid value among valid ones' do
-      get '/proc', type: ['valid-type1', 'invalid-type1', 'valid-type3']
+      get '/proc', type: %w[valid-type1 invalid-type1 valid-type3]
       expect(last_response.status).to eq 400
       expect(last_response.body).to eq({ error: 'type does not have a valid value' }.to_json)
     end