input_sanitizer 0.2.2 → 0.3.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 22a6e4537da366c88f1578e47d886e94319e9104
-  data.tar.gz: d039d03743961d3712a8e651f83af62087837231
+SHA256:
+  metadata.gz: f59d8ae098bd3a822f1a4377412421f3860a55bbc8b0e3cfe078800b11a6fb46
+  data.tar.gz: 89613d28b02091c0386f809001a1bdbfeaaa668b2e0c2be6a211b01843476433
 SHA512:
-  metadata.gz: 5696a63090cd6e7428669dae8f0536c9ef6d04cf2d0fe040c1f36319172be9d11e7b6e385d57dad12efb1357e1c4992e81d2a27f39bd84fd646ea25265589518
-  data.tar.gz: c9a42b2d1ad1b9702d59305a8df143f2a4c3054a6999d24a89c00471b29685cc5cc86d4195c16dd2cb8fa7f54224b6b3c2d5e202ae0d5b1d0e2ed94bd7dea445
+  metadata.gz: d241f06a15d1c85c527ec6fe7098eab724c1346495f29a1b2d1af78963c6f9bb1867a11f956f780d090c9094a73641352b66b0676b4c32cfa1ddfc507da924f0
+  data.tar.gz: '0843a109ee082218066e3d90bfc6c9e9bb8c21a50fdb6ea7cfc12ddd5b073a3b463ed638199dfa7faab237b0128bb2b6a23aeeee172e3ef1cdd2a238ce8d0d1b'

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.idea
 InstalledFiles
 _yardoc
 coverage
@@ -15,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 /bin
+Gemfile.lock

data/.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
 script: bundle exec rspec spec
 rvm:
+  - 1.8.7
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.0
   - jruby-19mode

data/CHANGELOG

@@ -0,0 +1,92 @@
+0.3.33
+  * Updated license to Apache License 2.0
+
+0.3.31
+  * Redesign RestrictedHash not to use default_proc
+
+0.3.30
+ * Introduce provided values
+
+0.3.29
+ * Support for `float` type in sanitizer
+
+0.3.28
+ * Introduced `regexp` option in String sanitizer
+
+0.3.27
+ * Accept `allow_nil` option in nested sanitizer
+
+0.3.26
+ * PayloadTransform will always return HashWithIndifferentAccess (even if given RestrictedHash)
+
+0.3.25
+ * Fix backward compatibility
+
+0.3.24
+ * Loosen activesupport version requirements on ruby 1.8
+
+0.3.23
+ * Accept allow_nil option for collection in payload sanitizers
+
+0.3.22
+ * Fix errors for Rails 4.2
+ 	 It was impossible to call stringify_keys on RestrictedHash which Rails
+	 relies on.
+
+0.3.21
+ * Added Date converter
+ * Support for validation context
+ * Fallback option support for SortByCheck
+
+0.3.20
+ * Fixed returned format in errors responses in DatetimeCheck
+
+0.3.19
+ * Support for checking dates - new `:date` dsl keyword
+ * Fixed handling TypeErrors in DatetimeCheck
+
+0.3.18
+ * Fix nil-value-error in SpecificValuesConverter
+
+0.3.17
+ * Added a minimum and maximum string length checks
+
+0.3.16
+ * Support "null" in CoercingIntegerCheck
+
+0.3.15
+ * Added handling of the case when invalid value type is passed to a nested sanitizer
+ * Tweaked error messages to unify their form
+
+0.3.14
+ * Separated :missing and :blank errors
+
+0.3.13
+ * Fixed handling frozen input in PayloadTransform
+
+0.3.12
+ * PayloadTransform fixes (nested transforms, renaming nil values)
+
+0.3.11
+ * Fixed a bug in PayloadTransform
+
+0.3.10
+ * Added PayloadTransform class
+
+0.3.9
+ * Added sort_by helper to QuerySanitizer
+
+0.3.8
+ * Added support for comma separated values in QuerySanitizer
+
+0.3.7
+ * Added allow_nil/allow_blank options for PayloadSanitizer
+
+0.3.6
+ * Fixed value of sanitized URLs
+
+0.3.5
+ * Sending nil to integer type field no longer crashes with TypeError
+
+0.3.4
+ * Field names in QuerySanitizer errors no longer have a leading '/'

data/LICENSE

@@ -1,22 +1,201 @@
-Copyright (c) 2012 Tomek Paczkowski, Tomasz Werbicki, Michal Bugno
-
-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.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Zendesk
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -23,6 +23,7 @@ class PersonSanitizer < InputSanitizer::Sanitizer
   string :name
   string :address
   integer :height
+  float :ratio
   date :birthday
 end
 
@@ -74,3 +75,9 @@ end
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Copyright and license
+
+Copyright 2020 Zendesk
+
+Licensed under the [Apache License, Version 2.0](LICENSE)

data/input_sanitizer.gemspec

@@ -3,11 +3,12 @@ $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'input_sanitizer/version'
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Tomek Paczkowski", "Tomasz Werbicki", "Michal Bugno"]
-  gem.email         = ["tom@futuresimple.com", "tomasz@futuresimple.com", "michal@futuresimple.com"]
+  gem.authors       = ["Zendesk"]
+  gem.email         = ["opensource@zendesk.com"]
   gem.description   = %q{Gem to sanitize hash of incoming data}
   gem.summary       = %q{Gem to sanitize hash of incoming data}
   gem.homepage      = ""
+  gem.license       = "Apache-2.0"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -16,7 +17,16 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = InputSanitizer::VERSION
 
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "simplecov"
-  gem.add_development_dependency "pry"
+  gem.add_runtime_dependency "method_struct", ">= 0.2.2"
+
+  if RUBY_VERSION =~ /^1\.8/
+    gem.add_runtime_dependency "activesupport", ">= 3.0.0", "< 3.2.0"
+    gem.add_development_dependency "pry", "~> 0.9.0"
+  else
+    gem.add_runtime_dependency "activesupport", ">= 3.0.0"
+    gem.add_development_dependency "pry", "~> 0.10.1"
+    gem.add_development_dependency "simplecov", "~> 0.9.2"
+  end
+
+  gem.add_development_dependency "rspec", "~> 3.2.0"
 end

data/lib/input_sanitizer/errors.rb

@@ -0,0 +1,142 @@
+module InputSanitizer
+  class OptionalValueOmitted < StandardError; end
+
+  class KeyNotAllowedError < ArgumentError; end
+
+  class ValidationError < StandardError
+    attr_accessor :field
+    attr_reader :value
+  end
+
+  class ConversionError < ValidationError; end
+
+  class ValueMissingError < ValidationError
+    def code
+      :missing
+    end
+
+    def initialize
+      super("is missing")
+    end
+  end
+
+  class BlankValueError < ValidationError
+    def code
+      :blank
+    end
+
+    def initialize
+      super("can't be blank")
+    end
+  end
+
+  class RegexpMismatchError < ValidationError
+    def code
+      :regexp
+    end
+
+    def initialize
+      super("does not match regular expression")
+    end
+  end
+
+  class ValueNotAllowedError < ValidationError
+    def code
+      :inclusion
+    end
+
+    def initialize(value)
+      @value = value
+      super("is not included in the list")
+    end
+  end
+
+  class TypeMismatchError < ValidationError
+    def code
+      case @type
+      when :integer
+        :not_an_integer
+      when :url
+        :invalid_uri
+      else
+        :invalid_type
+      end
+    end
+
+    def initialize(value, type)
+      @value = value
+      @type = type
+
+      message = case @type
+      when :integer
+        "must be an integer"
+      when :url
+        'must be a valid URI (include the scheme name part, both http and https are accepted, '\
+        'and the hierarchical part)'
+      else
+        "must be a value of type '#{type}'"
+      end
+
+      super(message)
+    end
+  end
+
+  class ExtraneousParamError < ValidationError
+    def code
+      :unknown_param
+    end
+
+    def initialize(name)
+      @field = name
+      super("is an unexpected parameter")
+    end
+  end
+
+  class CollectionLengthError < ValidationError
+    def code
+      :invalid_length
+    end
+
+    def initialize(value, min, max)
+      if min && max
+        super("must be of length between #{min} and #{max}, given: #{value}")
+      elsif min
+        super("must be of length greater than or equal to #{min}, given: #{value}")
+      else
+        super("must be of length less than or equal to #{max}, given: #{value}")
+      end
+    end
+  end
+
+  class ValueError < ValidationError
+    def code
+      :invalid_value
+    end
+
+    def initialize(value, min, max)
+      if min && max
+        super("must be between #{min} and #{max}, given: #{value}")
+      elsif min
+        super("must be higher than or equal to #{min}, given: #{value}")
+      else
+        super("must be lower than or equal to #{max}, given: #{value}")
+      end
+    end
+  end
+
+  class NestedError < ValidationError
+    attr_reader :nested_errors
+
+    def initialize(nested_errors)
+      @nested_errors = nested_errors
+    end
+  end
+
+  class CollectionError < ValidationError
+    attr_reader :collection_errors
+
+    def initialize(collection_errors)
+      @collection_errors = collection_errors
+    end
+  end
+end