airbrake 5.8.0.rc.2 → 5.8.0.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 739d297145e474289e0991518823f2a335730af1
-  data.tar.gz: e342217370635b59ff72dab485a5ae2190693100
+  metadata.gz: 493f0a2aced008e37822fd5be783ee6874312987
+  data.tar.gz: 4d4f2e85c5f959d516aa0fd1e9a048f5db8977cd
 SHA512:
-  metadata.gz: ab4c6612ef1301925779ca3519a85a119d213e5b72f10748f98f144b00547b4e8db8a57babc398238f72096575d05392f8cd14d532cdfad7f0c8068ff405c520
-  data.tar.gz: 1bcc18a8234ba41e3d28a19e7cf1071611c21275cf049f843003a018995b0f9e75642b1c7d9f7a22165c3f78286f48aedeaa99604409fb79ba6c65e476742efa
+  metadata.gz: 8381916743bd4d1ada0027a85acd10212cb1f9a0fec53f2c5aec6b0623e56641bb7b0a1972dd1de85ab40726e1412d2be92291073c4ad394305a906a8605d0d8
+  data.tar.gz: 32e1cb6fa237f035c01f68619e40bcda26aedfb2b02b9b4f42b9c46d10f66c79fd6a3bf5344ba5cfba4a2138a60961855e82c36f2a88200693df53a879afbdf1

data/lib/airbrake.rb

@@ -25,7 +25,8 @@ require 'airbrake/resque/failure' if defined?(Resque)
 require 'airbrake/sidekiq/error_handler' if defined?(Sidekiq)
 require 'airbrake/shoryuken/error_handler' if defined?(Shoryuken)
 require 'airbrake/delayed_job/plugin' if defined?(Delayed)
-require 'airbrake/logger/logger_ext' if defined?(Logger)
+
+require 'airbrake/logger/airbrake_logger'
 
 ##
 # This module reopens the original Airbrake module from airbrake-ruby and adds

data/lib/airbrake/logger/airbrake_logger.rb

@@ -0,0 +1,106 @@
+require 'logger'
+
+module Airbrake
+  ##
+  # Decorator for +Logger+ from stdlib. Endows loggers the ability to both log
+  # and report errors to Airbrake.
+  #
+  # @example
+  #   # Create a logger like you normally do and decorate it.
+  #   logger = Airbrake::AirbrakeLogger.new(Logger.new(STDOUT))
+  #
+  #   # Just use the logger like you normally do.
+  #   logger.fatal('oops')
+  class AirbrakeLogger < SimpleDelegator
+    ##
+    # @example
+    #   # Assign a default Airbrake notifier
+    #   logger.airbrake_notifier = Airbrake[:default]
+    # @return [Airbrake::Notifier] notifier to be used to send notices
+    attr_accessor :airbrake_notifier
+
+    ##
+    # @example
+    #   logger.airbrake_level = Logger::FATAL
+    # @return [Integer]
+    attr_accessor :airbrake_level
+
+    def initialize(logger)
+      __setobj__(logger)
+      @airbrake_notifier = Airbrake[:default]
+      @airbrake_level = Logger::WARN
+    end
+
+    ##
+    # @see Logger#warn
+    def warn(progname = nil, &block)
+      notify_airbrake(Logger::WARN, progname)
+      super
+    end
+
+    ##
+    # @see Logger#error
+    def error(progname = nil, &block)
+      notify_airbrake(Logger::ERROR, progname)
+      super
+    end
+
+    ##
+    # @see Logger#fatal
+    def fatal(progname = nil, &block)
+      notify_airbrake(Logger::FATAL, progname)
+      super
+    end
+
+    ##
+    # @see Logger#unknown
+    def unknown(progname = nil, &block)
+      notify_airbrake(Logger::UNKNOWN, progname)
+      super
+    end
+
+    ##
+    # Sets airbrake severity level. Does not permit values below `Logger::WARN`.
+    #
+    # @example
+    #   logger.airbrake_level = Logger::FATAL
+    # @return [void]
+    def airbrake_level=(level)
+      if level < Logger::WARN
+        raise "Airbrake severity level #{level} is not allowed. " \
+              "Minimum allowed level is #{Logger::WARN}"
+      end
+      @airbrake_level = level
+    end
+
+    private
+
+    def notify_airbrake(severity, progname)
+      return if severity < @airbrake_level || !@airbrake_notifier
+
+      notice = @airbrake_notifier.build_notice(progname)
+
+      # Get rid of unwanted internal Logger frames. Examples:
+      # * /ruby-2.4.0/lib/ruby/2.4.0/logger.rb
+      # * /gems/activesupport-4.2.7.1/lib/active_support/logger.rb
+      backtrace = notice[:errors].first[:backtrace]
+      notice[:errors].first[:backtrace] =
+        backtrace.drop_while { |frame| frame[:file] =~ %r{/logger.rb\z} }
+
+      notice[:context][:component] = 'log'
+      notice[:context][:severity] = normalize_severity(severity)
+
+      @airbrake_notifier.notify(notice)
+    end
+
+    def normalize_severity(severity)
+      (case severity
+       when Logger::WARN then 'warning'
+       when Logger::ERROR, Logger::UNKNOWN then 'error'
+       when Logger::FATAL then 'critical'
+       else
+         raise "Unknown airbrake severity: #{severity}"
+       end).freeze
+    end
+  end
+end

data/lib/airbrake/rack/user.rb

@@ -25,9 +25,9 @@ module Airbrake
 
       def self.try_current_user(rack_env)
         controller = rack_env['action_controller.instance']
-        return unless controller.respond_to?(:current_user)
+        return unless controller.respond_to?(:current_user, true)
         return unless [-1, 0].include?(controller.method(:current_user).arity)
-        controller.current_user
+        controller.__send__(:current_user)
       end
       private_class_method :try_current_user
 

data/lib/airbrake/version.rb

@@ -2,5 +2,5 @@
 # We use Semantic Versioning v2.0.0
 # More information: http://semver.org/
 module Airbrake
-  AIRBRAKE_VERSION = '5.8.0.rc.2'.freeze
+  AIRBRAKE_VERSION = '5.8.0.rc.3'.freeze
 end

data/spec/unit/logger/airbrake_logger_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+RSpec.describe Airbrake::AirbrakeLogger do
+  let(:project_id) { 113743 }
+  let(:project_key) { 'fd04e13d806a90f96614ad8e529b2822' }
+
+  let(:endpoint) do
+    "https://airbrake.io/api/v3/projects/#{project_id}/notices?key=#{project_key}"
+  end
+
+  let(:airbrake) do
+    Airbrake::Notifier.new(project_id: project_id, project_key: project_key)
+  end
+
+  let(:logger) { Logger.new('/dev/null') }
+
+  subject { described_class.new(logger) }
+
+  def wait_for_a_request_with_body(body)
+    wait_for(a_request(:post, endpoint).with(body: body)).to have_been_made.once
+  end
+
+  before do
+    stub_request(:post, endpoint).to_return(status: 201, body: '{}')
+  end
+
+  describe "#airbrake_notifier" do
+    it "has the default notifier installed by default" do
+      expect(subject.airbrake_notifier).to be_an(Airbrake::Notifier)
+    end
+
+    it "installs Airbrake notifier" do
+      notifier_id = airbrake.object_id
+      expect(subject.airbrake_notifier.object_id).not_to eq(notifier_id)
+
+      subject.airbrake_notifier = airbrake
+      expect(subject.airbrake_notifier.object_id).to eq(notifier_id)
+    end
+
+    context "when Airbrake is installed explicitly" do
+      let(:out) { StringIO.new }
+      let(:logger) { Logger.new(out) }
+
+      before do
+        subject.airbrake_notifier = airbrake
+      end
+
+      it "both logs and notifies" do
+        msg = 'bingo'
+        subject.fatal(msg)
+
+        wait_for_a_request_with_body(/"message":"#{msg}"/)
+        expect(out.string).to match(/FATAL -- : #{msg}/)
+      end
+
+      it "sets the correct severity" do
+        subject.fatal('bango')
+        wait_for_a_request_with_body(/"context":{.*"severity":"critical".*}/)
+      end
+
+      it "sets the correct component" do
+        subject.fatal('bingo')
+        wait_for_a_request_with_body(/"component":"log"/)
+      end
+
+      it "strips out internal logger frames" do
+        subject.fatal('bongo')
+
+        wait_for(
+          a_request(:post, endpoint).
+            with(body: %r{"file":".+/logger.rb"})
+        ).not_to have_been_made
+        wait_for(a_request(:post, endpoint)).to have_been_made.once
+      end
+    end
+
+    context "when Airbrake is not installed" do
+      it "only logs, never notifies" do
+        out = StringIO.new
+        l = described_class.new(Logger.new(out))
+        l.airbrake_notifier = nil
+        msg = 'bango'
+
+        l.fatal(msg)
+
+        wait_for(a_request(:post, endpoint)).not_to have_been_made
+        expect(out.string).to match('FATAL -- : bango')
+      end
+    end
+  end
+
+  describe "#airbrake_level" do
+    context "when not set" do
+      it "defaults to Logger::WARN" do
+        expect(subject.airbrake_level).to eq(Logger::WARN)
+      end
+    end
+
+    context "when set" do
+      before do
+        subject.airbrake_level = Logger::FATAL
+      end
+
+      it "does not notify below the specified level" do
+        subject.error('bingo')
+        wait_for(a_request(:post, endpoint)).not_to have_been_made
+      end
+
+      it "notifies in the current or above level" do
+        subject.fatal('bingo')
+        wait_for(a_request(:post, endpoint)).to have_been_made
+      end
+
+      it "raises error when below the allowed level" do
+        expect do
+          subject.airbrake_level = Logger::DEBUG
+        end.to raise_error(/severity level \d is not allowed/)
+      end
+    end
+  end
+end

data/spec/unit/rack/user_spec.rb

@@ -137,6 +137,27 @@ RSpec.describe Airbrake::Rack::User do
           end
         end
       end
+
+      context 'and it is a private method' do
+        context "and it is not nil" do
+          let(:dummy_controller) do
+            Class.new do
+              private
+
+              def current_user
+                "username"
+              end
+            end
+          end
+
+          let(:controller) { dummy_controller.new }
+
+          it "returns the wrapped user" do
+            retval = described_class.extract(env)
+            expect(retval).to be_a(described_class)
+          end
+        end
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrake
 version: !ruby/object:Gem::Version
-  version: 5.8.0.rc.2
+  version: 5.8.0.rc.3
 platform: ruby
 authors:
 - Airbrake Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake-ruby
@@ -197,7 +197,7 @@ files:
 - lib/airbrake.rb
 - lib/airbrake/capistrano/tasks.rb
 - lib/airbrake/delayed_job/plugin.rb
-- lib/airbrake/logger/logger_ext.rb
+- lib/airbrake/logger/airbrake_logger.rb
 - lib/airbrake/rack/context_filter.rb
 - lib/airbrake/rack/http_headers_filter.rb
 - lib/airbrake/rack/http_params_filter.rb
@@ -235,7 +235,7 @@ files:
 - spec/integration/sinatra/sinatra_spec.rb
 - spec/spec_helper.rb
 - spec/unit/airbrake_spec.rb
-- spec/unit/logger/logger_ext_spec.rb
+- spec/unit/logger/airbrake_logger_spec.rb
 - spec/unit/rack/context_filter_spec.rb
 - spec/unit/rack/http_headers_filter_spec.rb
 - spec/unit/rack/http_params_filter_spec.rb
@@ -290,7 +290,7 @@ test_files:
 - spec/integration/sinatra/sinatra_spec.rb
 - spec/spec_helper.rb
 - spec/unit/airbrake_spec.rb
-- spec/unit/logger/logger_ext_spec.rb
+- spec/unit/logger/airbrake_logger_spec.rb
 - spec/unit/rack/context_filter_spec.rb
 - spec/unit/rack/http_headers_filter_spec.rb
 - spec/unit/rack/http_params_filter_spec.rb

data/lib/airbrake/logger/logger_ext.rb

@@ -1,78 +0,0 @@
-##
-# Redefine +Logger+ from stdlib, so it can both log and report errors to
-# Airbrake.
-#
-# @example
-#   # Create a logger like you normally do.
-#   logger = Logger.new(STDOUT)
-#
-#   # Assign a default Airbrake notifier
-#   logger.airbrake_notifier = Airbrake[:default]
-#
-#   # Just use the logger like you normally do.
-#   logger.fatal('oops')
-class Logger
-  # Store the orginal methods to use them later.
-  alias add_without_airbrake add
-  alias initialize_without_airbrake initialize
-
-  ##
-  # @see https://goo.gl/MvlYq3 Logger#initialize
-  def initialize(*args)
-    @airbrake_notifier = Airbrake[:default]
-    @airbrake_severity_level = WARN
-    initialize_without_airbrake(*args)
-  end
-
-  ##
-  # @return [Airbrake::Notifier] notifier to be used to send notices
-  attr_accessor :airbrake_notifier
-
-  ##
-  # @example
-  #   logger.airbrake_severity_level = Logger::FATAL
-  # @return [Integer]
-  attr_accessor :airbrake_severity_level
-
-  ##
-  # @see https://goo.gl/8zPyoM Logger#add
-  def add(severity, message = nil, progname = nil, &block)
-    if severity >= airbrake_severity_level && airbrake_notifier
-      notify_airbrake(severity, message || progname)
-    end
-    add_without_airbrake(severity, message, progname, &block)
-  end
-
-  private
-
-  def notify_airbrake(severity, message)
-    notice = airbrake_notifier.build_notice(message)
-
-    # Get rid of unwanted internal Logger frames. Examples:
-    # * /ruby-2.4.0/lib/ruby/2.4.0/logger.rb
-    # * /gems/activesupport-4.2.7.1/lib/active_support/logger.rb
-    backtrace = notice[:errors].first[:backtrace]
-    notice[:errors].first[:backtrace] =
-      backtrace.drop_while { |frame| frame[:file] =~ %r{/logger.rb\z} }
-
-    notice[:context][:component] = 'log'
-    notice[:context][:severity] = airbrake_severity(severity)
-
-    airbrake_notifier.notify(notice)
-  end
-
-  def airbrake_severity(severity)
-    (case severity
-     when DEBUG
-       'debug'
-     when INFO
-       'info'
-     when WARN
-       'warning'
-     when ERROR, UNKNOWN
-       'error'
-     when FATAL
-       'critical'
-     end).freeze
-  end
-end

data/spec/unit/logger/logger_ext_spec.rb

@@ -1,113 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Logger do
-  let(:project_id) { 113743 }
-  let(:project_key) { 'fd04e13d806a90f96614ad8e529b2822' }
-
-  let(:endpoint) do
-    "https://airbrake.io/api/v3/projects/#{project_id}/notices?key=#{project_key}"
-  end
-
-  let(:airbrake) do
-    Airbrake::Notifier.new(project_id: project_id, project_key: project_key)
-  end
-
-  let(:logger) { Logger.new('/dev/null') }
-
-  def wait_for_a_request_with_body(body)
-    wait_for(a_request(:post, endpoint).with(body: body)).to have_been_made.once
-  end
-
-  before do
-    stub_request(:post, endpoint).to_return(status: 201, body: '{}')
-  end
-
-  describe "#airbrake" do
-    it "has the default notifier installed by default" do
-      expect(logger.airbrake_notifier).to be_an(Airbrake::Notifier)
-    end
-
-    it "installs Airbrake notifier" do
-      notifier_id = airbrake.object_id
-      expect(logger.airbrake_notifier.object_id).not_to eq(notifier_id)
-
-      logger.airbrake_notifier = airbrake
-      expect(logger.airbrake_notifier.object_id).to eq(notifier_id)
-    end
-  end
-
-  context "when Airbrake is installed" do
-    let(:out) { StringIO.new }
-    let(:logger) { Logger.new(out) }
-
-    before do
-      logger.airbrake_notifier = airbrake
-    end
-
-    it "both logs and notifies" do
-      msg = 'bingo'
-      logger.fatal(msg)
-
-      wait_for_a_request_with_body(/"message":"#{msg}"/)
-      expect(out.string).to match(/FATAL -- : #{msg}/)
-    end
-
-    it "sets the correct severity" do
-      logger.fatal('bango')
-      wait_for_a_request_with_body(/"context":{.*"severity":"critical".*}/)
-    end
-
-    it "sets the correct component" do
-      logger.fatal('bingo')
-      wait_for_a_request_with_body(/"component":"log"/)
-    end
-
-    it "strips out internal logger frames" do
-      logger.fatal('bongo')
-
-      wait_for(
-        a_request(:post, endpoint).
-        with(body: %r{"file":".+/logger.rb"})
-      ).not_to have_been_made
-      wait_for(a_request(:post, endpoint)).to have_been_made.once
-    end
-  end
-
-  describe "#airbrake_severity_level" do
-    context "when not set" do
-      it "defaults to Logger::WARN" do
-        expect(logger.airbrake_severity_level).to eq(Logger::WARN)
-      end
-    end
-
-    context "when set" do
-      before do
-        logger.airbrake_severity_level = Logger::FATAL
-      end
-
-      it "does not notify below the specified level" do
-        logger.error('bingo')
-        wait_for(a_request(:post, endpoint)).not_to have_been_made
-      end
-
-      it "notifies in the current or above level" do
-        logger.fatal('bingo')
-        wait_for(a_request(:post, endpoint)).to have_been_made
-      end
-    end
-  end
-
-  context "when Airbrake is not installed" do
-    it "only logs, never notifies" do
-      out = StringIO.new
-      l = Logger.new(out)
-      l.airbrake_notifier = nil
-      msg = 'bango'
-
-      l.fatal(msg)
-
-      wait_for(a_request(:post, endpoint)).not_to have_been_made
-      expect(out.string).to match('FATAL -- : bango')
-    end
-  end
-end