Merge spidah's commits and some test codes.

Author: snaka

ChangeLog

@@ -24,3 +24,7 @@
 * 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).
+

lib/ruby_gntp.rb

@@ -122,7 +122,11 @@ def notify(params)
   # 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 => [
@@ -169,6 +173,7 @@ 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
 
   #
@@ -182,6 +187,7 @@ def notify_header(app_name, name, title, text, sticky, icon)
     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
@@ -262,24 +268,29 @@ def output_binary(binary)
 #----------------------------
 # 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",

ruby_gntp.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "ruby_gntp"
-  s.version = "0.1.3.1"
+  s.version = "0.2.0"
   s.summary = "Ruby library for GNTP(Growl Notification Transport Protocol) client"
   s.authors = ["snaka", "David Hayward (spidah)"]
   s.email = ["[email protected]", "[email protected]"]
@@ -9,6 +9,8 @@ Gem::Specification.new do |s|
     "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"

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

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