clean_room 0.1.3 → 0.2.0

data/lib/clean_room.rb

@@ -1,4 +1,5 @@
 require "clean_room/air_lock"
 require "clean_room/dsl"
 require "clean_room/exceptions"
+require "clean_room/filter"
 require "clean_room/version"

data/lib/clean_room/air_lock.rb

@@ -1,55 +1,30 @@
-require 'sanitize'
-require 'sanitize-url'
-
 module CleanRoom
-  class AirLock
-    include SanitizeUrl
-
-    def shower(dirty_value, options = {})
-      determine_and_clean(dirty_value, options)
+  module AirLock
+    class Parameters
+      class << self
+        def activate
+          ActionController::Base.send :include, CleanParameters
+        end
+      end
     end
 
-    def determine_and_clean(dirty_value, options)
-
-      case dirty_value
-      when Array
-        dirty_value.map{ |dv| determine_and_clean(dv, options) }
-      when Hash
-        Hash[dirty_value.map {|k,dv| [determine_and_clean(k, allow: (k.is_a?(Symbol) ? :symbol : :string)),determine_and_clean(dv, options)]}]
-      when Fixnum
-        dirty_value
-      when Symbol
-        clean(dirty_value, options).to_sym
-      when FalseClass
-        false
-      when NilClass
-        nil
-      else
-        clean(dirty_value, options)
+    class ModelBasedFilter
+      class << self
+        def filter(parameters)
+          # TODO: check the parameter names against the model sanitization rules, when no rules found do a 'normal' sanitization
+          HashWithIndifferentAccess.new(CleanRoom::Filter.clean(parameters))
+        end
       end
     end
 
-    def clean(dirty_value, options)
-      dirty_value = dirty_value.to_s
-      case (options[:allow] || :plain_text)
-      when :html
-        Sanitize.clean(dirty_value, Sanitize::Config::RELAXED)
-      when :simple_html
-        Sanitize.clean(dirty_value, Sanitize::Config::BASIC)
-      when :strict
-        regex =  /[^#{options[:character_class] || "a-zA-Z0-9 "}]/
-        Sanitize.clean(dirty_value).gsub(regex, "")
-      when :url
-        sanitize_url(dirty_value)
-      when :symbol
-        Sanitize.clean(dirty_value).gsub(/[^a-zA-Z0-9]/, "").to_sym
-      when :fixnum
-        Sanitize.clean(dirty_value).gsub(/[^0-9]\.\,/, "").gsub(",",".").to_i
-      when :float
-        Sanitize.clean(dirty_value).gsub(/[^0-9\.\,]/, "").gsub(",",".").to_f
-      else
-        Sanitize.clean(dirty_value)
+    module CleanParameters
+      def params
+        @_params ||= ModelBasedFilter.filter(request.parameters)
+      end
+
+      def params=(val)
+        @_params = val.is_a?(Hash) ? ModelBasedFilter.filter(val) : val
       end
     end
   end
-end
+end 

data/lib/clean_room/dsl.rb

@@ -5,8 +5,8 @@ module CleanRoom
       base.extend ClassMethods
       base.sanitizable_attributes = {}
 
-      if base.respond_to? :before_save
-        base.before_save :sanitize_attributes
+      if base.respond_to? :before_validate
+        base.before_validate :sanitize_attributes
       end
     end
 
@@ -18,16 +18,12 @@ module CleanRoom
 
     def sanitize_attribute(name, options = {})
       current_value = self.send(name)
-      cleaned_value = air_lock.shower(current_value, options)
+      cleaned_value = Filter.clean(current_value, options)
 
       raise Exceptions::Contaminated.new("#{name} contained unacceptable data") if options[:raise] && (current_value != cleaned_value)
       self.send("#{name}=".to_sym, cleaned_value)
     end
 
-    def air_lock
-      @air_lock ||= AirLock.new
-    end
-
     module ClassMethods
       attr_accessor :sanitizable_attributes
 

data/lib/clean_room/filter.rb

@@ -0,0 +1,60 @@
+require 'sanitize'
+require 'sanitize-url'
+
+module CleanRoom
+  class Filter
+
+    class << self
+      include SanitizeUrl
+
+      def clean(dirty_value, options = {})
+        determine_and_filter(dirty_value, options)
+      end
+
+      private
+
+      def determine_and_filter(dirty_value, options)
+
+        case dirty_value
+        when Array
+          dirty_value.map{ |dv| determine_and_filter(dv, options) }
+        when Hash
+          Hash[dirty_value.map {|k,dv| [determine_and_filter(k, allow: (k.is_a?(Symbol) ? :symbol : :string)),determine_and_filter(dv, options)]}]
+        when Fixnum
+          dirty_value
+        when Symbol
+          filter(dirty_value, options).to_sym
+        when FalseClass
+          false
+        when NilClass
+          nil
+        else
+          filter(dirty_value, options)
+        end
+      end
+
+      def filter(dirty_value, options)
+        dirty_value = dirty_value.to_s
+        case (options[:allow] || :plain_text)
+        when :html
+          Sanitize.clean(dirty_value, Sanitize::Config::RELAXED)
+        when :simple_html
+          Sanitize.clean(dirty_value, Sanitize::Config::BASIC)
+        when :strict
+          regex =  /[^#{options[:character_class] || "a-zA-Z0-9 "}]/
+          Sanitize.clean(dirty_value).gsub(regex, "")
+        when :url
+          sanitize_url(dirty_value)
+        when :symbol
+          Sanitize.clean(dirty_value).gsub(/[^a-zA-Z0-9]/, "").to_sym
+        when :fixnum
+          Sanitize.clean(dirty_value).gsub(/[^0-9]\.\,/, "").gsub(",",".").to_i
+        when :float
+          Sanitize.clean(dirty_value).gsub(/[^0-9\.\,]/, "").gsub(",",".").to_f
+        else
+          Sanitize.clean(dirty_value)
+        end
+      end
+    end
+  end
+end

data/lib/clean_room/version.rb

@@ -1,3 +1,3 @@
 module CleanRoom
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/test/clean_room_test.rb

@@ -33,13 +33,13 @@ class CleanRoomTest < MiniTest::Unit::TestCase
     attribute_test(:url, "www.google.com/?q=<script>test</script>", "http://www.google.com/?q=%3Cscript%3Etest%3C/script%3E")
   end
 
-  def test_air_lock
-    assert_equal ["test1","test2"], CleanRoom::AirLock.new.shower(["<b>test1</b>","<b>test2</b>"])
-    assert_equal [{"test1" => "test3"},"test2"], CleanRoom::AirLock.new.shower([{"<b>test1</b>" => "<b>test3</b>"},"<b>test2</b>"])
-    assert_equal [{test1: "test3"},"test2"], CleanRoom::AirLock.new.shower([{:"<b>te * st1</b>" => "<b>test3</b>"},"<b>test2</b>"])
-    assert_equal ["123.", "456.3", "789.8"], CleanRoom::AirLock.new.shower(["<b>123.</b>","456.3", 789.8])
-    assert_equal [123, 456, 789], CleanRoom::AirLock.new.shower(["<b>123.</b>","456.3", 789.8], allow: :fixnum)
-    assert_equal [123.0, 456.3, 789.8], CleanRoom::AirLock.new.shower(["<b>123.</b>","456.3", 789.8], allow: :float)
+  def test_filter
+    assert_equal ["test1","test2"], CleanRoom::Filter.clean(["<b>test1</b>","<b>test2</b>"])
+    assert_equal [{"test1" => "test3"},"test2"], CleanRoom::Filter.clean([{"<b>test1</b>" => "<b>test3</b>"},"<b>test2</b>"])
+    assert_equal [{test1: "test3"},"test2"], CleanRoom::Filter.clean([{:"<b>te * st1</b>" => "<b>test3</b>"},"<b>test2</b>"])
+    assert_equal ["123.", "456.3", "789.8"], CleanRoom::Filter.clean(["<b>123.</b>","456.3", 789.8])
+    assert_equal [123, 456, 789], CleanRoom::Filter.clean(["<b>123.</b>","456.3", 789.8], allow: :fixnum)
+    assert_equal [123.0, 456.3, 789.8], CleanRoom::Filter.clean(["<b>123.</b>","456.3", 789.8], allow: :float)
   end
 
   def attribute_test(field, value_in, value_out)
@@ -69,7 +69,7 @@ class CleanRoomTest < MiniTest::Unit::TestCase
   def test_with_before_save
     assert_output("sanitize_attributes\n") do
       test_class = Class.new do
-        def self.before_save(method_name)
+        def self.before_validate(method_name)
           puts method_name
         end
         include CleanRoom::DSL

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clean_room
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sanitize
-  requirement: &70175557841960 !ruby/object:Gem::Requirement
+  requirement: &70156494356660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70175557841960
+  version_requirements: *70156494356660
 - !ruby/object:Gem::Dependency
   name: sanitize-url
-  requirement: &70175557841420 !ruby/object:Gem::Requirement
+  requirement: &70156494356120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *70175557841420
+  version_requirements: *70156494356120
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70175557841000 !ruby/object:Gem::Requirement
+  requirement: &70156494355660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70175557841000
+  version_requirements: *70156494355660
 description: Work in progress, this will be a generic attribute sanitizer which can
   be used for sanitizing models and other objects holding data
 email:
@@ -62,6 +62,7 @@ files:
 - lib/clean_room/air_lock.rb
 - lib/clean_room/dsl.rb
 - lib/clean_room/exceptions.rb
+- lib/clean_room/filter.rb
 - lib/clean_room/version.rb
 - test/clean_room_test.rb
 - test/test_helper.rb