barsoom_utils 0.2.0.76 → 0.2.0.78

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc8c7ab6a54929794df46c90b1cbe14474f0461989ee071a5917176c057db757
-  data.tar.gz: d016e08c7b0b8fe901eaabafa14027bb9da1c533967b69e078b74191c7da9693
+  metadata.gz: f10ec24dca48ed3703590008317664ee7993d1efbfd0b3d4c5cc1d876c5712ca
+  data.tar.gz: c9d43fdc45e23e2a267c390007cc5c685273d5da581f8a413fb2da106ec25d08
 SHA512:
-  metadata.gz: 0b126fb0cbb946764f8e2132e27fd8aaf546857a00caf378086ac20caeffaff5cad49a004472e89397c759e5e704d074a54fd61cf8df8277bce7b2694c511664
-  data.tar.gz: f8d54ae7b4b409da656cc85af93cb47fc12aa436d8f59e90b39521323f9c76505cf5631713d5ac437fe1488b8c49bd2a576ed1a963d014db73234b21a6571e39
+  metadata.gz: bfb7e4a46b94501ce9d505c0b19b674006f75c48cd3b16f18c7573c6d006ab41f9b3196529a5fa6a383d7c2454a41ac12dcfacd3da05db9e40b19f217715ae32
+  data.tar.gz: f9e748ad9dfb716d217df3420fafb7ac93c859d07b240e24dcd9c668b9ff741f9d6631a6f467abea7ca24a71867e39ed8b37885a4ea53ab15e0ee83f3593b277

data/Gemfile

@@ -15,4 +15,5 @@ group :development, :test do
   gem "redis"
   gem "rspec"
   gem "rubocop"
+  gem "sentry-ruby"
 end

data/VERSION

@@ -1 +1 @@
-0.2.0.76
+0.2.0.78

data/lib/barsoom_utils/exception_notifier.rb

@@ -11,10 +11,16 @@ module BarsoomUtils
         raise "Expected an exception but got: #{exception.inspect}"
       end
 
-      Honeybadger.notify(exception, context: context)
+      ensure_notifier!
+
+      result = Honeybadger.notify(exception, context: context) if defined?(Honeybadger)
+      Sentry.capture_exception(exception, extra: context) if defined?(Sentry)
+      result
     end
 
     def self.message(message, details_or_context = nil, context_or_nothing = nil)
+      ensure_notifier!
+
       if context_or_nothing
         details = details_or_context
         context = context_or_nothing
@@ -26,13 +32,29 @@ module BarsoomUtils
         context = {}
       end
 
-      details ||= "(no message)"
+      if defined?(Honeybadger)
+        result = Honeybadger.notify(
+          error_class: message,
+          error_message: (details || "(no message)").to_s,
+          context: context.to_h,
+        )
+      end
+
+      if defined?(Sentry)
+        title = details ? "#{message}: #{details}" : message.to_s
+        Sentry.capture_message(title, extra: context.to_h)
+      end
+
+      result
+    end
+
+    private
+
+    private_class_method \
+    def self.ensure_notifier!
+      return if defined?(Honeybadger) || defined?(Sentry)
 
-      Honeybadger.notify(
-        error_class: message,
-        error_message: details.to_s,
-        context: context.to_h,
-      )
+      raise "Cannot notify: neither Honeybadger nor Sentry is available."
     end
   end
 end

data/spec/exception_notifier_spec.rb

@@ -1,26 +1,31 @@
 # frozen_string_literal: true
 require "barsoom_utils/exception_notifier"
 require "honeybadger"
+require "sentry-ruby"
 require "fixme"
 
 RSpec.describe BarsoomUtils::ExceptionNotifier do
   before do
     allow(Honeybadger).to receive(:notify)
+    allow(Sentry).to receive(:capture_exception)
+    allow(Sentry).to receive(:capture_message)
   end
 
   describe ".notify" do
     let(:ex) { StandardError.new("boom") }
 
-    it "passes an exception to Honeybadger" do
+    it "passes an exception to Honeybadger and Sentry" do
       BarsoomUtils::ExceptionNotifier.notify(ex)
 
       expect(Honeybadger).to have_received(:notify).with(ex, context: {})
+      expect(Sentry).to have_received(:capture_exception).with(ex, extra: {})
     end
 
     it "can pass through context info" do
       BarsoomUtils::ExceptionNotifier.notify(ex, context: { foo: "bar" })
 
       expect(Honeybadger).to have_received(:notify).with(ex, context: { foo: "bar" })
+      expect(Sentry).to have_received(:capture_exception).with(ex, extra: { foo: "bar" })
     end
 
     it "complains if given a non-exception" do
@@ -29,11 +34,51 @@ RSpec.describe BarsoomUtils::ExceptionNotifier do
       }.to raise_error(/Expected an exception but got:.*foo.*bar/)
 
       expect(Honeybadger).not_to have_received(:notify)
+      expect(Sentry).not_to have_received(:capture_exception)
+    end
+
+    it "returns Honeybadger's result" do
+      allow(Honeybadger).to receive(:notify).and_return(:sentinel)
+
+      expect(BarsoomUtils::ExceptionNotifier.notify(ex)).to eq(:sentinel)
+    end
+
+    context "without Sentry" do
+      before { hide_const("Sentry") }
+
+      it "still notifies Honeybadger and raises nothing" do
+        BarsoomUtils::ExceptionNotifier.notify(ex, context: { foo: "bar" })
+
+        expect(Honeybadger).to have_received(:notify).with(ex, context: { foo: "bar" })
+      end
+    end
+
+    context "without Honeybadger" do
+      before { hide_const("Honeybadger") }
+
+      it "still notifies Sentry and raises nothing" do
+        BarsoomUtils::ExceptionNotifier.notify(ex, context: { foo: "bar" })
+
+        expect(Sentry).to have_received(:capture_exception).with(ex, extra: { foo: "bar" })
+      end
+    end
+
+    context "without either notifier" do
+      before do
+        hide_const("Honeybadger")
+        hide_const("Sentry")
+      end
+
+      it "raises" do
+        expect {
+          BarsoomUtils::ExceptionNotifier.notify(ex)
+        }.to raise_error(/neither Honeybadger nor Sentry/)
+      end
     end
   end
 
   describe ".message" do
-    it "passes a message to Honeybadger" do
+    it "passes a message to Honeybadger and Sentry" do
       BarsoomUtils::ExceptionNotifier.message("Boom!")
 
       expect(Honeybadger).to have_received(:notify).with(
@@ -41,6 +86,7 @@ RSpec.describe BarsoomUtils::ExceptionNotifier do
         error_message: "(no message)",
         context: {},
       )
+      expect(Sentry).to have_received(:capture_message).with("Boom!", extra: {})
     end
 
     it "can take a custom details string" do
@@ -51,6 +97,13 @@ RSpec.describe BarsoomUtils::ExceptionNotifier do
         error_message: "Details!",
         context: {},
       )
+      expect(Sentry).to have_received(:capture_message).with("Boom!: Details!", extra: {})
+    end
+
+    it "coerces the message to a string for Sentry" do
+      BarsoomUtils::ExceptionNotifier.message(:boom)
+
+      expect(Sentry).to have_received(:capture_message).with("boom", extra: {})
     end
 
     it "can take a context hash" do
@@ -61,6 +114,7 @@ RSpec.describe BarsoomUtils::ExceptionNotifier do
         error_message: "(no message)",
         context: { foo: "bar" },
       )
+      expect(Sentry).to have_received(:capture_message).with("Boom!", extra: { foo: "bar" })
     end
 
     it "can take a custom details string and a context hash" do
@@ -71,6 +125,50 @@ RSpec.describe BarsoomUtils::ExceptionNotifier do
         error_message: "Details!",
         context: { foo: "bar" },
       )
+      expect(Sentry).to have_received(:capture_message).with("Boom!: Details!", extra: { foo: "bar" })
+    end
+
+    it "returns Honeybadger's result" do
+      allow(Honeybadger).to receive(:notify).and_return(:sentinel)
+
+      expect(BarsoomUtils::ExceptionNotifier.message("Boom!")).to eq(:sentinel)
+    end
+
+    context "without Sentry" do
+      before { hide_const("Sentry") }
+
+      it "still notifies Honeybadger and raises nothing" do
+        BarsoomUtils::ExceptionNotifier.message("Boom!", "Details!", foo: "bar")
+
+        expect(Honeybadger).to have_received(:notify).with(
+          error_class: "Boom!",
+          error_message: "Details!",
+          context: { foo: "bar" },
+        )
+      end
+    end
+
+    context "without Honeybadger" do
+      before { hide_const("Honeybadger") }
+
+      it "still notifies Sentry and raises nothing" do
+        BarsoomUtils::ExceptionNotifier.message("Boom!", "Details!", foo: "bar")
+
+        expect(Sentry).to have_received(:capture_message).with("Boom!: Details!", extra: { foo: "bar" })
+      end
+    end
+
+    context "without either notifier" do
+      before do
+        hide_const("Honeybadger")
+        hide_const("Sentry")
+      end
+
+      it "raises" do
+        expect {
+          BarsoomUtils::ExceptionNotifier.message("Boom!")
+        }.to raise_error(/neither Honeybadger nor Sentry/)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: barsoom_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.0.76
+  version: 0.2.0.78
 platform: ruby
 authors:
 - Tomas Skogberg