param_checker 0.0.1 → 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 by Kai Schlamp
+
+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.rdoc

@@ -0,0 +1,64 @@
+= ParamChecker
+
+ParamChecker is a small library for validation and parsing of user provided parameters. It is a handy way to check GET/POST params in Ruby webframeworks (like Rails or Sinatra).
+
+== Installation
+
+  gem install param_checker
+
+or add ParamChecker to your Gemfile
+
+  gem 'param_checker'
+
+and afterwards (when using the Gemfile) execute
+
+  bundle install
+
+== Usage
+
+Include the ParamChecker module where ever you like. I usually put it into my Rails +ApplicationController.rb+
+
+  class ApplicationController < ActionController::Base
+    include ParamChecker
+  end
+
+You can then simply call +check_string_param(param_to_check, "my default", ["foo", "bar"])+ in every controller.
+
+Instead of including the module you could also call all functions of the module directly.
+
+  ParamChecker.check_string_param(param_to_check, "my default", ["foo", "bar"])
+
+There are currently 5 supported functions:
+
+* +check_integer_param(param, default, min, max)+
+* +check_float_param(param, default, min, max)+
+* +check_string_param(param, default, allowed)+
+* +check_symbol_param(param, default, allowed)+
+* +check_boolean_param(param, default)+
+
++param+ is always the string parameter to check. +default+ is a value that is returned when +param+ does not succeed the check.
++min+ and +max+ in +check_integer_param+ and +check_float_param+ are the minimum and maximum allowed values of param. Both +min+ and +max+ options are optional. If they are not provided then no range is checked at all.
++allowed+ in +check_string_param+ and +check_symbol_param+ represent the allowed values of +param+. They can be either a string (resp. a symbol for +check_symbol_param+), a regular expression, or an array of strings (resp. symbols for +check_symbol_param+).
++check_boolean_param+ evaluates "1" or "true" string as true and "0" or "false" string to false.
+All functions return the parsed and type cast value (check_integer_param returns an integer, check_symbol_param returns a symbol, and so on).
+
+== Examples
+
+Below are some simple examples how I use those function in my controllers.
+
+  # +max+ is not provided in this case. I just want to ensure that page is bigger than 1 and otherwise return 1.
+  page = check_integer_param(params[:page], 1, 1)
+
+  # Returns "name" if params[:field] is not "name" or "address"
+  field = check_string_param(params[:field], "name", ["name", "address"])
+
+  # Return the boolean if params[:accepted] is a valid boolean representation, and the default false otherwise.
+  accepted = check_boolean_param(params[:accepted], false)
+
+== Testing
+
+ParamChecker uses RSpec for testing and has a rake task for executing the provided specs
+
+  rake spec
+
+Copyright © 2010-2011 Kai Schlamp (http://www.medihack.org), released under the MIT license

data/Rakefile

@@ -1,2 +1,5 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/lib/param_checker/version.rb

@@ -1,3 +1,3 @@
 module ParamChecker
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/param_checker.rb

@@ -1,5 +1,8 @@
 module ParamChecker
-  def self.check_integer_param(param, default, min = nil, max = nil)
+
+  module_function
+
+  def check_integer_param(param, default, min = nil, max = nil)
     min_lambda = (min.nil? ? lambda { true } : lambda { param.strip.to_i >= min })
     max_lambda = (max.nil? ? lambda { true } : lambda { param.strip.to_i <= max })
 
@@ -10,7 +13,7 @@ module ParamChecker
     end
   end
 
-  def self.check_float_param(param, default, min = nil, max = nil)
+  def check_float_param(param, default, min = nil, max = nil)
     min_lambda = (min.nil? ? lambda { true } : lambda { param.strip.to_i >= min })
     max_lambda = (max.nil? ? lambda { true } : lambda { param.strip.to_i <= max })
 
@@ -21,7 +24,7 @@ module ParamChecker
     end
   end
 
-  def self.check_string_param(param, default, allowed)
+  def check_string_param(param, default, allowed)
     if (param && allowed.class == Regexp && param =~ allowed)
       param
     elsif (param && allowed.class == Array && allowed.include?(param))
@@ -33,7 +36,7 @@ module ParamChecker
     end
   end
 
-  def self.check_symbol_param(param, default, allowed)
+  def check_symbol_param(param, default, allowed)
     begin
       if (param && allowed.class == Regexp && param.to_s =~ allowed)
         param.to_sym
@@ -49,7 +52,7 @@ module ParamChecker
     end
   end
 
-  def self.check_boolean_param(param, default)
+  def check_boolean_param(param, default)
     if (param && param == "1" || param == "true")
       true
     elsif (param && param == "0" || param == "false")
@@ -58,4 +61,10 @@ module ParamChecker
       default
     end
   end
+
+  public :check_integer_param,
+         :check_float_param,
+         :check_string_param,
+         :check_symbol_param,
+         :check_boolean_param
 end

data/param_checker.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Kai Schlamp"]
   s.email       = ["schlamp@gmx.de"]
-  s.homepage    = "http://www.medihack.org"
+  s.homepage    = "https://github.com/medihack/param_checker"
   s.summary     = %q{Parameter parsing and validation}
-  s.description = %q{A library for parameter parsing and validation. A handy way to check user provided params in Rails.}
+  s.description = %q{A library for parameter validation and parsing. A handy way to check GET/POST params in Ruby webframeworks (like Rails or Sinatra).}
 
   s.rubyforge_project = "param_checker"
 

data/spec/lib/param_checker_spec.rb

@@ -1,71 +1,83 @@
 require 'spec_helper'
 
 describe "ParamChecker" do
+  before(:all) do
+    @model = ParamCheckerModel.new
+  end
+
   it "should check integer" do
-    ParamChecker.check_integer_param("5", 99).should == 5
-    ParamChecker.check_integer_param("5", 99, 4).should == 5
-    ParamChecker.check_integer_param("5", 99, nil, 6).should == 5
-    ParamChecker.check_integer_param("5", 99, 4, 6).should == 5
-    ParamChecker.check_integer_param("-5", 99).should == -5
-    ParamChecker.check_integer_param(" 5 ", 99).should == 5
+    @model.check_integer_param("5", 99).should == 5
+    @model.check_integer_param("5", 99, 4).should == 5
+    @model.check_integer_param("5", 99, nil, 6).should == 5
+    @model.check_integer_param("5", 99, 4, 6).should == 5
+    @model.check_integer_param("-5", 99).should == -5
+    @model.check_integer_param(" 5 ", 99).should == 5
 
-    ParamChecker.check_integer_param("", 99).should == 99
-    ParamChecker.check_integer_param("5abc", 99).should == 99
-    ParamChecker.check_integer_param("5", 99, 6).should == 99
-    ParamChecker.check_integer_param("5", 99, nil, 4).should == 99
-    ParamChecker.check_integer_param("5", 99, 1, 4).should == 99
-    ParamChecker.check_integer_param("5", 99, 10, 1).should == 99
+    @model.check_integer_param("", 99).should == 99
+    @model.check_integer_param("5abc", 99).should == 99
+    @model.check_integer_param("5", 99, 6).should == 99
+    @model.check_integer_param("5", 99, nil, 4).should == 99
+    @model.check_integer_param("5", 99, 1, 4).should == 99
+    @model.check_integer_param("5", 99, 10, 1).should == 99
   end
 
   it "should check float" do
-    ParamChecker.check_float_param("5.1", 99.2).should == 5.1
-    ParamChecker.check_float_param("5.1", 99.2, 4.3).should == 5.1
-    ParamChecker.check_float_param("5.1", 99.2, nil, 6.4).should == 5.1
-    ParamChecker.check_float_param("5.1", 99.2, 4.3, 6.4).should == 5.1
-    ParamChecker.check_float_param("-5.1", 99.2).should == -5.1
-    ParamChecker.check_float_param(" 5.1 ", 99.2).should == 5.1
+    @model.check_float_param("5.1", 99.2).should == 5.1
+    @model.check_float_param("5.1", 99.2, 4.3).should == 5.1
+    @model.check_float_param("5.1", 99.2, nil, 6.4).should == 5.1
+    @model.check_float_param("5.1", 99.2, 4.3, 6.4).should == 5.1
+    @model.check_float_param("-5.1", 99.2).should == -5.1
+    @model.check_float_param(" 5.1 ", 99.2).should == 5.1
 
-    ParamChecker.check_float_param("", 99.2).should == 99.2
-    ParamChecker.check_float_param("5abc", 99.2).should == 99.2
-    ParamChecker.check_float_param("5", 99.2, 6.4).should == 99.2
-    ParamChecker.check_float_param("5", 99.2, nil, 4.3).should == 99.2
-    ParamChecker.check_float_param("5", 99.2, 1, 4.3).should == 99.2
-    ParamChecker.check_float_param("5", 99.2, 10.5, 1.6).should == 99.2
+    @model.check_float_param("", 99.2).should == 99.2
+    @model.check_float_param("5abc", 99.2).should == 99.2
+    @model.check_float_param("5", 99.2, 6.4).should == 99.2
+    @model.check_float_param("5", 99.2, nil, 4.3).should == 99.2
+    @model.check_float_param("5", 99.2, 1, 4.3).should == 99.2
+    @model.check_float_param("5", 99.2, 10.5, 1.6).should == 99.2
   end
 
   it "should check string" do
-    ParamChecker.check_string_param("lorem", "dolor", /.*ore.*/).should == "lorem"
-    ParamChecker.check_string_param("lorem", "dolor", ["lorem", "ipsum"]).should == "lorem"
-    ParamChecker.check_string_param("lorem", "dolor", "lorem").should == "lorem"
-    ParamChecker.check_string_param("", "dolor", /.*/).should == ""
-    ParamChecker.check_string_param("", "dolor", "").should == ""
+    @model.check_string_param("lorem", "dolor", /.*ore.*/).should == "lorem"
+    @model.check_string_param("lorem", "dolor", ["lorem", "ipsum"]).should == "lorem"
+    @model.check_string_param("lorem", "dolor", "lorem").should == "lorem"
+    @model.check_string_param("", "dolor", /.*/).should == ""
+    @model.check_string_param("", "dolor", "").should == ""
 
-    ParamChecker.check_string_param("lorem", "dolor", /.*ips.*/).should == "dolor"
-    ParamChecker.check_string_param("lorem", "dolor", ["patre", "ipsum"]).should == "dolor"
-    ParamChecker.check_string_param("lorem", "dolor", "ipsum").should == "dolor"
+    @model.check_string_param("lorem", "dolor", /.*ips.*/).should == "dolor"
+    @model.check_string_param("lorem", "dolor", ["patre", "ipsum"]).should == "dolor"
+    @model.check_string_param("lorem", "dolor", "ipsum").should == "dolor"
   end
 
   it "should check symbol" do
-    ParamChecker.check_symbol_param("lorem", :dolor, /.*ore.*/).should == :lorem
-    ParamChecker.check_symbol_param("lorem", :dolor, ["lorem", :ipsum]).should == :lorem
-    ParamChecker.check_symbol_param("lorem", :dolor, :lorem).should == :lorem
+    @model.check_symbol_param("lorem", :dolor, /.*ore.*/).should == :lorem
+    @model.check_symbol_param("lorem", :dolor, ["lorem", :ipsum]).should == :lorem
+    @model.check_symbol_param("lorem", :dolor, :lorem).should == :lorem
 
-    ParamChecker.check_symbol_param("lorem", :dolor, /.*ips.*/).should == :dolor
-    ParamChecker.check_symbol_param("lorem", :dolor, ["patre", "ipsum"]).should == :dolor
-    ParamChecker.check_symbol_param("lorem", :dolor, "ipsum").should == :dolor
-    ParamChecker.check_symbol_param("lorem", "dolor", "ipsum").should == :dolor
-    ParamChecker.check_symbol_param("", :dolor, /.*/).should == :dolor
-    ParamChecker.check_symbol_param("", :dolor, "").should == :dolor
+    @model.check_symbol_param("lorem", :dolor, /.*ips.*/).should == :dolor
+    @model.check_symbol_param("lorem", :dolor, ["patre", "ipsum"]).should == :dolor
+    @model.check_symbol_param("lorem", :dolor, "ipsum").should == :dolor
+    @model.check_symbol_param("lorem", "dolor", "ipsum").should == :dolor
+    @model.check_symbol_param("", :dolor, /.*/).should == :dolor
+    @model.check_symbol_param("", :dolor, "").should == :dolor
   end
 
   it "should check boolean" do
-    ParamChecker.check_boolean_param("1", false).should == true
-    ParamChecker.check_boolean_param("true", false).should == true
-    ParamChecker.check_boolean_param("0", true).should == false
-    ParamChecker.check_boolean_param("false", true).should == false
+    @model.check_boolean_param("1", false).should == true
+    @model.check_boolean_param("true", false).should == true
+    @model.check_boolean_param("0", true).should == false
+    @model.check_boolean_param("false", true).should == false
 
-    ParamChecker.check_boolean_param("3", true).should == true
-    ParamChecker.check_boolean_param("", true).should == true
-    ParamChecker.check_boolean_param("abc", true).should == true
+    @model.check_boolean_param("3", true).should == true
+    @model.check_boolean_param("", true).should == true
+    @model.check_boolean_param("abc", true).should == true
+  end
+
+  it "can be called as module functions" do
+    ParamChecker.check_integer_param("5", 99).should == 5
+    ParamChecker.check_float_param("5.1", 99.2).should == 5.1
+    ParamChecker.check_string_param("lorem", "dolor", /.*ore.*/).should == "lorem"
+    ParamChecker.check_symbol_param("lorem", :dolor, /.*ore.*/).should == :lorem
+    ParamChecker.check_boolean_param("1", false).should == true
   end
 end

data/spec/model.rb

@@ -0,0 +1,3 @@
+class ParamCheckerModel
+  include ParamChecker
+end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 require 'param_checker'
 
-#load(File.dirname(__FILE__) + '/models.rb')
+load(File.dirname(__FILE__) + '/model.rb')
 
 RSpec.configure do |config|
   config.filter_run :focus => true

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: param_checker
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Kai Schlamp
@@ -34,7 +34,7 @@ dependencies:
         version: 2.0.0
   type: :development
   version_requirements: *id001
-description: A library for parameter parsing and validation. A handy way to check user provided params in Rails.
+description: A library for parameter validation and parsing. A handy way to check GET/POST params in Ruby webframeworks (like Rails or Sinatra).
 email: 
 - schlamp@gmx.de
 executables: []
@@ -46,14 +46,17 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- MIT-LICENSE
+- README.rdoc
 - Rakefile
 - lib/param_checker.rb
 - lib/param_checker/version.rb
 - param_checker.gemspec
 - spec/lib/param_checker_spec.rb
+- spec/model.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://www.medihack.org
+homepage: https://github.com/medihack/param_checker
 licenses: []
 
 post_install_message: