params_validator 0.1.0 → 0.1.1

data/README.md

@@ -1,4 +1,4 @@
-# params_validator ![Continuous Integration](https://secure.travis-ci.org/chdorner/epubinfo.png?branch=master)
+# params_validator [![Continuous Integration](https://secure.travis-ci.org/chdorner/epubinfo.png?branch=master)](https://secure.travis-ci.org/chdorner/params_validator) [![Dependencies](https://gemnasium.com/chdorner/epubinfo.png)](https://gemnasium.com/chdorner/params_validator)
 
 A DSL for validating request parameters, raises exceptions when validation failed. Currently only supports Rails.
 
@@ -96,6 +96,36 @@ Basic usage:
 * `ids=1`
 * `ids[1]=true`
 
+### Presence
+
+    validate_params_for :search, { :q => { :with => [:presence] } }
+
+**Valid:**
+
+* `q=term`
+
+**Invalid:**
+
+* `q=`
+* `somethingelse=term`
+
+## Validation errors
+
+When validation of parameters fails, this gem is raising a `ParamsValidator::InvalidParamsException` error which contains an `errors` hash with further information.
+
+The `errors` hash is modeled after the Rails model validation errors like this:
+
+    {
+      :field_name => 'error description',
+      :integer_field => 'is not of type integer'
+    }
+
+As briefly described in the example at the beginning, the easiest way to rescue from validation errors is with a `rescue_from` block inside your controller, like this:
+
+    rescue_from ParamsValidator::InvalidParamsException do |exception|
+      render :json => { :errors => exception.errors }, :status => :bad_request
+    end
+
 ## Contributing to params_validator
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/lib/params_validator.rb

@@ -2,8 +2,10 @@ require 'bundler/setup'
 Bundler.require(:default)
 
 module ParamsValidator
-  class InvalidParamsException < Exception; end
   class InvalidValidatorException < Exception; end
+  class InvalidParamsException < Exception
+    attr_accessor :errors
+  end
 end
 
 require 'params_validator/class_methods'

data/lib/params_validator/filter.rb

@@ -3,19 +3,25 @@ module ParamsValidator
     extend ActiveSupport::Inflector
 
     def self.validate_params(params, definition)
+      errors = {}
       definition.each do |field, validation_definition|
         validation_definition[:with].each do |validator_name|
           camelized_validator_name = self.camelize(validator_name)
           begin
             validator = constantize("ParamsValidator::Validator::#{camelized_validator_name}")
             unless validator.valid?(params[field.to_s])
-              raise InvalidParamsException.new
+              errors[field] = validator.error_message
             end
           rescue NameError
             raise InvalidValidatorException.new(validator_name)
           end
         end
       end
+      if errors.count > 0
+        exception = InvalidParamsException.new
+        exception.errors = errors
+        raise exception
+      end
     end
   end
 end

data/lib/params_validator/validator.rb

@@ -1,6 +1,3 @@
-require 'params_validator/validator/type_integer'
-require 'params_validator/validator/type_float'
-require 'params_validator/validator/type_string'
-require 'params_validator/validator/type_hash'
-require 'params_validator/validator/type_array'
+require 'params_validator/validator/type'
+require 'params_validator/validator/presence'
 

data/lib/params_validator/validator/{type_array.rb → presence.rb}

@@ -1,8 +1,10 @@
 module ParamsValidator
   module Validator
-    module TypeArray
+    module Presence
+      def self.error_message; "is empty"; end
+
       def self.valid?(value)
-        value.kind_of? Array
+        value.present?
       end
     end
   end

data/lib/params_validator/validator/type.rb

@@ -0,0 +1,64 @@
+module ParamsValidator
+  module Validator
+    module TypeInteger
+      def self.error_message; "is not of type integer"; end
+
+      def self.valid?(value)
+        return true unless Presence.valid?(value)
+
+        begin
+          Integer(value)
+          true
+        rescue
+          false
+        end
+      end
+    end
+
+    module TypeFloat
+      def self.error_message; "is not of type float"; end
+
+      def self.valid?(value)
+        return true unless Presence.valid?(value)
+
+        begin
+          Float(value)
+          true
+        rescue
+          false
+        end
+      end
+    end
+
+    module TypeString
+      def self.error_message; "is not of type string"; end
+
+      def self.valid?(value)
+        return true unless Presence.valid?(value)
+
+        value.kind_of? String
+      end
+    end
+
+    module TypeArray
+      def self.error_message; "is not of type array"; end
+
+      def self.valid?(value)
+        return true unless Presence.valid?(value)
+
+        value.kind_of? Array
+      end
+    end
+
+    module TypeHash
+      def self.error_message; "is not of type hash"; end
+
+      def self.valid?(value)
+        return true unless Presence.valid?(value)
+
+        value.kind_of? Hash
+      end
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: params_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-15 00:00:00.000000000 Z
+date: 2012-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70160681777260 !ruby/object:Gem::Requirement
+  requirement: &70244496983080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70160681777260
+  version_requirements: *70244496983080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70160681793780 !ruby/object:Gem::Requirement
+  requirement: &70244496981740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70160681793780
+  version_requirements: *70244496981740
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70160681789960 !ruby/object:Gem::Requirement
+  requirement: &70244496980260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70160681789960
+  version_requirements: *70244496980260
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70160681812280 !ruby/object:Gem::Requirement
+  requirement: &70244496978500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70160681812280
+  version_requirements: *70244496978500
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70160681810740 !ruby/object:Gem::Requirement
+  requirement: &70244496977340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160681810740
+  version_requirements: *70244496977340
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70160681822060 !ruby/object:Gem::Requirement
+  requirement: &70244496976340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70160681822060
+  version_requirements: *70244496976340
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70160681819620 !ruby/object:Gem::Requirement
+  requirement: &70244496975260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160681819620
+  version_requirements: *70244496975260
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70160681830320 !ruby/object:Gem::Requirement
+  requirement: &70244497000340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160681830320
+  version_requirements: *70244497000340
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70160681826500 !ruby/object:Gem::Requirement
+  requirement: &70244496998380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160681826500
+  version_requirements: *70244496998380
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70160681823660 !ruby/object:Gem::Requirement
+  requirement: &70244496996880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +120,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160681823660
+  version_requirements: *70244496996880
 description: 
 email: christof@chdorner.me
 executables: []
@@ -134,11 +134,8 @@ files:
 - lib/params_validator/filter.rb
 - lib/params_validator/railtie.rb
 - lib/params_validator/validator.rb
-- lib/params_validator/validator/type_array.rb
-- lib/params_validator/validator/type_float.rb
-- lib/params_validator/validator/type_hash.rb
-- lib/params_validator/validator/type_integer.rb
-- lib/params_validator/validator/type_string.rb
+- lib/params_validator/validator/presence.rb
+- lib/params_validator/validator/type.rb
 - LICENSE.txt
 - README.md
 homepage: https://github.com/chdorner/params_validator
@@ -156,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4216775152249830731
+      hash: 1545211467612620897
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/params_validator/validator/type_float.rb

@@ -1,15 +0,0 @@
-module ParamsValidator
-  module Validator
-    module TypeFloat
-      def self.valid?(value)
-        begin
-          Float(value)
-          true
-        rescue
-          false
-        end
-      end
-    end
-  end
-end
-

data/lib/params_validator/validator/type_hash.rb

@@ -1,10 +0,0 @@
-module ParamsValidator
-  module Validator
-    module TypeHash
-      def self.valid?(value)
-        value.kind_of? Hash
-      end
-    end
-  end
-end
-

data/lib/params_validator/validator/type_integer.rb

@@ -1,15 +0,0 @@
-module ParamsValidator
-  module Validator
-    module TypeInteger
-      def self.valid?(value)
-        begin
-          Integer(value)
-          true
-        rescue
-          false
-        end
-      end
-    end
-  end
-end
-

data/lib/params_validator/validator/type_string.rb

@@ -1,10 +0,0 @@
-module ParamsValidator
-  module Validator
-    module TypeString
-      def self.valid?(value)
-        value.kind_of? String
-      end
-    end
-  end
-end
-