smartfox 0.0.0 → 0.1.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Richard Penwell
+Copyright (c) 2010 Richard Penwell
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -11,6 +11,8 @@ begin
     gem.homepage = "http://github.com/penwellr/smartfox"
     gem.authors = ["Richard Penwell"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency 'json'
+    gem.add_dependency 'builder'
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -43,3 +45,5 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+task :gem => :build

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/smartfox.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'logger'
+
+module SmartFox
+  class SmartFoxError < Exception; end
+  
+  autoload :Client, 'smartfox/client'
+  autoload :Socket, 'smartfox/socket'
+  autoload :BlueBox, 'smartfox/blue_box'
+  autoload :Packet, 'smartfox/packet'
+  
+  Logger = Logger.new(STDOUT)
+end

data/lib/smartfox/blue_box.rb

@@ -0,0 +1,3 @@
+module SmartFox::BlueBox
+  autoload :Connection, 'smartfox/blue_box/connection'
+end

data/lib/smartfox/blue_box/connection.rb

@@ -0,0 +1,2 @@
+class SmartFox::BlueBox::Connection
+end

data/lib/smartfox/client.rb

@@ -0,0 +1,97 @@
+require 'builder'
+require 'libxml'
+
+class SmartFox::Client
+  class ConnectionFailureError < SmartFox::SmartFoxError; end
+  class ApiIncompatibleError < SmartFox::SmartFoxError; end
+  class TransportTimeoutError < SmartFox::SmartFoxError; end
+
+  attr_reader :connected, :room_list, :buddy_list, :server, :port
+  alias_method :connected?, :connected
+  
+  CLIENT_VERSION = "1.5.8"
+  CONNECTION_TIMEOUT = 5
+  TRANSPORTS = [ SmartFox::Socket::Connection, SmartFox::BlueBox::Connection ]
+
+  HEADER_SYSTEM = 'sys'
+  ACTION_VERSION_CHECK = 'verChk'
+  ACTION_API_OK = 'apiOK'
+  ACTION_API_OBSOLETE = 'apiKO'
+  
+  def initialize(options = {})
+    @room_list = {}
+    @connected = false
+    @buddy_list = []
+    @user_id = options[:user_id]
+    @user_name = options[:user_name]
+    @server = options[:server] || 'localhost'
+    @port = options[:port]
+    @events = {}
+  end
+  
+  def connect()
+    unless @connected
+      TRANSPORTS.each do |transport_class|
+        begin
+          @transport = transport_class.new(self)
+          @transport.connect
+          if connected?
+            return @transport
+          end
+        rescue
+        end
+      end
+      raise ConnectionFailureError.new "Could not negotiate any transport with server."
+    end
+  end
+
+  def add_handler(event, &proc)
+    @events[event.to_sym] = [] unless @events[event.to_sym]
+    @events[event.to_sym] << proc
+  end
+
+  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
+  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|
+        yield body
+      end
+    end
+    packet = xml.target!
+    SmartFox::Logger.info "SmartFox::Client#send_packet -> #{packet}"
+    @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
+    event.each do |event_handler|
+      event_handler.call(*params)
+    end
+  end
+end

data/lib/smartfox/packet.rb

@@ -0,0 +1,41 @@
+require 'libxml'
+
+class SmartFox::Packet
+  attr_reader :action, :header, :room, :data
+
+  def initialize(header, action, room = 0, extra = nil)
+    @header = header
+    @action = action
+    @room = room
+    @extra = extra
+  end
+
+  def self.parse(data)
+    case data[0, 1]
+    when '<'
+      return parse_xml(data)
+    when '{'
+      return parse_json(data)
+    else
+      return parse_string(data)
+    end
+  end
+
+  def self.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']
+    room = document.root.child['r']
+    extra = document.root.child.child
+    new(header, action, room, extra)
+  end
+
+  def self.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}')"
+  end
+end

data/lib/smartfox/socket.rb

@@ -0,0 +1,3 @@
+module SmartFox::Socket
+  autoload :Connection, 'smartfox/socket/connection'
+end

data/lib/smartfox/socket/connection.rb

@@ -0,0 +1,71 @@
+require 'socket'
+
+class SmartFox::Socket::Connection
+  DEFAULT_PORT = 9339
+  attr_reader :connected
+  alias_method :connected?, :connected
+
+  def initialize(client)
+    @client = client
+    @connected = false
+    @event_thread = nil
+    @disconnecting = false
+    @buffer = String.new
+  end
+
+  def connect
+    begin
+      SmartFox::Logger.info "SmartFox::Socket::Connection#connect began"
+      @socket = TCPSocket.new(@client.server, @client.port || DEFAULT_PORT)
+      # SmartFox sockets will send a cross domain policy, receive this packet
+      #  before we do anything else or the connection will hang
+      @socket.readpartial(4096)
+      @connected = true
+      @event_thread = Thread.start(self) { |connection| connection.event_loop }
+      @client.connect_succeeded
+      
+    rescue => e
+      SmartFox::Logger.error "In SmartFox::Socket::Connection#connect:"
+      SmartFox::Logger.error "  #{e.inspect}"
+    end
+  end
+
+  def disconnect
+    @disconnecting = true
+    while @connected
+      sleep
+    end
+  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)
+
+      ticks += 1
+    end
+
+    @connected = false
+  end
+
+  def inspect
+    "#<#{self.class.name}:#{object_id} server:#{@client.server} port:#{@client.port || DEFAULT_PORT}>"
+  end
+end

data/nbproject/configs/Spec.properties

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

data/nbproject/private/config.properties

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

data/nbproject/private/configs/Spec.properties

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

data/nbproject/private/private.properties

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,4 @@
+<?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

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,15 @@
+<?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>

data/smartfox.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{smartfox}
+  s.version = "0.1.0"
+
+  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.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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/smartfox.rb",
+     "lib/smartfox/blue_box.rb",
+     "lib/smartfox/blue_box/connection.rb",
+     "lib/smartfox/client.rb",
+     "lib/smartfox/packet.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",
+     "smartfox.gemspec",
+     "spec/smartfox_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/penwellr/smartfox}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Client library for SmartFoxServer}
+  s.test_files = [
+    "spec/smartfox_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<builder>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<builder>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<builder>, [">= 0"])
+  end
+end
+

data/spec/smartfox_spec.rb

@@ -1,7 +1,29 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Smartfox" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  it "should create a connection" do
+    connection = SmartFox::Client.new(:server => 'localhost')
+    connection.connect
   end
+
+  it "should be connected after calling connect" do
+    connection = SmartFox::Client.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
+  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)
+  end
+  
+  it "should fall back on BlueBox if needed"
 end

data/spec/spec_helper.rb

@@ -4,6 +4,8 @@ require 'smartfox'
 require 'spec'
 require 'spec/autorun'
 
+SmartFox::Logger.level = Logger::DEBUG
+
 Spec::Runner.configure do |config|
   
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: smartfox
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Richard Penwell
@@ -34,6 +34,34 @@ dependencies:
         version: 1.2.9
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: Provides a client library for the SmartFox realtime communication server, including BlueBox extensions.
 email: self@richardpenwell.me
 executables: []
@@ -51,6 +79,21 @@ files:
 - Rakefile
 - VERSION
 - lib/smartfox.rb
+- lib/smartfox/blue_box.rb
+- lib/smartfox/blue_box/connection.rb
+- lib/smartfox/client.rb
+- lib/smartfox/packet.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
+- smartfox.gemspec
 - spec/smartfox_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb