blinkist-airbrake-scrubber 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b85ab4bf932163ef87c58a0213d5a66eedcba189
-  data.tar.gz: 672688d23f9af0da1b52ae0eba8db74612810677
+  metadata.gz: f8fc147a1a2aedc718e46ffcb626a3ac6a58fc61
+  data.tar.gz: 7118c10d9e7b7e5cd05f0a96bd860131ea982f00
 SHA512:
-  metadata.gz: 88453a2053ff065c9e41a841ee984436c625dac0934dba868442faf547d00128657f3c45abeda6773b234e3a0cd903a4c897f750a73d40c9eb96ea4ea6350047
-  data.tar.gz: c5db35d6b008865fb28bf78dab40eff29aa379a53852fb1cd26cef618b72581c774deb8590ed2176c38e334dac4df172d696a4a97d43817763bd619af95f6aac
+  metadata.gz: 7bb657ded1f044a61be2bac7b00c08a9045a9e66fbb1922749626d15b99616afbee9c78089a6cf0c2a47eaedb9600209c389853f9cce9c85f2df880274ff8517
+  data.tar.gz: 2ec6867a21e8aee97510781c0d7a8e4ddeefce2f9925ff50f80f1e0e0ab7fade0cf3cc713b5f1c8c2714ed337bbdb99b002bc164479aa45d4654559c7d78a641

data/blinkist-airbrake-scrubber.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.license       = "MIT"
 
   # Airbrake
-  gem.add_dependency "airbrake"
+  gem.add_dependency "airbrake", "~> 7"
 
   gem.files         = Dir["{lib,spec}/**/*", "README.md", "Rakefile", "Gemfile", "*.gemspec"]
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/blinkist-airbrake-scrubber.rb

@@ -4,6 +4,7 @@ Dir[File.expand_path('../../lib/**/*.rb', __FILE__)].each do |f|
 end
 
 # Prepend the original Airbrake module
+# Note: Do not remove from this file, it needs to be before Blinkist::Airbrake::Scrubber
 module Airbrake
   class << self
     prepend Blinkist::Airbrake::Scrubber
@@ -28,6 +29,7 @@ module Blinkist
       def self.run!
         SCRUBBERS.each { |scrubber| scrubber::scrub! }
       end
+
     end
   end
 end

data/lib/blinkist-airbrake-scrubber/deep_traversal.rb

@@ -0,0 +1,43 @@
+# DeepTraversal provides traverse possibility of Hashes
+# Can handle Hash objects with deep nesting, or other nested objects that can be dug deeper (e.g. Array)
+module Blinkist
+  module Airbrake
+    module Scrubber
+
+      class DeepTraversal
+        def initialize(source)
+          @source = source
+        end
+
+        def traverse(&block)
+          recursive_traverse(@source, &block)
+        end
+
+        private
+
+        def recursive_traverse(input, &block)
+          case input
+          when Array
+            input.map { |i| recursive_traverse(i, &block) }
+
+          when Hash
+            Hash[input.map { |key, value|
+
+              # Go deeper for things that are not simple objects
+              case value
+              when Array, Hash
+                [ key, recursive_traverse(value, &block) ]
+              else
+                [ key, block.call(key, value) ]
+              end
+
+            }]
+          else
+            input
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/blinkist-airbrake-scrubber/scrubbers/params_email.rb

@@ -5,8 +5,9 @@ module Blinkist
 
         def self.scrub!
           ::Airbrake.add_filter do |notice|
-            if notice[:params] && notice[:params][:email]
-              notice[:params][:email] = FILTERED
+            notice[:params] = DeepTraversal.new(notice[:params]).traverse do |key, value|
+              value = FILTERED if key.to_s == 'email'
+              value
             end
             notice
           end

data/lib/blinkist-airbrake-scrubber/scrubbers/params_password.rb

@@ -5,8 +5,9 @@ module Blinkist
 
         def self.scrub!
           ::Airbrake.add_filter do |notice|
-            if notice[:params] && notice[:params][:password]
-              notice[:params][:password] = FILTERED
+            notice[:params] = DeepTraversal.new(notice[:params]).traverse do |key, value|
+              value = FILTERED if key.to_s == 'password'
+              value
             end
             notice
           end

data/lib/blinkist-airbrake-scrubber/version.rb

@@ -1,7 +1,7 @@
 module Blinkist
   module Airbrake
     module Scrubber
-      VERSION = "2.0.1"
+      VERSION = "2.1.1"
     end
   end
 end

data/spec/specs/lib/blinkist-airbrake-scrubber/deep_traversal_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'blinkist-airbrake-scrubber'
+
+describe Blinkist::Airbrake::Scrubber::DeepTraversal do
+  subject { described_class.new(source) }
+
+  let(:source) { Hash.new }
+
+  describe ".traverse" do
+    it "calls .recursive_traverse" do
+      expect(subject).to receive(:recursive_traverse).with(source)
+      subject.traverse { |k, v| v }
+    end
+  end
+
+  context "For single-level hashes" do
+    let(:source) { { email: 'user@example.org', password: 'whatever', param: true } }
+
+    it "filters out any key" do
+      returned_object = subject.traverse { |k, v| k.to_s == 'email' ? '[Filtered]' : v }
+      expect(returned_object).to eq({ email: '[Filtered]', password: 'whatever', param: true })
+    end
+
+    it "filters out any keys" do
+      returned_object = subject.traverse { |k, v| %w{ email password }.include?(k.to_s) ? '[Filtered]' : v }
+      expect(returned_object).to eq({ email: '[Filtered]', password: '[Filtered]', param: true })
+    end
+  end
+
+  context "For deeply-nested hashes" do
+    let(:source) { { email: 'user@example.org', params: { email: 'user@example.org', contact: { email: 'user@example.org' } } } }
+
+    it "filters out all keys" do
+      returned_object = subject.traverse { |k, v| k.to_s == 'email' ? '[Filtered]' : v }
+      expect(returned_object).to eq({ email: '[Filtered]', params: { email: '[Filtered]', contact: { email: '[Filtered]' } } })
+    end
+  end
+
+  context "For hashes with arrays" do
+    let(:source) { { email: 'user@example.org', emails: [ { email: 'user@example.org' }, { email: 'user@example.org' } ], whatever: [ nil ] } }
+
+    it "filters out all keys" do
+      returned_object = subject.traverse { |k, v| k.to_s == 'email' ? '[Filtered]' : v }
+      expect(returned_object).to eq({ email: '[Filtered]', emails: [ { email: '[Filtered]' }, { email: '[Filtered]' } ], whatever: [ nil ] })
+    end
+  end
+
+  context "For arrays" do
+    let(:source) { [ { email: 'user@example.org' }, { email: 'user@example.org' } ] }
+
+    it "filters out all keys" do
+      returned_object = subject.traverse { |k, v| k.to_s == 'email' ? '[Filtered]' : v }
+      expect(returned_object).to eq([ { email: '[Filtered]' }, { email: '[Filtered]' } ])
+    end
+  end
+
+  context "For simple objects (non-hash, non-array)" do
+    it "doesn't break String" do
+      returned_object = described_class.new("Sample").traverse { |k, v| k.to_s == 'email' ? '[Filtered]' : v }
+      expect(returned_object).to eq("Sample")
+    end
+
+    it "doesn't break Fixnum" do
+      returned_object = described_class.new(1).traverse { |k, v| k.to_s == 'email' ? '[Filtered]' : v }
+      expect(returned_object).to eq(1)
+    end
+
+    it "doesn't break Float" do
+      returned_object = described_class.new(3.14).traverse { |k, v| k.to_s == 'email' ? '[Filtered]' : v }
+      expect(returned_object).to eq(3.14)
+    end
+  end
+end

data/spec/specs/lib/blinkist-airbrake-scrubber/scrubbers/params_email_spec.rb

@@ -25,6 +25,17 @@ describe Blinkist::Airbrake::Scrubber::ParamsEmail do
       notifier.instance_variable_get(:@filter_chain).refine(notice)
       expect(notice[:params][:email]).to eq(Blinkist::Airbrake::Scrubber::FILTERED)
     end
+
+    it "scrubs the deep-nested email from the params hash" do
+      notice = Airbrake[:default].build_notice(
+        Exception.new('whatever'),
+        { email: 'user@example.org', deeply: { nested: { email: 'user@example.org' } } }
+      )
+
+      notifier.instance_variable_get(:@filter_chain).refine(notice)
+      expect(notice[:params][:email]).to eq(Blinkist::Airbrake::Scrubber::FILTERED)
+      expect(notice[:params][:deeply][:nested][:email]).to eq(Blinkist::Airbrake::Scrubber::FILTERED)
+    end
   end
 
 end

data/spec/specs/lib/blinkist-airbrake-scrubber/scrubbers/params_password_spec.rb

@@ -25,6 +25,17 @@ describe Blinkist::Airbrake::Scrubber::ParamsPassword do
       notifier.instance_variable_get(:@filter_chain).refine(notice)
       expect(notice[:params][:password]).to eq(Blinkist::Airbrake::Scrubber::FILTERED)
     end
+
+    it "scrubs the deep-nested password from the params hash" do
+      notice = Airbrake[:default].build_notice(
+        Exception.new('whatever'),
+        { password: 'whatever', deeply: { nested: { password: 'whatever' } } }
+      )
+
+      notifier.instance_variable_get(:@filter_chain).refine(notice)
+      expect(notice[:params][:password]).to eq(Blinkist::Airbrake::Scrubber::FILTERED)
+      expect(notice[:params][:deeply][:nested][:password]).to eq(Blinkist::Airbrake::Scrubber::FILTERED)
+    end
   end
 
 end

data/spec/specs/version_spec.rb

@@ -10,9 +10,9 @@ describe Blinkist::Airbrake::Scrubber::VERSION do
     expect(version.instance_of?(String)).to be true
   end
 
-  it 'equals 2.0.1 for auto-check purposes' do
+  it 'equals 2.1.1 for auto-check purposes' do
     version = Blinkist::Airbrake::Scrubber::VERSION
-    expect(version).to eq '2.0.1'
+    expect(version).to eq '2.1.1'
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blinkist-airbrake-scrubber
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Paweł Komarnicki
@@ -15,16 +15,16 @@ dependencies:
   name: airbrake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7'
 description: Email scrubbing configuration for Airbrake at Blinkist
 email:
 - pawel@blinkist.com
@@ -38,12 +38,14 @@ files:
 - Rakefile
 - blinkist-airbrake-scrubber.gemspec
 - lib/blinkist-airbrake-scrubber.rb
+- lib/blinkist-airbrake-scrubber/deep_traversal.rb
 - lib/blinkist-airbrake-scrubber/scrubbers/message_email.rb
 - lib/blinkist-airbrake-scrubber/scrubbers/params_email.rb
 - lib/blinkist-airbrake-scrubber/scrubbers/params_password.rb
 - lib/blinkist-airbrake-scrubber/version.rb
 - spec/spec_helper.rb
-- spec/specs/lib/airbrake_spec.rb
+- spec/specs/lib/blinkist-airbrake-scrubber/airbrake_spec.rb
+- spec/specs/lib/blinkist-airbrake-scrubber/deep_traversal_spec.rb
 - spec/specs/lib/blinkist-airbrake-scrubber/scrubbers/message_email_spec.rb
 - spec/specs/lib/blinkist-airbrake-scrubber/scrubbers/params_email_spec.rb
 - spec/specs/lib/blinkist-airbrake-scrubber/scrubbers/params_password_spec.rb
@@ -75,7 +77,8 @@ specification_version: 4
 summary: With this, Airbrake will not leak emails via exception notifications
 test_files:
 - spec/spec_helper.rb
-- spec/specs/lib/airbrake_spec.rb
+- spec/specs/lib/blinkist-airbrake-scrubber/airbrake_spec.rb
+- spec/specs/lib/blinkist-airbrake-scrubber/deep_traversal_spec.rb
 - spec/specs/lib/blinkist-airbrake-scrubber/scrubbers/message_email_spec.rb
 - spec/specs/lib/blinkist-airbrake-scrubber/scrubbers/params_email_spec.rb
 - spec/specs/lib/blinkist-airbrake-scrubber/scrubbers/params_password_spec.rb