smartfox 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/smartfox/client.rb

@@ -1,5 +1,6 @@
 require 'builder'
 require 'libxml'
+require 'json'
 
 class SmartFox::Client
   class ConnectionFailureError < SmartFox::SmartFoxError; end
@@ -7,19 +8,27 @@ class SmartFox::Client
   class TransportTimeoutError < SmartFox::SmartFoxError; end
 
   attr_reader :connected, :room_list, :buddy_list, :server, :port
+  attr_reader :current_room
   alias_method :connected?, :connected
   
   CLIENT_VERSION = "1.5.8"
   CONNECTION_TIMEOUT = 5
   TRANSPORTS = [ SmartFox::Socket::Connection, SmartFox::BlueBox::Connection ]
-  EVENTS = [ :connected, :logged_in ]
+  EVENTS = [ :connected, :logged_in, :rooms_updated ]
 
   HEADER_SYSTEM = 'sys'
+  HEADER_EXTENDED = 'xt'
+  
   ACTION_VERSION_CHECK = 'verChk'
   ACTION_API_OK = 'apiOK'
   ACTION_API_OBSOLETE = 'apiKO'
   ACTION_LOGIN = 'login'
   ACTION_LOGIN_OK = 'logOK'
+  ACTION_AUTO_JOIN = 'autoJoin'
+  ACTION_UPDATE_ROOMS = 'getRmList'
+  ACTION_ROOM_LIST = 'rmList'
+
+  EXTENDED_RESPONSE = 'xtRes'
   
   def initialize(options = {})
     @room_list = {}
@@ -30,6 +39,7 @@ class SmartFox::Client
     @server = options[:server] || 'localhost'
     @port = options[:port]
     @events = {}
+    @rooms = []
   end
   
   def connect()
@@ -59,13 +69,30 @@ class SmartFox::Client
     end
   end
 
+  def extended_command(action, data = nil, room = -1, options = {})
+    options[:format] ||= :xml
+
+    case options[:format]
+    when :xml
+      send_packet(HEADER_EXTENDED, action, room) { |x| x.cdata!(data || '') }
+    end
+  end
+
   def add_handler(event, &proc)
     @events[event.to_sym] = [] unless @events[event.to_sym]
     @events[event.to_sym] << proc
   end
 
+  def refresh_rooms
+    send_packet(HEADER_SYSTEM, ACTION_UPDATE_ROOMS)
+  end
+
   def connect_succeeded
-    send_packet(HEADER_SYSTEM, ACTION_VERSION_CHECK) { |x| x.ver(:v => CLIENT_VERSION.delete('.')) }
+    send_packet(HEADER_SYSTEM, ACTION_VERSION_CHECK, 0) { |x| x.ver(:v => CLIENT_VERSION.delete('.')) }
+  end
+
+  def auto_join
+    send_packet(HEADER_SYSTEM, ACTION_AUTO_JOIN)
   end
 
   def packet_recieved(data)
@@ -80,7 +107,7 @@ class SmartFox::Client
           complete_login(packet)
         end
       when HEADER_EXTENSION
-
+        raise_event :extended_response, self, packet.data
       end
     rescue => e
       SmartFox::Logger.error "In SmartFox::Client#packet_received"
@@ -98,19 +125,40 @@ class SmartFox::Client
     Thread.pass
   end
 
+  def send_extended(extension, action, options)
+    options[:format] ||= :xml
+    options[:room] ||= (current_room ? current_room.id : 0)
+    options[:parameters] ||= {}
+
+    case options[:format]
+    when :xml
+
+    when :json
+      send_extended_json_packet(extension, action, options[:room], options[:parameters])
+    end
+  end
+
   private
-  def send_packet(header, action, room_id = 0)
+  def send_packet(header, action, room_id = -1)
     xml = Builder::XmlMarkup.new()
     xml.msg(:t => header) do |msg|
       msg.body(:r => room_id, :action => action) do |body|
-        yield body
+        if block_given?
+          yield body
+        end
       end
     end
     packet = xml.target!
-    SmartFox::Logger.info "SmartFox::Client#send_packet -> #{packet}"
+    SmartFox::Logger.debug "SmartFox::Client#send_packet -> #{packet}"
     @transport.send_data(packet + "\0")
   end
 
+  def send_extended_json_packet(name, action, room, object)
+    packet = { :t => 'xt', :b => { :x => name, :c => action, :r => room, :p => object } }
+    SmartFox::Logger.debug "SmartFox::Client#send_extended_json_packet -> #{packet.to_json}"
+    @transport.send_data(packet.to_json + "\0")
+  end
+
   def raise_event(event_name, *params)
     event = @events[event_name.to_sym]
     return unless event
@@ -138,6 +186,15 @@ class SmartFox::Client
       @id = packet.data['id']
       SmartFox::Logger.info "SmartFox::Client logged in as #{@username}"
       raise_event(:logged_in, self)
+    when ACTION_ROOM_LIST
+      @rooms.clear
+      packet.data.children.each do |room|
+        @rooms << SmartFox::Room.parse(room)
+      end
+
+      raise_event(:rooms_updated, self, @rooms)
     end
   end
+
+
 end

data/lib/smartfox/packet.rb

@@ -6,8 +6,8 @@ class SmartFox::Packet
   def initialize(header, action, room = 0, extra = nil)
     @header = header
     @action = action
-    @room = room
-    @data = extra
+    @room = room.to_i
+    @data = (@header == SmartFox::Client::HEADER_EXTENDED ? SmartFox::Packet.parse_extended(extra) : extra)
   end
 
   def self.parse(data)
@@ -22,7 +22,7 @@ class SmartFox::Packet
   end
 
   def self.parse_xml(data)
-    SmartFox::Logger.debug "SmartFox::Packet#parse_xml('#{data}')"
+    SmartFox::Logger.debug "SmartFox::Packet.parse_xml('#{data}')"
     document = LibXML::XML::Parser.string(data).parse
     header = document.root['t']
     action = document.root.child['action']
@@ -32,10 +32,42 @@ class SmartFox::Packet
   end
 
   def self.parse_json(data)
-    SmartFox::Logger.debug "SmartFox::Packet#parse_json('#{data}')"
+    SmartFox::Logger.debug "SmartFox::Packet.parse_json('#{data}')"
   end
 
   def self.parse_string(data)
-    SmartFox::Logger.debug "SmartFox::Packet#parse_string('#{data}')"
+    SmartFox::Logger.debug "SmartFox::Packet.parse_string('#{data}')"
+  end
+
+  def self.parse_extended(data)
+    SmartFox::Logger.debug "SmartFox::Packet.parse_extended('#{data}')"
+    document = LibXML::XML::Parser.string(data.content).parse
+    parse_extended_object document.root
+  end
+
+  def self.parse_extended_scaler(node)
+    case node['t']
+    when 'n'
+      node.content.to_i
+    when 's'
+      node.content
+    when 'b'
+      node.content == "1"
+    end
+  end
+
+  def self.parse_extended_object(node)
+    result = {}
+
+    node.children.each do |child|
+      case child.name
+      when 'var'
+        result[child["n"].to_sym] = parse_extended_scaler(child)
+      when 'obj'
+        result[child["o"].to_sym] = parse_extended_object(child)
+      end
+    end
+
+    result
   end
 end

data/lib/smartfox/room.rb

@@ -0,0 +1,3 @@
+class SmartFox::Room
+
+end

data/lib/smartfox/socket/connection.rb

@@ -50,14 +50,21 @@ class SmartFox::Socket::Connection
     until @disconnecting
       SmartFox::Logger.debug "SmartFox::Socket::Connection#event_loop tick #{ticks}"
 
-      @buffer += @socket.readpartial(4096)
+      buffer = String.new
+      begin
+        @socket.read_nonblock(4096, buffer)
+        
+        @buffer += buffer if buffer
       
-      while index = @buffer.index("\0")
-        @packets << @buffer.slice!(0..index)
-      end
+        while index = @buffer.index("\0")
+          @packets << @buffer.slice!(0..index)
+        end
 
-      @packets.each { |packet| @client.packet_recieved(packet) }
-      @packets.clear
+        @packets.each { |packet| @client.packet_recieved(packet) }
+        @packets.clear
+      rescue => e
+        Thread.pass
+      end
       
       ticks += 1
     end

data/smartfox.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{smartfox}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Penwell"]
-  s.date = %q{2010-06-07}
+  s.date = %q{2010-06-08}
   s.description = %q{Provides a client library for the SmartFox realtime communication server, including BlueBox extensions.}
   s.email = %q{self@richardpenwell.me}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "lib/smartfox/blue_box/connection.rb",
      "lib/smartfox/client.rb",
      "lib/smartfox/packet.rb",
+     "lib/smartfox/room.rb",
      "lib/smartfox/socket.rb",
      "lib/smartfox/socket/connection.rb",
      "nbproject/configs/Spec.properties",
@@ -39,6 +40,7 @@ Gem::Specification.new do |s|
      "nbproject/project.properties",
      "nbproject/project.xml",
      "smartfox.gemspec",
+     "spec/packet_spec.rb",
      "spec/smartfox_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
@@ -50,7 +52,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Client library for SmartFoxServer}
   s.test_files = [
-    "spec/smartfox_spec.rb",
+    "spec/packet_spec.rb",
+     "spec/smartfox_spec.rb",
      "spec/spec_helper.rb",
      "spec/waiter.rb"
   ]

data/spec/packet_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe SmartFox::Packet do
+  it "should parse system packets" do
+    SYSTEM_PACKET = "<msg t='sys'><body action='apiOK' r='0'></body></msg>\0"
+
+    packet = SmartFox::Packet.parse(SYSTEM_PACKET)
+
+    packet.header.should == SmartFox::Client::HEADER_SYSTEM
+    packet.action.should == SmartFox::Client::ACTION_API_OK
+    packet.room.should == 0
+    packet.data.should be_nil
+  end
+
+  it "should parse extended packets" do
+    EXTENDED_PACKET = "<msg t='xt'><body action='xtRes' r='-1'><![CDATA[<dataObj><var n='uid' t='n'>481942</var><var n='_cmd' t='s'>logOK</var><obj o='ent' t='a'><var n='chat_priv' t='s'>1</var><var n='init_block' t='s'>1</var><var n='chat_join_rooms' t='s'>10</var><var n='chat_occupancy' t='s'>200</var><var n='init_chat' t='s'>1</var><var n='chat_admin' t='s'>0</var></obj></dataObj>]]></body></msg>\0"
+    
+    packet = SmartFox::Packet.parse(EXTENDED_PACKET)
+    
+    packet.header.should == SmartFox::Client::HEADER_EXTENDED
+    packet.action.should == SmartFox::Client::EXTENDED_RESPONSE
+    packet.room.should == -1
+    packet.data.should == { :uid => 481942, :_cmd => 'logOK', :ent => { :chat_priv => "1", :init_block => "1", :chat_join_rooms => "10", :chat_occupancy => "200", :init_chat => "1", :chat_admin => "0" } }
+
+  end
+end

data/spec/smartfox_spec.rb

@@ -1,6 +1,27 @@
+require 'json'
+
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe SmartFox::Client do
+  def transport
+    @connection.instance_variable_get(:@transport)
+  end
+
+  def expect_send_data
+    transport.should_receive(:send_data) do |data|
+      yield data
+    end
+  end
+
+  def login_to_connection
+    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
+
   before(:each) do
     @connection = SmartFox::Client.new()
   end
@@ -40,6 +61,27 @@ describe SmartFox::Client do
 
     login_waiter.wait(10)
   end
+
+  it "should properly serialize extended json packets" do
+    @connection.connect
+    expect_send_data do |data|
+      object = JSON.parse(data.chop)
+      object.should == { "t" => 'xt', "b" => { "x" => 'ManChatXT', "c" => 'grlbk', "r" => 6, "p" => {} } }
+    end
+
+    @connection.send_extended('ManChatXT', 'grlbk', :room => 6, :format => :json)
+  end
+
+  it "should retrieve the room list asyncronously" do
+    login_to_connection
+    updated_waiter = Waiter.new
+    room_list = nil
+    @connection.add_handler(:rooms_updated) { |client, rooms| room_list = rooms; updated_waiter.fire }
+    @connection.refresh_rooms
+    updated_waiter.wait
+
+    room_list.should_not be_blank
+  end
   
   it "should fall back on BlueBox if needed"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: smartfox
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Richard Penwell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-07 00:00:00 -04:00
+date: 2010-06-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -83,6 +83,7 @@ files:
 - lib/smartfox/blue_box/connection.rb
 - lib/smartfox/client.rb
 - lib/smartfox/packet.rb
+- lib/smartfox/room.rb
 - lib/smartfox/socket.rb
 - lib/smartfox/socket/connection.rb
 - nbproject/configs/Spec.properties
@@ -94,6 +95,7 @@ files:
 - nbproject/project.properties
 - nbproject/project.xml
 - smartfox.gemspec
+- spec/packet_spec.rb
 - spec/smartfox_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -133,6 +135,7 @@ signing_key:
 specification_version: 3
 summary: Client library for SmartFoxServer
 test_files: 
+- spec/packet_spec.rb
 - spec/smartfox_spec.rb
 - spec/spec_helper.rb
 - spec/waiter.rb