Merge pull request #14 from sealink/occurrence_env

Adds `original_env` and `filtered_env` properties to occurrence

CHANGELOG.md

@@ -7,6 +7,9 @@ This changelog adheres to [Keep a CHANGELOG](http://keepachangelog.com/).
 ### Changed
 - Updates README for usage with Rails middleware stack
 
+### Added
+- Adds `original_env` and `filtered_env` properties to occurrence
+
 ## [0.2.4] - 2016-12-22
 ### Changed
 - Does not match credit cards numbers that are part of alphanumerical strings

README.md

@@ -63,6 +63,8 @@ An occurrence object has the following properties:
 * session:               the session properties for the request
 * 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
 
 It also exposes `to_h` and `to_s` methods for hash and string representation respectively.  
 Please note that these representations omit sensitive data, 

lib/sensitive_data_filter/middleware/occurrence.rb

@@ -35,6 +35,14 @@ def filtered_body_params
         @filtered_env_parser.body_params
       end
 
+      def original_env
+        @original_env_parser.env
+      end
+
+      def filtered_env
+        @filtered_env_parser.env
+      end
+
       def_delegators :@filtered_env_parser, :request_method, :url, :content_type, :session
 
       def matches_count

spec/sensitive_data_filter/middleware/occurrence_spec.rb

@@ -15,6 +15,8 @@
   let(:original_body_params) { { credit_cards: '4111 1111 1111 1111 and 5123 4567 8901 2346' } }
   let(:filtered_body_params) { { credit_cards: '[FILTERED] and [FILTERED]' } }
   let(:session) { { 'session_id' => '01ab02cd' } }
+  let(:original_env) { double }
+  let(:filtered_env) { double }
   let(:original_env_parser) {
     double(
       ip:             ip,
@@ -23,7 +25,8 @@
       content_type:   content_type,
       query_params:   original_query_params,
       body_params:    original_body_params,
-      session:        session
+      session:        session,
+      env:            original_env
     )
   }
   let(:filtered_env_parser) {
@@ -34,7 +37,8 @@
       content_type:   content_type,
       query_params:   filtered_query_params,
       body_params:    filtered_body_params,
-      session:        session
+      session:        session,
+      env:            filtered_env
     )
   }
   let(:matches) {
@@ -61,6 +65,8 @@
   specify { expect(occurrence.filtered_body_params).to eq filtered_body_params }
   specify { expect(occurrence.session).to eq session }
   specify { expect(occurrence.matches_count).to eq matches_count }
+  specify { expect(occurrence.original_env).to eq original_env }
+  specify { expect(occurrence.filtered_env).to eq filtered_env }
 
   let(:expected_to_h) {
     {