kosmonaut 0.2.1 → 0.2.2

data/ChangeLog

@@ -1,3 +1,12 @@
+2012-01-20  Krzysztof Kowalik  <chris@nu7hat.ch>
+
+	* test/test_kosmonaut_worker.rb: shortened test time
+
+2012-01-18  Krzysztof Kowalik  <chris@nu7hat.ch>
+
+	* lib/kosmonaut.rb: added documentation
+	* lib/kosmonaut/client.rb: added docs for part of the methods
+
 2012-01-16  Krzysztof Kowalik  <chris@nu7hat.ch>
 
 	* lib/kosmonaut/socket.rb: base for worker and client

data/NEWS

@@ -1,8 +1,11 @@
 Releases
 ========
 
+v0.2.1
+------
+* Fixed behaviour of the worker's listener.
+
 v0.2.0
 ------
-* Pure ruby implementation of the client and worker using
-  majordomo pattern.
+* Pure ruby implementation of the client and worker using majordomo pattern.
 * Tests for the API

data/kosmonaut.gemspec

@@ -1,9 +1,10 @@
 # -*- ruby -*-
 require 'rubygems'
+require File.expand_path("../lib/kosmonaut/version", __FILE__)
 
 Gem::Specification.new do |s|
   s.name = "kosmonaut"
-  s.version = "0.2.1"
+  s.version = Kosmonaut.version
   s.summary = "Ruby client for the WebRocket backend"
   s.description = "The WebRocket server backend client for ruby programming language"
   s.authors = ["Krzysztof Kowalik", "Cubox"]

data/lib/kosmonaut.rb

@@ -6,8 +6,15 @@ require 'kosmonaut/version'
 
 module Kosmonaut
   extend self
+  
+  # Public: The debug mode switch. If true, then debug messages will
+  # be printed out. 
   attr_accessor :debug
 
+  # Internal: Simple logging method used to display debug information
+  #
+  # msg - The debug message to be displayed
+  #
   def log(msg)
     print("DEBUG: ", msg, "\n") if Kosmonaut.debug
   end

data/lib/kosmonaut/client.rb

@@ -9,20 +9,48 @@ module Kosmonaut
   class Client < Socket
     include Kosmonaut
 
-    REQUEST_TIMEOUT = 5 # in seconds
+    # Maximum number of seconds to wait for the request to being processed.
+    REQUEST_TIMEOUT = 5
 
+    # Public: The Client constructor. Pre-configures the client instance. See
+    # also the Kosmonaut::Socket#initialize for the details.
+    # 
+    # url - The WebRocket backend endpoint URL to connect to.
+    #
+    # The endpoint's URL must have the following format:
+    #
+    #     [scheme]://[secret]@[host]:[port]/[vhost]
+    #
+    # Examples
+    #
+    #     c = Kosmonaut::Client.new("wr://f343...fa4a@myhost.com:8080/hello")
+    #     c.broadcast("room", "status", {"message" => "is going to the beach!"})
+    # 
     def initialize(url)
       super(url)
       @mtx = Mutex.new
     end
 
+    # Public: Broadcasts a event with attached data on the specified channel.
+    # The data attached to the event must be a hash!
+    #
+    # channel - A name of the channel to broadcast to.
+    # event   - A name of the event to be triggered.
+    # data    - The data attached to the event.
+    #
+    # Examples
+    #
+    #     c.broadcast("room", "away", {"message" => "on the meeting"})
+    #     c.broadcast("room". "message", {"content" => "Hello World!"})
+    #     c.broadcast("room". "status", {"message" => "is saying hello!"})
+    #
     def broadcast(channel, event, data)
       payload = ["BC", channel, event, data.to_json]
       perform_request(payload)
     end
 
-    def open_channel(name, type)
-      payload = ["OC", name, type]
+    def open_channel(name)
+      payload = ["OC", name]
       perform_request(payload)
     end
 

data/lib/kosmonaut/version.rb

@@ -2,7 +2,7 @@ module Kosmonaut
   module Version
     MAJOR = 0
     MINOR = 2
-    PATCH = 0
+    PATCH = 2
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/test/test_kosmonaut_client.rb

@@ -18,11 +18,11 @@ class TestKosmonautClient < MiniTest::Unit::TestCase
   end
   
   def _test_open_channel
-    @client.open_channel("foo", 0)
+    @client.open_channel("foo")
   end
 
   def _test_open_channel_with_invalid_name
-    @client.open_channel("%%%", 0)
+    @client.open_channel("%%%")
     assert false
   rescue Kosmonaut::InvalidChannelNameError
   end

data/test/test_kosmonaut_worker.rb

@@ -21,7 +21,7 @@ class TestKosmonautWorker < MiniTest::Unit::TestCase
 
   def test_api
     Thread.new {
-      sleep(15)
+      sleep(10)
       @worker.stop
     }
     @worker.listen

metadata

@@ -2,7 +2,7 @@
 name: kosmonaut
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Krzysztof Kowalik
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-17 00:00:00 Z
+date: 2012-01-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json