ruby_gntp 0.1.1 → 0.2.0

data/ChangeLog

@@ -16,3 +16,15 @@
 == Version 0.1.1 - 2009/4/17
 * Add NOTE to example directory.
 
+== Version 0.1.2 - 2009/08/15
+* Enabled password authentication mainly for sending notifications to a network machine.
+
+== Version 0.1.3 - 2009/08/19
+* Added notification icon sending.
+* Now sends out Origin-X headers.
+* Use \r\n instead of \n in the header lines.
+
+== Version 0.2.0 - 2009/11/03
+* Merge spidahman's commits. Lot of thanks, spidahman!
+* Add some test(spec).
+

data/lib/ruby_gntp.rb

@@ -29,6 +29,7 @@
 #
 #}}}
 require 'socket'
+require 'digest/md5'
 
 #$DEBUG = true
 
@@ -36,13 +37,17 @@ class TooFewParametersError < Exception
 end
 
 class GNTP
-  attr_reader :app_name, :target_host, :target_port
+  attr_reader :app_name, :target_host, :target_port, :password
   attr_reader :message if $DEBUG
 
-  def initialize(app_name = 'Ruby/GNTP', host = 'localhost', port = 23053)
+  RUBY_GNTP_NAME = 'ruby_gntp'
+  RUBY_GNTP_VERSION = '0.1.3.1'
+
+  def initialize(app_name = 'Ruby/GNTP', host = 'localhost', password = '', port = 23053)
     @app_name    = app_name
     @target_host = host
     @target_port = port
+    @password = password
   end
 
   #
@@ -53,36 +58,37 @@ class GNTP
     raise TooFewParametersError, "Need least one 'notification' for register" unless @notifications
 
     @app_icon = params[:app_icon]
+    @binaries = []
+
+    @message = register_header(@app_name, @app_icon)
+    @message << output_origin_headers
 
-    @message = <<EOF
-GNTP/1.0 REGISTER NONE
-Application-Name: #{@app_name}
-Notifications-Count: #{@notifications.size}
-EOF
-    @message << "Application-Icon: #{@app_icon}\n" if @app_icon
-    @message << "\n"
+    @message << "Notifications-Count: #{@notifications.size}\r\n"
+    @message << "\r\n"
 
     @notifications.each do |notification|
       name      = notification[:name]
-      disp_name = notification[:disp_name]
+      disp_name = notification[:disp_name] || name
       enabled   = notification[:enabled] || true
       icon      = notification[:icon]
 
-      @message += <<EOF
-Notification-Name: #{name}
-EOF
-      @message << "Notification-Display-Name: #{disp_name}\n" if disp_name
-      @message << "Notification-Enabled: #{enabled}\n"        if enabled
-      @message << "Notification-Icon: #{icon}\n"              if icon
-      @message << "\n"
+      @message << "Notification-Name: #{name}\r\n"
+      @message << "Notification-Enabled: #{enabled ? 'True' : 'False'}\r\n"
+      @message << "Notification-Display-Name: #{disp_name}\r\n"
+      @message << "#{handle_icon(icon, 'Notification')}\r\n"    if icon
     end
 
+    @binaries.each {|binary|
+      @message << output_binary(binary)
+    }
+
+    @message << "\r\n"
+
     unless (ret = send_and_recieve(@message))
       raise "Register failed"
     end
   end
 
-
   #
   # notify
   #
@@ -95,16 +101,16 @@ EOF
     icon   = params[:icon] || get_notification_icon(name)
     sticky = params[:sticky]
 
-    @message = <<EOF
-GNTP/1.0 NOTIFY NONE
-Application-Name: #{@app_name}
-Notification-Name: #{name}
-Notification-Title: #{title}
-EOF
-    @message << "Notification-Text: #{text}\n"     if text
-    @message << "Notification-Sticky: #{sticky}\n" if sticky
-    @message << "Notification-Icon: #{icon}\n"     if icon
-    @message << "\n"
+    @binaries = []
+
+    @message = notify_header(app_name, name, title, text, sticky, icon)
+    @message << output_origin_headers
+
+    @binaries.each {|binary|
+      @message << output_binary(binary)
+    }
+
+    @message << "\r\n"
 
     unless (ret = send_and_recieve(@message))
       raise "Notify failed"
@@ -116,7 +122,11 @@ EOF
   # instant notification
   #
   def self.notify(params)
-    growl = GNTP.new(params[:app_name])
+    host    = params[:host]
+    passwd  = params[:passwd]
+
+    growl = GNTP.new(params[:app_name], host, passwd)
+
     notification = params
     notification[:name] = params[:app_name] || "Ruby/GNTP notification"
     growl.register(:notifications => [
@@ -131,7 +141,6 @@ EOF
   # send and recieve
   #
   def send_and_recieve msg
-    msg.gsub!(/\n/, "\r\n")
     print msg if $DEBUG
 
     sock = TCPSocket.open(@target_host, @target_port)
@@ -156,29 +165,132 @@ EOF
     return nil unless notification
     return notification[:icon]
   end
+
+  #
+  # outputs the registration header
+  #
+  def register_header(app_name, app_icon)
+    message =  "#{get_gntp_header_start('REGISTER')}\r\n"
+    message << "Application-Name: #{app_name}\r\n"
+    message << "#{handle_icon(@app_icon, 'Application')}\r\n" if app_icon
+    message
+  end
+
+  #
+  # outputs the notification header
+  #
+  def notify_header(app_name, name, title, text, sticky, icon)
+    message =  "#{get_gntp_header_start('NOTIFY')}\r\n"
+    message << "Application-Name: #{@app_name}\r\n"
+    message << "Notification-Name: #{name}\r\n"
+    message << "Notification-Title: #{title}\r\n"
+    message << "Notification-Text: #{text}\r\n"            if text
+    message << "Notification-Sticky: #{sticky}\r\n"        if sticky
+    message << "#{handle_icon(icon, 'Notification')}\r\n"  if icon
+    message
+  end
+
+  def output_origin_headers
+    message =  "Origin-Machine-Name: #{Socket.gethostname}\r\n"
+    message << "Origin-Software-Name: #{RUBY_GNTP_NAME}\r\n"
+    message << "Origin-Software-Version: #{RUBY_GNTP_VERSION}\r\n"
+
+    platformname, platformversion = '', ''
+
+    if ENV['OS']
+      ver = `ver`
+      if ver.index('[')
+        matches = ver.scan(/(.*)\[+(.*)\]+/)[0]
+        platformname, platformversion = matches[0], matches[1]
+      else
+        platformname, platformversion = 'Microsoft Windows', ver
+      end
+    else
+      platformname, platformversion = `uname -s`, `uname -r`
+    end
+
+    message << "Origin-Platform-Name: #{platformname.strip}\r\n"
+    message << "Origin-Platform-Version: #{platformversion.strip}\r\n"
+  end
+
+  #
+  # get start of the GNTP header
+  #
+  def get_gntp_header_start(type)
+    if @password.empty?
+      "GNTP/1.0 #{type} NONE"
+    else
+      saltvar = Time.now.to_s
+      salt = Digest::MD5.digest(saltvar)
+      salthash = Digest::MD5.hexdigest(saltvar)
+      key = Digest::MD5.digest("#{@password}#{salt}")
+      keyhash = Digest::MD5.hexdigest(key)
+      "GNTP/1.0 #{type} NONE MD5:#{keyhash}.#{salthash}"
+    end
+  end
+
+  #
+  # figure out how to handle the icon
+  #   a URL icon just gets put into the header
+  #   a file icon gets read and stored, ready to be appended to the end of the request
+  #
+  def handle_icon(icon, type)
+    if File.exists?(icon) && @target_host != 'localhost'
+      file = File.new(icon)
+      data = file.read
+      size = data.length
+      if size > 0
+        binary = {
+          :size => size,
+          :data => data,
+          :uniqueid => Digest::MD5.hexdigest(data)
+        }
+        @binaries << binary
+        "#{type}-Icon: x-growl-resource://#{binary[:uniqueid]}"
+      end
+    else
+      "#{type}-Icon: #{icon}"
+    end
+  end
+
+  #
+  # outputs any binary data to be sent
+  #
+  def output_binary(binary)
+    message =  "\r\n"
+    message << "Identifier: #{binary[:uniqueid]}\r\n"
+    message << "Length: #{binary[:size]}\r\n"
+    message << "\r\n"
+    message << "#{binary[:data]}\r\n"
+  end
 end
 
 #----------------------------
 # self test code
 if __FILE__ == $0
+  host = ARGV[0] || 'loaclhost'
+  passwd = host && ARGV[1] 
+
   #--- Use standard notification method ('register' first then 'notify')
-  growl = GNTP.new("Ruby/GNTP self test")
-  growl.register({:notifications => [{
+  growl = GNTP.new("Ruby/GNTP self test", host, passwd)
+  growl.register(:notifications => [{
       :name     => "notify",
-      :enabled  => true,
-  }]})
+      :enabled  => true
+  }])
 
-  growl.notify({
+  growl.notify(
     :name  => "notify",
     :title => "Congraturation",
     :text  => "Congraturation! You are successful install ruby_gntp.",
     :icon  => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",
-    :sticky=> true,
-  })
+    :sticky=> true
+  )
 
   #--- Use instant notification method (just 'notify')
   GNTP.notify({
     :app_name => "Instant notify",
+    :host     => host,
+    :passwd   => passwd,
     :title    => "Instant notification", 
     :text     => "Instant notification available now.",
     :icon     => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",

data/test/ruby_gntp_spec.rb

@@ -0,0 +1,74 @@
+require '../lib/ruby_gntp'
+require 'ruby_gntp_spec_helper'
+
+# use Double Ruby for mock/stub framework.
+Spec::Runner.configure do |conf|
+  conf.mock_with :rr
+end
+
+# describe GNTP behavior
+describe GNTP do
+  include GNTPExampleHelperMethods
+
+  DEFAULT_APP_NAME  = "Ruby/GNTP"
+  NOTIFICATION_NAME = "TestApp"
+
+  before do
+    @sended_messages = []
+    @ok_response = StringIO.new(["GNTP/1.0 -OK NONE\r\n", "\r\n"].join)
+    @opened_socket = create_stub_socket(@ok_response, @sended_messages)
+  end
+
+  it "can register notifications with minimum params" do
+    @gntp = GNTP.new
+    @gntp.register :notifications => [{:name => NOTIFICATION_NAME}]
+
+    [
+      "GNTP/1.0 REGISTER NONE\r\n",
+      "Application-Name: #{DEFAULT_APP_NAME}\r\n",
+      "Notifications-Count: 1\r\n",
+      "\r\n",
+      "Notification-Name: #{NOTIFICATION_NAME}\r\n",
+      "Notification-Display-Name: #{NOTIFICATION_NAME}\r\n",
+      "Notification-Enabled: True\r\n"
+    ].each {|expected_text| 
+      @sended_messages.last.should include(expected_text) 
+    }
+  end
+
+  it "can register notifications to remote host" do
+    @gntp = GNTP.new "TestApp", "1.2.3.4", "password", 12345
+    @gntp.register :notifications => [{:name => NOTIFICATION_NAME}]
+
+    @opened_socket[:host].should == "1.2.3.4"
+    @opened_socket[:port].should == 12345
+
+    @sended_messages.last.first.should match(/GNTP\/1\.0 REGISTER NONE MD5:\S+\r\n/)
+    [
+      "Application-Name: TestApp\r\n",
+      "Notifications-Count: 1\r\n",
+      "\r\n",
+      "Notification-Name: #{NOTIFICATION_NAME}\r\n",
+      "Notification-Display-Name: #{NOTIFICATION_NAME}\r\n",
+      "Notification-Enabled: True\r\n"
+    ].each {|expected_text| 
+      @sended_messages.last.should include(expected_text) 
+    }
+  end
+
+  it "can notify with minimum params" do
+    @gntp = GNTP.new
+    @gntp.register :notifications => [{:name => NOTIFICATION_NAME}]
+    @gntp.notify :name => NOTIFICATION_NAME
+
+    [
+      "GNTP/1.0 NOTIFY NONE\r\n",
+      "Application-Name: #{DEFAULT_APP_NAME}\r\n",
+      "Notification-Name: #{NOTIFICATION_NAME}\r\n",
+      "Notification-Title: \r\n"
+    ].each {|expected_text| 
+      @sended_messages.last.should include(expected_text) 
+    }
+  end
+
+end

data/test/ruby_gntp_spec_helper.rb

@@ -0,0 +1,34 @@
+module GNTPExampleHelperMethods
+
+  def create_stub_socket(ok_response, sended_messages)
+
+    sock = {}
+
+    stub(sock).write do |string|
+      lines = []
+      buf = StringIO.new(string)
+
+      while line = buf.gets
+        lines << line
+      end
+
+      sended_messages << lines
+      ok_response.rewind
+    end
+
+    stub(sock).gets do
+      ok_response.gets
+    end
+
+    stub(sock).close
+
+    stub(TCPSocket).open do |host, port|
+      sock[:host] = host
+      sock[:port] = port
+      sock
+    end
+
+    sock
+  end
+
+end

metadata

@@ -1,20 +1,23 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_gntp
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - snaka
+- David Hayward (spidah)
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-04-20 00:00:00 +09:00
+date: 2009-11-04 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
 description: 
-email: snaka.gml@gmail.com
+email: 
+- snaka.gml@gmail.com
+- spidahman@gmail.com
 executables: []
 
 extensions: []
@@ -25,10 +28,12 @@ files:
 - lib/ruby_gntp.rb
 - example/twitter_notifier.rb
 - example/gntp-notify
+- test/ruby_gntp_spec.rb
+- test/ruby_gntp_spec_helper.rb
 - README
 - TODO
 - ChangeLog
-has_rdoc: false
+has_rdoc: true
 homepage: http://snaka.github.com/ruby_gntp/
 licenses: []
 
@@ -52,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.2
+rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
 summary: Ruby library for GNTP(Growl Notification Transport Protocol) client