input_sanitizer 0.2.2 → 0.3.33

metadata

@@ -1,64 +1,88 @@
 --- !ruby/object:Gem::Specification
 name: input_sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.33
 platform: ruby
 authors:
-- Tomek Paczkowski
-- Tomasz Werbicki
-- Michal Bugno
+- Zendesk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-31 00:00:00.000000000 Z
+date: 2020-04-24 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'
-  type: :development
+        version: 0.2.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 3.0.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    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: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    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: []
@@ -66,25 +90,51 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG
 - Gemfile
-- Gemfile.lock
 - 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: []
@@ -101,14 +151,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 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
+- 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/Gemfile.lock

@@ -1,44 +0,0 @@
-PATH
-  remote: .
-  specs:
-    input_sanitizer (0.2.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    method_source (0.8.2)
-    multi_json (1.10.1)
-    pry (0.10.0)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.3)
-    simplecov (0.9.0)
-      docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    slop (3.6.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  input_sanitizer!
-  pry
-  rspec
-  simplecov

data/lib/input_sanitizer/sanitizer.rb

@@ -1,179 +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]
-      collection = hash[:options][:collection]
-      namespace = hash[:options][:namespace]
-      default = hash[:options][:default]
-      provide = hash[:options][:provide]
-      clean_field(field, type, required, collection, namespace, default, provide)
-    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
-
-  converters.keys.each do |name|
-    class_eval <<-END
-      def self.#{name}(*keys)
-        set_keys_to_type(keys, :#{name})
-      end
-    END
-  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
-
-  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 ||= {}
-  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, collection, namespace, default, provide)
-    if @data.has_key?(field)
-      begin
-        @cleaned[field] = convert(field, type, collection, namespace, provide)
-      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
-  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, collection, namespace, provide)
-    if collection
-      @data[field].map { |v|
-        convert_single(type, v, namespace, provide)
-      }
-    else
-      convert_single(type, @data[field], namespace, provide)
-    end
-  end
-
-  def convert_single(type, value, namespace, provide)
-    if namespace
-      { namespace => convert_value(converter(type), value[namespace], provide) }
-    else
-      convert_value(converter(type), value, provide)
-    end
-  end
-
-  def convert_value(converter, value, provide)
-    if provide
-      converter.call(value, @data[provide])
-    else
-      converter.call(value)
-    end
-  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/extended_converters_spec.rb

@@ -1,78 +0,0 @@
-require 'spec_helper'
-require 'input_sanitizer/extended_converters'
-
-describe InputSanitizer::AllowNil do
-  it "passes blanks" do
-    lambda { |_| 1 }.extend(InputSanitizer::AllowNil).call("").should be_nil
-  end
-
-  it "passes things the extended sanitizer passes" do
-    lambda { |_| :something }.extend(InputSanitizer::AllowNil).call(:stuff).
-      should eq(:something)
-  end
-
-  it "raises error if the extended sanitizer raises error" do
-    action = lambda do
-      lambda { |_| raise "Some error" }.extend(InputSanitizer::AllowNil).call(:stuff)
-    end
-
-    action.should raise_error
-  end
-end
-
-describe InputSanitizer::PositiveIntegerConverter do
-  let(:converter) { InputSanitizer::PositiveIntegerConverter.new }
-
-  it "casts string to integer" do
-    converter.call("3").should == 3
-  end
-
-  it "raises error if integer less than zero" do
-    lambda { converter.call("-3") }.should raise_error(InputSanitizer::ConversionError)
-  end
-
-  it "raises error if integer equals zero" do
-    lambda { converter.call("0") }.should raise_error(InputSanitizer::ConversionError)
-  end
-end
-
-describe InputSanitizer::CommaJoinedIntegersConverter do
-  let(:converter) { InputSanitizer::CommaJoinedIntegersConverter.new }
-
-  it "parses to array of ids" do
-    converter.call("1,2,3,5").should == [1, 2, 3, 5]
-  end
-
-  it "raises on invalid character" do
-    lambda { converter.call(":") }.should raise_error(InputSanitizer::ConversionError)
-  end
-end
-
-describe InputSanitizer::CommaJoinedStringsConverter do
-  let(:converter) { described_class.new }
-
-  it "parses to array of ids" do
-    converter.call("input,Sanitizer,ROCKS").should == ["input", "Sanitizer", "ROCKS"]
-  end
-
-  it "raises on invalid character" do
-    lambda { converter.call(":") }.should raise_error(InputSanitizer::ConversionError)
-  end
-end
-
-describe InputSanitizer::SpecificValuesConverter do
-  let(:converter) { InputSanitizer::SpecificValuesConverter.new([:a, :b]) }
-
-  it "converts valid value to symbol" do
-    converter.call("b").should == :b
-  end
-
-  it "raises on invalid value" do
-    lambda { converter.call("c") }.should raise_error(InputSanitizer::ConversionError)
-  end
-
-  it "converts valid value to string" do
-    converter = InputSanitizer::SpecificValuesConverter.new(["a", "b"])
-    converter.call("a").should == "a"
-  end
-end