notification 0.1 → 0.2

data/CHANGES

@@ -1,3 +1,9 @@
+== Version 0.2
+
+* snarl support
+* popup will use snarl or growl depending on which is present on your system
+* should work w/ windows
+
 == Version 0.1
 
 Initial version release, supports :

data/Manifest.txt

@@ -6,8 +6,12 @@ example.rb
 lib/gmail_notifier.rb
 lib/growl_notifier.rb
 lib/notification.rb
+lib/popup_notifier.rb
 lib/sms_notifier.rb
+lib/snarl_notifier.rb
 test/gmail_notifier_test.rb
 test/growl_notifier_test.rb
+test/notification_test.rb
+test/popup_notifier_test.rb
 test/sms_notifier_test.rb
 test/test_helper.rb

data/README

@@ -24,6 +24,7 @@ growl, snarl, etc, and all these are exposed in a simple, uniform way.
 * GMail
 * SMS (via teleflip)
 * Growl
+* Snarl
 
 == Contact
 

data/lib/growl_notifier.rb

@@ -1,16 +1,36 @@
 require 'ruby-growl'
 
 class GrowlNotifier  
+  #Valid options:
+  # :application => the name of the application sending the notifications (ruby-growl)
+  # :to => the hostname notifications will send to by default (localhost)
+  # :notifications => an array of names for the different notifications the application can send ([])
+  # :password => the growl network password for the given host (nil)
   def initialize(options = {})
     @application = options[:application] || 'ruby-growl'
-    @to = options[:to]
+    @to = options[:to] || 'localhost'
+    @notifications = options[:notifications] 
+    @password = options[:password]
   end
   
+  # Important warning: unless the user has enabled network notifications,
+  # this will throw an error.  It's suggested that you catch this error
+  # and entreat your user to enable network notifications in an appropriate fashion.
+  # They probably also need to enable remote application registration.
+  #
+  # Valid options:
+  #   :to => the hostname notifications will send to by default (localhost)
+  #   :type => the notification type that's being sent ("@application notification")
+  #   :password => 
   def notify(message, options = {})
-    to = options[:to] || @to || 'localhost'
-    notification_type = "#{@application} notification"
+    to = options[:to] || @to
+    notification_type = options[:type] || "#{@application} notification"
+    notifications =  @notifications || [notification_type]
+
+    #ensures we never get an Unknown Notification error
+    notification_type = notifications.first unless notifications.include?(notification_type)
     
-    g = Growl.new to, @application, [notification_type]
+    g = Growl.new to, @application, notifications, notifications, @password
     g.notify notification_type, @application, message
   end
 end

data/lib/notification.rb

@@ -1,16 +1,23 @@
+require 'rubygems'
+
 module Notification
-  VERSION = "0.1"
-end
+  VERSION = "0.2"
 
-def safe_require file
-  require file
-rescue LoadError
-  puts "#{file} is not available"
+  #this is the preferred place to check if a notification system
+  #is available
+  def self.available_notifiers
+    @available_notifiers ||= []
+  end
 end
 
-require 'rubygems'
 
-safe_require 'gmail_notifier'
-safe_require 'sms_notifier'
-safe_require 'growl_notifier'
+%w(gmail sms growl snarl popup).each do |type|
+  begin
+    type += "_notifier"
+    require type
+    Notification.available_notifiers << type
+  rescue LoadError
+    $stderr.puts "#{type} is not available"
+  end
+end
 

data/lib/popup_notifier.rb

@@ -0,0 +1,17 @@
+# Generalizes the API for growl and snarl
+# it should be easy to add support for more later.
+class PopupNotifier
+  def initialize(*params)
+    if Notification.available_notifiers.include?("growl_notifier")
+      @notifier = GrowlNotifier.new(*params)
+    elsif Notification.available_notifiers.include?("snarl_notifier")
+      @notifier = SnarlNotifier.new(*params)
+    else
+      raise LoadError("No popup notification system installed\n Try 'sudo gem install ruby-growl' or 'gem install snarl-growl'")
+    end
+  end
+  
+  def notify(*params)
+    @notifier.notify(*params)
+  end
+end

data/lib/snarl_notifier.rb

@@ -0,0 +1,15 @@
+require 'snarl'
+
+class SnarlNotifier  
+  # valid options:
+  #   application: the name of your application
+  def initialize(options = {})
+    @application = options[:application] || 'ruby-snarl'
+  end
+  
+  # 
+  def notify(message, options = {})
+    title = options[:title] || "#{@application} notification"
+    Snarl.show_message(title,message,options[:icon] || nil, options[:timeout] || Snarl::DEFAULT_TIMEOUT)
+  end
+end

data/test/notification_test.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/test_helper'
+require "notification"
+
+class NotificationTest < Test::Unit::TestCase
+  def test_available_notifiers
+    assert_equal ['gmail_notifier', 'sms_notifier', 'growl_notifier', 'popup_notifier'], Notification.available_notifiers
+  end
+end

data/test/popup_notifier_test.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/test_helper'
+require "notification"
+
+class GrowlNotifierTest < Test::Unit::TestCase
+  def test_default_stuff
+    g = Object.new
+    Growl.expects(:new).returns(g)
+    g.expects(:notify)
+    
+    popup = PopupNotifier.new
+    popup.notify('help')
+    
+    g.verify
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: notification
 version: !ruby/object:Gem::Version 
-  version: "0.1"
-date: 2007-03-21 00:00:00 -07:00
+  version: "0.2"
+date: 2007-07-28 00:00:00 -07:00
 summary: Notification is a one stop shop for notification, it knows how to send messages via GMail, SMS, growl, snarl, etc, and all these are exposed in a simple, uniform way.
 require_paths: 
 - lib
@@ -37,19 +37,26 @@ files:
 - lib/gmail_notifier.rb
 - lib/growl_notifier.rb
 - lib/notification.rb
+- lib/popup_notifier.rb
 - lib/sms_notifier.rb
+- lib/snarl_notifier.rb
 - test/gmail_notifier_test.rb
 - test/growl_notifier_test.rb
+- test/notification_test.rb
+- test/popup_notifier_test.rb
 - test/sms_notifier_test.rb
 - test/test_helper.rb
 test_files: 
 - test/gmail_notifier_test.rb
 - test/growl_notifier_test.rb
+- test/notification_test.rb
+- test/popup_notifier_test.rb
 - test/sms_notifier_test.rb
-rdoc_options: []
-
-extra_rdoc_files: []
-
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- Manifest.txt
 executables: []
 
 extensions: []
@@ -91,5 +98,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.0
+        version: 1.2.1
     version: