sensitive_data_filter 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e31778956e211080b72def2da410aa33a3f93b86
-  data.tar.gz: 8234e02dc9e1e69663cd72aa65fb854a5471f0f7
+  metadata.gz: 6cce4248617024392c3ae4361addc7aba426cc1a
+  data.tar.gz: 63bfa17fd66e237d54e549b5fda77f66d2c809a7
 SHA512:
-  metadata.gz: 4317e1dcf196f132905332abd27ce1227656294edf9b721d6b577d6bab6156860ae687c1aefbbfa122da49245c64aa344841e10f61554027c7ec2a4eacdefd87
-  data.tar.gz: e1f221ad6fc0fb2bf57d36d6b0652de4f410e3ff587f5cb73069b0fa0eac85b21f8343a2e721541d5137abf2527010001bffab58c1c6cbe34f247874a9ae74cf
+  metadata.gz: fc9f481f0ed4edd51af68e2d0e02ecb8bebf1e67bdd6e1d845373ee6bbf19260e384df5356364dad8ad95e60c9a6698885a6d4da98f937af61ef0e77e63a735a
+  data.tar.gz: ee718699451224d75f88ad945c27aa6cdf32a1892b6e9bf6b3a584c2c33f768c757603605c2d91d5512b68b578efe12ddb2d8ee7d5ec054a865eff1cb48bb691

data/CHANGELOG.md

@@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 This changelog adheres to [Keep a CHANGELOG](http://keepachangelog.com/).
 
+## [0.4.0] - 2018-01-18
+### Changed
+- [TT-3520] No longer clone the "env" middleware variable
+- [TT-3521] filter action dispatch parameter fields
+- [TT-3523] Update gem dependencies
+
 ## [0.3.0] - 2016-12-28
 ### Changed
 - Allows whitelisting hash values based on the key

data/README.md

@@ -80,7 +80,7 @@ An occurrence object has the following properties:
 * matches:               the matched sensitive data
 * matches_count:         the number of matches per data type, e.g. { 'CreditCard' => 1 }
 * original_env:          the original unfiltered Rack env
-* filtered_env:          the filtered Rack env which will be passed down the middleware stack
+* changeset:             the modified rack env variables
 
 It also exposes `to_h` and `to_s` methods for hash and string representation respectively.  
 Please note that these representations omit sensitive data, 

data/lib/sensitive_data_filter/middleware/detect.rb

@@ -0,0 +1,28 @@
+module SensitiveDataFilter
+  module Middleware
+    class Detect
+      def initialize(filter)
+        @filter = filter
+      end
+
+      def call
+        changeset = nil
+        scan = run_scan
+        if scan.matches?
+          changeset = OpenStruct.new(SensitiveDataFilter::Middleware::FILTERABLE.each_with_object({}) { |filterable, hash|
+            hash[filterable.to_s] = SensitiveDataFilter::Mask.mask(@filter.send(filterable))
+          })
+        end
+        [changeset, scan]
+      end
+
+      private
+
+      def run_scan
+        SensitiveDataFilter::Scan.new(
+          SensitiveDataFilter::Middleware::FILTERABLE.map { |filterable| @filter.send(filterable) }
+        )
+      end
+    end
+  end
+end

data/lib/sensitive_data_filter/middleware/env_parser.rb

@@ -6,6 +6,7 @@ module SensitiveDataFilter
     class EnvParser
       QUERY_STRING = 'QUERY_STRING'.freeze
       RACK_INPUT   = 'rack.input'.freeze
+      REQUEST_PARAMS = 'action_dispatch.request.request_parameters'.freeze
 
       extend Forwardable
 
@@ -28,6 +29,10 @@ module SensitiveDataFilter
         @parameter_parser.parse(body)
       end
 
+      def request_params
+        @env[REQUEST_PARAMS]
+      end
+
       def query_params=(new_params)
         @env[QUERY_STRING] = Rack::Utils.build_query(new_params)
       end
@@ -36,13 +41,14 @@ module SensitiveDataFilter
         @env[RACK_INPUT] = StringIO.new @parameter_parser.unparse(new_params)
       end
 
-      def copy
-        self.class.new(@env.clone)
+      def request_params=(new_params)
+        @env[REQUEST_PARAMS] = new_params
       end
 
-      def mask!
-        self.query_params = SensitiveDataFilter::Mask.mask(query_params)
-        self.body_params  = SensitiveDataFilter::Mask.mask(body_params)
+      def mutate(mutation)
+        SensitiveDataFilter::Middleware::FILTERABLE.each do |filterable|
+          self.send("#{filterable}=", mutation.send(filterable))
+        end
       end
 
       def_delegators :@request, :ip, :request_method, :url, :content_type, :session

data/lib/sensitive_data_filter/middleware/filter.rb

@@ -7,16 +7,20 @@ module SensitiveDataFilter
       end
 
       def call(env)
-        env_filter = EnvFilter.new env
-        handle_occurrence env_filter
-        @app.call env_filter.filtered_env
+        original_env = EnvParser.new(env)
+        changeset, scan = Detect.new(original_env).call
+        unless changeset.nil?
+          handle_occurrence(original_env, changeset, scan)
+          original_env.mutate(changeset)
+        end
+        @app.call(env)
       end
 
       private
 
-      def handle_occurrence(env_filter)
-        return unless env_filter.occurrence?
-        SensitiveDataFilter.handle_occurrence env_filter.occurrence
+      def handle_occurrence(filter, changeset, scan)
+        occurence = Occurrence.new(filter, changeset, scan.matches)
+        SensitiveDataFilter.handle_occurrence(occurence)
       end
     end
   end

data/lib/sensitive_data_filter/middleware/occurrence.rb

@@ -9,9 +9,9 @@ module SensitiveDataFilter
 
       attr_reader :matches
 
-      def initialize(original_env_parser, filtered_env_parser, matches)
+      def initialize(original_env_parser, changeset, matches)
         @original_env_parser = original_env_parser
-        @filtered_env_parser = filtered_env_parser
+        @changeset           = changeset
         @matches             = matches
       end
 
@@ -28,22 +28,26 @@ module SensitiveDataFilter
       end
 
       def filtered_query_params
-        @filtered_env_parser.query_params
+        @changeset.query_params
       end
 
       def filtered_body_params
-        @filtered_env_parser.body_params
+        @changeset.body_params
+      end
+
+      def changeset
+        @changeset
       end
 
       def original_env
         @original_env_parser.env
       end
 
-      def filtered_env
-        @filtered_env_parser.env
+      def url
+        SensitiveDataFilter::Mask.mask(@original_env_parser.url)
       end
 
-      def_delegators :@filtered_env_parser, :request_method, :url, :content_type, :session
+      def_delegators :@original_env_parser, :request_method, :content_type, :session
 
       def matches_count
         @matches.map { |type, matches| [type, matches.count] }.to_h

data/lib/sensitive_data_filter/middleware.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 module SensitiveDataFilter
   module Middleware
+    FILTERABLE = %i(query_params body_params request_params).freeze
   end
 end
 
 require 'sensitive_data_filter/middleware/parameter_parser'
 require 'sensitive_data_filter/middleware/env_parser'
 require 'sensitive_data_filter/middleware/occurrence'
-require 'sensitive_data_filter/middleware/env_filter'
+require 'sensitive_data_filter/middleware/detect'
 require 'sensitive_data_filter/middleware/filter'

data/lib/sensitive_data_filter/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SensitiveDataFilter
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/sensitive_data_filter.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rack', '>= 1.4'
   spec.add_dependency 'facets', '~> 3.1'
-  spec.add_dependency 'credit_card_validations', '~> 3.2'
+  spec.add_dependency 'credit_card_validations', '~> 3.4'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'coverage-kit', '~> 0.1'
   spec.add_development_dependency 'simplecov-rcov', '~> 0.2'
   spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'rubocop', '~> 0.46'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
   spec.add_development_dependency 'travis', '~> 1.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensitive_data_filter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alessandro Berardi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2018-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -143,14 +143,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.46'
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.46'
+        version: '0.52'
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +192,7 @@ files:
 - lib/sensitive_data_filter/config.rb
 - lib/sensitive_data_filter/mask.rb
 - lib/sensitive_data_filter/middleware.rb
-- lib/sensitive_data_filter/middleware/env_filter.rb
+- lib/sensitive_data_filter/middleware/detect.rb
 - lib/sensitive_data_filter/middleware/env_parser.rb
 - lib/sensitive_data_filter/middleware/filter.rb
 - lib/sensitive_data_filter/middleware/occurrence.rb

data/lib/sensitive_data_filter/middleware/env_filter.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-require 'facets/kernel/present'
-
-module SensitiveDataFilter
-  module Middleware
-    class EnvFilter
-      attr_reader :occurrence
-
-      def initialize(env)
-        @original_env_parser = EnvParser.new(env)
-        @filtered_env_parser = @original_env_parser.copy
-        @scan = build_scan
-        @filtered_env_parser.mask! if @scan.matches?
-        @occurrence = build_occurrence
-      end
-
-      def filtered_env
-        @filtered_env_parser.env
-      end
-
-      def occurrence?
-        @occurrence.present?
-      end
-
-      private
-
-      def build_occurrence
-        return nil unless @scan.matches?
-        Occurrence.new(@original_env_parser, @filtered_env_parser, @scan.matches)
-      end
-
-      def build_scan
-        SensitiveDataFilter::Scan.new(
-          [@original_env_parser.query_params, @original_env_parser.body_params]
-        )
-      end
-    end
-  end
-end