rack-param 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b2edee1664ad9b019933bc685bf5f46cbeac16e
+  data.tar.gz: fc27ecd3dee2e3d1a510f118ffff495ba7de9cbd
+SHA512:
+  metadata.gz: f40aab970852ee0aec2b0dce37ff7308ad04924801ddbc8a05ae945da5d59c646cc1d10a7df02d194b9fced920d442461ef4309a7413de2af3280a79015d9c11
+  data.tar.gz: 141fcefcaecb4637d94a073ebd7feb0081e37f511d5555269daa8340460e634651a5e35050b66277f3c342ef32fa227494b0277d5934d6c3cddfb0ac81af956f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+#Changelog
+
+v 0.0.1
+
+- Initial release
+
+v 0.1.0
+
+- Complete rewrite
+   * Write tests
+   * Make rules more readable in `param.rb`
+   * `Rack::Request#params` now points to coerced and validated parameters

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-param.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathaniel Symer
+
+MIT License
+
+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,53 @@
+# Rack::Param
+
+Parameter checking and validation for `Rack::Request`. Originally designed to be used with [`Sansom`](http://github.com/fhsjaagshs/fhsjaagshs), but it also works with [`Rack`](http://github.com/rack/rack).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-param'
+
+And then execute:
+
+    $ bundle
+
+Or install it through `gem`:
+
+    $ gem install rack-param
+
+## Usage
+
+    require "rack/param"
+    
+    r = Rack::Request env # pass your env
+    r.param :param_name, Integer, :required => true ...
+    
+Now, `r.params` should contain a single entry:
+    
+    { :param_name => <some Integer> }
+    
+`Rack::Param` patches `Rack::Request#params` to contain only the validated parameters, in coerced form.
+
+Here's a list of options:
+
+`:required` => `true`/`false`<br />
+`:blank` => `true`/`false`<br />
+`:greater_than` => Any `Numeric`<br />
+`:less_than` => Any `Numeric`<br />
+`:min` => Any `Numeric`<br />
+`:max` => Any `Numeric`<br />
+`:length` => Any `Numeric`<br />
+`:min_length` => Any `Numeric`<br />
+`:max_length` => Any `Numeric`<br />
+`:in` => Something that responds to `include?`<br />
+`:regex` => A `Regexp`<br />
+`:validator` => A block: `{ |param| true }`<br />
+
+## Contributing
+
+1. Fork it ( https://github.com/sansomrb/rack-param/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/rack/param.rb

@@ -0,0 +1,136 @@
+#/usr/bin/env ruby
+
+require "rack"
+require "time"
+require "date"
+
+Boolean = "Boolean" # A boldfaced hack
+
+module Rack
+  ParameterError = Class.new StandardError
+  
+  class ::String
+    def truthy?
+      (/^(true|t|yes|y|1|on)$/ =~ downcase) != nil
+    end
+
+    def falsey?
+      (/^(false|f|no|n|0|off)$/ =~ downcase) != nil
+    end
+  end
+  
+  class Request
+    alias_method :params_original, :params
+    def params
+      @processed_parameters ||= {}
+    end
+    
+    def param name, type, opts={}
+			_name = name.to_s
+      
+      p = Rack::Parameter.new(
+        :name => _name,
+        :value => params_original[_name] || params[_name],
+        :type => type,
+        :conditions => opts
+      )
+      
+      raise ParameterError, p.error unless p.valid?
+      params[_name] = p.value
+    end
+  end
+  
+  class Parameter
+    attr_reader :error, :value
+    
+    class Rule
+      def initialize message, &block
+        @block = block
+        @message = message
+      end
+      
+      def self.rule message, &block
+        new message, &block
+      end
+
+      def validate param, value
+        return @message.sub("$",param.to_s).sub("#",value.to_s) unless @block.call(param,value)
+      end
+    end
+    
+    def initialize(opts={})
+      opts[:value].inspect
+			_opts = Hash[opts.dup.map { |k,v| [k.to_sym,v] }]
+      _opts.merge! _opts.delete(:conditions)
+			@default = _opts.delete :default
+			@required = _opts.delete :required
+			@transform = _opts.delete :transform
+			@delimiter = _opts.delete(:delimiter) || ","
+			@separator = _opts.delete(:separator) || ":"
+      @name = _opts.delete :name
+      @type = _opts.delete :type
+      @value = _opts.delete(:value) || @default
+      @error = process(_opts) unless default?
+    end
+
+    def valid?
+      @error.nil?
+    end
+    
+		def default?
+			@default == @value && !@value.nil?
+		end
+		
+		def required?
+			@required
+		end
+		
+    def nil?
+      @value.nil?
+    end
+
+    def process opts
+      return "Parameter #{@name} is required." if @value.nil? && required?
+      
+      unless @value.class == @type
+        begin
+          @value = case @type.to_s.downcase.to_sym
+            when :date then Date.parse @value
+            when :time then Time.parse @value
+            when :datetime then DateTime.parse @value
+            when :array then @value.split(@delimiter)
+            when :hash then Hash[@value.split(@delimiter).map { |c| c.split @separator, 2 }]
+            when :boolean then (@value.falsey? ? false : @value.truthy? ? true : raise(StandardError))
+            else method(@type.to_s.to_sym).call @value end
+        rescue StandardError => e
+          return "Parameter `#{@name}` is not a valid #{@type.to_s}."
+        end
+      end
+      
+      validate_error = opts.detect { |k,v| rules[k].validate @value, v }
+      return validate_error unless validate_error.nil?
+      
+      @value = @transform.to_proc.call @value if @transform
+      nil
+    end
+     
+    def rules
+      @rules ||= {}
+      if @rules.empty?
+        @rules[:blank] = Rule.rule("$ cannot be blank.") { |p,v| v == (p.empty? rescue false) }
+        @rules[:greater_than] = Rule.rule("$ can't be less than #.") { |p,v| p > v }
+        @rules[:less_than] = Rule.rule("$ can't be greater than #.") { |p,v| p < v }
+        @rules[:min] = Rule.rule("$ can't be less than #.") { |p,v| p >= v }
+        @rules[:max] = Rule.rule("$ can't be greater than #.") { |p,v| p <= v }
+        @rules[:length] = Rule.rule("$ can't be longer or shorter than #.") { |p,v| p.length == v }
+        @rules[:min_length] = Rule.rule("$ must be longer than #.") { |p,v| p.length >= v }
+        @rules[:max_length] = Rule.rule("$ must be shorter than #.") { |p,v| p.length <= v }
+        @rules[:in] = Rule.rule("$ must be included in #.") { |p,v| v.include? p }
+        @rules[:contains] = Rule.rule("$ must include #") { |p,v| p.include? v }
+        @rules[:regex] = Rule.rule("$ failed validation.") { |p,v| v.match p }
+        @rules[:validator] = Rule.rule("$ failed validation.") { |p,v| v.call p }
+      end
+      @rules
+    end
+  end
+end

data/rack-param.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-param"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Nathaniel Symer"]
+  spec.email         = ["nate@natesymer.com"]
+  spec.summary       = "Sane parameter validation for Rack::Request."
+  spec.description   = spec.summary + " Originally written for use with Sansom."
+  spec.homepage      = "https://github.com/sansomrb/rack-param"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_dependency "rack", "~> 1.0"
+end

data/spec/coercion_spec.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+require_relative "./spec_helper.rb"
+
+describe Rack::Parameter do
+  before :all do
+    @p = {
+      :date => "2014/8/4",
+      :time => "Thu Nov 29 14:33:20 GMT 2001",
+      :array => "asdf,asdf,asdf",
+      :datetime => "2012-02-09 20:05:33",
+      :hash => "key:value,this:that,foo:bar",
+      :true => "true",
+      :t => "t",
+      :yes => "yes",
+      :y => "y",
+      :one => "1",
+      :integer => "42",
+      :float => "420.42",
+      :string => "foo bar baz",
+      :should_fail => "asdfasdf"
+    }
+  end
+  
+  context "when coercing types" do
+    it "parses a Date" do
+      @r.param :date, Date
+
+      expect(@r.params["date"]).to eq(Date.new(2014, 8, 4))
+    end
+    
+    it "parses a Time" do
+      @r.param :time, Time
+
+      expect(@r.params["time"].to_i).to eq(1007044400)
+    end
+    
+    it "parses a DateTime" do
+      @r.param :datetime, DateTime
+      
+      expect(@r.params["datetime"].to_s).to eq("2012-02-09T20:05:33+00:00")
+    end
+    
+    it "parses an Array" do
+      @r.param :array, Array
+      
+      expect(@r.params["array"]).to eq(["asdf", "asdf", "asdf"])
+    end
+    
+    it "parses a Hash" do
+      @r.param :hash, Hash
+      
+      expect(@r.params["hash"]).to eq({"key" => "value", "this" => "that", "foo" => "bar"})
+    end
+    
+    it "coerces a Boolean" do
+      @r.param :true, Boolean
+      @r.param :t, Boolean
+      @r.param :yes, Boolean
+      @r.param :y, Boolean
+      @r.param :one, Boolean
+      
+      expect(@r.params["true"]).to eq(true)
+      expect(@r.params["t"]).to eq(true)
+      expect(@r.params["yes"]).to eq(true)
+      expect(@r.params["y"]).to eq(true)
+      expect(@r.params["one"]).to eq(true)
+    end
+    
+    it "coerces an Integer" do
+      @r.param :integer, Integer
+
+      expect(@r.params["integer"]).to eq(42)
+    end
+    
+    it "coerces a Float" do
+      @r.param :float, Float
+
+      expect(@r.params["float"]).to eq(420.42)
+    end
+    
+    it "\"coerces\" a String" do
+      @r.param :string, String
+      
+      expect(@r.params["string"]).to eq("foo bar baz")
+    end
+    
+    it "errors out on unrecognized types" do
+      expect { @r.param :should_fail, Date }.to raise_error(Rack::ParameterError)
+    end
+  end
+end

data/spec/rules_spec.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+require_relative "./spec_helper.rb"
+
+describe Rack::Parameter do
+  before :all do
+    @p = {
+      :int_three => "3",
+      :int_six => "6",
+      :string => "mary had a little lamb",
+      :callback_url => "http://www.example.com/",
+      :blank => "",
+      :required => "This is very important data",
+      :array => "one,two,three,four"
+    }
+  end
+  
+  context "when given rules" do
+    it "checks a parameter based on :required" do
+      expect { @r.param :not_a_param, String, :required => true }.to raise_error(Rack::ParameterError)
+      expect { @r.param :required, String, :required => true }.to_not raise_error
+    end
+    
+    it "checks a parameter based on :blank" do
+      expect { @r.param :blank, String, :blank => true }.to_not raise_error
+      expect { @r.param :string, String, :blank => false }.to_not raise_error
+    end
+    
+    it "checks a parameter based on :greater_than" do
+      expect { @r.param :int_six, Integer, :greater_than => 5 }.to_not raise_error
+    end
+    
+    it "checks a parameter based on :less_than" do
+      expect { @r.param :int_three, Integer, :less_than => 4 }.to_not raise_error
+    end
+    
+    it "checks a parameter based on :min" do
+      expect { @r.param :int_three, Integer, :min => 3 }.to_not raise_error
+      expect { @r.param :int_three, Integer, :min => 4 }.to raise_error(Rack::ParameterError)
+    end
+    
+    it "checks a parameter based on :max" do
+      expect { @r.param :int_three, Integer, :max => 3 }.to_not raise_error
+      expect { @r.param :int_three, Integer, :max => 2 }.to raise_error(Rack::ParameterError)
+    end
+    
+    it "checks a parameter based on :length" do
+      expect { @r.param :string, String, :length => 22 }.to_not raise_error
+      expect { @r.param :string, String, :length => 10 }.to raise_error(Rack::ParameterError)
+    end
+    
+    it "checks a parameter based on :min_length" do
+      expect { @r.param :string, String, :min_length => 20 }.to_not raise_error
+      expect { @r.param :string, String, :min_length => 30 }.to raise_error(Rack::ParameterError)
+    end
+    
+    it "checks a parameter based on :max_length" do
+      expect { @r.param :string, String, :max_length => 25 }.to_not raise_error
+      expect { @r.param :string, String, :max_length => 20 }.to raise_error(Rack::ParameterError)
+    end
+    
+    it "checks a parameter based on :in" do
+      expect { @r.param :int_three, Integer, :in => [3] }.to_not raise_error
+      expect { @r.param :int_three, Integer, :in => [] }.to raise_error(Rack::ParameterError)
+    end
+    
+    it "checks a parameter based on :contains" do
+      expect { @r.param :array, Array, :contains => "one" }.to_not raise_error
+      expect { @r.param :array, Array, :contains => "three hundred" }.to raise_error(Rack::ParameterError)
+    end
+    
+    it "checks a parameter based on :regex" do
+      expect { @r.param :string, String, :regex => /^mary.+lamb$/ }.to_not raise_error
+      expect { @r.param :string, String, :regex => /^bo.+peep$/ }.to raise_error(Rack::ParameterError)
+    end
+    
+    it "checks a parameter based on :validator" do
+      expect { @r.param :int_three, Integer, :validator => lambda { |p| p < 5 && p > 0 } }.to_not raise_error
+      expect { @r.param :int_three, Integer, :validator => lambda { |p| p < 0 } }.to raise_error(Rack::ParameterError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require "rspec"
+
+module TestHelpers
+  require_relative File.dirname(File.dirname(__FILE__)) + "/lib/rack/param.rb"
+  
+  require "rack"
+  require "cgi"
+  require "stringio"
+  
+  def env params
+    {
+      "CONTENT_TYPE" => "text/plain",
+      "QUERY_STRING" => params.map { |k,v| "#{k.to_s}=#{CGI.escape(v.to_s)}" }.join('&'),
+      "REQUEST_METHOD" => "GET",
+      "REQUEST_PATH" => "/",
+      "REQUEST_URI" => "/",
+      "HTTP_HOST" => "localhost:2000",
+      "SERVER_NAME" => "localhost",
+      "SERVER_PORT" => "2000",
+      "PATH_INFO" => "/",
+      "rack.url_scheme" => "http",
+      "rack.input" => StringIO.new("")
+    }
+  end
+end
+
+RSpec.configure do |c|
+  c.include TestHelpers
+  
+  c.before :each do
+    @p ||= {}
+    @r = Rack::Request.new env(@p.dup)
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rack-param
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathaniel Symer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Sane parameter validation for Rack::Request. Originally written for use
+  with Sansom.
+email:
+- nate@natesymer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/rack/param.rb
+- rack-param.gemspec
+- spec/coercion_spec.rb
+- spec/rules_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sansomrb/rack-param
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Sane parameter validation for Rack::Request.
+test_files:
+- spec/coercion_spec.rb
+- spec/rules_spec.rb
+- spec/spec_helper.rb