hara 0.2.0 → 0.2.1

data/.travis.yml

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

data/README.md

@@ -9,11 +9,7 @@ Hara's async ability from [em-websocket](https://github.com/igrigorik/em-websock
 
 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!!
-
-Current API is unstable, you should lock the version.
+Yes, hara is a combination of them, eventmachine and celluloid work well together :)
 
 ## Installation
 
@@ -29,14 +25,16 @@ Or install it yourself as:
 
     $ gem install hara
 
-## Usage
+## BasicUsage
 
 *server*
 ```ruby
 #test.rb
 require 'hara'
 
-class Echo < Hara::App
+class Echo 
+  include Hara::App
+
   define_action :echo do |str|
     socket.send str
   end
@@ -59,9 +57,43 @@ ws.send(msg)
 
 `ruby test.rb -h` to view options
 
-*Other Usage*
+## Other Usages & How it work
+
+```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
+
+  #Hara::App provide some callbacks
+
+  def after_connect
+    puts 'first called'
+    p headers
+  end
+
+  def before_action action, *args
+    puts 'called when action comming'
+  end
+
+  define_action :echo do |str|
+    puts "#{client_ip} #{client_port}"
+    socket.send str
+  end
+
+  def after_action action, *args
+    puts 'called when action complete'
+  end
+end
+
+#if you require 'hara/base' you need start server you self, like below
+Hara::Server.start 'localhost', '3000'
+```
+
+## RoadMap
 
-checkout tests
+js client is processing
 
 ## Contributing
 

data/lib/hara/app.rb

@@ -1,5 +1,6 @@
 require "hara/version"
 require 'celluloid'
+require 'socket'
 require 'json'
 
 module Hara
@@ -12,6 +13,7 @@ module Hara
       @_env = env
     end
 
+    #decode message, return action and args
     def decode_msg msg
       msg = JSON.parse(msg)
       msg.values_at 'action', 'args'
@@ -22,21 +24,22 @@ module Hara
     end
   end
 
-  class App
-    include Celluloid
-    include Celluloid::Logger
-
-    attr_reader :socket, :handshake
-
-    finalizer :app_finalizer
+  module App
+    attr_reader :socket, :handshake, :client_ip, :client_port
 
     Actions = {}
 
     class << self
-      def inherited klass
+      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
       end
+    end
 
+    module ClassMethods
       def define_action action, &block
 	action = action.to_s
 	warn "Action #{action} duplication defined" if Actions.has_key? action
@@ -47,6 +50,8 @@ module Hara
       end
     end
 
+    ##callback methods
+
     def after_connect
     end
 
@@ -56,39 +61,44 @@ module Hara
     def after_action action, args
     end
 
+    def on_close
+    end
+
+    ##################
+
+    #like method_missing
     def action_missing action, args
-      info "#{headers['host']} request action: #{action} args: #{args.inspect}, action not defined"
+      info "#{client_ip} request action: #{action} args: #{args.inspect}, action not defined"
       raise NoMethodError, "undefined action '#{action}' for #{self}:#{self.class}"
     end
 
+    #get client headers
     def headers
       handshake.headers_downcased
     end
 
-    def on_close
-    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
       async.hara_setup
     end
 
     def hara_setup
-      info "#{headers['host']} coming"
+      info "#{client_ip} coming"
       after_connect
     end
 
     def process_msg message
       action, args = Hara.decode_msg(message)
-      info "#{headers['host']} request action:  #{action} args: #{args.inspect}"
+      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 "#{headers['host']} processing error:\n#{e.inspect}"
+      info "#{client_ip} processing error:\n#{e.inspect}"
       terminate
     end
 

data/lib/hara/version.rb

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

data/spec/app_spec.rb

@@ -2,7 +2,9 @@ require 'spec_helper'
 
 describe Hara::App do
   before :all do
-    Class.new Hara::App do
+    Class.new do
+      include Hara::App
+
       def after_connect
 	@states = []
       end
@@ -45,6 +47,12 @@ describe Hara::App do
     end
   end
 
+  it 'client_infos' do
+    @app.client_ip.should == '127.0.0.1'
+    @app.client_port.should.is_a? Integer
+    @app.headers.should.is_a? Hash
+  end
+
   it 'remote call actions' do
     @app.process_msg(Hara.encode_msg(:hello, ' world'))
     sleep 0.1 until msg = @socket.client_read

data/spec/hara_spec.rb

@@ -2,7 +2,9 @@ require 'spec_helper'
 
 describe Hara do
   it 'Hara::Application should equal with App' do
-    App = Class.new Hara::App
+    App = Class.new do
+      include Hara::App
+    end
     App.should == Hara::Application
   end
 

data/spec/spec_helper.rb

@@ -14,6 +14,12 @@ class FayeSocket
   def initialize
     @client_messages = []
     @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"
+  end
+
+  def get_peername
+    defined?(JRuby) ? @jruby_peername : @mri_peername
   end
 
   def alive?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hara
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors: