em-nodes 0.2.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe922a1ce046c59c80d0e07fef0231bf5fa01e61
-  data.tar.gz: 1779d2eae2c85475290ff25dd6c885da0bffc3df
+  metadata.gz: f1363157af5191aec0b3766f90bbea6f6f796774
+  data.tar.gz: c62062bed18a240bedb582f7181496b7801d278c
 SHA512:
-  metadata.gz: b654c62869647ee287a5b5e15627020ef2512aafa72db19d18e9eb13e9f8260bbd1959449e5af292fb65e290835b45cab86299edbd1cd743b8e3898805b531d3
-  data.tar.gz: 571c7a47c76818db7fabfd20c106290bdf6237937da0e5e97d6538e34aaefdcaf34313cfd2706dd75ed20fa21e02364a4985f184d5a87f43ae7314037c835fce
+  metadata.gz: de60f8921cce94868c95f6e9206dad695473f6d511f7e185d03ec401cb63fd39823e9edcdd332f3f77e3ae0cde15caad567ca08f02a5c6e54a7b8e274678d54f
+  data.tar.gz: 109ee1213f2002c4fe8fa21839386c971e7e4743c9294cd68525682329786f86b7a76370f2d450099a3c9db2898fa5591ca78a8ec17f9f8d29bbce9bf8d50c93

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 *.log
+.todo

data/README.md

@@ -1,6 +1,6 @@
 # EM::Nodes
 
-Simple EM client server, and some stuffs
+Simple abstraction on top of EventMachine for easy create clients, servers, workers, ...
 
 ## Installation
 
@@ -8,3 +8,179 @@ Add this line to your application's Gemfile:
 
     gem 'em-nodes'
 
+### How to use
+
+Client should inherit from EM::Nodes::Client, Server should inherit from EM::Nodes::Server.
+Client and Server can define and use methods `on_#{method_name}` and `send_#{method_name}`, `on_#{method_name}` - receive value from `send_#{method_name}` call.
+
+Example: client after connection to server, send i_connected to server, server send_client_request, client on_client_request send to server client_responce, and server output value.
+
+simple_server.rb
+```ruby
+class Server < EM::Nodes::Server
+  def on_i_connected(value)
+    puts "#{value} connected"
+    send_client_request(1)
+  end
+
+  def on_client_responce(value)
+    puts "client responce #{value}"
+  end
+end
+
+EM.run do
+  Server.start "/tmp/server.sock"
+end
+```
+
+simple_client.rb
+```ruby
+class Client < EM::Nodes::Client
+  def on_client_request(value)
+    send_client_responce(value + 1)
+  end
+end
+
+EM.run do
+  client = Client.connect "/tmp/server.sock"
+  client.send_i_connected("hahaha")
+end
+```
+
+### HelloFeature
+
+HelloFeature used to simple greetings between client and server. Client should define method `info` which return hash. Server had added method: `ready_clients`, which contain clients which answered on `info` method.
+
+hello_server.rb
+```ruby
+class Server < EM::Nodes::Server
+  include HelloFeature
+end
+
+EM.run do
+  Server.start "/tmp/server.sock"
+
+  EM.add_periodic_timer(5) do
+    vasya = Server.ready_clients.detect { |client| client.data.my_name == 'Vasya' }
+    vasya.send_die if vasya
+  end
+end
+```
+
+hello_client.rb
+```ruby
+class Client < EM::Nodes::Client
+  include HelloFeature
+
+  def initialize(name)
+    @name = name
+    super
+  end
+
+  def info
+    { :my_name => @name }
+  end
+
+  def on_die
+    puts "oops i should die"
+    EM.stop
+  end
+end
+
+EM.run do
+  client = Client.connect "/tmp/server.sock", nil, "Vasya"
+end
+```
+
+### TaskFeature
+
+TaskFeature is simple task sending, executing and getting results. Client should define method `on_task(task_id, param)`, and when execute task and got results, should call `send_task_result(task_id, result)`. Server should send task with method, `send_task(param)`
+
+Example: Client after connection send to server `get_me_task`, server send_task to client with rand value, client execute `on_task` method and add to param 1 and call `send_task_result`, server receive `on_task_result` and output result.
+
+task_server.rb
+```ruby
+class Server < EM::Nodes::Server
+  include TaskFeature
+
+  def on_get_me_task
+    param = rand
+    puts "send to client #{param}"
+    send_task(param)
+  end
+
+  def on_task_result(result)
+    puts "client return result #{result}"
+  end
+end
+
+EM.run do
+  Server.start "/tmp/server.sock"
+end
+```
+
+task_client.rb
+```ruby
+class Client < EM::Nodes::Client
+  include TaskFeature
+
+  def on_task(task_id, param)
+    EM.next_tick { send_task_result(task_id, param + 1) }
+  end
+end
+
+EM.run do
+  client = Client.connect "/tmp/server.sock"
+  client.send_get_me_task
+end
+```
+
+### DefaultClient, DefaultServer
+
+This is abstraction with HelloFeature and TaskFeature by default. Example how to create server and 10 workers. Server schedule for each client every 1 second, some value. Client just add 1 to value and return result to server, server puts value.
+
+default_server.rb
+```ruby
+class Server < EM::Nodes::DefaultServer
+  def on_task_result(res)
+    puts res
+  end
+end
+
+EM.run do
+  Server.start "127.0.0.1", 8888
+
+  # periodical schedule tasks to clients
+  EM.add_periodic_timer(1) do
+    Server.ready_clients.each do |client|
+      client.send_task(rand)
+    end
+  end
+end
+```
+
+default_client.rb
+```ruby
+class Client < EM::Nodes::DefaultClient
+  def info
+    { :name => 'bla' }
+  end
+
+  def on_task(task_id, param)
+    res = do_something(param)
+    send_task_result(task_id, res)
+  end
+
+  def do_something(x)
+    x + 1
+  end
+end
+
+EM.run do
+  10.times do
+    Client.connect "127.0.0.1", 8888
+  end
+end
+```
+
+[More examples](https://github.com/kostya/em-nodes/tree/master/examples)

data/benchmark/client.rb

@@ -14,5 +14,7 @@ end
 
 EM.run do
   puts "client run"
-  Client.connect '/tmp/test_em_nodes_sock'
+  EM.add_timer(0.1) do
+    Client.connect '/tmp/test_em_nodes_sock'
+  end
 end

data/em-nodes.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = EventMachine::Nodes::VERSION
   spec.authors       = ["'Konstantin Makarchev'"]
   spec.email         = ["'kostya27@gmail.com'"]
-  spec.summary       = %q{Simple EM client server, and some stuffs}
-  spec.description   = %q{Simple EM client server, and some stuffs}
+  spec.summary       = %q{Simple abstraction on top of EventMachine for easy create clients, servers, workers, ...}
+  spec.description   = %q{Simple abstraction on top of EventMachine for easy create clients, servers, workers, ...}
   spec.homepage      = "https://github.com/kostya/em-nodes"
   spec.license       = "MIT"
 

data/examples/default_client.rb

@@ -0,0 +1,28 @@
+require 'bundler/setup'
+Bundler.require
+require 'logger'
+
+l = Logger.new(STDOUT)
+l.level = Logger::INFO
+EM::Nodes.logger = l
+
+class Client < EM::Nodes::DefaultClient
+  def info
+    { :name => 'bla' }
+  end
+
+  def on_task(task_id, param)
+    res = do_something(param)
+    send_task_result(task_id, res)
+  end
+
+  def do_something(x)
+    x + 1
+  end
+end
+
+EM.run do
+  10.times do
+    Client.connect "127.0.0.1", 8888
+  end
+end

data/examples/default_server.rb

@@ -0,0 +1,24 @@
+require 'bundler/setup'
+Bundler.require
+require 'logger'
+
+l = Logger.new(STDOUT)
+l.level = Logger::INFO
+EM::Nodes.logger = l
+
+class Server < EM::Nodes::DefaultServer
+  def on_task_result(res)
+    puts res
+  end
+end
+
+EM.run do
+  Server.start "127.0.0.1", 8888
+
+  # periodical schedule tasks to clients
+  EM.add_periodic_timer(1) do
+    Server.ready_clients.each do |client|
+      client.send_task(rand)
+    end
+  end
+end

data/examples/hello_client.rb

@@ -0,0 +1,29 @@
+require 'bundler/setup'
+Bundler.require
+require 'logger'
+
+l = Logger.new(STDOUT)
+l.level = Logger::INFO
+EM::Nodes.logger = l
+
+class Client < EM::Nodes::Client
+  include HelloFeature
+
+  def initialize(name)
+    @name = name
+    super
+  end
+
+  def info
+    { :my_name => @name }
+  end
+
+  def on_die
+  	puts "oops i should die"
+    EM.stop
+  end
+end
+
+EM.run do
+  client = Client.connect "/tmp/server.sock", nil, "Vasya"
+end

data/examples/hello_server.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+Bundler.require
+require 'logger'
+
+l = Logger.new(STDOUT)
+l.level = Logger::INFO
+EM::Nodes.logger = l
+
+class Server < EM::Nodes::Server
+  include HelloFeature
+end
+
+EM.run do
+  Server.start "/tmp/server.sock"
+
+  EM.add_periodic_timer(5) do
+    vasya = Server.ready_clients.detect { |client| client.data.my_name == 'Vasya' }
+    vasya.send_die if vasya
+  end
+end

data/examples/simple_client.rb

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+Bundler.require
+require 'logger'
+
+l = Logger.new(STDOUT)
+l.level = Logger::INFO
+EM::Nodes.logger = l
+
+class Client < EM::Nodes::Client
+  def on_server_request(value)
+  	puts "server send #{value}"
+    send_client_responce(value + 1)
+  end
+end
+
+EM.run do
+  client = Client.connect "/tmp/server.sock"
+  client.send_i_connected("hahaha")
+end

data/examples/simple_server.rb

@@ -0,0 +1,22 @@
+require 'bundler/setup'
+Bundler.require
+require 'logger'
+
+l = Logger.new(STDOUT)
+l.level = Logger::INFO
+EM::Nodes.logger = l
+
+class Server < EM::Nodes::Server
+  def on_i_connected(value)
+    puts "#{value} connected"
+    send_server_request(1)
+  end
+
+  def on_client_responce(value)
+    puts "client responce #{value}"
+  end
+end
+
+EM.run do
+  Server.start "/tmp/server.sock"
+end

data/examples/task_client.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+Bundler.require
+require 'logger'
+
+l = Logger.new(STDOUT)
+l.level = Logger::INFO
+EM::Nodes.logger = l
+
+class Client < EM::Nodes::Client
+  include TaskFeature
+
+  def on_task(task_id, param)
+    EM.next_tick { send_task_result(task_id, param + 1) }
+  end
+end
+
+EM.run do
+  client = Client.connect "/tmp/server.sock"
+  client.send_get_me_task
+end

data/examples/task_server.rb

@@ -0,0 +1,25 @@
+require 'bundler/setup'
+Bundler.require
+require 'logger'
+
+l = Logger.new(STDOUT)
+l.level = Logger::INFO
+EM::Nodes.logger = l
+
+class Server < EM::Nodes::Server
+  include TaskFeature
+
+  def on_get_me_task
+    param = rand
+    puts "send to client #{param}"
+    send_task(param)
+  end
+
+  def on_task_result(result)
+    puts "client return result #{result}"
+  end
+end
+
+EM.run do
+  Server.start "/tmp/server.sock"
+end

data/lib/em-nodes/client.rb

@@ -17,7 +17,7 @@ class EM::Nodes::Client < EM::Connection
   end
 
   def self.connect(host, port = nil, *args, &block)
-    EM::Nodes.logger.info { "Connecting to server #{host}:#{port}" }
+    EM::Nodes.logger.info { "Connecting to server #{host}#{port ? ':' + port.to_s : nil}" }
     EM.connect(host, port, self, *args)
   end
 end

data/lib/em-nodes/server.rb

@@ -37,6 +37,7 @@ class EM::Nodes::Server < EM::Connection
     self.comm_inactivity_timeout = inactivity_timeout if EM.reactor_running?
 
     port, host = Socket.unpack_sockaddr_in(get_peername) rescue []
+    host = Socket.unpack_sockaddr_un(get_sockname) unless host
     unless accept?(host, port)
       unbind
       return
@@ -57,7 +58,7 @@ class EM::Nodes::Server < EM::Connection
   end
 
   def self.start(host, port = nil, *args)
-    EM::Nodes.logger.info { "Start server #{host}:#{port}" }
+    EM::Nodes.logger.info { "Start server #{host}#{port ? ':' + port.to_s : nil}" }
     EM.start_server host, port, self, *args
   end
 end

data/lib/em-nodes/version.rb

@@ -2,5 +2,5 @@ module EventMachine
 end
 
 module EventMachine::Nodes
-  VERSION = "0.2.4"
+  VERSION = "0.5"
 end

data/lib/em-nodes.rb

@@ -1,6 +1,7 @@
 require 'eventmachine'
 require 'logger'
 require 'em-nodes/em_hacks'
+require 'em-nodes/version'
 
 module EM::Nodes
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: em-nodes
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: '0.5'
 platform: ruby
 authors:
 - "'Konstantin Makarchev'"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -66,7 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple EM client server, and some stuffs
+description: Simple abstraction on top of EventMachine for easy create clients, servers,
+  workers, ...
 email:
 - "'kostya27@gmail.com'"
 executables: []
@@ -88,6 +89,14 @@ files:
 - em-nodes.gemspec
 - examples/chat_client.rb
 - examples/chat_server.rb
+- examples/default_client.rb
+- examples/default_server.rb
+- examples/hello_client.rb
+- examples/hello_server.rb
+- examples/simple_client.rb
+- examples/simple_server.rb
+- examples/task_client.rb
+- examples/task_server.rb
 - examples/work_client.rb
 - examples/work_server.rb
 - lib/em-nodes.rb
@@ -133,7 +142,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Simple EM client server, and some stuffs
+summary: Simple abstraction on top of EventMachine for easy create clients, servers,
+  workers, ...
 test_files:
 - spec/base_spec.rb
 - spec/hello_spec.rb