airbrake-ruby 4.14.1 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a99b9f69c92aab19bd33806452b720f4e193578d5ffa22f79faa780c38d9fa0
-  data.tar.gz: 6e19717eef99f7446b8f2e50e79e2eea6787d2b283c0a291821f09ab5e227a8f
+  metadata.gz: 9737dfd8078f14a0150525e1c8b226bcaa5bb87e7627542d7a1a25a27d3c191d
+  data.tar.gz: 653ff8929bc7199a77c59ead004167a38d214741157282d93e947c3d5ca8ecd6
 SHA512:
-  metadata.gz: 8ece3a704ef7a11e8994e657e53526c684da53316cc609ff8efc05e5b14cf6eca8b2536233a8ab0bfd8c6bc0997f7c97a9ef073967a8fd85b69f960db9db5757
-  data.tar.gz: 28b983d5c3b2b3e7d2a31c5429ffb72b06103569444411c5e7231c76ce308ef143140f40d215401b178aa2022f912914ef7c3f7b14ec4f01c75398342dda97c0
+  metadata.gz: 21d60bd1415bec1e0ed3b89891f5b35e56f019b09dcb50c05f1e55b2176a2976a566c95e0a3fc4cdce2601a1b4b0e786b1ddbcc67188da6df51bd5c94188e54d
+  data.tar.gz: 3c3b2312b7945685c6199ecd21f23601b752e1d4234d35461db2f4c7cf0318c24ee263df2536e9cffb7e107002a5a5be10af1cf7eecc16ac65e07cd948f2c68e

data/lib/airbrake-ruby.rb

@@ -24,8 +24,8 @@ require 'airbrake-ruby/notice'
 require 'airbrake-ruby/backtrace'
 require 'airbrake-ruby/truncator'
 require 'airbrake-ruby/filters/keys_filter'
-require 'airbrake-ruby/filters/keys_whitelist'
-require 'airbrake-ruby/filters/keys_blacklist'
+require 'airbrake-ruby/filters/keys_allowlist'
+require 'airbrake-ruby/filters/keys_blocklist'
 require 'airbrake-ruby/filters/gem_root_filter'
 require 'airbrake-ruby/filters/system_exit_filter'
 require 'airbrake-ruby/filters/root_directory_filter'
@@ -572,14 +572,14 @@ module Airbrake
 
     # rubocop:disable Metrics/AbcSize
     def process_config_options(config)
-      if config.blacklist_keys.any?
-        blacklist = Airbrake::Filters::KeysBlacklist.new(config.blacklist_keys)
-        notice_notifier.add_filter(blacklist)
+      if config.blocklist_keys.any?
+        blocklist = Airbrake::Filters::KeysBlocklist.new(config.blocklist_keys)
+        notice_notifier.add_filter(blocklist)
       end
 
-      if config.whitelist_keys.any?
-        whitelist = Airbrake::Filters::KeysWhitelist.new(config.whitelist_keys)
-        notice_notifier.add_filter(whitelist)
+      if config.allowlist_keys.any?
+        allowlist = Airbrake::Filters::KeysAllowlist.new(config.allowlist_keys)
+        notice_notifier.add_filter(allowlist)
       end
 
       return unless config.root_directory

data/lib/airbrake-ruby/config.rb

@@ -68,14 +68,20 @@ module Airbrake
     # @return [Array<String, Symbol, Regexp>] the keys, which should be
     #   filtered
     # @api public
-    # @since v1.2.0
-    attr_accessor :blacklist_keys
+    # @since v4.15.0
+    attr_accessor :allowlist_keys
 
-    # @return [Array<String, Symbol, Regexp>] the keys, which shouldn't be
+    # @deprecated Use allowlist_keys instead
+    alias whitelist_keys allowlist_keys
+
+    # @return [Array<String, Symbol, Regexp>] the keys, which should be
     #   filtered
     # @api public
-    # @since v1.2.0
-    attr_accessor :whitelist_keys
+    # @since v4.15.0
+    attr_accessor :blocklist_keys
+
+    # @deprecated Use blocklist_keys instead
+    alias blacklist_keys blocklist_keys
 
     # @return [Boolean] true if the library should attach code hunks to each
     #   frame in a backtrace, false otherwise
@@ -134,8 +140,8 @@ module Airbrake
 
       self.timeout = user_config[:timeout]
 
-      self.blacklist_keys = []
-      self.whitelist_keys = []
+      self.blocklist_keys = []
+      self.allowlist_keys = []
 
       self.root_directory = File.realpath(
         (defined?(Bundler) && Bundler.root) ||
@@ -152,6 +158,24 @@ module Airbrake
     end
     # rubocop:enable Metrics/AbcSize
 
+    def blacklist_keys=(keys)
+      loc = caller_locations(1..1).first
+      Kernel.warn(
+        "#{loc.path}:#{loc.lineno}: warning: blacklist_keys= is deprecated " \
+        "use blocklist_keys= instead",
+      )
+      self.blocklist_keys = keys
+    end
+
+    def whitelist_keys=(keys)
+      loc = caller_locations(1..1).first
+      Kernel.warn(
+        "#{loc.path}:#{loc.lineno}: warning: whitelist_keys= is deprecated " \
+        "use allowlist_keys= instead",
+      )
+      self.allowlist_keys = keys
+    end
+
     # The full URL to the Airbrake Notice API. Based on the +:host+ option.
     # @return [URI] the endpoint address
     def endpoint

data/lib/airbrake-ruby/filters/{keys_whitelist.rb → keys_allowlist.rb}

@@ -4,7 +4,7 @@ module Airbrake
     # notice, but specified keys.
     #
     # @example
-    #   filter = Airbrake::Filters::KeysBlacklist.new(
+    #   filter = Airbrake::Filters::KeysAllowlist.new(
     #     [:email, /credit/i, 'password']
     #   )
     #   airbrake.add_filter(filter)
@@ -22,9 +22,9 @@ module Airbrake
     #   #     email: 'john@example.com',
     #   #     account_id: 42 }
     #
-    # @see KeysBlacklist
+    # @see KeysBlocklist
     # @see KeysFilter
-    class KeysWhitelist
+    class KeysAllowlist
       include KeysFilter
 
       def initialize(*)

data/lib/airbrake-ruby/filters/{keys_blacklist.rb → keys_blocklist.rb}

@@ -4,7 +4,7 @@ module Airbrake
     # list of parameters in the payload of a notice.
     #
     # @example
-    #   filter = Airbrake::Filters::KeysBlacklist.new(
+    #   filter = Airbrake::Filters::KeysBlocklist.new(
     #     [:email, /credit/i, 'password']
     #   )
     #   airbrake.add_filter(filter)
@@ -22,10 +22,10 @@ module Airbrake
     #   #     email: '[Filtered]',
     #   #     credit_card: '[Filtered]' }
     #
-    # @see KeysWhitelist
+    # @see KeysAllowlist
     # @see KeysFilter
     # @api private
-    class KeysBlacklist
+    class KeysBlocklist
       include KeysFilter
 
       def initialize(*)

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

@@ -7,8 +7,8 @@ module Airbrake
     # class that includes this module must implement.
     #
     # @see Notice
-    # @see KeysWhitelist
-    # @see KeysBlacklist
+    # @see KeysAllowlist
+    # @see KeysBlocklist
     # @api private
     module KeysFilter
       # @return [String] The label to replace real values of filtered payload
@@ -19,11 +19,11 @@ module Airbrake
       VALID_PATTERN_CLASSES = [String, Symbol, Regexp].freeze
 
       # @return [Array<Symbol>] parts of a Notice's payload that can be modified
-      #   by blacklist/whitelist filters
+      #   by blocklist/allowlist filters
       FILTERABLE_KEYS = %i[environment session params].freeze
 
       # @return [Array<Symbol>] parts of a Notice's *context* payload that can
-      #   be modified by blacklist/whitelist filters
+      #   be modified by blocklist/allowlist filters
       FILTERABLE_CONTEXT_KEYS = %i[
         user
 
@@ -42,7 +42,7 @@ module Airbrake
       # @return [Integer]
       attr_reader :weight
 
-      # Creates a new KeysBlacklist or KeysWhitelist filter that uses the given
+      # Creates a new KeysBlocklist or KeysAllowlist filter that uses the given
       # +patterns+ for filtering a notice's payload.
       #
       # @param [Array<String,Regexp,Symbol>] patterns

data/lib/airbrake-ruby/version.rb

@@ -2,5 +2,5 @@
 # More information: http://semver.org/
 module Airbrake
   # @return [String] the library version
-  AIRBRAKE_RUBY_VERSION = '4.14.1'.freeze
+  AIRBRAKE_RUBY_VERSION = '4.15.0'.freeze
 end

data/spec/airbrake_spec.rb

@@ -99,33 +99,33 @@ RSpec.describe Airbrake do
       end
     end
 
-    context "when blacklist_keys gets configured" do
+    context "when blocklist_keys gets configured" do
       before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
 
-      it "adds blacklist filter" do
+      it "adds blocklist filter" do
         expect(Airbrake.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::KeysBlacklist))
-        described_class.configure { |c| c.blacklist_keys = %w[password] }
+          .with(an_instance_of(Airbrake::Filters::KeysBlocklist))
+        described_class.configure { |c| c.blocklist_keys = %w[password] }
       end
 
-      it "initializes blacklist with specified parameters" do
-        expect(Airbrake::Filters::KeysBlacklist).to receive(:new).with(%w[password])
-        described_class.configure { |c| c.blacklist_keys = %w[password] }
+      it "initializes blocklist with specified parameters" do
+        expect(Airbrake::Filters::KeysBlocklist).to receive(:new).with(%w[password])
+        described_class.configure { |c| c.blocklist_keys = %w[password] }
       end
     end
 
-    context "when whitelist_keys gets configured" do
+    context "when allowlist_keys gets configured" do
       before { allow(Airbrake.notice_notifier).to receive(:add_filter) }
 
-      it "adds whitelist filter" do
+      it "adds allowlist filter" do
         expect(Airbrake.notice_notifier).to receive(:add_filter)
-          .with(an_instance_of(Airbrake::Filters::KeysWhitelist))
-        described_class.configure { |c| c.whitelist_keys = %w[banana] }
+          .with(an_instance_of(Airbrake::Filters::KeysAllowlist))
+        described_class.configure { |c| c.allowlist_keys = %w[banana] }
       end
 
-      it "initializes whitelist with specified parameters" do
-        expect(Airbrake::Filters::KeysWhitelist).to receive(:new).with(%w[banana])
-        described_class.configure { |c| c.whitelist_keys = %w[banana] }
+      it "initializes allowlist with specified parameters" do
+        expect(Airbrake::Filters::KeysAllowlist).to receive(:new).with(%w[banana])
+        described_class.configure { |c| c.allowlist_keys = %w[banana] }
       end
     end
 

data/spec/config_spec.rb

@@ -17,8 +17,8 @@ RSpec.describe Airbrake::Config do
   its(:environment) { is_expected.to be_nil }
   its(:ignore_environments) { is_expected.to be_empty }
   its(:timeout) { is_expected.to be_nil }
-  its(:blacklist_keys) { is_expected.to be_empty }
-  its(:whitelist_keys) { is_expected.to be_empty }
+  its(:blocklist_keys) { is_expected.to be_empty }
+  its(:allowlist_keys) { is_expected.to be_empty }
   its(:performance_stats) { is_expected.to eq(true) }
   its(:performance_stats_flush_period) { is_expected.to eq(15) }
   its(:query_stats) { is_expected.to eq(true) }
@@ -169,4 +169,32 @@ RSpec.describe Airbrake::Config do
       expect(subject.logger.level).to eq(Logger::WARN)
     end
   end
+
+  describe "#blacklist_keys=" do
+    before { allow(Kernel).to receive(:warn) }
+
+    it "sets blocklist_keys instead" do
+      subject.blacklist_keys = [1, 2, 3]
+      expect(subject.blocklist_keys).to eq([1, 2, 3])
+    end
+
+    it "prints a warning" do
+      expect(Kernel).to receive(:warn).with(/use blocklist_keys= instead/)
+      subject.blacklist_keys = [1, 2, 3]
+    end
+  end
+
+  describe "#whitelist_keys=" do
+    before { allow(Kernel).to receive(:warn) }
+
+    it "sets allowlist_keys instead" do
+      subject.whitelist_keys = [1, 2, 3]
+      expect(subject.allowlist_keys).to eq([1, 2, 3])
+    end
+
+    it "prints a warning" do
+      expect(Kernel).to receive(:warn).with(/use allowlist_keys= instead/)
+      subject.whitelist_keys = [1, 2, 3]
+    end
+  end
 end

data/spec/filters/{keys_whitelist_spec.rb → keys_allowlist_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe Airbrake::Filters::KeysWhitelist do
+RSpec.describe Airbrake::Filters::KeysAllowlist do
   subject { described_class.new(patterns) }
 
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
@@ -70,10 +70,10 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
 
       it "logs an error" do
         expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /KeysWhitelist is invalid.+patterns: \[#<Object:.+>\]/,
+          /KeysAllowlist is invalid.+patterns: \[#<Object:.+>\]/,
         )
-        keys_whitelist = described_class.new(patterns)
-        keys_whitelist.call(notice)
+        keys_allowlist = described_class.new(patterns)
+        keys_allowlist.call(notice)
       end
     end
 
@@ -83,10 +83,10 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
       context "and when the filter is called once" do
         it "logs an error" do
           expect(Airbrake::Loggable.instance).to receive(:error).with(
-            /KeysWhitelist is invalid.+patterns: \[#<Proc:.+>\]/,
+            /KeysAllowlist is invalid.+patterns: \[#<Proc:.+>\]/,
           )
-          keys_whitelist = described_class.new(patterns)
-          keys_whitelist.call(notice)
+          keys_allowlist = described_class.new(patterns)
+          keys_allowlist.call(notice)
         end
 
         include_examples(
@@ -113,10 +113,10 @@ RSpec.describe Airbrake::Filters::KeysWhitelist do
 
     it "logs an error" do
       expect(Airbrake::Loggable.instance).to receive(:error).with(
-        /KeysWhitelist is invalid.+patterns: \[#<Object:.+>\]/,
+        /KeysAllowlist is invalid.+patterns: \[#<Object:.+>\]/,
       )
-      keys_whitelist = described_class.new(patterns)
-      keys_whitelist.call(notice)
+      keys_allowlist = described_class.new(patterns)
+      keys_allowlist.call(notice)
     end
   end
 

data/spec/filters/{keys_blacklist_spec.rb → keys_blocklist_spec.rb}

@@ -1,4 +1,4 @@
-RSpec.describe Airbrake::Filters::KeysBlacklist do
+RSpec.describe Airbrake::Filters::KeysBlocklist do
   subject { described_class.new(patterns) }
 
   let(:notice) { Airbrake::Notice.new(AirbrakeTestError.new) }
@@ -91,10 +91,10 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
 
       it "logs an error" do
         expect(Airbrake::Loggable.instance).to receive(:error).with(
-          /KeysBlacklist is invalid.+patterns: \[#<Object:.+>\]/,
+          /KeysBlocklist is invalid.+patterns: \[#<Object:.+>\]/,
         )
-        keys_blacklist = described_class.new(patterns)
-        keys_blacklist.call(notice)
+        keys_blocklist = described_class.new(patterns)
+        keys_blocklist.call(notice)
       end
     end
 
@@ -104,10 +104,10 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
       context "and when the filter is called once" do
         it "logs an error" do
           expect(Airbrake::Loggable.instance).to receive(:error).with(
-            /KeysBlacklist is invalid.+patterns: \[#<Proc:.+>\]/,
+            /KeysBlocklist is invalid.+patterns: \[#<Proc:.+>\]/,
           )
-          keys_blacklist = described_class.new(patterns)
-          keys_blacklist.call(notice)
+          keys_blocklist = described_class.new(patterns)
+          keys_blocklist.call(notice)
         end
       end
 
@@ -133,10 +133,10 @@ RSpec.describe Airbrake::Filters::KeysBlacklist do
 
     it "logs an error" do
       expect(Airbrake::Loggable.instance).to receive(:error).with(
-        /KeysBlacklist is invalid.+patterns: \[#<Object:.+>\]/,
+        /KeysBlocklist is invalid.+patterns: \[#<Object:.+>\]/,
       )
-      keys_blacklist = described_class.new(patterns)
-      keys_blacklist.call(notice)
+      keys_blocklist = described_class.new(patterns)
+      keys_blocklist.call(notice)
     end
   end
 

data/spec/filters/sql_filter_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Airbrake::Filters::SqlFilter do
     end
   end
 
-  shared_examples "query blacklisting" do |query, opts|
+  shared_examples "query blocklisting" do |query, opts|
     it "ignores '#{query}'" do
       filter = described_class.new('postgres')
       q = Airbrake::Query.new(query: query, method: 'GET', route: '/', timing: 1)
@@ -263,12 +263,12 @@ RSpec.describe Airbrake::Filters::SqlFilter do
 
     'SELECT t.oid, t.typname FROM pg_type as t WHERE t.typname IN (?)',
   ].each do |query|
-    include_examples 'query blacklisting', query, should_ignore: true
+    include_examples 'query blocklisting', query, should_ignore: true
   end
 
   [
     'UPDATE "users" SET "last_sign_in_at" = ? WHERE "users"."id" = ?',
   ].each do |query|
-    include_examples 'query blacklisting', query, should_ignore: false
+    include_examples 'query blocklisting', query, should_ignore: false
   end
 end

data/spec/notice_notifier/options_spec.rb

@@ -234,14 +234,14 @@ RSpec.describe Airbrake::NoticeNotifier do
       end
     end
 
-    describe ":blacklist_keys" do
+    describe ":blocklist_keys" do
       # Fixes https://github.com/airbrake/airbrake-ruby/issues/276
-      context "when specified along with :whitelist_keys" do
+      context "when specified along with :allowlist_keys" do
         context "and when context payload is present" do
           before do
             Airbrake::Config.instance.merge(
-              blacklist_keys: %i[password password_confirmation],
-              whitelist_keys: [:email, /user/i, 'account_id'],
+              blocklist_keys: %i[password password_confirmation],
+              allowlist_keys: [:email, /user/i, 'account_id'],
             )
           end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 4.14.1
+  version: 4.15.0
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -55,9 +55,9 @@ files:
 - lib/airbrake-ruby/filters/git_last_checkout_filter.rb
 - lib/airbrake-ruby/filters/git_repository_filter.rb
 - lib/airbrake-ruby/filters/git_revision_filter.rb
-- lib/airbrake-ruby/filters/keys_blacklist.rb
+- lib/airbrake-ruby/filters/keys_allowlist.rb
+- lib/airbrake-ruby/filters/keys_blocklist.rb
 - lib/airbrake-ruby/filters/keys_filter.rb
-- lib/airbrake-ruby/filters/keys_whitelist.rb
 - lib/airbrake-ruby/filters/root_directory_filter.rb
 - lib/airbrake-ruby/filters/sql_filter.rb
 - lib/airbrake-ruby/filters/system_exit_filter.rb
@@ -105,8 +105,8 @@ files:
 - spec/filters/git_last_checkout_filter_spec.rb
 - spec/filters/git_repository_filter.rb
 - spec/filters/git_revision_filter_spec.rb
-- spec/filters/keys_blacklist_spec.rb
-- spec/filters/keys_whitelist_spec.rb
+- spec/filters/keys_allowlist_spec.rb
+- spec/filters/keys_blocklist_spec.rb
 - spec/filters/root_directory_filter_spec.rb
 - spec/filters/sql_filter_spec.rb
 - spec/filters/system_exit_filter_spec.rb
@@ -172,14 +172,14 @@ test_files:
 - spec/filters/exception_attributes_filter_spec.rb
 - spec/filters/root_directory_filter_spec.rb
 - spec/filters/sql_filter_spec.rb
-- spec/filters/keys_whitelist_spec.rb
 - spec/filters/system_exit_filter_spec.rb
 - spec/filters/thread_filter_spec.rb
+- spec/filters/keys_allowlist_spec.rb
 - spec/filters/dependency_filter_spec.rb
 - spec/filters/context_filter_spec.rb
 - spec/filters/git_last_checkout_filter_spec.rb
 - spec/filters/git_revision_filter_spec.rb
-- spec/filters/keys_blacklist_spec.rb
+- spec/filters/keys_blocklist_spec.rb
 - spec/filters/gem_root_filter_spec.rb
 - spec/filters/git_repository_filter.rb
 - spec/spec_helper.rb