ruby_gntp 0.2.3 → 0.3.0

data/lib/ruby_gntp.rb

@@ -38,17 +38,17 @@ class TooFewParametersError < Exception
 end
 
 class GNTP
-  attr_reader :app_name, :target_host, :target_port, :password
+  attr_reader :app_name, :target_host, :target_port
   attr_reader :message if $DEBUG
 
   RUBY_GNTP_NAME = 'ruby_gntp'
-  RUBY_GNTP_VERSION = '0.2.3'
+  RUBY_GNTP_VERSION = '0.3.0'
 
   def initialize(app_name = 'Ruby/GNTP', host = 'localhost', password = '', port = 23053)
-    @app_name    = app_name
-    @target_host = host
-    @target_port = port
-    @password = password
+    @app_name     = app_name
+    @target_host  = host
+    @target_port  = port
+    @password     = password
   end
 
   #
@@ -56,16 +56,17 @@ class GNTP
   #
   def register(params)
     @notifications = params[:notifications]
+    @app_icon = params[:app_icon]
+
     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 = register_header(@app_name, @app_icon)
+    message << output_origin_headers
 
-    @message << "Notifications-Count: #{@notifications.size}\r\n"
-    @message << "\r\n"
+    message << "Notifications-Count: #{@notifications.size}\r\n"
+    message << "\r\n"
 
     @notifications.each do |notification|
       name      = notification[:name]
@@ -73,19 +74,19 @@ class GNTP
       enabled   = notification[:enabled] || true
       icon      = notification[:icon]
 
-      @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
+      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 << output_binary(binary)
     }
 
-    @message << "\r\n"
+    message << "\r\n"
 
-    unless (ret = send_and_recieve(@message))
+    unless (ret = send_and_recieve(message))
       raise "Register failed"
     end
   end
@@ -93,27 +94,33 @@ class GNTP
   #
   # notify
   #
-  def notify(params)
+  def notify(params, &callback)
     name   = params[:name]
-    raise TooFewParametersError, "Notification need 'name', 'title' parameters" unless name || title
-
     title  = params[:title]
     text   = params[:text]
     icon   = params[:icon] || get_notification_icon(name)
     sticky = params[:sticky]
+    callback_context = params[:callback_context]
+    callback_context_type = params[:callback_context_type]
+
+    raise TooFewParametersError, "Notification need 'name', 'title' parameters" unless name || title
 
     @binaries = []
 
-    @message = notify_header(app_name, name, title, text, sticky, icon)
-    @message << output_origin_headers
+    message = notify_header(app_name, name, title, text, sticky, icon)
+    message << output_origin_headers
+    if callback || callback_context
+      message << "Notification-Callback-Context: #{callback_context || '(none)'}\r\n"
+      message << "Notification-Callback-Context-Type: #{callback_context_type || '(none)'}\r\n"
+    end
 
     @binaries.each {|binary|
-      @message << output_binary(binary)
+      message << output_binary(binary)
     }
 
-    @message << "\r\n"
+    message << "\r\n"
 
-    unless (ret = send_and_recieve(@message))
+    unless (ret = send_and_recieve(message, callback))
       raise "Notify failed"
     end
   end
@@ -122,7 +129,7 @@ class GNTP
   #
   # instant notification
   #
-  def self.notify(params)
+  def self.notify(params, &callback)
     host    = params[:host]
     passwd  = params[:passwd]
 
@@ -133,7 +140,7 @@ class GNTP
     growl.register(:notifications => [
       :name => notification[:name]
     ])
-    growl.notify(notification)
+    growl.notify(notification, &callback)
   end
 
   private
@@ -141,7 +148,7 @@ class GNTP
   #
   # send and recieve
   #
-  def send_and_recieve msg
+  def send_and_recieve(msg, callback=nil)
     print msg if $DEBUG
 
     sock = TCPSocket.open(@target_host, @target_port)
@@ -153,8 +160,24 @@ class GNTP
       print ">#{rcv}" if $DEBUG
       ret = $1 if /GNTP\/1.0\s+-(\S+)/ =~ rcv
     end
-    sock.close
 
+    if callback
+      Thread.new do 
+        response = {}
+        while rcv = sock.gets
+          break if rcv == "\r\n"
+          print ">>#{rcv}" if $DEBUG
+          response[:callback_result]        = $1 if /Notification-Callback-Result:\s+(\S*)\r\n/ =~ rcv
+          response[:callback_context]       = $1 if /Notification-Callback-Context:\s+(\S*)\r\n/ =~ rcv
+          response[:callback_context_type]  = $1 if /Notification-Callback-Context-Type:\s+(\S*)\r\n/ =~ rcv
+        end
+        callback.call(response)
+        sock.close
+      end
+      return true
+    end
+
+    sock.close
     return 'OK' == ret
   end
 
@@ -198,6 +221,9 @@ class GNTP
 
     platformname, platformversion = '', ''
 
+    # see Proper way to detect Windows platform in Ruby - The Empty Way
+    #     http://blog.emptyway.com/2009/11/03/proper-way-to-detect-windows-platform-in-ruby/
+    #
     if Config::CONFIG['host_os'] =~ /mswin/
       ver = `ver`
       if ver.index('[')
@@ -285,7 +311,9 @@ if __FILE__ == $0
     :text  => "Congraturation! You are successful install ruby_gntp.",
     :icon  => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",
     :sticky=> true
-  )
+  ) do |response|
+    p response
+  end
 
   #--- Use instant notification method (just 'notify')
   GNTP.notify({
@@ -295,7 +323,14 @@ if __FILE__ == $0
     :title    => "Instant notification", 
     :text     => "Instant notification available now.",
     :icon     => "http://www.hatena.ne.jp/users/sn/snaka72/profile.gif",
-  })
+  }) do |response|
+    p response
+  end
+
+  #--- wait
+  puts
+  puts "press enter key to finish."
+  a = STDIN.gets
 end
 
 # vim: ts=2 sw=2 expandtab fdm=marker

data/test/ruby_gntp_spec.rb

@@ -54,6 +54,7 @@ describe GNTP do
     ].each {|expected_text| 
       @sended_messages.last.should include(expected_text) 
     }
+
   end
 
   it "can notify with minimum params" do
@@ -72,11 +73,67 @@ describe GNTP do
   end
 
   it "should callback when notify clicked" do
+    # prepare callback msg
+    @opened_socket.add [
+      "GNTP/1.0 -CALLBACK NONE\r\n",
+      "Notification-Callback-Result: CLICKED\r\n",
+      "Notification-Callback-Context: hoge\r\n",
+      "Notification-Callback-Context-Type: fuga\r\n",
+      "\r\n",
+    ].join
+
+    callback_called = false
+    msg = {}
+
     @gntp = GNTP.new
     @gntp.register :notifications => [{:name => NOTIFICATION_NAME}]
-    @gntp.notify(:name => NOTIFICATION_NAME) do |context|
-      context.should_not_nil
+    @gntp.notify(:name => NOTIFICATION_NAME) do |response|
+      sleep 1
+      callback_called = true
+      msg = response
     end
+
+    [
+      "Notification-Callback-Context: (none)\r\n",
+      "Notification-Callback-Context-Type: (none)\r\n"
+    ].each {|expected_text| 
+      @sended_messages.last.should include(expected_text) 
+    }
+
+    # wait for callback called
+    sleep 3
+    callback_called.should be_true
+    msg[:callback_result].should        == 'CLICKED'
+    msg[:callback_context].should       == 'hoge'
+    msg[:callback_context_type].should  == 'fuga'
+  end
+
+  it "should not send 'Notification-Callback-*' header when block parameter has not given" do
+    @gntp = GNTP.new
+    @gntp.register :notifications => [{:name => NOTIFICATION_NAME}]
+    @gntp.notify :name => NOTIFICATION_NAME
+
+    [
+      "Notification-Callback-Context: (none)\r\n",
+      "Notification-Callback-Context-Type: (none)\r\n"
+    ].each {|expected_text| 
+      @sended_messages.last.should_not include(expected_text) 
+    }
+  end
+
+  it "should send 'Notification-Callback-*' header when block parameter has not given, but supply :callback_* parameter given" do
+    @gntp = GNTP.new
+    @gntp.register :notifications => [{:name => NOTIFICATION_NAME}]
+    @gntp.notify :name                  => NOTIFICATION_NAME, 
+                 :callback_context      => 'hoge',
+                 :callback_context_type => 'text'
+
+    [
+      "Notification-Callback-Context: hoge\r\n",
+      "Notification-Callback-Context-Type: text\r\n"
+    ].each {|expected_text| 
+      @sended_messages.last.should include(expected_text) 
+    }
   end
 
 end

data/test/ruby_gntp_spec_helper.rb

@@ -16,6 +16,12 @@ module GNTPExampleHelperMethods
       ok_response.rewind
     end
 
+    stub(sock).add do |msg|
+      ok_response.seek(0, IO::SEEK_END)
+      ok_response.write msg
+      ok_response.rewind
+    end 
+
     stub(sock).gets do
       ok_response.gets
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_gntp
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors: 
 - snaka
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 +09:00
+date: 2009-11-09 00:00:00 +09:00
 default_executable: 
 dependencies: []