hash_keys_sanitizer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3c5bce97d346dbbbcca89d585915eb11719b3bb
+  data.tar.gz: 51a9fecfcd71bee9dd82a40a7bc725d394a688d9
+SHA512:
+  metadata.gz: 7b2757714a924666984281e8fe6807a9775e7683d81c8ce20667b4ed3fb5d46029329cffae05fe9f684cbaf94cd9ccc293eb4efd0d405263c33f66f1ae320ecb
+  data.tar.gz: ff18bc1acd6fa71d1b310092d8f6b874b26a8f039d8d2801eefb2016ac959527b551b1b7a0226e709373bdaacfd6e64345bf39102516b230c3b261581117fcad

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea
+/coverage*
+Gemfile.lock
+/.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.5

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9"
+  - "2.1"
+  - "2.2"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hash_keys_sanitizer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Thomas Baustert
+
+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.

data/README.md

@@ -0,0 +1,40 @@
+[![Build Status](https://travis-ci.org/thomasbaustert/hash_keys_sanitizer.svg?branch=master)](https://travis-ci.org/thomasbaustert/hash_keys_sanitizer)
+
+# hash_keys_sanitizer
+
+Sanitizes a hash keys according to a whitelist.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hash_keys_sanitizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash_keys_sanitizer
+
+## Usage
+
+The sanitizer is initialized with the whitelist, for example: 
+
+    HashKeysSanitizer.new(whitelist: [:name, address: [:street, :city, email: [:type]]])
+
+The whitelist contains the permitted (nested keys). In the example above the top level keys `name` 
+and `address` are permitted. For the key `address` the nested keys `street`, `city` and `email` are
+permitted. And for `email` the nested key `type` is permitted.
+
+To sanitizes the hash call `sanitize` and pass the hash:
+
+    sanitized_params = sanitizer.sanitize(name: 'John', unknown: 'dummy', 
+                                          address: { street: "John Street", unknown: "BANG",
+                                                     email: { type: 'job', unknown: 'BANG' } })
+    p sanitized_params 
+    {:name=>"John", :address=>{:street=>"John Street", :email=>{:type=>"job"}}}
+    
+The whitelist and hash can have stringified or symbolized keys. All combinations are supported.
+     

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# running spec as rake default tasks
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+Bundler::GemHelper.install_tasks

data/hash_keys_sanitizer.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hash_keys_sanitizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_keys_sanitizer"
+  spec.version       = HashKeysSanitizer::VERSION
+  spec.authors       = ["Thomas Baustert"]
+  spec.email         = ["business@thomasbaustert.de"]
+  spec.summary       = %q{Hash keys sanitizer}
+  spec.description   = %q{Sanitizes hash keys according to a whitelist}
+  spec.homepage      = "https://github.com/thomasbuatsert/hash_keys_sanitizer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/hash_keys_sanitizer/hash_keys_sanitizer.rb

@@ -0,0 +1,55 @@
+class HashKeysSanitizer
+
+  class HashKeysSanitizerError < StandardError
+  end
+
+  def initialize(options = {})
+    @whitelist = options[:whitelist] || {}
+  end
+
+  ##
+  # Sanitizes given hash and returns new hash.
+  #
+  def sanitize(raw_parameters = {})
+    kept_params = {}
+    sanitize_nesting(kept_params, @whitelist, symbolize_recursive(raw_parameters))
+    kept_params
+  end
+
+  private
+
+    def sanitize_nesting(kept_params, whitelist, raw_parameters)
+      # example whitelist: [:name, address: [:street, :city, email: [:type]]]
+      whitelist.each do |entry|
+        # :name
+        if entry.is_a?(Symbol) || entry.is_a?(String)
+          key = entry.to_sym
+          kept_params[key] = raw_parameters[key] if raw_parameters.has_key?(key)
+        # { address: [:street, :city, ...] }
+        elsif entry.is_a?(Hash)
+          key = entry.keys.first.to_sym
+          kept_params[key] ||= {}
+          sanitize_nesting(kept_params[key], entry.values.first, raw_parameters[key])
+        else
+          raise HashKeysSanitizerError, "Unsupported whitelist entry type #{entry.class}: #{entry.inspect}"
+        end
+      end
+    end
+
+    def symbolize_recursive(hash)
+      {}.tap do |h|
+        hash.each { |key, value| h[key.to_sym] = map_value(value) }
+      end
+    end
+
+    def map_value(thing)
+      case thing
+      when Hash
+        symbolize_recursive(thing)
+      when Array
+        thing.map { |v| map_value(v) }
+      else
+        thing
+      end
+    end
+end

data/lib/hash_keys_sanitizer/version.rb

@@ -0,0 +1,3 @@
+class HashKeysSanitizer
+  VERSION = "0.0.1"
+end

data/lib/hash_keys_sanitizer.rb

@@ -0,0 +1,3 @@
+require "hash_keys_sanitizer/version"
+require "hash_keys_sanitizer/hash_keys_sanitizer"
+

data/spec/lib/hash_keys_sanitizer/hash_keys_sanitizer_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'hash_keys_sanitizer'
+
+describe HashKeysSanitizer do
+
+  let(:whitelist) { [:name, address: [:street, :city, email: [:type]]] }
+  let(:sanitizer) { described_class.new(whitelist: whitelist) }
+
+  describe "#sanitize" do
+
+    context "unknown names given" do
+      let(:raw_hash) {
+        { name: 'John', unknown: 'dummy', address: { street: "John Street", unknown: "BANG",
+                                                     email: { type: 'job', unknown: 'BANG' } } }
+      }
+
+      it "filters out hash keys" do
+        filtered_params = sanitizer.sanitize(raw_hash)
+        expect(filtered_params).to eq(name: 'John', address: { street: "John Street", email: { type: 'job' } })
+      end
+
+      it "does not modify original hash" do
+        filtered_params = sanitizer.sanitize(raw_hash)
+        expect(raw_hash).to eq(name: 'John', unknown: 'dummy', address: { street: "John Street", unknown: "BANG",
+                                                                            email: { type: 'job', unknown: 'BANG' } })
+      end
+
+      it "accepts stringified hash keys" do
+        filtered_params = sanitizer.sanitize('name' => 'John', 'unknown' => 'dummy',
+                                             'address' => { 'street' => "John Street", 'unknown' => "BANG",
+                                                            'email' => { 'type' => 'job', 'unknown' => 'BANG' } })
+        expect(filtered_params).to eq(name: 'John', address: { street: "John Street", email: { type: 'job' } })
+      end
+
+      it "accepts stringified whitelist" do
+        sanitizer = described_class.new(whitelist: ['name', 'address' => ['street', 'city', 'email' => ['type']]])
+
+        filtered_params = sanitizer.sanitize(raw_hash)
+        expect(filtered_params).to eq(name: 'John', address: { street: "John Street", email: { type: 'job' } })
+      end
+
+      it "accepts stringified hash keys and whitelist" do
+        sanitizer = described_class.new(whitelist: ['name', 'address' => ['street', 'city', 'email' => ['type']]])
+
+        filtered_params = sanitizer.sanitize('name' => 'John', 'unknown' => 'dummy',
+                                             'address' => { 'street' => "John Street", 'unknown' => "BANG",
+                                                            'email' => { 'type' => 'job', 'unknown' => 'BANG' } })
+        expect(filtered_params).to eq(name: 'John', address: { street: "John Street", email: { type: 'job' } })
+      end
+    end
+
+    context "valid names given" do
+      it "does not sanitize hash" do
+        raw_hash = { name: 'John Doe', address: { street: 'John Street', city: 'London', email: { type: 'job' } } }
+
+        expect(sanitizer.sanitize(raw_hash)).to eq(raw_hash)
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: hash_keys_sanitizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Baustert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sanitizes hash keys according to a whitelist
+email:
+- business@thomasbaustert.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hash_keys_sanitizer.gemspec
+- lib/hash_keys_sanitizer.rb
+- lib/hash_keys_sanitizer/hash_keys_sanitizer.rb
+- lib/hash_keys_sanitizer/version.rb
+- spec/lib/hash_keys_sanitizer/hash_keys_sanitizer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thomasbuatsert/hash_keys_sanitizer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Hash keys sanitizer
+test_files:
+- spec/lib/hash_keys_sanitizer/hash_keys_sanitizer_spec.rb
+- spec/spec_helper.rb