actory 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f849624dcbf73cd2426caf250797b3c337004180
+  data.tar.gz: 6dd0edf66c46fc3e2d918b9a2c7b777c24e6aae0
+SHA512:
+  metadata.gz: 0417891112886283844180fcf39a4813b0de016a175501e509c07522eda80de1fbb5b054d171a5485db725eb674bafd5d87229747aa11b3521752b9eb63505ba
+  data.tar.gz: 981b151264135f1094bc622b7f28e0103fd17fbebb8bdf6a2731e2a4bb8691f9be949fe47d3183cabb6bb1d6cfa520a736d42f48ac989cdb5a1f758be11eec7c

data/.gitignore

@@ -0,0 +1,4 @@
+receiver.yml
+sender.yml
+*.log*
+/tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'msgpack-rpc'
+gem 'parallel'
+gem 'facter'
+gem 'progressbar'

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,361 @@
+actory
+======
+
+Actor model like, concurrent and distributed framework for Ruby.
+
+## Installation
+
+`````
+gem install actory
+`````
+
+## Setup
+
+`````
+path_to_actory="/PATH/TO/GEMS/actory-0.0.1"
+export PATH=$PATH:$path_to_actory/bin
+`````
+
+* /PATH/TO/GEMS above means the path to the directory of gem files. e.g. $HOME/.rvm/gems/ruby-2.0.0-p247@global/gems
+
+### System-wide setup with the root permission
+
+`````
+sudo mkdir -p /etc/actory
+sudo cp -p $path_to_actory/config/receiver.yml.example /etc/actory
+sudo cp -p $path_to_actory/config/sender.yml.example /etc/actory
+`````
+
+### System-wide setup under the RubyGems
+
+`````
+cd $path_to_actory/config
+cp receiver.yml.example receiver.yml
+cp sender.yml.example sender.yml
+sed -i '' "s/\/etc\/actory/\.\.\/\.\.\/\.\.\/config/g" global.yml
+`````
+
+### Setup inside of each indivisual project
+
+`````
+echo "gem actory" >> Gemfile
+bundle install --path vendor/bundle
+cp ./vendor/bundle
+path_to_actory="vendor/bundle/ruby/2.0.0/gems/actory-0.0.1"
+cp $path_to_actory/config/receiver.yml.example $path_to_actory/config/receiver.yml
+cp $path_to_actory/config/sender.yml.example $path_to_actory/config/sender.yml
+sed -i '' "s/\/etc\/actory/\.\.\/\.\.\/\.\.\/config/g" $path_to_actory/config/global.yml
+`````
+
+
+## Architecture
+
+* Actor model like message passing API
+* Dynamically loaded plugins
+* High concurrency
+* Low overheads
+
+### System-wide
+
+#### Sending a message to each receiver to make it deal with the message.
+
+`````
+  +--------+
+  |user app|
+  +--------+
+    | message(method, [args]) # [args].size # => i
+    v
+  +------------------+
+  |Sender::Dispatcher|
+  +------------------+
+    |                                                           execute
+    |   +----------------+ msgpack-rpc +----------------------+ method(arg[0]) +----------------+
+    +-->|sub-process #1/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
+    |   +----------------+             +----------------------+ execute        +----------------+
+    |   +----------------+             +----------------------+ method(arg[1]) +----------------+
+    +-->|sub-process #2/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
+    |   +----------------+             +----------------------+       :        +----------------+
+    |         :                                 :               execute                :
+    |   +----------------+             +----------------------+ method(arg[i]) +----------------+
+    `-->|sub-process #n/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
+        +----------------+             +----------------------+                +----------------+
+`````
+
+#### Receiving each returned value at once.
+
+`````
+  +--------+
+  |user app|
+  +--------+
+    ^ a hash value in {"host:port" => [return_value(s), ...], ... }
+    |
+  +------------------+
+  |Sender::Dispatcher|
+  +------------------+
+    ^                                                              return
+    |   +----------------+ msgpack-rpc +----------------------+   value(s)   +----------------+
+    +---|sub-process #1/n|<------------|Receiver::EventHandler|<-------------|Receiver::Plugin|
+    |   +----------------+             +----------------------+              +----------------+
+    |   +----------------+             +----------------------+              +----------------+
+    +---|sub-process #2/n|<------------|Receiver::EventHandler|<-------------|Receiver::Plugin|
+    |   +----------------+             +----------------------+              +----------------+
+    |         :                                 :                                     :
+    |   +----------------+             +----------------------+              +----------------+
+    `---|sub-process #n/n|<------------|Receiver::EventHandler|<-------------|Receiver::Plugin|
+        +----------------+             +----------------------+              +----------------+
+`````
+
+#### Jobs can be assigned flexibly.
+
+`````
+  +--------+
+  |user app|
+  +--------+
+    | message(method, [args]) # [args].size # => i; i > n # => true
+    v
+  +------------------+
+  |Sender::Dispatcher|
+  +------------------+
+    |                                                           execute
+    |   +----------------+ msgpack-rpc +----------------------+ method(arg[0])   +----------------+
+    +-->|sub-process #1/n|------------>|Receiver::EventHandler|----------------->|Receiver::Plugin|
+    |   |                |             +----------------------+ execute          +----------------+
+    |   |                |             +----------------------+ method(arg[i])   +----------------+
+    +-->|                |------------>|Receiver::EventHandler|----------------->|Receiver::Plugin|
+    |   +----------------+             +----------------------+ execute          +----------------+
+    |   +----------------+             +----------------------+ method(arg[1])   +----------------+
+    +-->|sub-process #2/n|------------>|Receiver::EventHandler|----------------->|Receiver::Plugin|
+    |   +----------------+             +----------------------+       :          +----------------+
+    |         :                                 :               execute                   :
+    |   +----------------+             +----------------------+ method(arg[i-1]) +----------------+
+    `-->|sub-process #n/n|------------>|Receiver::EventHandler|----------------->|Receiver::Plugin|
+        +----------------+             +----------------------+                  +----------------+
+`````
+
+`````
+  +--------+
+  |user app|
+  +--------+
+    | message(method, [args]) # [args].size # => i; n > i # => true
+    v
+  +------------------+
+  |Sender::Dispatcher|
+  +------------------+
+    |                                                           execute
+    |   +----------------+ msgpack-rpc +----------------------+ method(arg[0]) +----------------+
+    +-->|sub-process #1/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
+    |   +----------------+             +----------------------+ execute        +----------------+
+    |   +----------------+             +----------------------+ method(arg[i]) +----------------+
+    `-->|sub-process #2/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
+        +----------------+             +----------------------+                +----------------+
+              :                                 :                                       :
+        +----------------+             +----------------------+                +----------------+
+        |sub-process #n/n|             |Receiver::EventHandler|                |Receiver::Plugin|
+        +----------------+             +----------------------+                +----------------+
+`````
+
+`````
+  +--------+
+  |user app|
+  +--------+
+    | message(method, [args]) # [args].size # => 1
+    v
+  +------------------+
+  |Sender::Dispatcher|
+  +------------------+
+    |                                                           execute
+    |   +----------------+ msgpack-rpc +----------------------+ method(arg[0]) +----------------+
+    `-->|sub-process #1/n|------------>|Receiver::EventHandler|--------------->|Receiver::Plugin|
+        +----------------+             +----------------------+                +----------------+
+        +----------------+             +----------------------+                +----------------+
+        |sub-process #2/n|             |Receiver::EventHandler|                |Receiver::Plugin|
+        +----------------+             +----------------------+                +----------------+
+              :                                 :                                       :
+        +----------------+             +----------------------+                +----------------+
+        |sub-process #n/n|             |Receiver::EventHandler|                |Receiver::Plugin|
+        +----------------+             +----------------------+                +----------------+
+`````
+
+### Receiver
+
+`````
+  +--------------------------------------------------------------------------+
+  | a receiver                                                               |
+  |                                                                          |
+  | +--------+                                                               |
+  | | Worker |                                                               |
+  | +--------+                                                               |
+  |   |                                 +-------------+                      |
+  |   | spawn when started              |     CPU     |                      |
+  |   |   +-------------------------+   | +---------+ |  +-----------------+ |
+  |   +-->|Msgpack::RPC::Server #1/n|-->| |core #1/n|--->|EventHandler #1/n| |
+  |   |   +-------------------------+   | +---------+ |  +-----------------+ |
+  |   |   +-------------------------+   | +---------+ |  +-----------------+ |
+  |   +-->|Msgpack::RPC::Server #2/n|-->| |core #2/n|--->|EventHandler #2/n| |
+  |   |   +-------------------------+   | +---------+ |  +-----------------+ |
+  |   |              :                  |      :      |          :           |
+  |   |   +-------------------------+   | +---------+ |  +-----------------+ |
+  |   `-->|Magpack::RPC::Server #n/n|-->| |core #n/n|--->|EventHandler #n/n| |
+  |       +-------------------------+   | +---------+ |  +-----------------+ |
+  |                                     |             |                      |
+  |                                     +-------------+                      |
+  |                                                                          |
+  +--------------------------------------------------------------------------+
+`````
+
+### Sender
+
+`````
+  +-----------------------------------------------------+  +-----------------------------+
+  | a sender                                            |  | receiver(s)                 |
+  |                                                     |  |                             |
+  | +------------+                                      |  |                             |
+  | | Dispatcher |                                      |  |                             |
+  | +------------+                                      |  |                             |
+  |   |                                 +-------------+ |  |                             |
+  |   | spawn when instantized          |     CPU     | |  |                             |
+  |   |   +-------------------------+   | +---------+ | |  | +-------------------------+ |
+  |   +-->|Msgpack::RPC::Client #1/n|-->| |core #1/n|------->|Msgpack::RPC::Server #1/m| |
+  |   |   +-------------------------+   | +---------+ | |  | +-------------------------+ |
+  |   |   +-------------------------+   | +---------+ | |  | +-------------------------+ |
+  |   +-->|Msgpack::RPC::Client #2/n|-->| |core #2/n|------->|Msgpack::RPC::Server #2/m| |
+  |   |   +-------------------------+   | +---------+ | |  | +-------------------------+ |
+  |   |              :                  |      :      | |  |            :                |
+  |   |   +-------------------------+   | +---------+ | |  | +-------------------------+ |
+  |   `-->|Magpack::RPC::Client #n/n|-->| |core #n/n|------->|Msgpack::RPC::Server #m/m| |
+  |       +-------------------------+   | +---------+ | |  | +-------------------------+ |
+  |                                     |             | |  |                             |
+  |                                     +-------------+ |  |                             |
+  |                                                     |  |                             |
+  +-----------------------------------------------------+  +-----------------------------+
+`````
+
+## Configuration
+
+### config/receiver.yml
+
+* protocol
+  * "tcp" or "udp"
+* address
+  * Binding IP Address.
+* port
+  * Port number to begin increment.
+* shared_key
+  * A pre-shared key string to establish connections with a sender.
+* log
+  * type
+    * The type of the log. "stdout", "file" or "both".
+  * level
+    * A log level. "fatal", "error", "warn", "info" or "debug".
+  * target
+    * The log file path, used when the "type" is specified as "file" or "both".
+
+### config/sender.yml
+
+* actors
+  * A list of actors. The format is "host_name_or_ip_address:port".
+* policy
+  * The policy to select actors and assign a message to them. "even", "random" or "safe-random".
+* timeout
+  * Connection timeout value for msgpack-rpc.
+* get_interval
+  * An interval to retry the get method for msgpack-rpc.
+* auth
+  * shared_key
+    * A pre-shared key string to establish connections with each receiver.
+  * timeout
+    * Authentication timeout with each receiver.
+* show_progress
+  * If it is true, the sender shows you a progress bar.
+* reload_receiver_plugins
+  * If it is true, the sender force each receiver reload plugins even in running.
+* log
+  * type
+    * The type of the log. "stdout", "file" or "both".
+  * level
+    * A log level. "fatal", "error", "warn", "info" or "debug".
+  * target
+    * The log file path, used when the "type" is specified as "file" or "both".
+
+## Usage
+
+### Receiver
+
+#### Foreground
+
+`````
+actory-receiver
+`````
+
+#### Background
+
+`````
+actory-receiver -d
+`````
+
+### Sender
+
+`````ruby
+require 'actory'
+dispacher = Actory::Sender::Dispatcher.new
+res = dispatcher.message(METHOD, ARGS)
+`````
+
+You can specify an actor or actors with an argument with actors keyword.
+
+`````ruby
+require 'actory'
+dispacher = Actory::Sender::Dispatcher.new(actors: ["localhost:18800"])
+res = dispatcher.message(METHOD, ARGS)
+`````
+
+`````ruby
+require 'actory'
+actors = ["192.168.1.1:18800", "192.168.1.2:18800", "192.168.1.3:18800"]
+dispacher = Actory::Sender::Dispatcher.new(actors: actors)
+res = dispatcher.message(METHOD, ARGS)
+`````
+
+## Plugin
+
+You can create your own plugin(s) to be executed by the receiver.
+
+`````ruby
+module Actory
+module Receiver
+
+class Plugin < Base
+
+  def hello(arg)
+    return "Hello #{arg}."
+  rescue => e
+    msg = Actory::Errors::Generator.new.json(level: "ERROR", message: e.message, backtrace: $@)
+    raise StandardError, msg
+  end
+
+end
+
+end
+end
+`````
+
+If you have created a plugin, put it just under the lib/actory/receiver/plugin directory. Then it will be automatically loaded even in the receiver running.
+
+And then, you can call the method from a sender like following:
+
+`````ruby
+require 'actory'
+dispacher = Actory::Sender::Dispatcher.new
+res = dispatcher.message("hello", ["world", "actory"])
+`````
+
+The response in a hash will be like following:
+
+`````ruby
+p res
+{"127.0.0.1:18800"=>["Hello world."], "192.168.1.1:18800"=>["Hello actory."]}
+`````
+
+## License
+
+Apache License, Version 2.0