carwash 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6576ac51de59d7fdccb1fcb5c591cf9e38680f9
-  data.tar.gz: 6988e960d2d76d58ab9732f86b837676a8778d0a
+  metadata.gz: 7dedb715ebed845cfa7533e62fc0259c32e1d486
+  data.tar.gz: 31caf74a8cc0341b4e0d19e71093a2bc89003b7a
 SHA512:
-  metadata.gz: f5b1ebf5ba0738aabf8fdf39645732998834da2ffae9ae3840c38bc039f1f2ee3a2eac7208310f96124a00f0275e291d13af0d9ef7e24bcaa63cb13a859dd817
-  data.tar.gz: 0d9c5db4ea69d11b676fe710d6f314861f451bfe875fb0b3c654ba2949800c951e04264256ead8ae2f78692af9823e740d91b72b74b48dce4dbf83315e51d2a3
+  metadata.gz: 3363073c280fbd86f5822e6bd16dbee1ef403ea4f9d59ca45177984e274b6ddb9f5ac321f0fe05b96ffde29e3c5bfb9a04f6cf2e00af896ae2a0376d41d2d91b
+  data.tar.gz: 2545cb05ff0632561f9ed4a749df5c97a75240fe8727e3f0f1da8f7fa8f0e86eda5d57fde19136600d0d94cdc08730a1112199722d3b6f7e731aea76bfa55d0a

data/carwash.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = "~> 2.0"
+
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/carwash/scrubber.rb

@@ -4,27 +4,27 @@ require "set"
 # obscures them in lines of text.
 class Carwash::Scrubber
   DEFAULT_OBSCURE_WITH   = "********"
-  DEFAULT_SENSITIVE_KEYS = %w[key password secret token]
+  DEFAULT_SENSITIVE_KEYS = %w[key password token]
 
   attr_accessor :obscure_with
   attr_reader :sensitive_keys
 
-  def initialize(sensitive_keys: DEFAULT_SENSITIVE_KEYS,
-                 obscure_with: DEFAULT_OBSCURE_WITH,
-                 check_for_rails: true,
-                 check_env_vars: true)
-    @obscure_with = obscure_with
+  def initialize(options = {})
+    @sensitive_keys  = options.fetch(:sensitive_keys, DEFAULT_SENSITIVE_KEYS)
+    @check_for_rails = options.fetch(:check_for_rails, true)
+    @check_env_vars  = options.fetch(:check_env_vars, true)
+    @obscure_with    = options.fetch(:obscure_with, DEFAULT_OBSCURE_WITH)
 
-    @sensitive_keys = Set.new(sensitive_keys.map(&:to_s).map(&:downcase))
+    @sensitive_keys = Set.new(@sensitive_keys.map(&:to_s).map(&:downcase))
     @sensitive_vals = Set.new
 
-    if check_for_rails && defined? Rails
+    if @check_for_rails && defined? Rails
       @sensitive_keys += Rails.configuration.filter_parameters.map(&:to_s).map(&:downcase).compact
       @sensitive_keys += Rails.application.secrets.keys.map(&:to_s).map(&:downcase).compact
       @sensitive_vals += Rails.application.secrets.values.map(&:to_s).map(&:downcase).compact
     end
 
-    if check_env_vars
+    if @check_env_vars
       ENV.each do |env_key, env_val|
         @sensitive_keys.each do |key|
           if env_key =~ %r{[_-]?#{key}}i
@@ -63,33 +63,33 @@ class Carwash::Scrubber
   #
   # NOTE: Does *not* discover/learn values from the line; use `#scrub` to both
   # discover and obscure based on the line.
-  def obscure_sensitive_values(line, obscure_with: self.obscure_with)
+  def obscure_sensitive_values(line, options = {})
     line = line.clone
-    obscure_sensitive_values!(line, obscure_with: obscure_with)
+    obscure_sensitive_values!(line, options)
     line
   end
 
   # Go through a line of text and obscure any potentially sensitive values
   # detected. Makes replacements in place.
-  def obscure_sensitive_values!(line, obscure_with: self.obscure_with)
+  def obscure_sensitive_values!(line, options = {})
     @sensitive_vals.each do |val|
-      line.gsub!(val, obscure_with)
+      line.gsub!(val, options.fetch(:obscure_with, self.obscure_with))
     end
   end
 
   # Scans the line to try and discover potentially sensitive values, then
   # obscures all sensitive values known. Returns the line with replacements
   # made.
-  def scrub(line, obscure_with: self.obscure_with)
+  def scrub(line, options = {})
     discover_sensitive_values(line)
-    obscure_sensitive_values(line, obscure_with: obscure_with)
+    obscure_sensitive_values(line, options)
   end
 
   # Scans the line to try and discover potentially sensitive values, then
   # obscures all sensitive values known. Makes replacements in place.
-  def scrub!(line, obscure_with: self.obscure_with)
+  def scrub!(line, options = {})
     discover_sensitive_values(line)
-    obscure_sensitive_values!(line, obscure_with: obscure_with)
+    obscure_sensitive_values!(line, options)
   end
 
   # Learns from and scrubs each line of an input stream, writing the result to 

data/lib/carwash/version.rb

@@ -1,3 +1,3 @@
 module Carwash
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/carwash/xml_value_discoverer.rb

@@ -5,10 +5,10 @@ require 'rexml/document'
 # since they match the `key="value"` format that it handles.
 class Carwash::XmlValueDiscoverer < Struct.new(:key)
   def discover(line)
-    line.scan(%r{[^/]#{key}>(?:([^<]+)|<!\[CDATA\[(.*?)\]\])}i)
-      .map(&:compact)
-      .flatten(1)
-      .map { |val| unescape_value(val) }
+    line.scan(%r{[^/]#{key}>(?:([^<]+)|<!\[CDATA\[(.*?)\]\])}i).
+      map(&:compact).
+      flatten(1).
+      map { |val| unescape_value(val) }
   end
 
   def unescape_value(value)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carwash
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nathan Clark
@@ -86,9 +86,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="