spidah-ruby_gntp 0.1.2 → 0.1.3

data/ChangeLog

@@ -16,3 +16,11 @@
 == 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.
+

data/lib/ruby_gntp.rb

@@ -40,6 +40,9 @@ class GNTP
   attr_reader :app_name, :target_host, :target_port, :password
   attr_reader :message if $DEBUG
 
+  RUBY_GNTP_NAME = 'ruby_gntp'
+  RUBY_GNTP_VERSION = '0.1.3'
+
   def initialize(app_name = 'Ruby/GNTP', host = 'localhost', password = '', port = 23053)
     @app_name    = app_name
     @target_host = host
@@ -55,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
-#{get_gntp_header_start('REGISTER')}
-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
   #
@@ -97,16 +101,16 @@ EOF
     icon   = params[:icon] || get_notification_icon(name)
     sticky = params[:sticky]
 
-    @message = <<EOF
-#{get_gntp_header_start('NOTIFY')}
-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"
@@ -133,7 +137,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)
@@ -159,6 +162,51 @@ EOF
     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
+  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
+  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
   #
@@ -174,6 +222,41 @@ EOF
       "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)
+      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
 
 #----------------------------

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spidah-ruby_gntp
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - snaka