notifier 0.1.0 → 0.1.1

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+.DS_Store

data/README.rdoc

@@ -13,6 +13,25 @@ Send system notifications on several platforms with a simple and unified API. Cu
 
   gem install notifier
 
+=== Mac OS X
+
+* 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.
+
+=== 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:
@@ -39,6 +58,20 @@ There are several helper methods that you can use in order to retrieve 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

data/lib/notifier/growl.rb

@@ -2,7 +2,7 @@ module Notifier
   module Growl
     extend self
 
-    SCRIPT = File.dirname(__FILE__) + "/../../../resources/register-growl.scpt"
+    SCRIPT = File.dirname(__FILE__) + "/../../resources/register-growl.scpt"
     FILE = File.expand_path("~/.test_notifier-growl")
 
     def supported?
@@ -10,6 +10,8 @@ module Notifier
     end
 
     def notify(options)
+      register
+
       Thread.new do
         `growlnotify -n test_notifier --image #{options[:image]} -p 2 -m '#{options[:message]}' -t '#{options[:title]}'`
       end

data/lib/notifier/osd_cat.rb

@@ -2,24 +2,27 @@ module Notifier
   module OsdCat
     extend self
 
-    FONT = "-bitstream-charter-bold-r-normal--33-240-100-100-p-206-iso8859-1"
-    POSITION = "top"
-    POSITION_OFFSET = "0"
-    ALIGN = "center"
-    COLORS = {
-      :fail => "orange",
-      :success => "green",
-      :error => "red"
-    }
-
     def supported?
       RUBY_PLATFORM =~ /(linux|freebsd)/ && `which osd_cat > /dev/null` && $? == 0
     end
 
     def notify(options)
-      Thread.new do
-        `echo #{options[:message].inspect} | osd_cat --font=#{FONT} --shadow=0 --pos=#{POSITION} -o #{POSITION_OFFSET} --delay=4 --outline=4 --align=#{ALIGN} -c #{COLORS[options[:status]]}`
-      end
+      color = options.fetch(:color, "white")
+      message = options[:message].inspect.gsub(/!/, "\\!")
+      command = %W[
+        echo #{message} |
+        osd_cat
+        --shadow=0
+        --colour=#{color}
+        --pos=top
+        --offset=10
+        --align=center
+        --font=-adobe-helvetica-bold-r-normal-*-*-240-*-*-p-*-*-*
+        --delay=5
+        --outline=4
+      ].join(" ")
+
+      Thread.new { `#{command}` }
     end
   end
 end

data/lib/notifier/version.rb

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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Nando Vieira
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-12 00:00:00 -02:00
+date: 2010-11-19 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,6 +67,7 @@ files:
 - lib/notifier/snarl.rb
 - lib/notifier/version.rb
 - notifier.gemspec
+- resources/register-growl.scpt
 - test/notifier_test.rb
 - test/test_helper.rb
 has_rdoc: true