job_reactor 0.5.1.beta2 → 0.5.1

data/README.markdown

@@ -20,7 +20,7 @@ They will block the reactor and break normal processing.
 
 If you can't divide 'THE BIG JOB' into 'small pieces' you shouldn't use JobReactor. See alternatives such [DelayedJob][4] or [Resque][1].
 
-__JobReactor is the right solution if you have thousands, millions, and, we hope:), billions relatively small jobs.__
+__JobReactor is the right solution if you have thousands, millions, and, we hope, billions relatively small jobs.__
 
 Quick start
 ===========
@@ -35,7 +35,7 @@ In your main application:
 ``` ruby
 require 'job_reactor'
 JR.run do
-  JR.start_distributor('localhost', 5000)
+  JR.start_distributor('localhost', 5000)  #see documentation
 end
 sleep(1) until(JR.ready?)
 
@@ -64,7 +64,7 @@ JR.run! do
   :name => 'worker_1',
   :server => ['localhost', 5001],
   :distributors => [['localhost', 5000]]
-  })
+  })                                         #see documentation
 end
 ```
 Run 'application.rb' in one terminal window and 'worker.rb' in another.

data/lib/job_reactor/distributor.rb

@@ -5,16 +5,15 @@ module JobReactor
   module Distributor
     extend self
 
-    # Gets nodes
     # You can monitor available nodes connections in you application.
-    # For example
-    # EM::PeriodicTimer.new(10) { JR::Logger.log nodes}
+    # For example:
+    # EM::PeriodicTimer.new(10) { JR::Logger.log nodes}.
     #
     def nodes
       @@nodes ||= []
     end
 
-    # Contains connections pool - all node connections
+    # Contains connections pool - all node connections.
     #
     def connections
       @@connections ||= []
@@ -24,7 +23,8 @@ module JobReactor
       @@connect_to || "#{@@host}:#{@@port}"
     end
 
-    #Starts distributor on given hast and port
+    # Starts distributor on given hast and port.
+    # See JR.start_distributor documentation.
     #
     def start(host, port, opts = {})
       @@connect_to = opts[:connect_to] && opts[:connect_to].join(':')
@@ -34,9 +34,9 @@ module JobReactor
       EM.start_server(host, port, JobReactor::Distributor::Server)
     end
 
-    # Tries to find available node connection
-    # If it is distributor will send marshalled data
-    # If get_connection returns nil distributor will try again after 1 second
+    # Tries to find available node connection.
+    # If it is distributor will send marshalled data.
+    # If get_connection returns nil distributor will try again after 1 second.
     #
     def send_data_to_node(hash)
       connection = get_connection(hash)
@@ -56,8 +56,8 @@ module JobReactor
 
     # Looks for available connection.
     # If job hash specified node, tries check if the node is available.
-    # If not, returns nil or tries to find any other free node if :always_use_specified_node == true
-    # If job hasn't any specified node, methods return any available connection or nil (and will be launched again in one second)
+    # If not, returns nil or tries to find any other free node if :always_use_specified_node == true.
+    # If job hasn't any specified node, methods return any available connection or nil (and will be launched again in one second).
     #
     def get_connection(hash)
       if hash['node']

data/lib/job_reactor/job_reactor.rb

@@ -39,6 +39,14 @@ module JobReactor
     # Parses jobs.
     # Requires storage.
     # Creates and start node.
+    # Options are:
+    # :storage - now available: 'memory_storage' and 'redis_storage';
+    # :name - uniq node name like 'my_favorite_memory_node';
+    # :server - address where node server starts (example: ['123.123.123.123', 1234];
+    # :distributors - address or addresses of distributor(s) node will try to connect (example: [['111.111.111.111', 5000], ['localhost', 5001]]);
+    # :connect_to - use this option if you have different ip-address to access your machine from outside world. Example (connect_to: ['213.122.132.231', 8000]).
+    # If you specify :connect_to option the connected distributor will use this host and port to connect the node.
+    # If not, distributor will use host and port from :server option.
     #
     def start_node(opts)
       parse_jobs
@@ -47,6 +55,12 @@ module JobReactor
       node.start
     end
 
+    # Starts distributor server on given host and port.
+    # If you have different ip-address to access your machine from outside world use additional option :connect_to.
+    # For example:
+    # JR.start_distributor('0.0.0.0', 5000, connect_to: ['123,223,234,213', 5000]).
+    # So the node will use '123,223,234,213:5000' to send the 'feedbacks' to distributor
+    #
     def start_distributor(host, port, opts = {})
       JR::Distributor.start(host, port, opts)
     end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: job_reactor
 version: !ruby/object:Gem::Version
-  version: 0.5.1.beta2
-  prerelease: 6
+  version: 0.5.1
+  prerelease: 
 platform: ruby
 authors:
 - Anton Mishchuk
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-15 00:00:00.000000000 Z
+date: 2012-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -100,9 +100,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24