input_sanitizer 0.1.10 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80975685ea36b822133f114e4f25a86795ab1a84
+  data.tar.gz: fe52c7a9f8039a61e247cc7634a93d176de4ed32
+SHA512:
+  metadata.gz: 3fd6f2abb6f51ddfc1e161568515dcb40800f3eb7c7a28962253040d1aa37052de7b3e15f1f6b0b5b739a54276b1d76b7f66f98289ad4052afb2fd84b264ddbb
+  data.tar.gz: cfc6ea3add9b7a3d9089e30830e53e1ffa00ec12daacb0d0ced5c6c8eedc05d22d112a2c29c3617c886ee57dd5559bea455901384b18ad78f7d437c681f9d38d

data/.travis.yml

@@ -6,7 +6,7 @@ rvm:
   - 1.9.3
   - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
   
   # keeps failing
+  #- rbx-18mode
   #- rbx-19mode

data/lib/input_sanitizer/default_converters.rb

@@ -1,4 +1,5 @@
 require 'time'
+require 'date'
 
 module InputSanitizer
   class ConversionError < Exception
@@ -32,11 +33,18 @@ module InputSanitizer
   end
 
   class TimeConverter
-    ISO_RE = /\A\d{4}-?\d{2}-?\d{2}([T ]?\d{2}(:?\d{2}(:?\d{2})?)?)?\Z/
+    ISO_RE = /\A\d{4}-?\d{2}-?\d{2}([T ]?\d{2}(:?\d{2}(:?\d{2}((\.)?\d{0,3}(Z)?)?)?)?)?\Z/
 
     def call(value)
-      if value =~ ISO_RE
-        strip_timezone(Time.parse(value))
+      case value
+      when Time
+        value.getutc
+      when String
+        if value =~ ISO_RE
+          strip_timezone(Time.parse(value))
+        else
+          raise ConversionError.new("invalid time")
+        end
       else
         raise ConversionError.new("invalid time")
       end
@@ -59,6 +67,8 @@ module InputSanitizer
       '0' => false,
       'yes' => true,
       'no' => false,
+      1 => true,
+      0 => false,
     }
 
     def call(value)

data/lib/input_sanitizer/sanitizer.rb

@@ -22,7 +22,10 @@ class InputSanitizer::Sanitizer
     self.class.fields.each do |field, hash|
       type = hash[:type]
       required = hash[:options][:required]
-      clean_field(field, type, required)
+      collection = hash[:options][:collection]
+      namespace = hash[:options][:namespace]
+      default = hash[:options][:default]
+      clean_field(field, type, required, collection, namespace, default)
     end
     @performed = true
     @cleaned.freeze
@@ -73,6 +76,17 @@ class InputSanitizer::Sanitizer
     self.set_keys_to_type(keys, converter)
   end
 
+  def self.nested(*keys)
+    options = keys.pop
+    sanitizer = options.delete(:sanitizer)
+    keys.push(options)
+    raise "You did not define a sanitizer for nested value" if sanitizer == nil
+    converter = lambda { |value|
+      sanitizer.clean(value)
+    }
+    self.set_keys_to_type(keys, converter)
+  end
+
   protected
   def self.fields
     @fields ||= {}
@@ -91,13 +105,15 @@ class InputSanitizer::Sanitizer
     array.last.is_a?(Hash) ? array.last : {}
   end
 
-  def clean_field(field, type, required)
+  def clean_field(field, type, required, collection, namespace, default)
     if @data.has_key?(field)
       begin
-        @cleaned[field] = convert(field, type)
+        @cleaned[field] = convert(field, type, collection, namespace)
       rescue InputSanitizer::ConversionError => ex
         add_error(field, :invalid_value, @data[field], ex.message)
       end
+    elsif default
+      @cleaned[field] = converter(type).call(default)
     elsif required
       add_missing(field)
     end
@@ -116,8 +132,22 @@ class InputSanitizer::Sanitizer
     add_error(field, :missing, nil, nil)
   end
 
-  def convert(field, type)
-    converter(type).call(@data[field])
+  def convert(field, type, collection, namespace)
+    if collection
+      @data[field].map { |v|
+        convert_single(type, v, namespace)
+      }
+    else
+      convert_single(type, @data[field], namespace)
+    end
+  end
+
+  def convert_single(type, value, namespace)
+    if namespace
+      { namespace => converter(type).call(value[namespace]) }
+    else
+      converter(type).call(value)
+    end
   end
 
   def converter(type)

data/lib/input_sanitizer/version.rb

@@ -1,3 +1,3 @@
 module InputSanitizer
-  VERSION = "0.1.10"
+  VERSION = "0.2.0"
 end

data/spec/default_converters_spec.rb

@@ -81,14 +81,27 @@ describe InputSanitizer::TimeConverter do
     converter.call("2012-05-15 13:42:54").should == t
     converter.call("2012-05-15T13:42:54").should == t
     converter.call("20120515134254").should == t
+  end
+
+  it "works with miliseconds" do
+    t = Time.utc(2012, 5, 15, 13, 42, 54)
+    converter.call("2012-05-15 13:42:54.000").should == t
+    converter.call("2012-05-15T13:42:54.000").should == t
+    converter.call("20120515134254000").should == t
+  end
 
+  it "works with Z at the end" do
+    t = Time.utc(2012, 5, 15, 13, 42, 54)
+    converter.call("2012-05-15 13:42:54.000Z").should == t
+    converter.call("2012-05-15T13:42:54.000Z").should == t
+   converter.call("2012-05-15T13:42:54Z").should == t
+    converter.call("20120515134254000Z").should == t
   end
 
   it "does not require time part" do
     converter.call("2012-05-15 13:42").should == Time.utc(2012, 5, 15, 13, 42)
     converter.call("2012-05-15 13").should == Time.utc(2012, 5, 15, 13)
     converter.call("2012-05-15").should == Time.utc(2012, 5, 15)
-
   end
 
   it "raises error if can format is wrong" do
@@ -98,4 +111,9 @@ describe InputSanitizer::TimeConverter do
   it "raises error if date is wrong" do
     lambda { converter.call("2012-02-32") }.should raise_error(InputSanitizer::ConversionError)
   end
+
+  it "allows the instance of Time" do
+    t = Time.now
+    converter.call(t).should == t.utc
+  end
 end

data/spec/sanitizer_spec.rb

@@ -1,11 +1,19 @@
 require 'spec_helper'
 
+class NestedSanitizer < InputSanitizer::Sanitizer
+  integer :foo
+end
+
 class BasicSanitizer < InputSanitizer::Sanitizer
   string :x, :y, :z
+  integer :namespaced, :namespace => :value
+  integer :array, :collection => true
+  integer :namespaced_array, :collection => true, :namespace => :value
   integer :num
   date :birthday
   time :updated_at
   custom :cust1, :cust2, :converter => lambda { |v| v.reverse }
+  nested :stuff, :sanitizer => NestedSanitizer, :collection => true, :namespace => :nested
 end
 
 class BrokenCustomSanitizer < InputSanitizer::Sanitizer
@@ -28,12 +36,17 @@ class RequiredCustom < BasicSanitizer
   custom :c1, :required => true, :converter => lambda { |v| v }
 end
 
+class DefaultParameters < BasicSanitizer
+  integer :funky_number, :default => 5
+  custom :fixed_stuff, :converter => lambda {|v| v }, :default => "default string"
+end
+
 describe InputSanitizer::Sanitizer do
   let(:sanitizer) { BasicSanitizer.new(@params) }
 
   describe ".clean" do
     it "returns cleaned data" do
-      clean_data = mock()
+      clean_data = double
       BasicSanitizer.any_instance.should_receive(:cleaned).and_return(clean_data)
       BasicSanitizer.clean({}).should be(clean_data)
     end
@@ -83,6 +96,30 @@ describe InputSanitizer::Sanitizer do
       cleaned.should_not have_key(:d)
     end
 
+    it "preserves namespace" do
+      value = { :value => 5 }
+      @params = { :namespaced => value }
+
+      cleaned[:namespaced].should eq(value)
+    end
+
+    it "maps values for collection fields" do
+      numbers = [3, 5, 6]
+      @params = { :array => numbers }
+
+      cleaned[:array].should eq(numbers)
+    end
+
+    it "maps values for collection fields with namespace" do
+      numbers = [
+        { :value => 2 },
+        { :value => 5 }
+      ]
+      @params = { :namespaced_array => numbers }
+
+      cleaned[:namespaced_array].should eq(numbers)
+    end
+
     it "silently discards cast errors" do
       @params = {:num => "f"}
 
@@ -106,6 +143,32 @@ describe InputSanitizer::Sanitizer do
       cleaned[:is_nice].should == 42
     end
 
+    context "when sanitizer is initialized with default values" do
+      context "when paremeters are not overwriten" do
+        let(:sanitizer) { DefaultParameters.new({}) }
+
+        it "returns default value for non custom key" do
+          sanitizer.cleaned[:funky_number].should == 5
+        end
+
+        it "returns default value for custom key" do
+          sanitizer.cleaned[:fixed_stuff].should == "default string"
+        end
+      end
+
+      context "when parameters are overwriten" do
+        let(:sanitizer) { DefaultParameters.new({ :funky_number => 2, :fixed_stuff => "fixed" }) }
+
+        it "returns default value for non custom key" do
+          sanitizer.cleaned[:funky_number].should == 2
+        end
+
+        it "returns default value for custom key" do
+          sanitizer.cleaned[:fixed_stuff].should == "fixed"
+        end
+      end
+    end
+
   end
 
   describe ".custom" do
@@ -126,6 +189,25 @@ describe InputSanitizer::Sanitizer do
     end
   end
 
+  describe ".nested" do
+    let(:sanitizer) { BasicSanitizer.new(@params) }
+    let(:cleaned) { sanitizer.cleaned }
+
+    it "sanitizes nested values" do
+      nested = [
+        { :nested => { :foo => "5" } },
+        { :nested => { :foo => 8 } },
+      ]
+      @params = { :stuff => nested }
+
+      expected = [
+        { :nested => { :foo => 5 } },
+        { :nested => { :foo => 8 } },
+      ]
+      cleaned[:stuff].should eq(expected)
+    end
+  end
+
   describe ".converters" do
     let(:sanitizer) { InputSanitizer::Sanitizer }
 

data/spec/spec_helper.rb

@@ -1,7 +1,9 @@
 require 'bundler'
 Bundler.setup(:test)
 
-require 'simplecov'
-SimpleCov.start unless ENV['CI'] == 'true'
+unless ENV['CI']
+  require 'simplecov'
+  SimpleCov.start
+end
 
 require 'input_sanitizer'

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: input_sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.1.10
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomek Paczkowski
@@ -11,38 +10,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Gem to sanitize hash of incoming data
@@ -75,27 +70,26 @@ files:
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gem to sanitize hash of incoming data
 test_files:
 - spec/default_converters_spec.rb