apipie-rails 0.0.20 → 0.0.21

data/CHANGELOG

@@ -2,6 +2,13 @@
  Changelog
 ===========
 
+v0.0.21
+-------
+
+* fix RDoc 4.0 compatibility issue
+* ``validate_value`` and ``validate_presence`` options for better
+  validation granularity
+
 v0.0.20
 -------
 

data/README.rst

@@ -478,6 +478,13 @@ default_version
 validate
   Parameters validation is turned off when set to false.
 
+validate_value
+  Check the value of params against specified validators (true by
+  default)
+
+validate_presence
+  Check the params presence against the documentation.
+
 app_info
   Application long description.
 

data/lib/apipie/configuration.rb

@@ -2,8 +2,10 @@ module Apipie
   class Configuration
 
     attr_accessor :app_name, :app_info, :copyright, :markup, :disqus_shortname,
-      :validate, :api_base_url, :doc_base_url, :required_by_default, :layout,
-      :default_version, :debug, :version_in_url, :namespaced_resources
+      :api_base_url, :doc_base_url, :required_by_default, :layout,
+      :default_version, :debug, :version_in_url, :namespaced_resources,
+      :validate, :validate_value, :validate_presence
+
 
     alias_method :validate?, :validate
     alias_method :required_by_default?, :required_by_default
@@ -24,6 +26,16 @@ module Apipie
       return @reload_controllers && @api_controllers_matcher
     end
 
+    def validate_value
+      return (validate? && @validate_value)
+    end
+    alias_method :validate_value?, :validate_value
+
+    def validate_presence
+      return (validate? && @validate_presence)
+    end
+    alias_method :validate_presence?, :validate_presence
+
     # set to true if you want to use pregenerated documentation cache and avoid
     # generating the documentation on runtime (usefull for production
     # environment).
@@ -100,6 +112,8 @@ module Apipie
       @app_info = HashWithIndifferentAccess.new
       @copyright = nil
       @validate = true
+      @validate_value = true
+      @validate_presence = true
       @required_by_default = false
       @api_base_url = HashWithIndifferentAccess.new
       @doc_base_url = "/apipie"

data/lib/apipie/dsl_definition.rb

@@ -175,19 +175,17 @@ module Apipie
 
           define_method(description.method) do |*args|
 
-            if Apipie.configuration.validate == true
+            if Apipie.configuration.validate_presence?
               description.params.each do |_, param|
-
                 # check if required parameters are present
-                if param.required && !params.has_key?(param.name)
-                  raise ParamMissing.new(param.name)
-                end
+                raise ParamMissing.new(param.name) if param.required && !params.has_key?(param.name)
+              end
+            end
 
+            if Apipie.configuration.validate_value?
+              description.params.each do |_, param|
                 # params validations
-                if params.has_key?(param.name)
-                  param.validate(params[:"#{param.name}"])
-                end
-
+                param.validate(params[:"#{param.name}"]) if params.has_key?(param.name)
               end
             end
 

data/lib/apipie/markup.rb

@@ -7,7 +7,11 @@ module Apipie
       def initialize
         require 'rdoc'
         require 'rdoc/markup/to_html'
-        @rdoc ||= ::RDoc::Markup::ToHtml.new
+        if Gem::Version.new(::RDoc::VERSION) < Gem::Version.new('4.0.0')
+          @rdoc ||= ::RDoc::Markup::ToHtml.new()
+        else
+          @rdoc ||= ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
+        end
       end
 
       def to_html(text)

data/lib/apipie/validator.rb

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

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.0.20'
+  VERSION = '0.0.21'
 end

data/spec/controllers/users_controller_spec.rb

@@ -57,7 +57,11 @@ describe UsersController do
   describe "validators" do
 
     context "validations are disabled" do
-      before { Apipie.configuration.validate = false }
+      before do
+        Apipie.configuration.validate = false
+        Apipie.configuration.validate_value = true
+        Apipie.configuration.validate_presence = true
+      end
 
       it "should reply to valid request" do
         get :show, :id => '5', :session => "secret_hash"
@@ -70,9 +74,36 @@ describe UsersController do
 
     end
 
+    context "only presence validations are enabled" do
+      before do
+        Apipie.configuration.validate = true
+        Apipie.configuration.validate_value = false
+        Apipie.configuration.validate_presence = true
+      end
+
+      it "should reply to valid request" do
+        lambda { get :show, :id => 5, :session => "secret_hash" }.should_not raise_error
+        assert_response :success
+      end
+
+      it "should fail if required parameter is missing" do
+        lambda { get :show, :id => 5 }.should raise_error(Apipie::ParamMissing, /\bsession\b/)
+      end
+
+      it "should pass if required parameter has wrong type" do
+        lambda { get :show, :id => 5, :session => "secret_hash" }.should_not raise_error
+        lambda { get :show, :id => "ten", :session => "secret_hash" }.should_not raise_error
+      end
+
+    end
+
 
     context "validations are enabled" do
-      before { Apipie.configuration.validate = true }
+      before do
+        Apipie.configuration.validate = true
+        Apipie.configuration.validate_value = true
+        Apipie.configuration.validate_presence = true
+      end
 
       it "should reply to valid request" do
         get :show, :id => '5', :session => "secret_hash"
@@ -166,7 +197,7 @@ describe UsersController do
 
         lambda {
           post :create, :user => { :name => "root" }
-        }.should raise_error(Apipie::ParamInvalid, /pass/)
+        }.should raise_error(Apipie::ParamMissing, /pass/)
 
         post :create, :user => { :name => "root", :pass => "pwd" }
         assert_response :success

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails