airbrake-ruby 3.2.5 → 3.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d82d2c4088a9f12a7b9f79f06bbd627e467ca41a
-  data.tar.gz: 2d5a844aee8b9566bb707a6ba5b89f6b0534d770
+  metadata.gz: b8b74bf6222301b0773cbae98656cae5e7434dfe
+  data.tar.gz: f0c09f8d665390398e8226e624d5fb407927ab09
 SHA512:
-  metadata.gz: c0bda142c168eeca50d9f73d6897c031d20bec58f2c1c9dbc1bbc4778fa3252025bfd56c8f0c1f7593b86fc632ac3f26a7a73d2edd5b84171c2701b4d7a0a94c
-  data.tar.gz: 871e4d592b46053d231d5ef6611e7f0736cffd0d4b40dc1ac586c1f3fee86e06bb937b4df0ee6c27a34d1c343d59d161b34b3b76b358683dbfdaad3a7013e1a3
+  metadata.gz: b075a5d9a1d6b6d3d28fe5345140c0c5397a34e49e89d52cbd9ab4b99d9d4fc57e12641cbd354028b579263f8fa69a82e15f15938559f8e905f553d0092ce972
+  data.tar.gz: 380596bb7dc0836185ac4a812fd309d5c3c5913b72177e4df660c620d9ae29520c9659bdcb01ccb52879e4946e37687231205b72a6191dbd1c177f2b3ad591aa

data/lib/airbrake-ruby.rb

@@ -15,6 +15,7 @@ require 'airbrake-ruby/async_sender'
 require 'airbrake-ruby/response'
 require 'airbrake-ruby/nested_exception'
 require 'airbrake-ruby/ignorable'
+require 'airbrake-ruby/inspectable'
 require 'airbrake-ruby/notice'
 require 'airbrake-ruby/backtrace'
 require 'airbrake-ruby/truncator'
@@ -78,6 +79,7 @@ require 'airbrake-ruby/request'
 #
 # @see Airbrake::NoticeNotifier
 # @since v1.0.0
+# rubocop:disable Metrics/ModuleLength
 module Airbrake
   # The general error that this library uses when it wants to raise.
   Error = Class.new(StandardError)
@@ -190,6 +192,13 @@ module Airbrake
     # @return [Airbrake::NoticeNotifier, NilClass]
     # @since v1.8.0
     def [](notifier_name)
+      loc = caller_locations(1..1).first
+      signature = "#{self}##{__method__}"
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: #{signature} is deprecated. It " \
+        "will be removed from airbrake-ruby v4 altogether."
+      )
+
       @notice_notifiers[notifier_name]
     end
 
@@ -197,6 +206,13 @@ module Airbrake
     #   (notice, performance, deploy)
     # @since v3.2.0
     def notifiers
+      loc = caller_locations(1..1).first
+      signature = "#{self}##{__method__}"
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: #{signature} is deprecated. It " \
+        "will be removed from airbrake-ruby v4 altogether."
+      )
+
       {
         notice: @notice_notifiers,
         performance: @performance_notifiers,
@@ -204,8 +220,7 @@ module Airbrake
       }
     end
 
-    # Configures a new +notifier+ with the given name. If the name is not given,
-    # configures the default notifier.
+    # Configures the Airbrake notifier.
     #
     # @example Configuring the default notifier
     #   Airbrake.configure do |c|
@@ -213,14 +228,6 @@ module Airbrake
     #     c.project_key = 'fd04e13d806a90f96614ad8e529b2822'
     #   end
     #
-    # @example Configuring a named notifier
-    #   # Configure a new Airbrake instance and
-    #   # assign +:my_other_project+ as its name.
-    #   Airbrake.configure(:my_other_project) do |c|
-    #     c.project_id = 224854
-    #     c.project_key = '91ac5e4a37496026c6837f63276ed2b6'
-    #   end
-    #
     # @param [Symbol] notifier_name the name to be associated with the notifier
     # @yield [config] The configuration object
     # @yieldparam config [Airbrake::Config]
@@ -232,6 +239,15 @@ module Airbrake
     # @note There's no way to reconfigure a notifier
     # @note There's no way to read config values outside of this library
     def configure(notifier_name = :default)
+      unless notifier_name == :default
+        loc = caller_locations(1..1).first
+        warn(
+          "#{loc.path}:#{loc.lineno}: warning: configuring a notifier with a " \
+          "custom name is deprecated. This feature will be removed from " \
+          "airbrake-ruby v4 altogether."
+        )
+      end
+
       yield config = Airbrake::Config.new
 
       if @notice_notifiers.key?(notifier_name)
@@ -378,8 +394,7 @@ module Airbrake
       @notice_notifiers[:default].close
     end
 
-    # Pings the Airbrake Deploy API endpoint about the occurred deploy. This
-    # method is used by the airbrake gem for various integrations.
+    # Pings the Airbrake Deploy API endpoint about the occurred deploy.
     #
     # @param [Hash{Symbol=>String}] deploy_info The params for the API
     # @option deploy_info [Symbol] :environment
@@ -388,10 +403,21 @@ module Airbrake
     # @option deploy_info [Symbol] :revision
     # @option deploy_info [Symbol] :version
     # @return [void]
-    def create_deploy(deploy_info)
+    def notify_deploy(deploy_info)
       @deploy_notifiers[:default].notify(deploy_info)
     end
 
+    # @see notify_deploy
+    def create_deploy(deploy_info)
+      loc = caller_locations(1..1).first
+      signature = "#{self}##{__method__}"
+      warn(
+        "#{loc.path}:#{loc.lineno}: warning: #{signature} is deprecated. Call " \
+        "#{self}#notify_deploy instead"
+      )
+      notify_deploy(deploy_info)
+    end
+
     # Merges +context+ with the current context.
     #
     # The context will be attached to the notice object upon a notify call and
@@ -565,3 +591,4 @@ module Airbrake
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

data/lib/airbrake-ruby/deploy_notifier.rb

@@ -10,6 +10,8 @@ module Airbrake
   # @api public
   # @since v3.2.0
   class DeployNotifier
+    include Inspectable
+
     # @param [Airbrake::Config] config
     def initialize(config)
       @config =

data/lib/airbrake-ruby/inspectable.rb

@@ -0,0 +1,39 @@
+module Airbrake
+  # Inspectable provides custom inspect methods that reduce clutter printed in
+  # REPLs for notifier objects. These custom methods display only essential
+  # information such as project id/key and filters.
+  #
+  # @since v3.2.6
+  # @api private
+  module Inspectable
+    # @return [String] inspect output template
+    INSPECT_TEMPLATE =
+      "#<%<classname>s:0x%<id>s project_id=\"%<project_id>s\" " \
+      "project_key=\"%<project_key>s\" " \
+      "host=\"%<host>s\" filter_chain=%<filter_chain>s>".freeze
+
+    # @return [String] customized inspect to lessen the amount of clutter
+    def inspect
+      format(
+        INSPECT_TEMPLATE,
+        classname: self.class.name,
+        id: (object_id << 1).to_s(16).rjust(16, '0'),
+        project_id: @config.project_id,
+        project_key: @config.project_key,
+        host: @config.host,
+        filter_chain: @filter_chain.inspect
+      )
+    end
+
+    # @return [String] {#inspect} for PrettyPrint
+    def pretty_print(q)
+      q.text("#<#{self.class}:0x#{(object_id << 1).to_s(16).rjust(16, '0')} ")
+      q.text(
+        "project_id=\"#{@config.project_id}\" project_key=\"#{@config.project_key}\" " \
+        "host=\"#{@config.host}\" filter_chain="
+      )
+      q.pp(@filter_chain)
+      q.text('>')
+    end
+  end
+end

data/lib/airbrake-ruby/notice_notifier.rb

@@ -7,15 +7,6 @@ module Airbrake
   # @api public
   # rubocop:disable Metrics/ClassLength
   class NoticeNotifier
-    # @return [String] the label to be prepended to the log output
-    LOG_LABEL = '**Airbrake:'.freeze
-
-    # @return [String] inspect output template
-    INSPECT_TEMPLATE =
-      "#<#{self}:0x%<id>s project_id=\"%<project_id>s\" " \
-      "project_key=\"%<project_key>s\" " \
-      "host=\"%<host>s\" filter_chain=%<filter_chain>s>".freeze
-
     # @return [Array<Class>] filters to be executed first
     DEFAULT_FILTERS = [
       Airbrake::Filters::SystemExitFilter,
@@ -25,6 +16,8 @@ module Airbrake
       # Airbrake::Filters::ThreadFilter
     ].freeze
 
+    include Inspectable
+
     # Creates a new notice notifier with the given config options.
     #
     # @example
@@ -116,29 +109,6 @@ module Airbrake
       @context.merge!(context)
     end
 
-    # @return [String] customized inspect to lessen the amount of clutter
-    def inspect
-      format(
-        INSPECT_TEMPLATE,
-        id: (object_id << 1).to_s(16).rjust(16, '0'),
-        project_id: @config.project_id,
-        project_key: @config.project_key,
-        host: @config.host,
-        filter_chain: @filter_chain.inspect
-      )
-    end
-
-    # @return [String] {#inspect} for PrettyPrint
-    def pretty_print(q)
-      q.text("#<#{self.class}:0x#{(object_id << 1).to_s(16).rjust(16, '0')} ")
-      q.text(
-        "project_id=\"#{@config.project_id}\" project_key=\"#{@config.project_key}\" " \
-        "host=\"#{@config.host}\" filter_chain="
-      )
-      q.pp(@filter_chain)
-      q.text('>')
-    end
-
     private
 
     def convert_to_exception(ex)

data/lib/airbrake-ruby/performance_notifier.rb

@@ -5,6 +5,8 @@ module Airbrake
   # @api public
   # @since v3.2.0
   class PerformanceNotifier
+    include Inspectable
+
     # @param [Airbrake::Config] config
     def initialize(config)
       @config =
@@ -85,6 +87,7 @@ module Airbrake
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
     def send(payload, promise)
       signature = "#{self.class.name}##{__method__}"
       raise "#{signature}: payload (#{payload}) cannot be empty. Race?" if payload.none?
@@ -92,8 +95,11 @@ module Airbrake
       @config.logger.debug("#{LOG_LABEL} #{signature}: #{payload}")
 
       payload.group_by { |k, _v| k.name }.each do |resource_name, data|
+        data = { resource_name => data.map { |k, v| k.to_h.merge!(v.to_h) } }
+        data['environment'] = @config.environment if @config.environment
+
         @sender.send(
-          { resource_name => data.map { |k, v| k.to_h.merge!(v.to_h) } },
+          data,
           promise,
           URI.join(
             @config.host,
@@ -102,5 +108,6 @@ module Airbrake
         )
       end
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end

data/lib/airbrake-ruby/query.rb

@@ -6,14 +6,12 @@ module Airbrake
   # @since v3.2.0
   # rubocop:disable Metrics/ParameterLists, Metrics/BlockLength
   Query = Struct.new(
-    :environment, :method, :route, :query, :func, :file, :line, :start_time,
-    :end_time
+    :method, :route, :query, :func, :file, :line, :start_time, :end_time
   ) do
     include HashKeyable
     include Ignorable
 
     def initialize(
-      environment: nil,
       method:,
       route:,
       query:,
@@ -23,10 +21,7 @@ module Airbrake
       start_time:,
       end_time: Time.now
     )
-      super(
-        environment, method, route, query, func, file, line, start_time,
-        end_time
-      )
+      super(method, route, query, func, file, line, start_time, end_time)
     end
 
     def name
@@ -35,7 +30,6 @@ module Airbrake
 
     def to_h
       {
-        'environment' => environment,
         'method' => method,
         'route' => route,
         'query' => query,

data/lib/airbrake-ruby/request.rb

@@ -4,22 +4,18 @@ module Airbrake
   # @see Airbrake.notify_request
   # @api public
   # @since v3.2.0
-  # rubocop:disable Metrics/ParameterLists
-  Request = Struct.new(
-    :environment, :method, :route, :status_code, :start_time, :end_time
-  ) do
+  Request = Struct.new(:method, :route, :status_code, :start_time, :end_time) do
     include HashKeyable
     include Ignorable
 
     def initialize(
-      environment: nil,
       method:,
       route:,
       status_code:,
       start_time:,
       end_time: Time.now
     )
-      super(environment, method, route, status_code, start_time, end_time)
+      super(method, route, status_code, start_time, end_time)
     end
 
     def name
@@ -28,7 +24,6 @@ module Airbrake
 
     def to_h
       {
-        'environment' => environment,
         'method' => method,
         'route' => route,
         'statusCode' => status_code,
@@ -36,5 +31,4 @@ module Airbrake
       }.delete_if { |_key, val| val.nil? }
     end
   end
-  # rubocop:enable Metrics/ParameterLists
 end

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 = '3.2.5'.freeze
+  AIRBRAKE_RUBY_VERSION = '3.2.6'.freeze
 end

data/spec/airbrake_spec.rb

@@ -121,12 +121,12 @@ RSpec.describe Airbrake do
     end
   end
 
-  describe ".create_deploy" do
+  describe ".notify_deploy" do
     let(:default_notifier) { described_class.notifiers[:deploy][:default] }
 
     it "calls 'notify' on the deploy notifier" do
       expect(default_notifier).to receive(:notify).with(foo: 'bar')
-      described_class.create_deploy(foo: 'bar')
+      described_class.notify_deploy(foo: 'bar')
     end
   end
 

data/spec/inspectable_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe Airbrake::Inspectable do
+  let(:klass) do
+    mod = subject
+    Class.new do
+      include(mod)
+
+      def initialize
+        @config = Airbrake::Config.new
+        @filter_chain = nil
+      end
+    end
+  end
+
+  describe "#inspect" do
+    it "displays object information" do
+      instance = klass.new
+      expect(instance.inspect).to match(/
+        #<:0x\w+\s
+          project_id=""\s
+          project_key=""\s
+          host="http.+"\s
+          filter_chain=nil>
+      /x)
+    end
+  end
+
+  describe "#pretty_print" do
+    it "displays object information in a beautiful way" do
+      q = PP.new
+
+      instance = klass.new
+      # Guarding is needed to fix JRuby failure:
+      # NoMethodError: undefined method `[]' for nil:NilClass
+      q.guard_inspect_key { instance.pretty_print(q) }
+
+      expect(q.output).to match(/
+        #<:0x\w+\s
+          project_id=""\s
+          project_key=""\s
+          host="http.+"\s
+          filter_chain=nil
+      /x)
+    end
+  end
+end

data/spec/notice_notifier_spec.rb

@@ -402,35 +402,5 @@ RSpec.describe Airbrake::NoticeNotifier do
       subject.merge_context(apples: 'oranges')
     end
   end
-
-  describe "#inspect" do
-    it "displays object information" do
-      expect(subject.inspect).to match(/
-        #<Airbrake::NoticeNotifier:0x\w+\s
-          project_id="\d+"\s
-          project_key=".+"\s
-          host="http.+"\s
-          filter_chain=\[.+\]>
-      /x)
-    end
-  end
-
-  describe "#pretty_print" do
-    it "displays object information in a beautiful way" do
-      q = PP.new
-
-      # Guarding is needed to fix JRuby failure:
-      # NoMethodError: undefined method `[]' for nil:NilClass
-      q.guard_inspect_key { subject.pretty_print(q) }
-
-      expect(q.output).to match(/
-        #<Airbrake::NoticeNotifier:0x\w+\s
-          project_id="\d+"\s
-          project_key=".+"\s
-          host="http.+"\s
-          filter_chain=\[\n\s\s
-      /x)
-    end
-  end
 end
 # rubocop:enable Layout/DotPosition

data/spec/performance_notifier_spec.rb

@@ -22,7 +22,6 @@ RSpec.describe Airbrake::PerformanceNotifier do
     it "sends full query" do
       subject.notify(
         Airbrake::Query.new(
-          environment: 'development',
           method: 'POST',
           route: '/foo',
           query: 'SELECT * FROM things',
@@ -37,7 +36,6 @@ RSpec.describe Airbrake::PerformanceNotifier do
       expect(
         a_request(:put, queries).with(body: %r|
           \A{"queries":\[{
-            "environment":"development",
             "method":"POST",
             "route":"/foo",
             "query":"SELECT\s\*\sFROM\sthings",
@@ -56,7 +54,6 @@ RSpec.describe Airbrake::PerformanceNotifier do
     it "sends full request" do
       subject.notify(
         Airbrake::Request.new(
-          environment: 'development',
           method: 'POST',
           route: '/foo',
           status_code: 200,
@@ -68,7 +65,6 @@ RSpec.describe Airbrake::PerformanceNotifier do
       expect(
         a_request(:put, routes).with(body: %r|
           \A{"routes":\[{
-            "environment":"development",
             "method":"POST",
             "route":"/foo",
             "statusCode":200,
@@ -217,8 +213,7 @@ RSpec.describe Airbrake::PerformanceNotifier do
 
     it "doesn't send route stats when current environment is ignored" do
       notifier = described_class.new(
-        Airbrake::Config.new(
-          project_id: 1, project_key: '2', performance_stats: true,
+        config.merge(
           environment: 'test', ignore_environments: %w[test]
         )
       )
@@ -231,6 +226,28 @@ RSpec.describe Airbrake::PerformanceNotifier do
       expect(promise.value).to eq('error' => "The 'test' environment is ignored")
     end
 
+    it "sends environment when it's specified" do
+      notifier = described_class.new(
+        config.merge(
+          project_id: 1, project_key: '2', performance_stats: true,
+          environment: 'test'
+        )
+      )
+      notifier.notify(
+        Airbrake::Request.new(
+          method: 'POST',
+          route: '/foo',
+          status_code: 200,
+          start_time: Time.new
+        )
+      )
+      expect(
+        a_request(:put, routes).with(
+          body: /\A{"routes":\[.+\],"environment":"test"}\z/x
+        )
+      ).to have_been_made
+    end
+
     describe "payload grouping" do
       let(:flush_period) { 0.5 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake-ruby
 version: !ruby/object:Gem::Version
-  version: 3.2.5
+  version: 3.2.6
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-20 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbtree3
@@ -63,6 +63,7 @@ files:
 - lib/airbrake-ruby/filters/thread_filter.rb
 - lib/airbrake-ruby/hash_keyable.rb
 - lib/airbrake-ruby/ignorable.rb
+- lib/airbrake-ruby/inspectable.rb
 - lib/airbrake-ruby/nested_exception.rb
 - lib/airbrake-ruby/notice.rb
 - lib/airbrake-ruby/notice_notifier.rb
@@ -107,6 +108,7 @@ files:
 - spec/fixtures/project_root/vendor/bundle/ignored_file.rb
 - spec/helpers.rb
 - spec/ignorable_spec.rb
+- spec/inspectable_spec.rb
 - spec/nested_exception_spec.rb
 - spec/notice_notifier_spec.rb
 - spec/notice_notifier_spec/options_spec.rb
@@ -187,4 +189,5 @@ test_files:
 - spec/fixtures/project_root/code.rb
 - spec/fixtures/project_root/short_file.rb
 - spec/fixtures/project_root/vendor/bundle/ignored_file.rb
+- spec/inspectable_spec.rb
 - spec/notice_notifier_spec/options_spec.rb