hara 0.2.1 → 0.2.2

data/README.md

@@ -3,13 +3,13 @@
 [![Gem Version](https://badge.fury.io/rb/hara.png)](http://badge.fury.io/rb/hara)
 [![Build Status](https://travis-ci.org/jjyr/hara.png?branch=master)](https://travis-ci.org/jjyr/hara)
 
-Hara is a simple framework, help you build async & concurrent websocket server.
+Hara is a simple framework, help you build async-io & concurrent websocket server.
 
-Hara's async ability from [em-websocket](https://github.com/igrigorik/em-websocket),
+Hara's async-io ability from [em-websocket](https://github.com/igrigorik/em-websocket),
 
 Hara's concurrent ability from [celluloid](https://github.com/celluloid/celluloid).
 
-Yes, hara is a combination of them, eventmachine and celluloid work well together :)
+Seems eventmachine and celluloid work well together :smile:
 
 ## Installation
 
@@ -57,13 +57,14 @@ ws.send(msg)
 
 `ruby test.rb -h` to view options
 
-## Other Usages & How it work
+## Full Usages
 
 ```ruby
 require 'hara/base'
 
 class Echo 
-  #include Hara::App, make you Echo class become Celluloid::Actor and per actor handle a socket
+  #include Hara::App, make you Echo class become Celluloid::Actor,
+  # and per actor handle a socket
   include Hara::App
 
   #Hara::App provide some callbacks
@@ -79,22 +80,40 @@ class Echo
 
   define_action :echo do |str|
     puts "#{client_ip} #{client_port}"
+    #send message to socket
     socket.send str
   end
 
+  define_action :exit do
+    puts "#{client_ip} exit"
+    # close client connection
+    close
+  end
+
   def after_action action, *args
     puts 'called when action complete'
   end
+
+  def action_missing action, *args
+    socket.send 'error'
+    super
+  end
+
+  def on_close close_info
+    puts "#{client_ip} connection closed"
+  end
 end
 
 #if you require 'hara/base' you need start server you self, like below
 Hara::Server.start 'localhost', '3000'
 ```
 
-## RoadMap
+## Client
 
 js client is processing
 
+current format is JSON.stringify({action: 'echo',args:['hello world']})
+
 ## Contributing
 
 1. Fork it

data/hara.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Hara::VERSION
   spec.authors       = ["jjy"]
   spec.email         = ["jjyruby@gmail.com"]
-  spec.description   = %q{Hara help you build async & concurrent websocket server.}
+  spec.description   = %q{Hara help you build async-io & concurrent websocket server.}
   spec.summary       = %q{In fact, hara just a combination of em-websocket and celluloid, but it really help you write applications easily.}
   spec.homepage      = "http://github.com/jjyr/hara"
   spec.license       = "MIT"

data/lib/hara/app.rb

@@ -61,7 +61,7 @@ module Hara
     def after_action action, args
     end
 
-    def on_close
+    def on_close close_info = {}
     end
 
     ##################
@@ -77,6 +77,11 @@ module Hara
       handshake.headers_downcased
     end
 
+    # close connection
+    def close code = nil, body = nil
+      @socket.close code, body
+    end
+
     #below are internal functions(should not been overriding)
 
     def initialize handshake, socket
@@ -110,8 +115,12 @@ module Hara
       end
     end
 
+    def set_close_info close_info
+      @_close_info = close_info
+    end
+
     def app_finalizer
-      on_close
+      on_close @_close_info
     ensure
       @socket.close if @socket
     end

data/lib/hara/server.rb

@@ -16,8 +16,9 @@ module Hara
 	    actor = Hara::Application.new handshake, ws
 	  }
 
-	  ws.onclose { 
+	  ws.onclose {|close_info = {}|
 	    begin
+	      actor.async.set_close_info close_info
 	      actor.terminate! if actor.alive?
 	    rescue Celluloid::DeadActorError => e
 	    end

data/lib/hara/version.rb

@@ -1,3 +1,3 @@
 module Hara
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/app_spec.rb

@@ -17,7 +17,7 @@ describe Hara::App do
 	@states << [:after_action, action, args]
       end
 
-      def on_close
+      def on_close close_info
 	@states << :closed
       end
 
@@ -29,6 +29,10 @@ describe Hara::App do
 	socket.send "hello#{msg}"
       end
 
+      define_action :exit do
+	close 3333, "Bye"
+      end
+
       def states
 	@states
       end
@@ -39,6 +43,7 @@ describe Hara::App do
     @handshake = FayeHandshake.new
     @socket = FayeSocket.new
     @app = Hara::Application.new @handshake, @socket
+    @socket.app = @app
   end
 
   after :each do
@@ -55,20 +60,29 @@ describe Hara::App do
 
   it 'remote call actions' do
     @app.process_msg(Hara.encode_msg(:hello, ' world'))
-    sleep 0.1 until msg = @socket.client_read
+    msg = nil
+    wait_until{msg = @socket.client_read}
     msg.should == 'hello world'
   end
 
+  it 'close should close connection' do
+    @app.process_msg(Hara.encode_msg(:exit))
+    wait_until{!@app.alive?}
+    @socket.alive?.should == false
+    @socket.close_info.should == [3333, 'Bye']
+  end
+
   it 'error remote call' do
     @app.process_msg('a error call')
-    sleep 0.1 while @app.alive?
+    wait_until{!@app.alive?}
     msg = @socket.client_read
     msg.should == nil
   end
 
   it 'action_missing should work' do
     @app.process_msg(Hara.encode_msg(:hello_world, 'hello', 'world'))
-    sleep 0.1 until msg = @socket.client_read
+    msg = nil
+    wait_until{msg = @socket.client_read}
     msg.should == [:action_missing, 'hello_world', ['hello', 'world']]
   end
 
@@ -77,7 +91,7 @@ describe Hara::App do
     states = @app.states
     sleep 0.2
     @app.terminate
-    sleep 0.1 while @app.alive?
+    wait_until{!@app.alive?}
     action_callbacks = [[:before_action, "hello", [" world"]], [:after_action, "hello", [" world"]]]
     states.should == [*(action_callbacks * 2),:closed]
   end

data/spec/spec_helper.rb

@@ -2,6 +2,12 @@ require 'hara/base'
 
 Celluloid.logger = nil
 
+def wait_until wait_time = 3
+  timeout wait_time do
+    sleep 0.1 until yield
+  end
+end
+
 class FayeHandshake
   def headers_downcased
     {'host' => 'localhost:8080'}
@@ -9,7 +15,7 @@ class FayeHandshake
 end
 
 class FayeSocket
-  attr_accessor :remote_ip
+  attr_accessor :remote_ip, :close_info, :app
 
   def initialize
     @client_messages = []
@@ -18,6 +24,11 @@ class FayeSocket
     @jruby_peername = "\x00\x02\x8Av\x7F\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00"
   end
 
+  def app= app
+    @app = app
+    @alive = true
+  end
+
   def get_peername
     defined?(JRuby) ? @jruby_peername : @mri_peername
   end
@@ -26,8 +37,12 @@ class FayeSocket
     @alive
   end
 
-  def close
-    @alive = false
+  def close code = nil, body = nil
+    if @alive
+      @close_info = [code, body]
+      @alive = false
+      @app.terminate!
+    end
   end
 
   def send message

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hara
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-websocket
@@ -75,7 +75,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Hara help you build async & concurrent websocket server.
+description: Hara help you build async-io & concurrent websocket server.
 email:
 - jjyruby@gmail.com
 executables: []