notifier 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ded78a65a591a7d25fc841c511ed827622fc1463
-  data.tar.gz: db832909bd190d77d8dcdd2248a60a4098e616db
+  metadata.gz: ae5afe2f3c9c49b9f8e29be682424de92908dd35
+  data.tar.gz: 7b5c443d285fd023fb001b48ebe43ac695944d7c
 SHA512:
-  metadata.gz: 2e26970c850341800b43a6d61865f82b95db278ed0666e8a550848d51b479cf837dbceaeb950224f0c1cceda8830f5f4ba0e69b027f2bf624a444adf08436d54
-  data.tar.gz: 96e7619e015a14c3383ccedca1423ce638cbbc771ac5789d9f455901b1bbf34d63c5356c70d9a7ef43107fa46eaf80c19263812f3ac02d55af1289cd9dee1f80
+  metadata.gz: 56c4fbc80d2c33cb22990600f977d031335c6e4cc4df42ce3f8bd9d0da452d183df75127dcd405ea36121d23bd6aab1cd8f5200e5b7de8bafde03a768563d2af
+  data.tar.gz: a9a64939c8a7db0f0040baec682e6d078621b2a8328036d016469cb8e534a9d1faba0a56a64c1586c2c2eb378493e8fed57178de964bba7965539bc8e7d97ccf

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache: bundler
+sudo: false
+notifications:
+  email: false
+rvm:
+- 2.3.0
+- '2.2'
+- '2.1'
+env:
+  global:
+    secure: mYd3r1SEZJcirOFNjNe75vMNjYJ/UHDLZAsEeCQQcI4Na03au53Pr02waJKPdXXV8JnakaYMDNBc4kOXnk3v0ytgINnvNXnObjPT2KUPvQKLUhXq2Q/BrWS4CFihihznZHAQFgeTVbDm/brLWH61+JwDlQ2kEo6OGSAZ8ZV/PV8=

data/{README.rdoc → README.md}

@@ -1,4 +1,10 @@
-= Notifier
+# Notifier
+
+[![Travis-CI](https://travis-ci.org/fnando/notifier.png)](https://travis-ci.org/fnando/notifier)
+[![Code Climate](https://codeclimate.com/github/fnando/notifier/badges/gpa.svg)](https://codeclimate.com/github/fnando/notifier)
+[![Test Coverage](https://codeclimate.com/github/fnando/notifier/badges/coverage.svg)](https://codeclimate.com/github/fnando/notifier/coverage)
+[![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:
 
@@ -11,85 +17,97 @@ Send system notifications on several platforms with a simple and unified API. Cu
 * Libnotify (Linux)
 * Snarl (Windows)
 
-== Installation
+## Installation
 
-  gem install notifier
+    gem install notifier
 
-=== Mac OS X
+### Mac OS X
 
-Growl:
+#### 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:
+#### terminal-notifier
 
 * Install terminal-notifier - https://github.com/alloy/terminal-notifier
 
-=== Linux
+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: <tt>sudo aptitude install libnotify-bin</tt>
-* Install xosd-bin: <tt>sudo aptitude install xosd-bin</tt>
+* 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
+### Windows
 
 * Install Snarl: download from http://www.fullphat.net
-* Install ruby-snarl: <tt>gem install ruby-snarl</tt>
+* Install ruby-snarl: `gem install ruby-snarl`
 
-== Usage
+## 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!"
-  )
+```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:
 
-  Notifier.default_notifier = :notify_send
+```ruby
+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>.
+The available names are `growl`, `terminal_notifier`, `kdialog`, `knotify`, `notify_send`, `osd_cat`, and `snarl`.
 
 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
+* `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
+## Creating custom notifiers
 
-To create a new notifier, just create a module on <tt>Notifier</tt> namespace that implements the following interface:
+To create a new notifier, just create a module on `Notifier` namespace that implements the following interface:
 
-  module Notifier
-    module MyCustomNotifier
-      def self.supported?
-      end
+```ruby
+module Notifier
+  module MyCustomNotifier
+    def self.supported?
+    end
 
-      def self.notify(options)
-      end
+    def self.notify(options)
     end
   end
+end
+```
 
-== Maintainer
+## Maintainer
 
-* Nando Vieira - http://nandovieira.com.br
+* Nando Vieira - http://nandovieira.com
 
-== Contributors
+## Contributors
 
-* Olek Janiszewski
-* David Miani
+https://github.com/fnando/notifier/graphs/contributors
 
-== License
+## License
 
 (The MIT License)
 

data/Rakefile

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

data/lib/notifier.rb

@@ -32,13 +32,13 @@ module Notifier
   end
 
   def notifiers
-    constants.collect do |name|
+    constants.map do |name|
       const_get(name) unless %w[Placebo Adapters Version].include?(name.to_s)
     end.compact + [Placebo]
   end
 
   def supported_notifiers
-    notifiers.select {|notifier| notifier.supported?}
+    notifiers.select {|notifier| notifier.supported? }
   end
 
   def from_name(name)
@@ -57,7 +57,9 @@ module Notifier
   end
 
   private
+
   def classify(string)
-    string.gsub(/_(.)/sm) { "#{$1.upcase}" }.gsub(/^(.)/) { "#{$1.upcase}" }
+    string.gsub(/_(.)/sm) { "#{$1.upcase}" }
+          .gsub(/^(.)/) { "#{$1.upcase}" }
   end
 end

data/lib/notifier/adapters.rb

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

data/lib/notifier/adapters/gntp.rb

@@ -8,7 +8,7 @@ module Notifier
 
       def initialize(options = {})
         if options.kind_of?(String)
-          options = {:name => options}
+          options = {name: options}
         end
 
         @application_name = options.fetch(:name, "GNTP/Ruby")
@@ -64,9 +64,9 @@ module Notifier
         contents = File.open(path, "rb") {|f| f.read }
 
         {
-          :identifier => Digest::MD5.hexdigest(contents),
-          :contents => contents,
-          :size => contents.bytesize
+          identifier: Digest::MD5.hexdigest(contents),
+          contents: contents,
+          size: contents.bytesize
         }
       end
 

data/lib/notifier/gntp.rb

@@ -21,16 +21,16 @@ module Notifier
 
     def notify(options)
       gntp = Adapters::GNTP.new({
-        :name => "test_notifier",
-        :host => host,
-        :port => port
+        name: "test_notifier",
+        host: host,
+        port: port
       })
 
       gntp.notify({
-        :name    => "status",
-        :title   => options[:title],
-        :message => options[:message],
-        :icon    => options[:image]
+        name: "status",
+        title: options[:title],
+        message: options[:message],
+        icon: options[:image]
       })
     end
   end

data/lib/notifier/growl.rb

@@ -14,7 +14,7 @@ module Notifier
       command = [
         "growlnotify",
         "--name", "test_notifier",
-        "--image", options.fetch(:image, '').to_s,
+        "--image", options.fetch(:image, "").to_s,
         "--priority", "2",
         "--message", options[:message].to_s,
         options[:title].to_s

data/lib/notifier/terminal_notifier.rb

@@ -12,9 +12,14 @@ 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
       ]
 
+      # -sound with an empty string (e.g., "") will trigger the
+      # default sound so we need to check for it.
+      command.concat(["-sound", options.fetch(:sound, "default").to_s] ) if options[:sound]
+
       Thread.new { system(*command) }.join
     end
   end

data/lib/notifier/version.rb

@@ -2,7 +2,7 @@ module Notifier
   module Version
     MAJOR = 0
     MINOR = 5
-    PATCH = 1
+    PATCH = 2
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/notifier.gemspec

@@ -1,6 +1,4 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "notifier/version"
+require "./lib/notifier/version"
 
 Gem::Specification.new do |s|
   s.name        = "notifier"
@@ -19,6 +17,8 @@ Gem::Specification.new do |s|
 
   s.requirements << "Growl, 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 "rake"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "codeclimate-test-reporter"
 end

data/test/notifier/notifier_test.rb

@@ -0,0 +1,75 @@
+require "test_helper"
+
+class NotifierTest < Minitest::Test
+  setup do
+    Notifier.notifiers.each do |notifier|
+      notifier.stubs(:supported?).returns(false) unless notifier == Notifier::Placebo
+    end
+
+    Notifier.default_notifier = nil
+  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 9, 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::Growl, Notifier.from_name(:growl)
+  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,9 @@
+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,12 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "bundler/setup"
+require "notifier"
+require "minitest/utils"
+require "minitest/autorun"
+
+module Snarl
+  def self.show_message(*)
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: notifier
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: codeclimate-test-reporter
+  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
 email:
@@ -47,9 +75,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
+- ".travis.yml"
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - lib/notifier.rb
 - lib/notifier/adapters.rb
@@ -66,8 +94,9 @@ files:
 - 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: {}
@@ -88,11 +117,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Growl, terminal-notifier, Libnotify, OSD, KDE (Knotify and Kdialog) or Snarl
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 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
 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/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