grape 0.11.0 → 0.12.0

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

@@ -40,20 +40,6 @@ describe Grape::Validations::DefaultValidator do
           { random_number: params[:random], non_random_number: params[:non_random_number] }
         end
 
-        params do
-          # NOTE: The :foo parameter could be made required with json body
-          # params, and then an empty hash would be valid. With query parameters
-          # it must be optional if it isn't provided at all, as otherwise
-          # the validaton for the Hash itself fails because there is no such
-          # thing as an empty hash.
-          optional :foo, type: Hash do
-            optional :bar, default: 'foo-bar'
-          end
-        end
-        get '/group' do
-          { foo_bar: params[:foo][:bar] }
-        end
-
         params do
           optional :array, type: Array do
             requires :name
@@ -107,15 +93,119 @@ describe Grape::Validations::DefaultValidator do
     expect(before['random_number']).not_to eq(after['random_number'])
   end
 
-  it 'set default values for optional grouped params' do
-    get('/group')
-    expect(last_response.status).to eq(200)
-    expect(last_response.body).to eq({ foo_bar: 'foo-bar' }.to_json)
-  end
-
   it 'sets default values for grouped arrays' do
     get('/array?array[][name]=name&array[][name]=name2&array[][with_default]=bar2')
     expect(last_response.status).to eq(200)
     expect(last_response.body).to eq({ array: [{ name: 'name', with_default: 'default' }, { name: 'name2', with_default: 'bar2' }] }.to_json)
   end
+
+  context 'optional group with defaults' do
+    subject do
+      Class.new(Grape::API) do
+        default_format :json
+      end
+    end
+
+    def app
+      subject
+    end
+
+    context 'optional array without default value includes optional param with default value' do
+      before do
+        subject.params do
+          optional :optional_array, type: Array do
+            optional :foo_in_optional_array, default: 'bar'
+          end
+        end
+        subject.post '/optional_array' do
+          { optional_array: params[:optional_array] }
+        end
+      end
+
+      it 'returns nil for optional array if param is not provided' do
+        post '/optional_array'
+        expect(last_response.status).to eq(201)
+        expect(last_response.body).to eq({ optional_array: nil }.to_json)
+      end
+    end
+
+    context 'optional array with default value includes optional param with default value' do
+      before do
+        subject.params do
+          optional :optional_array_with_default, type: Array, default: [] do
+            optional :foo_in_optional_array, default: 'bar'
+          end
+        end
+        subject.post '/optional_array_with_default' do
+          { optional_array_with_default: params[:optional_array_with_default] }
+        end
+      end
+
+      it 'sets default value for optional array if param is not provided' do
+        post '/optional_array_with_default'
+        expect(last_response.status).to eq(201)
+        expect(last_response.body).to eq({ optional_array_with_default: [] }.to_json)
+      end
+    end
+
+    context 'optional hash without default value includes optional param with default value' do
+      before do
+        subject.params do
+          optional :optional_hash_without_default, type: Hash do
+            optional :foo_in_optional_hash, default: 'bar'
+          end
+        end
+        subject.post '/optional_hash_without_default' do
+          { optional_hash_without_default: params[:optional_hash_without_default] }
+        end
+      end
+
+      it 'returns nil for optional hash if param is not provided' do
+        post '/optional_hash_without_default'
+        expect(last_response.status).to eq(201)
+        expect(last_response.body).to eq({ optional_hash_without_default: nil }.to_json)
+      end
+    end
+
+    context 'optional hash with default value includes optional param with default value' do
+      before do
+        subject.params do
+          optional :optional_hash_with_default, type: Hash, default: {} do
+            optional :foo_in_optional_hash, default: 'bar'
+          end
+        end
+        subject.post '/optional_hash_with_default_empty_hash' do
+          { optional_hash_with_default: params[:optional_hash_with_default] }
+        end
+
+        subject.params do
+          optional :optional_hash_with_default, type: Hash, default: { foo_in_optional_hash: 'parent_default' } do
+            optional :some_param
+            optional :foo_in_optional_hash, default: 'own_default'
+          end
+        end
+        subject.post '/optional_hash_with_default_inner_params' do
+          { foo_in_optional_hash: params[:optional_hash_with_default][:foo_in_optional_hash] }
+        end
+      end
+
+      it 'sets default value for optional hash if param is not provided' do
+        post '/optional_hash_with_default_empty_hash'
+        expect(last_response.status).to eq(201)
+        expect(last_response.body).to eq({ optional_hash_with_default: {} }.to_json)
+      end
+
+      it 'sets default value from parent defaults for inner param if parent param is not provided' do
+        post '/optional_hash_with_default_inner_params'
+        expect(last_response.status).to eq(201)
+        expect(last_response.body).to eq({ foo_in_optional_hash: 'parent_default' }.to_json)
+      end
+
+      it 'sets own default value for inner param if parent param is provided' do
+        post '/optional_hash_with_default_inner_params', optional_hash_with_default: { some_param: 'param' }
+        expect(last_response.status).to eq(201)
+        expect(last_response.body).to eq({ foo_in_optional_hash: 'own_default' }.to_json)
+      end
+    end
+  end
 end

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

@@ -55,7 +55,7 @@ describe Grape::Validations::PresenceValidator do
   context 'with a required non-empty string' do
     before do
       subject.params do
-        requires :email, type: String, regexp: /^\S+$/
+        requires :email, type: String, allow_blank: false, regexp: /^\S+$/
       end
       subject.get do
         'Hello'
@@ -64,12 +64,12 @@ describe Grape::Validations::PresenceValidator do
     it 'requires when missing' do
       get '/'
       expect(last_response.status).to eq(400)
-      expect(last_response.body).to eq('{"error":"email is missing, email is invalid"}')
+      expect(last_response.body).to eq('{"error":"email is missing, email is empty"}')
     end
     it 'requires when empty' do
       get '/', email: ''
       expect(last_response.status).to eq(400)
-      expect(last_response.body).to eq('{"error":"email is invalid"}')
+      expect(last_response.body).to eq('{"error":"email is empty, email is invalid"}')
     end
     it 'valid when set' do
       get '/', email: 'bob@example.com'
@@ -176,4 +176,42 @@ describe Grape::Validations::PresenceValidator do
       expect(last_response.body).to eq('Nested triple'.to_json)
     end
   end
+
+  context 'with reused parameter documentation once required and once optional' do
+    before do
+      docs = { name: { type: String, desc: 'some name' } }
+
+      subject.params do
+        requires :all, using: docs
+      end
+      subject.get '/required' do
+        'Hello required'
+      end
+
+      subject.params do
+        optional :all, using: docs
+      end
+      subject.get '/optional' do
+        'Hello optional'
+      end
+    end
+    it 'works with required' do
+      get '/required'
+      expect(last_response.status).to eq(400)
+      expect(last_response.body).to eq('{"error":"name is missing"}')
+
+      get '/required', name: 'Bob'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('Hello required'.to_json)
+    end
+    it 'works with optional' do
+      get '/optional'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('Hello optional'.to_json)
+
+      get '/optional', name: 'Bob'
+      expect(last_response.status).to eq(200)
+      expect(last_response.body).to eq('Hello optional'.to_json)
+    end
+  end
 end

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

@@ -25,12 +25,17 @@ describe Grape::Validations::RegexpValidator do
       expect(last_response.status).to eq(400)
     end
 
-    it 'refuses nil' do
-      get '/', name: nil
+    it 'refuses empty' do
+      get '/', name: ''
       expect(last_response.status).to eq(400)
     end
   end
 
+  it 'accepts nil' do
+    get '/', name: nil
+    expect(last_response.status).to eq(200)
+  end
+
   it 'accepts valid input' do
     get '/', name: 'bob'
     expect(last_response.status).to eq(200)

data/spec/grape/validations_spec.rb

@@ -353,7 +353,7 @@ describe Grape::Validations do
     end
 
     context 'group params with nested params which has a type' do
-      let(:invalid_items){ { items: '' } }
+      let(:invalid_items) { { items: '' } }
 
       before do
         subject.params do
@@ -1132,6 +1132,25 @@ describe Grape::Validations do
           expect(last_response.status).to eq(400)
         end
       end
+
+      context 'mutually exclusive params inside Hash group' do
+        it 'invalidates if request param is invalid type' do
+          subject.params do
+            optional :wine, type: Hash do
+              optional :grape
+              optional :country
+              mutually_exclusive :grape, :country
+            end
+          end
+          subject.post '/mutually_exclusive' do
+            'mutually_exclusive works!'
+          end
+
+          post '/mutually_exclusive', wine: '2015 sauvignon'
+          expect(last_response.status).to eq(400)
+          expect(last_response.body).to eq 'wine is invalid'
+        end
+      end
     end
 
     context 'exactly one of' do

data/spec/support/file_streamer.rb

@@ -0,0 +1,11 @@
+class FileStreamer
+  def initialize(file_path)
+    @file_path = file_path
+  end
+
+  def each(&blk)
+    File.open(@file_path, 'rb') do |file|
+      file.each(10, &blk)
+    end
+  end
+end

data/spec/support/versioned_helpers.rb

@@ -28,7 +28,7 @@ def versioned_headers(options)
       'HTTP_ACCEPT' => [
         "application/vnd.#{options[:vendor] }-#{options[:version] }",
         options[:format]
-     ].compact.join('+')
+      ].compact.join('+')
     }
   when :accept_version_header
     {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -360,6 +360,7 @@ files:
 - lib/grape/formatter/serializable_hash.rb
 - lib/grape/formatter/txt.rb
 - lib/grape/formatter/xml.rb
+- lib/grape/http/headers.rb
 - lib/grape/http/request.rb
 - lib/grape/locale/en.yml
 - lib/grape/middleware/auth/base.rb
@@ -381,6 +382,7 @@ files:
 - lib/grape/parser/json.rb
 - lib/grape/parser/xml.rb
 - lib/grape/path.rb
+- lib/grape/presenters/presenter.rb
 - lib/grape/route.rb
 - lib/grape/util/content_types.rb
 - lib/grape/util/inheritable_setting.rb
@@ -403,6 +405,8 @@ files:
 - lib/grape/validations/validators/regexp.rb
 - lib/grape/validations/validators/values.rb
 - lib/grape/version.rb
+- spec/grape/api/custom_validations_spec.rb
+- spec/grape/api/deeply_included_options_spec.rb
 - spec/grape/api/nested_helpers_spec.rb
 - spec/grape/api/shared_helpers_spec.rb
 - spec/grape/api_spec.rb
@@ -436,12 +440,14 @@ files:
 - spec/grape/middleware/error_spec.rb
 - spec/grape/middleware/exception_spec.rb
 - spec/grape/middleware/formatter_spec.rb
+- spec/grape/middleware/globals_spec.rb
 - spec/grape/middleware/versioner/accept_version_header_spec.rb
 - spec/grape/middleware/versioner/header_spec.rb
 - spec/grape/middleware/versioner/param_spec.rb
 - spec/grape/middleware/versioner/path_spec.rb
 - spec/grape/middleware/versioner_spec.rb
 - spec/grape/path_spec.rb
+- spec/grape/presenters/presenter_spec.rb
 - spec/grape/util/inheritable_setting_spec.rb
 - spec/grape/util/inheritable_values_spec.rb
 - spec/grape/util/stackable_values_spec.rb
@@ -465,6 +471,7 @@ files:
 - spec/support/basic_auth_encode_helpers.rb
 - spec/support/content_type_helpers.rb
 - spec/support/endpoint_faker.rb
+- spec/support/file_streamer.rb
 - spec/support/versioned_helpers.rb
 homepage: https://github.com/intridea/grape
 licenses:
@@ -491,6 +498,8 @@ signing_key:
 specification_version: 4
 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/nested_helpers_spec.rb
 - spec/grape/api/shared_helpers_spec.rb
 - spec/grape/api_spec.rb
@@ -524,12 +533,14 @@ test_files:
 - spec/grape/middleware/error_spec.rb
 - spec/grape/middleware/exception_spec.rb
 - spec/grape/middleware/formatter_spec.rb
+- spec/grape/middleware/globals_spec.rb
 - spec/grape/middleware/versioner/accept_version_header_spec.rb
 - spec/grape/middleware/versioner/header_spec.rb
 - spec/grape/middleware/versioner/param_spec.rb
 - spec/grape/middleware/versioner/path_spec.rb
 - spec/grape/middleware/versioner_spec.rb
 - spec/grape/path_spec.rb
+- spec/grape/presenters/presenter_spec.rb
 - spec/grape/util/inheritable_setting_spec.rb
 - spec/grape/util/inheritable_values_spec.rb
 - spec/grape/util/stackable_values_spec.rb
@@ -553,5 +564,6 @@ test_files:
 - spec/support/basic_auth_encode_helpers.rb
 - spec/support/content_type_helpers.rb
 - spec/support/endpoint_faker.rb
+- spec/support/file_streamer.rb
 - spec/support/versioned_helpers.rb
 has_rdoc: