input_sanitizer 0.1.9 → 0.4.0

metadata

@@ -1,106 +1,171 @@
 --- !ruby/object:Gem::Specification
 name: input_sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.1.9
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
-- Tomek Paczkowski
-- Tomasz Werbicki
-- Michal Bugno
+- Zendesk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: method_struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 description: Gem to sanitize hash of incoming data
 email:
-- tom@futuresimple.com
-- tomasz@futuresimple.com
-- michal@futuresimple.com
+- opensource@zendesk.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".github/workflows/gempush.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - input_sanitizer.gemspec
 - lib/input_sanitizer.rb
-- lib/input_sanitizer/default_converters.rb
+- lib/input_sanitizer/errors.rb
 - lib/input_sanitizer/extended_converters.rb
+- lib/input_sanitizer/extended_converters/comma_joined_integers_converter.rb
+- lib/input_sanitizer/extended_converters/comma_joined_strings_converter.rb
+- lib/input_sanitizer/extended_converters/positive_integer_converter.rb
+- lib/input_sanitizer/extended_converters/specific_values_converter.rb
 - lib/input_sanitizer/restricted_hash.rb
-- lib/input_sanitizer/sanitizer.rb
+- lib/input_sanitizer/v1.rb
+- lib/input_sanitizer/v1/clean_field.rb
+- lib/input_sanitizer/v1/default_converters.rb
+- lib/input_sanitizer/v1/sanitizer.rb
+- lib/input_sanitizer/v2.rb
+- lib/input_sanitizer/v2/clean_field.rb
+- lib/input_sanitizer/v2/clean_payload_collection_field.rb
+- lib/input_sanitizer/v2/clean_query_collection_field.rb
+- lib/input_sanitizer/v2/error_collection.rb
+- lib/input_sanitizer/v2/nested_sanitizer_factory.rb
+- lib/input_sanitizer/v2/payload_sanitizer.rb
+- lib/input_sanitizer/v2/payload_transform.rb
+- lib/input_sanitizer/v2/query_sanitizer.rb
+- lib/input_sanitizer/v2/types.rb
 - lib/input_sanitizer/version.rb
-- spec/default_converters_spec.rb
-- spec/extended_converters_spec.rb
+- spec/extended_converters/comma_joined_integers_converter_spec.rb
+- spec/extended_converters/comma_joined_strings_converter_spec.rb
+- spec/extended_converters/positive_integer_converter_spec.rb
+- spec/extended_converters/specific_values_converter_spec.rb
 - spec/restricted_hash_spec.rb
 - spec/sanitizer_spec.rb
 - spec/spec_helper.rb
+- spec/v1/default_converters_spec.rb
+- spec/v2/converters_spec.rb
+- spec/v2/payload_sanitizer_spec.rb
+- spec/v2/payload_transform_spec.rb
+- spec/v2/query_sanitizer_spec.rb
+- v2.md
 homepage: ''
-licenses: []
+licenses:
+- Apache-2.0
+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: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gem to sanitize hash of incoming data
 test_files:
-- spec/default_converters_spec.rb
-- spec/extended_converters_spec.rb
+- spec/extended_converters/comma_joined_integers_converter_spec.rb
+- spec/extended_converters/comma_joined_strings_converter_spec.rb
+- spec/extended_converters/positive_integer_converter_spec.rb
+- spec/extended_converters/specific_values_converter_spec.rb
 - spec/restricted_hash_spec.rb
 - spec/sanitizer_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/v1/default_converters_spec.rb
+- spec/v2/converters_spec.rb
+- spec/v2/payload_sanitizer_spec.rb
+- spec/v2/payload_transform_spec.rb
+- spec/v2/query_sanitizer_spec.rb

data/lib/input_sanitizer/sanitizer.rb

@@ -1,152 +0,0 @@
-require 'input_sanitizer/restricted_hash'
-require 'input_sanitizer/default_converters'
-
-class InputSanitizer::Sanitizer
-  def initialize(data)
-    @data = symbolize_keys(data)
-    @performed = false
-    @errors = []
-    @cleaned = InputSanitizer::RestrictedHash.new(self.class.fields.keys)
-  end
-
-  def self.clean(data)
-    new(data).cleaned
-  end
-
-  def [](field)
-    cleaned[field]
-  end
-
-  def cleaned
-    return @cleaned if @performed
-    self.class.fields.each do |field, hash|
-      type = hash[:type]
-      required = hash[:options][:required]
-      clean_field(field, type, required)
-    end
-    @performed = true
-    @cleaned.freeze
-  end
-
-  def valid?
-    cleaned
-    @errors.empty?
-  end
-
-  def errors
-    cleaned
-    @errors
-  end
-
-  def self.converters
-    {
-      :integer => InputSanitizer::IntegerConverter.new,
-      :string => InputSanitizer::StringConverter.new,
-      :date => InputSanitizer::DateConverter.new,
-      :time => InputSanitizer::TimeConverter.new,
-      :boolean => InputSanitizer::BooleanConverter.new,
-      :integer_or_blank => InputSanitizer::IntegerConverter.new.extend(InputSanitizer::AllowNil),
-      :string_or_blank => InputSanitizer::StringConverter.new.extend(InputSanitizer::AllowNil),
-      :date_or_blank => InputSanitizer::DateConverter.new.extend(InputSanitizer::AllowNil),
-      :time_or_blank => InputSanitizer::TimeConverter.new.extend(InputSanitizer::AllowNil),
-      :boolean_or_blank => InputSanitizer::BooleanConverter.new.extend(InputSanitizer::AllowNil),
-    }
-  end
-
-  def self.inherited(subclass)
-    subclass.fields = self.fields.dup
-  end
-
-  def self.string(*keys)
-    set_keys_to_type(keys, :string)
-  end
-
-  def self.integer(*keys)
-    set_keys_to_type(keys, :integer)
-  end
-
-  def self.boolean(*keys)
-    set_keys_to_type(keys, :boolean)
-  end
-
-  def self.date(*keys)
-    set_keys_to_type(keys, :date)
-  end
-
-  def self.time(*keys)
-    set_keys_to_type(keys, :time)
-  end
-
-  def self.custom(*keys)
-    options = keys.pop
-    converter = options.delete(:converter)
-    keys.push(options)
-    raise "You did not define a converter for a custom type" if converter == nil
-    self.set_keys_to_type(keys, converter)
-  end
-
-  protected
-  def self.fields
-    @fields ||= {}
-  end
-
-  def self.fields=(new_fields)
-    @fields = new_fields
-  end
-
-  private
-  def self.extract_options!(array)
-    array.last.is_a?(Hash) ? array.pop : {}
-  end
-
-  def self.extract_options(array)
-    array.last.is_a?(Hash) ? array.last : {}
-  end
-
-  def clean_field(field, type, required)
-    if @data.has_key?(field)
-      begin
-        @cleaned[field] = convert(field, type)
-      rescue InputSanitizer::ConversionError => ex
-        add_error(field, :invalid_value, @data[field], ex.message)
-      end
-    elsif required
-      add_missing(field)
-    end
-  end
-
-  def add_error(field, error_type, value, description = nil)
-    @errors << {
-      :field => field,
-      :type => error_type,
-      :value => value,
-      :description => description
-    }
-  end
-
-  def add_missing(field)
-    add_error(field, :missing, nil, nil)
-  end
-
-  def convert(field, type)
-    converter(type).call(@data[field])
-  end
-
-  def converter(type)
-    type.respond_to?(:call) ? type : self.class.converters[type]
-  end
-
-  def symbolize_keys(data)
-    data.inject({}) do |memo, kv|
-      memo[kv.first.to_sym] = kv.last
-      memo
-    end
-  end
-
-  def self.set_keys_to_type(keys, type)
-    opts = extract_options!(keys)
-    keys.each do |key|
-      fields[key] = { :type => type, :options => opts }
-    end
-  end
-end

data/spec/default_converters_spec.rb

@@ -1,101 +0,0 @@
-require 'spec_helper'
-
-describe InputSanitizer::IntegerConverter do
-  let(:converter) { InputSanitizer::IntegerConverter.new }
-
-  it "casts string to integer" do
-    converter.call("42").should == 42
-  end
-
-  it "casts integer to integer" do
-    converter.call(42).should == 42
-  end
-
-  it "raises error if cannot cast" do
-    lambda { converter.call("f") }.should raise_error(InputSanitizer::ConversionError)
-  end
-end
-
-describe InputSanitizer::DateConverter do
-  let(:converter) { InputSanitizer::DateConverter.new }
-
-  it "casts dates in iso format" do
-    converter.call("2012-05-15").should == Date.new(2012, 5, 15)
-  end
-
-  it "raises error if cannot cast" do
-    lambda { converter.call("2012-02-30") }.should raise_error(InputSanitizer::ConversionError)
-  end
-end
-
-describe InputSanitizer::BooleanConverter do
-  let(:converter) { InputSanitizer::BooleanConverter.new }
-
-  it "casts 'true' to true" do
-    converter.call('true').should be_true
-  end
-
-  it "casts true to true" do
-    converter.call(true).should be_true
-  end
-
-  it "casts '1' to true" do
-    converter.call('1').should be_true
-  end
-
-  it "casts 'yes' to true" do
-    converter.call('yes').should be_true
-  end
-
-  it "casts 'false' to false" do
-    converter.call('false').should be_false
-  end
-
-  it "casts false to false" do
-    converter.call(false).should be_false
-  end
-
-  it "casts '0' to false" do
-    converter.call('0').should be_false
-  end
-
-  it "casts 'no' to false" do
-    converter.call('no').should be_false
-  end
-
-  it "raises error if cannot cast" do
-    lambda { converter.call("notboolean") }.should raise_error(InputSanitizer::ConversionError)
-  end
-end
-
-
-describe InputSanitizer::TimeConverter do
-  let(:converter) { InputSanitizer::TimeConverter.new }
-
-  it "raises if timezone part given" do
-    lambda { converter.call("2012-05-15 13:42:54 +01:00") }.should raise_error(InputSanitizer::ConversionError)
-  end
-
-  it "casts date time in iso format" do
-    t = Time.utc(2012, 5, 15, 13, 42, 54)
-    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 "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
-    lambda { converter.call("2/10/2031 13:44:22") }.should raise_error(InputSanitizer::ConversionError)
-  end
-
-  it "raises error if date is wrong" do
-    lambda { converter.call("2012-02-32") }.should raise_error(InputSanitizer::ConversionError)
-  end
-end