hara 0.1.0 → 0.2.0

data/.travis.yml

@@ -3,3 +3,7 @@ rvm:
   - 2.0.0
   - 1.9.3
   - jruby-19mode
+
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode

data/README.md

@@ -3,7 +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 websocket server.
+Hara is a simple framework, help you build async & concurrent websocket server.
+
+Hara's async ability from [em-websocket](https://github.com/igrigorik/em-websocket),
+
+Hara's concurrent ability from [celluloid](https://github.com/celluloid/celluloid).
+
+Yes, hara just a combination of them, eventmachine and celluloid work well together :)
 
 ## Notice!!
 
@@ -32,7 +38,7 @@ require 'hara'
 
 class Echo < Hara::App
   define_action :echo do |str|
-    socket << str
+    socket.send str
   end
 end
 ```
@@ -41,7 +47,9 @@ end
 ```javascript
 var msg = JSON.stringify({action: 'echo',args:['hello world']})
 var ws = new WebSocket('ws://localhost:3210')
-ws.onmessage = function(msg){console.log(msg.data)}
+ws.onmessage = function(msg){alert(msg.data)}
+
+//after a while
 ws.send(msg)
 //hello world
 ```

data/hara.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Hara::VERSION
   spec.authors       = ["jjy"]
   spec.email         = ["jjyruby@gmail.com"]
-  spec.description   = %q{Hara is a simple framework, help you build [web ]socket server. Power by reel and celluloid.}
-  spec.summary       = %q{Hara can help your build [web ]socket server easier.}
+  spec.description   = %q{Hara help you build async & 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"
 
@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
 
-  spec.add_dependency "reel", "~> 0.3"
+  spec.add_dependency "em-websocket", "~> 0.5.0"
+  spec.add_dependency "celluloid", "~> 0.14.1"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/hara/app.rb

@@ -1,14 +1,32 @@
-require 'celluloid/io'
+require "hara/version"
+require 'celluloid'
 require 'json'
 
 module Hara
+  class << self
+    def env
+      @_env ||= (ENV['APP_ENV'] || :development).to_sym
+    end
+
+    def env= env
+      @_env = env
+    end
+
+    def decode_msg msg
+      msg = JSON.parse(msg)
+      msg.values_at 'action', 'args'
+    end
+
+    def encode_msg action, *args
+      {action: action, args: args}.to_json
+    end
+  end
+
   class App
-    include Celluloid::IO
+    include Celluloid
     include Celluloid::Logger
 
-    attr_reader :socket
-
-    alias halt terminate
+    attr_reader :socket, :handshake
 
     finalizer :app_finalizer
 
@@ -16,34 +34,20 @@ module Hara
 
     class << self
       def inherited klass
-        ::Hara.const_set :Application, klass
+	::Hara.const_set :Application, klass
       end
 
       def define_action action, &block
-        action = action.to_s
-        warn "Action #{action} duplication defined" if Actions.has_key? action
-        Hara::Application.send :define_method, action, &block
-        method = Hara::Application.send :instance_method, action
-        Hara::Application.send :remove_method, action
-        Actions[action] = method
+	action = action.to_s
+	warn "Action #{action} duplication defined" if Actions.has_key? action
+	Hara::Application.send :define_method, action, &block
+	method = Hara::Application.send :instance_method, action
+	Hara::Application.send :remove_method, action
+	Actions[action] = method
       end
     end
 
-
-    def init
-    end
-
-    #return true or false
-    def authentication
-      true
-    end
-
-    def authentication_failed
-      halt
-    end
-
-    #after_authentication only called when authentication succeeded
-    def after_authentication
+    def after_connect
     end
 
     def before_action action, args
@@ -52,83 +56,52 @@ module Hara
     def after_action action, args
     end
 
-    def after_process
-    end
-
     def action_missing action, args
-      info " #{socket.remote_ip} request action:  #{action} args: #{args.inspect}, action not defined"
+      info "#{headers['host']} request action: #{action} args: #{args.inspect}, action not defined"
+      raise NoMethodError, "undefined action '#{action}' for #{self}:#{self.class}"
     end
 
-    def command
-      @command || {}
+    def headers
+      handshake.headers_downcased
     end
 
     def on_close
     end
 
-    private
-    def initialize socket
-      @socket = socket
-      async.setup
-    end
+    #below are internal functions(should not been overriding)
 
-    def setup
-      init
-      info "#{socket.remote_ip} coming"
-      unless authentication
-        authentication_failed
-      else
-        after_authentication
-        async.run
-      end
+    def initialize handshake, socket
+      @handshake = handshake
+      @socket = socket
+      async.hara_setup
     end
 
-    def run
-      while msg = @socket.read
-        process msg
-        if @closed
-          terminate
-          return
-        end
-      end
-    rescue Reel::SocketError, EOFError #client disconnect
-      info "#{socket.remote_ip} disconnect"
-      begin
-        @closed = true unless @closed
-        on_close
-      ensure
-        terminate
-      end
+    def hara_setup
+      info "#{headers['host']} coming"
+      after_connect
     end
 
-    def process message
-      @command = JSON.parse(message)
-      action = @command["action"]
-      args = @command["args"]
-      info "#{socket.remote_ip} request action:  #{action} args: #{args.inspect}"
+    def process_msg message
+      action, args = Hara.decode_msg(message)
+      info "#{headers['host']} request action:  #{action} args: #{args.inspect}"
       before_action action, *args
       call_action action, *args
       after_action action, *args
-    rescue JSON::ParserError
-      info "#{socket.remote_ip} message can't parse"
-      terminate
     rescue StandardError => e
-      info "#{socket.remote_ip} processing error:\n#{e.inspect}"
+      info "#{headers['host']} processing error:\n#{e.inspect}"
       terminate
-    ensure
-      after_process
     end
 
     def call_action action, *args
       if Actions.has_key? action
-        Actions[action].bind(self).call *args
+	Actions[action].bind(self).call *args
       else
-        action_missing action, *args
+	action_missing action, *args
       end
     end
 
     def app_finalizer
-      on_close unless @closed
+      on_close
     ensure
       @socket.close if @socket
     end

data/lib/hara/base.rb

@@ -1,24 +1,3 @@
 require "hara/version"
 require 'hara/app'
-
-module Hara
-  class << self
-    def env
-      @_env ||= (ENV['APP_ENV'] || :development).to_sym
-    end
-
-    def env= env
-      @_env = env
-    end
-
-    def request_handler &blk
-      if blk
-        @_request_handler = blk
-      else
-        @_request_handler
-      end
-    end
-  end
-end
-
 require 'hara/server'

data/lib/hara/server.rb

@@ -1,42 +1,34 @@
-require 'reel'
+require 'em-websocket'
+require 'eventmachine'
 require 'hara/base'
 
 module Hara
-  class Server < Reel::Server
-    include Celluloid::Logger
+  class Server
+    class << self
+      def start host, port
+	puts "Server starting on #{host}:#{port}"
+	EM.epoll
+	EM.run {
+	  EM::WebSocket.run(host: host, port: port) do |ws|
+	  actor = nil
 
-    def initialize host, port
-      info "Server starting on #{host}:#{port}"
-      super(host, port, &method(:on_connection))
-    end
-
-    def on_connection(connection)
-      while request = connection.request
-        case request
-        when Reel::WebSocket
-          info "Received a WebSocket connection"
-          handle_websocket request
-        when Reel::Request
-          Hara.request_handler.call connection, request
-        else
-          warn "Connection not support"
-          request.close
-        end
-      end
-    end
+	  ws.onopen { |handshake|
+	    actor = Hara::Application.new handshake, ws
+	  }
 
-    Hara.request_handler do |connection, request|
-      info "#{request.remote_ip} request #{request.url}, not support"
-      request.close
-    end
-
-    def handle_websocket socket
-      Hara::Application.new socket
-    end
+	  ws.onclose { 
+	    begin
+	      actor.terminate! if actor.alive?
+	    rescue Celluloid::DeadActorError => e
+	    end
+	  }
 
-    def self.start host, port
-      self.supervise_as :hara, host, port
-      sleep
+	  ws.onmessage { |msg|
+	    actor.async.process_msg msg
+	  }
+	  end
+	}
+      end
     end
   end
 end

data/lib/hara/version.rb

@@ -1,3 +1,3 @@
 module Hara
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/app_spec.rb

@@ -3,57 +3,40 @@ require 'spec_helper'
 describe Hara::App do
   before :all do
     Class.new Hara::App do
-      def init
-        @states = []
+      def after_connect
+	@states = []
       end
 
       def before_action action, *args
-        @states << [:before_action, action, args]
+	@states << [:before_action, action, args]
       end
 
       def after_action action, *args
-        @states << [:after_action, action, args]
-      end
-
-      def after_process
-        @states << :after_process
+	@states << [:after_action, action, args]
       end
 
       def on_close
-        @states << :closed
+	@states << :closed
       end
 
       def action_missing action, *args
-        socket << [:action_missing, action, args]
+	socket.send [:action_missing, action, args]
       end
 
       define_action :hello do |msg|
-        socket << "hello#{msg}"
-      end
-
-      def authentication
-        socket.remote_ip == 'localhost'
-      end
-
-      def authentication_failed
-        @states << :fail
-        sleep 0.1
-      end
-
-      def after_authentication
-        @states << :success
-        sleep 0.1
+	socket.send "hello#{msg}"
       end
 
       def states
-        @states
+	@states
       end
     end
   end
 
   before :each do
+    @handshake = FayeHandshake.new
     @socket = FayeSocket.new
-    @socket.remote_ip = 'localhost'
+    @app = Hara::Application.new @handshake, @socket
   end
 
   after :each do
@@ -62,48 +45,32 @@ describe Hara::App do
     end
   end
 
-  it 'authentication_failed' do
-    @socket.remote_ip = '0.0.0.0'
-    @app = Hara::Application.new @socket
-    sleep 0.1 while @app.states.size == 0
-    @app.states.should == [:fail]
-  end
-
-  it 'authentication_succeeded' do
-    @app = Hara::Application.new @socket
-    sleep 0.1 while @app.states.size == 0
-    @app.states.should == [:success]
-  end
-
   it 'remote call actions' do
-    @socket.client_send({action: :hello, args: [' world']}.to_json)
-    @app = Hara::Application.new @socket
+    @app.process_msg(Hara.encode_msg(:hello, ' world'))
     sleep 0.1 until msg = @socket.client_read
     msg.should == 'hello world'
   end
 
   it 'error remote call' do
-    @socket.client_send("a error call")
-    @app = Hara::Application.new @socket
+    @app.process_msg('a error call')
     sleep 0.1 while @app.alive?
     msg = @socket.client_read
     msg.should == nil
   end
 
   it 'action_missing should work' do
-    @socket.client_send({action: :hello_world, args: ['hello', 'world']}.to_json)
-    @app = Hara::Application.new @socket
+    @app.process_msg(Hara.encode_msg(:hello_world, 'hello', 'world'))
     sleep 0.1 until msg = @socket.client_read
     msg.should == [:action_missing, 'hello_world', ['hello', 'world']]
   end
 
   it 'callbacks should work' do
-    @app = Hara::Application.new @socket
-    @socket.client_send({action: :hello, args: [' world']}.to_json)
+    2.times{ @app.process_msg(Hara.encode_msg(:hello, ' world'))}
     states = @app.states
     sleep 0.2
-    @app.halt
+    @app.terminate
     sleep 0.1 while @app.alive?
-    states.should == [:success, [:before_action, "hello", [" world"]], [:after_action, "hello", [" world"]], :after_process,:closed]
+    action_callbacks = [[:before_action, "hello", [" world"]], [:after_action, "hello", [" world"]]]
+    states.should == [*(action_callbacks * 2),:closed]
   end
 end

data/spec/hara_spec.rb

@@ -10,13 +10,11 @@ describe Hara do
     Hara.env.should == :development
   end
 
-  it 'Hara.request_handler should work' do
-    handler = Hara.request_handler
-    handler.class.should == Proc
-    Hara.request_handler do |conn, req|
-      conn + req
-    end
-    Hara.request_handler.call(40, 2).should == 42
-    Hara.request_handler &handler
+  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
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,13 @@
 require 'hara/base'
 
-require 'json'
-
 Celluloid.logger = nil
 
+class FayeHandshake
+  def headers_downcased
+    {'host' => 'localhost:8080'}
+  end
+end
+
 class FayeSocket
   attr_accessor :remote_ip
 
@@ -20,19 +24,11 @@ class FayeSocket
     @alive = false
   end
 
-  def read
-    @server_messages.shift
-  end
-
-  def << message
+  def send message
     @client_messages << message
   end
 
   def client_read
     @client_messages.shift
   end
-
-  def client_send message
-    @server_messages << message
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hara
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: reel
+  name: em-websocket
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -59,8 +75,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Hara is a simple framework, help you build [web ]socket server. Power
-  by reel and celluloid.
+description: Hara help you build async & concurrent websocket server.
 email:
 - jjyruby@gmail.com
 executables: []
@@ -107,7 +122,8 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Hara can help your build [web ]socket server easier.
+summary: In fact, hara just a combination of em-websocket and celluloid, but it really
+  help you write applications easily.
 test_files:
 - spec/app_spec.rb
 - spec/hara_spec.rb