blinkist-airbrake-scrubber 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42384200d89830615e9c495963632bc2d83f0a07
+  data.tar.gz: 2bf61a3d16cb60926ebbefa781bdcaefb5867cd4
+SHA512:
+  metadata.gz: 6d47e6602c6612562666687d8e6357c7cf42a7f48060a46ccbdbfec6f19e0e206602678c260b6411f58dc129d9a725292de87441536fa849c5dc2abca60ac5cd
+  data.tar.gz: 9d541b33a0883dbe45398f032e943da7414d487c54f4cbb51e54d02cc4504bef1353d6917667b561df4a5cd776bfe156bebdd2efd90be34b13ddd0cd663bc762

data/Gemfile

@@ -0,0 +1,23 @@
+ruby "2.3.6"
+
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/blinkist/#{repo}.git" }
+
+group :test do
+  gem "rake"
+  gem "rack"
+  gem "rspec"
+  gem "forgery"
+  gem "simplecov"
+  gem "dotenv"
+end
+
+group :development, :test do
+  gem 'awesome_print'
+  gem "byebug"
+  gem 'memory_profiler'
+  gem "ruby-prof"
+end
+
+# Specify your gem"s dependencies in blinkist-core.gemspec
+gemspec

data/README.md

@@ -0,0 +1,59 @@
+# Blinkist::Airbrake::Scrubber
+
+Blinkist::Airbrake::Scrubber 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
+
+Add this line to your application's Gemfile:
+
+    gem "blinkist-airbrake-scrubber", "0.0.1", github: "blinkist-airbrake-scrubber", tag: "v0.0.1"
+
+And then execute:
+
+    $ bundle install
+
+## Information
+
+### Extending the functionality
+
+To extend the functionality, create a new scrubber file in `lib/blinkist-airbrake-scrubber/scrubbers` folder, like the template:
+
+```ruby
+module Blinkist::Airbrake::Scrubber
+  class WubbaLubba
+    REGEXP = /[\S]+@[\S]+/i
+
+    def self.scrub!
+      ::Airbrake.add_filter do |notice|
+        # Rainbows and unicorns come here:
+        notice[:errors].each { |error| error[:message].gsub!(REGEXP, FILTERED) }
+      end
+    end # def self.scrub!
+
+  end
+end
+```
+
+Then, add the class to Blinkist::Airbrake::Scrubber's SCRUBBERS list to have it ran after Airbrake.configure
+
+### Applications using this gem
+
+There are a few applications available on GitHub that use this gem. For usage see:
+
+* blinkist-messenger
+
+### Dependencies
+
+This gem has dependency on airbrake (~> 5), it will automatically add it unless already bundled.
+
+## Maintainers
+
+* Paweł Komarnicki (https://github.com/pawelkomarnicki)
+
+## Special thanks
+
+* Tomek Przedmojski (https://github.com/tprzedmojski) for providing a brilliant way to use Module#prepend :-)
+
+## License
+
+Copyright 2018 Blinks Labs GmbH. http://blinkist.com

data/Rakefile

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

data/blinkist-airbrake-scrubber.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
+
+require_relative "lib/blinkist-airbrake-scrubber/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "blinkist-airbrake-scrubber"
+  gem.version       = Blinkist::Airbrake::Scrubber::VERSION
+  gem.authors       = ["Paweł Komarnicki", "Dinesh Vasudevan"]
+  gem.email         = ["pawel@blinkist.com", "dinesh@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.homepage      = "https://github.com/blinkist/blinkist-airbrake-scrubber"
+  gem.license       = "MIT"
+
+  # Airbrake
+  gem.add_dependency "airbrake", "~> 5"
+
+  gem.files         = Dir["{lib,spec}/**/*", "README.md", "Rakefile", "Gemfile", "*.gemspec"]
+  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.rb

@@ -0,0 +1,33 @@
+require 'airbrake'
+Dir[File.expand_path('../../lib/**/*.rb', __FILE__)].each do |f|
+  require f
+end
+
+# Prepend the original Airbrake module
+module Airbrake
+  class << self
+    prepend Blinkist::Airbrake::Scrubber
+  end
+end
+
+# Set up the namespace and run every scrubber listed in SCRUBBERS
+module Blinkist
+  module Airbrake
+    module Scrubber
+      FILTERED  = '[Filtered]'
+      SCRUBBERS = [ MessageEmail, ParamsEmail, ParamsPassword ]
+
+      # Override original Airbrake.configure
+      def configure(*args, &block)
+        super
+      ensure
+        Blinkist::Airbrake::Scrubber.run!
+      end
+
+      # Run scrubbers
+      def self.run!
+        SCRUBBERS.each { |scrubber| scrubber::scrub! }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module Blinkist
+  module Airbrake
+    module Scrubber
+      class MessageEmail
+        REGEXP = /[\S]+@[\S]+/i
+
+        def self.scrub!
+          ::Airbrake.add_filter do |notice|
+            notice[:errors].each { |error| error[:message].gsub!(REGEXP, FILTERED) }
+          end
+        end # def self.scrub!
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Blinkist
+  module Airbrake
+    module Scrubber
+      class ParamsEmail
+
+        def self.scrub!
+          ::Airbrake.add_filter do |notice|
+            if notice[:params] && notice[:params][:email]
+              notice[:params][:email] = FILTERED
+            end
+            notice
+          end
+        end # def self.scrub!
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Blinkist
+  module Airbrake
+    module Scrubber
+      class ParamsPassword
+
+        def self.scrub!
+          ::Airbrake.add_filter do |notice|
+            if notice[:params] && notice[:params][:password]
+              notice[:params][:password] = FILTERED
+            end
+            notice
+          end
+        end # def self.scrub!
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Blinkist
+  module Airbrake
+    module Scrubber
+      VERSION = "1.1.0"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'bundler/setup'
+
+require 'awesome_print'
+require 'byebug'
+require 'securerandom'
+
+require 'blinkist-airbrake-scrubber'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require 'spec_helper'` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.color = true
+  config.full_backtrace=true
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  # Configure shared airbrake so it doesn't freak out somewhere else
+  Airbrake.configure do |c|
+    c.project_id  = 1
+    c.project_key = 'whatever'
+  end
+end

data/spec/specs/lib/airbrake_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'blinkist-airbrake-scrubber'
+
+describe Airbrake do
+  let(:instantiate_airbrake) {
+    Airbrake.configure :"notifier_#{ SecureRandom.uuid }" do |c|
+      c.project_id  = 1
+      c.project_key = 'whatever'
+    end
+  }
+
+  describe "Module#prepend" do
+    it "does have Blinkist::Airbrake::Scrubber as one of the ancestors" do
+      expect(described_class.ancestors).to include(Blinkist::Airbrake::Scrubber)
+    end
+  end
+
+  describe '.configure' do
+    it "does call Blinkist::Airbrake::Scrubber.configure" do
+      expect_any_instance_of(Blinkist::Airbrake::Scrubber).to receive(:configure)
+      instantiate_airbrake
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Blinkist::Airbrake::Scrubber::MessageEmail do
+
+  describe "Structure" do
+    it "has REGEXP constant" do
+      expect(described_class.constants).to include(:REGEXP)
+    end
+
+    it "has scrub! method" do
+      expect(described_class).to respond_to(:scrub!)
+    end
+  end
+
+  describe "self.scrub!" do
+    subject { described_class::scrub! }
+
+    it "adds the filter" do
+      expect(Airbrake).to receive(:add_filter)
+      subject
+    end
+  end
+
+  # It's ridiculously hard to peek into Airbrake::Notice
+  # Instead verify the functionality here
+  describe "scrubber functionality" do
+    let(:filtered)  { Blinkist::Airbrake::Scrubber::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_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 } }
+
+    context "Pure email content" do
+      it "filters out valid emails" do
+        puts "Verifying: #{ valid_emails.join ', ' }"
+        valid_emails.each do |email|
+          expect(email.gsub(regexp, filtered)).to eq(filtered)
+        end
+      end
+
+      it "filters out invalid emails" do
+        puts "Verifying: #{ invalid_emails.join ', ' }"
+        invalid_emails.each do |email|
+          expect(email.gsub(regexp, filtered)).to eq(filtered)
+        end
+      end
+    end
+
+    context "Email inside a text" do
+      let(:text) { "Erorr bla bla EMAIL bla bla bla" }
+
+      it "filters out valid emails" do
+        puts "Verifying: #{ valid_emails.join ', ' }"
+        valid_emails.each do |email|
+          content = text.gsub('EMAIL', email)
+          expect(content.gsub(regexp, filtered)).to eq(text.gsub('EMAIL', filtered))
+        end
+      end
+
+      it "filters out invalid emails" do
+        puts "Verifying: #{ invalid_emails.join ', ' }"
+        invalid_emails.each do |email|
+          content = text.gsub('EMAIL', email)
+          expect(content.gsub(regexp, filtered)).to eq(text.gsub('EMAIL', filtered))
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Blinkist::Airbrake::Scrubber::ParamsEmail do
+  let(:notifier) { Airbrake[:default] }
+  let(:notice) {
+    Airbrake[:default].build_notice(
+      Exception.new('whatever'),
+      { email: 'user@example.org', password: 'whatever', param: 'whatever' }
+    )
+  }
+
+  describe "Structure" do
+    it "has scrub! method" do
+      expect(described_class).to respond_to(:scrub!)
+    end
+  end
+
+  describe "self.scrub!" do
+    it "adds the filter" do
+      expect(Airbrake).to receive(:add_filter)
+      described_class::scrub!
+    end
+
+    it "scrubs the email from the params hash" do
+      notifier.instance_variable_get(:@filter_chain).refine(notice)
+      expect(notice[:params][:email]).to eq(Blinkist::Airbrake::Scrubber::FILTERED)
+    end
+  end
+
+end

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

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Blinkist::Airbrake::Scrubber::ParamsPassword do
+  let(:notifier) { Airbrake[:default] }
+  let(:notice) {
+    Airbrake[:default].build_notice(
+      Exception.new('whatever'),
+      { email: 'user@example.org', password: 'whatever', param: 'whatever' }
+    )
+  }
+
+  describe "Structure" do
+    it "has scrub! method" do
+      expect(described_class).to respond_to(:scrub!)
+    end
+  end
+
+  describe "self.scrub!" do
+    it "adds the filter" do
+      expect(Airbrake).to receive(:add_filter)
+      described_class::scrub!
+    end
+
+    it "scrubs the password from the params hash" do
+      notifier.instance_variable_get(:@filter_chain).refine(notice)
+      expect(notice[:params][:password]).to eq(Blinkist::Airbrake::Scrubber::FILTERED)
+    end
+  end
+
+end

data/spec/specs/lib/blinkist_airbrake_scrubber_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'securerandom'
+require 'blinkist-airbrake-scrubber'
+
+describe Blinkist::Airbrake::Scrubber do
+  let(:instantiate_airbrake) {
+    Airbrake.configure :"notifier_#{ SecureRandom.uuid }" do |c|
+      c.project_id  = 1
+      c.project_key = 'whatever'
+    end
+  }
+
+  describe "Constants" do
+    it "has FILTERED constant" do
+      expect(Blinkist::Airbrake::Scrubber.constants).to include(:FILTERED)
+    end
+
+    it "has explicit FILTERED constant content" do
+      expect(Blinkist::Airbrake::Scrubber::FILTERED).to eq('[Filtered]')
+    end
+
+    it "has SCRUBBERS constant" do
+      expect(Blinkist::Airbrake::Scrubber.constants).to include(:SCRUBBERS)
+    end
+
+    it "has list of scrubbers in SCRUBBERS" do
+      expect(Blinkist::Airbrake::Scrubber::SCRUBBERS.is_a?(Array)).to be true
+    end
+  end
+
+  describe ".configure(*args, &block)" do
+    it "calls super Airbrake.configure(*args, &block)" do
+      expect(Airbrake).to receive(:configure)
+      instantiate_airbrake
+    end
+
+    it "calls Blinkist::Airbrake::Scrubber.run!" do
+      expect(Blinkist::Airbrake::Scrubber).to receive(:run!)
+      instantiate_airbrake
+    end
+  end
+
+  describe "self.run!" do
+    it "runs ::scrub! for every scrubber declared in SCRUBBERS" do
+      Blinkist::Airbrake::Scrubber::SCRUBBERS.each do |scrubber|
+        expect(scrubber).to receive(:scrub!)
+      end
+      instantiate_airbrake
+    end
+  end
+
+end

data/spec/specs/version_spec.rb

@@ -0,0 +1,18 @@
+
+require 'spec_helper'
+require 'blinkist-airbrake-scrubber/version'
+
+describe Blinkist::Airbrake::Scrubber::VERSION do
+
+  it 'provides the current version' do
+    version = Blinkist::Airbrake::Scrubber::VERSION
+    expect(version).to_not be nil
+    expect(version.instance_of?(String)).to be true
+  end
+
+  it 'equals 1.0.1 for auto-check purposes' do
+    version = Blinkist::Airbrake::Scrubber::VERSION
+    expect(version).to eq '1.1.0'
+  end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: blinkist-airbrake-scrubber
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Paweł Komarnicki
+- Dinesh Vasudevan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Email scrubbing configuration for Airbrake at Blinkist
+email:
+- pawel@blinkist.com
+- dinesh@blinkist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- blinkist-airbrake-scrubber.gemspec
+- lib/blinkist-airbrake-scrubber.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/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
+- spec/specs/lib/blinkist_airbrake_scrubber_spec.rb
+- spec/specs/version_spec.rb
+homepage: https://github.com/blinkist/blinkist-airbrake-scrubber
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.2
+signing_key: 
+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/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
+- spec/specs/lib/blinkist_airbrake_scrubber_spec.rb
+- spec/specs/version_spec.rb