journeta 0.0.5 → 0.1.0

data/History.txt

@@ -1,3 +1,11 @@
+== 0.1.0 2008-09-05
+
+* Renamed Journeta::JournetaEngine to Journeta::Engine
+* Added Engine.known_peers
+* Peer handler interface changed from 'handle(event)' to 'call(event)' to support raw Proc objects.
+* examples/network_status.rb
+* Documentation updates.
+
 == 0.0.5 2008-08-22
 
 * Documentation updates.

data/Manifest.txt

@@ -6,6 +6,7 @@ Rakefile
 lib/journeta.rb
 examples/instant_messenger.rb
 examples/instant_messenger_gui.rb
+examples/network_status.rb
 examples/queue_client.rb
 examples/queue_server.rb
 lib/journeta/logger.rb

data/README.txt

@@ -39,7 +39,12 @@ For insight into events internal to the library, start ruby with the `--debug` o
 	sent from the server(s). All nodes automatically find eachother. Try running multiples clients,
 	and then multiple servers. Notice that when you have N servers, each job gets run N times,
 	and not necessarilly by the same client!
-	
+
+ examples/network_status.rb
+
+	Monitors the presence of all peers on the network.
+
+		
 == Author
 
 Preston Lee <preston.lee at openrain d0t com>

data/examples/instant_messenger.rb

@@ -11,7 +11,7 @@ include Journeta::Common
 # A message handler will be called by the engine every time a message is received.
 # This code will be customized for your application-specific needs.
 class ExampleHandler < Journeta::DefaultPeerHandler
-  def handle(message)
+  def call(message)
     if message.class == BasicMessage
       puts "#{message.name.chop}: #{message.text}"
     else
@@ -28,13 +28,13 @@ end
 #
 # You'll need to find an unused port if..
 # (1) you intend to run multiple peers on the same machine, or
-# (2) the default port (Journeta::JournetaEngine::DEFAULT_PEER_PORT)
+# (2) the default port (Journeta::Engine::DEFAULT_PEER_PORT)
 #     is otherwise already taken on your machine.
 #
 # :peer_handler -- A piece of logic you must specify to process objects sent to you from peers.
 # :groups -- Defines the peer types which care about the objects you broadcast. (Optional: by default, all peers will receive all your object broadcasts.)
 peer_port = (2048 + rand( 2 ** 8))
-journeta = Journeta::JournetaEngine.new(:peer_port => peer_port, :peer_handler => ExampleHandler.new, :groups => ['im_example'])
+journeta = Journeta::Engine.new(:peer_port => peer_port, :peer_handler => ExampleHandler.new, :groups => ['im_example'])
 
 
 # Let the magic begin!
@@ -45,7 +45,7 @@ journeta.start
 include Journeta::Common::Shutdown
 stop_on_shutdown(journeta)
 
-# Alternatively, you can stop the engine manually by calling +JournetaEngine#stop+.
+# Alternatively, you can stop the engine manually by calling +Engine#stop+.
 # Do this before exiting to broadcast a message stating you are going offline as a courtesy to your peers, like so..
 # @journeta.stop
 

data/examples/instant_messenger_gui.rb

@@ -27,7 +27,7 @@ class JournetaGUIHandler
     @control = control
   end
   
-  def handle(message)
+  def call(message)
     if message.class == BasicMessage
       text = @control.get_value
       text.chop!
@@ -106,7 +106,7 @@ class IConvFrame < Wx::Frame
     panel.set_sizer_and_fit( sizer )
     
     peer_port = (2048 + rand( 2 ** 8))
-    @journeta = Journeta::JournetaEngine.new(:peer_port => peer_port, :peer_handler => JournetaGUIHandler.new(@peer_control), :groups => ['im_example'])    
+    @journeta = Journeta::Engine.new(:peer_port => peer_port, :peer_handler => JournetaGUIHandler.new(@peer_control), :groups => ['im_example'])    
     @journeta.start
   end
   

data/examples/network_status.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+current_dir = File.dirname(File.expand_path(__FILE__))
+lib_path = File.join(current_dir, '..', 'lib')
+$LOAD_PATH.unshift lib_path
+
+require 'journeta'
+include Journeta
+include Journeta::Common
+include Journeta::Common::Shutdown
+
+clear = %x{clear} # HACK
+
+peer_port = (2048 + rand( 2 ** 8))
+@journeta = Journeta::Engine.new(:peer_port => peer_port)
+@journeta.start
+stop_on_shutdown(@journeta)
+
+
+begin
+  all = @journeta.known_peers    
+  puts clear
+  puts __FILE__
+  puts "Displays infromation on all known peers."
+  puts "Updated: #{Time.now}"
+  puts "\n"
+  puts "UUID\t\tVersion\t\tIP Address\t\tPort\t\tDiscovered\t\tUpdated\t\tGroups\n"
+  all.keys.sort.each do |uuid|
+    puts "#{all[uuid].uuid}\t#{all[uuid].version}\t\t#{all[uuid].ip_address}\t\t#{all[uuid].peer_port}\t\t#{all[uuid].created_at || 'TODO'}\t\t#{all[uuid].updated_at || 'TODO'}\t[#{all[uuid].groups.join(',')}]"
+  end
+  sleep(0.2)
+end     while true

data/examples/queue_client.rb

@@ -9,7 +9,7 @@ include Journeta::Common
 include Journeta::Common::Shutdown
 
 class JobProcessor
-  def handle(msg)
+  def call(msg)
     if msg.class == Job && !msg.submission
       puts "Processing job ##{msg.name} from peer ##{msg.owner}."
     end
@@ -17,7 +17,7 @@ class JobProcessor
 end
 
 peer_port = (2048 + rand( 2 ** 8))
-journeta = Journeta::JournetaEngine.new(:peer_port => peer_port, :peer_handler => JobProcessor.new, :groups => ['queue_example'])
+journeta = Journeta::Engine.new(:peer_port => peer_port, :peer_handler => JobProcessor.new, :groups => ['queue_example'])
 stop_on_shutdown(journeta)
 journeta.start
 

data/examples/queue_server.rb

@@ -15,17 +15,19 @@ class JobQueuer
   def initialize(queue)
     @queue = queue
   end
-  def handle(msg)
+  def call(msg)
     if msg.class == Job && msg.submission
       puts "Enqueing job '##{msg.name}' from peer ##{msg.owner}."
       msg.submission = false
       @queue.push msg
+    else
+      puts "Unsupported junk received. Ignoring."
     end
   end
 end
 
 peer_port = (2048 + rand( 2 ** 8))
-journeta = Journeta::JournetaEngine.new(:peer_port => peer_port, :peer_handler => JobQueuer.new(@queue), :groups => ['queue_example'])
+journeta = Journeta::Engine.new(:peer_port => peer_port, :peer_handler => JobQueuer.new(@queue), :groups => ['queue_example'])
 stop_on_shutdown(journeta)
 journeta.start
 

data/lib/journeta/asynchronous.rb

@@ -1,10 +1,14 @@
-# Copyright 2007, OpenRain, LLC. All rights reserved.
+# Copyright © 2007 OpenRain, LLC. All rights reserved.
+#
+# Preston Lee <preston.lee@openrain.com>
 
 
 require 'journeta/logger'
 
+
 module Journeta
   
+  # See Journeta::Engine
   class Asynchronous
     
     include Logger

data/lib/journeta/common/dummy_peer_handler.rb

@@ -3,7 +3,7 @@ module Journeta
   module Common
     
     class DummyPeerHandler
-      def handle(message)
+      def call(message)
         # Intentionally ingore all messages.
       end
     end

data/lib/journeta/journeta_engine.rb

@@ -2,11 +2,17 @@
 #
 # Preston Lee <preston.lee@openrain.com>
 
-
+# The root namespace for the entire #Journeta library.
+# See..
+#  * Journeta::Engine
+#  * http://journeta.rubyforge.org
 module Journeta
   
-  # The primary fascade of the entire +Journeta+ library, which composite a number of objects that may or may not have code running asynchronously to the primary application +Thread+.
-  class JournetaEngine
+  # The primary fascade of the entire +Journeta+ library, which composite a number of
+  # objects running asynchronously to the primary application +Thread+. Use of this fascade
+  # requires a minimal amount of lifecycle management on your part to start and stop the
+  # engine at appropriate times. (Usually only at application startup and shutdown, respectively.)
+  class Engine
     
     include Logger
     
@@ -52,55 +58,58 @@ module Journeta
     
     
     # Incoming direct peer TCP connections will use this port.
-    @@DEFAULT_PEER_PORT = 31338
-    
-    # The application message callback handler.
-    @@DEFAULT_PEER_HANDLER = DefaultPeerHandler.new
+    DEFAULT_PEER_PORT = 31338
     
-    @@DEFAULT_PRESENCE_PORT = 31337
+    # On UDP port on which we send/receive peer presence messages.
+    DEFAULT_PRESENCE_PORT = 31337
     
     # Addresses 224.0.0.0 through 239.255.255.255 are reserved for multicast messages.
-    @@DEFAULT_PRESENCE_NETWORK = '224.220.221.222'
+    DEFAULT_PRESENCE_NETWORK = '224.220.221.222'
     
     # The wait time, in seconds, between rebroadcasts of peer presence.
-    @@DEFAULT_PRESENCE_PERIOD = 4
+    DEFAULT_PRESENCE_PERIOD = 4
     
     
-    def initialize(configuration ={})
-      putsd "CON: #{configuration}"
-      
+    # Nothing magical. Just creation of internal components and configuration setup.
+    def initialize(configuration ={})      
       # TODO make guaranteed to be unique.
       @uuid = configuration[:uuid] || rand(2 ** 31)
       @groups = configuration[:groups]
+
       
+      @peer_port = configuration[:peer_port] || DEFAULT_PEER_PORT
+      @peer_handler = configuration[:peer_handler] || DefaultPeerHandler.new
+
+      @presence_port = configuration[:presence_port] || DEFAULT_PRESENCE_PORT    
+      @presence_address = configuration[:presence_address] || DEFAULT_PRESENCE_NETWORK      
+      @presence_period = configuration[:presence_period] || DEFAULT_PRESENCE_PERIOD
       
-      @peer_port = configuration[:peer_port] || @@DEFAULT_PEER_PORT
-      @peer_handler = configuration[:peer_handler] || @@DEFAULT_PEER_HANDLER
-      @peer_listener = Journeta::PeerListener.new self
-      
-      @presence_port = configuration[:presence_port] || @@DEFAULT_PRESENCE_PORT    
-      @presence_address = configuration[:presence_address] || @@DEFAULT_PRESENCE_NETWORK      
-      @presence_period = configuration[:presence_period] || @@DEFAULT_PRESENCE_PERIOD
-      @presence_listener = EventListener.new self
-      @presence_broadcaster = EventBroadcaster.new self
-      
-      @peer_registry = PeerRegistry.new self
+      # Inversion of Control is used in the following components to allow for some semblance of testing.
+      @peer_listener = configuration[:peer_listener] || Journeta::PeerListener.new(self)
+      @peer_registry = configuration[:peer_registry] || PeerRegistry.new(self)
+      @presence_listener = configuration[:presence_listener] || PresenceListener.new(self)
+      @presence_broadcaster = configuration[:presence_broadcaster] || PresenceBroadcaster.new(self)
     end
     
+    
+    # Starts sub-comonents which have their own life-cycle requirements.
+    # The registry itself does not have a dedication thread, and thus does not need to be started.
     def start
       # Start a peer listener first so we don't risk missing a connection attempt.
       putsd "Starting #{@peer_listener.class.to_s}"
       @peer_listener.start
       
-      # Start listening for presence events.
+      # Start listening for peer presence announcements next.
       putsd "Starting #{@presence_listener.class.to_s}"
       @presence_listener.start
       
-      # Start sending our own presence events!
+      # Now that we're all set up, start sending our own presence events
+      # so peer can start sending us data!
       putsd "Starting #{@presence_broadcaster.class.to_s}"
       @presence_broadcaster.start
     end
     
+    
     def stop
       # Stop broadcasting presence.
       @presence_broadcaster.stop
@@ -108,15 +117,23 @@ module Journeta
       @presence_listener.stop
       # Stop listening for incoming peer data.
       @peer_listener.stop
-      # Forcefull terminate all connections, which may be actively passing data.
+      
+      # While the registry does not have its own thread, it is in charge of managing
+      # +PeerConnection+s which DO have individual threads. This call
+      # forcefully terminates all connections, which may or may not be actively passing data.
       @peer_registry.unregister_all
     end
     
+    # Sends the given object to all peers in one of the #groups associated with this instance.
+    # The object will be marshalled via YAML, so anything the YAML serializer misses won't make it to the other side(s). 
+    # The return value is undefined.
     def send_to_known_peers(payload)
       # Delegate directly.
       peer_registry.send_to_known_peers(payload)
     end
     
+    # Send the given object to the peer of the given UUID, if available.
+    # The return value is undefined.
     def send_to_peer(peer_uuid, payload)
       # Delegate directly.
       peer_registry.send_to_peer(peer_uuid, payload)
@@ -128,11 +145,24 @@ module Journeta
       peer_registry.all(all_groups)
     end
     
-    # Adds (or updates) the given +PeerConnection+.
+    def known_groups()
+      s = Set.new
+      self.known_peers(true).each do |uuid, peer|
+        s.merge peer.groups
+      end
+      s.to_a
+    end
+    
+    # Adds (or updates) the given +PeerConnection+. If a peer of the same UUID is found,
+    # the existing record will be updated and given instance #PeerConnection#stop'd.
+    # This prevents pending outbound data from being accidentally dropped.
     def register_peer(peer)
       peer_registry.register(peer)
     end
     
+    # Forcefully unregisters the given #PeerConnection, though this is of limited use
+    # since the #PresenceListener will eventually automatically re-register
+    # the peers UUID if it's still online.
     def unregister_peer(peer)
       peer_registry.unregister(peer)
     end

data/lib/journeta/logger.rb

@@ -3,9 +3,10 @@
 
 module Journeta
    
+   # A silly logging implementation intended for internal use only. Nothing to see here!
    module Logger
       
-      # a thread safe method for printing the given string if and only if debugging is enabled
+      # A thread safe method for printing the given string if and only if debugging is enabled.
       def putsd(message = '(no message)')
          $stderr.print("DEBUG: #{message}\n") if $DEBUG
       end

data/lib/journeta/peer_connection.rb

@@ -1,19 +1,29 @@
-# Copyright 2007, OpenRain, LLC. All rights reserved.
-
+# Copyright © 2007 OpenRain, LLC. All rights reserved.
+#
+# Preston Lee <preston.lee@openrain.com>
 module Journeta
   
   # An outgoing message tube. Messages may or may not arrive at the destination, but if they do they'll be in order.
   class PeerConnection < Journeta::Asynchronous
-    
+
     include Logger
     
+    # String
     attr_accessor :uuid
     attr_accessor :ip_address
-    attr_accessor :peer_port
     attr_accessor :version
+    
+    # An Array of Strings.
+    attr_accessor :groups
+    
+    # Time.
     attr_accessor :created_at
     attr_accessor :updated_at
-    attr_accessor :groups
+    
+    # integer.
+    attr_accessor :peer_port
+    
+    
     
     def initialize(engine)
       super(engine)
@@ -27,16 +37,24 @@ module Journeta
       @queue.push payload
     end
     
+    # Updates this instances settings by copying from a provided template.
+    # Peers can, in theory, change IP address, port, version and group
+    # settings without re-registering in this instance,
+    # which would drop all pending outbound data from this connection queue,
+    # and the creation and registration of a new connection record.
+    # Peer metadata of this instance will be updated from the same fields of the given instance,
+    # however, the internal queue of this instance and current thread I/O context will remain unchanged.
     def update_settings(other)
       @settings_lock.synchronize do
-        self.ip_address = other.ip_address
-        self.peer_port = other.peer_port
-        self.version = other.version
-        self.created_at = other.created_at
-        self.updated_at = other.updated_at
+        self.ip_address = other.ip_address if other.ip_address
+        self.peer_port = other.peer_port if other.peer_port
+        self.version = other.version if other.version
+        self.created_at = other.created_at if other.created_at
+        self.updated_at = other.updated_at if other.updated_at
       end
     end
     
+    # Implementation of abstract parent declaration.
     def go
       begin
         while true
@@ -52,8 +70,17 @@ module Journeta
           s.close
         end
       rescue
-        putsd "Peer #{uuid} has gone away. Deregistering self."
-        # Yeah... kindof wierd, I know.
+        # Ok, so this is kindof wierd.
+        # Unregistering ourselves in our own thread is a paradox becasue
+        # we'd end up killing ourselves before the call completes and the unregistration process can finish.
+        # The end effect being we could end up with a stopped peer connection which is still registered.
+        # So to kill ourselves cleanly, we need to create *another* thread exclusively for the task.
+        # If somehow we end up in this block again before our child thread kills us, we're ok to create another one
+        # because the registry will just ignore a request to unregister an unknown connection, and it's internally
+        # protected against registry corruption with an exclusive lock.
+        #
+        # Sorry that this is deceptively complicated. It's a design gotcha! :)
+        putsd "Peer #{uuid} has gone away. Deregistering in the background."
         Thread.new {
           @engine.unregister_peer(self)
         }

data/lib/journeta/peer_handler.rb

@@ -4,7 +4,7 @@ module Journeta
     
     include Logger
     
-    def handle(message)
+    def call(message)
       putsd("New message received! #{message}")
     end
     

data/lib/journeta/peer_listener.rb

@@ -1,11 +1,19 @@
+# Copyright © 2007 OpenRain, LLC. All rights reserved.
+#
+# Preston Lee <preston.lee@openrain.com>
+
 require 'socket'
 
 module Journeta
   
+  # Accepts inbound connections from other peers using TCP.
+  # After the peer finishes sending data, the connection is terminated.
+  # No data is returned to the sender.
   class PeerListener < Journeta::Asynchronous
     
     def go
       begin
+        # Grab configuration information from the injected object.
         port = @engine.peer_port
         socket = TCPServer.new(port) 
         putsd "Listening on port #{port}"
@@ -13,23 +21,24 @@ module Journeta
         begin
           loop do             
             session = socket.accept
+            # We'll put the actual handling of the new session in the background so we 
+            # can continue listening for new connections as soon as possible.
             Thread.new do 
               data = ''
               # Read every last bit from the socket before passing off to the handler.
               while more = session.gets
                 data += more
               end
-#              pp data
               msg     = YAML::load(data)
               h = @engine.peer_handler
-              h.handle msg              
+              h.call msg              
             end
           end
         rescue
           putsd "Session closed."
         end 
       ensure 
-        putsd "Closing event listener socket."
+        putsd "Closing peer listener socket."
         # session.close
         # socket.close
       end

data/lib/journeta/peer_registry.rb

@@ -2,8 +2,8 @@ require 'thread'
 
 module Journeta
   
-  # responsible for keeping in-memory metadata on known peers,
-  # as well as peer tcp connections
+  # Responsible for keeping in-memory metadata on known peers in the form of PeerConnections.
+  # TODO Add dead peer reaper functionality.
   class PeerRegistry #<< Journeta::Asynchronous
     
     include Logger
@@ -107,11 +107,16 @@ module Journeta
         res = Hash.new.update @peers
       else
         res = Hash.new
-        @peers.each do |uuid, n|
-          n.groups.each do |g|
-            if @engine.groups.include?(g)
-              res[uuid] = n
-            end  
+        @peers.each do |uuid, peer|
+          if peer.groups
+            peer.groups.each do |g|
+              if @engine.groups.nil? || @engine.groups.include?(g)
+                res[uuid] = peer
+              end  
+            end
+          else
+            # Peer is a member of all groups.
+            res[uuid] = peer
           end
         end
       end     

data/lib/journeta/presence_broadcaster.rb

@@ -5,11 +5,13 @@ require 'journeta/asynchronous'
 
 module Journeta
   
-  class EventBroadcaster < Journeta::Asynchronous
+  # Spams the local area network with metadata about the local instance.
+  # This allows peers to make direct connections back at a later time.
+  class PresenceBroadcaster < Journeta::Asynchronous
     
     attr_accessor :thread
     
-    def go #(engine)
+    def go
       address = @engine.presence_address
       port = @engine.presence_port
       delay = @engine.presence_period
@@ -18,12 +20,17 @@ module Journeta
       groups = @engine.groups
       begin
         socket = UDPSocket.open
-        if PLATFORM[/linux/i]
-          socket.setsockopt( Socket::SOL_SOCKET, Socket::SO_REUSEADDR, [1].pack("i_") )
-        else
-          # socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, [1].pack('i')) # Preston's original config for OS X.
-          socket.setsockopt( Socket::SOL_SOCKET, Socket::SO_REUSEPORT, [1].pack("i_") ) # Remi's suggested default.
-        end
+        begin
+          if PLATFORM[/linux/i]
+            socket.setsockopt( Socket::SOL_SOCKET, Socket::SO_REUSEADDR, [1].pack("i_") )
+          else
+            # socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, [1].pack('i')) # Preston's original config for OS X.
+            socket.setsockopt( Socket::SOL_SOCKET, Socket::SO_REUSEPORT, [1].pack("i_") ) # Remi's suggested default.
+          end
+        rescue
+          puts "Native socket library not supported on this platform. Please submit a patch! Exiting since this is fatal :("
+          exit 1
+        end    
         loop do
           putsd "Sending presence event."
           note = PresenceMessage.new uuid, peer_port, groups

data/lib/journeta/presence_listener.rb

@@ -6,9 +6,11 @@ require 'journeta/peer_connection'
 
 module Journeta
   
-  # uses the fucked up socket api to listen for events broadcast from peers
-  class EventListener < Journeta::Asynchronous
-    
+  # Uses the fucked up Ruby socket API (which isn't really an API)
+  # to listen for presence broadcast from peers. Processing of the
+  # inbound data is quickly delegated to a background thread to allow the listener
+  # to continue responding to inbound traffic as fast as possible.
+  class PresenceListener < Journeta::Asynchronous    
     
     def go
       presence_address = @engine.presence_address
@@ -43,15 +45,21 @@ module Journeta
               peer.uuid = m.uuid
               peer.version = m.version
               peer.groups = m.groups
+              
+              # We should not start the #PeerConnection before registering because
+              # the peer might already be registered. In this case, we'd have wasted a thread,
+              # so we'll let the registry handle startup (if it happens at all.)
+              #
+              # peer.start
+              
               # TODO validate peer entry is sane before registering it
-#              peer.start
               @engine.register_peer peer
             end
           }
           # putsd "Event received!"
         end
       ensure
-        putsd "Closing event listener socket."
+        putsd "Closing presence listener socket."
         socket.close
       end
     end

data/lib/journeta/presence_message.rb

@@ -1,5 +1,7 @@
 module Journeta
    
+   # A built-in data structure which gets broadcast across the network
+   # for meta-data exchange purposes. A no-frills PORO.
    class PresenceMessage
       
       attr_accessor :version

data/lib/journeta/version.rb

@@ -1,8 +1,8 @@
 module Journeta #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 5
+    MINOR = 1
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/journeta.rb

@@ -1,5 +1,6 @@
 
 require 'yaml'
+require 'set'
 require 'thread'
 
 

data/test/test_event_broadcaster.rb

@@ -4,7 +4,7 @@ class TestEventBroadcaster < Test::Unit::TestCase
 
    
    def setup
-      # @journeta = JournetaEngine.new
+      # @journeta = Engine.new
       # @journeta.start
    end
 

data/test/test_journeta.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class TestJournetaEngine < Test::Unit::TestCase
+class TestEngine < Test::Unit::TestCase
 
   def setup
   end

data/test/test_lifecycle.rb

@@ -4,7 +4,7 @@ class TestLifecycle < Test::Unit::TestCase
 
    
    def setup
-      # @journeta = JournetaEngine.new
+      # @journeta = Engine.new
       # @journeta.start
    end
 

data/website/index.html

@@ -1,87 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <title>
-      Journeta
-  </title>
-  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
-<style>
-
-</style>
-  <script type="text/javascript">
-    window.onload = function() {
-      settings = {
-          tl: { radius: 10 },
-          tr: { radius: 10 },
-          bl: { radius: 10 },
-          br: { radius: 10 },
-          antiAlias: true,
-          autoPad: true,
-          validTags: ["div"]
-      }
-      var versionBox = new curvyCorners(settings, document.getElementById("version"));
-      versionBox.applyCornersToAll();
-    }
-  </script>
-</head>
-<body>
-<div id="main">
-
-    <h1>Journeta</h1>
-    <!--div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/journeta"; return false'>
-      <p>Get Version</p>
-      <a href="http://rubyforge.org/frs/?group_id=4138" class="numbers">sudo gem install journeta</a>
-    </div-->
-    <h2>Ruby <span class="caps">P2P</span> for your <span class="caps">LAN</span>, yo.</h2>
-	<a href="http://rubyforge.org/frs/?group_id=4138" class="numbers">[RubyForge Project]</a>
-
-	<p>Journeta is a dirt simple library for peer discovery and message passing between Ruby applications on a <span class="caps">LAN</span>.</p>
-
-
-	<h2>Peers</h2>
-
-
-	<p>A &#8220;peer&#8221; is represented by a &#8220;start&#8221;ed instance of JournetaEngine in your Ruby application. You&#8217;ll probably want just one, but may run more if it makes sense for your application to logically represent two (or more) peers simultaneously, or want to run multiple instances on the same machine.</p>
-
-
-	<p>Any object that can be serialized via <span class="caps">YAML</span> can be sent and received by Journeta. Received messages (a.k.a. objects defined by your application sent from a peer running the same code) are passed into a message handler you provide in an event-based manner. Messages do not come from your applications main thread!</p>
-
-
-	<h2>Journeta Is Simple Because It Doesn&#8217;t..</h2>
-
-
-<ol>
-<li><b>Work outside the <span class="caps">LAN</span></b>. Presence broadcasts don&#8217;t propagate to the internet, and there is no such thing as a &#8220;server&#8221; in Journeta.</li>
-<li><b>Attempt to be secure</b>, as all network messages are sent in text. Messages from peers are implicitly trusted for truthiness.</li>
-<li><b>Solve Ruby&#8217;s threading issues</b>, nor dictate your applications thread handling design. Until Ruby uses native threads, high-performance uses of Journeta will likely be limited. Remember that stuff sent to your message handler is not coming from your applications main thread.</li>
-<li><b>Provide backwards compatibility</b>, or for the matter, compatibility with anything other than peers of the same Journeta version. No formal messaging specifications here. Different versions of Journeta may or may not be protocol compatible; we don&#8217;t know and we don&#8217;t keep track.</li>
-<li><b>Guarantee message delivery</b>, since <span class="caps">UDP</span> is used for some types of communications, and peers are free to go down at any time.</li>
-</ol>
-
-	<h2>Installing</h2>
-
-
-<pre syntax="ruby">sudo gem install journeta</pre>
-
-	<h2>The Basics</h2>
-
-
-	<p>Several annotated code snippets can be found in the &#8220;examples&#8221; directory of the gem. Open two (or more) consoles and run and following on each for a completely decentralized, zero-configuration-required chat server.
-	<pre syntax="ruby">ruby examples/instant_messenger.rb</pre>
-	Sweeeeet.</p>
-
-
-    <p class="coda">
-	<a href="mailto:preston.lee@openrain.com">Preston Email</a>
-      <a href="http://prestonlee.com/">Preston Blog</a>
-      <a href="http://openrain.com/">Preston's Company</a>
-    </p>
-</div>
-
-<!-- insert site tracking codes here, like Google Urchin -->
-
-</body>
-</html>

data/website/index.txt

@@ -6,7 +6,7 @@ Journeta is a library for passing objects between automatically discovered and c
 
 h2. Peers
 
-A "peer" is represented by a "start"ed instance of JournetaEngine in your Ruby application. You'll probably want just one, but may run more if it makes sense for your application to logically represent two (or more) peers simultaneously.
+A "peer" is represented by a "start"ed instance of Engine in your Ruby application. You'll probably want just one, but may run more if it makes sense for your application to logically represent two (or more) peers simultaneously.
 
 Any object that can be serialized via YAML can be sent and received by Journeta. Received messages (a.k.a. objects defined by your application sent from a peer) are passed into a message handler you define, in an event-based manner. Message do not come from your applications main thread.
 

data/website/stylesheets/screen.css

@@ -1,138 +1,43 @@
-body {
-  background-color: #E1D1F1;
-  font-family: "Georgia", sans-serif;
-  font-size: 16px;
-  line-height: 1.6em;
-  padding: 1.6em 0 0 0;
-  color: #333;
-}
-h1, h2, h3, h4, h5, h6 {
-  color: #444;
-}
-h1 { 
-  font-family: sans-serif;
-  font-weight: normal;
-  font-size: 4em;
-  line-height: 0.8em;
-  letter-spacing: -0.1ex;
-	margin: 5px;
-}
-li {
-  padding: 0;
-  margin: 0;
-  list-style-type: square;
-}
-a {
-  color: #5E5AFF;
-	background-color: #DAC;
-  font-weight: normal;
-  text-decoration: underline;
-}
-blockquote {
-  font-size: 90%;
-  font-style: italic;
-  border-left: 1px solid #111;
-  padding-left: 1em;
-}
-.caps {
-  font-size: 80%;
-}
-
-#main {
-  width: 45em;
-  padding: 0;
-  margin: 0 auto;
-}
-.coda {
-  text-align: right;
-  color: #77f;
-  font-size: smaller;
-}
-
-table {
-  font-size: 90%;
-  line-height: 1.4em;
-  color: #ff8;
-  background-color: #111;
-  padding: 2px 10px 2px 10px;
-	border-style: dashed;
-}
-
-th {
-	color: #fff;
-}
-
-td {
-  padding: 2px 10px 2px 10px;
-}
-
-.success {
-	color: #0CC52B;
-}
-
-.failed {
-	color: #E90A1B;
-}
-
-.unknown {
-	color: #995000;
-}
-pre, code {
-  font-family: monospace;
-  font-size: 90%;
-  line-height: 1.4em;
-  color: #ff8;
-  background-color: #111;
-  padding: 2px 10px 2px 10px;
-}
-.comment { color: #aaa; font-style: italic; }
-.keyword { color: #eff; font-weight: bold; }
-.punct { color: #eee; font-weight: bold; }
-.symbol { color: #0bb; }
-.string { color: #6b4; }
-.ident { color: #ff8; }
-.constant { color: #66f; }
-.regex { color: #ec6; }
-.number { color: #F99; }
-.expr { color: #227; }
-
-#version {
-  float: right;
-  text-align: right;
-  font-family: sans-serif;
-  font-weight: normal;
-  background-color: #B3ABFF;
-  color: #141331;
-  padding: 15px 20px 10px 20px;
-  margin: 0 auto;
-	margin-top: 15px;
-  border: 3px solid #141331;
-}
-
-#version .numbers {
-  display: block;
-  font-size: 4em;
-  line-height: 0.8em;
-  letter-spacing: -0.1ex;
-	margin-bottom: 15px;
-}
-
-#version p {
-  text-decoration: none;
-	color: #141331;
-	background-color: #B3ABFF;
-	margin: 0;
-	padding: 0;
-}
-
-#version a {
-  text-decoration: none;
-	color: #141331;
-	background-color: #B3ABFF;
-}
-
-.clickable {
-	cursor:	pointer; 
-	cursor:	hand;
-}
+/* Copyright 2008 OpenRain, LLC. All rights reserved. */
 
+body {
+background-color: #ffffff;
+font-family: "Georgia", sans-serif;
+font-size: 16px;
+line-height: 1.6em;
+color: #333;
+background-position: 0px 0px;
+background-repeat: repeat-x;
+background-image: url(../images/content_side.png);
+background-color: #faf3c0;
+}
+
+h1, h2, h3 {font-weight: bold;}
+h1 {font-size: 24pt; color: #194c38;}
+h2 {font-size: 18pt; color: #194c38;}
+h3 {color: #697c68;}
+em {color: #ffffff; font-size: 140%;}
+a {color: #fbf5d0; text-decoration: none;}
+
+.clear { clear: both;}
+.code { font-family: monospace; margin: 10px;  font-size: 10pt;  color: #ff8; background-color: #111; }
+.clickable { cursor: pointer; cursor: hand; }
+
+#header_side {background-position: 0px 0px;background-repeat: repeat-x;background-image: url(../images/header_side.jpg);float: left;position: absolute;width: 100%;height: 97px;z-index: -1;}
+
+#header { background-position: 0px 0px; background-repeat: repeat-x; background-image: url(../images/header.jpg); margin: 0 auto; width: 700px; height: 97px; }
+#header #name {color: #ffffff; font-size: 48pt;  padding: 40px 0 0 10px; }
+#header ol {list-style: none; position: absolute; top: 77px; font-size: 10pt;margin-left: 10px;}
+#header li { display: inline; color: #f0f0f0;margin-left:10px;}
+
+#content_wrapper { background-position: 0px 0px; background-repeat: repeat-y; background-image: url(../images/content_shadow.png); width: 729px; margin: 0 auto;}
+
+#content { width: 700px; background-color: #ffffff; margin-left: 15px; }
+#content ol {list-style-type: none; margin-left: 20px;}
+#content li {margin-top: 10px;}
+#content #blurb { width: 320px; float: right; margin: 10px; clear: none; font-size: 16pt; color: #d8d8d8;}
+#content #guts > div {margin:20px; padding: 10px; }
+#content #guts p {padding-bottom: 20px; display: block;}
+#content #banner { background-position: 0px 0px; background-repeat: no-repeat; background-image: url(../images/banner.jpg); width: 700px; height: 202px;}
+
+#sidebar { float: right; width: 300px; margin: 20px; clear: none; background-color: #FDFEEE; padding: 10px;}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: journeta
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors: 
 - Preston Lee
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-22 00:00:00 -07:00
+date: 2008-09-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ files:
 - lib/journeta.rb
 - examples/instant_messenger.rb
 - examples/instant_messenger_gui.rb
+- examples/network_status.rb
 - examples/queue_client.rb
 - examples/queue_server.rb
 - lib/journeta/logger.rb