notifier 0.2.1 → 0.4.0

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/Gemfile.lock

@@ -1,22 +1,26 @@
 PATH
   remote: .
   specs:
-    notifier (0.2.1)
+    notifier (0.4.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    metaclass (0.0.1)
-    mocha (0.11.4)
-      metaclass (~> 0.0.1)
+    diff-lcs (1.1.3)
     rake (0.9.2.2)
-    test-unit (2.4.8)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  mocha
   notifier!
   rake
-  test-unit
+  rspec

data/README.rdoc

@@ -3,6 +3,7 @@
 Send system notifications on several platforms with a simple and unified API. Currently supports:
 
 * Growl (Mac OS X)
+* GNTP Protocol (Growl, with Vagrant support)
 * Kdialog (Linux/KDE)
 * Knotify (Linux/KDE)
 * OSD Cat (Linux)

data/lib/notifier.rb

@@ -1,4 +1,7 @@
 require "open3"
+require "socket"
+require "digest/md5"
+require "timeout"
 require "rbconfig"
 
 module Notifier
@@ -11,6 +14,7 @@ module Notifier
   autoload :NotifySend, "notifier/notify_send"
   autoload :Placebo,    "notifier/placebo"
   autoload :Version,    "notifier/version"
+  autoload :Adapters,   "notifier/adapters"
 
   extend self
 
@@ -28,7 +32,7 @@ module Notifier
 
   def notifiers
     constants.collect do |name|
-      const_get(name) unless %w[Placebo Version].include?(name.to_s)
+      const_get(name) unless %w[Placebo Adapters Version].include?(name.to_s)
     end.compact + [Placebo]
   end
 

data/lib/notifier/adapters.rb

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

data/lib/notifier/adapters/gntp.rb

@@ -0,0 +1,85 @@
+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)
+        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])
+
+        result = 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)
+        result = 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/gntp.rb

@@ -1,22 +1,37 @@
 module Notifier
-  module GNTP
-    extend self
-
+  module GNTP extend self
     def supported?
-      begin
-        require "ruby_gntp" unless defined?(::GNTP)
-        true
-      rescue LoadError
-        false
-      end
+      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.notify(
-        :title => options[:title],
-        :text => options[:message],
-        :icon => options[:image]
-      )
+      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/version.rb

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

data/notifier.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
 
   s.requirements << "Growl, Libnotify, OSD, KDE (Knotify and Kdialog) or Snarl"
 
-  s.add_development_dependency "test-unit"
-  s.add_development_dependency "mocha"
+  s.add_development_dependency "rspec"
   s.add_development_dependency "rake"
 end

data/spec/notifier_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe Notifier do
+  before do
+    unsupport_all_notifiers
+    Notifier.default_notifier = nil
+  end
+
+  it "retrieves list of supported notifiers" do
+    Notifier::Snarl.stub :supported? => true
+    Notifier::Knotify.stub :supported? => true
+
+    expect(Notifier.supported_notifiers.size).to eql(3)
+  end
+
+  it "returns first available notifier" do
+    Notifier::Snarl.stub :supported? => true
+    Notifier::Knotify.stub :supported? => true
+
+    expect(Notifier.notifier).to eql(Notifier::Snarl)
+  end
+
+  it "prefers default notifier" do
+    Notifier::Snarl.stub :supported? => true
+    Notifier::Knotify.stub :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"
+    }
+
+    Notifier::Snarl.stub :supported? => true
+    Notifier::Snarl.should_receive(:notify).with(params)
+
+    Notifier.notify(params)
+  end
+
+  it "retrieves list of all notifiers" do
+    expect(Notifier.notifiers.size).to eql(8)
+  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
+    Notifier::Snarl.stub :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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notifier
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,26 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-11 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -68,11 +52,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - Gemfile.lock
 - README.rdoc
 - Rakefile
 - lib/notifier.rb
+- lib/notifier/adapters.rb
+- lib/notifier/adapters/gntp.rb
 - lib/notifier/gntp.rb
 - lib/notifier/growl.rb
 - lib/notifier/kdialog.rb
@@ -84,8 +71,8 @@ files:
 - lib/notifier/version.rb
 - notifier.gemspec
 - resources/register-growl.scpt
-- test/notifier_test.rb
-- test/test_helper.rb
+- spec/notifier_spec.rb
+- spec/spec_helper.rb
 homepage: http://rubygems.org/gems/notifier
 licenses: []
 post_install_message: 
@@ -98,18 +85,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3729581669822386303
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3729581669822386303
 requirements:
 - Growl, Libnotify, OSD, KDE (Knotify and Kdialog) or Snarl
 rubyforge_project: 
@@ -118,6 +99,4 @@ signing_key:
 specification_version: 3
 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:
-- test/notifier_test.rb
-- test/test_helper.rb
+test_files: []

data/test/notifier_test.rb

@@ -1,73 +0,0 @@
-require "test_helper"
-
-class NotifierTest < Test::Unit::TestCase
-  def setup
-    unsupport_all_notifiers
-    Notifier.default_notifier = nil
-  end
-
-  test "retrieve list of supported notifiers" do
-    Notifier::Snarl.expects(:supported?).returns(true)
-    Notifier::Knotify.expects(:supported?).returns(true)
-
-    assert_equal 3, Notifier.supported_notifiers.size
-  end
-
-  test "return first available notifier" do
-    Notifier::Snarl.expects(:supported?).returns(true)
-    Notifier::Knotify.expects(:supported?).returns(true)
-
-    assert_equal Notifier::Snarl, Notifier.notifier
-  end
-
-  test "prefer default notifier" do
-    Notifier::Snarl.stubs(:supported?).returns(true)
-    Notifier::Knotify.expects(:supported?).returns(true)
-
-    Notifier.default_notifier = :knotify
-
-    assert_equal Notifier::Knotify, Notifier.notifier
-  end
-
-  test "send notification" do
-    params = {
-      :title => "Some title",
-      :message => "Some message",
-      :image => "image.png"
-    }
-
-    Notifier::Snarl.expects(:supported?).returns(true)
-    Notifier::Snarl.expects(:notify).with(params)
-
-    Notifier.notify(params)
-  end
-
-  test "retrieve list of all notifiers" do
-    assert_equal 8, Notifier.notifiers.size
-  end
-
-  test "consider Placebo as fallback notifier" do
-    assert_equal Notifier::Placebo, Notifier.supported_notifiers.last
-  end
-
-  test "return 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 "return 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 "return nil when have no supported notifiers" do
-    assert_nil Notifier.supported_notifier_from_name(:snarl)
-  end
-
-  test "return 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/test_helper.rb

@@ -1,14 +0,0 @@
-gem "test-unit"
-require "test/unit"
-require "mocha"
-
-require "notifier"
-
-class Test::Unit::TestCase
-  private
-  def unsupport_all_notifiers
-    Notifier.notifiers.each do |notifier|
-      notifier.stubs(:supported?).returns(false) unless notifier == Notifier::Placebo
-    end
-  end
-end