airbrake-ruby 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2498350f956db613816b9cf8ae1579a01b0ca940
-  data.tar.gz: 3bafaf42dc712d226ac97b3ad5690f923ff49cc6
+  metadata.gz: ab4ce2485ab1b938a76f15f2b71d92db0fe6e0e2
+  data.tar.gz: a48ae79d2523577c1400d2ed6b914e5340e9f5ff
 SHA512:
-  metadata.gz: 097a7a2681e0d28b020ea43a918b96ed0c89167a96d7b8146f27bac98682d95b61431ffe6eb1d78d278068b6321e4c28f196dec021c8a7fb7ed31c7e6465cc3d
-  data.tar.gz: 3cfdaaf798e0b85835126535434bb10bff78422b1b8890e924cf881b2b3843f0230eea43eaf6efdf0f9e3296941c2e85c217d71d6ed69b8caae3ae94be4baec7
+  metadata.gz: 05d26b46d931156979aa32411b8d722c46023056eee2d0545be53df86a26e5ee565640a59999ddd37d1b947db44f113ac6dc636df5e9b6cb800682d66ef87c55
+  data.tar.gz: ec26b798eb2c9139ffbd44a0bd42385886663fade0ddcab147ea0b6d68b94c4635813398fe9c2b0b4e87398d26099751d016900e3b026cfac79acd0dc29d9998

data/lib/airbrake-ruby.rb

@@ -69,6 +69,11 @@ module Airbrake
   #   for special cases where we need to work around older implementations
   RUBY_19 = RUBY_VERSION.start_with?('1.9')
 
+  ##
+  # @return [Boolean] true if current Ruby is Ruby 2.0.*. The result is used
+  #   for special cases where we need to work around older implementations
+  RUBY_20 = RUBY_VERSION.start_with?('2.0')
+
   ##
   # A Hash that holds all notifiers. The keys of the Hash are notifier
   # names, the values are Airbrake::Notifier instances.
@@ -188,42 +193,6 @@ module Airbrake
       call_notifier(notifier, __method__, filter, &block)
     end
 
-    ##
-    # Specifies which keys should *not* be filtered. All other keys will be
-    # substituted with the +[Filtered]+ label.
-    #
-    # @macro proxy_method
-    # @example
-    #   Airbrake.whitelist([:email, /user/i, 'account_id'])
-    #
-    # @param [Array<String, Symbol, Regexp>] keys The keys, which shouldn't be
-    #   filtered
-    # @return [void]
-    # @since v5.0.0
-    # @see .blacklist_keys
-    # @deprecated Please use {Airbrake::Config#whitelist_keys} instead
-    def whitelist_keys(keys, notifier = :default)
-      call_notifier(notifier, __method__, keys)
-    end
-
-    ##
-    # Specifies which keys *should* be filtered. Such keys will be replaced with
-    # the +[Filtered]+ label.
-    #
-    # @macro proxy_method
-    # @example
-    #   Airbrake.blacklist_keys([:email, /credit/i, 'password'])
-    #
-    # @param [Array<String, Symbol, Regexp>] keys The keys, which should be
-    #   filtered
-    # @return [void]
-    # @since v5.0.0
-    # @see .whitelist_keys
-    # @deprecated Please use {Airbrake::Config#blacklist_keys} instead
-    def blacklist_keys(keys, notifier = :default)
-      call_notifier(notifier, __method__, keys)
-    end
-
     ##
     # Builds an Airbrake notice. This is useful, if you want to add or modify a
     # value only for a specific notice. When you're done modifying the notice,

data/lib/airbrake-ruby/backtrace.rb

@@ -151,7 +151,7 @@ module Airbrake
         return false unless defined?(ExecJS::RuntimeError)
         return true if exception.is_a?(ExecJS::RuntimeError)
 
-        if Airbrake::RUBY_19
+        if Airbrake::RUBY_19 || Airbrake::RUBY_20
           # Ruby 1.9 doesn't support Exception#cause. We work around this by
           # parsing backtraces. It's slow, so we check only a few first frames.
           exception.backtrace[0..2].each do |frame|

data/lib/airbrake-ruby/filters/keys_blacklist.rb

@@ -2,7 +2,7 @@ module Airbrake
   module Filters
     ##
     # A default Airbrake notice filter. Filters only specific keys listed in the
-    # list of parameters in the modifiable payload of a notice.
+    # list of parameters in the payload of a notice.
     #
     # @example
     #   filter = Airbrake::Filters::KeysBlacklist.new(:email, /credit/i, 'password')

data/lib/airbrake-ruby/filters/keys_filter.rb

@@ -13,13 +13,20 @@ module Airbrake
       # @return [String] The label to replace real values of filtered payload
       FILTERED = '[Filtered]'.freeze
 
+      ##
+      # @return [Array<String,Symbol,Regexp>] the array of classes instances of
+      #   which can compared with payload keys
+      VALID_PATTERN_CLASSES = [String, Symbol, Regexp].freeze
+
       ##
       # Creates a new KeysBlacklist or KeysWhitelist filter that uses the given
       # +patterns+ for filtering a notice's payload.
       #
       # @param [Array<String,Regexp,Symbol>] patterns
-      def initialize(*patterns)
+      def initialize(logger, *patterns)
+        @logger = logger
         @patterns = patterns
+        @valid_patterns = false
       end
 
       ##
@@ -30,6 +37,11 @@ module Airbrake
       # @return [void]
       # @see FilterChain
       def call(notice)
+        unless @valid_patterns
+          eval_proc_patterns!
+          validate_patterns
+        end
+
         FILTERABLE_KEYS.each { |key| filter_hash(notice[key]) }
 
         if notice[:context][:user]
@@ -86,6 +98,28 @@ module Airbrake
         return unless url.query
         notice[:context][:url] = filter_url_params(url)
       end
+
+      def eval_proc_patterns!
+        return unless @patterns.any? { |pattern| pattern.is_a?(Proc) }
+
+        @patterns = @patterns.flat_map do |pattern|
+          next(pattern) unless pattern.respond_to?(:call)
+          pattern.call
+        end
+      end
+
+      def validate_patterns
+        @valid_patterns = @patterns.all? do |pattern|
+          VALID_PATTERN_CLASSES.any? { |c| pattern.is_a?(c) }
+        end
+
+        return if @valid_patterns
+
+        @logger.error(
+          "#{LOG_LABEL} one of the patterns in #{self.class} is invalid. " \
+          "Known patterns: #{@patterns}"
+        )
+      end
     end
   end
 end

data/lib/airbrake-ruby/filters/keys_whitelist.rb

@@ -1,8 +1,8 @@
 module Airbrake
   module Filters
     ##
-    # A default Airbrake notice filter. Filters everything in the modifiable
-    # payload of a notice, but specified keys.
+    # A default Airbrake notice filter. Filters everything in the payload of a
+    # notice, but specified keys.
     #
     # @example
     #   filter = Airbrake::Filters::KeysWhitelist.new(:email, /user/i, 'account_id')

data/lib/airbrake-ruby/notice.rb

@@ -57,17 +57,14 @@ module Airbrake
     def initialize(config, exception, params = {})
       @config = config
 
-      @private_payload = {
-        notifier: NOTIFIER
-      }.freeze
-
-      @modifiable_payload = {
+      @payload = {
         errors: NestedException.new(exception, @config.logger).as_json,
         context: context(params),
         environment: {},
         session: {},
         params: params
       }
+
       extract_custom_attributes(exception)
 
       @truncator = PayloadTruncator.new(PAYLOAD_MAX_SIZE, @config.logger)
@@ -82,7 +79,7 @@ module Airbrake
     def to_json
       loop do
         begin
-          json = payload.to_json
+          json = @payload.to_json
         rescue *JSON_EXCEPTIONS => ex
           @config.logger.debug("#{LOG_LABEL} `notice.to_json` failed: #{ex.class}: #{ex}")
         else
@@ -100,7 +97,7 @@ module Airbrake
     # @see #ignored?
     # @note Ignored noticed can't be unignored
     def ignore!
-      @modifiable_payload = nil
+      @payload = nil
     end
 
     ##
@@ -109,21 +106,21 @@ module Airbrake
     # @return [Boolean]
     # @see #ignore!
     def ignored?
-      @modifiable_payload.nil?
+      @payload.nil?
     end
 
     ##
-    # Reads a value from notice's modifiable payload.
+    # Reads a value from notice's payload.
     # @return [Object]
     #
     # @raise [Airbrake::Error] if the notice is ignored
     def [](key)
       raise_if_ignored
-      @modifiable_payload[key]
+      @payload[key]
     end
 
     ##
-    # Writes a value to the modifiable payload hash. Restricts unrecognized
+    # Writes a value to the payload hash. Restricts unrecognized
     # writes.
     # @example
     #   notice[:params][:my_param] = 'foobar'
@@ -137,7 +134,7 @@ module Airbrake
       raise_if_unrecognized_key(key)
       raise_if_non_hash_value(value)
 
-      @modifiable_payload[key] = value.to_hash
+      @payload[key] = value.to_hash
     end
 
     private
@@ -178,17 +175,13 @@ module Airbrake
       raise Airbrake::Error, "Got #{value.class} value, wanted a Hash"
     end
 
-    def payload
-      @modifiable_payload.merge(@private_payload)
-    end
-
     def truncate_payload
-      @modifiable_payload[:errors].each do |error|
+      @payload[:errors].each do |error|
         @truncator.truncate_error(error)
       end
 
       Filters::FILTERABLE_KEYS.each do |key|
-        @truncator.truncate_object(@modifiable_payload[key])
+        @truncator.truncate_object(@payload[key])
       end
 
       new_max_size = @truncator.reduce_max_size
@@ -196,7 +189,7 @@ module Airbrake
         @config.logger.error(
           "#{LOG_LABEL} truncation failed. File an issue at " \
           "https://github.com/airbrake/airbrake-ruby " \
-          "and attach the following payload: #{payload}"
+          "and attach the following payload: #{@payload}"
         )
       end
 
@@ -218,7 +211,7 @@ module Airbrake
       return unless attributes
 
       begin
-        @modifiable_payload.merge!(attributes)
+        @payload.merge!(attributes)
       rescue TypeError
         @config.logger.error(
           "#{LOG_LABEL} #{exception.class}#to_airbrake failed:" \

data/lib/airbrake-ruby/notifier.rb

@@ -36,13 +36,7 @@ module Airbrake
 
       @filter_chain = FilterChain.new(@config)
 
-      if @config.blacklist_keys.any?
-        add_filter(Filters::KeysBlacklist.new(*@config.blacklist_keys))
-      end
-
-      if @config.whitelist_keys.any?
-        add_filter(Filters::KeysWhitelist.new(*@config.whitelist_keys))
-      end
+      add_filters_for_config_keys
 
       @async_sender = AsyncSender.new(@config)
       @sync_sender = SyncSender.new(@config)
@@ -71,28 +65,6 @@ module Airbrake
       @filter_chain.add_filter(block_given? ? block : filter)
     end
 
-    ##
-    # @macro see_public_api_method
-    # @deprecated Please use {Airbrake::Config#whitelist_keys} instead
-    def whitelist_keys(keys)
-      @config.logger.warn(
-        "#{LOG_LABEL} Airbrake.whitelist_keys is deprecated. Please use the " \
-        "whitelist_keys option instead (https://goo.gl/sQwpYN)"
-      )
-      add_filter(Filters::KeysWhitelist.new(*keys))
-    end
-
-    ##
-    # @macro see_public_api_method
-    # @deprecated Please use {Airbrake::Config#blacklist_keys} instead
-    def blacklist_keys(keys)
-      @config.logger.warn(
-        "#{LOG_LABEL} Airbrake.blacklist_keys is deprecated. Please use the " \
-        "blacklist_keys option instead (https://goo.gl/jucrFt)"
-      )
-      add_filter(Filters::KeysBlacklist.new(*keys))
-    end
-
     ##
     # @macro see_public_api_method
     def build_notice(exception, params = {})
@@ -171,5 +143,15 @@ module Airbrake
       return caller_copy if clean_bt.empty?
       clean_bt
     end
+
+    def add_filters_for_config_keys
+      if @config.blacklist_keys.any?
+        add_filter(Filters::KeysBlacklist.new(@config.logger, *@config.blacklist_keys))
+      end
+
+      return if @config.whitelist_keys.none?
+
+      add_filter(Filters::KeysWhitelist.new(@config.logger, *@config.whitelist_keys))
+    end
   end
 end

data/lib/airbrake-ruby/sync_sender.rb

@@ -67,12 +67,10 @@ module Airbrake
     end
 
     def proxy_params
-      if @config.proxy.key?(:host)
-        [@config.proxy[:host],
-         @config.proxy[:port],
-         @config.proxy[:user],
-         @config.proxy[:password]]
-      end
+      return unless @config.proxy.key?(:host)
+
+      [@config.proxy[:host], @config.proxy[:port], @config.proxy[:user],
+       @config.proxy[:password]]
     end
   end
 end

data/lib/airbrake-ruby/version.rb

@@ -4,5 +4,5 @@
 module Airbrake
   ##
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '1.5.0'.freeze
+  AIRBRAKE_RUBY_VERSION = '1.6.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -176,14 +176,6 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe ".whitelist_keys" do
-    include_examples 'non-configured notifier handling', :whitelist_keys
-  end
-
-  describe ".blacklist_keys" do
-    include_examples 'non-configured notifier handling', :blacklist_keys
-  end
-
   describe ".build_notice" do
     include_examples 'non-configured notifier handling', :build_notice
   end

data/spec/notifier_spec.rb

@@ -472,268 +472,6 @@ RSpec.describe Airbrake::Notifier do
     end
   end
 
-  describe "#blacklist_keys" do
-    describe "the list of arguments" do
-      it "accepts regexps" do
-        @airbrake.blacklist_keys(/\Abin/)
-
-        @airbrake.notify_sync(ex, bingo: 'bango')
-
-        expect(
-          a_request(:post, endpoint).
-          with(body: /"params":{"bingo":"\[Filtered\]"}/)
-        ).to have_been_made.once
-      end
-
-      it "accepts symbols" do
-        @airbrake.blacklist_keys(:bingo)
-
-        @airbrake.notify_sync(ex, bingo: 'bango')
-
-        expect(
-          a_request(:post, endpoint).
-          with(body: /"params":{"bingo":"\[Filtered\]"}/)
-        ).to have_been_made.once
-      end
-
-      it "accepts strings" do
-        @airbrake.blacklist_keys('bingo')
-
-        @airbrake.notify_sync(ex, bingo: 'bango', bbingoo: 'bbangoo')
-
-        expect(
-          a_request(:post, endpoint).
-          with(body: /"params":{"bingo":"\[Filtered\]","bbingoo":"bbangoo"}/)
-        ).to have_been_made.once
-      end
-    end
-
-    describe "hash values" do
-      context "non-recursive" do
-        it "filters nested hashes" do
-          @airbrake.blacklist_keys('bish')
-
-          @airbrake.notify_sync(ex, bongo: { bish: 'bash' })
-
-          expect(
-            a_request(:post, endpoint).
-            with(body: /"params":{"bongo":{"bish":"\[Filtered\]"}}/)
-          ).to have_been_made.once
-        end
-      end
-
-      context "recursive" do
-        it "filters recursive hashes" do
-          @airbrake.blacklist_keys('bango')
-
-          bongo = { bingo: {} }
-          bongo[:bingo][:bango] = bongo
-
-          @airbrake.notify_sync(ex, bongo)
-
-          expect(
-            a_request(:post, endpoint).
-            with(body: /"params":{"bingo":{"bango":"\[Filtered\]"}}/)
-          ).to have_been_made.once
-        end
-      end
-    end
-
-    it "filters query parameters correctly" do
-      @airbrake.blacklist_keys(%w(bish))
-
-      notice = @airbrake.build_notice(ex)
-      notice[:context][:url] = 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash&color=%23FFAAFF'
-
-      @airbrake.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(:post, endpoint).
-        with(body: expected_body)
-      ).to have_been_made.once
-    end
-
-    it "filters out user" do
-      @airbrake.blacklist_keys('user')
-
-      notice = @airbrake.build_notice(ex)
-      notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
-
-      @airbrake.notify_sync(notice)
-
-      expect_a_request_with_body(/"user":"\[Filtered\]"/)
-    end
-
-    it "filters out individual user fields" do
-      @airbrake.blacklist_keys('name')
-
-      notice = @airbrake.build_notice(ex)
-      notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
-
-      @airbrake.notify_sync(notice)
-
-      expect_a_request_with_body(/"user":{"id":1337,"name":"\[Filtered\]"}/)
-    end
-  end
-
-  describe "#whitelist_keys" do
-    describe "the list of arguments" do
-      it "accepts regexes" do
-        @airbrake.whitelist_keys(/\Abin/)
-
-        @airbrake.notify_sync(ex, bingo: 'bango', bongo: 'bish', bash: 'bosh')
-
-        body = /"params":{"bingo":"bango","bongo":"\[Filtered\]","bash":"\[Filtered\]"}/
-
-        expect(
-          a_request(:post, endpoint).
-          with(body: body)
-        ).to have_been_made.once
-      end
-
-      it "accepts symbols" do
-        @airbrake.whitelist_keys(:bongo)
-
-        @airbrake.notify_sync(ex, bingo: 'bango', bongo: 'bish', bash: 'bosh')
-
-        body = /"params":{"bingo":"\[Filtered\]","bongo":"bish","bash":"\[Filtered\]"}/
-
-        expect(
-          a_request(:post, endpoint).
-          with(body: body)
-        ).to have_been_made.once
-      end
-
-      it "accepts strings" do
-        @airbrake.whitelist_keys('bash')
-
-        @airbrake.notify_sync(
-          ex,
-          bingo: 'bango',
-          bongo: 'bish',
-          bash: 'bosh',
-          bbashh: 'bboshh'
-        )
-
-        expect(
-          a_request(:post, endpoint).
-          with(
-            body: /"params":{"bingo":"\[Filtered\]","bongo":"\[Filtered\]",
-                   "bash":"bosh","bbashh":"\[Filtered\]"}/x
-          )
-        ).to have_been_made.once
-      end
-    end
-
-    describe "hash values" do
-      context "non-recursive" do
-        it "filters out everything but the provided keys" do
-          @airbrake.whitelist_keys(%w(bongo bish))
-
-          @airbrake.notify_sync(ex, bingo: 'bango', bongo: { bish: 'bash' })
-
-          expect(
-            a_request(:post, endpoint).
-            with(body: /"params":{"bingo":"\[Filtered\]","bongo":{"bish":"bash"}}/)
-          ).to have_been_made.once
-        end
-      end
-
-      context "recursive" do
-        it "errors when nested hashes are not filtered" do
-          @airbrake.whitelist_keys(%w(bingo bango))
-
-          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
-                @airbrake.notify_sync(ex, bongo)
-              end.to raise_error(SystemStackError)
-            rescue RSpec::Expectations::ExpectationNotMetError
-              expect do
-                @airbrake.notify_sync(ex, bongo)
-              end.to raise_error(java.lang.StackOverflowError)
-            end
-          else
-            expect do
-              @airbrake.notify_sync(ex, bongo)
-            end.to raise_error(SystemStackError)
-          end
-        end
-      end
-    end
-
-    describe "context/url" do
-      it "filters query parameters correctly" do
-        @airbrake.whitelist_keys(%w(bish))
-
-        notice = @airbrake.build_notice(ex)
-        notice[:context][:url] = 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash'
-
-        @airbrake.notify_sync(notice)
-
-        # rubocop:disable Metrics/LineLength
-        expected_body =
-          %r("context":{.*"url":"http://localhost:3000/crash\?foo=\[Filtered\]&baz=\[Filtered\]&bish=bash".*})
-        # rubocop:enable Metrics/LineLength
-
-        expect(
-          a_request(:post, endpoint).
-          with(body: expected_body)
-        ).to have_been_made.once
-      end
-
-      context "given a non-standard URL" do
-        it "leaves the URL unfiltered" do
-          @airbrake.whitelist_keys(%w(bish))
-
-          notice = @airbrake.build_notice(ex)
-          notice[:context][:url] =
-            'http://localhost:3000/cra]]]sh?foo=bar&baz=bongo&bish=bash'
-
-          @airbrake.notify_sync(notice)
-
-          # rubocop:disable Metrics/LineLength
-          expected_body =
-            %r("context":{.*"url":"http://localhost:3000/cra\]\]\]sh\?foo=bar&baz=bongo&bish=bash".*})
-          # rubocop:enable Metrics/LineLength
-
-          expect(
-            a_request(:post, endpoint).
-            with(body: expected_body)
-          ).to have_been_made.once
-        end
-      end
-
-      context "given a URL without a query" do
-        it "skips params filtering and leaves the URL untouched" do
-          @airbrake.whitelist_keys(%w(bish))
-
-          notice = @airbrake.build_notice(ex)
-          notice[:context][:url] = 'http://localhost:3000/crash'
-
-          @airbrake.notify_sync(notice)
-
-          expect(
-            a_request(:post, endpoint).
-            with(body: %r("context":{.*"url":"http://localhost:3000/crash".*}))
-          ).to have_been_made.once
-        end
-      end
-    end
-  end
-
   describe "#build_notice" do
     it "builds a notice from exception" do
       expect(@airbrake.build_notice(ex)).to be_an Airbrake::Notice

data/spec/notifier_spec/blacklist_keys_spec.rb

@@ -0,0 +1,192 @@
+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/options_spec.rb

@@ -225,200 +225,5 @@ RSpec.describe Airbrake::Notifier do
         include_examples 'sent notice', environment: :development
       end
     end
-
-    describe ":blacklist_keys" do
-      describe "the list of values" do
-        it "accepts regexps" do
-          params = { blacklist_keys: [/\Abin/] }
-          airbrake = described_class.new(airbrake_params.merge(params))
-
-          airbrake.notify_sync(ex, bingo: 'bango')
-
-          expect_a_request_with_body(/"params":{"bingo":"\[Filtered\]"}/)
-        end
-
-        it "accepts symbols" do
-          params = { blacklist_keys: [:bingo] }
-          airbrake = described_class.new(airbrake_params.merge(params))
-
-          airbrake.notify_sync(ex, bingo: 'bango')
-
-          expect_a_request_with_body(/"params":{"bingo":"\[Filtered\]"}/)
-        end
-
-        it "accepts strings" do
-          params = { blacklist_keys: ['bingo'] }
-          airbrake = described_class.new(airbrake_params.merge(params))
-
-          airbrake.notify_sync(ex, bingo: 'bango')
-
-          expect_a_request_with_body(/"params":{"bingo":"\[Filtered\]"}/)
-        end
-      end
-
-      describe "hash values" do
-        context "non-recursive" do
-          it "filters nested hashes" do
-            params = { blacklist_keys: ['bish'] }
-            airbrake = described_class.new(airbrake_params.merge(params))
-
-            airbrake.notify_sync(ex, bongo: { bish: 'bash' })
-
-            expect_a_request_with_body(/"params":{"bongo":{"bish":"\[Filtered\]"}}/)
-          end
-        end
-
-        context "recursive" do
-          it "filters recursive hashes" do
-            params = { blacklist_keys: ['bango'] }
-            airbrake = described_class.new(airbrake_params.merge(params))
-
-            bongo = { bingo: {} }
-            bongo[:bingo][:bango] = bongo
-
-            airbrake.notify_sync(ex, bongo)
-
-            expect_a_request_with_body(/"params":{"bingo":{"bango":"\[Filtered\]"}}/)
-          end
-        end
-      end
-
-      it "filters query parameters correctly" do
-        params = { blacklist_keys: ['bish'] }
-        airbrake = described_class.new(airbrake_params.merge(params))
-
-        notice = airbrake.build_notice(ex)
-        notice[:context][:url] = 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash&color=%23FFAAFF'
-
-        airbrake.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
-
-      it "filters out user" do
-        params = { blacklist_keys: ['user'] }
-        airbrake = described_class.new(airbrake_params.merge(params))
-
-        notice = airbrake.build_notice(ex)
-        notice[:context][:user] = { id: 1337, name: 'Bingo Bango' }
-
-        airbrake.notify_sync(notice)
-
-        expect_a_request_with_body(/"user":"\[Filtered\]"/)
-      end
-    end
-
-    describe ":whitelist_keys" do
-      describe "the list of values" do
-        it "accepts regexes" do
-          params = { whitelist_keys: [/\Abin/] }
-          airbrake = described_class.new(airbrake_params.merge(params))
-
-          airbrake.notify_sync(ex, bingo: 'bango', bongo: 'bish', bash: 'bosh')
-
-          expect_a_request_with_body(
-            /"params":{"bingo":"bango","bongo":"\[Filtered\]","bash":"\[Filtered\]"}/
-          )
-        end
-
-        it "accepts symbols" do
-          params = { whitelist_keys: [:bongo] }
-          airbrake = described_class.new(airbrake_params.merge(params))
-
-          airbrake.notify_sync(ex, bingo: 'bango', bongo: 'bish', bash: 'bosh')
-
-          expect_a_request_with_body(
-            /"params":{"bingo":"\[Filtered\]","bongo":"bish","bash":"\[Filtered\]"}/
-          )
-        end
-
-        it "accepts strings" do
-          params = { whitelist_keys: ['bash'] }
-          airbrake = described_class.new(airbrake_params.merge(params))
-
-          airbrake.notify_sync(
-            ex,
-            bingo: 'bango',
-            bongo: 'bish',
-            bash: 'bosh',
-            bbashh: 'bboshh'
-          )
-
-          expect_a_request_with_body(
-            /"params":{"bingo":"\[Filtered\]","bongo":"\[Filtered\]",
-                       "bash":"bosh","bbashh":"\[Filtered\]"}/x
-          )
-        end
-      end
-
-      describe "hash values" do
-        context "non-recursive" do
-          it "filters out everything but the provided keys" do
-            params = { whitelist_keys: %w(bongo bish) }
-            airbrake = described_class.new(airbrake_params.merge(params))
-
-            airbrake.notify_sync(ex, bingo: 'bango', bongo: { bish: 'bash' })
-
-            expect_a_request_with_body(
-              /"params":{"bingo":"\[Filtered\]","bongo":{"bish":"bash"}}/
-            )
-          end
-        end
-
-        context "recursive" do
-          it "errors when nested hashes are not filtered" do
-            params = { whitelist_keys: %w(bingo bango) }
-            airbrake = described_class.new(airbrake_params.merge(params))
-
-            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
-                  airbrake.notify_sync(ex, bongo)
-                end.to raise_error(SystemStackError)
-              rescue RSpec::Expectations::ExpectationNotMetError
-                expect do
-                  airbrake.notify_sync(ex, bongo)
-                end.to raise_error(java.lang.StackOverflowError)
-              end
-            else
-              expect do
-                airbrake.notify_sync(ex, bongo)
-              end.to raise_error(SystemStackError)
-            end
-          end
-        end
-      end
-
-      describe "context/url" do
-        it "filters query parameters correctly" do
-          params = { whitelist_keys: %w(bish) }
-          airbrake = described_class.new(airbrake_params.merge(params))
-
-          notice = airbrake.build_notice(ex)
-          notice[:context][:url] = 'http://localhost:3000/crash?foo=bar&baz=bongo&bish=bash'
-
-          airbrake.notify_sync(notice)
-
-          # rubocop:disable Metrics/LineLength
-          expected_body =
-            %r("context":{.*"url":"http://localhost:3000/crash\?foo=\[Filtered\]&baz=\[Filtered\]&bish=bash".*})
-          # rubocop:enable Metrics/LineLength
-
-          expect_a_request_with_body(expected_body)
-        end
-      end
-    end
   end
 end

data/spec/notifier_spec/whitelist_keys_spec.rb

@@ -0,0 +1,246 @@
+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) { /"params":{"bingo":"\[Filtered\]","bongo":{"bish":"bash"}}/ }
+
+      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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +121,9 @@ files:
 - 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/spec_helper.rb
 - spec/sync_sender_spec.rb
@@ -158,7 +160,9 @@ test_files:
 - spec/filter_chain_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/spec_helper.rb