params_validator 0.2.0 → 0.3.0

data/README.md

@@ -1,4 +1,4 @@
-# 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)
+# params_validator [![Continuous Integration](https://secure.travis-ci.org/chdorner/params_validator.png?branch=master)](https://secure.travis-ci.org/chdorner/params_validator)
 
 A DSL for validating request parameters, raises exceptions when validation failed. Currently only supports Rails.
 
@@ -109,6 +109,19 @@ Basic usage:
 * `q=`
 * `somethingelse=term`
 
+### Whitelist
+
+    validate_params_for :search, { :type => { :_with => [:whitelist], :_whitelist: [:documents, :pictures], :_default: :documents } }
+
+**Valid:**
+
+* `type=documents`
+* `type=pictures`
+
+**Invalid:**
+
+* `type=unicorns`
+
 ## Validation errors
 
 When validation of parameters fails, this gem is raising a `ParamsValidator::InvalidParamsException` error which contains an `errors` hash with further information.
@@ -127,7 +140,7 @@ As briefly described in the example at the beginning, the easiest way to rescue
     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.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
@@ -138,6 +151,6 @@ As briefly described in the example at the beginning, the easiest way to rescue
 
 ## Copyright
 
-Copyright (c) 2012 Christof Dorner. See LICENSE.txt for
+Copyright (c) 2013 Christof Dorner. See LICENSE.txt for
 further details.
 

data/lib/params_validator.rb

@@ -4,7 +4,13 @@ Bundler.require(:default)
 module ParamsValidator
   class InvalidValidatorException < Exception; end
   class InvalidParamsException < Exception
-    attr_accessor :errors
+    attr_reader :errors
+
+    def initialize(errors)
+      @errors = errors
+
+      super()
+    end
   end
 end
 

data/lib/params_validator/class_methods.rb

@@ -14,7 +14,8 @@ module ParamsValidator
         action_filter_name = "validate_params_for_action_#{action}".to_sym
 
         define_method(action_filter_name) do
-          Filter::validate_params(params, definition)
+          sanitized_params = Filter.sanitize_params(params, definition)
+          request.parameters.merge!(sanitized_params)
         end
         self.before_filter action_filter_name, :only => action
       end

data/lib/params_validator/filter.rb

@@ -2,33 +2,45 @@ module ParamsValidator
   module Filter
     extend ActiveSupport::Inflector
 
-    def self.validate_params(params, definition)
+    class << self
+      attr_accessor :params
+    end
+
+    def self.sanitize_params(params, definition)
+      self.params = params
       errors = {}
       definition.each do |field, validation_definition|
-        errors = validate_field(field, params, validation_definition, errors)
+        errors = validate_field(field, validation_definition, errors)
 
-        validation_definition.reject {|k,v| k == :_with }.each do |nested_field, nested_validation_definition|
-          errors = validate_field(nested_field, params[field.to_s], nested_validation_definition, errors)
+        validation_definition.reject {|k,v| reserved_keys.include?(k) }.each do |nested_field, nested_validation_definition|
+          sanitize_params(params[field.to_s], { nested_field => nested_validation_definition })
         end
       end
-      if errors.count > 0
-        exception = InvalidParamsException.new
-        exception.errors = errors
-        raise exception
-      end
+      raise InvalidParamsException.new(errors) unless errors.empty?
+      self.params
     end
 
     private
 
-    def self.validate_field(field, params, validation_definition, errors)
-      return errors unless validation_definition.has_key? :_with
-      validation_definition[:_with].each do |validator_name|
+    def self.reserved_keys
+      @reserved_keys ||= [:_default, :_whitelist, :_with].to_set
+    end
+
+    def self.validate_field(field, validation_definition, errors)
+      validators = validation_definition[:_with]
+      return errors unless validators
+      validators.each do |validator_name|
         camelized_validator_name = self.camelize(validator_name)
         begin
-          validator = constantize("ParamsValidator::Validator::#{camelized_validator_name}")
+          validator = ParamsValidator::Validator.const_get(camelized_validator_name)
+          validator = validator.new(validation_definition)
           value = params.is_a?(Hash) ? params[field.to_s] : nil
           unless validator.valid?(value)
-            errors[field] = validator.error_message
+            if validator.respond_to?(:default?) && validator.default?
+              params[field] = validator.default
+            else
+              errors[field] = validator.error_message
+            end
           end
         rescue NameError
           raise InvalidValidatorException.new(validator_name)

data/lib/params_validator/validator.rb

@@ -1,3 +1,5 @@
-require 'params_validator/validator/type'
+require 'params_validator/validator/base'
 require 'params_validator/validator/presence'
+require 'params_validator/validator/type'
+require 'params_validator/validator/whitelist'
 

data/lib/params_validator/validator/base.rb

@@ -0,0 +1,22 @@
+module ParamsValidator
+  module Validator
+    class Base
+      attr_reader :default
+
+      def initialize(definition={})
+      end
+
+      def default?
+        instance_variable_defined?('@default')
+      end
+
+      def error_message
+        raise NotImplementedError
+      end
+
+      def valid?(value)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/params_validator/validator/presence.rb

@@ -1,9 +1,11 @@
 module ParamsValidator
   module Validator
-    module Presence
-      def self.error_message; "is empty"; end
+    class Presence < Base
+      def error_message
+        'is empty'
+      end
 
-      def self.valid?(value)
+      def valid?(value)
         value.present?
       end
     end

data/lib/params_validator/validator/type.rb

@@ -1,50 +1,49 @@
 module ParamsValidator
   module Validator
+    class Type < Base
+      def error_message
+        "is not of type #{type}"
+      end
 
-    private
+      def valid?(value)
+        true unless Presence.new.valid?(value)
+      end
 
-    module Base
       private
-      def define_type_validator(type_name, &block)
-        @type_name = type_name
-        @block = block
-
-        def self.error_message
-          "is not of type #{@type_name.to_s.downcase}"
-        end
 
-        def self.valid?(value)
-          return true unless Presence.valid?(value)
-          return !!@block.call(value) rescue false
-        end
+      def type
+        self.class.to_s.split(/type/i).last.downcase
       end
     end
 
-    public
-
-    module TypeInteger
-      extend Base
-      define_type_validator('integer') { |value| Integer(value) }
+    class TypeInteger < Type
+      def valid?(value)
+        super || !!Integer(value) rescue false
+      end
     end
 
-    module TypeFloat
-      extend Base
-      define_type_validator('float') { |value| Float(value) }
+    class TypeFloat < Type
+      def valid?(value)
+        super || !!Float(value) rescue false
+      end
     end
 
-    module TypeString
-      extend Base
-      define_type_validator('string') { |value| value.kind_of? String }
+    class TypeString < Type
+      def valid?(value)
+        super || value.kind_of?(String)
+      end
     end
 
-    module TypeArray
-      extend Base
-      define_type_validator('array') { |value| value.kind_of? Array }
+    class TypeArray < Type
+      def valid?(value)
+        super || value.kind_of?(Array)
+      end
     end
 
-    module TypeHash
-      extend Base
-      define_type_validator('hash') { |value| value.kind_of? Hash }
+    class TypeHash < Type
+      def valid?(value)
+        super || value.kind_of?(Hash)
+      end
     end
   end
 end

data/lib/params_validator/validator/whitelist.rb

@@ -0,0 +1,29 @@
+module ParamsValidator
+  module Validator
+    class Whitelist
+      attr_reader :default
+
+      def initialize(definition)
+        @default = definition[:_default] if definition.key?(:_default)
+        @whitelist = definition[:_whitelist].map(&:to_s).to_set
+      end
+
+      def default?
+        instance_variable_defined?('@default')
+      end
+
+      def error_message
+        'is invalid'
+      end
+
+      def valid?(value)
+        whitelist.include?(value)
+      end
+
+      private
+
+      attr_reader :whitelist
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: params_validator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-25 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70160878293820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70160878293820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70160878293300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,21 +37,31 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70160878293300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70160878292800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *70160878292800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70160878292320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70160878292320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70160878291840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160878291840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70160878291320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +101,15 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70160878291320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70160878290780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +117,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160878290780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70160878290240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +133,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160878290240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70160878289720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +149,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160878289720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70160878305580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +165,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70160878305580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: christof@chdorner.me
 executables: []
@@ -134,8 +184,10 @@ files:
 - lib/params_validator/filter.rb
 - lib/params_validator/railtie.rb
 - lib/params_validator/validator.rb
+- lib/params_validator/validator/base.rb
 - lib/params_validator/validator/presence.rb
 - lib/params_validator/validator/type.rb
+- lib/params_validator/validator/whitelist.rb
 - LICENSE.txt
 - README.md
 homepage: https://github.com/chdorner/params_validator
@@ -153,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 464833905745855690
+      hash: -1148739892296269609
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -162,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A DSL for validating request parameters, raises exceptions when validation