hara 0.2.2 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f83818ae52c8a4eb9db097c057149a4b1c4078e
+  data.tar.gz: ba02fe00a42900cea3af4d7ee8a60aa74ecb31f8
+SHA512:
+  metadata.gz: 4b60a714370f02384741883e26995d5f3136166e7df01236691502b3a739510e49d0eea863e487f21711bbdb87dcfd6c2aba7300a84449119edc386ad330e7b3
+  data.tar.gz: f33ffb17c068aab2a9cb35b02b8f17a98084884e7700113474ad3d4d52f507a573e94f85964084efb15e1df4a9e0fb868f91cd2f128d7f703c8fd7d6e2e70372

data/README.md

@@ -3,13 +3,11 @@
 [![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-io & concurrent websocket server.
+Hara is a websocket based application framework, build upon [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).
-
-Seems eventmachine and celluloid work well together :smile:
+* Simple, easy to use.
+* OO, Actor model(Celluloid).
+* Event-io(em-websocket).
 
 ## Installation
 
@@ -25,26 +23,28 @@ Or install it yourself as:
 
     $ gem install hara
 
-## BasicUsage
+## Basic Usage
 
 *server*
 ```ruby
 #test.rb
 require 'hara'
 
-class Echo 
+class Echo
   include Hara::App
 
   define_action :echo do |str|
-    socket.send str
+    send_msg str
   end
 end
+
+Hara::Server.start 'localhost', '3000'
 ```
 
 *client*
 ```javascript
 var msg = JSON.stringify({action: 'echo',args:['hello world']})
-var ws = new WebSocket('ws://localhost:3210')
+var ws = new WebSocket('ws://localhost:3000')
 ws.onmessage = function(msg){alert(msg.data)}
 
 //after a while
@@ -60,11 +60,11 @@ ws.send(msg)
 ## Full Usages
 
 ```ruby
-require 'hara/base'
+require 'hara'
 
-class Echo 
-  #include Hara::App, make you Echo class become Celluloid::Actor,
-  # and per actor handle a socket
+class Echo
+  #include Hara::App make your Echo class become Celluloid::Actor,
+  #hara use actor per connection
   include Hara::App
 
   #Hara::App provide some callbacks
@@ -80,8 +80,8 @@ class Echo
 
   define_action :echo do |str|
     puts "#{client_ip} #{client_port}"
-    #send message to socket
-    socket.send str
+    #send message to client
+    send_msg str
   end
 
   define_action :exit do
@@ -95,7 +95,7 @@ class Echo
   end
 
   def action_missing action, *args
-    socket.send 'error'
+    send_msg 'error'
     super
   end
 
@@ -104,7 +104,34 @@ class Echo
   end
 end
 
-#if you require 'hara/base' you need start server you self, like below
+# you can pass some options to start
+server_options = {
+#...some options, same as EM::Websocket.run
+}
+Hara::Server.start 'localhost', '3000', server_options
+
+
+# Hara::Filter
+# Filter can help you filter some connections before dispatched to app actor.
+# Example: use Filter to authentication
+require 'cgi/cookie'
+
+class Echo
+  include Hara::App
+#..some code
+end
+
+#class name is not matter
+class Authentication
+  include Hara::Filter
+
+  # You must implement filter method, return value should be ture or false
+  def filter
+    # You can use some helper methods(headers, client_ip, send_msg...), just like Hara::App
+    CGI::Cookie.parse(headers['cookie'])['foo'] == ['bar']
+  end
+end
+
 Hara::Server.start 'localhost', '3000'
 ```
 

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 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.description   = %q{Hara is a websocket based application framework.}
+  spec.summary       = %q{Hara build upon em-websocket, easy to use.}
   spec.homepage      = "http://github.com/jjyr/hara"
   spec.license       = "MIT"
 
@@ -19,8 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
 
-  spec.add_dependency "em-websocket", "~> 0.5.0"
-  spec.add_dependency "celluloid", "~> 0.14.1"
+  spec.add_dependency "em-websocket", ">= 0.5.0"
+  spec.add_dependency "eventmachine"
+  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,52 +1,32 @@
-require "hara/version"
+require 'hara/client_interaction'
 require 'celluloid'
 require 'socket'
 require 'json'
 
 module Hara
-  class << self
-    def env
-      @_env ||= (ENV['APP_ENV'] || :development).to_sym
-    end
-
-    def env= env
-      @_env = env
-    end
-
-    #decode message, return action and args
-    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
-
   module App
-    attr_reader :socket, :handshake, :client_ip, :client_port
+    include ClientInteraction
 
     Actions = {}
 
     class << self
       def included klass
-	klass.send :include, Celluloid
-	klass.send :include, Celluloid::Logger
-	klass.send :finalizer, :app_finalizer
-	klass.send :extend, ClassMethods
-	::Hara.const_set :Application, klass
+        klass.send :include, Celluloid
+        klass.send :include, Celluloid::Logger
+        klass.send :finalizer, :app_finalizer
+        klass.send :extend, ClassMethods
+        ::Hara.const_set :Application, klass
       end
     end
 
     module ClassMethods
       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
 
@@ -72,22 +52,10 @@ module Hara
       raise NoMethodError, "undefined action '#{action}' for #{self}:#{self.class}"
     end
 
-    #get client headers
-    def headers
-      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
-      @handshake = handshake
-      @socket = socket
-      @client_port, @client_ip = Socket.unpack_sockaddr_in(socket.get_peername) #to get ip address of user
+      socket_setup handshake, socket
       async.hara_setup
     end
 
@@ -109,9 +77,9 @@ module Hara
 
     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
 

data/lib/hara/client_interaction.rb

@@ -0,0 +1,26 @@
+module Hara
+  module ClientInteraction
+    attr_reader :socket, :handshake, :client_ip, :client_port
+
+    def socket_setup handshake, socket
+      @handshake = handshake
+      @socket = socket
+      @client_port, @client_ip = Socket.unpack_sockaddr_in(socket.get_peername) #to get ip address of user
+    end
+
+    # get client headers
+    def headers
+      handshake.headers_downcased
+    end
+
+    # send msg to client
+    def send_msg msg
+      socket.send msg
+    end
+
+    # close connection
+    def close code = nil, body = nil
+      @socket.close code, body
+    end
+  end
+end

data/lib/hara/default_filter.rb

@@ -0,0 +1,9 @@
+require 'hara/filter'
+
+class DefaultFilter
+  include Hara::Filter
+
+  def filter
+    true
+  end
+end

data/lib/hara/filter.rb

@@ -0,0 +1,60 @@
+require 'celluloid'
+require 'hara/client_interaction'
+
+module Hara
+  module Filter
+    include ClientInteraction
+
+    class << self
+      def included klass
+        klass.send :include, Celluloid
+        klass.send :include, Celluloid::Logger
+        Hara.filter_class = klass
+        klass.send :extend, ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def pool_size= size
+        Hara.filter_pool_size = size
+      end
+
+      def pool_size
+        Hara.filter_pool_size
+      end
+    end
+
+    def setup_socket_callbacks handshake, ws
+      actor = Hara::Application.new handshake, ws
+
+      ws.onclose { |close_info = {}|
+        begin
+          actor.async.set_close_info close_info
+          actor.terminate! if actor.alive?
+        rescue Celluloid::DeadActorError => e
+        end
+      }
+
+      ws.onmessage { |msg|
+        actor.async.process_msg msg
+      }
+    end
+
+    def run_filter handshake, socket
+      exclusive do
+        socket_setup handshake, socket
+        pass = self.filter
+        if pass
+          setup_socket_callbacks handshake, socket
+        else
+          close
+        end
+      end
+    end
+
+    # you should implement this method and return true or false
+    def filter
+      raise NotImplementedError, 'You must implement method filter, return value can be true or false.'
+    end
+  end
+end

data/lib/hara/server.rb

@@ -1,34 +1,22 @@
 require 'em-websocket'
 require 'eventmachine'
-require 'hara/base'
 
 module Hara
   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 start host, port, options = {}
+        puts "Server starting on #{host}:#{port}"
+        options = options.merge(host: host, port: port)
+        EM.epoll
+        EM.run do
 
-	  ws.onopen { |handshake|
-	    actor = Hara::Application.new handshake, ws
-	  }
+          EM::WebSocket.run(options) do |ws|
+            ws.onopen { |handshake|
+              Hara.filter_pool.async.run_filter handshake, ws
+            }
+          end
 
-	  ws.onclose {|close_info = {}|
-	    begin
-	      actor.async.set_close_info close_info
-	      actor.terminate! if actor.alive?
-	    rescue Celluloid::DeadActorError => e
-	    end
-	  }
-
-	  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.2.2"
+  VERSION = "0.3.0"
 end

data/lib/hara.rb

@@ -1,2 +1,40 @@
-require 'hara/base'
-require 'hara/main'
+require "hara/version"
+
+module Hara
+  class << self
+    #decode message, return action and args
+    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
+
+    def filter_class
+      @filter_class || DefaultFilter
+    end
+
+    def filter_class= klass
+      @filter_class = klass
+    end
+
+    def filter_pool_size= size
+      @filter_pool_size = size
+    end
+
+    def filter_pool_size
+      @filter_pool_size || 10
+    end
+
+    def filter_pool
+      @filter_pool ||= filter_class.pool(size: filter_pool_size)
+    end
+  end
+end
+
+require 'hara/app'
+require 'hara/filter'
+require 'hara/default_filter'
+require 'hara/server'

data/spec/app_spec.rb

@@ -6,35 +6,35 @@ describe Hara::App do
       include Hara::App
 
       def after_connect
-	@states = []
+        @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]
+        @states << [:after_action, action, args]
       end
 
       def on_close close_info
-	@states << :closed
+        @states << :closed
       end
 
       def action_missing action, *args
-	socket.send [:action_missing, action, args]
+        send_msg [:action_missing, action, args]
       end
 
       define_action :hello do |msg|
-	socket.send "hello#{msg}"
+        send_msg "hello#{msg}"
       end
 
       define_action :exit do
-	close 3333, "Bye"
+        close 3333, "Bye"
       end
 
       def states
-	@states
+        @states
       end
     end
   end

data/spec/filter_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Hara::Filter do
+  before :all do
+    @filter = Class.new do
+      include Hara::Filter
+      self.pool_size = 3
+
+      def filter
+        socket.remote_ip == 'localhost'
+      end
+    end
+  end
+
+  it 'Hara.filter_class should be set' do
+    Hara.filter_class.should == @filter
+  end
+
+  it 'Hara.filter_pool_size should be set' do
+    Hara.filter_pool_size.should == 3
+  end
+
+  it 'Hara.filter_pool should work' do
+    wait_until{Hara.filter_pool}
+    Hara.filter_pool.nil?.should == false
+  end
+
+  describe 'filter' do
+    before :each do
+      @handshake = FayeHandshake.new
+      @socket = FayeSocket.new
+      @socket.alive = true
+      wait_until{Hara.filter_pool}
+    end
+
+    it 'filter should close socket if not pass' do
+      @socket.remote_ip = '127.0.0.1'
+      Hara.filter_pool.run_filter @handshake, @socket
+      wait_until{!@socket.alive?}
+      @socket.alive?.should == false
+    end
+
+    it 'filter should set callbacks on socket if pass' do
+      @socket.remote_ip = 'localhost'
+      Hara.filter_pool.run_filter @handshake, @socket
+      wait_until{@socket.onclose_block}
+      @socket.onmessage_block.should.is_a? Proc
+      @socket.onclose_block.should.is_a? Proc
+    end
+  end
+end

data/spec/hara_spec.rb

@@ -8,10 +8,6 @@ describe Hara do
     App.should == Hara::Application
   end
 
-  it 'Hara.env should be development' do
-    Hara.env.should == :development
-  end
-
   it 'Hara.encode_msg & decode_msg should work' do
     action = 'hello_world'
     args = ['hello', 'world']

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'hara/base'
+require 'hara'
 
 Celluloid.logger = nil
 
@@ -33,6 +33,10 @@ class FayeSocket
     defined?(JRuby) ? @jruby_peername : @mri_peername
   end
 
+  def alive= alive
+    @alive = alive
+  end
+
   def alive?
     @alive
   end
@@ -41,7 +45,7 @@ class FayeSocket
     if @alive
       @close_info = [code, body]
       @alive = false
-      @app.terminate!
+      @app.terminate! if @app
     end
   end
 
@@ -52,4 +56,12 @@ class FayeSocket
   def client_read
     @client_messages.shift
   end
+
+  [:onclose, :onmessage, :onopen].each do |method|
+    attribute = "#{method}_block".to_sym
+    attr_accessor attribute
+    define_method method do |&blk|
+      __send__ "#{attribute}=", blk
+    end
+  end
 end

metadata

@@ -1,52 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: hara
 version: !ruby/object:Gem::Version
-  version: 0.2.2
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - jjy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-websocket
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '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
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,20 +69,18 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Hara help you build async-io & concurrent websocket server.
+description: Hara is a websocket based application framework.
 email:
 - jjyruby@gmail.com
 executables: []
@@ -91,40 +96,41 @@ files:
 - hara.gemspec
 - lib/hara.rb
 - lib/hara/app.rb
-- lib/hara/base.rb
-- lib/hara/main.rb
+- lib/hara/client_interaction.rb
+- lib/hara/default_filter.rb
+- lib/hara/filter.rb
 - lib/hara/server.rb
 - lib/hara/version.rb
 - spec/app_spec.rb
+- spec/filter_spec.rb
 - spec/hara_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/jjyr/hara
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
-summary: In fact, hara just a combination of em-websocket and celluloid, but it really
-  help you write applications easily.
+specification_version: 4
+summary: Hara build upon em-websocket, easy to use.
 test_files:
 - spec/app_spec.rb
+- spec/filter_spec.rb
 - spec/hara_spec.rb
 - spec/spec_helper.rb

data/lib/hara/base.rb

@@ -1,3 +0,0 @@
-require "hara/version"
-require 'hara/app'
-require 'hara/server'

data/lib/hara/main.rb

@@ -1,15 +0,0 @@
-require 'hara/base'
-
-start_options = {host: 'localhost', port: 3210}
-
-#like sinatra..
-if ARGV.any?
-  require 'optparse'
-  OptionParser.new { |op|
-    op.on('-p port',   "set the port (default is #{start_options[:port]})") { |val| start_options[:port] = val.to_i }
-    op.on('-o addr',   "set the host (default is #{start_options[:host]})") { |val| srart_options[:host] = val }
-    op.on('-e env',    'set the environment (default is development)')  { |val| Hara.env = val.to_sym }
-  }.parse!(ARGV.dup)
-end
-
-at_exit { Hara::Server.start(start_options[:host], start_options[:port]) if $!.nil? }