Skip to content
Ruby growlnotify 'bindings' (unobtrusive notification system)
Branch: master
Clone or download
Pull request Compare This branch is 10 commits ahead, 17 commits behind tj:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
lib
spec
tasks
.gitignore
History.rdoc
Manifest
README.rdoc
Rakefile
growl.gemspec

README.rdoc

Growl

Ruby growlnotify 'bindings'.

Examples

notification = Growl.new
notification.message = 'Hello World'
notification.sticky!
notification.icon = :jpeg
notification.run if Growl.installed?

# OR

Growl.notify {
  self.message = 'Hello World'
  self.icon = :jpeg
  sticky!
}

# OR

Growl.notify do |n|
  n.message = 'Hello World'
  n.icon = :jpeg
  n.stick!
end

# OR

Growl.notify 'Foo', :icon => :jpeg, :title => 'Growl'

# OR

include Growl
notify 'Email received', :sticky => true

# Convenience methods

notify_ok 'Deployment successful'
notify_info 'Email received'
notify_warning 'Merge required'
notify_error 'Failed to send email', :sticky => true

Normaized Icons

The :icon option key is automatically normalized when you use any of the Growl#notify methods, this removes the need to explicitly use :appIcon, :image, etc.

notify 'App icon', :icon => :Safari
notify 'Jpeg icon', :icon => :jpeg 
notify 'Image icon', :icon => 'path/to/image.png' 
notify 'Icns icon', :icon => 'path/to/icon.icns'
notify 'Path extname icon', :icon => 'foo.rb'

Normalised icons only work on OSX.

To support OSX and Windows always give a path to an image, e.g.

:image => 'path/to/image.png'

Features

  • Packaged with growlnotify (so notificatons always available)

  • Support for Growl for Windows

  • Wraps growlnotify to avoid dropped notificatons on OSX

  • Use images, icon paths, application icons, or file format icons

  • Sticky a notification making it appear until explicitly closed

  • Set notification priority

  • Convenience methods such as notify_ok, notify_warning, notify_error, and notify_info

  • Etc (consult growlnotify –help)

Known Issues

Not all switches work on Windows. Unsupported switches are:

:iconpath
:appIcon
:icon
:udp
:crypt

Contribute

Fork / send a pull request or submit a ticket at: github.com/visionmedia/growl/issues

License:

(The MIT License)

Copyright © 2009 TJ Holowaychuk <tj@vision-media.ca>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, an d/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.