hara 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f83818ae52c8a4eb9db097c057149a4b1c4078e
-  data.tar.gz: ba02fe00a42900cea3af4d7ee8a60aa74ecb31f8
+  metadata.gz: 5863328a79f220ece656a08e162f10675e758dd7
+  data.tar.gz: addd1f740c431d625188663a8640aebdcf6f9ea2
 SHA512:
-  metadata.gz: 4b60a714370f02384741883e26995d5f3136166e7df01236691502b3a739510e49d0eea863e487f21711bbdb87dcfd6c2aba7300a84449119edc386ad330e7b3
-  data.tar.gz: f33ffb17c068aab2a9cb35b02b8f17a98084884e7700113474ad3d4d52f507a573e94f85964084efb15e1df4a9e0fb868f91cd2f128d7f703c8fd7d6e2e70372
+  metadata.gz: 13a36a9802a40a714c18e357cf70e43c5a806cdc6181e69a3688403e965def6f0d6a25510687fcbdb67f4025bc9831b7ff3ac48beeb8f0c441bffb2956281e50
+  data.tar.gz: 104134728df1f2a724fdad3b68f3a4757b54d4d40e45de4906deb18ba2586dda4b90a66e837a2f4dd3f5b17dc04d6856ddae0f3fbd5a3e60f2fd779969eea6d9

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'rspec'
+gem 'therubyracer', :group => [:development, :test]
 
 # Specify your gem's dependencies in hara.gemspec
 gemspec

data/README.md

@@ -1,13 +1,13 @@
-# Hara
+# Hara(袚)
 
 [![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 websocket based application framework, build upon [em-websocket](https://github.com/igrigorik/em-websocket).
+Hara(袚) is a websocket based application framework, build upon [em-websocket](https://github.com/igrigorik/em-websocket).
 
 * Simple, easy to use.
-* OO, Actor model(Celluloid).
-* Event-io(em-websocket).
+* Actor model(celluloid).
+* Event-IO(em-websocket).
 
 ## Installation
 
@@ -23,18 +23,21 @@ Or install it yourself as:
 
     $ gem install hara
 
+Client:
+
+    copy it from ./client
+
 ## Basic Usage
 
 *server*
 ```ruby
-#test.rb
 require 'hara'
 
-class Echo
+class Test
   include Hara::App
 
-  define_action :echo do |str|
-    send_msg str
+  define_action :reverse do |str|
+    response_msg str.reverse
   end
 end
 
@@ -43,28 +46,19 @@ Hara::Server.start 'localhost', '3000'
 
 *client*
 ```javascript
-var msg = JSON.stringify({action: 'echo',args:['hello world']})
-var ws = new WebSocket('ws://localhost:3000')
-ws.onmessage = function(msg){alert(msg.data)}
-
-//after a while
-ws.send(msg)
-//hello world
+var client = new Hara();
+client.connect('ws://localhost:3000');
+client.send('reverse', ['hello world'], function(msg){alert(msg)});
 ```
 
-*start server*
-`ruby test.rb`
-
-`ruby test.rb -h` to view options
-
 ## Full Usages
 
+*server*
 ```ruby
 require 'hara'
 
-class Echo
-  #include Hara::App make your Echo class become Celluloid::Actor,
-  #hara use actor per connection
+class Clock
+  #include Hara::App make your class become Celluloid::Actor
   include Hara::App
 
   #Hara::App provide some callbacks
@@ -72,22 +66,29 @@ class Echo
   def after_connect
     puts 'first called'
     p headers
+    # push message to client
+    send_msg "connected"
   end
 
   def before_action action, *args
     puts 'called when action comming'
   end
 
-  define_action :echo do |str|
+  define_action :start do
     puts "#{client_ip} #{client_port}"
-    #send message to client
-    send_msg str
+
+    # push time to client every 1 sec
+    @timer = every(1){ send_msg Time.now.to_s}
+
+    # different between send_msg & response_msg
+    # send_msg means push to client, trigger client onmessage callback
+    # response_msg respond client request, and trigger send callback(if it present)
+    response_msg 'started'
   end
 
-  define_action :exit do
-    puts "#{client_ip} exit"
-    # close client connection
-    close
+  define_action :stop do
+    @timer.cancel
+    response_msg 'stoped'
   end
 
   def after_action action, *args
@@ -95,7 +96,7 @@ class Echo
   end
 
   def action_missing action, *args
-    send_msg 'error'
+    puts 'error'
     super
   end
 
@@ -109,8 +110,36 @@ server_options = {
 #...some options, same as EM::Websocket.run
 }
 Hara::Server.start 'localhost', '3000', server_options
+```
 
+*client*
+```javascript
+var client = new Hara();
+
+//handle pushed messages(send_msg)
+client.onmessage = function(msg){
+    console.log("current time:" + msg);
+}
+
+//connect to server
+client.connect('ws://localhost:3000');
+
+//call server side action
+client.send('start', [], function(msg){console.log(msg)});
+//started
+//current time:2013-08-05 10:48:04 +0800
+//current time:2013-08-05 10:48:05 +0800
+//current time:2013-08-05 10:48:06 +0800
+//current time:2013-08-05 10:48:07 +0800
+client.send('stop', [], function(msg){console.log(msg)});
+//stoped
+
+//close connection
+client.close();
+```
 
+####use filter####
+```ruby
 # Hara::Filter
 # Filter can help you filter some connections before dispatched to app actor.
 # Example: use Filter to authentication
@@ -124,6 +153,9 @@ end
 #class name is not matter
 class Authentication
   include Hara::Filter
+  
+  #default value is 10
+  self.pool_size = 20
 
   # You must implement filter method, return value should be ture or false
   def filter
@@ -135,12 +167,6 @@ end
 Hara::Server.start 'localhost', '3000'
 ```
 
-## Client
-
-js client is processing
-
-current format is JSON.stringify({action: 'echo',args:['hello world']})
-
 ## Contributing
 
 1. Fork it

data/client/hara.js

@@ -0,0 +1,78 @@
+function Hara() {
+    this.send_message_ids = {};
+    this.onopen = this.onclose = this.onerror = this.onmessage = function(){};
+}
+
+Hara.prototype.send = function(action, args, callback){
+    var id = Hara.uuid();
+    var message = Hara.encode({_id: id, action: action, args: args});
+    this.send_message_ids[id] = callback;
+    this.websocket.send(message);
+}
+
+Hara.prototype.connect = function(url, protocol){
+    this.websocket = new WebSocket(url, protocol);
+    this.setup_callbacks();
+}
+
+Hara.prototype.setup_callbacks = function(){
+    var that = this;
+    this.websocket.onopen = function(){
+        that.onopen.apply(that, arguments);
+    };
+    this.websocket.onclose = function(){
+        that.onclose.apply(that, arguments);
+    };
+    this.websocket.onerror = function(){
+        that.onerror.apply(that, arguments);
+    };
+    this.websocket.onmessage = function(msg){
+        var message = Hara.decode(msg.data);
+        switch(message.type){
+            case 'response':
+            that.handle_response(message);
+            break;
+            case 'push':
+            that.handle_push(message);
+            break;
+            default:
+            throw 'Unknown message type'
+        }
+    };
+};
+
+Hara.prototype.handle_response = function(message) {
+    var id = message._id;
+    var args = message.args;
+    var callback = this.send_message_ids[id];
+    if(callback) {
+        callback.apply(this, [args]);
+    }
+    delete this.send_message_ids[id];
+};
+
+Hara.prototype.handle_push = function(message) {
+    var args = message.args;
+    this.onmessage(args);
+};
+
+Hara.prototype.close = function(){
+    this.websocket.close.apply(this.websocket, arguments);
+    this.send_message_ids = {};
+}
+
+Hara.uuid = function() {
+    var uuid = ('xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
+        var r = Math.random()*16|0, v = c == 'x' ? r : (r&0x3|0x8);
+        return v.toString(16);
+    }));
+    return uuid;
+}
+
+Hara.encode = function(args) {
+    return JSON.stringify(args);
+}
+
+Hara.decode = function(args){
+    return JSON.parse(args);
+}

data/lib/hara.rb

@@ -4,12 +4,11 @@ module Hara
   class << self
     #decode message, return action and args
     def decode_msg msg
-      msg = JSON.parse(msg)
-      msg.values_at 'action', 'args'
+      JSON.parse msg
     end
 
-    def encode_msg action, *args
-      {action: action, args: args}.to_json
+    def encode_msg msg
+      msg.to_json
     end
 
     def filter_class

data/lib/hara/app.rb

@@ -46,13 +46,13 @@ module Hara
 
     ##################
 
-    #like method_missing
+    # like method_missing
     def action_missing action, args
       info "#{client_ip} request action: #{action} args: #{args.inspect}, action not defined"
       raise NoMethodError, "undefined action '#{action}' for #{self}:#{self.class}"
     end
 
-    #below are internal functions(should not been overriding)
+    # below are internal functions(should not been overriding)
 
     def initialize handshake, socket
       socket_setup handshake, socket
@@ -65,14 +65,31 @@ module Hara
     end
 
     def process_msg message
-      action, args = Hara.decode_msg(message)
-      info "#{client_ip} request action: #{action} args: #{args.inspect}"
-      before_action action, *args
-      call_action action, *args
-      after_action action, *args
-    rescue StandardError => e
-      info "#{client_ip} processing error:\n#{e.inspect}"
-      terminate
+      exclusive do
+        begin
+          id, action, args = Hara.decode_msg(message).values_at('_id', 'action', 'args')
+          info "#{client_ip} request action: #{action} args: #{args.inspect}"
+          before_action action, *args
+          call_action action, *args
+          after_action action, *args
+          send_response_msg id
+        rescue StandardError => e
+          info "#{client_ip} processing error:\n#{e.inspect}"
+          terminate
+        end
+      end
+    end
+
+    # respond to client
+    def response_msg msg
+      raise DuplicateResponseError if @_response_msg
+      @_response_msg = msg
+    end
+
+    def send_response_msg message_id
+      msg, @_response_msg = @_response_msg, nil
+      message = Hara.encode_msg(_id: message_id, type: :response, args: msg)
+      socket.send message
     end
 
     def call_action action, *args

data/lib/hara/client_interaction.rb

@@ -1,4 +1,7 @@
 module Hara
+  class DuplicateResponseError < StandardError
+  end
+
   module ClientInteraction
     attr_reader :socket, :handshake, :client_ip, :client_port
 
@@ -15,7 +18,12 @@ module Hara
 
     # send msg to client
     def send_msg msg
-      socket.send msg
+      message = Hara.encode_msg(type: :push, args: msg)
+      socket.send message
+    end
+
+    def response_msg msg
+      raise NotImplementedError
     end
 
     # close connection

data/lib/hara/version.rb

@@ -1,3 +1,3 @@
 module Hara
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/app_spec.rb

@@ -40,8 +40,8 @@ describe Hara::App do
   end
 
   before :each do
-    @handshake = FayeHandshake.new
-    @socket = FayeSocket.new
+    @handshake = FakeHandshake.new
+    @socket = FakeSocket.new
     @app = Hara::Application.new @handshake, @socket
     @socket.app = @app
   end
@@ -59,35 +59,33 @@ describe Hara::App do
   end
 
   it 'remote call actions' do
-    @app.process_msg(Hara.encode_msg(:hello, ' world'))
+    @socket.client_send(:hello, [' world'])
     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))
+    @socket.client_send(: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')
+    @socket.client_send(:hello, [])
     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'))
+    @socket.client_send(:hello_world, ['hello', 'world'])
     msg = nil
     wait_until{msg = @socket.client_read}
-    msg.should == [:action_missing, 'hello_world', ['hello', 'world']]
+    msg.should == ['action_missing', 'hello_world', ['hello', 'world']]
   end
 
   it 'callbacks should work' do
-    2.times{ @app.process_msg(Hara.encode_msg(:hello, ' world'))}
+    2.times{ @socket.client_send(:hello, [' world'])}
     states = @app.states
     sleep 0.2
     @app.terminate

data/spec/filter_spec.rb

@@ -27,8 +27,8 @@ describe Hara::Filter do
 
   describe 'filter' do
     before :each do
-      @handshake = FayeHandshake.new
-      @socket = FayeSocket.new
+      @handshake = FakeHandshake.new
+      @socket = FakeSocket.new
       @socket.alive = true
       wait_until{Hara.filter_pool}
     end

data/spec/hara_spec.rb

@@ -9,10 +9,7 @@ describe Hara do
   end
 
   it 'Hara.encode_msg & decode_msg should work' do
-    action = 'hello_world'
-    args = ['hello', 'world']
-    action_d, args_d = Hara.decode_msg Hara.encode_msg(action, *args)
-    action.should == action_d
-    args.should == args_d
+    msg = {'action' => 'hello_world', 'args' => ['hello', 'world']}
+    Hara.decode_msg(Hara.encode_msg msg).should == msg
   end
 end

data/spec/spec_helper.rb

@@ -8,13 +8,13 @@ def wait_until wait_time = 3
   end
 end
 
-class FayeHandshake
+class FakeHandshake
   def headers_downcased
     {'host' => 'localhost:8080'}
   end
 end
 
-class FayeSocket
+class FakeSocket
   attr_accessor :remote_ip, :close_info, :app
 
   def initialize
@@ -22,6 +22,7 @@ class FayeSocket
     @server_messages = []
     @mri_peername = "\x02\x00\x00P\x7F\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00"
     @jruby_peername = "\x00\x02\x8Av\x7F\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00\x00"
+    @send_message_ids = {}
   end
 
   def app= app
@@ -49,12 +50,18 @@ class FayeSocket
     end
   end
 
+  def client_send action, args
+    id = SecureRandom.uuid
+    @server_messages << Hara.encode_msg(id: id, action: action, args: args)
+    @app.process_msg @server_messages.shift
+  end
+
   def send message
     @client_messages << message
   end
 
   def client_read
-    @client_messages.shift
+    Hara.decode_msg(@client_messages.shift)['args']
   end
 
   [:onclose, :onmessage, :onopen].each do |method|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hara
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - jjy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-websocket
@@ -93,6 +93,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- client/hara.js
 - hara.gemspec
 - lib/hara.rb
 - lib/hara/app.rb
@@ -125,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Hara build upon em-websocket, easy to use.