growl_notifier 1.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+html
+pkg
+coverage

data/History.txt

@@ -0,0 +1 @@
+See git-log.

data/LICENSE

@@ -0,0 +1,2 @@
+Copyright (c) 2007-2008 Satoshi Nakagawa <psychs@limechat.net>, Eloy Duran <e.duran@superalloy.nl>
+You can redistribute it and/or modify it under the same terms as Ruby.

data/Manifest.txt

@@ -0,0 +1,11 @@
+Manifest.txt
+README.txt
+Rakefile
+LICENSE
+lib/growl.rb
+lib/growl_helpers.rb
+samples/growl_block_sample.rb
+samples/growl_delegate_sample.rb
+test/growl_test.rb
+test/growl_helpers_test.rb
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,71 @@
+= Growl Notifier
+
+== Overview
+
+Growl::Notifier is a class that allows your application to post notifications to the Growl daemon.
+It can also receive clicked and timeout notifications as well as take blocks for clicked callback handlers.
+
+This is an extraction and cleanup of the Growl code from LimeChat (http://github.com/psychs/limechat/tree/master) and later on extended for WebApp (http://github.com/alloy/webapp-app/tree/master).
+
+== Requirements
+
+* Mac OS X 10.4 or 10.5
+* Ruby 1.8 (http://ruby-lang.org/)
+* RubyCocoa (http://rubycocoa.sourceforge.net/)
+
+== How to use Growl Notifier
+
+A simple example:
+
+  require 'growl'
+  
+  g = Growl::Notifier.sharedInstance
+  g.register('test_app', ['message_type'])
+  g.notify('message_type', 'title', 'desc')
+
+How to receive clicked and timeout notifications in your application:
+
+  require 'rubygems'
+  require 'growl'
+
+  class GrowlController < OSX::NSObject
+    def init
+      if super_init
+        @g = Growl::Notifier.sharedInstance
+        @g.delegate = self
+        @g.register('test_app', ['message_type'])
+        @g.notify('message_type', 'title', 'desc')
+        self
+      end
+    end
+
+    def growlNotifierClicked_context(sender, context)
+      puts context
+    end
+
+    def growlNotifierTimedOut_context(sender, context)
+      puts context
+    end
+  end
+
+Include the Growl module into your class to get access to a few convenience methods:
+
+  require 'rubygems'
+  require 'growl'
+
+  class GrowlController < OSX::NSObject
+    include Growl
+    Growl::Notifier.sharedInstance.register('test_app', ['message_type'])
+    
+    def init
+      if super_init
+        growl('message_type', 'title', 'desc')
+        self
+      end
+    end
+  end
+
+== License
+
+Copyright (c) 2007-2008 Satoshi Nakagawa <psychs@limechat.net>, Eloy Duran <e.duran@superalloy.nl>
+You can redistribute it and/or modify it under the same terms as Ruby.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "growl_notifier"
+    gem.description = %Q{A ruby library which allows you to send Growl notifications.}
+    gem.email = ["psychs@limechat.net", "e.duran@superalloy.nl","jphastings@gmail.com"]
+    gem.homepage = "http://github.com/jphastings/growl_notifier"
+    gem.summary = "Growl::Notifier is a OSX RubyCocoa class that allows your application to post notifications to the Growl daemon."
+    gem.authors = ["Satoshi Nakagawa", "Eloy Duran","JP Hastings-Spital"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+task :default => :build

data/TODO

@@ -0,0 +1 @@
+- Maybe define a initWithDelegate initializer? But this might not be necessary because of the sharedInstance.

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/init.rb

@@ -0,0 +1,2 @@
+require File.expand_path('../lib/growl', __FILE__)
+require File.expand_path('../lib/growl_helpers', __FILE__)

data/lib/growl_notifier.rb

@@ -0,0 +1,170 @@
+require 'osx/cocoa'
+
+module Growl
+  class Notifier < OSX::NSObject
+    VERSION = '1.0.2'
+    
+    GROWL_IS_READY = "Lend Me Some Sugar; I Am Your Neighbor!"
+    GROWL_NOTIFICATION_CLICKED = "GrowlClicked!"
+    GROWL_NOTIFICATION_TIMED_OUT = "GrowlTimedOut!"
+    GROWL_KEY_CLICKED_CONTEXT = "ClickedContext"
+    
+    PRIORITIES = {
+      :emergency =>  2,
+      :high      =>  1,
+      :normal    =>  0,
+      :moderate  => -1,
+      :very_low  => -2,
+    }
+    
+    class << self
+      # Returns the singleton instance of Growl::Notifier with which you register and send your Growl notifications.
+      def sharedInstance
+        @sharedInstance ||= alloc.init
+      end
+    end
+    
+    attr_reader :application_name, :application_icon, :notifications, :default_notifications
+    attr_accessor :delegate
+    
+    # Set to +true+ if you want to receive delegate callback messages,
+    # <tt>growlNotifierClicked_context</tt> & <tt>growlNotifierTimedOut_context</tt>,
+    # without the need to specify a <tt>:click_context</tt>.
+    #
+    # The default is +false+, which means your application won't receive any delegate
+    # callback messages if the <tt>:click_context</tt> is omitted.
+    attr_accessor :always_callback
+    
+    # Registers the applications metadata and the notifications, that your application might send, to Growl.
+    # The +default_notifications+ are notifications that will be enabled by default, the regular +notifications+ are
+    # optional and should be enabled by the user in the Growl system preferences.
+    #
+    # Register the applications name and the notifications that will be used.
+    # * +default_notifications+ defaults to the regular +notifications+.
+    # * +application_icon+ defaults to OSX::NSApplication.sharedApplication.applicationIconImage.
+    #
+    #   Growl::Notifier.sharedInstance.register 'FoodApp', ['YourHamburgerIsReady', 'OhSomeoneElseAteIt']
+    #
+    # Register the applications name, the notifications plus the default notifications that will be used and the icon that's to be used in the Growl notifications.
+    #
+    #   Growl::Notifier.sharedInstance.register 'FoodApp', ['YourHamburgerIsReady', 'OhSomeoneElseAteIt'], ['DefaultNotification], OSX::NSImage.imageNamed('GreasyHamburger')
+    def register(application_name, notifications, default_notifications = nil, application_icon = nil)
+      @application_name, @application_icon = application_name, (application_icon || OSX::NSApplication.sharedApplication.applicationIconImage)
+      @notifications, @default_notifications = notifications, (default_notifications || notifications)
+      @callbacks = {}
+      send_registration!
+    end
+    
+    # Sends a Growl notification.
+    #
+    # * +notification_name+ : the name of one of the notifcations that your apllication registered with Growl. See register for more info.
+    # * +title+ : the title that should be used in the Growl notification.
+    # * +description+ : the body of the Grow notification.
+    # * +options+ : specifies a few optional options:
+    #   * <tt>:sticky</tt> : indicates if the Grow notification should "stick" to the screen. Defaults to +false+.
+    #   * <tt>:priority</tt> : sets the priority level of the Growl notification. Defaults to 0.
+    #   * <tt>:click_context</tt> : a string describing the context of the notification. This is send back to the delegate so you can check what kind of notification it was. If omitted, no delegate messages will be send. You can disable this behaviour by setting always_callback to +true+.
+    #   * <tt>:icon</tt> : specifies the icon to be used in the Growl notification. Defaults to the registered +application_icon+, see register for more info.
+    #
+    # Simple example:
+    #
+    #   name = 'YourHamburgerIsReady'
+    #   title = 'Your hamburger is ready for consumption!'
+    #   description = 'Please pick it up at isle 4.'
+    #   
+    #   Growl::Notifier.sharedInstance.notify(name, title, description)
+    #
+    # Example with optional options:
+    #
+    #   Growl::Notifier.sharedInstance.notify(name, title, description, :sticky => true, :priority => 1, :icon => OSX::NSImage.imageNamed('SuperBigHamburger'))
+    #
+    # When you pass notify a block, that block will be used as the callback handler if the Growl notification was clicked. Eg:
+    #
+    #   Growl::Notifier.sharedInstance.notify(name, title, description, :sticky => true) do
+    #     user_clicked_notification_so_do_something!
+    #   end
+    def notify(notification_name, title, description, options = {}, &callback)
+      dict = {
+        :ApplicationName => @application_name,
+        :ApplicationPID => pid,
+        :NotificationName => notification_name,
+        :NotificationTitle => title,
+        :NotificationDescription => description,
+        :NotificationPriority => PRIORITIES[options[:priority]] || options[:priority] || 0
+      }
+      dict[:NotificationIcon] = options[:icon].TIFFRepresentation if options[:icon]
+      dict[:NotificationSticky] = 1 if options[:sticky]
+      
+      context = {}
+      context[:user_click_context] = options[:click_context] if options[:click_context]
+      if block_given?
+        @callbacks[callback.object_id] = callback
+        context[:callback_object_id] = callback.object_id.to_s
+      end
+      dict[:NotificationClickContext] = context if always_callback || !context.empty?
+      
+      notification_center.postNotificationName_object_userInfo_deliverImmediately(:GrowlNotification, nil, dict, true)
+    end
+    
+    def onReady(notification)
+      send_registration!
+    end
+    
+    def onClicked(notification)
+      user_context = nil
+      if context = notification.userInfo[GROWL_KEY_CLICKED_CONTEXT]
+        user_context = context[:user_click_context]
+        if callback_object_id = context[:callback_object_id]
+          @callbacks.delete(callback_object_id.to_i).call
+        end
+      end
+      
+      @delegate.growlNotifierClicked_context(self, user_context) if @delegate && @delegate.respond_to?(:growlNotifierClicked_context)
+    end
+    
+    def onTimeout(notification)
+      user_context = nil
+      if context = notification.userInfo[GROWL_KEY_CLICKED_CONTEXT]
+        @callbacks.delete(context[:callback_object_id].to_i) if context[:callback_object_id]
+        user_context = context[:user_click_context]
+      end
+      
+      @delegate.growlNotifierTimedOut_context(self, user_context) if @delegate && @delegate.respond_to?(:growlNotifierTimedOut_context)
+    end
+    
+    private
+    
+    def pid
+      OSX::NSProcessInfo.processInfo.processIdentifier.to_i
+    end
+    
+    def notification_center
+      OSX::NSDistributedNotificationCenter.defaultCenter
+    end
+    
+    def send_registration!
+      add_observer 'onReady:', GROWL_IS_READY, false
+      add_observer 'onClicked:', GROWL_NOTIFICATION_CLICKED, true
+      add_observer 'onTimeout:', GROWL_NOTIFICATION_TIMED_OUT, true
+      
+      dict = {
+        :ApplicationName => @application_name,
+        :ApplicationIcon => application_icon.TIFFRepresentation,
+        :AllNotifications => @notifications,
+        :DefaultNotifications => @default_notifications
+      }
+      
+      notification_center.objc_send(
+        :postNotificationName, :GrowlApplicationRegistrationNotification,
+                      :object, nil,
+                    :userInfo, dict,
+          :deliverImmediately, true
+      )
+    end
+    
+    def add_observer(selector, name, prepend_name_and_pid)
+      name = "#{@application_name}-#{pid}-#{name}" if prepend_name_and_pid
+      notification_center.addObserver_selector_name_object self, selector, name, nil
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: growl_notifier
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Satoshi Nakagawa
+- Eloy Duran
+- JP Hastings-Spital
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-02 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A ruby library which allows you to send Growl notifications.
+email: 
+- psychs@limechat.net
+- e.duran@superalloy.nl
+- jphastings@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.txt
+- TODO
+files: 
+- .gitignore
+- History.txt
+- LICENSE
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO
+- VERSION
+- init.rb
+- lib/growl_notifier.rb
+has_rdoc: true
+homepage: http://github.com/jphastings/growl_notifier
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Growl::Notifier is a OSX RubyCocoa class that allows your application to post notifications to the Growl daemon.
+test_files: []
+