Merge pull request Apipie#390 from jcalvert/missing_message

Add custom message support for missing parameters

Author: Pajk

README.rst

@@ -291,6 +291,10 @@ meta
 show
   Parameter is hidden from documentation when set to false (true by default)
 
+missing-message
+  Specify the message to be returned if the parameter is missing as a string or Proc.
+  Defaults to ``Missing parameter #{name}`` if not specified.
+
 Example:
 ~~~~~~~~
 
@@ -301,6 +305,7 @@ Example:
      param :password, String, :desc => "Password for login", :required => true
      param :membership, ["standard","premium"], :desc => "User membership"
      param :admin_override, String, :desc => "Not shown in documentation", :show => false
+     param :ip_address, String, :desc => "IP address", :required => true, :missing_message => lambda { I18n.t("ip_address.required") }
    end
    def create
      #...

lib/apipie/dsl_definition.rb

@@ -223,7 +223,7 @@ def _apipie_define_validators(description)
               if Apipie.configuration.validate_presence?
                 method_params.each do |_, param|
                   # check if required parameters are present
-                  raise ParamMissing.new(param.name) if param.required && !params.has_key?(param.name)
+                  raise ParamMissing.new(param) if param.required && !params.has_key?(param.name)
                 end
               end
 

lib/apipie/errors.rb

@@ -17,7 +17,15 @@ def initialize(param)
 
   class ParamMissing < DefinedParamError
     def to_s
-      "Missing parameter #{@param}"
+      unless @param.options[:missing_message].nil?
+        if @param.options[:missing_message].kind_of?(Proc)
+          @param.options[:missing_message].call
+        else
+          @param.options[:missing_message].to_s
+        end
+      else
+        "Missing parameter #{@param.name}"
+      end
     end
   end
 

lib/apipie/validator.rb

@@ -305,7 +305,7 @@ def validate(value)
         if @hash_params
           @hash_params.each do |k, p|
             if Apipie.configuration.validate_presence?
-              raise ParamMissing.new(k) if p.required && !value.has_key?(k)
+              raise ParamMissing.new(p) if p.required && !value.has_key?(k)
             end
             if Apipie.configuration.validate_value?
               p.validate(value[k]) if value.has_key?(k)

spec/controllers/users_controller_spec.rb

@@ -97,7 +97,7 @@ def reload_controllers
           end
 
           it "should fail if required parameter is missing" do
-            expect { get :show, :id => 5 }.to raise_error(Apipie::ParamMissing, /\bsession\b/)
+            expect { get :show, :id => 5 }.to raise_error(Apipie::ParamMissing, /session_parameter_is_required/)
           end
 
           it "should pass if required parameter has wrong type" do
@@ -144,7 +144,7 @@ def reload_controllers
           end
 
           it "should fail if required parameter is missing" do
-            expect { get :show, :id => 5 }.to raise_error(Apipie::ParamMissing, /\bsession\b/)
+            expect { get :show, :id => 5 }.to raise_error(Apipie::ParamMissing, /session_parameter_is_required/)
           end
 
           it "should work with custom Type validator" do

spec/dummy/app/controllers/users_controller.rb

@@ -174,7 +174,7 @@ class UsersController < ApplicationController
   error 401, "Unauthorized"
   error :code => 404, :description => "Not Found"
   param :id, Integer, :desc => "user id", :required => true
-  param :session, String, :desc => "user is logged in", :required => true
+  param :session, String, :desc => "user is logged in", :required => true, :missing_message => lambda { "session_parameter_is_required" }
   param :regexp_param, /^[0-9]* years/, :desc => "regexp param"
   param :regexp2, /\b[A-Z0-9._%+-=]+@[A-Z0-9.-]+.[A-Z]{2,}\b/i, :desc => "email regexp"
   param :array_param, ["100", "one", "two", "1", "2"], :desc => "array validator"