uniform_notifier 1.11.0 → 1.13.2

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,19 +8,21 @@ 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)
         @password = growl.include?(:password) ? growl[:password] : nil
@@ -33,8 +37,9 @@ 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)
         @password = growl.include?(:password) ? growl[:password] : nil
@@ -42,34 +47,28 @@ class UniformNotifier
       end
       @password ||= nil
       @host ||= 'localhost'
-      @growl = GNTP.new('uniform_notifier', @host, @password, 23053)
-      @growl.register({:notifications => [{
-                                            :name     => 'uniform_notifier',
-                                            :enabled  => true,
-                                          }]})
+      @growl = GNTP.new('uniform_notifier', @host, @password, 23_053)
+      @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?
@@ -10,12 +12,11 @@ class UniformNotifier
       message = data.values.compact.join("\n")
 
       opt = {}
-      if UniformNotifier.honeybadger.is_a?(Hash)
-        opt = UniformNotifier.honeybadger
-      end
+      opt = UniformNotifier.honeybadger if UniformNotifier.honeybadger.is_a?(Hash)
 
       exception = Exception.new(message)
-      Honeybadger.notify(exception, opt)
+      honeybadger_class = opt[:honeybadger_class] || Honeybadger
+      honeybadger_class.notify(exception, opt)
     end
   end
 end

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

data/lib/uniform_notifier/rails_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class RailsLogger < Base
     def self.active?
@@ -6,7 +8,7 @@ class UniformNotifier
 
     protected
 
-    def self._out_of_channel_notify( data )
+    def self._out_of_channel_notify(data)
       message = data.values.compact.join("\n")
 
       Rails.logger.warn message

data/lib/uniform_notifier/raise.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class Raise < Base
     def self.active?
-      @exception_class
+      defined?(@exception_class) ? @exception_class : false
     end
 
     def self.setup_connection(exception_class)
@@ -10,7 +12,7 @@ class UniformNotifier
 
     protected
 
-    def self._out_of_channel_notify( data )
+    def self._out_of_channel_notify(data)
       message = data.values.compact.join("\n")
 
       raise @exception_class, message

data/lib/uniform_notifier/rollbar.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class RollbarNotifier < Base
+    DEFAULT_LEVEL = 'info'
+
     def self.active?
       !!UniformNotifier.rollbar
     end
@@ -10,7 +14,10 @@ class UniformNotifier
       message = data.values.compact.join("\n")
 
       exception = Exception.new(message)
-      Rollbar.info(exception)
+      level = UniformNotifier.rollbar.fetch(:level, DEFAULT_LEVEL) if UniformNotifier.rollbar.is_a?(Hash)
+      level ||= DEFAULT_LEVEL
+
+      Rollbar.log(level, exception)
     end
   end
 end

data/lib/uniform_notifier/sentry.rb

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

data/lib/uniform_notifier/slack.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class Slack < Base
-    POSSIBLE_OPTIONS = [:username, :channel]
+    POSSIBLE_OPTIONS = %i[username channel].freeze
 
     @slack = nil
 
@@ -9,43 +11,39 @@ class UniformNotifier
         @slack
       end
 
-      def setup_connection(config={})
+      def setup_connection(config = {})
         webhook_url, options = parse_config(config)
         fail_connection('webhook_url required for Slack notification') unless webhook_url
 
         require 'slack-notifier'
         @slack = ::Slack::Notifier.new webhook_url, options
       rescue LoadError
-        fail_connection 'You must install the slack-notifier gem to use Slack notification: '\
-                        '`gem install slack-notifier`'
+        fail_connection 'You must install the slack-notifier gem to use Slack notification: `gem install slack-notifier`'
       end
 
       protected
 
-        def _out_of_channel_notify(data)
-          message = data.values.compact.join("\n")
-          notify(message)
-        end
+      def _out_of_channel_notify(data)
+        message = data.values.compact.join("\n")
+        notify(message)
+      end
 
       private
 
-        def fail_connection(message)
-          @slack = nil
-          raise NotificationError.new(message)
-        end
-
-        def notify(message)
-          @slack.ping message
-        end
+      def fail_connection(message)
+        @slack = nil
+        raise NotificationError, message
+      end
 
-        def parse_config(config)
-          options = config.select do |name, value|
-            POSSIBLE_OPTIONS.include?(name) && !value.nil?
-          end
+      def notify(message)
+        @slack.ping message
+      end
 
-          return config[:webhook_url], options
-        end
+      def parse_config(config)
+        options = config.select { |name, value| POSSIBLE_OPTIONS.include?(name) && !value.nil? }
 
+        [config[:webhook_url], options]
+      end
     end
   end
 end

data/lib/uniform_notifier/terminal_notifier.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class UniformNotifier
+  class TerminalNotifier < Base
+    def self.active?
+      !!UniformNotifier.terminal_notifier
+    end
+
+    protected
+
+    def self._out_of_channel_notify(data)
+      unless defined?(::TerminalNotifier)
+        begin
+          require 'terminal-notifier'
+        rescue LoadError
+          raise NotificationError,
+                'You must install the terminal-notifier gem to use terminal_notifier: `gem install terminal-notifier`'
+        end
+      end
+
+      ::TerminalNotifier.notify(data[:body], title: data[:title])
+    end
+  end
+end

data/lib/uniform_notifier/version.rb

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

data/lib/uniform_notifier/xmpp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class UniformNotifier
   class Xmpp < Base
     @receiver = nil
@@ -8,7 +10,7 @@ class UniformNotifier
       @xmpp
     end
 
-    def self.setup_connection( xmpp_information )
+    def self.setup_connection(xmpp_information)
       return unless xmpp_information
 
       require 'xmpp4r'
@@ -16,43 +18,42 @@ class UniformNotifier
       @xmpp = xmpp_information
       @receiver = xmpp_information[:receiver]
       @password = xmpp_information[:password]
-      @account  = xmpp_information[:account]
+      @account = xmpp_information[:account]
       @show_online_status = xmpp_information[:show_online_status]
       @stay_connected = xmpp_information[:stay_connected].nil? ? true : xmpp_information[:stay_connected]
 
       connect if @stay_connected
     rescue LoadError
       @xmpp = nil
-      raise NotificationError.new( 'You must install the xmpp4r gem to use XMPP notification: `gem install xmpp4r`' )
+      raise NotificationError, 'You must install the xmpp4r gem to use XMPP notification: `gem install xmpp4r`'
     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.connect
-        jid = Jabber::JID.new( @account )
-        @xmpp = Jabber::Client.new( jid )
-        @xmpp.connect
-        @xmpp.auth( @password )
-        @xmpp.send( presence_status ) if @show_online_status
-      end
-
-      def self.notify( message )
-        connect unless @stay_connected
-        message = Jabber::Message.new( @receiver, message ).
-                                  set_type( :normal ).
-                                  set_subject( 'Uniform Notifier' )
-        @xmpp.send( message )
-      end
-
-      def self.presence_status
-        Jabber::Presence.new.set_status( "Uniform Notifier started on #{Time.now}" )
-      end
+
+    def self.connect
+      jid = Jabber::JID.new(@account)
+      @xmpp = Jabber::Client.new(jid)
+      @xmpp.connect
+      @xmpp.auth(@password)
+      @xmpp.send(presence_status) if @show_online_status
+    end
+
+    def self.notify(message)
+      connect unless @stay_connected
+      message = Jabber::Message.new(@receiver, message).set_type(:normal).set_subject('Uniform Notifier')
+      @xmpp.send(message)
+    end
+
+    def self.presence_status
+      Jabber::Presence.new.set_status("Uniform Notifier started on #{Time.now}")
+    end
   end
 end