grape 1.5.1 → 1.6.1

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

@@ -2,73 +2,67 @@
 
 require 'spec_helper'
 
-describe Grape::Validations::AtLeastOneOfValidator do
-  describe '#validate!' do
-    subject(:validate) { post path, params }
-
-    module ValidationsSpec
-      module AtLeastOneOfValidatorSpec
-        class API < Grape::API
-          rescue_from Grape::Exceptions::ValidationErrors do |e|
-            error!(e.errors.transform_keys! { |key| key.join(',') }, 400)
-          end
+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
+        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, :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
+        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
+      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
 
-          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
+          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
+      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
+  end
 
-    def app
-      ValidationsSpec::AtLeastOneOfValidatorSpec::API
-    end
+  describe '#validate!' do
+    subject(:validate) { post path, params }
 
     context 'when all restricted params are present' do
       let(:path) { '/' }

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

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe Grape::Validations::CoerceValidator do
+describe Grape::Validations::Validators::CoerceValidator do
   subject do
     Class.new(Grape::API)
   end
@@ -23,7 +23,7 @@ describe Grape::Validations::CoerceValidator do
     end
 
     context 'i18n' do
-      after :each do
+      after do
         I18n.available_locales = %i[en]
         I18n.locale = :en
         I18n.default_locale = :en
@@ -31,9 +31,9 @@ describe Grape::Validations::CoerceValidator do
 
       it 'i18n error on malformed input' do
         I18n.available_locales = %i[en zh-CN]
-        I18n.load_path << File.expand_path('../zh-CN.yml', __FILE__)
+        I18n.load_path << File.expand_path('zh-CN.yml', __dir__)
         I18n.reload!
-        I18n.locale = 'zh-CN'.to_sym
+        I18n.locale = :'zh-CN'
         subject.params do
           requires :age, type: Integer
         end
@@ -48,7 +48,7 @@ describe Grape::Validations::CoerceValidator do
 
       it 'gives an english fallback error when default locale message is blank' do
         I18n.available_locales = %i[en pt-BR]
-        I18n.locale = 'pt-BR'.to_sym
+        I18n.locale = :'pt-BR'
         subject.params do
           requires :age, type: Integer
         end
@@ -83,10 +83,11 @@ describe Grape::Validations::CoerceValidator do
       context 'on custom coercion rules' do
         before do
           subject.params do
-            requires :a, types: { value: [Boolean, String], message: 'type cast is invalid' }, coerce_with: (lambda do |val|
-              if val == 'yup'
+            requires :a, types: { value: [Grape::API::Boolean, String], message: 'type cast is invalid' }, coerce_with: (lambda do |val|
+              case val
+              when 'yup'
                 true
-              elsif val == 'false'
+              when 'false'
                 0
               else
                 val
@@ -170,9 +171,9 @@ describe Grape::Validations::CoerceValidator do
           expect(last_response.body).to eq('BigDecimal 45.1')
         end
 
-        it 'Boolean' do
+        it 'Grape::API::Boolean' do
           subject.params do
-            requires :boolean, type: Boolean
+            requires :boolean, type: Grape::API::Boolean
           end
           subject.post '/boolean' do
             params[:boolean]
@@ -227,23 +228,51 @@ describe Grape::Validations::CoerceValidator do
         expect(last_response.body).to eq('NilClass')
       end
 
-      it 'is a custom type' do
-        subject.params do
-          requires :uri, coerce: SecureURIOnly
-        end
-        subject.get '/secure_uri' do
-          params[:uri].class
+      context 'a custom type' do
+        it 'coerces the given value' do
+          subject.params do
+            requires :uri, coerce: SecureURIOnly
+          end
+          subject.get '/secure_uri' do
+            params[:uri].class
+          end
+
+          get 'secure_uri', uri: 'https://www.example.com'
+
+          expect(last_response.status).to eq(200)
+          expect(last_response.body).to eq('URI::HTTPS')
+
+          get 'secure_uri', uri: 'http://www.example.com'
+
+          expect(last_response.status).to eq(400)
+          expect(last_response.body).to eq('uri is invalid')
         end
 
-        get 'secure_uri', uri: 'https://www.example.com'
+        context 'returning the InvalidValue instance when invalid' do
+          let(:custom_type) do
+            Class.new do
+              def self.parse(_val)
+                Grape::Types::InvalidValue.new('must be unique')
+              end
+            end
+          end
+
+          it 'uses a custom message added to the invalid value' do
+            type = custom_type
 
-        expect(last_response.status).to eq(200)
-        expect(last_response.body).to eq('URI::HTTPS')
+            subject.params do
+              requires :name, type: type
+            end
+            subject.get '/whatever' do
+              params[:name].class
+            end
 
-        get 'secure_uri', uri: 'http://www.example.com'
+            get 'whatever', name: 'Bob'
 
-        expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('uri is invalid')
+            expect(last_response.status).to eq(400)
+            expect(last_response.body).to eq('name must be unique')
+          end
+        end
       end
 
       context 'Array' do
@@ -341,9 +370,9 @@ describe Grape::Validations::CoerceValidator do
         end
       end
 
-      it 'Boolean' do
+      it 'Grape::API::Boolean' do
         subject.params do
-          requires :boolean, type: Boolean
+          requires :boolean, type: Grape::API::Boolean
         end
         subject.get '/boolean' do
           params[:boolean].class
@@ -622,7 +651,7 @@ describe Grape::Validations::CoerceValidator do
 
       it 'parses parameters with Array[Array[String]] type and coerce_with' do
         subject.params do
-          requires :values, type: Array[Array[String]], coerce_with: ->(val) { val.is_a?(String) ? [val.split(/,/).map(&:strip)] : val }
+          requires :values, type: Array[Array[String]], coerce_with: ->(val) { val.is_a?(String) ? [val.split(',').map(&:strip)] : val }
         end
         subject.post '/coerce_nested_strings' do
           params[:values]
@@ -678,6 +707,44 @@ describe Grape::Validations::CoerceValidator do
         expect(JSON.parse(last_response.body)).to eq([1, 1, 1, 1])
       end
 
+      context 'Array type and coerce_with should' do
+        before do
+          subject.params do
+            optional :arr, type: Array, coerce_with: (lambda do |val|
+              if val.nil?
+                []
+              else
+                val
+              end
+            end)
+          end
+          subject.get '/' do
+            params[:arr].class.to_s
+          end
+        end
+
+        it 'coerce nil value to array' do
+          get '/', arr: nil
+
+          expect(last_response.status).to eq(200)
+          expect(last_response.body).to eq('Array')
+        end
+
+        it 'not coerce missing field' do
+          get '/'
+
+          expect(last_response.status).to eq(200)
+          expect(last_response.body).to eq('NilClass')
+        end
+
+        it 'coerce array as array' do
+          get '/', arr: []
+
+          expect(last_response.status).to eq(200)
+          expect(last_response.body).to eq('Array')
+        end
+      end
+
       it 'uses parse where available' do
         subject.params do
           requires :ints, type: Array, coerce_with: JSON do
@@ -726,13 +793,52 @@ describe Grape::Validations::CoerceValidator do
         expect(last_response.body).to eq('3')
       end
 
+      context 'Integer type and coerce_with should' do
+        before do
+          subject.params do
+            optional :int, type: Integer, coerce_with: (lambda do |val|
+              if val.nil?
+                0
+              else
+                val.to_i
+              end
+            end)
+          end
+          subject.get '/' do
+            params[:int].class.to_s
+          end
+        end
+
+        it 'coerce nil value to integer' do
+          get '/', int: nil
+
+          expect(last_response.status).to eq(200)
+          expect(last_response.body).to eq('Integer')
+        end
+
+        it 'not coerce missing field' do
+          get '/'
+
+          expect(last_response.status).to eq(200)
+          expect(last_response.body).to eq('NilClass')
+        end
+
+        it 'coerce integer as integer' do
+          get '/', int: 1
+
+          expect(last_response.status).to eq(200)
+          expect(last_response.body).to eq('Integer')
+        end
+      end
+
       context 'Integer type and coerce_with potentially returning nil' do
         before do
           subject.params do
             requires :int, type: Integer, coerce_with: (lambda do |val|
-              if val == '0'
+              case val
+              when '0'
                 nil
-              elsif val.match?(/^-?\d+$/)
+              when /^-?\d+$/
                 val.to_i
               else
                 val
@@ -912,11 +1018,9 @@ describe Grape::Validations::CoerceValidator do
     end
 
     context 'multiple types' do
-      Boolean = Grape::API::Boolean
-
       it 'coerces to first possible type' do
         subject.params do
-          requires :a, types: [Boolean, Integer, String]
+          requires :a, types: [Grape::API::Boolean, Integer, String]
         end
         subject.get '/' do
           params[:a].class.to_s
@@ -937,7 +1041,7 @@ describe Grape::Validations::CoerceValidator do
 
       it 'fails when no coercion is possible' do
         subject.params do
-          requires :a, types: [Boolean, Integer]
+          requires :a, types: [Grape::API::Boolean, Integer]
         end
         subject.get '/' do
           params[:a].class.to_s
@@ -1096,10 +1200,11 @@ describe Grape::Validations::CoerceValidator do
       context 'custom coercion rules' do
         before do
           subject.params do
-            requires :a, types: [Boolean, String], coerce_with: (lambda do |val|
-              if val == 'yup'
+            requires :a, types: [Grape::API::Boolean, String], coerce_with: (lambda do |val|
+              case val
+              when 'yup'
                 true
-              elsif val == 'false'
+              when 'false'
                 0
               else
                 val

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

@@ -2,104 +2,98 @@
 
 require 'spec_helper'
 
-describe Grape::Validations::DefaultValidator do
-  module ValidationsSpec
-    module DefaultValidatorSpec
-      class API < Grape::API
-        default_format :json
-
-        params do
-          optional :id
-          optional :type, default: 'default-type'
-        end
-        get '/' do
-          { id: params[:id], type: params[:type] }
-        end
+describe Grape::Validations::Validators::DefaultValidator do
+  let_it_be(:app) do
+    Class.new(Grape::API) do
+      default_format :json
+
+      params do
+        optional :id
+        optional :type, default: 'default-type'
+      end
+      get '/' do
+        { id: params[:id], type: params[:type] }
+      end
 
-        params do
-          optional :type1, default: 'default-type1'
-          optional :type2, default: 'default-type2'
-        end
-        get '/user' do
-          { type1: params[:type1], type2: params[:type2] }
-        end
+      params do
+        optional :type1, default: 'default-type1'
+        optional :type2, default: 'default-type2'
+      end
+      get '/user' do
+        { type1: params[:type1], type2: params[:type2] }
+      end
 
-        params do
-          requires :id
-          optional :type1, default: 'default-type1'
-          optional :type2, default: 'default-type2'
-        end
+      params do
+        requires :id
+        optional :type1, default: 'default-type1'
+        optional :type2, default: 'default-type2'
+      end
 
-        get '/message' do
-          { id: params[:id], type1: params[:type1], type2: params[:type2] }
-        end
+      get '/message' do
+        { id: params[:id], type1: params[:type1], type2: params[:type2] }
+      end
 
-        params do
-          optional :random, default: -> { Random.rand }
-          optional :not_random, default: Random.rand
-        end
-        get '/numbers' do
-          { random_number: params[:random], non_random_number: params[:non_random_number] }
-        end
+      params do
+        optional :random, default: -> { Random.rand }
+        optional :not_random, default: Random.rand
+      end
+      get '/numbers' do
+        { random_number: params[:random], non_random_number: params[:non_random_number] }
+      end
 
-        params do
-          optional :array, type: Array do
-            requires :name
-            optional :with_default, default: 'default'
-          end
-        end
-        get '/array' do
-          { array: params[:array] }
+      params do
+        optional :array, type: Array do
+          requires :name
+          optional :with_default, default: 'default'
         end
+      end
+      get '/array' do
+        { array: params[:array] }
+      end
 
-        params do
-          requires :thing1
-          optional :more_things, type: Array do
-            requires :nested_thing
-            requires :other_thing, default: 1
-          end
-        end
-        get '/optional_array' do
-          { thing1: params[:thing1] }
+      params do
+        requires :thing1
+        optional :more_things, type: Array do
+          requires :nested_thing
+          requires :other_thing, default: 1
         end
+      end
+      get '/optional_array' do
+        { thing1: params[:thing1] }
+      end
 
-        params do
-          requires :root, type: Hash do
-            optional :some_things, type: Array do
-              requires :foo
-              optional :options, type: Array do
-                requires :name, type: String
-                requires :value, type: String
-              end
+      params do
+        requires :root, type: Hash do
+          optional :some_things, type: Array do
+            requires :foo
+            optional :options, type: Array do
+              requires :name, type: String
+              requires :value, type: String
             end
           end
         end
-        get '/nested_optional_array' do
-          { root: params[:root] }
-        end
+      end
+      get '/nested_optional_array' do
+        { root: params[:root] }
+      end
 
-        params do
-          requires :root, type: Hash do
-            optional :some_things, type: Array do
-              requires :foo
-              optional :options, type: Array do
-                optional :name, type: String
-                optional :value, type: String
-              end
+      params do
+        requires :root, type: Hash do
+          optional :some_things, type: Array do
+            requires :foo
+            optional :options, type: Array do
+              optional :name, type: String
+              optional :value, type: String
             end
           end
         end
-        get '/another_nested_optional_array' do
-          { root: params[:root] }
-        end
+      end
+      get '/another_nested_optional_array' do
+        { root: params[:root] }
       end
     end
   end
 
-  def app
-    ValidationsSpec::DefaultValidatorSpec::API
-  end
-
   it 'lets you leave required values nested inside an optional blank' do
     get '/optional_array', thing1: 'stuff'
     expect(last_response.status).to eq(200)