smartfox 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/smartfox.rb

@@ -10,4 +10,13 @@ module SmartFox
   autoload :Packet, 'smartfox/packet'
   
   Logger = Logger.new(STDOUT)
+
+  class << Logger
+    def exception(exception)
+      error exception.message
+      exception.backtrace.each do |line|
+        error "  #{line}"
+      end
+    end
+  end
 end

data/lib/smartfox/client.rb

@@ -12,11 +12,14 @@ class SmartFox::Client
   CLIENT_VERSION = "1.5.8"
   CONNECTION_TIMEOUT = 5
   TRANSPORTS = [ SmartFox::Socket::Connection, SmartFox::BlueBox::Connection ]
+  EVENTS = [ :connected, :logged_in ]
 
   HEADER_SYSTEM = 'sys'
   ACTION_VERSION_CHECK = 'verChk'
   ACTION_API_OK = 'apiOK'
   ACTION_API_OBSOLETE = 'apiKO'
+  ACTION_LOGIN = 'login'
+  ACTION_LOGIN_OK = 'logOK'
   
   def initialize(options = {})
     @room_list = {}
@@ -33,11 +36,15 @@ class SmartFox::Client
     unless @connected
       TRANSPORTS.each do |transport_class|
         begin
+          started_at = Time.now
           @transport = transport_class.new(self)
           @transport.connect
-          if connected?
-            return @transport
+
+          while not connected? and Time.now <= started_at + CONNECTION_TIMEOUT
+            Thread.pass
           end
+
+          return @transport if connected?
         rescue
         end
       end
@@ -45,6 +52,13 @@ class SmartFox::Client
     end
   end
 
+  def disconnect
+    if @connected
+      @transport.disconnect
+      @connected = false
+    end
+  end
+
   def add_handler(event, &proc)
     @events[event.to_sym] = [] unless @events[event.to_sym]
     @events[event.to_sym] << proc
@@ -52,22 +66,43 @@ class SmartFox::Client
 
   def connect_succeeded
     send_packet(HEADER_SYSTEM, ACTION_VERSION_CHECK) { |x| x.ver(:v => CLIENT_VERSION.delete('.')) }
-    connect_response = wait_for_packet(CONNECTION_TIMEOUT)
-    if connect_response.header == HEADER_SYSTEM and connect_response.action == ACTION_API_OK
-      @connected = true
-      SmartFox::Logger.info "SmartFox::Client successfully connected with transport #{@transport.inspect}"
-      raise_event :connected, self
-    else
-      raise ApiIncompatibleError if connect_response.action == ACTION_API_OBSOLETE
-      raise ConnectionFailureError.new "Did not recieve an expected response from the server."
+  end
+
+  def packet_recieved(data)
+    begin
+      SmartFox::Logger.debug "SmartFox::Client#packet_recieved('#{data}')"
+      packet = SmartFox::Packet.parse(data)
+      case packet.header
+      when HEADER_SYSTEM
+        if @connected
+          handle_system_packet(packet)
+        else
+          complete_login(packet)
+        end
+      when HEADER_EXTENSION
+
+      end
+    rescue => e
+      SmartFox::Logger.error "In SmartFox::Client#packet_received"
+      SmartFox::Logger.exception e
     end
   end
 
+  def login(zone, username, password = nil)
+    send_packet(HEADER_SYSTEM, ACTION_LOGIN) do |packet|
+      packet.login(:z => zone) do |login|
+        login.nick { |nick| nick.cdata! username }
+        login.pword { |pword| pword.cdata! password || '' }
+      end
+    end
+    Thread.pass
+  end
+
   private
   def send_packet(header, action, room_id = 0)
     xml = Builder::XmlMarkup.new()
     xml.msg(:t => header) do |msg|
-      msg.body(:action => action, :r => room_id) do |body|
+      msg.body(:r => room_id, :action => action) do |body|
         yield body
       end
     end
@@ -76,17 +111,6 @@ class SmartFox::Client
     @transport.send_data(packet + "\0")
   end
 
-  def wait_for_packet(timeout)
-    begin_at = Time.now
-    while Time.now <= (begin_at + timeout)
-      if @transport.data_available?
-        return SmartFox::Packet.parse(@transport.read_packet)
-      end
-    end
-
-    raise TransportTimeoutError
-  end
-
   def raise_event(event_name, *params)
     event = @events[event_name.to_sym]
     return unless event
@@ -94,4 +118,26 @@ class SmartFox::Client
       event_handler.call(*params)
     end
   end
+
+  def complete_login(connect_response)
+    if connect_response.header == HEADER_SYSTEM and connect_response.action == ACTION_API_OK
+      @connected = true
+      SmartFox::Logger.info "SmartFox::Client successfully connected with transport #{@transport.inspect}"
+      raise_event :connected, self
+    else
+      raise ApiIncompatibleError if connect_response.action == ACTION_API_OBSOLETE
+      raise ConnectionFailureError.new "Did not recieve an expected response from the server."
+    end
+  end
+
+  def handle_system_packet(packet)
+    case packet.action
+    when ACTION_LOGIN_OK
+      @username = packet.data['n']
+      @moderator = packet.data['mod'] != "0"
+      @id = packet.data['id']
+      SmartFox::Logger.info "SmartFox::Client logged in as #{@username}"
+      raise_event(:logged_in, self)
+    end
+  end
 end

data/lib/smartfox/packet.rb

@@ -7,7 +7,7 @@ class SmartFox::Packet
     @header = header
     @action = action
     @room = room
-    @extra = extra
+    @data = extra
   end
 
   def self.parse(data)

data/lib/smartfox/socket/connection.rb

@@ -11,6 +11,7 @@ class SmartFox::Socket::Connection
     @event_thread = nil
     @disconnecting = false
     @buffer = String.new
+    @packets = []
   end
 
   def connect
@@ -26,39 +27,38 @@ class SmartFox::Socket::Connection
       
     rescue => e
       SmartFox::Logger.error "In SmartFox::Socket::Connection#connect:"
-      SmartFox::Logger.error "  #{e.inspect}"
+      SmartFox::Logger.exception e
+      raise e
     end
   end
 
   def disconnect
     @disconnecting = true
     while @connected
-      sleep
+      Thread.pass
     end
+    @socket.close if @socket
   end
 
   def send_data(data)
     @socket.write(data)
   end
 
-  def data_available?
-    not @buffer.empty?
-  end
-
-  def read_packet
-    packet = @buffer
-    @buffer = ""
-    return packet
-  end
-
   def event_loop
     SmartFox::Logger.info "SmartFox::Socket::Connection#event_loop began"
     ticks = 0
     until @disconnecting
       SmartFox::Logger.debug "SmartFox::Socket::Connection#event_loop tick #{ticks}"
 
-      @buffer << @socket.readpartial(4096)
+      @buffer += @socket.readpartial(4096)
+      
+      while index = @buffer.index("\0")
+        @packets << @buffer.slice!(0..index)
+      end
 
+      @packets.each { |packet| @client.packet_recieved(packet) }
+      @packets.clear
+      
       ticks += 1
     end
 

data/smartfox.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{smartfox}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Penwell"]
@@ -41,7 +41,8 @@ Gem::Specification.new do |s|
      "smartfox.gemspec",
      "spec/smartfox_spec.rb",
      "spec/spec.opts",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/waiter.rb"
   ]
   s.homepage = %q{http://github.com/penwellr/smartfox}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -50,7 +51,8 @@ Gem::Specification.new do |s|
   s.summary = %q{Client library for SmartFoxServer}
   s.test_files = [
     "spec/smartfox_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/waiter.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/smartfox_spec.rb

@@ -1,28 +1,44 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "Smartfox" do
+describe SmartFox::Client do
+  before(:each) do
+    @connection = SmartFox::Client.new()
+  end
+
+  after(:each) do
+    @connection.disconnect if @connection
+  end
+
   it "should create a connection" do
-    connection = SmartFox::Client.new(:server => 'localhost')
-    connection.connect
+    login_waiter = Waiter.new
+    @connection.connect
   end
 
   it "should be connected after calling connect" do
-    connection = SmartFox::Client.new()
-    connection.connect
-    connection.connected?.should be_true
+    login_waiter = Waiter.new
+    @connection.connect
+    @connection.connected?.should be_true
   end
 
   it "should raise the 'connected' event after connecting" do
-    connected = false
-    connection = SmartFox::Client.new()
-    connection.add_handler(:connected) { |connection| connected = true}
-    connection.connect
-    connected.should be_true
+    connected_waiter = Waiter.new
+    @connection.add_handler(:connected) { |connection| puts "connected_waiter fired"; connected_waiter.fire }
+    @connection.connect
+    connected_waiter.wait
   end
 
   it "should fail when attempting to connect to a non-existant server" do
-    connection = SmartFox::Client.new(:server => '10.2.3.4')
-    lambda { connection.connect }.should raise_error(SmartFox::Client::ConnectionFailureError)
+    TCPSocket.should_receive(:new).once.with('localhost', 9339).and_raise(Errno::ETIMEDOUT)
+    lambda { @connection.connect }.should raise_error(SmartFox::Client::ConnectionFailureError)
+  end
+
+  it "should login to the default install" do
+    login_waiter = Waiter.new
+    @connection.add_handler(:connected) { |connection| connection.login 'simpleChat', 'penwellr' }
+    @connection.add_handler(:logged_in) { login_waiter.fire }
+    @connection.connect
+
+    login_waiter.wait(10)
   end
   
   it "should fall back on BlueBox if needed"

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@ require 'smartfox'
 require 'spec'
 require 'spec/autorun'
 
+require File.join(File.dirname(__FILE__), 'waiter')
+
 SmartFox::Logger.level = Logger::DEBUG
 
 Spec::Runner.configure do |config|

data/spec/waiter.rb

@@ -0,0 +1,25 @@
+class Waiter
+  class TimeoutError < Exception; end
+
+  def initialize
+    @fired = false
+  end
+
+  def fire
+    @fired = true
+    Thread.pass
+  end
+
+  def wait(timeout = 5)
+    started_at = Time.now
+    while Time.now <= started_at + timeout
+      if @fired
+        return
+      else
+        Thread.pass
+      end
+    end
+
+    raise TimeoutError
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: smartfox
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Richard Penwell
@@ -97,6 +97,7 @@ files:
 - spec/smartfox_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/waiter.rb
 has_rdoc: true
 homepage: http://github.com/penwellr/smartfox
 licenses: []
@@ -134,3 +135,4 @@ summary: Client library for SmartFoxServer
 test_files: 
 - spec/smartfox_spec.rb
 - spec/spec_helper.rb
+- spec/waiter.rb