sinatra-params-validator 0.0.2 → 0.0.3

data/README.md

@@ -66,7 +66,9 @@ class App < Sinatra::Base
 
   validation_required :POST, '/group', :params => [
     { :name => :name, :required => true },
-    { :name => :private, :type => :boolean, :required => true }
+    { :name => :private, :type => :boolean, :required => true },
+    { :name => :type, :set => %{public private}, :default => 'public' },
+    { :name => :param, :action => [ :trim, :downcase ] }
   ]
 
   post '/group' do
@@ -78,23 +80,32 @@ end
 
 Try it out yourself and run this in the root directory `rackup example/app.rb`.
 
+__NOTE__ Every parameter that is used for that particular request needs to be mentioned in the params
+array. Every parameter that hasn't been mentioned will be delete and won't be available in the sinatra
+`params` variable when your sinatra code block is invoked.
+
 ## Validator class
 
 A class with several methods to validate and clean data from sinatra params holder.
-Can be used for an adopter for other libraries/frameworks, like rails.
+Can be used as a basis for an adopter for other libraries/frameworks, like rails.
 
 ### Examples
 
 Initialize class in lazy mode, this means that once a validation fail the following ones are not executed:
 
 ```ruby
+require 'rack/validator'
+
 validator = Rack::Validator.new(params)
 #required_3 is not present
 validator.required [:required_1, :required_2, :required_3]
-validator.trim
-validator.downcase [:required_2, :other_param]
+validator.trim :required_1
+validator.downcase :required_2
+validator.downcase :other
 validator.is_in_range 3, 32, :required_1
 validator.is_email :contact
+validator.is_boolean :private
+validator.is_set %{public private}, :type
 validator.matches /[a-z]{2}_[A-Z]{2}|[a-z]{2}/i, :locale
 
 if validator.has_errors?
@@ -117,7 +128,14 @@ Available methods:
 * is_in_range
 * is_less_equal_than
 * is_email
+* is_set
 * is_boolean
 * matches
+* clean_parameters
 
 To see more examples check tests/params_validator_spec.rb
+
+## Contribution
+
+If you like the project, fork me and help make sinatra better.
+Make sure to include test cases and explanation for the implemented feature.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/rack/validator/sinatra.rb

@@ -6,6 +6,7 @@ module Rack
     attr_reader :invalid_params
     attr_reader :missing_params
     attr_reader :messages
+    attr_reader :params
     attr_accessor :lazy_mode
 
     def initialize(params, lazy_mode = true)
@@ -20,12 +21,12 @@ module Rack
       @invalid_params.length > 0 or @missing_params.length > 0
     end
 
-    def trim
-      @params.each_key { |k| @params[k] = @params[k].strip if @params[k]}
+    def trim(key)
+      @params[key.to_s] = @params[key.to_s].strip if @params[key.to_s]
     end
 
-    def downcase(keys)
-      keys.each { |k| @params[k.to_s] = @params[k.to_s].to_s.downcase if @params[k.to_s]}
+    def downcase(key)
+      @params[key.to_s] = @params[key.to_s].to_s.downcase if @params[key.to_s]
     end
 
     def required(keys)
@@ -127,6 +128,16 @@ module Rack
       end
     end
 
+    def is_set(array, key)
+      if lazy_check_disabled
+        key = key.to_s
+        unless array.include? @params[key]
+          @invalid_params.push(key)
+          @messages.push("#{key} does not match #{array}")
+        end
+      end
+    end
+
     def is_boolean(key)
       if lazy_check_disabled
         key = key.to_s
@@ -147,6 +158,12 @@ module Rack
       end
     end
 
+    def clean_parameters(all_parameters)
+      @params.each_key do |key|
+        @params.delete key.to_s unless all_parameters.include? key.to_s
+      end
+    end
+
     private
 
     def lazy_check_disabled
@@ -179,26 +196,34 @@ module Rack
         # TODO: Needs a general cleanup!!!
         def validate_parameters(options)
           validator = Rack::Validator.new params, false
+          all_params = [ ]
           required_params = [ ]
           integer_params = [ ]
           float_params = [ ]
           email_params = [ ]
           range_params = [ ]
+          set_params = [ ]
           boolean_params = [ ]
           matches_params = [ ]
           default_params = [ ]
+          action_params = [ ]
 
           options[:params].each do |param|
+            all_params << (param[:name].to_s)
             required_params << (param[:name]) if param[:required]
             integer_params << (param) if param[:type] == :integer
             float_params << (param) if param[:type] == :float
             email_params << (param) if param[:type] == :email
             range_params << (param) if param[:range]
+            set_params << (param) if param[:set]
             boolean_params << (param) if param[:type] == :boolean
             matches_params << (param) if param[:matches]
             default_params << (param) if param[:default]
+            action_params << (param) if param[:action]
           end
 
+          validator.clean_parameters all_params
+
           validator.required required_params
 
           integer_params.each do |param|
@@ -213,6 +238,9 @@ module Rack
           range_params.each do |param|
             validator.is_in_range param[:range].first, param[:range].last, param[:name] unless params[param[:name].to_s].nil?
           end
+          set_params.each do |param|
+            validator.is_set param[:set], param[:name] unless params[param[:name].to_s].nil?
+          end
           boolean_params.each do |param|
             validator.is_boolean param[:name] unless params[param[:name].to_s].nil?
           end
@@ -228,6 +256,11 @@ module Rack
             end
           end
 
+          action_params.each do |param|
+            validator.downcase param[:name] if param[:action].include? :downcase
+            validator.trim param[:name] if param[:action].include? :trim
+          end
+
           if validator.has_errors?
             @env['validator.missing'] = validator.missing_params
             @env['validator.invalid'] = validator.invalid_params

data/sinatra-params-validator.gemspec

@@ -3,7 +3,7 @@ $: << File.dirname(__FILE__) + "/lib"
 Gem::Specification.new do |spec|
   spec.name           = "sinatra-params-validator"
   spec.version        = IO.read("VERSION")
-  spec.authors        = ["tsov", "lube8buy"]
+  spec.authors        = ["tsov", "lube8uy"]
   spec.email          = "tsov@me.com"
   spec.homepage       = "http://github.com/tsov/#{spec.name}"
   spec.summary        = "A Sinatra Module to validate incoming parameters"

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-params-validator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
 - tsov
-- lube8buy
+- lube8uy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-30 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies: []
 description: This sinatra module validates the incoming parameter and lets you configure
   the pattern.