airbrake-ruby 2.2.3 → 2.2.4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.2.4
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -115,7 +115,6 @@ files:
 - lib/airbrake-ruby/config.rb
 - lib/airbrake-ruby/config/validator.rb
 - lib/airbrake-ruby/filter_chain.rb
-- lib/airbrake-ruby/filters.rb
 - lib/airbrake-ruby/filters/gem_root_filter.rb
 - lib/airbrake-ruby/filters/keys_blacklist.rb
 - lib/airbrake-ruby/filters/keys_filter.rb
@@ -126,10 +125,10 @@ files:
 - lib/airbrake-ruby/nested_exception.rb
 - lib/airbrake-ruby/notice.rb
 - lib/airbrake-ruby/notifier.rb
-- lib/airbrake-ruby/payload_truncator.rb
 - lib/airbrake-ruby/promise.rb
 - lib/airbrake-ruby/response.rb
 - lib/airbrake-ruby/sync_sender.rb
+- lib/airbrake-ruby/truncator.rb
 - lib/airbrake-ruby/version.rb
 - spec/airbrake_spec.rb
 - spec/async_sender_spec.rb
@@ -137,18 +136,20 @@ files:
 - spec/config/validator_spec.rb
 - spec/config_spec.rb
 - spec/filter_chain_spec.rb
+- spec/filters/gem_root_filter_spec.rb
 - spec/filters/keys_blacklist_spec.rb
+- spec/filters/keys_whitelist_spec.rb
+- spec/filters/root_directory_filter_spec.rb
+- spec/filters/system_exit_filter_spec.rb
 - spec/filters/thread_filter_spec.rb
 - spec/nested_exception_spec.rb
 - spec/notice_spec.rb
 - spec/notifier_spec.rb
-- spec/notifier_spec/blacklist_keys_spec.rb
 - spec/notifier_spec/options_spec.rb
-- spec/notifier_spec/whitelist_keys_spec.rb
-- spec/payload_truncator_spec.rb
 - spec/promise_spec.rb
 - spec/spec_helper.rb
 - spec/sync_sender_spec.rb
+- spec/truncator_spec.rb
 homepage: https://airbrake.io
 licenses:
 - MIT
@@ -180,15 +181,17 @@ test_files:
 - spec/config/validator_spec.rb
 - spec/config_spec.rb
 - spec/filter_chain_spec.rb
+- spec/filters/gem_root_filter_spec.rb
 - spec/filters/keys_blacklist_spec.rb
+- spec/filters/keys_whitelist_spec.rb
+- spec/filters/root_directory_filter_spec.rb
+- spec/filters/system_exit_filter_spec.rb
 - spec/filters/thread_filter_spec.rb
 - spec/nested_exception_spec.rb
 - spec/notice_spec.rb
-- spec/notifier_spec/blacklist_keys_spec.rb
 - spec/notifier_spec/options_spec.rb
-- spec/notifier_spec/whitelist_keys_spec.rb
 - spec/notifier_spec.rb
-- spec/payload_truncator_spec.rb
 - spec/promise_spec.rb
 - spec/spec_helper.rb
 - spec/sync_sender_spec.rb
+- spec/truncator_spec.rb

data/lib/airbrake-ruby/filters.rb

@@ -1,10 +0,0 @@
-module Airbrake
-  ##
-  # Represents a namespace for default Airbrake Ruby filters.
-  module Filters
-    ##
-    # @return [Array<Symbol>] parts of a Notice's payload that can be modified
-    #   by various filters
-    FILTERABLE_KEYS = %i[environment session params].freeze
-  end
-end

data/spec/notifier_spec/blacklist_keys_spec.rb

@@ -1,192 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe "Airbrake::Notifier blacklist_keys" do
-  def expect_a_request_with_body(body)
-    expect(a_request(:post, endpoint).with(body: body)).to have_been_made.once
-  end
-
-  let(:project_id) { 105138 }
-  let(:project_key) { 'fd04e13d806a90f96614ad8e529b2822' }
-  let(:localhost) { 'http://localhost:8080' }
-
-  let(:endpoint) do
-    "https://airbrake.io/api/v3/projects/#{project_id}/notices?key=#{project_key}"
-  end
-
-  let(:airbrake_params) do
-    { project_id: project_id,
-      project_key: project_key,
-      logger: Logger.new(StringIO.new) }
-  end
-
-  let(:ex) { AirbrakeTestError.new }
-
-  shared_examples 'blacklisting' do |keys, params|
-    it "filters out the value" do
-      blacklist = { blacklist_keys: keys }
-      notifier = Airbrake::Notifier.new(airbrake_params.merge(blacklist))
-
-      notifier.notify_sync(ex, params)
-
-      expect_a_request_with_body(expected_body)
-    end
-  end
-
-  shared_examples 'logging' do |keys, params|
-    it "logs the error" do
-      out = StringIO.new
-      blacklist = { blacklist_keys: keys, logger: Logger.new(out) }
-      notifier = Airbrake::Notifier.new(airbrake_params.merge(blacklist))
-
-      notifier.notify_sync(ex, params)
-
-      expect(out.string).to match(expected_output)
-    end
-  end
-
-  before do
-    stub_request(:post, endpoint).to_return(status: 201, body: '{}')
-  end
-
-  context "when blacklisting with a Regexp" do
-    let(:expected_body) { /"params":{"bingo":"\[Filtered\]".*}/ }
-    include_examples('blacklisting', [/\Abin/], bingo: 'bango')
-  end
-
-  context "when blacklisting with a Symbol" do
-    let(:expected_body) { /"params":{"bingo":"\[Filtered\]".*}/ }
-    include_examples('blacklisting', [:bingo], bingo: 'bango')
-  end
-
-  context "when blacklisting with a String" do
-    let(:expected_body) { /"params":{"bingo":"\[Filtered\]".*}/ }
-    include_examples('blacklisting', ['bingo'], bingo: 'bango')
-  end
-
-  context "when payload has a hash" do
-    context "and it is a non-recursive hash" do
-      let(:expected_body) { /"params":{"bongo":{"bish":"\[Filtered\]"}.*}/ }
-      include_examples('blacklisting', ['bish'], bongo: { bish: 'bash' })
-    end
-
-    context "and it is a recursive hash" do
-      let(:expected_body) { /"params":{"bingo":{"bango":"\[Filtered\]"}.*}/ }
-
-      bongo = { bingo: {} }
-      bongo[:bingo][:bango] = bongo
-
-      include_examples('blacklisting', ['bango'], bongo)
-    end
-  end
-
-  context "when there was invalid pattern provided" do
-    let(:expected_output) do
-      /ERROR.+KeysBlacklist is invalid.+patterns: \[#<Object:.+>\]/
-    end
-
-    include_examples('logging', [Object.new], bingo: 'bango')
-  end
-
-  context "when there was a proc provided, which returns an array of keys" do
-    let(:expected_body) { /"params":{"bingo":"\[Filtered\]","bongo":"bish".*}/ }
-    include_examples('blacklisting', [proc { 'bingo' }], bingo: 'bango', bongo: 'bish')
-  end
-
-  context "when there was a proc provided along with normal keys" do
-    let(:expected_body) do
-      /"params":{"bingo":"bango","bongo":"\[Filtered\]","bash":"\[Filtered\]".*}/
-    end
-
-    include_examples(
-      'blacklisting',
-      [proc { 'bongo' }, :bash],
-      bingo: 'bango', bongo: 'bish', bash: 'bosh'
-    )
-  end
-
-  context "when there was a proc provided, which doesn't return an array of keys" do
-    let(:expected_output) do
-      /ERROR.+KeysBlacklist is invalid.+patterns: \[#<Object:.+>\]/
-    end
-
-    include_examples('logging', [proc { Object.new }], bingo: 'bango')
-
-    it "doesn't blacklist keys" do
-      blacklist = { blacklist_keys: [proc { Object.new }] }
-      notifier = Airbrake::Notifier.new(airbrake_params.merge(blacklist))
-
-      notifier.notify_sync(ex, bingo: 'bango', bongo: 'bish')
-
-      expect_a_request_with_body(/"params":{"bingo":"bango","bongo":"bish".*}/)
-    end
-  end
-
-  context "when there was a proc provided, which returns another proc" do
-    context "when called once" do
-      let(:expected_output) do
-        /ERROR.+KeysBlacklist is invalid.+patterns: \[#<Proc:.+>\]/
-      end
-
-      include_examples('logging', [proc { proc { ['bingo'] } }], bingo: 'bango')
-    end
-
-    context "when called twice" do
-      it "unwinds procs and filters keys" do
-        blacklist = { blacklist_keys: [proc { proc { ['bingo'] } }] }
-        notifier = Airbrake::Notifier.new(airbrake_params.merge(blacklist))
-
-        notifier.notify_sync(ex, bingo: 'bango', bongo: 'bish')
-        notifier.notify_sync(ex, bingo: 'bango', bongo: 'bish')
-
-        expect_a_request_with_body(
-          /"params":{"bingo":"\[Filtered\]","bongo":"bish".*}/
-        )
-      end
-    end
-  end
-
-  it "filters query parameters correctly" do
-    blacklist = { blacklist_keys: ['bish'] }
-    notifier = Airbrake::Notifier.new(airbrake_params.merge(blacklist))
-
-    notice = notifier.build_notice(ex)
-    notice[:context][:url] = 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash&color=%23FFAAFF'
-
-    notifier.notify_sync(notice)
-
-    # rubocop:disable Metrics/LineLength
-    expected_body =
-      %r("context":{.*"url":"http://localhost:3000/crash\?foo=bar&baz=bongo&bish=\[Filtered\]&color=%23FFAAFF".*})
-    # rubocop:enable Metrics/LineLength
-
-    expect_a_request_with_body(expected_body)
-  end
-
-  context "when the user payload is present" do
-    context "and when the user key is ignored" do
-      it "filters out user entirely" do
-        blacklist = { blacklist_keys: ['user'] }
-        notifier = Airbrake::Notifier.new(airbrake_params.merge(blacklist))
-
-        notice = notifier.build_notice(ex)
-        notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
-
-        notifier.notify_sync(notice)
-
-        expect_a_request_with_body(/"user":"\[Filtered\]"/)
-      end
-    end
-
-    it "filters out individual user fields" do
-      blacklist = { blacklist_keys: ['name'] }
-      notifier = Airbrake::Notifier.new(airbrake_params.merge(blacklist))
-
-      notice = notifier.build_notice(ex)
-      notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
-
-      notifier.notify_sync(notice)
-
-      expect_a_request_with_body(/"user":{"id":1337,"name":"\[Filtered\]"}/)
-    end
-  end
-end

data/spec/notifier_spec/whitelist_keys_spec.rb

@@ -1,248 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe "Airbrake::Notifier whitelist_keys" do
-  def expect_a_request_with_body(body)
-    expect(a_request(:post, endpoint).with(body: body)).to have_been_made.once
-  end
-
-  let(:project_id) { 105138 }
-  let(:project_key) { 'fd04e13d806a90f96614ad8e529b2822' }
-  let(:localhost) { 'http://localhost:8080' }
-
-  let(:endpoint) do
-    "https://airbrake.io/api/v3/projects/#{project_id}/notices?key=#{project_key}"
-  end
-
-  let(:airbrake_params) do
-    { project_id: project_id,
-      project_key: project_key,
-      logger: Logger.new(StringIO.new) }
-  end
-
-  let(:ex) { AirbrakeTestError.new }
-
-  shared_examples 'whitelisting' do |keys, params|
-    it "filters everything but the value of the specified key" do
-      whitelist = { whitelist_keys: keys }
-      notifier = Airbrake::Notifier.new(airbrake_params.merge(whitelist))
-
-      notifier.notify_sync(ex, params)
-
-      expect_a_request_with_body(expected_body)
-    end
-  end
-
-  shared_examples 'logging' do |keys, params|
-    it "logs the error" do
-      out = StringIO.new
-      whitelist = { whitelist_keys: keys, logger: Logger.new(out) }
-      notifier = Airbrake::Notifier.new(airbrake_params.merge(whitelist))
-
-      notifier.notify_sync(ex, params)
-
-      expect(out.string).to match(expected_output)
-    end
-  end
-
-  before do
-    stub_request(:post, endpoint).to_return(status: 201, body: '{}')
-  end
-
-  context "when whitelisting with a Regexp" do
-    let(:expected_body) do
-      /"params":{"bingo":"bango","bongo":"\[Filtered\]","bash":"\[Filtered\]".*}/
-    end
-
-    include_examples(
-      'whitelisting',
-      [/\Abin/],
-      bingo: 'bango', bongo: 'bish', bash: 'bosh'
-    )
-  end
-
-  context "when whitelisting with a Symbol" do
-    let(:expected_body) do
-      /"params":{"bingo":"\[Filtered\]","bongo":"bish","bash":"\[Filtered\]".*}/
-    end
-
-    include_examples(
-      'whitelisting',
-      [:bongo],
-      bingo: 'bango', bongo: 'bish', bash: 'bosh'
-    )
-  end
-
-  context "when whitelisting with a String" do
-    let(:expected_body) do
-      /"params":{"bingo":"\[Filtered\]","bongo":"\[Filtered\]",
-         "bash":"bosh","bbashh":"\[Filtered\]".*}/x
-    end
-
-    include_examples(
-      'whitelisting',
-      ['bash'],
-      bingo: 'bango', bongo: 'bish', bash: 'bosh', bbashh: 'bboshh'
-    )
-  end
-
-  context "when payload has a hash" do
-    context "and it is a non-recursive hash" do
-      let(:expected_body) do
-        /"params":{"bingo":"\[Filtered\]","bongo":{"bish":"bash"}.*}/
-      end
-
-      include_examples(
-        'whitelisting',
-        %w[bongo bish],
-        bingo: 'bango', bongo: { bish: 'bash' }
-      )
-    end
-
-    context "and it is a recursive hash" do
-      it "errors when nested hashes are not filtered" do
-        whitelist = airbrake_params.merge(whitelist_keys: %w[bingo bango])
-        notifier = Airbrake::Notifier.new(whitelist)
-
-        bongo = { bingo: {} }
-        bongo[:bingo][:bango] = bongo
-
-        if RUBY_ENGINE == 'jruby'
-          # JRuby might raise two different exceptions, which represent the
-          # same thing. One is a Java exception, the other is a Ruby
-          # exception. It's probably a JRuby bug:
-          # https://github.com/jruby/jruby/issues/1903
-          begin
-            expect do
-              notifier.notify_sync(ex, bongo)
-            end.to raise_error(SystemStackError)
-          rescue RSpec::Expectations::ExpectationNotMetError
-            expect do
-              notifier.notify_sync(ex, bongo)
-            end.to raise_error(java.lang.StackOverflowError)
-          end
-        else
-          expect do
-            notifier.notify_sync(ex, bongo)
-          end.to raise_error(SystemStackError)
-        end
-      end
-    end
-  end
-
-  context "when there was a proc provided, which returns an array of keys" do
-    let(:expected_body) do
-      /"params":{"bingo":"\[Filtered\]","bongo":"bish","bash":"\[Filtered\]".*}/
-    end
-
-    include_examples(
-      'whitelisting',
-      [proc { 'bongo' }],
-      bingo: 'bango', bongo: 'bish', bash: 'bosh'
-    )
-  end
-
-  context "when there was a proc provided along with normal keys" do
-    let(:expected_body) do
-      /"params":{"bingo":"\[Filtered\]","bongo":"bish","bash":"bosh".*}/
-    end
-
-    include_examples(
-      'whitelisting',
-      [proc { 'bongo' }, :bash],
-      bingo: 'bango', bongo: 'bish', bash: 'bosh'
-    )
-  end
-
-  context "when there was a proc provided, which returns another proc" do
-    context "when called once" do
-      let(:expected_output) do
-        /ERROR.+KeysWhitelist is invalid.+patterns: \[#<Proc:.+>\]/
-      end
-
-      include_examples('logging', [proc { proc { ['bingo'] } }], bingo: 'bango')
-    end
-
-    context "when called twice" do
-      it "unwinds procs and filters keys" do
-        whitelist = { whitelist_keys: [proc { proc { ['bingo'] } }] }
-        notifier = Airbrake::Notifier.new(airbrake_params.merge(whitelist))
-
-        notifier.notify_sync(ex, bingo: 'bango', bongo: 'bish')
-        notifier.notify_sync(ex, bingo: 'bango', bongo: 'bish')
-
-        expect_a_request_with_body(
-          /"params":{"bingo":"bango","bongo":"\[Filtered\]".*}/
-        )
-      end
-    end
-  end
-
-  context "when there was a proc provided, which doesn't return an array of keys" do
-    let(:expected_output) do
-      /ERROR.+KeysWhitelist is invalid.+patterns: \[#<Object:.+>\]/
-    end
-
-    include_examples('logging', [proc { Object.new }], bingo: 'bango')
-
-    it "doesn't whitelist keys" do
-      whitelist = { whitelist_keys: [proc { Object.new }] }
-      notifier = Airbrake::Notifier.new(airbrake_params.merge(whitelist))
-
-      notifier.notify_sync(ex, bingo: 'bango', bongo: 'bish')
-
-      expect_a_request_with_body(
-        /"params":{"bingo":"\[Filtered\]","bongo":"\[Filtered\]".*}/
-      )
-    end
-  end
-
-  describe "context/url" do
-    let(:notifier) do
-      Airbrake::Notifier.new(airbrake_params.merge(whitelist_keys: %w[bish]))
-    end
-
-    context "given a standard URL" do
-      it "filters query parameters correctly" do
-        notice = notifier.build_notice(ex)
-        notice[:context][:url] = 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash'
-
-        notifier.notify_sync(notice)
-
-        expect_a_request_with_body(
-          # rubocop:disable Metrics/LineLength
-          %r("context":{.*"url":"http://localhost:3000/crash\?foo=\[Filtered\]&baz=\[Filtered\]&bish=bash".*})
-          # rubocop:enable Metrics/LineLength
-        )
-      end
-    end
-
-    context "given a non-standard URL" do
-      it "leaves the URL unfiltered" do
-        notice = notifier.build_notice(ex)
-        notice[:context][:url] =
-          'http://localhost:3000/cra]]]sh?foo=bar&baz=bongo&bish=bash'
-
-        notifier.notify_sync(notice)
-
-        expect_a_request_with_body(
-          # rubocop:disable Metrics/LineLength
-          %r("context":{.*"url":"http://localhost:3000/cra\]\]\]sh\?foo=bar&baz=bongo&bish=bash".*})
-          # rubocop:enable Metrics/LineLength
-        )
-      end
-    end
-
-    context "given a URL without a query" do
-      it "skips params filtering and leaves the URL untouched" do
-        notice = notifier.build_notice(ex)
-        notice[:context][:url] = 'http://localhost:3000/crash'
-
-        notifier.notify_sync(notice)
-
-        expect_a_request_with_body(
-          %r("context":{.*"url":"http://localhost:3000/crash".*})
-        )
-      end
-    end
-  end
-end