uniform_notifier 1.13.2 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caeab8d8f879b1215cb8f9e7523400cc2965820eecfc78d2cb0ba25186b47973
-  data.tar.gz: 3a7dc976b54fcb942ebe201634b59147b8b92488b9971a25d4ce89615a3c6dbf
+  metadata.gz: 2e0dc90eb392f340e5bcb87c74e7f5ff5abdfe056c2f9a477349ed21806c981c
+  data.tar.gz: da95631ac719cf684e878f377cd93ab1678ed6d5d18ba63c22b3f04d77224386
 SHA512:
-  metadata.gz: b036883f44cc5504b74695abe5a967fa8c673eb006b3704402bf2802c97baeaa1fcb27f54bd62f8fd6a2b1fa6eac7cd466f8e55621e533749548ae37b41a0f0e
-  data.tar.gz: 38c16a936df8d779f778a23dfa740d507548e26c9b4d28b42bcebab2ebc59872ffb56cc23dbb8fff0275d036d925a99e2cef1983eae8c9add4d81dfc0a84deb3
+  metadata.gz: 73a4d1e31f1604646b28f703ab865b6644413e42d41096c5e983d7fbbb0ae8a6ea1b2d14c88ffea7c15007d431aebedefd948d4365e265a3f074efd166ccc3a6
+  data.tar.gz: '08c69d23ee80f460409ab2edd5949a7beff96799afc5aa5ea8adb89536969fb9c1defa096ac24a652551280ff0b1a8b86c85ddde5443c7ade8f04c459ee42a30'

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Next Release
 
+# 1.14.0 (02/26/2021)
+
+* Add AppSignal integration
 * Fix UniformNotifier::Raise.active? when .rails= receives a false value
 
 ## 1.13.0 (10/05/2019)

data/README.md

@@ -4,7 +4,7 @@
 Status](https://secure.travis-ci.org/flyerhzm/uniform_notifier.svg)](http://travis-ci.org/flyerhzm/uniform_notifier)
 [![AwesomeCode Status for flyerhzm/uniform_notifier](https://awesomecode.io/projects/3e29a7de-0b37-4ecf-b06d-410ebf815174/status)](https://awesomecode.io/repos/flyerhzm/uniform_notifier)
 
-uniform_notifier is extracted from [bullet][0], it gives you the ability to send notification through rails logger, customized logger, javascript alert, javascript console, growl, xmpp, airbrake and honeybadger.
+uniform_notifier is extracted from [bullet][0], it gives you the ability to send notification through rails logger, customized logger, javascript alert, javascript console, growl, xmpp, airbrake, honeybadger and AppSignal.
 
 ## Install
 
@@ -40,6 +40,10 @@ if you want to notify by bugsnag, you should install bugsnag first
 
     gem install bugsnag
 
+if you want to notify by AppSignal, you should install AppSignal first
+
+    gem install appsignal
+
 if you want to notify by slack, you should install slack-notifier first
 
     gem install slack-notifier
@@ -83,6 +87,11 @@ UniformNotifier.airbrake = true
 # airbrake with options
 UniformNotifier.airbrake = { :error_class => Exception }
 
+# AppSignal
+UniformNotifier.appsignal = true
+# AppSignal with options
+UniformNotifier.appsignal = { :namespace => "Background", :tags => { :hostname => "frontend1" } }
+
 # Honeybadger
 #
 # Reporting live data from development is disabled by default. Ensure

data/lib/uniform_notifier.rb

@@ -13,6 +13,7 @@ require 'uniform_notifier/airbrake'
 require 'uniform_notifier/sentry'
 require 'uniform_notifier/rollbar'
 require 'uniform_notifier/bugsnag'
+require 'uniform_notifier/appsignal'
 require 'uniform_notifier/slack'
 require 'uniform_notifier/raise'
 require 'uniform_notifier/terminal_notifier'
@@ -32,6 +33,7 @@ class UniformNotifier
     slack
     raise
     sentry
+    appsignal
     terminal_notifier
   ].freeze
 
@@ -49,6 +51,7 @@ class UniformNotifier
     Raise,
     Slack,
     SentryNotifier,
+    AppsignalNotifier,
     TerminalNotifier
   ].freeze
 

data/lib/uniform_notifier/appsignal.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class UniformNotifier
+  class AppsignalNotifier < Base
+    def self.active?
+      !!UniformNotifier.appsignal
+    end
+
+    protected
+
+    def self._out_of_channel_notify(data)
+      opt = UniformNotifier.appsignal.is_a?(Hash) ? UniformNotifier.appsignal : {}
+
+      exception = Exception.new(data[:title])
+      exception.set_backtrace(data[:backtrace]) if data[:backtrace]
+
+      tags = opt.fetch(:tags, {}).merge(data.fetch(:tags, {}))
+      namespace = data[:namespace] || opt[:namespace]
+
+      Appsignal.send_error(*[exception, tags, namespace].compact)
+    end
+  end
+end

data/lib/uniform_notifier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class UniformNotifier
-  VERSION = '1.13.2'
+  VERSION = '1.14.0'
 end

data/spec/uniform_notifier/appsignal_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class Appsignal
+  # mock AppSignal
+end
+
+RSpec.describe UniformNotifier::AppsignalNotifier do
+  it 'should not notify appsignal' do
+    expect(UniformNotifier::AppsignalNotifier.out_of_channel_notify(title: 'notify appsignal')).to be_nil
+  end
+
+  it 'should notify appsignal with keyword title' do
+    expect(Appsignal).to receive(:send_error)
+      .with(UniformNotifier::Exception.new('notify appsignal'), {})
+
+    UniformNotifier.appsignal = true
+    expect(UniformNotifier::AppsignalNotifier.out_of_channel_notify(title: 'notify appsignal'))
+  end
+
+  it 'should notify appsignal with first argument title' do
+    expect(Appsignal).to receive(:send_error)
+      .with(UniformNotifier::Exception.new('notify appsignal'), {})
+
+    UniformNotifier.appsignal = true
+    UniformNotifier::AppsignalNotifier.out_of_channel_notify('notify appsignal')
+  end
+
+  it 'should notify appsignal with tags' do
+    expect(Appsignal).to receive(:send_error)
+      .with(UniformNotifier::Exception.new('notify appsignal'), { foo: :bar })
+
+    UniformNotifier.appsignal = true
+    UniformNotifier::AppsignalNotifier.out_of_channel_notify(title: 'notify appsignal', tags: { foo: :bar})
+  end
+
+  it 'should notify appsignal with default namespace' do
+    expect(Appsignal).to receive(:send_error)
+      .with(UniformNotifier::Exception.new('notify appsignal'), {}, 'web')
+
+    UniformNotifier.appsignal = { namespace: 'web' }
+    UniformNotifier::AppsignalNotifier.out_of_channel_notify('notify appsignal')
+  end
+
+  it 'should notify appsignal with overridden namespace' do
+    expect(Appsignal).to receive(:send_error)
+      .with(UniformNotifier::Exception.new('notify appsignal'), { foo: :bar }, 'background')
+
+    UniformNotifier.appsignal = { namespace: 'web' }
+    UniformNotifier::AppsignalNotifier.out_of_channel_notify(
+      title: 'notify appsignal',
+      tags: { foo: :bar },
+      namespace: 'background'
+    )
+  end
+
+  it 'should notify appsignal with merged tags' do
+    expect(Appsignal).to receive(:send_error)
+      .with(UniformNotifier::Exception.new('notify appsignal'), { user: 'Bob', hostname: 'frontend2', site: 'first' }, 'background')
+
+    UniformNotifier.appsignal = { namespace: 'web', tags: { hostname: 'frontend1', user: 'Bob' } }
+    UniformNotifier::AppsignalNotifier.out_of_channel_notify(
+      title: 'notify appsignal',
+      tags: { hostname: 'frontend2', site: 'first' },
+      namespace: 'background'
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uniform_notifier
 version: !ruby/object:Gem::Version
-  version: 1.13.2
+  version: 1.14.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -97,6 +97,7 @@ files:
 - Rakefile
 - lib/uniform_notifier.rb
 - lib/uniform_notifier/airbrake.rb
+- lib/uniform_notifier/appsignal.rb
 - lib/uniform_notifier/base.rb
 - lib/uniform_notifier/bugsnag.rb
 - lib/uniform_notifier/customized_logger.rb
@@ -115,6 +116,7 @@ files:
 - lib/uniform_notifier/xmpp.rb
 - spec/spec_helper.rb
 - spec/uniform_notifier/airbrake_spec.rb
+- spec/uniform_notifier/appsignal_spec.rb
 - spec/uniform_notifier/base_spec.rb
 - spec/uniform_notifier/bugsnag_spec.rb
 - spec/uniform_notifier/customized_logger_spec.rb
@@ -160,6 +162,7 @@ summary: uniform notifier for rails logger, customized logger, javascript alert,
 test_files:
 - spec/spec_helper.rb
 - spec/uniform_notifier/airbrake_spec.rb
+- spec/uniform_notifier/appsignal_spec.rb
 - spec/uniform_notifier/base_spec.rb
 - spec/uniform_notifier/bugsnag_spec.rb
 - spec/uniform_notifier/customized_logger_spec.rb