uniform_notifier 1.10.0 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ce5c6778339ac98c3683322370c55b36e2e0f6d8
-  data.tar.gz: 2c10528a49539b46b7cdfbde658d5032e04ccffb
+SHA256:
+  metadata.gz: dacef5e1c0f74c728aa2a8e4b6fe6e31701b426657c3416a9180f768f61fad4c
+  data.tar.gz: 86c66452779fae50c955177392892a33aaa34624274b7c5c1faaec72f56d2917
 SHA512:
-  metadata.gz: bdff272e464293c384f81eb736b0e1d639293ae84b97c3212cff43f8ea5e150f43095f5f4efd055c57c50eb9be4e9d664d75efcf4b3d07d16083b058cf65e335
-  data.tar.gz: 0918ca02b1d871578e5cd5c45bb0037553ef7739adcbdd73d4655dad8d796290a0890e38de0fe1168c57af2dce392d458ab998507141a3ed46ed1c1cdea466a4
+  metadata.gz: ea912a1f196dacde8e5146304f3b5fb0d76b9d46f35a12e76b0a50e1e4c52b5b27e2dd6742fb1f5276f1a73b53e15d667f9485ababca63c16e896302d762f203
+  data.tar.gz: f58c6974795db0b7e6e1e04bf33997bdcc280999f6b5bbf0ef6b0b20b323fed7d005b2bc24fce7b444f78ce9186d75bbe6c024a2e8d4fec42b9ce6998b3ce0a9

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.3.6

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Next Release
 
+## 1.13.0 (10/05/2019)
+
+* Add Honeybadger class dependecy injection.
+* Allow configuration of Rollbar level.
+
+## 1.12.1 (10/30/2018)
+
+* Require Ruby 2.3+
+
+## 1.12.0 (08/17/2018)
+
+* Add [terminal-notifier](https://github.com/julienXX/terminal-notifier) support
+* Lots of refactors from Awesome Code
+
+## 1.11.0 (11/13/2017)
+
+* Add Sentry notifier
+
 ## 1.10.0 (01/06/2016)
 
 * Add honeybadger notifier

data/Gemfile

@@ -1,4 +1,6 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in uniform_notifier.gemspec
 gemspec

data/README.md

@@ -1,5 +1,9 @@
 # UniformNotifier
 
+[![Build
+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.
 
 ## Install
@@ -40,11 +44,15 @@ if you want to notify by slack, you should install slack-notifier first
 
     gem install slack-notifier
 
+if you want to notify by terminal-notifier, you must install it first
+
+    gem install terminal-notifier
+
 ### add it into Gemfile (Bundler)
 
     gem "uniform_notifier"
 
-  you should add ruby-growl, ruby_gntp, xmpp4r, airbrake, bugsnag, honeybadger, slack-notifier gem if you want.
+  you should add ruby-growl, ruby_gntp, xmpp4r, airbrake, bugsnag, honeybadger, slack-notifier, terminal-notifier gem if you want.
 
 ## Usage
 
@@ -54,80 +62,95 @@ the other is <code>out_of_channel_notify</code>, for rails logger, customized lo
 
 By default, all notifiers are disabled, you should enable them first.
 
-    # javascript alert
-    UniformNotifier.alert = true
-
-    # javascript console (Safari/Webkit browsers or Firefox w/Firebug installed)
-    UniformNotifier.console = true
-
-    # rails logger
-    UniformNotifier.rails_logger = true
-
-    # airbrake
-    UniformNotifier.airbrake = true
-    # airbrake with options
-    UniformNotifier.airbrake = { :error_class => Exception }
-
-    # Honeybadger
-    #
-    # Reporting live data from development is disabled by default. Ensure
-    # that the `report_data` option is enabled via configuration.
-    UniformNotifier.honeybadger = true
-    # Honeybadger with options
-    UniformNotifier.honeybadger = { :error_class => 'Exception' }
-
-    # rollbar
-    UniformNotifier.rollbar = true
-
-    # bugsnag
-    UniformNotifier.bugsnag = true
-    # bugsnag with options
-    UniformNotifier.bugsnag = { :api_key => 'something' }
-
-    # slack
-    UniformNotifier.slack = true
-    # slack with options
-    UniformNotifier.slack = { :webhook_url => 'http://some.slack.url', :foo => 'bar' }
-
-    # customized logger
-    logger = File.open('notify.log', 'a+')
-    logger.sync = true
-    UniformNotifier.customized_logger = logger
-
-    # growl without password
-    UniformNotifier.growl = true
-    # growl with passowrd
-    UniformNotifier.growl = { :password => 'growl password' }
-
-    # xmpp
-    UniformNotifier.xmpp = { :account => 'sender_account@jabber.org',
-                             :password => 'password_for_jabber',
-                             :receiver => 'recipient_account@jabber.org',
-                             :show_online_status => true }
-
-    # raise an error
-    UniformNotifier.raise = true # raise a generic exception
-
-    class MyExceptionClass < Exception; end
-    UniformNotifier.raise = MyExceptionClass # raise a custom exception type
-
-    UniformNotifier.raise = false # don't raise errors
+```ruby
+# javascript alert
+UniformNotifier.alert = true
+# javascript alert with options
+# the attributes key adds custom attributes to the script tag appended to the body
+UniformNotifier.alert = { :attributes => { :nonce => 'mySecret-nonce', 'data-key' => 'value' } }
+
+# javascript console (Safari/Webkit browsers or Firefox w/Firebug installed)
+UniformNotifier.console = true
+# javascript console with options
+# the attributes key adds custom attributes to the script tag appended to the body
+UniformNotifier.console = { :attributes => { :nonce => 'mySecret-nonce', 'data-key' => 'value' } }
+
+# rails logger
+UniformNotifier.rails_logger = true
+
+# airbrake
+UniformNotifier.airbrake = true
+# airbrake with options
+UniformNotifier.airbrake = { :error_class => Exception }
+
+# Honeybadger
+#
+# Reporting live data from development is disabled by default. Ensure
+# that the `report_data` option is enabled via configuration.
+UniformNotifier.honeybadger = true
+# Honeybadger with options
+UniformNotifier.honeybadger = { :error_class => 'Exception' }
+
+# rollbar
+UniformNotifier.rollbar = true
+# rollbar with options (level can be 'debug', 'info', 'warning', 'error' or 'critical')
+UniformNotifier.rollbar = { :level => 'warning' }
+
+# bugsnag
+UniformNotifier.bugsnag = true
+# bugsnag with options
+UniformNotifier.bugsnag = { :api_key => 'something' }
+
+# slack
+UniformNotifier.slack = true
+# slack with options
+UniformNotifier.slack = { :webhook_url => 'http://some.slack.url', :channel => '#default', :username => 'notifier' }
+
+# customized logger
+logger = File.open('notify.log', 'a+')
+logger.sync = true
+UniformNotifier.customized_logger = logger
+
+# growl without password
+UniformNotifier.growl = true
+# growl with passowrd
+UniformNotifier.growl = { :password => 'growl password' }
+
+# xmpp
+UniformNotifier.xmpp = { :account => 'sender_account@jabber.org',
+                         :password => 'password_for_jabber',
+                         :receiver => 'recipient_account@jabber.org',
+                         :show_online_status => true }
+
+# terminal-notifier
+UniformNotifier.terminal_notifier = true
+
+# raise an error
+UniformNotifier.raise = true # raise a generic exception
+
+class MyExceptionClass < Exception; end
+UniformNotifier.raise = MyExceptionClass # raise a custom exception type
+
+UniformNotifier.raise = false # don't raise errors
+```
 
 After that, you can enjoy the notifiers, that's cool!
 
-    # the notify message will be notified to rails logger, customized logger, growl or xmpp.
-    UniformNotifier.active_notifiers.each do |notifier|
-      notifier.out_of_channel_notify("customize message")
-    end
-
-    # the notify message will be wrapped by <script type="text/javascript">...</script>,
-    # you should append the javascript_str at the bottom of http response body.
-    # for more information, please check https://github.com/flyerhzm/bullet/blob/master/lib/bullet/rack.rb
-    responses = []
-    UniformNotifier.active_notifiers.each do |notifier|
-      responses << notifier.inline_notify("customize message")
-    end
-    javascript_str = responses.join("\n")
+```ruby
+# the notify message will be notified to rails logger, customized logger, growl or xmpp.
+UniformNotifier.active_notifiers.each do |notifier|
+  notifier.out_of_channel_notify("customize message")
+end
+
+# the notify message will be wrapped by <script type="text/javascript">...</script>,
+# you should append the javascript_str at the bottom of http response body.
+# for more information, please check https://github.com/flyerhzm/bullet/blob/master/lib/bullet/rack.rb
+responses = []
+UniformNotifier.active_notifiers.each do |notifier|
+  responses << notifier.inline_notify("customize message")
+end
+javascript_str = responses.join("\n")
+```
 
 ## Growl Support
 
@@ -141,10 +164,6 @@ To get Growl support up-and-running, follow the steps below:
 * Restart Growl ("General" tab -> Stop Growl -> Start Growl)
 * Boot up your application. UniformNotifier will automatically send a Growl notification when Growl is turned on. If you do not see it when your application loads, make sure it is enabled in your initializer and double-check the steps above.
 
-### Ruby 1.9 issue
-
-ruby-growl gem has an issue about md5 in ruby 1.9, if you use growl and ruby 1.9, check this [gist][1]
-
 ## XMPP/Jabber Support
 
 To get XMPP support up-and-running, follow the steps below:
@@ -157,4 +176,3 @@ To get XMPP support up-and-running, follow the steps below:
 
 
 [0]: https://github.com/flyerhzm/bullet
-[1]: https://gist.github.com/300184

data/Rakefile

@@ -1,25 +1,27 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require "rake"
-require "rdoc/task"
-require "rspec"
-require "rspec/core/rake_task"
+require 'rake'
+require 'rdoc/task'
+require 'rspec'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = "spec/**/*_spec.rb"
+  spec.pattern = 'spec/**/*_spec.rb'
 end
 
 RSpec::Core::RakeTask.new('spec:progress') do |spec|
-  spec.rspec_opts = %w(--format progress)
-  spec.pattern = "spec/**/*_spec.rb"
+  spec.rspec_opts = %w[--format progress]
+  spec.pattern = 'spec/**/*_spec.rb'
 end
 
 Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
+  rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "uniform_notifier #{UniformNotifier::VERSION}"
-  rdoc.rdoc_files.include("README*")
-  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-task :default => :spec
+task default: :spec

data/lib/uniform_notifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uniform_notifier/base'
 require 'uniform_notifier/errors'
 require 'uniform_notifier/javascript_alert'
@@ -8,25 +10,55 @@ require 'uniform_notifier/xmpp'
 require 'uniform_notifier/rails_logger'
 require 'uniform_notifier/customized_logger'
 require 'uniform_notifier/airbrake'
+require 'uniform_notifier/sentry'
 require 'uniform_notifier/rollbar'
 require 'uniform_notifier/bugsnag'
 require 'uniform_notifier/slack'
 require 'uniform_notifier/raise'
+require 'uniform_notifier/terminal_notifier'
 
 class UniformNotifier
-  AVAILABLE_NOTIFIERS = [:alert, :console, :growl, :honeybadger, :xmpp, :rails_logger,
-                         :customized_logger, :airbrake, :rollbar, :bugsnag, :slack, :raise]
+  AVAILABLE_NOTIFIERS = %i[
+    alert
+    console
+    growl
+    honeybadger
+    xmpp
+    rails_logger
+    customized_logger
+    airbrake
+    rollbar
+    bugsnag
+    slack
+    raise
+    sentry
+    terminal_notifier
+  ].freeze
 
-  NOTIFIERS = [JavascriptAlert, JavascriptConsole, Growl, HoneybadgerNotifier, Xmpp, RailsLogger,
-               CustomizedLogger, AirbrakeNotifier, RollbarNotifier, BugsnagNotifier, Raise, Slack]
+  NOTIFIERS = [
+    JavascriptAlert,
+    JavascriptConsole,
+    Growl,
+    HoneybadgerNotifier,
+    Xmpp,
+    RailsLogger,
+    CustomizedLogger,
+    AirbrakeNotifier,
+    RollbarNotifier,
+    BugsnagNotifier,
+    Raise,
+    Slack,
+    SentryNotifier,
+    TerminalNotifier
+  ].freeze
 
   class NotificationError < StandardError; end
 
-  class <<self
+  class << self
     attr_accessor(*AVAILABLE_NOTIFIERS)
 
     def active_notifiers
-      NOTIFIERS.select { |notifier| notifier.active? }
+      NOTIFIERS.select(&:active?)
     end
 
     undef :growl=

data/lib/uniform_notifier/airbrake.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class AirbrakeNotifier < Base
     def self.active?
@@ -10,9 +12,7 @@ class UniformNotifier
       message = data.values.compact.join("\n")
 
       opt = {}
-      if UniformNotifier.airbrake.is_a?(Hash)
-        opt = UniformNotifier.airbrake
-      end
+      opt = UniformNotifier.airbrake if UniformNotifier.airbrake.is_a?(Hash)
 
       exception = Exception.new(message)
       Airbrake.notify(exception, opt)

data/lib/uniform_notifier/base.rb

@@ -1,40 +1,43 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class Base
     def self.active?
       false
     end
 
-    def self.inline_notify( data )
+    def self.inline_notify(data)
       return unless active?
 
       # For compatibility to the old protocol
-      data = { :title => data } if data.is_a?(String)
+      data = { title: data } if data.is_a?(String)
 
-      _inline_notify( data )
+      _inline_notify(data)
     end
 
-    def self.out_of_channel_notify( data )
+    def self.out_of_channel_notify(data)
       return unless active?
 
       # For compatibility to the old protocol
-      data = { :title => data } if data.is_a?(String)
+      data = { title: data } if data.is_a?(String)
 
       _out_of_channel_notify(data)
     end
 
     protected
 
-    def self._inline_notify( data )
-    end
+    def self._inline_notify(data); end
 
-    def self._out_of_channel_notify( data )
-    end
+    def self._out_of_channel_notify(data); end
+
+    def self.wrap_js_association(code, attributes = {})
+      attributes = { type: 'text/javascript' }.merge(attributes || {})
+      attributes_string = attributes.map { |k, v| "#{k}=#{v.to_s.inspect}" }.join(' ')
 
-    def self.wrap_js_association( code )
-      <<-CODE
-<script type="text/javascript">/*<![CDATA[*/
-#{code}
-/*]]>*/</script>
+      <<~CODE
+        <script #{attributes_string}>/*<![CDATA[*/
+        #{code}
+        /*]]>*/</script>
       CODE
     end
   end

data/lib/uniform_notifier/bugsnag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class BugsnagNotifier < Base
     def self.active?
@@ -8,16 +10,11 @@ class UniformNotifier
 
     def self._out_of_channel_notify(data)
       opt = {}
-      if UniformNotifier.bugsnag.is_a?(Hash)
-        opt = UniformNotifier.bugsnag
-      end
+      opt = UniformNotifier.bugsnag if UniformNotifier.bugsnag.is_a?(Hash)
 
       exception = Exception.new(data[:title])
       exception.set_backtrace(data[:backtrace]) if data[:backtrace]
-      Bugsnag.notify(exception, opt.merge(
-        :grouping_hash => data[:body] || data[:title],
-        :notification => data
-      ))
+      Bugsnag.notify(exception, opt.merge(grouping_hash: data[:body] || data[:title], notification: data))
     end
   end
 end