real-growl 0.2.0 → 0.3.0

data/README.md

@@ -0,0 +1,60 @@
+real-growl
+
+Description
+===========
+
+A Growl notification library that uses native c bindings to interact with GrowlApplicationBridge rather than Growl's network API.
+
+Synopsis
+========
+
+### rg
+
+    >> require 'real_growl'
+    => true
+    >> rg("Check out", ["Real", "Growl"], :icon => "/path/to/a/picture.jpg")
+    >> rg("Google", ["Real", "Growl"], :icon => "http://www.google.com/logos/stpatricks_d4gwinner_eo09.gif")
+    => nil
+  
+    >> Kernel.rg_sticky = false
+    => false
+    >> Kernel.rg_priority = 3
+    => 3
+    >> Kernel.rg_icon = "/the/path/cool.png"
+    => "/the/path/cool.png"
+  
+### Custom Application
+
+    >> require 'real_growl'
+    >> my_own_application = RealGrowl::Application.new("AppName")
+    => #<RealGrowl::Application:0x1018eb6b8>
+    >> my_own_application.notify(:title => "Title", :description => "Desc", :priority => 0, :sticky => true, :icon => "/path/to/image.png")
+
+### Extras
+    >> RealGrowl.installed?
+    => true
+    >> RealGrowl.running?
+    => true
+
+TODO
+====
+  * Add executable script
+  * Enable growl callbacks
+  
+Requirements
+============
+
+* MacOS X 10.5 > ??
+* Growl Framework - http://growl.info/downloads_developers.php
+
+INSTALL
+=======
+
+Download and install Growl.framework into either ~/Library/Frameworks or /Library/Frameworks
+gem install real-growl
+
+INSTALLATION HINTS
+==================
+
+Make sure that the Growl.framework is either 32bit or the 64bit depending on the version of MacOS X
+installed and the kind of machine it is installed on.

data/ext/extconf.rb

@@ -2,7 +2,7 @@
 require 'mkmf'
 
 
-$CFLAGS << ' ' + "-ObjC"
+$CFLAGS << ' ' + "-ObjC "
 $LDFLAGS << ' ' + "-lobjc -framework Foundation -framework Growl"
 $objs = %w(ruby_delegate.o real_growl_api.o)
 

data/ext/real_growl_api.c

@@ -12,6 +12,28 @@ build_nsstring(VALUE string) {
   }
 }
 
+static NSData*
+get_icon_data(VALUE pathOrUrl) {
+  NSString *nsPathOrUrl = build_nsstring(pathOrUrl);
+  NSData *iconData = nil;
+  
+  if(nsPathOrUrl != nil) {
+    iconData = [NSData dataWithContentsOfFile: nsPathOrUrl];
+    
+    if(iconData == nil) {
+      iconData = [NSData dataWithContentsOfURL: [NSURL URLWithString: nsPathOrUrl]];
+    }
+  }
+  
+  return iconData;
+}
+
+
+static NSAutoreleasePool*
+create_autorelease_pool() {
+  return [[NSAutoreleasePool alloc] init];
+}
+
 static void
 free_delegate(id delegate) {
   [delegate release];
@@ -22,11 +44,6 @@ alloc_delegate(VALUE klass) {
   return Data_Wrap_Struct(klass, 0, free_delegate, [[RubyDelegate alloc] init]);  
 }
 
-static NSAutoreleasePool*
-create_autorelease_pool() {
-  return [[NSAutoreleasePool alloc] init];
-}
-
 VALUE
 classMethod_installed(VALUE self) {
   NSAutoreleasePool *pool = create_autorelease_pool();
@@ -54,22 +71,34 @@ classMethod_running(VALUE self) {
 }
 
 VALUE
-// VALUE title, VALUE description, VALUE priority, VALUE sticky, VALUE iconPath
 method_notify(VALUE self, VALUE options) {
   NSAutoreleasePool *pool = create_autorelease_pool();
+  id delegate = NULL;
+  Data_Get_Struct(self, RubyDelegate, delegate);
   
   VALUE title             = rb_hash_aref(options, ID2SYM(rb_intern("title")));
   VALUE description       = rb_hash_aref(options, ID2SYM(rb_intern("description")));
-  VALUE priority          = rb_hash_aref(options, ID2SYM(rb_intern("priority")));
-  priority                = (priority == Qnil) ? INT2NUM(0) : priority;
+  VALUE priority          = rb_Integer(rb_hash_aref(options, ID2SYM(rb_intern("priority"))));
   VALUE sticky            = rb_hash_aref(options, ID2SYM(rb_intern("sticky")));
   VALUE iconPath          = rb_hash_aref(options, ID2SYM(rb_intern("icon")));  
+  VALUE click             = rb_hash_aref(options, ID2SYM(rb_intern("click")));
+  
   BOOL nsSticky           = (sticky == Qtrue) ? YES : NO;
-  NSData *data            = [NSData dataWithContentsOfFile:build_nsstring(iconPath)];
+  NSData *data            = get_icon_data(iconPath);
   NSString *nsTitle       = build_nsstring(title);
   NSString *nsDescription = build_nsstring(description);
+  NSNumber *clickContext  = [NSNumber numberWithUnsignedLong: self];
   
-  [GrowlApplicationBridge notifyWithTitle: nsTitle description: nsDescription notificationName: REAL_GROWL_NOTIFICATION iconData: data priority: NUM2INT(priority) isSticky:nsSticky clickContext:nil];
+  [delegate setCallbackProc: click];
+  [GrowlApplicationBridge setGrowlDelegate: delegate];  
+  [GrowlApplicationBridge 
+    notifyWithTitle: nsTitle 
+    description: nsDescription 
+    notificationName: REAL_GROWL_NOTIFICATION 
+    iconData: data 
+    priority: NUM2INT(priority) 
+    isSticky:nsSticky 
+    clickContext:clickContext];
   
   [pool drain];
   
@@ -82,9 +111,8 @@ method_init(VALUE self, VALUE applicationName) {
   id delegate = NULL;  
   
   Data_Get_Struct(self, RubyDelegate, delegate);  
-  NSString *nsAppName = [NSString stringWithCString:STR2CSTR(applicationName) encoding: NSASCIIStringEncoding];
+  NSString *nsAppName = build_nsstring(applicationName);
   [delegate setApplicationName: nsAppName];
-  [GrowlApplicationBridge setGrowlDelegate: delegate];
   
   [pool drain];
   

data/ext/real_growl_api.h

@@ -2,4 +2,4 @@
 #include "ruby.h"
 #include <objc/runtime.h>
 #include <Growl/Growl.h>
-#include <Foundation/Foundation.h>
+#include <Foundation/Foundation.h>

data/ext/{ruby_delegate.m → ruby_delegate.c}

@@ -1,7 +1,7 @@
 #include "ruby_delegate.h"
 
 @implementation RubyDelegate
-@synthesize applicationName;
+@synthesize applicationName, callbackProc;
 
 -(id)init {
   if(self = [super init]) {
@@ -12,9 +12,19 @@
   return nil;
 }
 
+-(NSString *)applicationNameForGrowl {
+  return applicationName;
+}
+
 -(NSDictionary *)registrationDictionaryForGrowl {
   NSArray *notifications = [NSArray arrayWithObject:REAL_GROWL_NOTIFICATION];
-  return [NSDictionary dictionaryWithObjectsAndKeys: [self applicationName], GROWL_APP_ID, [self applicationName], GROWL_APP_NAME, notifications, GROWL_NOTIFICATIONS_ALL, nil];
+  return [NSDictionary dictionaryWithObjectsAndKeys: [self applicationName], GROWL_APP_ID, [self applicationName], GROWL_APP_NAME, notifications, GROWL_NOTIFICATIONS_ALL, notifications, GROWL_NOTIFICATIONS_DEFAULT, nil];
+}
+
+-(void)growlNotificationWasClicked:(id)clickContext {
+  if(callbackProc != Qnil) {
+    rb_funcall(callbackProc, rb_intern("call"), 0);
+  }
 }
 
 -(void)dealloc {

data/ext/ruby_delegate.h

@@ -1,12 +1,19 @@
 #include <Foundation/Foundation.h>
 #include <Growl/Growl.h>
+#include "ruby.h"
+
 #define REAL_GROWL_NOTIFICATION XSTR("RealGrowlNotification")
 
 @interface RubyDelegate : NSObject<GrowlApplicationBridgeDelegate>
 {
   NSString *applicationName;
+  VALUE callbackProc;
 }
 
 -(NSDictionary *) registrationDictionaryForGrowl;
+-(void) growlNotificationWasClicked:(id)clickContext;
+-(NSString *)applicationNameForGrowl;
+
+@property(nonatomic, assign) VALUE callbackProc;
 @property(nonatomic, retain) NSString *applicationName;
 @end

data/lib/real_growl.rb

@@ -10,11 +10,13 @@ module Kernel
     Kernel.rg_priority ||= 0
     Kernel.rg_sticky = true if Kernel.rg_sticky.nil?
     icon = Kernel.rg_icon
+    click = nil
     
     @__growl_app ||= RealGrowl::Application.new("RealGrowl")
     
-    if args.last.is_a?(Hash) and args.last[:icon]
+    if args.last.is_a?(Hash) and (args.last[:icon] or args.last[:click])
       icon = args.last[:icon]
+      click = args.last[:click]
       args.pop
     end
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: real-growl
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Justin DeWind
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-18 00:00:00 -05:00
+date: 2010-02-05 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -20,15 +20,15 @@ executables: []
 extensions: 
 - ext/extconf.rb
 extra_rdoc_files: 
-- README.rdoc
+- README.md
 files: 
-- README.rdoc
 - Rakefile
 - ext/real_growl_api.c
 - ext/real_growl_api.h
+- ext/ruby_delegate.c
 - ext/ruby_delegate.h
-- ext/ruby_delegate.m
 - lib/real_growl.rb
+- README.md
 has_rdoc: true
 homepage: http://github.com/dewind/real-growl
 licenses: []

data/README.rdoc

@@ -1,47 +0,0 @@
-real-growl
-
-== DESCRIPTION:
-
-A Growl notification library that uses native c bindings to interact with GrowlApplicationBridge rather than Growl's network API.
-
-== SYNOPSIS:
-
-  >> require 'real_growl'
-  => true
-  >> rg("Check out", ["Real", "Growl"], :icon => "/path/to/a/picture.jpg")
-  => nil
-  
-  >> Kernel.rg_sticky = false
-  => false
-  >> Kernel.rg_priority = 3
-  => 3
-  >> Kernel.rg_icon = "/the/path/cool.png"
-  => "/the/path/cool.png"
-  
-  >> my_own_application = RealGrowl::Application.new("AppName")
-  => #<RealGrowl::Application:0x1018eb6b8>
-  >> my_own_application.notify(:title => "Title", :description => "Desc", :priority => 0, :sticky => true, :icon => "/path/to/image.png")
-  
-  >> RealGrowl.installed?
-  => true
-  >> RealGrowl.running?
-  => true
-
-== TODO:
-  * Add executable script
-  * Enable growl callbacks
-  
-== REQUIREMENTS:
-
-* MacOS X 10.5 > ??
-* Growl Framework - http://growl.info/downloads_developers.php
-
-== INSTALL:
-
-Download and install Growl.framework into either ~/Library/Frameworks or /Library/Frameworks
-gem install real-growl
-
-== INSTALLATION HINTS:
-
-Make sure that the Growl.framework is either 32bit or the 64bit depending on the version of MacOS X
-installed and the kind of machine it is installed on.