ahoy 0.0.1 → 0.0.2

data/lib/ahoy/broadcast.rb

@@ -2,8 +2,7 @@ require File.expand_path("#{File.dirname(__FILE__)}/../ahoy")
 
 module Ahoy
   class Broadcast
-    def initialize(name, location="nowhere", domain="local")
-      user = Ahoy::User.new(name, location, domain)
+    def initialize(user)
       user.sign_in
       sleep 1
       @chats = user.contacts.map {|contact| user.chat(contact)}

data/lib/ahoy/chat.rb

@@ -4,8 +4,9 @@ require File.expand_path("#{File.dirname(__FILE__)}/xmpp4r_hack")
 
 module Ahoy
   class Chat
-    attr_reader :user, :contact, :client
-    private :client
+    attr_reader :user, :contact
+    attr_accessor :client
+    protected :client, :client=
     
     def initialize(user, contact)
       @user = user
@@ -28,7 +29,7 @@ module Ahoy
       message = Jabber::Message.new(contact.name, message)
       message.type = :chat
       begin
-        @client.send(message)
+        client.send(message)
       rescue IOError
         connect
         retry
@@ -36,19 +37,45 @@ module Ahoy
       message
     end
     
+    def on_reply(&block)
+      start unless client
+      client.delete_message_callback("on_reply")
+      
+      client.add_message_callback(0, "on_reply") do |message|
+        block.call(message.body) if message.type == :chat
+      end
+    end
+    
+    def receive
+      start unless client
+      thread = Thread.current
+      reply = nil
+      
+      client.add_message_callback(0, "receive") do |message|
+        if message.type == :chat
+          reply = message.body
+          thread.run
+        end
+      end
+      Thread.stop
+      
+      client.delete_message_callback("receive")
+      reply
+    end
+    
     def close
-      @client.close
-      @client = nil
+      client.close
+      self.client = nil
     end
     
     private
     def connect
       contact.resolve
       
-      @client = Jabber::Client.new(Jabber::JID.new(user.name))
+      self.client = Jabber::Client.new(Jabber::JID.new(user.name))
       sleep 0.5
       begin
-        @client.connect(contact.target, contact.port, user.contact.ip)
+        client.connect(contact.target, contact.port, user.contact.ip)
       rescue Errno::ECONNREFUSED
         raise Ahoy::ContactOfflineError.new("Contact Offline")
       end

data/lib/ahoy/user.rb

@@ -16,7 +16,7 @@ module Ahoy
       
       @port = 5562
       @flags = 0
-      @interface = "en0"
+      @interface = DNSSD::InterfaceAny
     end
     
     def name

data/readme.rdoc

@@ -0,0 +1,72 @@
+=Ahoy
+Serverless Messaging using Bonjour/DNSDS/mDNS, XMPP, and Ruby
+
+Wha?
+
+In simpler terms, this is a library for sending messages to iChat (or Adium, Pidgin, etc) using the Bonjour chat protocol.
+
+The Bonjour chat protocol is pretty much XMPP with the presence and server parts ripped out and replaced Bonjour (DNS Service Discovery and multicast DNS). Like standard XMPP while mainly used as for instant messaging, there is nothing stopping you for using it for a more generic messaging system, a presence system or interprocess communication.
+
+Ahoy isn't much more than a wrapper with a nice API around the dnssd and xmpp4r gems.
+
+The API is based around the idea that this is an instant messaging protocol, there is a user, that user has a list of contacts, you can start a chat with a contact and send messages the contact though that chat session. This may be refined, but is unlikely to change in it's outlook.
+
+Example:
+
+  require 'rubygems'
+  require 'ahoy'
+  
+  user = Ahoy::User.new("mat")
+  user.sign_in
+  
+  sleep 1                               # wait for the contact list to populate
+  
+  first_contact = user.contacts.first   # find someone to talk to
+  
+  chat = user.chat(first_contact)       # open a chat with them
+  
+  chat.send("We come in peace.")        # send a message
+  
+  puts chat.receive                     # blocks until we get a response
+  
+  chat.close
+
+Along with the blocking Chat#receive method to receive replies, there is an on_reply method that takes a callback. This method returns immediately, and the block is only called when there is a reply, and can be used like so
+
+  require 'rubygems'
+  require 'ahoy'
+  
+  user = Ahoy::User.new("mat")
+  user.sign_in
+  sleep 1
+  chat = user.chat(user.contacts.first)
+  
+  chat.on_reply do |reply|
+    puts reply
+  end
+  
+  chat.send("hello")
+  
+  # do something while we wait for a reply
+  loop do
+    sleep 1
+  end
+
+If you are sending messages to a contact on the same machine (likely while testing, sending messages to yourself in iChat), you may need to set the interface on the user to your primary network interface:
+
+  user = Ahoy::User.new("mat")
+  user.interface = "en1"   # on Mac OS X en1 is usually Wi-Fi, en0 is ethernet
+  user.sign_in
+  
+  ...
+
+The current use case is to send a message to a team of developers when a deploy script is run, there is a simplified interface for this:
+
+  require 'rubygems'
+  require 'ahoy/broadcast'
+  
+  user = Ahoy::User.new("Dr. Nick")
+  cast = Ahoy::Broadcast.new(user)
+  
+  cast.send("Hi, everybody!")
+  cast.close

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ahoy
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mat Sadler
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-27 00:00:00 +00:00
+date: 2010-03-04 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,6 +49,7 @@ files:
 - lib/ahoy/user.rb
 - lib/ahoy/xmpp4r_hack.rb
 - lib/ahoy.rb
+- readme.rdoc
 has_rdoc: true
 homepage: http://sourcetagsandcodes.com
 licenses: []