ExceptionNotifier class to notify devs about exceptions and unexpected situations via Honeybadger.

exception_notifier.rb

# Notify devs about an actual exception, or unexpected situation,
# without necessarily letting it appear to the user as a 500 error.
#
# Decouples the rest of the app from the specific exception logger service.
#
# Suggested location in a Rails project: lib/

class ExceptionNotifier
  def self.notify(exception)
    Honeybadger.notify(exception)
  end

  def self.message(message, details_or_context = nil, context_or_nothing = nil)
    if context_or_nothing
      details = details_or_context
      context = context_or_nothing
    elsif details_or_context.is_a?(Hash)
      details = nil
      context = details_or_context
    else
      details = details_or_context
      context = {}
    end

    details ||= "(no message)"

    Honeybadger.notify(
      error_class: message,
      error_message: details.to_s,
      context: context.to_h,
    )
  end
end

exception_notifier_spec.rb

require "spec_helper"
require "exception_notifier"

describe ExceptionNotifier, ".notify" do
  before do
    stub_const("Honeybadger", double)
  end

  it "passes an exception to Honeybadger" do
    ex = StandardError.new("boom")
    expect(Honeybadger).to receive(:notify).with(ex)
    ExceptionNotifier.notify(ex)
  end
end

describe ExceptionNotifier, ".message" do
  before do
    stub_const("Honeybadger", double)
  end

  it "passes a message to Honeybadger" do

    expect(Honeybadger).to receive(:notify).with(
      error_class: "Boom!",
      error_message: "(no message)",
      context: {},
    )
    ExceptionNotifier.message("Boom!")

    expect(Honeybadger).to receive(:notify).with(
      error_class: "Boom!",
      error_message: "Details!",
      context: {},
    )
    ExceptionNotifier.message("Boom!", "Details!")

    expect(Honeybadger).to receive(:notify).with(
      error_class: "Boom!",
      error_message: "Details!",
      context: { foo: "bar" },
    )
    ExceptionNotifier.message("Boom!", "Details!", foo: "bar")

    expect(Honeybadger).to receive(:notify).with(
      error_class: "Boom!",
      error_message: "(no message)",
      context: { foo: "bar" },
    )
    ExceptionNotifier.message("Boom!", foo: "bar")
  end
end