talker 0.0.1 → 0.0.2

data/README.md

@@ -27,8 +27,8 @@ A real-time Talker Ruby client.
 # Callbacks
 All arguments are optional.
 
-## <code>on_connected</code>
-Called when the user is authenticated and ready to receive events.
+## <code>on_connected(user)</code>
+Called when the user is authenticated and ready to receive events. "user" is a Hash containing your user info: <code>{"id"=>1, "name"=>"macournoyer", "email"=>"macournoyer@talkerapp.com"}</code>.
 
 ## <code>on_presence(users)</code>
 Called after <code>on_connected</code> with the list of connected users.
@@ -37,9 +37,13 @@ With <code>users</code> being something like this:
     [{"id"=>1, "name"=>"macournoyer", "email"=>"macournoyer@talkerapp.com"},
      {"id"=>2, "name"=>"gary", "email"=>"gary@talkerapp.com"}]
 
-## <code>on_message(user, message, event)</code>
+## <code>on_message(user, message)</code>
 Called when a new message is received.
-<code>user</code> is the sender. <code>event</code> contains the full event sent by the server.
+<code>user</code> is the sender.
+
+## <code>on_private_message(user, message)</code>
+Called when a new private message is received.
+<code>user</code> is the sender.
 
 ## <code>on_join(user)</code>
 Called when a user joins the room.
@@ -57,11 +61,19 @@ Called when a user leaves.
 Called when the connection is closed.
 
 ## <code>on_error(error_message)</code>
-Called an error is received from the Talker server.
+Called when an error is received from the Talker server.
+
+## <code>on_event(event)</code>
+Called when any kind of event (all of the above) is received. "event" is a Hash: <code>{"type":"event type","id":"unique ID",... event specific attributes}</code>.
 
 # Methods
 Methods of an instance of Talker class.
 
+## <code>current_user</code>
+Info about the user currently connected, <code>nil</code> if not yet connected:
+
+    {"id"=>1, "name"=>"macournoyer", "email"=>"macournoyer@talkerapp.com"}
+
 ## <code>users</code>
 Array of users currently in the room. In the form:
 

data/bin/talker-cat

@@ -21,12 +21,29 @@ usage: echo 'something' | talker-cat <room_id>
   
 EOS
 
-Talker.connect(:room => room, :token => token) do |client|
+# Non-blocking reader for stdin
+module Reader
+  attr_accessor :client
+  
+  def notify_readable
+    @client.send_message @io.readline.chomp
+  rescue EOFError
+    detach
+  end
+  
+  def unbind
+    @client.close
+  end
+end
+
+Talker.connect(:room => room.to_i, :token => token) do |client|
   client.on_connected do
-    client.send_message STDIN.read
-    client.close
+    conn = EM.watch STDIN, Reader
+    conn.client = client
+    conn.notify_readable = true
   end
   client.on_error do |error|
     puts error
   end
+  trap("INT") { client.close }
 end

data/bin/talker-shell

@@ -22,7 +22,7 @@ module Process
   attr_accessor :name, :client
   
   def receive_data(data)
-    log data
+    log data.chomp
   end
   
   def unbind
@@ -38,7 +38,7 @@ end
 
 
 EM.run do
-  Talker.connect(:room => room, :token => token) do |client|
+  Talker.connect(:room => room.to_i, :token => token) do |client|
     @process = nil
     
     client.on_connected do

data/lib/talker.rb

@@ -2,26 +2,27 @@ require "eventmachine"
 require "yajl"
 
 class Talker < EM::Connection
+  CALLBACKS = %w( connected message private_message join idle back leave presence error close event )
+  
   class Error < RuntimeError; end
   
-  attr_accessor :room, :token, :thread
+  attr_accessor :connect_options, :thread, :current_user
   
   def self.connect(options={})
-    host = options[:host] || "talkerapp.com"
-    port = (options[:port] || 8500).to_i
-    room = options[:room].to_i
-    token = options[:token]
-    
+    host = options.delete(:host) || "talkerapp.com"
+    port = (options.delete(:port) || 8500).to_i
+
     thread = Thread.new { EM.run } unless EM.reactor_running?
     
-    EM.connect host, port, self do |c|
+    connection = EM.connect host, port, self do |c|
       c.thread = thread
-      c.room = room
-      c.token = token
+      c.connect_options = options
       yield c if block_given?
     end
     
-    thread.join unless thread.nil?
+    thread.join if thread
+    
+    connection
   end
   
   def initialize
@@ -29,7 +30,7 @@ class Talker < EM::Connection
   end
   
   # Callbacks
-  %w( connected message join idle back leave presence error close ).each do |method|
+  CALLBACKS.each do |method|
     class_eval <<-EOS
       def on_#{method}(&block)
         @on_#{method} = block
@@ -45,25 +46,19 @@ class Talker < EM::Connection
     send({ :type => "message", :content => message }.merge(attributes))
   end
   
+  def find_user!(user_name)
+    @users.values.detect { |user| user["name"] == user_name } || raise(Error, "User #{user_name} not found")
+  end
+  
   def send_private_message(to, message)
     if to.is_a?(String)
-      user = @users.values.detect { |user| user["name"] == to }
-      raise Error, "User #{to} not found" unless user
-      user_id = user["id"]
+      user_id = find_user!(to)["id"]
     else
       user_id = to
     end
     send_message message, :to => user_id
   end
   
-  
-  ## EventMachine callbacks
-  
-  def connection_completed
-    send :type => "connect", :room => @room, :token => @token
-    EM.add_periodic_timer(20) { send :type => "ping" }
-  end
-  
   def leave
     send :type => "close"
     close
@@ -73,6 +68,14 @@ class Talker < EM::Connection
     close_connection_after_writing
   end
   
+  
+  ## EventMachine callbacks
+  
+  def connection_completed
+    send @connect_options.merge(:type => "connect")
+    EM.add_periodic_timer(20) { send :type => "ping" }
+  end
+  
   def post_init
     @parser = Yajl::Parser.new
     @parser.on_parse_complete = method(:event_parsed)
@@ -90,9 +93,12 @@ class Talker < EM::Connection
   
   private
     def event_parsed(event)
+      trigger :event, event
+      
       case event["type"]
       when "connected"
-        trigger :connected
+        @current_user = event["user"]
+        trigger :connected, event["user"]
       when "error"
         if @on_error
           @on_error.call(event["message"])
@@ -116,10 +122,15 @@ class Talker < EM::Connection
         trigger :back, event["user"]
       when "message"
         @users[event["user"]["id"]] ||= event["user"]
-        trigger :message, event["user"], event["content"], event
+        if event["private"]
+          trigger :private_message, event["user"], event["content"]
+        else
+          trigger :message, event["user"], event["content"]
+        end
       else
         raise Error, "unknown event type received from server: " + event["type"]
       end
+      
     rescue
       close
       raise
@@ -127,7 +138,7 @@ class Talker < EM::Connection
     
     def trigger(callback, *args)
       callback = instance_variable_get(:"@on_#{callback}")
-      callback.call(*args[0,callback.arity]) if callback
+      callback.call(*args) if callback
     end
     
     def send(data)

data/spec/talker_spec.rb

@@ -3,7 +3,8 @@ require File.dirname(__FILE__) + "/spec_helper"
 EM.describe Talker do
   it "should connect" do
     connect do |client|
-      client.on_connected do
+      client.on_connected do |user|
+        user["name"].should == TALKER_CONFIG["user_name"]
         done
       end
     end
@@ -47,13 +48,21 @@ EM.describe Talker do
       client.on_presence do
         client.send_private_message TALKER_CONFIG["user_name"], "private magic"
       end
-      client.on_message do |user, message|
+      client.on_private_message do |user, message|
         message.should == "private magic"
         done
       end
     end
   end
   
+  it "should receive events" do
+    connect do |client|
+      client.on_event do
+        done
+      end
+    end
+  end
+  
   # Keep at the end, mmmkay?
   it "should leave" do
     connect do |client|

data/talker.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
-  s.name            = %q{talker}
-  s.version         = "0.0.1"
+  s.name            = "talker"
+  s.version         = "0.0.2"
  
   s.authors         = ["Marc-Andre Cournoyer"]
   s.email           = "macournoyer@talkerapp.com"
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.homepage        = "http://github.com/macournoyer/talker.rb"
   s.require_paths   = ["lib"]
   s.bindir          = "bin"
-  s.executables     = ["talker-cat", "talker-shell"]
+  s.executables     = Dir["bin/*"].map { |f| File.basename(f) }
   s.summary         = "A real-time Talker Ruby client."
   s.test_files      = Dir["spec/**"]
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: talker
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Marc-Andre Cournoyer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-12 00:00:00 -05:00
+date: 2009-12-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,6 @@ files:
 - spec/talker.example.yml
 - spec/talker.yml
 - spec/talker_spec.rb
-- talker-0.0.1.gem
 - talker.gemspec
 has_rdoc: true
 homepage: http://github.com/macournoyer/talker.rb