blinkist-airbrake-scrubber 4.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 481351d1dcfaacbac3c90de8d56a3ec874ffa06ad7a594d28e8c2d836ad9017d
-  data.tar.gz: ef6af4052741c1608fa7ebefaacaca7590d33b1a5eaf97dc82c6698d080145b8
+  metadata.gz: 384474ed46015fbd829291dee4447f62f298cc5350c785553dfdec1a1bfdcfa1
+  data.tar.gz: 01ae174a8654423131efc1a0553bcf73522aa8c49bd28d68bb129b27721ee0e6
 SHA512:
-  metadata.gz: 0e94893b4853f603fe92f21bbcadeaf281585cfd153b6fc458a6178e5331bd9da24b1842b6de2e4a3fefc8ea066b1519ff253c3351dd820fda2eb4768a4e236f
-  data.tar.gz: 71cdc6db850e77c69cff4010507a7c2977664bd46c70d62a9fef6b800a25ac8f48966791528755d2656c97566c71b51e7ebf52bf7442ffd760fd3325290a39ff
+  metadata.gz: 65975aaba1e9a49c176e9f2163d332a6666b0875d391aab1fe0bca9cee0e03046310d5ef6045a8fb2f078d39460bdc8dffe798c52f38ea765de83a4bc73470a6
+  data.tar.gz: 6d4de8de1e728188bb318e27134af4af1423c71907d422ae6d3f4ca8d1f21c5a3c44134beac2ecf61527c63c819700582e8e3d0565af75fa755a6077e93122ac

data/Gemfile

@@ -1,16 +1,16 @@
-ruby "2.3.6"
+# frozen_string_literal: true
 
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/blinkist/#{repo}.git" }
 
 group :test do
-  gem "rake"
+  gem "dotenv"
+  gem "forgery"
   gem "rack"
+  gem "rake"
   gem "rspec"
-  gem "forgery"
-  gem "simplecov"
-  gem "dotenv"
   gem "rspec_junit_formatter"
+  gem "simplecov"
 end
 
 group :development, :test do

data/README.md

@@ -1,6 +1,6 @@
 # Blinkist::AirbrakeScrubber
 
-Blinkist::AirbrakeScrubber provides an Airbrake scrubbing service to remove various sensitive informations from the notifications, e.g. emails. It does *not* replace Airbrake configuration, but provides some seamless functionality.
+Blinkist::AirbrakeScrubber provides an Airbrake scrubbing service to remove various sensitive informations from the notifications, e.g. emails. It does _not_ replace Airbrake configuration, but provides some seamless functionality.
 
 ## Installation
 
@@ -28,7 +28,7 @@ module Blinkist::AirbrakeScrubber
         # Rainbows and unicorns come here:
         notice[:errors].each { |error| error[:message].gsub!(REGEXP, FILTERED) }
       end
-    end # def self.scrub!
+    end
 
   end
 end
@@ -38,16 +38,16 @@ Then, add the class to Blinkist::AirbrakeScrubber's SCRUBBERS list to have it ra
 
 ### Dependencies
 
-This gem has dependency on airbrake (~> 7), it will automatically add it unless already bundled.
+This gem has dependency on airbrake (>= 9), it will automatically add it unless already bundled.
 
 ## Maintainers
 
-* Paweł Komarnicki (https://github.com/pawelkomarnicki)
+- Blinkist (https://github.com/blinkist)
 
 ## Special thanks
 
-* Tomek Przedmojski (https://github.com/tprzedmojski) for providing a brilliant way to use Module#prepend :-)
+- Tomek Przedmojski (https://github.com/tprzedmojski) for providing a brilliant way to use Module#prepend :-)
 
 ## License
 
-Copyright 2018 Blinks Labs GmbH. http://blinkist.com
+Copyright 2021 Blinks Labs GmbH. https://blinkist.com

data/Rakefile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task(:default).clear
-task default: [ :spec ]
+task default: [:spec]

data/blinkist-airbrake-scrubber.gemspec

@@ -1,4 +1,5 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
 
 require_relative "lib/blinkist-airbrake-scrubber/version"
@@ -6,17 +7,17 @@ require_relative "lib/blinkist-airbrake-scrubber/version"
 Gem::Specification.new do |gem|
   gem.name          = "blinkist-airbrake-scrubber"
   gem.version       = Blinkist::AirbrakeScrubber::VERSION
-  gem.authors       = ["Paweł Komarnicki", "Dinesh Vasudevan", 'Tomek Przedmojski']
-  gem.email         = ["pawel@blinkist.com", "dinesh@blinkist.com", "tomek@blinkist.com"]
-  gem.description   = %q{Email scrubbing configuration for Airbrake at Blinkist}
-  gem.summary       = %q{With this, Airbrake will not leak emails via exception notifications}
+  gem.authors       = ["Blinkist"]
+  gem.email         = ["operations@blinkist.com"]
+  gem.description   = 'Email scrubbing configuration for Airbrake at Blinkist'
+  gem.summary       = 'With this, Airbrake will not leak emails via exception notifications'
   gem.homepage      = "https://github.com/blinkist/airbrake-scrubber"
   gem.license       = "MIT"
 
-  # Airbrake
-  gem.add_dependency "airbrake", "~> 9"
+  # https://github.com/airbrake/airbrake
+  gem.add_dependency "airbrake", ">= 9", "< 14"
 
   gem.files         = Dir["{lib,spec}/**/*", "README.md", "Rakefile", "Gemfile", "*.gemspec"]
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -20,17 +22,15 @@ module Blinkist
           input.map { |i| recursive_traverse(i, &block) }
 
         when Hash
-          Hash[input.map { |key, value|
-
+          Hash[input.map do |key, value|
             # Go deeper for things that are not simple objects
             case value
             when Array, Hash
-              [ key, recursive_traverse(value, &block) ]
+              [key, recursive_traverse(value, &block)]
             else
-              [ key, block.call(key, value) ]
+              [key, block.call(key, value)]
             end
-
-          }]
+          end]
         else
           input
         end

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

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 module Blinkist
   module AirbrakeScrubber
     class MessageEmail
-      REGEXP = /[\S]+@[\S]+/i
+      REGEXP = /[\S]+@[\S]+/i.freeze
 
       def self.scrub!
         ::Airbrake.add_filter do |notice|
           # Cannot do gsub! coz of frozen literals
           notice[:errors].each { |error| error[:message] = scrub(error[:message]) }
         end
-      end # def self.scrub!
+      end
 
       def self.scrub(message)
-        message.gsub(REGEXP, FILTERED) if message
+        message&.gsub(REGEXP, FILTERED)
       end
 
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blinkist
   module AirbrakeScrubber
     class ParamsEmail
@@ -10,7 +12,7 @@ module Blinkist
           end
           notice
         end
-      end # def self.scrub!
+      end
 
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blinkist
   module AirbrakeScrubber
     class ParamsPassword
@@ -10,7 +12,7 @@ module Blinkist
           end
           notice
         end
-      end # def self.scrub!
+      end
 
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Blinkist
   module AirbrakeScrubber
     class ParamsTokens
@@ -5,12 +7,12 @@ module Blinkist
       def self.scrub!
         ::Airbrake.add_filter do |notice|
           notice[:params] = DeepTraversal.new(notice[:params]).traverse do |key, value|
-            value = FILTERED if %w( facebook_access_token google_id_token ).include?(key.to_s)
+            value = FILTERED if %w[facebook_access_token google_id_token].include?(key.to_s)
             value
           end
           notice
         end
-      end # def self.scrub!
+      end
 
     end
   end

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Blinkist
   module AirbrakeScrubber
 
-    VERSION = "4.1.1"
+    VERSION = "5.0.0"
 
   end
 end

data/lib/blinkist-airbrake-scrubber.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'airbrake'
-Dir[File.expand_path('../../lib/**/*.rb', __FILE__)].each do |f|
+Dir[File.expand_path('../lib/**/*.rb', __dir__)].sort.each do |f|
   require f
 end
 
@@ -15,10 +17,10 @@ end
 module Blinkist
   module AirbrakeScrubber
     FILTERED  = '[Filtered]'
-    SCRUBBERS = [ MessageEmail, ParamsEmail, ParamsPassword, ParamsTokens ]
+    SCRUBBERS = [MessageEmail, ParamsEmail, ParamsPassword, ParamsTokens].freeze
 
     # Override original Airbrake.configure
-    def configure(*args, &block)
+    def configure(*_args, &block)
       super(&block)
     ensure
       Blinkist::AirbrakeScrubber.run!
@@ -26,7 +28,7 @@ module Blinkist
 
     # Run scrubbers
     def self.run!
-      SCRUBBERS.each { |scrubber| scrubber::scrub! }
+      SCRUBBERS.each(&:scrub!)
     end
 
   end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 
 require 'awesome_print'
@@ -14,7 +16,7 @@ require 'blinkist-airbrake-scrubber'
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   config.color = true
-  config.full_backtrace=true
+  config.full_backtrace = true
 
   config.expect_with :rspec do |expectations|
     expectations.syntax = :expect

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'blinkist-airbrake-scrubber'
 
 describe Airbrake do
   let(:instantiate_airbrake) {
-    Airbrake.configure :"notifier_#{ SecureRandom.uuid }" do |c|
+    Airbrake.configure :"notifier_#{SecureRandom.uuid}" do |c|
       c.project_id  = 1
       c.project_key = 'whatever'
     end

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

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'blinkist-airbrake-scrubber'
 
 describe Blinkist::AirbrakeScrubber::DeepTraversal do
   subject { described_class.new(source) }
 
-  let(:source) { Hash.new }
+  let(:source) { {} }
 
   describe ".traverse" do
     it "calls .recursive_traverse" do
       expect(subject).to receive(:recursive_traverse).with(source)
-      subject.traverse { |k, v| v }
+      subject.traverse { |_k, v| v }
     end
   end
 
@@ -22,7 +24,7 @@ describe Blinkist::AirbrakeScrubber::DeepTraversal do
     end
 
     it "filters out any keys" do
-      returned_object = subject.traverse { |k, v| %w{ email password }.include?(k.to_s) ? '[Filtered]' : v }
+      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
@@ -37,20 +39,20 @@ describe Blinkist::AirbrakeScrubber::DeepTraversal do
   end
 
   context "For hashes with arrays" do
-    let(:source) { { email: 'user@example.org', emails: [ { email: 'user@example.org' }, { email: 'user@example.org' } ], whatever: [ nil ] } }
+    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 ] })
+      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' } ] }
+    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]' } ])
+      expect(returned_object).to eq([{ email: '[Filtered]' }, { email: '[Filtered]' }])
     end
   end
 

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Blinkist::AirbrakeScrubber::MessageEmail do
-
   describe "Structure" do
     it "has REGEXP constant" do
       expect(described_class.constants).to include(:REGEXP)
@@ -13,7 +14,7 @@ describe Blinkist::AirbrakeScrubber::MessageEmail do
   end
 
   describe "self.scrub!" do
-    subject { described_class::scrub! }
+    subject { described_class.scrub! }
 
     it "adds the filter" do
       expect(Airbrake).to receive(:add_filter)
@@ -27,21 +28,21 @@ describe Blinkist::AirbrakeScrubber::MessageEmail do
     let(:filtered)  { Blinkist::AirbrakeScrubber::FILTERED }
     let(:regexp)    { described_class::REGEXP }
 
-    let(:valid_domains) { %w{ example.org exam-ple.org exam.ple.org e-xam.ple.org e-xam.p-le.org e.x.a.m.p.l.e.co.uk } }
-    let(:valid_usernames) { %w{ username user.name user+name user-name user_name } }
+    let(:valid_domains) { %w[example.org exam-ple.org exam.ple.org e-xam.ple.org e-xam.p-le.org e.x.a.m.p.l.e.co.uk] }
+    let(:valid_usernames) { %w[username user.name user+name user-name user_name] }
     let(:valid_emails) { valid_usernames.product(valid_domains).map { |row| row.join '@' } }
-    let(:invalid_emails) { %w{ user@example user@example. user!@example.org us@r@example.org us&r@example.com } }
+    let(:invalid_emails) { %w[user@example user@example. user!@example.org us@r@example.org us&r@example.com] }
 
     context "Pure email content" do
       it "filters out valid emails" do
-        puts "Verifying: #{ valid_emails.join ', ' }"
+        puts "Verifying: #{valid_emails.join ', '}"
         valid_emails.each do |email|
           expect(described_class.scrub(email)).to eq(filtered)
         end
       end
 
       it "filters out invalid emails" do
-        puts "Verifying: #{ invalid_emails.join ', ' }"
+        puts "Verifying: #{invalid_emails.join ', '}"
         invalid_emails.each do |email|
           expect(described_class.scrub(email)).to eq(filtered)
         end
@@ -52,7 +53,7 @@ describe Blinkist::AirbrakeScrubber::MessageEmail do
       let(:text) { "Erorr bla bla EMAIL bla bla bla" }
 
       it "filters out valid emails" do
-        puts "Verifying: #{ valid_emails.join ', ' }"
+        puts "Verifying: #{valid_emails.join ', '}"
         valid_emails.each do |email|
           content = text.gsub('EMAIL', email)
           expect(described_class.scrub(content)).to eq(text.gsub('EMAIL', filtered))
@@ -60,7 +61,7 @@ describe Blinkist::AirbrakeScrubber::MessageEmail do
       end
 
       it "filters out invalid emails" do
-        puts "Verifying: #{ invalid_emails.join ', ' }"
+        puts "Verifying: #{invalid_emails.join ', '}"
         invalid_emails.each do |email|
           content = text.gsub('EMAIL', email)
           expect(described_class.scrub(content)).to eq(text.gsub('EMAIL', filtered))
@@ -70,12 +71,11 @@ describe Blinkist::AirbrakeScrubber::MessageEmail do
 
     context "Anything that is a frozen string" do
       subject { described_class.scrub text }
-      let(:text) { "Error bla bla bla test@example.org bla bla bla".freeze }
+      let(:text) { "Error bla bla bla test@example.org bla bla bla" }
 
       it "filters out email" do
         expect(subject).to eq(text.gsub('test@example.org', filtered))
       end
     end
   end
-
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Blinkist::AirbrakeScrubber::ParamsEmail do
@@ -17,7 +19,7 @@ describe Blinkist::AirbrakeScrubber::ParamsEmail do
   describe "self.scrub!" do
     it "adds the filter" do
       expect(Airbrake).to receive(:add_filter)
-      described_class::scrub!
+      described_class.scrub!
     end
 
     it "scrubs the email from the params hash" do
@@ -36,5 +38,4 @@ describe Blinkist::AirbrakeScrubber::ParamsEmail do
       expect(notice[:params][:deeply][:nested][:email]).to eq(Blinkist::AirbrakeScrubber::FILTERED)
     end
   end
-
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Blinkist::AirbrakeScrubber::ParamsPassword do
@@ -17,7 +19,7 @@ describe Blinkist::AirbrakeScrubber::ParamsPassword do
   describe "self.scrub!" do
     it "adds the filter" do
       expect(Airbrake).to receive(:add_filter)
-      described_class::scrub!
+      described_class.scrub!
     end
 
     it "scrubs the password from the params hash" do
@@ -36,5 +38,4 @@ describe Blinkist::AirbrakeScrubber::ParamsPassword do
       expect(notice[:params][:deeply][:nested][:password]).to eq(Blinkist::AirbrakeScrubber::FILTERED)
     end
   end
-
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Blinkist::AirbrakeScrubber::ParamsTokens do
@@ -17,7 +19,7 @@ describe Blinkist::AirbrakeScrubber::ParamsTokens do
   describe "self.scrub!" do
     it "adds the filter" do
       expect(Airbrake).to receive(:add_filter)
-      described_class::scrub!
+      described_class.scrub!
     end
 
     it "scrubs the google_id_token from the params hash" do
@@ -52,5 +54,4 @@ describe Blinkist::AirbrakeScrubber::ParamsTokens do
       expect(notice[:params][:deeply][:nested][:facebook_access_token]).to eq(Blinkist::AirbrakeScrubber::FILTERED)
     end
   end
-
 end

data/spec/specs/lib/blinkist_airbrake_scrubber_spec.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'securerandom'
 require 'blinkist-airbrake-scrubber'
 
 describe Blinkist::AirbrakeScrubber do
   let(:instantiate_airbrake) {
-    Airbrake.configure :"notifier_#{ SecureRandom.uuid }" do |c|
+    Airbrake.configure :"notifier_#{SecureRandom.uuid}" do |c|
       c.project_id  = 1
       c.project_key = 'whatever'
     end
@@ -48,5 +50,4 @@ describe Blinkist::AirbrakeScrubber do
       instantiate_airbrake
     end
   end
-
 end

data/spec/specs/version_spec.rb

@@ -1,18 +1,17 @@
+# frozen_string_literal: true
 
 require 'spec_helper'
 require 'blinkist-airbrake-scrubber/version'
 
 describe Blinkist::AirbrakeScrubber::VERSION do
-
   it 'provides the current version' do
     version = Blinkist::AirbrakeScrubber::VERSION
     expect(version).to_not be nil
-    expect(version.instance_of?(String)).to be true
+    expect(version).to be_a String
   end
 
-  it 'equals 4.0.1 for auto-check purposes' do
+  it 'equals 5.0.0 for auto-check purposes' do
     version = Blinkist::AirbrakeScrubber::VERSION
-    expect(version).to eq '4.1.1'
+    expect(version).to eq '5.0.0'
   end
-
 end

metadata

@@ -1,36 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: blinkist-airbrake-scrubber
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 5.0.0
 platform: ruby
 authors:
-- Paweł Komarnicki
-- Dinesh Vasudevan
-- Tomek Przedmojski
+- Blinkist
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-14 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
 description: Email scrubbing configuration for Airbrake at Blinkist
 email:
-- pawel@blinkist.com
-- dinesh@blinkist.com
-- tomek@blinkist.com
+- operations@blinkist.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -74,8 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: With this, Airbrake will not leak emails via exception notifications