smartfox 0.2.1 → 0.3.1

data/Rakefile

@@ -13,6 +13,8 @@ begin
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_dependency 'json'
     gem.add_dependency 'builder'
+    gem.add_dependency 'libxml-ruby'
+    gem.files.exclude 'nbproject/**'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -30,6 +32,7 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
+  spec.rcov_opts = ['--exclude', "features,kernel,load-diff-lcs\.rb,instance_exec\.rb,lib/spec.rb,lib/spec/runner.rb,^spec/*,bin/spec,examples,/gems,/Library/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
 end
 
 task :spec => :check_dependencies

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.1

data/lib/smartfox.rb

@@ -8,6 +8,9 @@ module SmartFox
   autoload :Socket, 'smartfox/socket'
   autoload :BlueBox, 'smartfox/blue_box'
   autoload :Packet, 'smartfox/packet'
+  autoload :Room, 'smartfox/room'
+  autoload :User, 'smartfox/user'
+  autoload :Message, 'smartfox/message'
   
   Logger = Logger.new(STDOUT)
 

data/lib/smartfox/client.rb

@@ -8,7 +8,7 @@ class SmartFox::Client
   class TransportTimeoutError < SmartFox::SmartFoxError; end
 
   attr_reader :connected, :room_list, :buddy_list, :server, :port
-  attr_reader :current_room
+  attr_reader :current_room, :users, :user_id
   alias_method :connected?, :connected
   
   CLIENT_VERSION = "1.5.8"
@@ -27,6 +27,8 @@ class SmartFox::Client
   ACTION_AUTO_JOIN = 'autoJoin'
   ACTION_UPDATE_ROOMS = 'getRmList'
   ACTION_ROOM_LIST = 'rmList'
+  ACTION_JOIN_OK = 'joinOK'
+  ACTION_JOIN_FAIL = 'joinKO'
 
   EXTENDED_RESPONSE = 'xtRes'
   
@@ -39,7 +41,8 @@ class SmartFox::Client
     @server = options[:server] || 'localhost'
     @port = options[:port]
     @events = {}
-    @rooms = []
+    @rooms = {}
+    @users = {}
   end
   
   def connect()
@@ -138,6 +141,14 @@ class SmartFox::Client
     end
   end
 
+  def parse_user(node)
+    if user = @users[node['i'].to_i]
+      user.parse(node)
+    else
+      @users[node['i'].to_i] = SmartFox::User.parse(node)
+    end
+  end
+
   private
   def send_packet(header, action, room_id = -1)
     xml = Builder::XmlMarkup.new()
@@ -181,18 +192,32 @@ class SmartFox::Client
   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}"
+      @username = packet.data.first['n']
+      @moderator = packet.data.first['mod'] != "0"
+      @user_id = packet.data.first['id'].to_i
+      SmartFox::Logger.info "SmartFox::Client logged in as #{@username} (ID:#{@user_id})"
       raise_event(:logged_in, self)
     when ACTION_ROOM_LIST
       @rooms.clear
-      packet.data.children.each do |room|
-        @rooms << SmartFox::Room.parse(room)
+      packet.data.first.children.each do |room|
+        room_object = SmartFox::Room.parse(self, room)
+        @rooms[room_object.id] = room_object
       end
 
       raise_event(:rooms_updated, self, @rooms)
+    when ACTION_JOIN_OK
+      @current_room = @rooms[packet.room]
+      SmartFox::Logger.info "SmartFox::Client joined room #{packet.room}"
+      SmartFox::Logger.debug "SmartFox::Client#handle_system_packet ACTION_JOIN_OK data => #{packet.data}"
+      @current_room.joined
+      @current_room.parse_users(packet.data.find{|n| n.name == 'uLs'})
+      raise_event(:room_joined, self, @current_room)
+    when ACTION_JOIN_FAIL
+      raise_event(:room_join_failed, self)
+    else
+      if packet.room > 0
+        @rooms[packet.room].handle_system_packet(packet)
+      end
     end
   end
 

data/lib/smartfox/message.rb

@@ -0,0 +1,7 @@
+class SmartFox::Message
+  attr_accessor :user, :message, :room
+
+  def initialize(user, message, room)
+    @user, @message, @room = user, message, room
+  end
+end

data/lib/smartfox/packet.rb

@@ -1,12 +1,13 @@
 require 'libxml'
 
 class SmartFox::Packet
-  attr_reader :action, :header, :room, :data
+  attr_reader :action, :header, :room, :data, :body
 
-  def initialize(header, action, room = 0, extra = nil)
+  def initialize(header, action, body, room = 0, extra = nil)
     @header = header
     @action = action
     @room = room.to_i
+    @body = body
     @data = (@header == SmartFox::Client::HEADER_EXTENDED ? SmartFox::Packet.parse_extended(extra) : extra)
   end
 
@@ -27,8 +28,8 @@ class SmartFox::Packet
     header = document.root['t']
     action = document.root.child['action']
     room = document.root.child['r']
-    extra = document.root.child.child
-    new(header, action, room, extra)
+    extra = document.root.child.children? ? document.root.child.children : nil
+    new(header, action, document.root.child, room, extra)
   end
 
   def self.parse_json(data)
@@ -41,7 +42,7 @@ class SmartFox::Packet
 
   def self.parse_extended(data)
     SmartFox::Logger.debug "SmartFox::Packet.parse_extended('#{data}')"
-    document = LibXML::XML::Parser.string(data.content).parse
+    document = LibXML::XML::Parser.string(data.first.content).parse
     parse_extended_object document.root
   end
 

data/lib/smartfox/room.rb

@@ -1,3 +1,115 @@
 class SmartFox::Room
+  attr_reader :id, :name, :private, :temporary, :game, :max_users, :users, :transcript
 
+  EVENTS = [ :message_sent, :message_received, :message_received_self, :message_received_other, :user_joined, :user_left, :user_count_updated ]
+  ACTION_PUBLISH_MESSAGE = 'pubMsg'
+  ACTION_USER_ENTER = 'uER'
+  ACTION_UPDATE_USER_COUNT = 'uCount'
+
+  def initialize(client, node)
+    @client = client
+    @id = node['id'].to_i
+    @name = node.first.content
+    @private = node['priv'] == '1'
+    @temporary = node['temp'] == '1'
+    @current_users = node['ucnt'].to_i
+    @max_users = node['maxu'].to_i
+    @game = node['game'] == '1'
+    @events = {}
+    @transcript = []
+
+    @users = nil
+    SmartFox::Logger.debug "SmartFox::Room.new -> #{inspect}"
+  end
+
+  def current_users
+    @users ? @users.length : @current_users
+  end
+
+  def self.parse(client, node)
+    new(client, node)
+  end
+
+  def inspect
+    "#<#{self.class.name}:#{object_id} id:#{@id} name:#{@name}#{' temporary' if @temporary}#{' private' if @private} current_users:#{@current_users} max_users:#{@max_users}>"
+  end
+
+  def join
+    @client.join_room self
+  end
+
+  def joined
+    @transcript.clear
+  end
+
+  def parse_users(users)
+    @users = {}
+
+    users.children.each do |child|
+      user = @client.parse_user(child)
+      @users[user.id] = user
+    end
+  end
+  
+  def send_message(message)
+    SmartFox::Logger.info "SmartFox::Room#send_message('#{message}')"
+    @client.send :send_packet, SmartFox::Client::HEADER_SYSTEM, ACTION_PUBLISH_MESSAGE, self.id do |packet|
+      packet.txt do |txt|
+        txt.cdata! message
+      end
+    end
+
+    @transcript << SmartFox::Message.new(@client.users[@client.user_id], message, self)
+
+    raise_event :message_sent, @client, self, message
+  end
+
+  def handle_system_packet(packet)
+    case packet.action
+    when ACTION_PUBLISH_MESSAGE
+      text = packet.data.find{|c| c.name == 'txt'}.child.content
+      user_id = packet.data.find{|c| c.name == 'user'}['id'].to_i
+      user = @client.users[user_id]
+      message = SmartFox::Message.new(user, text, self)
+      SmartFox::Logger.info "SmartFox::Room did receive message #{message.inspect}"
+      @transcript << message unless user.id == @client.user_id
+
+      SmartFox::Logger.info "SmartFox::Room#handle_system_packet ACTION_PUBLISH_MESSAGE #{user.id} == #{@client.user_id}"
+      if user.id == @client.user_id
+        SmartFox::Logger.debug "SmartFox::Room#handle_system_packet ACTION_PUBLISH_MESSAGE from self"
+        raise_event :message_received_self, @client, @room, message
+      else
+        SmartFox::Logger.debug "SmartFox::Room#handle_system_packet ACTION_PUBLISH_MESSAGE from #{user.name}"
+        raise_event :message_received_other, @client, @room, message
+      end
+      raise_event :message_received, @client, @room, message
+    when ACTION_USER_ENTER
+      packet.data.each do |u|
+        user = @client.parse_user(u)
+        @users[user.id] = user
+        raise_event :user_joined, @client, self, user
+      end
+    when ACTION_UPDATE_USER_COUNT
+      old_count = @current_users
+      @current_users = packet.body['u'].to_i
+      raise_event :user_count_updated, @client, self, { :old => old_count, :new => @current_users }
+    end
+  end
+
+  def add_handler(event, &proc)
+    @events[event.to_sym] = [] unless @events[event.to_sym]
+    @events[event.to_sym] << proc
+  end
+
+  private
+  def raise_event(event_name, *params)
+    event = @events[event_name.to_sym]
+    return unless event
+    event.each do |event_handler|
+      event_handler.call(*params)
+    end
+
+    # Pass the message upstream to the client as well
+    @client.send :raise_event, event_name, self, *params
+  end
 end

data/lib/smartfox/socket/connection.rb

@@ -34,10 +34,11 @@ class SmartFox::Socket::Connection
 
   def disconnect
     @disconnecting = true
+    @socket.close if @socket
     while @connected
       Thread.pass
     end
-    @socket.close if @socket
+    
   end
 
   def send_data(data)
@@ -52,7 +53,7 @@ class SmartFox::Socket::Connection
 
       buffer = String.new
       begin
-        @socket.read_nonblock(4096, buffer)
+        buffer = @socket.readpartial(4096)
         
         @buffer += buffer if buffer
       

data/lib/smartfox/user.rb

@@ -0,0 +1,14 @@
+class SmartFox::User
+  attr_accessor :id, :moderator, :name
+  
+  def parse(node)
+    @id = node['i'].to_i
+    @name = node.find_first('n').first.content
+    
+    self
+  end
+
+  def self.parse(node)
+    new.parse(node)
+  end
+end

data/smartfox.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{smartfox}
-  s.version = "0.2.1"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Richard Penwell"]
@@ -27,18 +27,12 @@ Gem::Specification.new do |s|
      "lib/smartfox/blue_box.rb",
      "lib/smartfox/blue_box/connection.rb",
      "lib/smartfox/client.rb",
+     "lib/smartfox/message.rb",
      "lib/smartfox/packet.rb",
      "lib/smartfox/room.rb",
      "lib/smartfox/socket.rb",
      "lib/smartfox/socket/connection.rb",
-     "nbproject/configs/Spec.properties",
-     "nbproject/private/config.properties",
-     "nbproject/private/configs/Spec.properties",
-     "nbproject/private/private.properties",
-     "nbproject/private/private.xml",
-     "nbproject/private/rake-d.txt",
-     "nbproject/project.properties",
-     "nbproject/project.xml",
+     "lib/smartfox/user.rb",
      "smartfox.gemspec",
      "spec/packet_spec.rb",
      "spec/smartfox_spec.rb",
@@ -66,15 +60,18 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<builder>, [">= 0"])
+      s.add_runtime_dependency(%q<libxml-ruby>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<builder>, [">= 0"])
+      s.add_dependency(%q<libxml-ruby>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<builder>, [">= 0"])
+    s.add_dependency(%q<libxml-ruby>, [">= 0"])
   end
 end
 

data/spec/smartfox_spec.rb

@@ -80,8 +80,68 @@ describe SmartFox::Client do
     @connection.refresh_rooms
     updated_waiter.wait
 
-    room_list.should_not be_blank
+    room_list.should_not be_empty
+  end
+
+  it "should join a room with auto join" do
+    login_to_connection
+    room_joined_waiter = Waiter.new
+    @connection.add_handler(:room_joined) { |client, room| room_joined_waiter.fire }
+    @connection.add_handler(:rooms_updated) { |client, rooms| @connection.auto_join }
+    @connection.refresh_rooms
+    room_joined_waiter.wait
+
+    @connection.current_room.current_users.should == 1
+  end
+
+  it "should see it's own messages sent from the room" do
+    login_to_connection
+    message_sent_waiter = Waiter.new
+    @connection.add_handler(:room_joined) do |client, room|
+      room.add_handler(:message_sent) { message_sent_waiter.fire }
+      room.send_message "Hello world"
+    end
+    @connection.add_handler(:rooms_updated) { |client, rooms| @connection.auto_join }
+    @connection.refresh_rooms
+    message_sent_waiter.wait
+
+    @connection.current_room.transcript.count.should == 1
+  end
+
+  it "should see it's own messages received from the room" do
+    login_to_connection
+    message_received_waiter = Waiter.new
+    @connection.add_handler(:room_joined) do |client, room|
+      room.add_handler(:message_received_self) { message_received_waiter.fire }
+      room.send_message "Hello world"
+    end
+    @connection.add_handler(:rooms_updated) { |client, rooms| @connection.auto_join }
+    @connection.refresh_rooms
+    message_received_waiter.wait
+
+    @connection.current_room.transcript.count.should == 1
+  end
+
+  it "should see others messages in the room, and play nicely if there are two instances" do
+    login_to_connection
+    message_received_waiter = Waiter.new
+    @connection.add_handler(:room_joined) do |client, room|
+      room.add_handler(:message_received_other) { message_received_waiter.fire }
+    end
+    @connection.add_handler(:rooms_updated) { |client, rooms| @connection.auto_join }
+    @connection.refresh_rooms
+
+    second_connection = SmartFox::Client.new()
+    second_connection.add_handler(:room_joined) do |client, room|
+      room.send_message "From two"
+    end
+    second_connection.add_handler(:connected) { |client| client.login('simpleChat', 'other') }
+    second_connection.add_handler(:logged_in) { |client| client.refresh_rooms }
+    second_connection.add_handler(:rooms_updated) {|client, rooms| client.auto_join }
+    second_connection.connect
+
+    message_received_waiter.wait
+
+    @connection.current_room.transcript.count.should == 1
   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: 21
+  hash: 17
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 1
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Richard Penwell
@@ -62,6 +62,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
 description: Provides a client library for the SmartFox realtime communication server, including BlueBox extensions.
 email: self@richardpenwell.me
 executables: []
@@ -82,18 +96,12 @@ files:
 - lib/smartfox/blue_box.rb
 - lib/smartfox/blue_box/connection.rb
 - lib/smartfox/client.rb
+- lib/smartfox/message.rb
 - lib/smartfox/packet.rb
 - lib/smartfox/room.rb
 - lib/smartfox/socket.rb
 - lib/smartfox/socket/connection.rb
-- nbproject/configs/Spec.properties
-- nbproject/private/config.properties
-- nbproject/private/configs/Spec.properties
-- nbproject/private/private.properties
-- nbproject/private/private.xml
-- nbproject/private/rake-d.txt
-- nbproject/project.properties
-- nbproject/project.xml
+- lib/smartfox/user.rb
 - smartfox.gemspec
 - spec/packet_spec.rb
 - spec/smartfox_spec.rb

data/nbproject/configs/Spec.properties

@@ -1 +0,0 @@
-main.file=spec/spec_helper.rb

data/nbproject/private/config.properties

@@ -1 +0,0 @@
-config=Spec

data/nbproject/private/configs/Spec.properties

@@ -1 +0,0 @@
-work.dir=/Users/penwellr/Development/smartfox

data/nbproject/private/private.properties

@@ -1,3 +0,0 @@
-file.reference.smartfox-lib=/Users/penwellr/Development/smartfox/lib
-file.reference.smartfox-spec=/Users/penwellr/Development/smartfox/spec
-platform.active=Ruby

data/nbproject/private/private.xml

@@ -1,4 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project-private xmlns="http://www.netbeans.org/ns/project-private/1">
-    <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1"/>
-</project-private>

data/nbproject/project.properties

@@ -1,8 +0,0 @@
-file.reference.smartfox-lib=lib
-file.reference.smartfox-spec=spec
-javac.classpath=
-main.file=smartfox.rb
-platform.active=Ruby
-source.encoding=UTF-8
-src.dir=${file.reference.smartfox-lib}
-test.src.dir=${file.reference.smartfox-spec}

data/nbproject/project.xml

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://www.netbeans.org/ns/project/1">
-    <type>org.netbeans.modules.ruby.rubyproject</type>
-    <configuration>
-        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
-            <name>smartfox</name>
-            <source-roots>
-                <root id="src.dir"/>
-            </source-roots>
-            <test-roots>
-                <root id="test.src.dir"/>
-            </test-roots>
-        </data>
-    </configuration>
-</project>