Parameter validation: Raises error for all missing

- Instead of just raising `ParamMissing` for the first missing,
  instead raise a compound `ParamMultipleMissing` if there are more
  than one missing.
- Adds specs for both POST and GET requests.
- Fixes #802

Author: davidwessman

lib/apipie/dsl_definition.rb

@@ -241,9 +241,15 @@ def _apipie_define_validators(description)
               method_params = self.class._apipie_get_method_params(action_name)
 
               if Apipie.configuration.validate_presence?
+                invalid_params = []
                 method_params.each do |_, param|
                   # check if required parameters are present
-                  raise ParamMissing.new(param) if param.required && !params.key?(param.name)
+                  invalid_params << param if param.required && !params.key?(param.name)
+                end
+                if invalid_params.size == 1
+                  raise ParamMissing.new(invalid_params.first)
+                elsif invalid_params.size > 1
+                  raise ParamMultipleMissing.new(invalid_params)
                 end
               end
 

lib/apipie/errors.rb

@@ -24,6 +24,20 @@ def initialize(param)
     end
   end
 
+  class ParamMultipleMissing < ParamError
+    attr_accessor :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def to_s
+      params.map do |param|
+        ParamMissing.new(param).to_s
+      end.join("\n")
+    end
+  end
+
   class ParamMissing < DefinedParamError
     def to_s
       unless @param.options[:missing_message].nil?

lib/apipie/validator.rb

@@ -345,14 +345,23 @@ def params_ordered
 
       def validate(value)
         return false if !value.is_a? Hash
+
+        missing_params = []
         @hash_params&.each do |k, p|
           if Apipie.configuration.validate_presence?
-            raise ParamMissing.new(p) if p.required && !value.key?(k)
+            missing_params << p if p.required && !value.key?(k)
           end
           if Apipie.configuration.validate_value?
             p.validate(value[k]) if value.key?(k)
           end
         end
+
+        if missing_params.size == 1
+          raise ParamMissing.new(missing_params.first)
+        elsif missing_params.size > 1
+          raise ParamMultipleMissing.new(missing_params)
+        end
+
         return true
       end
 

spec/controllers/users_controller_spec.rb

@@ -37,6 +37,7 @@ def compare_hashes(h1, h2)
       expect(methods.keys).to include(:update)
       expect(methods.keys).to include(:two_urls)
       expect(methods.keys).to include(:action_with_headers)
+      expect(methods.keys).to include(:multiple_required_params)
     end
 
     it "should contain info about resource" do
@@ -101,6 +102,10 @@ def reload_controllers
             expect { get :show, :params => { :id => 5 }}.to raise_error(Apipie::ParamMissing, /session_parameter_is_required/)
           end
 
+          it "should fail if multiple required parameters are missing" do
+            expect { get :multiple_required_params }.to raise_error(Apipie::ParamMultipleMissing, /[required_parameter1|required_parameter2]{2}/)
+          end
+
           it "should pass if required parameter has wrong type" do
             expect { get :show, :params => { :id => 5 , :session => "secret_hash" }}.not_to raise_error
             expect { get :show, :params => { :id => "ten" , :session => "secret_hash" }}.not_to raise_error
@@ -246,6 +251,11 @@ def reload_controllers
               post :create, :params => { :user => { :name => "root", :pass => "12345", :membership => "____" } }
             }.to raise_error(Apipie::ParamInvalid, /membership/)
 
+            # Should include both pass and name
+            expect {
+              post :create, :params => { :user => { :membership => "standard" } }
+            }.to raise_error(Apipie::ParamMultipleMissing, /pass.*\n.*name|name.*\n.*pass/)
+
             expect {
               post :create, :params => { :user => { :name => "root" } }
             }.to raise_error(Apipie::ParamMissing, /pass/)

spec/dummy/app/controllers/users_controller.rb

@@ -301,4 +301,10 @@ def create_route
   header :HeaderNameWithDefaultValue, 'Header with default value', required: true, default: 'default value'
   def action_with_headers
   end
+
+  api :GET, '/users/multiple_required_params'
+  param :required_param1, String, required: true
+  param :required_param2, String, required: true
+  def multiple_required_params
+  end
 end

spec/dummy/config/routes.rb

@@ -8,6 +8,7 @@
       resources :users do
         collection do
           post :create_route
+          get :multiple_required_params
         end
       end
       resources :concerns, :only => [:index, :show]