uniform_notifier 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cbfb1cbe32444a41960c0a9671bac48a43d96722312c1717c0c4e7a2a804433
-  data.tar.gz: 6c82f5aa72805717af977bc454464eaaf6cf2222e96cf6b97581265eb52ec678
+  metadata.gz: 345526c76633d08822fec4f5aae85d96ddae55f7ad72182fac5da280063278fa
+  data.tar.gz: 3847746070513a8e12a89853821a300579f416be6e9d1f1cc80e2492c5cf7f33
 SHA512:
-  metadata.gz: 6870a31994f2d3592c30f145c76efedb4cb773053231732d4a2e369ced6ff013f37c673df7279d90bd4067dfd6029073b55fc24b957936519033abae809aef94
-  data.tar.gz: '09a5bb04b7966baf30a5af2b207dd7e33c2450e8058ebf16efe23ce7f024f3330e49ceaf07b3c1571fb0b316e1fffa1ce62673431f2145ac2762fe2b55e19b16'
+  metadata.gz: a87a4ad5a16f0f9fe28426318a3c7979dfa6d3c0ae4381f5971a4d31cec48863af9e5474f093fd9e00690cd05e610cba10e79f6a444092a623428637a1b06fc2
+  data.tar.gz: 8e4a5d81b898650f16eb1bc296c75b36f38d596fb82e94f2cb6f8615cdde94ed4f31c424a89b99db1f07cd8524faede84e115ea616bfa191a0e21f19fd5ca04f

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.7
+          - 3.0
+          - 3.1
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Next Release
 
+# 1.16.0 (03/24/2022)
+
+* Drop Growl support
+* Move CI from travis to github actions
+
 # 1.15.0 (03/21/2022)
 
 * Fix bugsnag notifications

data/Gemfile

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in uniform_notifier.gemspec
 gemspec
 
 gem 'rake'
+gem 'rexml' # for Ruby 3.0+

data/README.md

@@ -1,10 +1,9 @@
 # UniformNotifier
 
-[![Build
-Status](https://secure.travis-ci.org/flyerhzm/uniform_notifier.svg)](http://travis-ci.org/flyerhzm/uniform_notifier)
+[![CI](https://github.com/flyerhzm/uniform_notifier/actions/workflows/ci.yml/badge.svg)](https://github.com/flyerhzm/uniform_notifier/actions/workflows/ci.yml)
 [![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, honeybadger and AppSignal.
+uniform_notifier is extracted from [bullet][0], it gives you the ability to send notification through rails logger, customized logger, javascript alert, javascript console, xmpp, airbrake, honeybadger and AppSignal.
 
 ## Install
 
@@ -12,14 +11,6 @@ uniform_notifier is extracted from [bullet][0], it gives you the ability to send
 
     gem install uniform_notifier
 
-if you want to notify by growl < v1.3, you should install ruby-growl first
-
-    gem install ruby-growl
-
-if you want to notify by growl v1.3+, you should install ruby_gntp first
-
-    gem install ruby_gntp
-
 if you want to notify by xmpp, you should install xmpp4r first
 
     gem install xmpp4r
@@ -56,13 +47,13 @@ if you want to notify by terminal-notifier, you must install it first
 
     gem "uniform_notifier"
 
-  you should add ruby-growl, ruby_gntp, xmpp4r, airbrake, bugsnag, honeybadger, slack-notifier, terminal-notifier gem if you want.
+  you should add xmpp4r, airbrake, bugsnag, honeybadger, slack-notifier, terminal-notifier gem if you want.
 
 ## Usage
 
 There are two types of notifications,
 one is <code>inline_notify</code>, for javascript alert and javascript console notifiers, which returns a string and will be combined,
-the other is <code>out_of_channel_notify</code>, for rails logger, customized logger, growl and xmpp, which doesn't return anything, just send the message to the notifiers.
+the other is <code>out_of_channel_notify</code>, for rails logger, customized logger, xmpp, which doesn't return anything, just send the message to the notifiers.
 
 By default, all notifiers are disabled, you should enable them first.
 
@@ -120,11 +111,6 @@ 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',
@@ -146,7 +132,7 @@ UniformNotifier.raise = false # don't raise errors
 After that, you can enjoy the notifiers, that's cool!
 
 ```ruby
-# the notify message will be notified to rails logger, customized logger, growl or xmpp.
+# the notify message will be notified to rails logger, customized logger or xmpp.
 UniformNotifier.active_notifiers.each do |notifier|
   notifier.out_of_channel_notify("customize message")
 end
@@ -161,18 +147,6 @@ end
 javascript_str = responses.join("\n")
 ```
 
-## Growl Support
-
-To get Growl support up-and-running, follow the steps below:
-
-* For Growl < v1.3, install the ruby-growl gem: <code>gem install ruby-growl</code>
-* For Growl v1.3+, install the ruby_gntp gem: <code>gem install ruby_gntp</code>
-* Open the Growl preference pane in Systems Preferences
-* Click the "Network" tab
-* Make sure both "Listen for incoming notifications" and "Allow remote application registration" are checked. *Note*: If you set a password, you will need to set <code>UniformNotifier.growl_password = { :password => 'growl password' }</code> in the config file.
-* 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.
-
 ## XMPP/Jabber Support
 
 To get XMPP support up-and-running, follow the steps below:

data/lib/uniform_notifier/version.rb

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

data/lib/uniform_notifier.rb

@@ -4,7 +4,6 @@ require 'uniform_notifier/base'
 require 'uniform_notifier/errors'
 require 'uniform_notifier/javascript_alert'
 require 'uniform_notifier/javascript_console'
-require 'uniform_notifier/growl'
 require 'uniform_notifier/honeybadger'
 require 'uniform_notifier/xmpp'
 require 'uniform_notifier/rails_logger'
@@ -22,7 +21,6 @@ class UniformNotifier
   AVAILABLE_NOTIFIERS = %i[
     alert
     console
-    growl
     honeybadger
     xmpp
     rails_logger
@@ -40,7 +38,6 @@ class UniformNotifier
   NOTIFIERS = [
     JavascriptAlert,
     JavascriptConsole,
-    Growl,
     HoneybadgerNotifier,
     Xmpp,
     RailsLogger,
@@ -65,11 +62,6 @@ class UniformNotifier
       NOTIFIERS.select(&:active?)
     end
 
-    undef growl=
-    def growl=(growl)
-      UniformNotifier::Growl.setup_connection(growl)
-    end
-
     undef xmpp=
     def xmpp=(xmpp)
       UniformNotifier::Xmpp.setup_connection(xmpp)

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'uniform_notifier'
-require 'ruby-growl'
 require 'xmpp4r'
 require 'slack-notifier'
 require 'rspec'

data/spec/uniform_notifier/airbrake_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe UniformNotifier::AirbrakeNotifier do
   end
 
   it 'should notify airbrake' do
-    expect(Airbrake).to receive(:notify).with(UniformNotifier::Exception.new('notify airbrake'), foo: :bar)
+    expect(Airbrake).to receive(:notify).with(UniformNotifier::Exception.new('notify airbrake'), { foo: :bar })
 
     UniformNotifier.airbrake = { foo: :bar }
     UniformNotifier::AirbrakeNotifier.out_of_channel_notify('notify airbrake')

data/spec/uniform_notifier/base_spec.rb

@@ -6,14 +6,14 @@ RSpec.describe UniformNotifier::Base do
   context '#inline_channel_notify' do
     before { allow(UniformNotifier::Base).to receive(:active?).and_return(true) }
     it 'should keep the compatibility' do
-      expect(UniformNotifier::Base).to receive(:_inline_notify).once.with(title: 'something')
+      expect(UniformNotifier::Base).to receive(:_inline_notify).once.with({ title: 'something' })
       UniformNotifier::Base.inline_notify('something')
     end
   end
   context '#out_of_channel_notify' do
     before { allow(UniformNotifier::Base).to receive(:active?).and_return(true) }
     it 'should keep the compatibility' do
-      expect(UniformNotifier::Base).to receive(:_out_of_channel_notify).once.with(title: 'something')
+      expect(UniformNotifier::Base).to receive(:_out_of_channel_notify).once.with({ title: 'something' })
       UniformNotifier::Base.out_of_channel_notify('something')
     end
   end

data/spec/uniform_notifier/bugsnag_spec.rb

@@ -26,7 +26,7 @@ RSpec.describe UniformNotifier::BugsnagNotifier do
         UniformNotifier::Exception.new(notification_data)
       ).and_yield(report)
       expect(report).to receive(:severity=).with('warning')
-      expect(report).to receive(:add_tab).with(:bullet, title: notification_data)
+      expect(report).to receive(:add_tab).with(:bullet, { title: notification_data })
       expect(report).to receive(:grouping_hash=).with(notification_data)
 
       UniformNotifier.bugsnag = true
@@ -37,7 +37,7 @@ RSpec.describe UniformNotifier::BugsnagNotifier do
       expect(Bugsnag).to receive(:notify).with(
         UniformNotifier::Exception.new(notification_data)
       ).and_yield(report)
-      expect(report).to receive(:meta_data=).with(foo: :bar)
+      expect(report).to receive(:meta_data=).with({ foo: :bar })
 
       UniformNotifier.bugsnag = ->(report) { report.meta_data = { foo: :bar } }
       UniformNotifier::BugsnagNotifier.out_of_channel_notify(notification_data)
@@ -62,7 +62,7 @@ RSpec.describe UniformNotifier::BugsnagNotifier do
       expect(Bugsnag).to receive(:notify).with(
         UniformNotifier::Exception.new(notification_data[:title])
       ).and_yield(report)
-      expect(report).to receive(:meta_data=).with(foo: :bar)
+      expect(report).to receive(:meta_data=).with({ foo: :bar })
 
       UniformNotifier.bugsnag = ->(report) { report.meta_data = { foo: :bar } }
       UniformNotifier::BugsnagNotifier.out_of_channel_notify(notification_data)

data/spec/uniform_notifier/honeybadger_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe UniformNotifier::HoneybadgerNotifier do
   end
 
   it 'should notify honeybadger' do
-    expect(Honeybadger).to receive(:notify).with(UniformNotifier::Exception.new('notify honeybadger'), foo: :bar)
+    expect(Honeybadger).to receive(:notify).with(UniformNotifier::Exception.new('notify honeybadger'), { foo: :bar })
 
     UniformNotifier.honeybadger = { foo: :bar }
     UniformNotifier::HoneybadgerNotifier.out_of_channel_notify('notify honeybadger')

data/spec/uniform_notifier/slack_spec.rb

@@ -35,7 +35,7 @@ RSpec.describe UniformNotifier::Slack do
 
     it 'should allow username and channel config options' do
       expect(Slack::Notifier).to receive(:new)
-        .with('http://some.slack.url', username: 'The Dude', channel: '#carpets')
+        .with('http://some.slack.url', { username: 'The Dude', channel: '#carpets' })
         .and_return(true)
       UniformNotifier.slack = { webhook_url: 'http://some.slack.url', username: 'The Dude', channel: '#carpets' }
       expect(UniformNotifier::Slack.active?).to eq true

data/uniform_notifier.gemspec

@@ -10,15 +10,13 @@ Gem::Specification.new do |s|
   s.authors     = ['Richard Huang']
   s.email       = ['flyerhzm@gmail.com']
   s.homepage    = 'http://rubygems.org/gems/uniform_notifier'
-  s.summary     = 'uniform notifier for rails logger, customized logger, javascript alert, javascript console, growl and xmpp'
-  s.description = 'uniform notifier for rails logger, customized logger, javascript alert, javascript console, growl and xmpp'
+  s.summary     = 'uniform notifier for rails logger, customized logger, javascript alert, javascript console and xmpp'
+  s.description = 'uniform notifier for rails logger, customized logger, javascript alert, javascript console and xmpp'
   s.license     = 'MIT'
 
   s.required_ruby_version = '>= 2.3'
 
   s.add_development_dependency 'rspec', ['> 0']
-  s.add_development_dependency 'ruby_gntp', ['= 0.3.4']
-  s.add_development_dependency 'ruby-growl', ['= 4.0']
   s.add_development_dependency 'slack-notifier', ['>= 1.0']
   s.add_development_dependency 'xmpp4r', ['= 0.5']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uniform_notifier
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,34 +24,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby_gntp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.3.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.3.4
-- !ruby/object:Gem::Dependency
-  name: ruby-growl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: slack-notifier
   requirement: !ruby/object:Gem::Requirement
@@ -81,15 +53,15 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.5'
 description: uniform notifier for rails logger, customized logger, javascript alert,
-  javascript console, growl and xmpp
+  javascript console and xmpp
 email:
 - flyerhzm@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -102,7 +74,6 @@ files:
 - lib/uniform_notifier/bugsnag.rb
 - lib/uniform_notifier/customized_logger.rb
 - lib/uniform_notifier/errors.rb
-- lib/uniform_notifier/growl.rb
 - lib/uniform_notifier/honeybadger.rb
 - lib/uniform_notifier/javascript_alert.rb
 - lib/uniform_notifier/javascript_console.rb
@@ -120,7 +91,6 @@ files:
 - spec/uniform_notifier/base_spec.rb
 - spec/uniform_notifier/bugsnag_spec.rb
 - spec/uniform_notifier/customized_logger_spec.rb
-- spec/uniform_notifier/growl_spec.rb
 - spec/uniform_notifier/honeybadger_spec.rb
 - spec/uniform_notifier/javascript_alert_spec.rb
 - spec/uniform_notifier/javascript_console_spec.rb
@@ -158,7 +128,7 @@ rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: uniform notifier for rails logger, customized logger, javascript alert, javascript
-  console, growl and xmpp
+  console and xmpp
 test_files:
 - spec/spec_helper.rb
 - spec/uniform_notifier/airbrake_spec.rb
@@ -166,7 +136,6 @@ test_files:
 - spec/uniform_notifier/base_spec.rb
 - spec/uniform_notifier/bugsnag_spec.rb
 - spec/uniform_notifier/customized_logger_spec.rb
-- spec/uniform_notifier/growl_spec.rb
 - spec/uniform_notifier/honeybadger_spec.rb
 - spec/uniform_notifier/javascript_alert_spec.rb
 - spec/uniform_notifier/javascript_console_spec.rb

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.7.2

data/lib/uniform_notifier/growl.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-class UniformNotifier
-  class Growl < Base
-    class << self
-      @growl = nil
-
-      def active?
-        @growl
-      end
-
-      def setup_connection(growl)
-        setup_connection_growl(growl)
-      rescue LoadError
-        begin
-          setup_connection_gntp(growl)
-        rescue LoadError
-          @growl = nil
-          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 setup_connection_growl(growl)
-        return unless growl
-
-        require 'ruby-growl'
-        if growl.instance_of?(Hash)
-          @password = growl.include?(:password) ? growl[:password] : nil
-          @host = growl.include?(:host) ? growl[:host] : 'localhost'
-        end
-        @password ||= nil
-        @host ||= 'localhost'
-        @growl = ::Growl.new @host, 'uniform_notifier'
-        @growl.add_notification 'uniform_notifier'
-        @growl.password = @password
-
-        notify 'Uniform Notifier Growl has been turned on' if !growl.instance_of?(Hash) || !growl[:quiet]
-      end
-
-      def setup_connection_gntp(growl)
-        return unless growl
-
-        require 'ruby_gntp'
-        if growl.instance_of?(Hash)
-          @password = growl.include?(:password) ? growl[:password] : nil
-          @host = growl.include?(:host) ? growl[:host] : 'localhost'
-        end
-        @password ||= nil
-        @host ||= 'localhost'
-        @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 _out_of_channel_notify(data)
-        message = data.values.compact.join("\n")
-
-        notify(message)
-      end
-
-      private
-
-      def 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
-end

data/spec/uniform_notifier/growl_spec.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe UniformNotifier::Growl do
-  it 'should not notify growl' do
-    expect(UniformNotifier::Growl.out_of_channel_notify(title: 'notify growl')).to be_nil
-  end
-
-  it 'should notify growl without password' do
-    growl = double('growl', is_a?: true)
-    expect(Growl).to receive(:new).with('localhost', 'uniform_notifier').and_return(growl)
-    expect(growl).to receive(:add_notification).with('uniform_notifier')
-    expect(growl).to receive(:password=).with(nil)
-    expect(growl).to receive(:notify)
-      .with('uniform_notifier', 'Uniform Notifier', 'Uniform Notifier Growl has been turned on')
-      .ordered
-    expect(growl).to receive(:notify)
-      .with('uniform_notifier', 'Uniform Notifier', 'notify growl without password')
-      .ordered
-
-    UniformNotifier.growl = true
-    UniformNotifier::Growl.out_of_channel_notify(title: 'notify growl without password')
-  end
-
-  it 'should notify growl with password' do
-    growl = double('growl', is_a?: true)
-    expect(Growl).to receive(:new).with('localhost', 'uniform_notifier').and_return(growl)
-    expect(growl).to receive(:add_notification).with('uniform_notifier')
-    expect(growl).to receive(:password=).with('123456')
-    expect(growl).to receive(:notify)
-      .with('uniform_notifier', 'Uniform Notifier', 'Uniform Notifier Growl has been turned on')
-      .ordered
-    expect(growl).to receive(:notify).with('uniform_notifier', 'Uniform Notifier', 'notify growl with password').ordered
-
-    UniformNotifier.growl = { password: '123456' }
-    UniformNotifier::Growl.out_of_channel_notify(title: 'notify growl with password')
-  end
-
-  it 'should notify growl with host' do
-    growl = double('growl', is_a?: true)
-    expect(Growl).to receive(:new).with('10.10.156.17', 'uniform_notifier').and_return(growl)
-    expect(growl).to receive(:add_notification).with('uniform_notifier')
-    expect(growl).to receive(:password=).with('123456')
-    expect(growl).to receive(:notify)
-      .with('uniform_notifier', 'Uniform Notifier', 'Uniform Notifier Growl has been turned on')
-      .ordered
-    expect(growl).to receive(:notify).with('uniform_notifier', 'Uniform Notifier', 'notify growl with password').ordered
-
-    UniformNotifier.growl = { password: '123456', host: '10.10.156.17' }
-    UniformNotifier::Growl.out_of_channel_notify(title: 'notify growl with password')
-  end
-
-  it 'should notify growl with quiet' do
-    growl = double('growl', is_a?: true)
-    expect(Growl).to receive(:new).with('localhost', 'uniform_notifier').and_return(growl)
-    expect(growl).to receive(:add_notification).with('uniform_notifier')
-    expect(growl).to receive(:password=).with('123456')
-    expect(growl).not_to receive(:notify).with(
-      'uniform_notifier',
-      'Uniform Notifier',
-      'Uniform Notifier Growl has been turned on'
-    )
-    expect(growl).to receive(:notify).with('uniform_notifier', 'Uniform Notifier', 'notify growl with password')
-
-    UniformNotifier.growl = { password: '123456', quiet: true }
-    UniformNotifier::Growl.out_of_channel_notify(title: 'notify growl with password')
-  end
-end