allowed_params 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ae4f72c04eb3f9dbf641a052240110f67b33b9f
-  data.tar.gz: bfacbca807f0e699013f2e6c7f4c14449b452e9b
+  metadata.gz: d84fd4bf309d1033e2c8192fb33240efbe49481c
+  data.tar.gz: ca19af6df7e37a423d1ad648b3078d296a249882
 SHA512:
-  metadata.gz: 666107c6262d625cc80850ba02b4e576a874de704f05a275922cd70a94f326c3daea2a3d2593e55477f661af027ed9a1d552b18c1c6189c0f6d62ba038952c93
-  data.tar.gz: 24e9038ee98ecb5a6a5955b1e7768808682a1667d379ad1f53ebe823c121d0152a614a5313047c2df3c124457a08ce52af63aa62c253271493a852dba4a19ed7
+  metadata.gz: a8574c49f9a50508728969a4f75a4e968a239c0a22faebcae4375542885fd7a24dc736c29d1c3c1e3870641ce1d78fa629c573950bea909bb63f9627ee6161f6
+  data.tar.gz: 09ee405c1a72ca1474e63572d8d6f999e8fbb288105e3263eb4b6b45f03187fd1488e01ef8341af1cd111dc99eec8134e12b515cd49ca4e763236ef408024ac7

data/README.md

@@ -1,25 +1,53 @@
 # AllowedParams
 
+## Installation
+
+This project uses [semantic versioning](http://semver.org/spec/v2.0.0.html).
+
+Add it to your Gemfile:
+
+```ruby
+gem 'allowed_params'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself with:
+
+```sh
+$ gem install allowed_params
+```
+
+
+## Usage
+
 This gem provides filtering and validations of params
+
+## Params validation with whitelist
  
 ```ruby
 
-    class DogsController < ApplicationController
+    class EmployersController < ApplicationController
         include AllowedParams::Helper
         
-        params do
-            allow :name, presence: true
-            allow :age
+        params whitelist: true do
+            validate :id, presence: true
+            validate :name, presence: true
+            validate :position, inclusion: { in: %w(manager developer) }
         end
         def update
             # do the job
-        end 
+        end        
     end
     
 ```
-
-This will validate `params[:name]` and raise `AllowedParams::ValidationError` in case of invalid value.
-`age` param is allowed and not validated. All other params is not allowed.
+ 
+This will validate listed params and raise `AllowedParams::ValidationError` in case of invalid value.
+All other params are not allowed, and `AllowedParams::NotAllowedError` will be raised if present.
 
 To allow params on all controllers:
  
@@ -27,7 +55,26 @@ To allow params on all controllers:
 
     AllowedParams.config.allowed_params = [:format]
 
+```   
+
+## Just validation   
+   
+```ruby    
+    class CatsController < ApplicationController
+        include AllowedParams::Helper
+        
+        params do
+            validates :name, presence: true
+            validates :kind, inclusion: { in: %w(fluffy bald) }
+        end
+        def update
+            # do the job
+        end        
+    end
+    
 ```
 
-This project rocks and uses MIT-LICENSE.
+This will validate `params[:name], params[:kind]` and raise `AllowedParams::ValidationError` in case of invalid value.
+All other params will just go through without any checks.
 
+This project rocks and uses MIT-LICENSE.

data/lib/allowed_params/helper.rb

@@ -8,29 +8,33 @@ module AllowedParams
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def params(&block)
+      def params(opts={}, &block)
         builder = ::AllowedParams::ValidatorBuilder.new(self)
         builder.instance_eval(&block) if block_given?
         @request_params_validator = builder.validator
+        @whitelist = opts.fetch(:whitelist, false)
       end
 
       def method_added(method)
         if instance_variable_get(:@request_params_validator).present?
           request_params_validator = @request_params_validator
           @request_params_validator = nil
+          whitelist = @whitelist
+          @whitelist = nil
 
           before_filter only: [method] do
             request_params = request_params_validator.new(params)
             if request_params.invalid?
               raise ValidationError, request_params.errors.full_messages.first
             end
-            if request_params.not_allowed.present?
-              raise NotAllowedError, request_params.not_allowed.join(', ')
+            if whitelist && request_params.not_white_listed.present?
+              raise NotAllowedError, request_params.not_white_listed.join(', ')
             end
           end
         end
+
         super
       end
     end
   end
-end
+end

data/lib/allowed_params/validator_builder.rb

@@ -10,7 +10,7 @@ module AllowedParams
       @params = {}
     end
 
-    def allow(name, options = {})
+    def validate(name, options = {})
       @params[name] = options
     end
 
@@ -40,9 +40,10 @@ module AllowedParams
           end
         end
 
-        def not_allowed
+        def not_white_listed
           @params.keys.map(&:to_s) - members.map(&:to_s)
         end
+
       end
     end
   end

data/lib/allowed_params/version.rb

@@ -1,3 +1,3 @@
 module AllowedParams
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end

metadata

@@ -1,74 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: allowed_params
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Tema Bolshakov
+- Dmitry Rybakov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: Allow to filter and validate params on rails controllers
 email:
 - abolshakov@spbtv.com
+- drybakov@spbtv.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -81,7 +69,7 @@ files:
 - lib/allowed_params/model.rb
 - lib/allowed_params/validator_builder.rb
 - lib/allowed_params/version.rb
-homepage: 
+homepage: https://github.com/SPBTV/allowed_params
 licenses:
 - MIT
 metadata: {}