rowl 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Jason Madigan
+
+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, and/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.

data/README.md

@@ -0,0 +1,60 @@
+Rowl
+====
+Rowl is a simple [Growl] notification sender for Ruby.
+
+Installation
+============
+
+As a RubyGem
+	
+	sudo gem install rowl
+	
+Since Rowl is tiny (and has no dependencies), you may just want to drop it into an existing project
+
+	git clone git://github.com/jasonmadigan/rowl
+	mv rowl/lib/rowl.rb <location>
+
+Then require it
+
+	require 'rowl'
+	
+Usage
+=====
+
+Before using Rowl, it's probably worth noting some things:
+
+* Applications need to register themselves with Growl before they can send notifications
+* Applications can have a number of different types of notifications associated with them
+* Registration requires you to include any types of notifications you'll wish to use later on
+* These notification types are user configurable - they can be enabled/disabled, styled etc. how a user wants
+* You only need to send a register your application once, but you'll want to store the application name you registered, along with any notification types, for future reference
+
+So, sending a notification is a little more involved than it might first seem. This reason why the API here is a little less terse than I'd like. Anyway.
+
+Load it (as a gem)
+
+	require 'rubygems'
+	require 'rowl'
+	
+Use it like so
+	
+	registration = Rowl::Registration.new("My Application", [{:name => "My Notification", :enabled => true}, {:name => "My Other Notification Type", :enabled => false}])
+	Rowl::Notification.new( :application => registration.application, 
+								            :notification => registration.notifications.first,
+								            :host => "localhost",
+								            :password => registration.password,
+								            :title => "Title", 
+								            :description => "Description" )
+							
+Patches, Bugs & Hatemail
+========================
+
+* Feel free to fork the project and send me a pull request with any changes if you come any bugs or general nastiness
+* All that I ask is that you don't touch the rakefile, version, or history (I'll update these and push out gem updates)
+* Tests would be nice, but I'm not going to reject a perfectly good fix if they're missing
+
+Copyright & Licensing
+=====================
+Copyright (c) 2009 Jason Madigan. MIT license, see LICENSE for details.
+
+[Growl]: http://growl.info

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rowl"
+    gem.summary = %Q{Rowl is a simple Growl notification sender for Ruby.}
+    gem.description = %Q{Rowl is a simple Growl notification sender for Ruby.}
+    gem.email = "jason@jasonmadigan.com"
+    gem.homepage = "http://github.com/jasonmadigan/rowl"
+    gem.authors = ["Jason Madigan"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # 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
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rowl #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/rowl.rb

@@ -0,0 +1,176 @@
+# Protocol Description: http://growl.info/documentation/developer/protocol.php
+
+require 'digest/md5'
+require 'socket'
+require 'rubygems'
+require 'ruby-debug'
+
+module Rowl
+  
+  GROWL_UDP_PORT          = 9887
+  GROWL_PROTOCOL_VERSION  = 1
+  GROWL_TYPE_REGISTRATION = 0
+  GROWL_TYPE_NOTIFICATION = 1
+  REGISTRATION_FORMAT     = "CCnCCa*"   # Growl Network Registration Packet Format
+  NOTIFICATION_FORMAT     = "CCnnnnna*" # Growl Network Notification Packet Format
+  
+  class Registration
+    
+    attr_accessor :application, :notifications, :host, :password
+    
+    def initialize(application, notifications, host="localhost", password=nil)      
+      @defaults = []
+      @application = application
+      @notifications = []
+      @password = password
+      @host = host
+
+      # Register notifications
+      notifications.each do |notification|
+        add_notification_type(notification[:name], notification[:enabled])
+      end
+      
+      send_registration
+    end
+    
+    def app_name
+      chars = ("a".."z").to_a + ("1".."9").to_a 
+      Array.new(8, '').collect{chars[rand(chars.size)]}.join
+    end
+        
+    def add_notification_type(notification, enabled)
+      if enabled.nil?
+        enabled = true
+      end
+      @notifications << notification
+      if enabled
+        @defaults << @notifications.length - 1
+      end
+    end
+  
+    def send_registration
+      socket = UDPSocket.open
+      socket.send(payload, 0, @host, 9887)
+    end
+      
+    def payload
+      length = 0
+      data = []
+      data_format = ""
+    
+      packet = [
+        GROWL_PROTOCOL_VERSION, 
+        GROWL_TYPE_REGISTRATION
+      ]
+    
+      packet << @application.length
+      packet << @notifications.length
+      packet << @defaults.length
+    
+      data << @application
+      data_format = "a#{@application.length}"
+    
+      @notifications.each do |notify|
+        data << notify.length
+        data << notify
+        data_format << "na#{notify.length}"
+      end
+    
+      @defaults.each do |notify|
+        data << notify
+        data_format << "C"
+      end
+    
+      data = data.pack(data_format)
+    
+      packet << data
+      packet = packet.pack(REGISTRATION_FORMAT)
+          
+      if @password
+        checksum = Digest::MD5.digest(packet+@password)
+      else
+        checksum = Digest::MD5.digest(packet)
+      end
+    
+      packet << checksum
+    
+      return packet
+    end
+  end
+  
+  class Notification
+    def initialize(opts={})
+      opts = {
+        :priority => 0, 
+        :sticky => false,
+        :host => "localhost"
+      }.merge(opts)
+      
+      @application = opts[:application]
+      @password = opts[:password]
+      @host = opts[:host]
+      @notification = opts[:notification]
+      @title = opts[:title]
+      @description = opts[:description]
+      @priority = opts[:priority]
+      @sticky = opts[:sticky]
+      
+      send_notification
+    end
+    
+    def send_notification
+      socket = UDPSocket.open
+      socket.send(payload, 0, @host, 9887)
+    end
+    
+    def payload
+      flags = 0
+      data = []
+      
+      packet = [
+        GROWL_PROTOCOL_VERSION,
+        GROWL_TYPE_NOTIFICATION,
+      ]
+
+      flags = 0
+      flags |= ((0x7 & @priority) << 1) # 3 bits for priority
+      flags |= 1 if @sticky # 1 bit for sticky
+
+      packet << flags
+      packet << @notification.length
+      packet << @title.length
+      packet << @description.length
+      packet << @application.length
+
+      data << @notification
+      data << @title
+      data << @description
+      data << @application
+
+      packet << data.join
+      packet = packet.pack(NOTIFICATION_FORMAT)
+
+      if @password
+        checksum = Digest::MD5.digest(packet+@password)
+      else
+        checksum = Digest::MD5.digest(packet)
+      end
+      
+      packet << checksum
+      @datagram = packet
+    end
+    
+  end
+  
+end
+
+if __FILE__ == $0
+  registration = Rowl::Registration.new("My Application", [{:name => "My Notification", :enabled => true}, {:name => "My Other Notification Type", :enabled => false}])
+  Rowl::Notification.new( :application => registration.application, 
+							            :notification => registration.notifications.first,
+							            :host => "localhost",
+							            :password => registration.password,
+							            :title => "Title", 
+							            :description => "Description" )
+end
+

data/test/rowl_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class RowlTest < Test::Unit::TestCase
+  context "A Rowl instance" do
+  
+    setup do
+      @registration = Rowl::Registration.new("My Application", [{:name => "My Notification", :enabled => true}, {:name => "My Other Notification Type", :enabled => false}])
+    end
+    
+    should "have registered" do
+      assert_not_nil @registration
+    end
+    
+    should "be able to send a notifcation as a registered application" do
+      assert_not_nil Rowl::Notification.new( :application => @registration.application, 
+    							            :notification => @registration.notifications.first,
+    							            :host => "localhost",
+    							            :password => @registration.password,
+    							            :title => "Title", 
+    							            :description => "Description" )
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rowl'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: rowl
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jason Madigan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Rowl is a simple Growl notification sender for Ruby.
+email: jason@jasonmadigan.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/rowl.rb
+- test/rowl_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jasonmadigan/rowl
+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: 3
+summary: Rowl is a simple Growl notification sender for Ruby.
+test_files: 
+- test/rowl_test.rb
+- test/test_helper.rb