notifier 0.5.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ded78a65a591a7d25fc841c511ed827622fc1463
-  data.tar.gz: db832909bd190d77d8dcdd2248a60a4098e616db
+SHA256:
+  metadata.gz: c842629dcf6da711e4d5979dd03a395e35e4aa752271f80f3fca65f50aff3bf9
+  data.tar.gz: aec07ca38b8a39779dbf9e65383ea26cb140dc46b7069fb79798853ef9b3f611
 SHA512:
-  metadata.gz: 2e26970c850341800b43a6d61865f82b95db278ed0666e8a550848d51b479cf837dbceaeb950224f0c1cceda8830f5f4ba0e69b027f2bf624a444adf08436d54
-  data.tar.gz: 96e7619e015a14c3383ccedca1423ce638cbbc771ac5789d9f455901b1bbf34d63c5356c70d9a7ef43107fa46eaf80c19263812f3ac02d55af1289cd9dee1f80
+  metadata.gz: a274ece6e94cb827c710d249ec9540551a116c2f99dbfa78ff8fe6c0458e9aa0c3fbd36df587cff7bbfdde4b9d1f213d1b07c5c9e3c66c1854f9a5f49e40af8a
+  data.tar.gz: d741722e7fea144a2c920c4add06a7fab380cb9b591c437c095707bab9cbbb21cbfb3a929d2d315c9e19ea468d85b4214bdefb77b1cfbd6a05c3cc7aaf942242

data/.gitignore

@@ -3,3 +3,4 @@ pkg/*
 .bundle
 .DS_Store
 *.lock
+/coverage

data/.rubocop.yml

@@ -0,0 +1,10 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source "http://rubygems.org"
 gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+(The MIT License)
+
+Nando Vieira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the 'Software'), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# Notifier
+
+[![Gem](https://img.shields.io/gem/v/notifier.svg)](https://rubygems.org/gems/notifier)
+[![Gem](https://img.shields.io/gem/dt/notifier.svg)](https://rubygems.org/gems/notifier)
+
+Send system notifications on several platforms with a simple and unified API.
+Currently supports:
+
+- terminal-notifier (Notification Center wrapper for Mac OS X)
+- GNTP Protocol (Growl, with Vagrant support)
+- Kdialog (Linux/KDE)
+- Knotify (Linux/KDE)
+- OSD Cat (Linux)
+- Libnotify (Linux)
+- Snarl (Windows)
+
+## Installation
+
+    gem install notifier
+
+### Mac OS X
+
+#### terminal-notifier
+
+- Install terminal-notifier - https://github.com/alloy/terminal-notifier
+
+terminal-notifier also supports two additional flags:
+
+- `subtitle`
+- `sound`
+
+See terminal-notifier's help for additional information.
+
+### Linux
+
+If you're a linux guy, you can choose one of these methods:
+
+- Install libnotify-bin and its dependencies:
+  `sudo aptitude install libnotify-bin`
+- Install xosd-bin: `sudo aptitude install xosd-bin`
+- KDE users don't need to install anything: Test Notifier will use +knotify+ or
+  +kdialog+.
+
+### Windows
+
+- Install Snarl: download from http://www.fullphat.net
+- Install ruby-snarl: `gem install ruby-snarl`
+
+## Usage
+
+Notifier will try to detect which notifiers are available in your system. So you
+can just send a message:
+
+```ruby
+Notifier.notify(
+  image: "image.png",
+  title: "Testing Notifier",
+  message: "Sending an important message!"
+)
+```
+
+Not all notifiers support the image option, therefore it will be ignored.
+
+If your system support more than one notifier, you can specify which one you
+prefer:
+
+```ruby
+Notifier.default_notifier = :notify_send
+```
+
+The available names are `terminal_notifier`, `kdialog`, `knotify`,
+`notify_send`, `osd_cat`, and `snarl`.
+
+There are several helper methods that you can use in order to retrieve
+notifiers.
+
+- `Notifier.notifier`: return the first supported notifier
+- `Notifier.notifiers`: return all notifiers
+- `Notifier.supported_notifiers`: return only supported notifiers
+- `Notifier.from_name(name)`: find notifier by its name
+- `Notifier.supported_notifier_from_name(name)`: find a supported notifier by
+  its name
+
+## Creating custom notifiers
+
+To create a new notifier, just create a module on `Notifier` namespace that
+implements the following interface:
+
+```ruby
+module Notifier
+  module MyCustomNotifier
+    def self.supported?
+    end
+
+    def self.notify(options)
+    end
+  end
+end
+```
+
+## Maintainer
+
+- Nando Vieira - https://nandovieira.com
+
+## Contributors
+
+https://github.com/fnando/notifier/graphs/contributors
+
+## License
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the 'Software'), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,10 +1,15 @@
-require "bundler"
-Bundler::GemHelper.install_tasks
+# frozen_string_literal: true
 
+require "bundler/gem_tasks"
 require "rake/testtask"
-Rake::TestTask.new do |t|
-  t.libs += %w[test lib]
-  t.ruby_opts = %w[-rubygems]
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
   t.test_files = FileList["test/**/*_test.rb"]
-  t.verbose = true
+  t.warning = false
 end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/notifier/hud.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Notifier
+  module Hud
+    extend self
+
+    def supported?
+      Notifier.os?(/darwin/) && hud?
+    end
+
+    def uri
+      URI("http://127.0.0.1:32323/hud")
+    end
+
+    def hud?
+      return @hud unless @hud.nil?
+
+      @hud = begin
+        response = Net::HTTP.get_response(uri)
+        response.code == "200"
+      rescue StandardError
+        false
+      end
+
+      @hud
+    end
+
+    def notify(options)
+      Thread.new do
+        Net::HTTP.post_form(
+          uri,
+          {
+            "title" => options[:title].to_s,
+            "message" => options[:message].to_s,
+            "symbolName" => options[:image].to_s
+          }
+        )
+      end.join
+    end
+  end
+end

data/lib/notifier/kdialog.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 module Notifier
   module Kdialog
     extend self
 
     def supported?
-      Notifier.os?(/(linux|freebsd)/) && `which kdialog > /dev/null` && $? == 0
+      Notifier.os?(/(linux|freebsd)/) &&
+        `which kdialog > /dev/null` &&
+        $CHILD_STATUS == 0
     end
 
     def notify(options)

data/lib/notifier/knotify.rb

@@ -1,16 +1,28 @@
+# frozen_string_literal: true
+
 module Notifier
   module Knotify
     extend self
 
     def supported?
-      Notifier.os?(/(linux|freebsd)/) && `ps -Al | grep dcop` && $? == 0
+      Notifier.os?(/(linux|freebsd)/) &&
+        `ps -Al | grep dcop` &&
+        $CHILD_STATUS == 0
     end
 
     def notify(options)
       command = [
-        "dcop", "knotify", "default", "notify", "eventname",
-        options[:title].to_s, options[:message].to_s,
-        "", "", "16", "2"
+        "dcop",
+        "knotify",
+        "default",
+        "notify",
+        "eventname",
+        options[:title].to_s,
+        options[:message].to_s,
+        "",
+        "",
+        "16",
+        "2"
       ]
 
       Thread.new { system(*command) }.join

data/lib/notifier/notify_send.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 module Notifier
   module NotifySend
     extend self
 
     def supported?
-      Notifier.os?(/(linux|freebsd)/) && `which notify-send > /dev/null` && $? == 0
+      Notifier.os?(/(linux|freebsd)/) &&
+        `which notify-send > /dev/null` &&
+        $CHILD_STATUS == 0
     end
 
     def notify(options)

data/lib/notifier/osd_cat.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 module Notifier
   module OsdCat
     extend self
 
     def supported?
-      Notifier.os?(/(linux|freebsd)/) && `which osd_cat > /dev/null` && $? == 0
+      Notifier.os?(/(linux|freebsd)/) &&
+        `which osd_cat > /dev/null` &&
+        $CHILD_STATUS == 0
     end
 
     def notify(options)
@@ -18,11 +22,11 @@ module Notifier
         "--align", "center",
         "--font", "-bitstream-bitstream charter-bold-r-*-*-*-350-*-*-*-*-*-*",
         "--delay", "5",
-        "--outline", "4",
+        "--outline", "4"
       ]
 
       Thread.new do
-        Open3.popen3(*command) do |stdin, stdout, stderr|
+        Open3.popen3(*command) do |stdin, _stdout, _stderr|
           stdin.puts options[:message]
           stdin.close
         end

data/lib/notifier/placebo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Notifier
   module Placebo
     extend self

data/lib/notifier/snarl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Notifier
   module Snarl
     extend self

data/lib/notifier/terminal_notifier.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Notifier
   module TerminalNotifier
     extend self
 
     def supported?
-      Notifier.os?(/darwin/) && `which terminal-notifier` && $? == 0
+      Notifier.os?(/darwin/) && `which terminal-notifier` && $CHILD_STATUS == 0
     end
 
     def notify(options)
@@ -12,10 +14,24 @@ module Notifier
         "-group", "notifier-rubygems",
         "-title", options[:title].to_s,
         "-appIcon", options.fetch(:image, "").to_s,
-        "-message", options[:message].to_s
+        "-message", options[:message].to_s,
+        "-subtitle", options.fetch(:subtitle, "").to_s
       ]
 
-      Thread.new { system(*command) }.join
+      # -sound with an empty string (e.g., "") will trigger the
+      # default sound so we need to check for it.
+      if options[:sound]
+        command.concat([
+          "-sound",
+          options.fetch(:sound, "default").to_s
+        ])
+      end
+
+      Thread.new do
+        Open3.popen3(*command) do |_stdin, _stdout, _stderr|
+          # noop
+        end
+      end.join
     end
   end
 end

data/lib/notifier/version.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Notifier
   module Version
-    MAJOR = 0
-    MINOR = 5
-    PATCH = 1
+    MAJOR = 1
+    MINOR = 1
+    PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/lib/notifier.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 require "open3"
 require "socket"
 require "digest/md5"
 require "timeout"
 require "rbconfig"
+require "English"
+require "net/http"
 
 module Notifier
-  require "notifier/growl"
-  require "notifier/gntp"
   require "notifier/snarl"
+  require "notifier/hud"
   require "notifier/osd_cat"
   require "notifier/knotify"
   require "notifier/kdialog"
@@ -15,7 +18,6 @@ module Notifier
   require "notifier/placebo"
   require "notifier/terminal_notifier"
   require "notifier/version"
-  require "notifier/adapters"
 
   extend self
 
@@ -23,6 +25,10 @@ module Notifier
     attr_accessor :default_notifier
   end
 
+  def skip_constants
+    @skip_constants ||= %w[Placebo Adapters Version]
+  end
+
   def notifier
     supported_notifier_from_name(default_notifier) || supported_notifiers.first
   end
@@ -32,32 +38,32 @@ module Notifier
   end
 
   def notifiers
-    constants.collect do |name|
-      const_get(name) unless %w[Placebo Adapters Version].include?(name.to_s)
-    end.compact + [Placebo]
+    constants.filter_map do |name|
+      const_get(name) unless skip_constants.include?(name.to_s)
+    end + [Placebo]
   end
 
   def supported_notifiers
-    notifiers.select {|notifier| notifier.supported?}
+    notifiers.select(&:supported?)
   end
 
   def from_name(name)
     const_get(classify(name.to_s))
-  rescue Exception
+  rescue StandardError
     nil
   end
 
   def supported_notifier_from_name(name)
     notifier = from_name(name)
-    notifier && notifier.supported? ? notifier : nil
+    notifier&.supported? ? notifier : nil
   end
 
   def os?(regex)
     RUBY_PLATFORM =~ regex || RbConfig::CONFIG["host_os"] =~ regex
   end
 
-  private
-  def classify(string)
-    string.gsub(/_(.)/sm) { "#{$1.upcase}" }.gsub(/^(.)/) { "#{$1.upcase}" }
+  private def classify(string)
+    string.gsub(/_(.)/sm) { Regexp.last_match(1).upcase.to_s }
+          .gsub(/^(.)/) { Regexp.last_match(1).upcase.to_s }
   end
 end

data/notifier.gemspec

@@ -1,24 +1,36 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "notifier/version"
+# frozen_string_literal: true
+
+require "./lib/notifier/version"
 
 Gem::Specification.new do |s|
   s.name        = "notifier"
   s.version     = Notifier::Version::STRING
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Nando Vieira"]
-  s.email       = ["fnando.vieira@gmail.com"]
+  s.email       = ["me@fnando.com"]
   s.homepage    = "http://rubygems.org/gems/notifier"
-  s.summary     = "Send system notifications on several platforms with a simple and unified API. Currently supports Growl, Libnotify, OSD, KDE (Knotify and Kdialog) and Snarl"
+  s.summary     = "Send system notifications on several platforms with a " \
+                  "simple and unified API. Currently supports Libnotify, " \
+                  "OSD, KDE (Knotify and Kdialog) and Snarl"
   s.description = s.summary
+  s.required_ruby_version = ">= 2.7"
+  s.metadata["rubygems_mfa_required"] = "true"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
   s.require_paths = ["lib"]
 
-  s.requirements << "Growl, terminal-notifier, Libnotify, OSD, KDE (Knotify and Kdialog) or Snarl"
+  s.requirements << "terminal-notifier, Libnotify, OSD, KDE (Knotify and " \
+                    "Kdialog) or Snarl"
 
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "minitest-utils"
+  s.add_development_dependency "mocha"
   s.add_development_dependency "rake"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "rubocop-fnando"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "test_notifier"
 end

data/test/notifier/notifier_test.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class NotifierTest < Minitest::Test
+  setup do
+    Notifier.notifiers.each do |notifier|
+      unless notifier == Notifier::Placebo
+        notifier.stubs(:supported?).returns(false)
+      end
+    end
+
+    Notifier.default_notifier = nil
+  end
+
+  teardown do
+    Notifier.default_notifier = :hud
+  end
+
+  test "retrieves list of supported notifiers" do
+    Notifier::Snarl.stubs(:supported?).returns(true)
+    Notifier::Knotify.stubs(:supported?).returns(true)
+
+    assert_equal 3, Notifier.supported_notifiers.size
+  end
+
+  test "returns first available notifier" do
+    Notifier::Snarl.stubs(:supported?).returns(true)
+    Notifier::Knotify.stubs(:supported?).returns(true)
+
+    assert_equal Notifier::Snarl, Notifier.notifier
+  end
+
+  test "prefers default notifier" do
+    Notifier::Snarl.stubs(:supported?).returns(true)
+    Notifier::Knotify.stubs(:supported?).returns(true)
+
+    Notifier.default_notifier = :knotify
+
+    assert_equal Notifier::Knotify, Notifier.notifier
+  end
+
+  test "sends notification" do
+    params = {
+      title: "Some title",
+      message: "Some message",
+      image: "image.png"
+    }
+
+    Notifier::Snarl.stubs(:supported?).returns(true)
+    Notifier::Snarl.expects(:notify).with(params)
+
+    Notifier.notify(params)
+  end
+
+  test "retrieves list of all notifiers" do
+    assert_equal 8, Notifier.notifiers.size
+  end
+
+  test "considers Placebo as fallback notifier" do
+    assert_equal Notifier::Placebo, Notifier.supported_notifiers.last
+  end
+
+  test "returns notifier by its name" do
+    assert_equal Notifier::OsdCat, Notifier.from_name(:osd_cat)
+    assert_equal Notifier::NotifySend, Notifier.from_name(:notify_send)
+    assert_equal Notifier::Hud, Notifier.from_name(:hud)
+  end
+
+  test "returns notifier by its name when supported" do
+    Notifier::Snarl.expects(:supported?).returns(true)
+    assert_equal Notifier::Snarl, Notifier.supported_notifier_from_name(:snarl)
+  end
+
+  test "returns nil when have no supported notifiers" do
+    assert_nil Notifier.supported_notifier_from_name(:snarl)
+  end
+
+  test "returns nil when an invalid notifier name is provided" do
+    assert_nil Notifier.from_name(:invalid)
+    assert_nil Notifier.supported_notifier_from_name(:invalid)
+  end
+end

data/test/notifier/snarl_test.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class SnarlTest < Minitest::Test
+  test "sends notification" do
+    Snarl.expects(:show_message).with("TITLE", "MESSAGE", "IMAGE")
+
+    Notifier::Snarl.notify(title: "TITLE", message: "MESSAGE", image: "IMAGE")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "simplecov"
+SimpleCov.start
+
+require "bundler/setup"
+require "notifier"
+require "minitest/utils"
+require "minitest/autorun"
+
+Notifier.default_notifier = :hud
+
+module Snarl
+  def self.show_message(*)
+  end
+end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: notifier
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,24 +52,78 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-fnando
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test_notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Send system notifications on several platforms with a simple and unified
-  API. Currently supports Growl, Libnotify, OSD, KDE (Knotify and Kdialog) and Snarl
+  API. Currently supports Libnotify, OSD, KDE (Knotify and Kdialog) and Snarl
 email:
-- fnando.vieira@gmail.com
+- me@fnando.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
+- ".rubocop.yml"
 - Gemfile
-- README.rdoc
+- LICENSE.md
+- README.md
 - Rakefile
 - lib/notifier.rb
-- lib/notifier/adapters.rb
-- lib/notifier/adapters/gntp.rb
-- lib/notifier/gntp.rb
-- lib/notifier/growl.rb
+- lib/notifier/hud.rb
 - lib/notifier/kdialog.rb
 - lib/notifier/knotify.rb
 - lib/notifier/notify_send.rb
@@ -65,13 +133,14 @@ files:
 - lib/notifier/terminal_notifier.rb
 - lib/notifier/version.rb
 - notifier.gemspec
-- resources/register-growl.scpt
-- spec/notifier_spec.rb
-- spec/spec_helper.rb
+- test/notifier/notifier_test.rb
+- test/notifier/snarl_test.rb
+- test/test_helper.rb
 homepage: http://rubygems.org/gems/notifier
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,20 +148,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- Growl, terminal-notifier, Libnotify, OSD, KDE (Knotify and Kdialog) or Snarl
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+- terminal-notifier, Libnotify, OSD, KDE (Knotify and Kdialog) or Snarl
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Send system notifications on several platforms with a simple and unified
-  API. Currently supports Growl, Libnotify, OSD, KDE (Knotify and Kdialog) and Snarl
+  API. Currently supports Libnotify, OSD, KDE (Knotify and Kdialog) and Snarl
 test_files:
-- spec/notifier_spec.rb
-- spec/spec_helper.rb
+- test/notifier/notifier_test.rb
+- test/notifier/snarl_test.rb
+- test/test_helper.rb

data/.rspec

@@ -1 +0,0 @@
---color

data/README.rdoc

@@ -1,113 +0,0 @@
-= Notifier
-
-Send system notifications on several platforms with a simple and unified API. Currently supports:
-
-* Growl (Mac OS X)
-* terminal-notifier (Notification Center wrapper for Mac OS X)
-* GNTP Protocol (Growl, with Vagrant support)
-* Kdialog (Linux/KDE)
-* Knotify (Linux/KDE)
-* OSD Cat (Linux)
-* Libnotify (Linux)
-* Snarl (Windows)
-
-== Installation
-
-  gem install notifier
-
-=== Mac OS X
-
-Growl:
-
-* Install Growl - http://growl.info/
-* Install the growlnotify script located on the "Extras" directory
-* Open the Growl Preference Panel (System > Growl) and activate "Listen for incoming notifications" and "Allow remote application registration" options on the Network tab.
-
-terminal-notifier:
-
-* Install terminal-notifier - https://github.com/alloy/terminal-notifier
-
-=== Linux
-
-If you're a linux guy, you can choose one of these methods:
-
-* Install libnotify-bin and its dependencies: <tt>sudo aptitude install libnotify-bin</tt>
-* Install xosd-bin: <tt>sudo aptitude install xosd-bin</tt>
-* KDE users don't need to install anything: Test Notifier will use +knotify+ or +kdialog+.
-
-=== Windows
-
-* Install Snarl: download from http://www.fullphat.net
-* Install ruby-snarl: <tt>gem install ruby-snarl</tt>
-
-== Usage
-
-Notifier will try to detect which notifiers are available in your system. So you can just send a message:
-
-  Notifier.notify(
-    :image   => "image.png",
-    :title   => "Testing Notifier",
-    :message => "Sending an important message!"
-  )
-
-Not all notifiers support the image option, therefore it will be ignored.
-
-If your system support more than one notifier, you can specify which one you prefer:
-
-  Notifier.default_notifier = :notify_send
-
-The available names are <tt>growl</tt>, <tt>terminal_notifier</tt>, <tt>kdialog</tt>, <tt>knotify</tt>, <tt>notify_send</tt>, <tt>osd_cat</tt>, and <tt>snarl</tt>.
-
-There are several helper methods that you can use in order to retrieve notifiers.
-
-* <tt>Notifier.notifier</tt>: return the first supported notifier
-* <tt>Notifier.notifiers</tt>: return all notifiers
-* <tt>Notifier.supported_notifiers</tt>: return only supported notifiers
-* <tt>Notifier.from_name(name)</tt>: find notifier by its name
-* <tt>Notifier.supported_notifier_from_name(name)</tt>: find a supported notifier by its name
-
-== Creating custom notifiers
-
-To create a new notifier, just create a module on <tt>Notifier</tt> namespace that implements the following interface:
-
-  module Notifier
-    module MyCustomNotifier
-      def self.supported?
-      end
-
-      def self.notify(options)
-      end
-    end
-  end
-
-== Maintainer
-
-* Nando Vieira - http://nandovieira.com.br
-
-== Contributors
-
-* Olek Janiszewski
-* David Miani
-
-== License
-
-(The MIT License)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/notifier/adapters/gntp.rb

@@ -1,87 +0,0 @@
-module Notifier
-  module Adapters
-    class GNTP
-      attr_accessor :application_name
-      attr_accessor :host
-      attr_accessor :port
-      attr_accessor :password
-
-      def initialize(options = {})
-        if options.kind_of?(String)
-          options = {:name => options}
-        end
-
-        @application_name = options.fetch(:name, "GNTP/Ruby")
-        @host = options.fetch(:host, "127.0.0.1")
-        @port = options.fetch(:port, 23053)
-        @password = options.fetch(:password, nil)
-      end
-
-      def line_break(number = 1)
-        "\r\n" * number
-      end
-
-      def write(*contents)
-        contents.map! do |content|
-          content.force_encoding("utf-8") rescue content
-        end
-
-        socket = TCPSocket.open(host, port)
-        message = [*contents, line_break(2)].join(line_break)
-        socket.write(message)
-
-        "".tap do |response|
-          while chunk = socket.gets
-            break if chunk == line_break
-            response << chunk
-          end
-
-          socket.close
-        end
-      end
-
-      def notify(options)
-        name = options.fetch(:name, "notification")
-        register(name)
-
-        icon = fetch_icon(options[:icon])
-
-        write "GNTP/1.0 NOTIFY NONE",
-              "Application-Name: #{application_name}",
-              "Notification-Name: #{name}",
-              "Notification-Title: #{options[:title]}",
-              "Notification-Text: #{options[:message]}",
-              "Notification-Icon: x-growl-resource://#{icon[:identifier]}",
-              "Notification-Sticky: #{bool options[:sticky]}",
-              nil,
-              "Identifier: #{icon[:identifier]}",
-              "Length: #{icon[:size]}",
-              nil,
-              icon[:contents]
-      end
-
-      def fetch_icon(path)
-        contents = File.open(path, "rb") {|f| f.read }
-
-        {
-          :identifier => Digest::MD5.hexdigest(contents),
-          :contents => contents,
-          :size => contents.bytesize
-        }
-      end
-
-      def bool(boolean)
-        {true => "Yes", false => "No"}[boolean]
-      end
-
-      def register(name)
-        write "GNTP/1.0 REGISTER NONE",
-              "Application-Name: #{application_name}",
-              "Notifications-count: 1",
-              nil,
-              "Notification-Name: #{name}",
-              "Notification-Enabled: True"
-      end
-    end
-  end
-end

data/lib/notifier/adapters.rb

@@ -1,5 +0,0 @@
-module Notifier
-  module Adapters
-    autoload :GNTP, "notifier/adapters/gntp"
-  end
-end

data/lib/notifier/gntp.rb

@@ -1,37 +0,0 @@
-module Notifier
-  module GNTP extend self
-    def supported?
-      Timeout.timeout(1) { TCPSocket.new(host, port).close }
-      true
-    rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, Timeout::Error
-      false
-    end
-
-    def port
-      ENV.fetch("GNTP_PORT", 23053)
-    end
-
-    def host
-      ENV["GNTP_HOST"] || ssh_connection || "127.0.0.1"
-    end
-
-    def ssh_connection
-      ENV["SSH_CONNECTION"][/^([^ ]+)/, 1] if ENV["SSH_CONNECTION"]
-    end
-
-    def notify(options)
-      gntp = Adapters::GNTP.new({
-        :name => "test_notifier",
-        :host => host,
-        :port => port
-      })
-
-      gntp.notify({
-        :name    => "status",
-        :title   => options[:title],
-        :message => options[:message],
-        :icon    => options[:image]
-      })
-    end
-  end
-end

data/lib/notifier/growl.rb

@@ -1,31 +0,0 @@
-module Notifier
-  module Growl
-    extend self
-
-    SCRIPT = File.dirname(__FILE__) + "/../../resources/register-growl.scpt"
-    FILE = File.expand_path("~/.test_notifier-growl")
-
-    def supported?
-      Notifier.os?(/darwin/) && `which growlnotify` && $? == 0
-    end
-
-    def notify(options)
-      register
-      command = [
-        "growlnotify",
-        "--name", "test_notifier",
-        "--image", options.fetch(:image, '').to_s,
-        "--priority", "2",
-        "--message", options[:message].to_s,
-        options[:title].to_s
-      ]
-
-      Thread.new { system(*command) }.join
-    end
-
-    def register
-      return if File.file?(FILE)
-      system "osascript #{SCRIPT} > #{FILE}"
-    end
-  end
-end

data/spec/notifier_spec.rb

@@ -1,72 +0,0 @@
-require "spec_helper"
-
-describe Notifier do
-  before do
-    unsupport_all_notifiers
-    Notifier.default_notifier = nil
-  end
-
-  it "retrieves list of supported notifiers" do
-    allow(Notifier::Snarl).to receive_messages :supported? => true
-    allow(Notifier::Knotify).to receive_messages :supported? => true
-
-    expect(Notifier.supported_notifiers.size).to eql(3)
-  end
-
-  it "returns first available notifier" do
-    allow(Notifier::Snarl).to receive_messages :supported? => true
-    allow(Notifier::Knotify).to receive_messages :supported? => true
-
-    expect(Notifier.notifier).to eql(Notifier::Snarl)
-  end
-
-  it "prefers default notifier" do
-    allow(Notifier::Snarl).to receive_messages :supported? => true
-    allow(Notifier::Knotify).to receive_messages :supported? => true
-
-    Notifier.default_notifier = :knotify
-
-    expect(Notifier.notifier).to eql(Notifier::Knotify)
-  end
-
-  it "sends notification" do
-    params = {
-      :title => "Some title",
-      :message => "Some message",
-      :image => "image.png"
-    }
-
-    allow(Notifier::Snarl).to receive_messages :supported? => true
-    expect(Notifier::Snarl).to receive(:notify).with(params)
-
-    Notifier.notify(params)
-  end
-
-  it "retrieves list of all notifiers" do
-    expect(Notifier.notifiers.size).to eql(9)
-  end
-
-  it "considers Placebo as fallback notifier" do
-    expect(Notifier.supported_notifiers.last).to eql(Notifier::Placebo)
-  end
-
-  it "returns notifier by its name" do
-    expect(Notifier.from_name(:osd_cat)).to eql(Notifier::OsdCat)
-    expect(Notifier.from_name(:notify_send)).to eql(Notifier::NotifySend)
-    expect(Notifier.from_name(:growl)).to eql(Notifier::Growl)
-  end
-
-  it "returns notifier by its name when supported" do
-    allow(Notifier::Snarl).to receive_messages :supported? => true
-    expect(Notifier.supported_notifier_from_name(:snarl)).to eql(Notifier::Snarl)
-  end
-
-  it "returns nil when have no supported notifiers" do
-    expect(Notifier.supported_notifier_from_name(:snarl)).to be_nil
-  end
-
-  it "returns nil when an invalid notifier name is provided" do
-    expect(Notifier.from_name(:invalid)).to be_nil
-    expect(Notifier.supported_notifier_from_name(:invalid)).to be_nil
-  end
-end

data/spec/spec_helper.rb

@@ -1,13 +0,0 @@
-require "notifier"
-
-module SpecHelpers
-  def unsupport_all_notifiers
-    Notifier.notifiers.each do |notifier|
-      allow(notifier).to receive_messages(:supported? => false) unless notifier == Notifier::Placebo
-    end
-  end
-end
-
-RSpec.configure do |config|
-  config.include SpecHelpers
-end