grape 0.10.1 → 0.11.0

data/spec/grape/validations/params_scope_spec.rb

@@ -53,5 +53,129 @@ describe Grape::Validations::ParamsScope do
         subject.params { requires :numbers, type: Array, values: [1, 'definitely not a number', 3] }
       end.to raise_error Grape::Exceptions::IncompatibleOptionValues
     end
+
+    it 'raises exception when range values have different endpoint types' do
+      expect do
+        subject.params { requires :numbers, type: Array, values: 0.0..10 }
+      end.to raise_error Grape::Exceptions::IncompatibleOptionValues
+    end
+  end
+
+  context 'with range values' do
+    context "when left range endpoint isn't #kind_of? the type" do
+      it 'raises exception' do
+        expect do
+          subject.params { requires :latitude, type: Integer, values: -90.0..90 }
+        end.to raise_error Grape::Exceptions::IncompatibleOptionValues
+      end
+    end
+
+    context "when right range endpoint isn't #kind_of? the type" do
+      it 'raises exception' do
+        expect do
+          subject.params { requires :latitude, type: Integer, values: -90..90.0 }
+        end.to raise_error Grape::Exceptions::IncompatibleOptionValues
+      end
+    end
+
+    context 'when both range endpoints are #kind_of? the type' do
+      it 'accepts values in the range' do
+        subject.params do
+          requires :letter, type: String, values: 'a'..'z'
+        end
+        subject.get('/letter') { params[:letter] }
+
+        get '/letter', letter: 'j'
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('j')
+      end
+
+      it 'rejects values outside the range' do
+        subject.params do
+          requires :letter, type: String, values: 'a'..'z'
+        end
+        subject.get('/letter') { params[:letter] }
+
+        get '/letter', letter: 'J'
+        expect(last_response.status).to eq(400)
+        expect(last_response.body).to eq('letter does not have a valid value')
+      end
+    end
+  end
+
+  context 'parameters in group' do
+    it 'errors when no type is provided' do
+      expect do
+        subject.params do
+          group :a do
+            requires :b
+          end
+        end
+      end.to raise_error Grape::Exceptions::MissingGroupTypeError
+
+      expect do
+        subject.params do
+          optional :a do
+            requires :b
+          end
+        end
+      end.to raise_error Grape::Exceptions::MissingGroupTypeError
+    end
+
+    it 'allows Hash as type' do
+      subject.params do
+        group :a, type: Hash do
+          requires :b
+        end
+      end
+      subject.get('/group') { 'group works' }
+      get '/group', a: { b: true }
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('group works')
+
+      subject.params do
+        optional :a, type: Hash do
+          requires :b
+        end
+      end
+      get '/optional_type_hash'
+    end
+
+    it 'allows Array as type' do
+      subject.params do
+        group :a, type: Array do
+          requires :b
+        end
+      end
+      subject.get('/group') { 'group works' }
+      get '/group', a: [{ b: true }]
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('group works')
+
+      subject.params do
+        optional :a, type: Array do
+          requires :b
+        end
+      end
+      get '/optional_type_array'
+    end
+
+    it 'errors with an unsupported type' do
+      expect do
+        subject.params do
+          group :a, type: Set do
+            requires :b
+          end
+        end
+      end.to raise_error Grape::Exceptions::UnsupportedGroupTypeError
+
+      expect do
+        subject.params do
+          optional :a, type: Set do
+            requires :b
+          end
+        end
+      end.to raise_error Grape::Exceptions::UnsupportedGroupTypeError
+    end
   end
 end

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

@@ -21,6 +21,51 @@ describe Grape::Validations::AllowBlankValidator do
         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: Fixnum, allow_blank: true
+        end
+        get '/allow_fixnum_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
           optional :user, type: Hash do
             requires :name, allow_blank: false
@@ -28,6 +73,13 @@ describe Grape::Validations::AllowBlankValidator do
         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
@@ -75,6 +127,9 @@ describe Grape::Validations::AllowBlankValidator do
     it 'refuses empty string' do
       get '/', name: ''
       expect(last_response.status).to eq(400)
+
+      get '/disallow_datetime_blank', val: ''
+      expect(last_response.status).to eq(400)
     end
 
     it 'refuses only whitespaces' do
@@ -104,6 +159,48 @@ describe Grape::Validations::AllowBlankValidator do
       get '/allow_blank', name: ''
       expect(last_response.status).to eq(200)
     end
+
+    it 'accepts empty input' do
+      get '/default_allow_datetime_blank', val: ''
+      expect(last_response.status).to eq(200)
+    end
+
+    it 'accepts empty when datetime allow_blank' do
+      get '/allow_datetime_blank', val: ''
+      expect(last_response.status).to eq(200)
+    end
+
+    it 'accepts empty when date allow_blank' do
+      get '/allow_date_blank', val: ''
+      expect(last_response.status).to eq(200)
+    end
+
+    context 'allow_blank when Numeric' do
+      it 'accepts empty when integer allow_blank' do
+        get '/allow_integer_blank', val: ''
+        expect(last_response.status).to eq(200)
+      end
+
+      it 'accepts empty when float allow_blank' do
+        get '/allow_float_blank', val: ''
+        expect(last_response.status).to eq(200)
+      end
+
+      it 'accepts empty when fixnum allow_blank' do
+        get '/allow_fixnum_blank', val: ''
+        expect(last_response.status).to eq(200)
+      end
+    end
+
+    it 'accepts empty when symbol allow_blank' do
+      get '/allow_symbol_blank', val: ''
+      expect(last_response.status).to eq(200)
+    end
+
+    it 'accepts empty when boolean allow_blank' do
+      get '/allow_boolean_blank', val: ''
+      expect(last_response.status).to eq(200)
+    end
   end
 
   context 'in an optional group' do
@@ -113,6 +210,11 @@ describe Grape::Validations::AllowBlankValidator do
         expect(last_response.status).to eq(200)
       end
 
+      it 'accepts a nested missing date value' do
+        get '/allow_blank_date_param_in_an_optional_group', user: { name: '' }
+        expect(last_response.status).to eq(200)
+      end
+
       it 'refuses a blank value in an existing group' do
         get '/disallow_blank_required_param_in_an_optional_group', user: { name: '' }
         expect(last_response.status).to eq(400)

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

@@ -71,7 +71,7 @@ describe Grape::Validations::ValuesValidator do
         end
 
         params do
-          optional :optional do
+          optional :optional, type: Array do
             requires :type, values: %w(a b)
           end
         end
@@ -221,4 +221,48 @@ describe Grape::Validations::ValuesValidator do
       expect(last_response.status).to eq 200
     end
   end
+
+  context 'with a range of values' do
+    subject(:app) do
+      Class.new(Grape::API) do
+        params do
+          optional :value, type: Float, values: 0.0..10.0
+        end
+        get '/value' do
+          { value: params[:value] }.to_json
+        end
+
+        params do
+          optional :values, type: Array[Float], values: 0.0..10.0
+        end
+        get '/values' do
+          { values: params[:values] }.to_json
+        end
+      end
+    end
+
+    it 'allows a single value inside of the range' do
+      get('/value', value: 5.2)
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq({ value: 5.2 }.to_json)
+    end
+
+    it 'allows an array of values inside of the range' do
+      get('/values', values: [8.6, 7.5, 3, 0.9])
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq({ values: [8.6, 7.5, 3.0, 0.9] }.to_json)
+    end
+
+    it 'rejects a single value outside the range' do
+      get('/value', value: 'a')
+      expect(last_response.status).to eq 400
+      expect(last_response.body).to eq('value is invalid, value does not have a valid value')
+    end
+
+    it 'rejects an array of values if any of them are outside the range' do
+      get('/values', values: [8.6, 75, 3, 0.9])
+      expect(last_response.status).to eq 400
+      expect(last_response.body).to eq('values does not have a valid value')
+    end
+  end
 end

data/spec/grape/validations_spec.rb

@@ -47,6 +47,44 @@ describe Grape::Validations do
       end
     end
 
+    context 'optional using Grape::Entity documentation' do
+      def define_optional_using
+        documentation = { field_a: { type: String }, field_b: { type: String } }
+        subject.params do
+          optional :all, using: documentation
+        end
+      end
+      before do
+        define_optional_using
+        subject.get '/optional' do
+          'optional with using works'
+        end
+      end
+
+      it 'adds entity documentation to declared params' do
+        define_optional_using
+        expect(subject.route_setting(:declared_params)).to eq([:field_a, :field_b])
+      end
+
+      it 'works when field_a and field_b are not present' do
+        get '/optional'
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('optional with using works')
+      end
+
+      it 'works when field_a is present' do
+        get '/optional', field_a: 'woof'
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('optional with using works')
+      end
+
+      it 'works when field_b is present' do
+        get '/optional', field_b: 'woof'
+        expect(last_response.status).to eq(200)
+        expect(last_response.body).to eq('optional with using works')
+      end
+    end
+
     context 'required' do
       before do
         subject.params do
@@ -228,7 +266,7 @@ describe Grape::Validations do
 
       it 'adds to declared parameters' do
         subject.params do
-          requires :items do
+          requires :items, type: Array do
             requires :key
           end
         end
@@ -272,7 +310,7 @@ describe Grape::Validations do
 
       it 'adds to declared parameters' do
         subject.params do
-          requires :items do
+          requires :items, type: Array do
             requires :key
           end
         end
@@ -283,7 +321,7 @@ describe Grape::Validations do
     context 'group' do
       before do
         subject.params do
-          group :items do
+          group :items, type: Array do
             requires :key
           end
         end
@@ -306,7 +344,7 @@ describe Grape::Validations do
 
       it 'adds to declared parameters' do
         subject.params do
-          group :items do
+          group :items, type: Array do
             requires :key
           end
         end
@@ -319,7 +357,7 @@ describe Grape::Validations do
 
       before do
         subject.params do
-          optional :items do
+          optional :items, type: Array do
             optional :key1, type: String
             optional :key2, type: String
           end
@@ -395,9 +433,9 @@ describe Grape::Validations do
     context 'validation within arrays' do
       before do
         subject.params do
-          group :children do
+          group :children, type: Array do
             requires :name
-            group :parents do
+            group :parents, type: Array do
               requires :name
             end
           end
@@ -457,7 +495,7 @@ describe Grape::Validations do
     context 'with block param' do
       before do
         subject.params do
-          requires :planets do
+          requires :planets, type: Array do
             requires :name
           end
         end
@@ -469,7 +507,7 @@ describe Grape::Validations do
         end
 
         subject.params do
-          group :stars do
+          group :stars, type: Array do
             requires :name
           end
         end
@@ -482,7 +520,7 @@ describe Grape::Validations do
 
         subject.params do
           requires :name
-          optional :moons do
+          optional :moons, type: Array do
             requires :name
           end
         end
@@ -549,9 +587,9 @@ describe Grape::Validations do
     context 'validation within arrays with JSON' do
       before do
         subject.params do
-          group :children do
+          group :children, type: Array do
             requires :name
-            group :parents do
+            group :parents, type: Array do
               requires :name
             end
           end
@@ -630,7 +668,7 @@ describe Grape::Validations do
 
       it 'adds to declared parameters' do
         subject.params do
-          optional :items do
+          optional :items, type: Array do
             requires :key
           end
         end
@@ -692,10 +730,10 @@ describe Grape::Validations do
 
       it 'adds to declared parameters' do
         subject.params do
-          optional :items do
+          optional :items, type: Array do
             requires :key
-            optional(:optional_subitems) { requires :value }
-            requires(:required_subitems) { requires :value }
+            optional(:optional_subitems, type: Array) { requires :value }
+            requires(:required_subitems, type: Array) { requires :value }
           end
         end
         expect(subject.route_setting(:declared_params)).to eq([items: [:key, { optional_subitems: [:value] }, { required_subitems: [:value] }]])