params_validator 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Christof Dorner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+# params_validator ![Continuous Integration](https://secure.travis-ci.org/chdorner/epubinfo.png?branch=master)
+
+A DSL for validating request parameters, raises exceptions when validation failed. Currently only supports Rails.
+
+Current status is very much alpha, this gem is still under development and not intended to use in production applications.
+
+# Installation
+
+Add this to your Gemfile and run `bundle install`
+
+    gem 'params_validator'
+
+# Usage
+
+Basic usage:
+
+    class WelcomeController < ActionController::Base
+      rescue_from ParamsValidator::InvalidParamsException do |exception|
+        render :text => 'Error', :status => :bad_request
+      end
+
+      validate_params_for :index, { :count => { :with => [:type_integer] } }
+      def index
+        @articles = Article.limit(params[:count])
+      end
+    end
+
+## Validators
+
+### TypeInteger
+
+    validate_params_for :index, { :count => { :with => [:type_integer] } }
+
+**Valid:**
+
+* `count=1`
+
+**Invalid:**
+
+* `count=something`
+* `count[]=1`
+* `count[key]=value`
+
+### TypeFloat
+
+    validate_params_for :index, { :position => { :with => [:type_float] } }
+
+**Valid:**
+
+* `position=0.42`
+* `position=1`
+
+**Invalid:**
+
+* `position=something`
+* `position[]=0.42`
+* `position[key]=0.42`
+
+### TypeString
+
+    validate_params_for :index, { :name => { :with => [:type_string] } }
+
+**Valid:**
+
+* `name=Jack`
+* `name=1`
+
+**Invalid:**
+
+* `name[]=Jack`
+* `name[key]=Jack`
+
+### TypeHash
+
+    validate_params_for :index, { :options => { :with => [:type_hash] } }
+
+**Valid:**
+
+* `options[all]=true`
+
+**Invalid:**
+
+* `options=all`
+* `options[]=all`
+
+### TypeArray
+
+    validate_params_for :index, { :ids => { :with => [:type_array] } }
+
+**Valid:**
+
+* `ids[]=1`
+
+**Invalid:**
+
+* `ids=1`
+* `ids[1]=true`
+
+## 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.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Christof Dorner. See LICENSE.txt for
+further details.
+

data/lib/params_validator.rb

@@ -0,0 +1,13 @@
+require 'bundler/setup'
+Bundler.require(:default)
+
+module ParamsValidator
+  class InvalidParamsException < Exception; end
+  class InvalidValidatorException < Exception; end
+end
+
+require 'params_validator/class_methods'
+require 'params_validator/filter'
+require 'params_validator/railtie'
+require 'params_validator/validator'
+

data/lib/params_validator/class_methods.rb

@@ -0,0 +1,24 @@
+module ParamsValidator
+  module ClassMethods
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :params_validation_definitions
+    end
+
+    module ClassMethods
+      def validate_params_for(action, definition)
+        self.params_validation_definitions ||= {}
+        self.params_validation_definitions[action.to_sym] = definition
+
+        action_filter_name = "validate_params_for_action_#{action}".to_sym
+
+        define_method(action_filter_name) do
+          Filter::validate_params(params, definition)
+        end
+        self.before_filter action_filter_name, :only => action
+      end
+    end
+  end
+end
+

data/lib/params_validator/filter.rb

@@ -0,0 +1,22 @@
+module ParamsValidator
+  module Filter
+    extend ActiveSupport::Inflector
+
+    def self.validate_params(params, definition)
+      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
+            end
+          rescue NameError
+            raise InvalidValidatorException.new(validator_name)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/params_validator/railtie.rb

@@ -0,0 +1,10 @@
+module ParamsValidator
+  class Railtie < Rails::Railtie
+    initializer 'params_validator.insert_into_action_controller' do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send(:include, ::ParamsValidator::ClassMethods)
+      end
+    end
+  end
+end
+

data/lib/params_validator/validator.rb

@@ -0,0 +1,6 @@
+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'
+

data/lib/params_validator/validator/type_array.rb

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

data/lib/params_validator/validator/type_float.rb

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,15 @@
+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

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

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: params_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Christof Dorner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70160681777260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70160681777260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70160681793780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70160681793780
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70160681789960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70160681789960
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70160681812280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70160681812280
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70160681810740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70160681810740
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70160681822060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70160681822060
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70160681819620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70160681819620
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70160681830320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70160681830320
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70160681826500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70160681826500
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70160681823660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70160681823660
+description: 
+email: christof@chdorner.me
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- lib/params_validator.rb
+- lib/params_validator/class_methods.rb
+- 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
+- LICENSE.txt
+- README.md
+homepage: https://github.com/chdorner/params_validator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4216775152249830731
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: A DSL for validating request parameters, raises exceptions when validation
+  failed. Currently only supports Rails.
+test_files: []