uniform_notifier 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daf1fcd71af2c468e1ba0fe5173fac2205bae8dd
-  data.tar.gz: c97aeac72e004d585fba564dc09fbc408d5af426
+  metadata.gz: f27b211c1e550787b74d7a57a1f534fda78a5271
+  data.tar.gz: 052c8e0d80a431a89c71d5578c0603fd5609686f
 SHA512:
-  metadata.gz: 23fe312e299e387bba4da21216ad2e0c5dd87e92c032fed14fb5fedd210c21c7a925be46cdfb7a1056609b4493fc17de29fa1c00c9581b970510f9780d8ffd30
-  data.tar.gz: 00446377e262d875c05f5fb78ec8086c9502559e908909243c965687f17abe7bd27f7b586b5a5ab6b17f6ba8038ceb42a1300b98c01d394941f87e2e634f1c65
+  metadata.gz: 925e6cf2f2dfc20a84fef57e1bee9872d5ddb18396142b63e335f9db5fe275650a3def097a6a2688e7411ffe2dd980be1313b5271e577514193f9faf0f2f071b
+  data.tar.gz: 2056c09e18698a84e87f4c8029fea3c73643c7ded92af0f30a40c79edb58b02721a88517012183ebf76f1f6f829150307e3e594151c234fb9e2a438b1feb9eab

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Next Release
 
-## 1.11.0 (13/11/2017)
+## 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
 

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.png)](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/projects/32)
+
 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
 
@@ -56,9 +64,15 @@ By default, all notifiers are disabled, you should enable them first.
 
     # 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
@@ -105,6 +119,9 @@ By default, all notifiers are disabled, you should enable them first.
                              :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
 

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'
@@ -13,17 +15,16 @@ 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,
-                         :sentry
-                        ]
+  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,
-               SentryNotifier
-              ]
+               SentryNotifier, TerminalNotifier].freeze
 
   class NotificationError < StandardError; end
 
@@ -31,7 +32,7 @@ class UniformNotifier
     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?

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?
@@ -15,9 +17,9 @@ class UniformNotifier
       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
-      ))
+                                  grouping_hash: data[:body] || data[:title],
+                                  notification: data
+                                ))
     end
   end
 end

data/lib/uniform_notifier/customized_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class CustomizedLogger < Base
     @logger = nil
@@ -6,7 +8,7 @@ class UniformNotifier
       @logger
     end
 
-    def self._out_of_channel_notify( data )
+    def self._out_of_channel_notify(data)
       message = data.values.compact.join("\n")
       @logger.warn message
     end
@@ -14,10 +16,10 @@ class UniformNotifier
     def self.setup(logdev)
       require 'logger'
 
-      @logger = Logger.new( logdev )
+      @logger = Logger.new(logdev)
 
-      def @logger.format_message( severity, timestamp, progname, msg )
-        "#{timestamp.strftime("%Y-%m-%d %H:%M:%S")}[#{severity}] #{msg}"
+      def @logger.format_message(severity, timestamp, _progname, msg)
+        "#{timestamp.strftime('%Y-%m-%d %H:%M:%S')}[#{severity}] #{msg}"
       end
     end
   end

data/lib/uniform_notifier/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UniformNotifier
-  class Exception < ::Exception; end
+  class Exception < RuntimeError; end
 end

data/lib/uniform_notifier/growl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class Growl < Base
     @growl = nil
@@ -6,18 +8,18 @@ class UniformNotifier
       @growl
     end
 
-    def self.setup_connection( growl )
+    def self.setup_connection(growl)
       setup_connection_growl(growl)
     rescue LoadError
       begin
         setup_connection_gntp(growl)
       rescue LoadError
         @growl = nil
-        raise NotificationError.new( 'You must install the ruby-growl or the ruby_gntp gem to use Growl notification: `gem install ruby-growl` or `gem install ruby_gntp`' )
+        raise NotificationError, 'You must install the ruby-growl or the ruby_gntp gem to use Growl notification: `gem install ruby-growl` or `gem install ruby_gntp`'
       end
     end
 
-    def self.setup_connection_growl( growl )
+    def self.setup_connection_growl(growl)
       return unless growl
       require 'ruby-growl'
       if growl.instance_of?(Hash)
@@ -33,7 +35,7 @@ class UniformNotifier
       notify 'Uniform Notifier Growl has been turned on' if !growl.instance_of?(Hash) || !growl[:quiet]
     end
 
-    def self.setup_connection_gntp( growl )
+    def self.setup_connection_gntp(growl)
       return unless growl
       require 'ruby_gntp'
       if growl.instance_of?(Hash)
@@ -43,33 +45,34 @@ class UniformNotifier
       @password ||= nil
       @host ||= 'localhost'
       @growl = GNTP.new('uniform_notifier', @host, @password, 23053)
-      @growl.register({:notifications => [{
-                                            :name     => 'uniform_notifier',
-                                            :enabled  => true,
-                                          }]})
+      @growl.register(notifications: [{
+                        name: 'uniform_notifier',
+                        enabled: true,
+                      }])
 
       notify 'Uniform Notifier Growl has been turned on (using GNTP)' if !growl.instance_of?(Hash) || !growl[:quiet]
     end
 
     protected
 
-    def self._out_of_channel_notify( data )
+    def self._out_of_channel_notify(data)
       message = data.values.compact.join("\n")
 
-      notify( message )
+      notify(message)
     end
 
     private
-      def self.notify( message )
-        if defined?(::Growl) && @growl.is_a?(::Growl)
-          @growl.notify( 'uniform_notifier', 'Uniform Notifier', message )
-        elsif defined?(::GNTP) && @growl.is_a?(::GNTP)
-          @growl.notify({
-                          :name  => 'uniform_notifier',
-                          :title => 'Uniform Notifier',
-                          :text  => message
-                        })
-        end
+
+    def self.notify(message)
+      if defined?(::Growl) && @growl.is_a?(::Growl)
+        @growl.notify('uniform_notifier', 'Uniform Notifier', message)
+      elsif defined?(::GNTP) && @growl.is_a?(::GNTP)
+        @growl.notify(
+          name: 'uniform_notifier',
+          title: 'Uniform Notifier',
+          text: message
+        )
       end
+    end
   end
 end

data/lib/uniform_notifier/honeybadger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class HoneybadgerNotifier < Base
     def self.active?

data/lib/uniform_notifier/javascript_alert.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class JavascriptAlert < Base
     def self.active?
-      UniformNotifier.alert
+      !!UniformNotifier.alert
     end
 
     protected
 
-    def self._inline_notify( data )
+    def self._inline_notify(data)
       message = data.values.compact.join("\n")
+      options = UniformNotifier.alert.is_a?(Hash) ? UniformNotifier.alert : {}
+      script_attributes = options[:attributes] || {}
 
-      wrap_js_association "alert( #{message.inspect} );"
+      wrap_js_association "alert( #{message.inspect} );", script_attributes
     end
   end
 end

data/lib/uniform_notifier/javascript_console.rb

@@ -1,27 +1,31 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class JavascriptConsole < Base
     def self.active?
-      UniformNotifier.console
+      !!UniformNotifier.console
     end
 
     protected
 
-    def self._inline_notify( data )
+    def self._inline_notify(data)
       message = data.values.compact.join("\n")
+      options = UniformNotifier.console.is_a?(Hash) ? UniformNotifier.console : {}
+      script_attributes = options[:attributes] || {}
 
-      code = <<-CODE
-if (typeof(console) !== 'undefined' && console.log) {
-  if (console.groupCollapsed && console.groupEnd) {
-    console.groupCollapsed(#{"Uniform Notifier".inspect});
-    console.log(#{message.inspect});
-    console.groupEnd();
-  } else {
-    console.log(#{message.inspect});
-  }
-}
-CODE
+      code = <<~CODE
+        if (typeof(console) !== 'undefined' && console.log) {
+          if (console.groupCollapsed && console.groupEnd) {
+            console.groupCollapsed(#{'Uniform Notifier'.inspect});
+            console.log(#{message.inspect});
+            console.groupEnd();
+          } else {
+            console.log(#{message.inspect});
+          }
+        }
+      CODE
 
-      wrap_js_association code
+      wrap_js_association code, script_attributes
     end
   end
 end