dmathieu-growlcocoa 1.0.0

data/README.textile

@@ -0,0 +1,57 @@
+h1. Growl Notifier
+
+Copyright (c) 2007-2008 Satoshi Nakagawa <psychs@limechat.net>
+Exported as a gem by Damien MATHIEU <42@dmathieu.com>
+You can redistribute it and/or modify it under the same terms as Ruby.
+
+h2. Overview
+
+Growl Notifier is a class to post notifications to the Growl daemon.
+And also it can receive clicked and timeout notifications from Growl.
+
+h2. Requirements
+
+Mac OS X 10.4 or 10.5
+Ruby 1.8 (http://ruby-lang.org/)
+RubyCocoa (http://rubycocoa.sourceforge.net/)
+
+h2. How to install
+
+The Growl Notifier is a gem. So to install it, you only need to do :
+
+> gem sources -a http://gems.github.com
+> sudo gem install dmathieu-growlcocoa
+
+And you're ready to go :)
+
+
+h2. How to use Growl Notifier
+
+A simple example:
+
+> require 'growl'
+
+> g = Growl::Notifier.alloc.init<br />
+> g.start('test_app', ['message_type'])<br />
+> g.notify('message_type', 'title', 'desc')
+
+How to receive clicked and timeout notifications in your application:
+
+> require 'growl'
+
+> class GrowlController < OSX::NSObject
+>     def init
+>         @g = Growl::Notifier.alloc.initWithDelegate(self)
+>         @g.start('test_app', ['message_type'])
+>         @g.notify('message_type', 'title', 'desc', 'click_context')
+>         self
+>     end
+
+>     def growl_onClicked(sender, context)
+>         puts 'clicked'
+>     end
+
+>     def growl_onTimeout(sender, context)
+>         puts 'timeout'
+>     end
+> end

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+ 
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "growlcocoa"
+    gem.summary = %Q{A library to send growl alerts using rubycocoa}
+    gem.email = "42@dmathieu.com"
+    gem.homepage = "http://github.com/dmathieu/growlcocoa"
+    gem.authors = ["Satoshi Nakagawa", "Damien MATHIEU"]
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/growlcocoa.gemspec

@@ -0,0 +1,38 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{growlcocoa}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Satoshi Nakagawa", "Damien MATHIEU"]
+  s.date = %q{2009-09-20}
+  s.email = %q{42@dmathieu.com}
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/dmathieu/growlcocoa}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.files = [
+      ".gitignore",
+       "README.textile",
+       "Rakefile",
+       "VERSION",
+       "growlcocoa.gemspec",
+       "lib/growl.rb",
+    ]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A library to send growl alerts using rubycocoa}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/growl.rb

@@ -0,0 +1,154 @@
+#
+# = growl.rb
+#
+# Growl Notifier
+#
+# Copyright (c) 2007-2008 Satoshi Nakagawa <psychs@limechat.net>
+# Exported as a gem by Damien MATHIEU <42@dmathieu.com>
+# You can redistribute it and/or modify it under the same terms as Ruby.
+#
+# == Overview
+#
+# Growl Notifier is a class to post notifications to the Growl daemon.
+# And also it can receive clicked and timeout notifications from Growl.
+#
+# == 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.alloc.init
+#   g.start('test_app', ['message_type'])
+#   g.notify('message_type', 'title', 'desc')
+#
+# How to receive clicked and timeout notifications in your application:
+#
+#   require 'growl'
+#
+#   class GrowlController < OSX::NSObject
+#     def init
+#       @g = Growl::Notifier.alloc.initWithDelegate(self)
+#       @g.start('test_app', ['message_type'])
+#       @g.notify('message_type', 'title', 'desc', 'click_context')
+#       self
+#     end
+#  
+#     def growl_onClicked(sender, context)
+#       puts 'clicked'
+#     end
+#  
+#     def growl_onTimeout(sender, context)
+#       puts 'timeout'
+#     end
+#   end
+#
+
+require 'osx/cocoa'
+
+module Growl
+  class Notifier < OSX::NSObject
+    include OSX
+    attr_accessor :delegate
+    
+    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"
+    
+    
+    def initWithDelegate(delegate)
+      init
+      @delegate = delegate
+      self
+    end
+    
+    def start(appname, notifications, default_notifications=nil, appicon=nil)
+      @appname = appname
+      @notifications = notifications
+      @default_notifications = default_notifications
+      @appicon = appicon
+      @default_notifications = @notifications unless @default_notifications
+      register
+    end
+    
+    def notify(type, title, desc, click_context=nil, sticky=false, priority=0, icon=nil)
+      dic = {
+        :ApplicationName => @appname,
+        :ApplicationPID => NSProcessInfo.processInfo.processIdentifier,
+        :NotificationName => type,
+        :NotificationTitle => title,
+        :NotificationDescription => desc,
+        :NotificationPriority => priority,
+      }
+      dic[:NotificationIcon] = icon.TIFFRepresentation if icon
+      dic[:NotificationSticky] = 1 if sticky
+      dic[:NotificationClickContext] = click_context if click_context
+      
+      c = NSDistributedNotificationCenter.defaultCenter
+      c.postNotificationName_object_userInfo_deliverImmediately(:GrowlNotification, nil, dic, true)
+    end
+    
+    KEY_TABLE = {
+      :type => :NotificationName,
+      :title => :NotificationTitle,
+      :desc => :NotificationDescription,
+      :clickContext => :NotificationClickContext,
+      :sticky => :NotificationSticky,
+      :priority => :NotificationPriority,
+      :icon => :NotificationIcon,
+    }
+    
+    def notifyWith(hash)
+      dic = {}
+      KEY_TABLE.each {|k,v| dic[v] = hash[k] if hash.key?(k) }
+      dic[:ApplicationName] = @appname
+      dic[:ApplicationPID] = NSProcessInfo.processInfo.processIdentifier
+      
+      c = NSDistributedNotificationCenter.defaultCenter
+      c.postNotificationName_object_userInfo_deliverImmediately(:GrowlNotification, nil, dic, true)
+    end
+    
+    
+    def onReady(n)
+      register
+    end
+    
+    def onClicked(n)
+      context = n.userInfo[GROWL_KEY_CLICKED_CONTEXT].to_s
+      @delegate.growl_onClicked(self, context) if @delegate && @delegate.respond_to?(:growl_onClicked)
+    end
+    
+    def onTimeout(n)
+      context = n.userInfo[GROWL_KEY_CLICKED_CONTEXT].to_s
+      @delegate.growl_onTimeout(self, context) if @delegate && @delegate.respond_to?(:growl_onTimeout)
+    end
+    
+    
+    private
+    
+    def register
+      pid = NSProcessInfo.processInfo.processIdentifier.to_i
+      
+      c = NSDistributedNotificationCenter.defaultCenter
+      c.addObserver_selector_name_object(self, 'onReady:', GROWL_IS_READY, nil)
+      c.addObserver_selector_name_object(self, 'onClicked:', "#{@appname}-#{pid}-#{GROWL_NOTIFICATION_CLICKED}", nil)
+      c.addObserver_selector_name_object(self, 'onTimeout:', "#{@appname}-#{pid}-#{GROWL_NOTIFICATION_TIMED_OUT}", nil)
+      
+      icon = @appicon || NSApplication.sharedApplication.applicationIconImage
+      dic = {
+        :ApplicationName => @appname,
+        :AllNotifications => @notifications,
+        :DefaultNotifications => @default_notifications,
+        :ApplicationIcon => icon.TIFFRepresentation,
+      }
+      c.postNotificationName_object_userInfo_deliverImmediately(:GrowlApplicationRegistrationNotification, nil, dic, true)
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: dmathieu-growlcocoa
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Satoshi Nakagawa
+- Damien MATHIEU
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 42@dmathieu.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README.textile
+- Rakefile
+- VERSION
+- growlcocoa.gemspec
+- lib/growl.rb
+has_rdoc: true
+homepage: http://github.com/dmathieu/growlcocoa
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: A library to send growl alerts using rubycocoa
+test_files: []
+