grape 0.14.0 → 0.15.0

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

@@ -165,6 +165,12 @@ describe Grape::Validations::DefaultValidator do
         expect(last_response.status).to eq(201)
         expect(last_response.body).to eq({ optional_hash_without_default: nil }.to_json)
       end
+
+      it 'does not fail even if invalid params is passed to default validator' do
+        expect { post '/optional_hash_without_default', optional_hash_without_default: '5678' }.not_to raise_error
+        expect(last_response.status).to eq(400)
+        expect(last_response.body).to eq({ error: 'optional_hash_without_default is invalid' }.to_json)
+      end
     end
 
     context 'optional hash with default value includes optional param with default value' do

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

@@ -25,6 +25,33 @@ describe Grape::Validations::PresenceValidator do
     end
   end
 
+  context 'with a custom validation message' do
+    before do
+      subject.resource :requires do
+        params do
+          requires :email, type: String, allow_blank: { value: false, message: 'has no value' }, regexp: { value: /^\S+$/, message: 'format is invalid' }, message: 'is required'
+        end
+        get do
+          'Hello'
+        end
+      end
+    end
+    it 'requires when missing' do
+      get '/requires'
+      expect(last_response.status).to eq(400)
+      expect(last_response.body).to eq('{"error":"email is required, email has no value"}')
+    end
+    it 'requires when empty' do
+      get '/requires', email: ''
+      expect(last_response.body).to eq('{"error":"email has no value, email format is invalid"}')
+    end
+    it 'valid when set' do
+      get '/requires', email: 'bob@example.com'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('Hello'.to_json)
+    end
+  end
+
   context 'with a required regexp parameter supplied in the POST body' do
     before do
       subject.format :json

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

@@ -6,6 +6,14 @@ describe Grape::Validations::RegexpValidator do
       class API < Grape::API
         default_format :json
 
+        resources :custom_message do
+          params do
+            requires :name, regexp: { value: /^[a-z]+$/, message: 'format is invalid' }
+          end
+          get do
+          end
+        end
+
         params do
           requires :name, regexp: /^[a-z]+$/
         end
@@ -19,15 +27,43 @@ describe Grape::Validations::RegexpValidator do
     ValidationsSpec::RegexpValidatorSpec::API
   end
 
+  context 'custom validation message' do
+    context 'with invalid input' do
+      it 'refuses inapppopriate' do
+        get '/custom_message', name: 'invalid name'
+        expect(last_response.status).to eq(400)
+        expect(last_response.body).to eq('{"error":"name format is invalid"}')
+      end
+
+      it 'refuses empty' do
+        get '/custom_message', name: ''
+        expect(last_response.status).to eq(400)
+        expect(last_response.body).to eq('{"error":"name format is invalid"}')
+      end
+    end
+
+    it 'accepts nil' do
+      get '/custom_message', name: nil
+      expect(last_response.status).to eq(200)
+    end
+
+    it 'accepts valid input' do
+      get '/custom_message', name: 'bob'
+      expect(last_response.status).to eq(200)
+    end
+  end
+
   context 'invalid input' do
     it 'refuses inapppopriate' do
       get '/', name: 'invalid name'
       expect(last_response.status).to eq(400)
+      expect(last_response.body).to eq('{"error":"name is invalid"}')
     end
 
     it 'refuses empty' do
       get '/', name: ''
       expect(last_response.status).to eq(400)
+      expect(last_response.body).to eq('{"error":"name is invalid"}')
     end
   end
 

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

@@ -21,6 +21,22 @@ describe Grape::Validations::ValuesValidator do
       class API < Grape::API
         default_format :json
 
+        resources :custom_message do
+          params do
+            requires :type, values: { value: ValuesModel.values, message: 'value does not include in values' }
+          end
+          get '/' do
+            { type: params[:type] }
+          end
+
+          params do
+            optional :type, values: { value: -> { ValuesModel.values }, message: 'value does not include in values' }, default: 'valid-type2'
+          end
+          get '/lambda' do
+            { type: params[:type] }
+          end
+        end
+
         params do
           requires :type, values: ValuesModel.values
         end
@@ -91,6 +107,34 @@ describe Grape::Validations::ValuesValidator do
     ValidationsSpec::ValuesValidatorSpec::API
   end
 
+  context 'with a custom validation message' do
+    it 'allows a valid value for a parameter' do
+      get('/custom_message', type: 'valid-type1')
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq({ type: 'valid-type1' }.to_json)
+    end
+
+    it 'does not allow an invalid value for a parameter' do
+      get('/custom_message', type: 'invalid-type')
+      expect(last_response.status).to eq 400
+      expect(last_response.body).to eq({ error: 'type value does not include in values' }.to_json)
+    end
+
+    it 'validates against values in a proc' do
+      ValidationsSpec::ValuesModel.add_value('valid-type4')
+
+      get('/custom_message/lambda', type: 'valid-type4')
+      expect(last_response.status).to eq 200
+      expect(last_response.body).to eq({ type: 'valid-type4' }.to_json)
+    end
+
+    it 'does not allow an invalid value for a parameter using lambda' do
+      get('/custom_message/lambda', type: 'invalid-type')
+      expect(last_response.status).to eq 400
+      expect(last_response.body).to eq({ error: 'type value does not include in values' }.to_json)
+    end
+  end
+
   it 'allows a valid value for a parameter' do
     get('/', type: 'valid-type1')
     expect(last_response.status).to eq 200

data/spec/grape/validations_spec.rb

@@ -366,7 +366,7 @@ describe Grape::Validations do
       end
 
       it "doesn't throw a missing param when param is present" do
-        get '/required', items: [key: 'hello', key: 'world']
+        get '/required', items: [key: 'hello']
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('required works')
       end
@@ -942,14 +942,14 @@ describe Grape::Validations do
           class CustomvalidatorWithOptions < Grape::Validations::Base
             def validate_param!(attr_name, params)
               return if params[attr_name] == @option[:text]
-              fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: @option[:error_message]
+              fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: message
             end
           end
         end
 
         before do
           subject.params do
-            optional :custom, customvalidator_with_options: { text: 'im custom with options', error_message: 'is not custom with options!' }
+            optional :custom, customvalidator_with_options: { text: 'im custom with options', message: 'is not custom with options!' }
           end
           subject.get '/optional_custom' do
             'optional with custom works!'
@@ -1078,8 +1078,62 @@ describe Grape::Validations do
       end
     end
 
+    context 'all or none' do
+      context 'optional params' do
+        before :each do
+          subject.resource :custom_message do
+            params do
+              optional :beer
+              optional :wine
+              optional :juice
+              all_or_none_of :beer, :wine, :juice, message: 'all params are required or none is required'
+            end
+            get '/all_or_none' do
+              'all_or_none works!'
+            end
+          end
+        end
+        context 'with a custom validation message' do
+          it 'errors when any one is present' do
+            get '/custom_message/all_or_none', beer: 'string'
+            expect(last_response.status).to eq(400)
+            expect(last_response.body).to eq 'beer, wine, juice all params are required or none is required'
+          end
+          it 'works when all params are present' do
+            get '/custom_message/all_or_none', beer: 'string', wine: 'anotherstring', juice: 'anotheranotherstring'
+            expect(last_response.status).to eq(200)
+            expect(last_response.body).to eq 'all_or_none works!'
+          end
+          it 'works when none are present' do
+            get '/custom_message/all_or_none'
+            expect(last_response.status).to eq(200)
+            expect(last_response.body).to eq 'all_or_none works!'
+          end
+        end
+      end
+    end
+
     context 'mutually exclusive' do
       context 'optional params' do
+        context 'with custom validation message' do
+          it 'errors when two or more are present' do
+            subject.resources :custom_message do
+              params do
+                optional :beer
+                optional :wine
+                optional :juice
+                mutually_exclusive :beer, :wine, :juice, message: 'are mutually exclusive cannot pass both params'
+              end
+              get '/mutually_exclusive' do
+                'mutually_exclusive works!'
+              end
+            end
+            get '/custom_message/mutually_exclusive', beer: 'string', wine: 'anotherstring'
+            expect(last_response.status).to eq(400)
+            expect(last_response.body).to eq 'beer, wine are mutually exclusive cannot pass both params'
+          end
+        end
+
         it 'errors when two or more are present' do
           subject.params do
             optional :beer
@@ -1098,6 +1152,34 @@ describe Grape::Validations do
       end
 
       context 'more than one set of mutually exclusive params' do
+        context 'with a custom validation message' do
+          it 'errors for all sets' do
+            subject.resources :custom_message do
+              params do
+                optional :beer
+                optional :wine
+                mutually_exclusive :beer, :wine, message: 'are mutually exclusive pass only one'
+                optional :nested, type: Hash do
+                  optional :scotch
+                  optional :aquavit
+                  mutually_exclusive :scotch, :aquavit, message: 'are mutually exclusive pass only one'
+                end
+                optional :nested2, type: Array do
+                  optional :scotch2
+                  optional :aquavit2
+                  mutually_exclusive :scotch2, :aquavit2, message: 'are mutually exclusive pass only one'
+                end
+              end
+              get '/mutually_exclusive' do
+                'mutually_exclusive works!'
+              end
+            end
+            get '/custom_message/mutually_exclusive', beer: 'true', wine: 'true', nested: { scotch: 'true', aquavit: 'true' }, nested2: [{ scotch2: 'true' }, { scotch2: 'true', aquavit2: 'true' }]
+            expect(last_response.status).to eq(400)
+            expect(last_response.body).to eq 'beer, wine are mutually exclusive pass only one, scotch, aquavit are mutually exclusive pass only one, scotch2, aquavit2 are mutually exclusive pass only one'
+          end
+        end
+
         it 'errors for all sets' do
           subject.params do
             optional :beer
@@ -1131,7 +1213,6 @@ describe Grape::Validations do
               optional :wine
               optional :beer
               optional :juice
-
               mutually_exclusive :beer, :wine, :juice
             end
           end
@@ -1185,6 +1266,18 @@ describe Grape::Validations do
     context 'exactly one of' do
       context 'params' do
         before :each do
+          subject.resources :custom_message do
+            params do
+              optional :beer
+              optional :wine
+              optional :juice
+              exactly_one_of :beer, :wine, :juice, message: { exactly_one: 'are missing, exactly one parameter is required', mutual_exclusion: 'are mutually exclusive, exactly one parameter is required' }
+            end
+            get '/exactly_one_of' do
+              'exactly_one_of works!'
+            end
+          end
+
           subject.params do
             optional :beer
             optional :wine
@@ -1196,6 +1289,26 @@ describe Grape::Validations do
           end
         end
 
+        context 'with a custom validation message' do
+          it 'errors when none are present' do
+            get '/custom_message/exactly_one_of'
+            expect(last_response.status).to eq(400)
+            expect(last_response.body).to eq 'beer, wine, juice are missing, exactly one parameter is required'
+          end
+
+          it 'succeeds when one is present' do
+            get '/custom_message/exactly_one_of', beer: 'string'
+            expect(last_response.status).to eq(200)
+            expect(last_response.body).to eq 'exactly_one_of works!'
+          end
+
+          it 'errors when two or more are present' do
+            get '/custom_message/exactly_one_of', beer: 'string', wine: 'anotherstring'
+            expect(last_response.status).to eq(400)
+            expect(last_response.body).to eq 'beer, wine are mutually exclusive, exactly one parameter is required'
+          end
+        end
+
         it 'errors when none are present' do
           get '/exactly_one_of'
           expect(last_response.status).to eq(400)
@@ -1259,6 +1372,18 @@ describe Grape::Validations do
     context 'at least one of' do
       context 'params' do
         before :each do
+          subject.resources :custom_message do
+            params do
+              optional :beer
+              optional :wine
+              optional :juice
+              at_least_one_of :beer, :wine, :juice, message: 'are missing, please specify at least one param'
+            end
+            get '/at_least_one_of' do
+              'at_least_one_of works!'
+            end
+          end
+
           subject.params do
             optional :beer
             optional :wine
@@ -1270,6 +1395,26 @@ describe Grape::Validations do
           end
         end
 
+        context 'with a custom validation message' do
+          it 'errors when none are present' do
+            get '/custom_message/at_least_one_of'
+            expect(last_response.status).to eq(400)
+            expect(last_response.body).to eq 'beer, wine, juice are missing, please specify at least one param'
+          end
+
+          it 'does not error when one is present' do
+            get '/custom_message/at_least_one_of', beer: 'string'
+            expect(last_response.status).to eq(200)
+            expect(last_response.body).to eq 'at_least_one_of works!'
+          end
+
+          it 'does not error when two are present' do
+            get '/custom_message/at_least_one_of', beer: 'string', wine: 'string'
+            expect(last_response.status).to eq(200)
+            expect(last_response.body).to eq 'at_least_one_of works!'
+          end
+        end
+
         it 'errors when none are present' do
           get '/at_least_one_of'
           expect(last_response.status).to eq(400)

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ require 'rack/test'
 require 'base64'
 require 'cookiejar'
 require 'mime/types'
+require 'cgi'
 
 Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
   require file

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -349,8 +349,11 @@ files:
 - lib/grape/dsl/api.rb
 - lib/grape/dsl/callbacks.rb
 - lib/grape/dsl/configuration.rb
+- lib/grape/dsl/desc.rb
+- lib/grape/dsl/headers.rb
 - lib/grape/dsl/helpers.rb
 - lib/grape/dsl/inside_route.rb
+- lib/grape/dsl/logger.rb
 - lib/grape/dsl/middleware.rb
 - lib/grape/dsl/parameters.rb
 - lib/grape/dsl/request_response.rb
@@ -358,6 +361,7 @@ files:
 - lib/grape/dsl/settings.rb
 - lib/grape/dsl/validations.rb
 - lib/grape/endpoint.rb
+- lib/grape/error_formatter.rb
 - lib/grape/error_formatter/base.rb
 - lib/grape/error_formatter/json.rb
 - lib/grape/error_formatter/txt.rb
@@ -370,6 +374,7 @@ files:
 - lib/grape/exceptions/invalid_version_header.rb
 - lib/grape/exceptions/invalid_versioner_option.rb
 - lib/grape/exceptions/invalid_with_option_for_represent.rb
+- lib/grape/exceptions/method_not_allowed.rb
 - lib/grape/exceptions/missing_group_type.rb
 - lib/grape/exceptions/missing_mime_type.rb
 - lib/grape/exceptions/missing_option.rb
@@ -380,7 +385,7 @@ files:
 - lib/grape/exceptions/unsupported_group_type.rb
 - lib/grape/exceptions/validation.rb
 - lib/grape/exceptions/validation_errors.rb
-- lib/grape/formatter/base.rb
+- lib/grape/formatter.rb
 - lib/grape/formatter/json.rb
 - lib/grape/formatter/serializable_hash.rb
 - lib/grape/formatter/txt.rb
@@ -403,7 +408,7 @@ files:
 - lib/grape/middleware/versioner/parse_media_type_patch.rb
 - lib/grape/middleware/versioner/path.rb
 - lib/grape/namespace.rb
-- lib/grape/parser/base.rb
+- lib/grape/parser.rb
 - lib/grape/parser/json.rb
 - lib/grape/parser/xml.rb
 - lib/grape/path.rb
@@ -415,6 +420,7 @@ files:
 - lib/grape/util/file_response.rb
 - lib/grape/util/inheritable_setting.rb
 - lib/grape/util/inheritable_values.rb
+- lib/grape/util/sendfile_response.rb
 - lib/grape/util/stackable_values.rb
 - lib/grape/util/strict_hash_configuration.rb
 - lib/grape/validations.rb
@@ -441,16 +447,21 @@ files:
 - lib/grape/validations/validators/regexp.rb
 - lib/grape/validations/validators/values.rb
 - lib/grape/version.rb
-- pkg/grape-0.13.0.gem
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/deeply_included_options_spec.rb
+- spec/grape/api/namespace_parameters_in_route_spec.rb
 - spec/grape/api/nested_helpers_spec.rb
+- spec/grape/api/optional_parameters_in_route_spec.rb
+- spec/grape/api/required_parameters_in_route_spec.rb
 - spec/grape/api/shared_helpers_spec.rb
 - spec/grape/api_spec.rb
 - spec/grape/dsl/callbacks_spec.rb
 - spec/grape/dsl/configuration_spec.rb
+- spec/grape/dsl/desc_spec.rb
+- spec/grape/dsl/headers_spec.rb
 - spec/grape/dsl/helpers_spec.rb
 - spec/grape/dsl/inside_route_spec.rb
+- spec/grape/dsl/logger_spec.rb
 - spec/grape/dsl/middleware_spec.rb
 - spec/grape/dsl/parameters_spec.rb
 - spec/grape/dsl/request_response_spec.rb
@@ -468,6 +479,8 @@ files:
 - spec/grape/exceptions/unknown_options_spec.rb
 - spec/grape/exceptions/unknown_validator_spec.rb
 - spec/grape/exceptions/validation_errors_spec.rb
+- spec/grape/exceptions/validation_spec.rb
+- spec/grape/integration/rack_sendfile_spec.rb
 - spec/grape/integration/rack_spec.rb
 - spec/grape/loading_spec.rb
 - spec/grape/middleware/auth/base_spec.rb
@@ -539,13 +552,19 @@ summary: A simple Ruby framework for building REST-like APIs.
 test_files:
 - spec/grape/api/custom_validations_spec.rb
 - spec/grape/api/deeply_included_options_spec.rb
+- spec/grape/api/namespace_parameters_in_route_spec.rb
 - spec/grape/api/nested_helpers_spec.rb
+- spec/grape/api/optional_parameters_in_route_spec.rb
+- spec/grape/api/required_parameters_in_route_spec.rb
 - spec/grape/api/shared_helpers_spec.rb
 - spec/grape/api_spec.rb
 - spec/grape/dsl/callbacks_spec.rb
 - spec/grape/dsl/configuration_spec.rb
+- spec/grape/dsl/desc_spec.rb
+- spec/grape/dsl/headers_spec.rb
 - spec/grape/dsl/helpers_spec.rb
 - spec/grape/dsl/inside_route_spec.rb
+- spec/grape/dsl/logger_spec.rb
 - spec/grape/dsl/middleware_spec.rb
 - spec/grape/dsl/parameters_spec.rb
 - spec/grape/dsl/request_response_spec.rb
@@ -563,6 +582,8 @@ test_files:
 - spec/grape/exceptions/unknown_options_spec.rb
 - spec/grape/exceptions/unknown_validator_spec.rb
 - spec/grape/exceptions/validation_errors_spec.rb
+- spec/grape/exceptions/validation_spec.rb
+- spec/grape/integration/rack_sendfile_spec.rb
 - spec/grape/integration/rack_spec.rb
 - spec/grape/loading_spec.rb
 - spec/grape/middleware/auth/base_spec.rb