grape 1.3.0 → 1.5.2

data/spec/grape/validations_spec.rb

@@ -9,16 +9,23 @@ describe Grape::Validations do
     subject
   end
 
+  def declared_params
+    subject.namespace_stackable(:declared_params).flatten
+  end
+
   describe 'params' do
     context 'optional' do
-      it 'validates when params is present' do
+      before do
         subject.params do
           optional :a_number, regexp: /^[0-9]+$/
+          optional :attachment, type: File
         end
         subject.get '/optional' do
           'optional works!'
         end
+      end
 
+      it 'validates when params is present' do
         get '/optional', a_number: 'string'
         expect(last_response.status).to eq(400)
         expect(last_response.body).to eq('a_number is invalid')
@@ -29,14 +36,7 @@ describe Grape::Validations do
       end
 
       it "doesn't validate when param not present" do
-        subject.params do
-          optional :a_number, regexp: /^[0-9]+$/
-        end
-        subject.get '/optional' do
-          'optional works!'
-        end
-
-        get '/optional'
+        get '/optional', a_number: nil, attachment: nil
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('optional works!')
       end
@@ -45,7 +45,7 @@ describe Grape::Validations do
         subject.params do
           optional :some_param
         end
-        expect(subject.route_setting(:declared_params)).to eq([:some_param])
+        expect(declared_params).to eq([:some_param])
       end
     end
 
@@ -65,7 +65,7 @@ describe Grape::Validations do
 
       it 'adds entity documentation to declared params' do
         define_optional_using
-        expect(subject.route_setting(:declared_params)).to eq(%i[field_a field_b])
+        expect(declared_params).to eq(%i[field_a field_b])
       end
 
       it 'works when field_a and field_b are not present' do
@@ -112,7 +112,7 @@ describe Grape::Validations do
         subject.params do
           requires :some_param
         end
-        expect(subject.route_setting(:declared_params)).to eq([:some_param])
+        expect(declared_params).to eq([:some_param])
       end
 
       it 'works when required field is present but nil' do
@@ -197,7 +197,7 @@ describe Grape::Validations do
 
       it 'adds entity documentation to declared params' do
         define_requires_all
-        expect(subject.route_setting(:declared_params)).to eq(%i[required_field optional_field])
+        expect(declared_params).to eq(%i[required_field optional_field])
       end
 
       it 'errors when required_field is not present' do
@@ -232,7 +232,7 @@ describe Grape::Validations do
 
       it 'adds entity documentation to declared params' do
         define_requires_none
-        expect(subject.route_setting(:declared_params)).to eq(%i[required_field optional_field])
+        expect(declared_params).to eq(%i[required_field optional_field])
       end
 
       it 'errors when required_field is not present' do
@@ -262,7 +262,7 @@ describe Grape::Validations do
 
         it 'adds only the entity documentation to declared params, nothing more' do
           define_requires_all
-          expect(subject.route_setting(:declared_params)).to eq(%i[required_field optional_field])
+          expect(declared_params).to eq(%i[required_field optional_field])
         end
       end
 
@@ -328,7 +328,7 @@ describe Grape::Validations do
             requires :key
           end
         end
-        expect(subject.route_setting(:declared_params)).to eq([items: [:key]])
+        expect(declared_params).to eq([items: [:key]])
       end
     end
 
@@ -400,7 +400,7 @@ describe Grape::Validations do
             requires :key
           end
         end
-        expect(subject.route_setting(:declared_params)).to eq([items: [:key]])
+        expect(declared_params).to eq([items: [:key]])
       end
     end
 
@@ -463,7 +463,7 @@ describe Grape::Validations do
             requires :key
           end
         end
-        expect(subject.route_setting(:declared_params)).to eq([items: [:key]])
+        expect(declared_params).to eq([items: [:key]])
       end
     end
 
@@ -578,7 +578,7 @@ describe Grape::Validations do
         # NOTE: with body parameters in json or XML or similar this
         # should actually fail with: children[parents][name] is missing.
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('children[1][parents] is missing')
+        expect(last_response.body).to eq('children[1][parents] is missing, children[0][parents][1][name] is missing, children[0][parents][1][name] is empty')
       end
 
       it 'errors when a parameter is not present in array within array' do
@@ -619,7 +619,7 @@ describe Grape::Validations do
 
         get '/within_array', children: [name: 'Jay']
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('children[0][parents] is missing')
+        expect(last_response.body).to eq('children[0][parents] is missing, children[0][parents][0][name] is missing, children[0][parents][0][name] is empty')
       end
 
       it 'errors when param is not an Array' do
@@ -767,7 +767,7 @@ describe Grape::Validations do
         expect(last_response.status).to eq(200)
         put_with_json '/within_array', children: [name: 'Jay']
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('children[0][parents] is missing')
+        expect(last_response.body).to eq('children[0][parents] is missing, children[0][parents][0][name] is missing')
       end
     end
 
@@ -817,7 +817,7 @@ describe Grape::Validations do
             requires :key
           end
         end
-        expect(subject.route_setting(:declared_params)).to eq([items: [:key]])
+        expect(declared_params).to eq([items: [:key]])
       end
     end
 
@@ -842,7 +842,7 @@ describe Grape::Validations do
       it 'does internal validations if the outer group is present' do
         get '/nested_optional_group', items: [{ key: 'foo' }]
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('items[0][required_subitems] is missing')
+        expect(last_response.body).to eq('items[0][required_subitems] is missing, items[0][required_subitems][0][value] is missing')
 
         get '/nested_optional_group', items: [{ key: 'foo', required_subitems: [{ value: 'bar' }] }]
         expect(last_response.status).to eq(200)
@@ -862,7 +862,7 @@ describe Grape::Validations do
       it 'handles validation within arrays' do
         get '/nested_optional_group', items: [{ key: 'foo' }]
         expect(last_response.status).to eq(400)
-        expect(last_response.body).to eq('items[0][required_subitems] is missing')
+        expect(last_response.body).to eq('items[0][required_subitems] is missing, items[0][required_subitems][0][value] is missing')
 
         get '/nested_optional_group', items: [{ key: 'foo', required_subitems: [{ value: 'bar' }] }]
         expect(last_response.status).to eq(200)
@@ -881,7 +881,275 @@ describe Grape::Validations do
             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] }]])
+        expect(declared_params).to eq([items: [:key, { optional_subitems: [:value] }, { required_subitems: [:value] }]])
+      end
+
+      context <<~DESC do
+        Issue occurs whenever:
+        * param structure with at least three levels
+        * 1st level item is a required Array that has >1 entry with an optional item present and >1 entry with an optional item missing  
+        * 2nd level is an optional Array or Hash 
+        * 3rd level is a required item (can be any type)
+        * additional levels do not effect the issue from occuring
+      DESC
+
+        it "example based off actual real world use case" do
+          subject.params do
+            requires :orders, type: Array do
+              requires :id, type: Integer
+              optional :drugs, type: Array do
+                requires :batches, type: Array do
+                  requires :batch_no, type: String
+                end
+              end
+            end
+          end
+
+          subject.get '/validate_required_arrays_under_optional_arrays' do
+            'validate_required_arrays_under_optional_arrays works!'
+          end
+
+          data = {
+            orders: [
+              { id: 77, drugs: [{batches: [{batch_no: "A1234567"}]}]},
+              { id: 70 }
+            ]
+          }
+
+          get '/validate_required_arrays_under_optional_arrays', data
+          expect(last_response.body).to eq("validate_required_arrays_under_optional_arrays works!")
+          expect(last_response.status).to eq(200)
+        end
+
+        it "simplest example using Array -> Array -> Hash -> String" do
+          subject.params do
+            requires :orders, type: Array do
+              requires :id, type: Integer
+              optional :drugs, type: Array do
+                requires :batch_no, type: String
+              end
+            end
+          end
+
+          subject.get '/validate_required_arrays_under_optional_arrays' do
+            'validate_required_arrays_under_optional_arrays works!'
+          end
+
+          data = {
+            orders: [
+              { id: 77, drugs: [{batch_no: "A1234567"}]},
+              { id: 70 }
+            ]
+          }
+
+          get '/validate_required_arrays_under_optional_arrays', data
+          expect(last_response.body).to eq("validate_required_arrays_under_optional_arrays works!")
+          expect(last_response.status).to eq(200)
+        end
+
+        it "simplest example using Array -> Hash -> String" do
+          subject.params do
+            requires :orders, type: Array do
+              requires :id, type: Integer
+              optional :drugs, type: Hash do
+                requires :batch_no, type: String
+              end
+            end
+          end
+
+          subject.get '/validate_required_arrays_under_optional_arrays' do
+            'validate_required_arrays_under_optional_arrays works!'
+          end
+
+          data = {
+            orders: [
+              { id: 77, drugs: {batch_no: "A1234567"}},
+              { id: 70 }
+            ]
+          }
+
+          get '/validate_required_arrays_under_optional_arrays', data
+          expect(last_response.body).to eq("validate_required_arrays_under_optional_arrays works!")
+          expect(last_response.status).to eq(200)
+        end
+
+        it "correctly indexes invalida data" do
+          subject.params do
+            requires :orders, type: Array do
+              requires :id, type: Integer
+              optional :drugs, type: Array do
+                requires :batch_no, type: String
+                requires :quantity, type: Integer
+              end
+            end
+          end
+
+          subject.get '/correctly_indexes' do
+            'correctly_indexes works!'
+          end
+
+          data = {
+            orders: [
+              { id: 70 },
+              { id: 77, drugs: [{batch_no: "A1234567", quantity: 12}, {batch_no: "B222222"}]}
+            ]
+          }
+
+          get '/correctly_indexes', data
+          expect(last_response.body).to eq("orders[1][drugs][1][quantity] is missing")
+          expect(last_response.status).to eq(400)
+        end
+
+        context "multiple levels of optional and requires settings" do
+          before do
+            subject.params do
+              requires :top, type: Array do
+                requires :top_id, type: Integer, allow_blank: false
+                optional :middle_1, type: Array do
+                  requires :middle_1_id, type: Integer, allow_blank: false
+                  optional :middle_2, type: Array do
+                    requires :middle_2_id, type: String, allow_blank: false
+                    optional :bottom, type: Array do
+                      requires :bottom_id, type: Integer, allow_blank: false
+                    end
+                  end
+                end
+              end
+            end
+
+            subject.get '/multi_level' do
+              'multi_level works!'
+            end
+          end
+
+          it "with valid data" do
+            data = {
+              top: [
+                { top_id: 1, middle_1: [
+                  {middle_1_id: 11}, {middle_1_id: 12, middle_2: [
+                    {middle_2_id: 121}, {middle_2_id: 122, bottom: [{bottom_id: 1221}]}]}]},
+                { top_id: 2, middle_1: [
+                  {middle_1_id: 21}, {middle_1_id: 22, middle_2: [
+                  {middle_2_id: 221}]}]},
+                { top_id: 3, middle_1: [
+                  {middle_1_id: 31}, {middle_1_id: 32}]},
+                { top_id: 4 }
+              ]
+            }
+
+            get '/multi_level', data
+            expect(last_response.body).to eq("multi_level works!")
+            expect(last_response.status).to eq(200)
+          end
+
+          it "with invalid data" do
+            data = {
+              top: [
+                { top_id: 1, middle_1: [
+                  {middle_1_id: 11}, {middle_1_id: 12, middle_2: [
+                  {middle_2_id: 121}, {middle_2_id: 122, bottom: [{bottom_id: nil}]}]}]},
+                { top_id: 2, middle_1: [
+                  {middle_1_id: 21}, {middle_1_id: 22, middle_2: [{middle_2_id: nil}]}]},
+                { top_id: 3, middle_1: [
+                  {middle_1_id: nil}, {middle_1_id: 32}]},
+                { top_id: nil, missing_top_id: 4 }
+              ]
+            }
+            # debugger
+            get '/multi_level', data
+            expect(last_response.body.split(", ")).to match_array([
+              "top[3][top_id] is empty",
+              "top[2][middle_1][0][middle_1_id] is empty",
+              "top[1][middle_1][1][middle_2][0][middle_2_id] is empty",
+              "top[0][middle_1][1][middle_2][1][bottom][0][bottom_id] is empty"
+            ])
+            expect(last_response.status).to eq(400)
+          end
+        end
+      end
+
+      it "exactly_one_of" do
+        subject.params do
+          requires :orders, type: Array do
+            requires :id, type: Integer
+            optional :drugs, type: Hash do
+              optional :batch_no, type: String
+              optional :batch_id, type: String
+              exactly_one_of :batch_no, :batch_id
+            end
+          end
+        end
+
+        subject.get '/exactly_one_of' do
+          'exactly_one_of works!'
+        end
+
+        data = {
+          orders: [
+            { id: 77, drugs: {batch_no: "A1234567"}},
+            { id: 70 }
+          ]
+        }
+
+        get '/exactly_one_of', data
+        expect(last_response.body).to eq("exactly_one_of works!")
+        expect(last_response.status).to eq(200)
+      end
+
+      it "at_least_one_of" do
+        subject.params do
+          requires :orders, type: Array do
+            requires :id, type: Integer
+            optional :drugs, type: Hash do
+              optional :batch_no, type: String
+              optional :batch_id, type: String
+              at_least_one_of :batch_no, :batch_id
+            end
+          end
+        end
+
+        subject.get '/at_least_one_of' do
+          'at_least_one_of works!'
+        end
+
+        data = {
+          orders: [
+            { id: 77, drugs: {batch_no: "A1234567"}},
+            { id: 70 }
+          ]
+        }
+
+        get '/at_least_one_of', data
+        expect(last_response.body).to eq("at_least_one_of works!")
+        expect(last_response.status).to eq(200)
+      end
+
+      it "all_or_none_of" do
+        subject.params do
+          requires :orders, type: Array do
+            requires :id, type: Integer
+            optional :drugs, type: Hash do
+              optional :batch_no, type: String
+              optional :batch_id, type: String
+              all_or_none_of :batch_no, :batch_id
+            end
+          end
+        end
+
+        subject.get '/all_or_none_of' do
+          'all_or_none_of works!'
+        end
+
+        data = {
+          orders: [
+            { id: 77, drugs: {batch_no: "A1234567", batch_id: "12"}},
+            { id: 70 }
+          ]
+        }
+
+        get '/all_or_none_of', data
+        expect(last_response.body).to eq("all_or_none_of works!")
+        expect(last_response.status).to eq(200)
       end
     end
 
@@ -1126,14 +1394,14 @@ describe Grape::Validations do
           subject.params do
             use :pagination
           end
-          expect(subject.route_setting(:declared_params)).to eq %i[page per_page]
+          expect(declared_params).to eq %i[page per_page]
         end
 
         it 'by #use with multiple params' do
           subject.params do
             use :pagination, :period
           end
-          expect(subject.route_setting(:declared_params)).to eq %i[page per_page start_date end_date]
+          expect(declared_params).to eq %i[page per_page start_date end_date]
         end
       end
 
@@ -1422,7 +1690,7 @@ describe Grape::Validations do
           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, juice are missing, exactly one parameter is required'
+            expect(last_response.body).to eq 'beer, wine are missing, exactly one parameter is required'
           end
         end
 
@@ -1441,7 +1709,7 @@ describe Grape::Validations do
         it 'errors when two or more are present' do
           get '/exactly_one_of', beer: 'string', wine: 'anotherstring'
           expect(last_response.status).to eq(400)
-          expect(last_response.body).to eq 'beer, wine, juice are missing, exactly one parameter must be provided'
+          expect(last_response.body).to eq 'beer, wine are mutually exclusive'
         end
       end
 
@@ -1481,7 +1749,7 @@ describe Grape::Validations do
         it 'errors when two or more are present' do
           get '/exactly_one_of_nested', nested: { beer_nested: 'string' }, nested2: [{ beer_nested2: 'string', wine_nested2: 'anotherstring' }]
           expect(last_response.status).to eq(400)
-          expect(last_response.body).to eq 'nested2[0][beer_nested2], nested2[0][wine_nested2], nested2[0][juice_nested2] are missing, exactly one parameter must be provided'
+          expect(last_response.body).to eq 'nested2[0][beer_nested2], nested2[0][wine_nested2] are mutually exclusive'
         end
       end
     end

data/spec/integration/eager_load/eager_load_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'grape'
+
+describe Grape do
+  it 'eager_load!' do
+    require 'grape/eager_load'
+    expect { Grape.eager_load! }.to_not raise_error
+  end
+
+  it 'compile!' do
+    expect { Class.new(Grape::API).compile! }.to_not raise_error
+  end
+end

data/spec/shared/versioning_examples.rb

@@ -7,7 +7,7 @@ shared_examples_for 'versioning' do
     subject.get :hello do
       "Version: #{request.env['api.version']}"
     end
-    versioned_get '/hello', 'v1', macro_options
+    versioned_get '/hello', 'v1', **macro_options
     expect(last_response.body).to eql 'Version: v1'
   end
 
@@ -18,7 +18,7 @@ shared_examples_for 'versioning' do
     subject.get :hello do
       "Version: #{request.env['api.version']}"
     end
-    versioned_get '/hello', 'v1', macro_options.merge(prefix: 'api')
+    versioned_get '/hello', 'v1', **macro_options.merge(prefix: 'api')
     expect(last_response.body).to eql 'Version: v1'
   end
 
@@ -34,14 +34,14 @@ shared_examples_for 'versioning' do
       end
     end
 
-    versioned_get '/awesome', 'v1', macro_options
+    versioned_get '/awesome', 'v1', **macro_options
     expect(last_response.status).to eql 404
 
-    versioned_get '/awesome', 'v2', macro_options
+    versioned_get '/awesome', 'v2', **macro_options
     expect(last_response.status).to eql 200
-    versioned_get '/legacy', 'v1', macro_options
+    versioned_get '/legacy', 'v1', **macro_options
     expect(last_response.status).to eql 200
-    versioned_get '/legacy', 'v2', macro_options
+    versioned_get '/legacy', 'v2', **macro_options
     expect(last_response.status).to eql 404
   end
 
@@ -51,11 +51,11 @@ shared_examples_for 'versioning' do
       'I exist'
     end
 
-    versioned_get '/awesome', 'v1', macro_options
+    versioned_get '/awesome', 'v1', **macro_options
     expect(last_response.status).to eql 200
-    versioned_get '/awesome', 'v2', macro_options
+    versioned_get '/awesome', 'v2', **macro_options
     expect(last_response.status).to eql 200
-    versioned_get '/awesome', 'v3', macro_options
+    versioned_get '/awesome', 'v3', **macro_options
     expect(last_response.status).to eql 404
   end
 
@@ -74,10 +74,10 @@ shared_examples_for 'versioning' do
           end
         end
 
-        versioned_get '/version', 'v2', macro_options
+        versioned_get '/version', 'v2', **macro_options
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('v2')
-        versioned_get '/version', 'v1', macro_options
+        versioned_get '/version', 'v1', **macro_options
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('version v1')
       end
@@ -98,11 +98,11 @@ shared_examples_for 'versioning' do
           end
         end
 
-        versioned_get '/version', 'v1', macro_options.merge(prefix: subject.prefix)
+        versioned_get '/version', 'v1', **macro_options.merge(prefix: subject.prefix)
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('version v1')
 
-        versioned_get '/version', 'v2', macro_options.merge(prefix: subject.prefix)
+        versioned_get '/version', 'v2', **macro_options.merge(prefix: subject.prefix)
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('v2')
       end
@@ -131,11 +131,11 @@ shared_examples_for 'versioning' do
         end
       end
 
-      versioned_get '/version', 'v1', macro_options.merge(prefix: subject.prefix)
+      versioned_get '/version', 'v1', **macro_options.merge(prefix: subject.prefix)
       expect(last_response.status).to eq(200)
       expect(last_response.body).to eq('v1-version')
 
-      versioned_get '/version', 'v2', macro_options.merge(prefix: subject.prefix)
+      versioned_get '/version', 'v2', **macro_options.merge(prefix: subject.prefix)
       expect(last_response.status).to eq(200)
       expect(last_response.body).to eq('v2-version')
     end
@@ -148,7 +148,7 @@ shared_examples_for 'versioning' do
     subject.get :api_version_with_version_param do
       params[:version]
     end
-    versioned_get '/api_version_with_version_param?version=1', 'v1', macro_options
+    versioned_get '/api_version_with_version_param?version=1', 'v1', **macro_options
     expect(last_response.body).to eql '1'
   end
 
@@ -183,13 +183,13 @@ shared_examples_for 'versioning' do
 
     context 'v1' do
       it 'finds endpoint' do
-        versioned_get '/version', 'v1', macro_options
+        versioned_get '/version', 'v1', **macro_options
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('v1')
       end
 
       it 'finds catch all' do
-        versioned_get '/whatever', 'v1', macro_options
+        versioned_get '/whatever', 'v1', **macro_options
         expect(last_response.status).to eq(200)
         expect(last_response.body).to end_with 'whatever'
       end
@@ -197,13 +197,13 @@ shared_examples_for 'versioning' do
 
     context 'v2' do
       it 'finds endpoint' do
-        versioned_get '/version', 'v2', macro_options
+        versioned_get '/version', 'v2', **macro_options
         expect(last_response.status).to eq(200)
         expect(last_response.body).to eq('v2')
       end
 
       it 'finds catch all' do
-        versioned_get '/whatever', 'v2', macro_options
+        versioned_get '/whatever', 'v2', **macro_options
         expect(last_response.status).to eq(200)
         expect(last_response.body).to end_with 'whatever'
       end

data/spec/spec_helper.rb

@@ -14,25 +14,18 @@ Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
   require file
 end
 
+eager_load!
+
 # The default value for this setting is true in a standard Rails app,
 # so it should be set to true here as well to reflect that.
 I18n.enforce_available_locales = true
 
-module Chunks
-  def read_chunks(body)
-    buffer = []
-    body.each { |chunk| buffer << chunk }
-
-    buffer
-  end
-end
-
 RSpec.configure do |config|
-  config.include Chunks
   config.include Rack::Test::Methods
   config.include Spec::Support::Helpers
   config.raise_errors_for_deprecations!
   config.filter_run_when_matching :focus
+  config.warnings = true
 
   config.before(:each) { Grape::Util::InheritableSetting.reset_global! }
 

data/spec/support/chunks.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Chunks
+  def read_chunks(body)
+    buffer = []
+    body.each { |chunk| buffer << chunk }
+
+    buffer
+  end
+end
+
+RSpec.configure do |config|
+  config.include Chunks
+end