run_rabbit_run 0.0.4 → 0.0.5

data/README.md

@@ -18,7 +18,102 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+### Including the rake tasks
+
+Require the rake tasks in your **Rakefile**
+
+    require "run_rabbit_run/tasks"
+
+#### Rake tasks
+
+```console
+RAKE_ENV=production bundle exec rake rrr:start
+```
+
+Starts the master process and it starts all worker processes for **production** environment (default is **development**).
+
+```console
+bundle exec rake rrr:stop
+```
+
+Stops the master process. Master process sends **QUIT** signal to workers and waits for 5 seconds. If processes are still running the master kills them.
+
+```console
+bundle exec rake rrr:reload
+```
+
+Master stops all workers and then starts the profile again.
+
+```console
+bundle exec rake rrr:worker:add[worker_name]
+```
+
+Master runs new process for given worker.
+
+```console
+bundle exec rake rrr:worker:remove[worker_name]
+```
+
+Master stops one worker process.
+
+### Configuration
+
+you need to create __config/rrr.rb__ file to set your config variables
+
+```ruby
+log "log/run_rabbit_run.log"
+pid "tmp/pids/run_rabbit_run.pid"
+
+worker :worker1, 'workers/worker_name_1.rb', processes: 0
+worker :worker2, 'workers/worker_name_2.rb', processes: 2
+worker :worker3, 'workers/worker_name_3.rb', processes: 1
+```
+
+* **log** sets path to log file
+* **pid** sets path to pid file
+* **worker** sets settings for worker. The first argument is the worker name. The second argument is the path to the worker ruby file. And you can pass options as a third parameter. The **processes** option sets the process count for worker, default is 1. If process count is 0 then no processes will be run, you can run the process by `bundle exec rake rrr:worker:add[worker_name]`.
+
+Another config file you need to create is configuration file for environment eg. **config/rrr/development.rb** or **config/rrr/production.rb**
+
+```ruby
+run :worker1, :worker2
+
+```
+**run** points the workers which will be run for the environment. In this case it will run only `worker1` and `worker2` but exlude the `worker3`.
+
+### Creating worker
+
+This is the "Hello world" worker. It creates **test_queue**, sends simple message to this queue, subscribes to the same queue and prints it into log file.
+
+```ruby
+test_queue = channel.queue('test_queue', auto_delete: false)
+
+publish(test_queue, {some: 'data'})
+
+subscribe(test_queue) do | header, data |
+  RunRabbitRun.logger.info data.inspect
+end
+```
+
+Sometimes we need to have workers which does something and shuts down. For example send some messages and end the process. It is possible if you set `processes` to **zero** for the worker in config file and run `stop` command at the end of the worker script file. If the `processes` count is set to number bigger than **0** then master will run the process again after it finishes. 
+
+__config/rrr.rb__
+
+```ruby
+# ... some code
+worker :worker1, 'workers/worker_name_1.rb', processes: 0
+# ... some code
+```
+__workers/worker_name_1.rb__
+
+```ruby
+test_queue = channel.queue('test_queue', auto_delete: false)
+
+publish(test_queue, {some: 'data'})
+
+stop
+```
 
 ## Contributing
 

data/lib/run_rabbit_run/master.rb

@@ -12,19 +12,19 @@ module RunRabbitRun
       @master_process ||= begin
         master = RunRabbitRun::Processes::Master.new
         master.pid = Pid.pid
-       
+
         master
       end
     end
-    
+
     def start
       master_process.start do
         workers = RunRabbitRun::Workers.new
         workers.start
 
-        add_periodic_timer 2 do
+        add_periodic_timer 5 do
           begin
-            workers.check unless exiting?
+            workers.check unless exiting? || starting?
           rescue => e
             RunRabbitRun.logger.error e.message
           end

data/lib/run_rabbit_run/processes/base.rb

@@ -49,6 +49,8 @@ module RunRabbitRun
                 end
               end
             end
+
+            @starting = false
           end
 
           RunRabbitRun.logger.info "[#{@name}] process finished"
@@ -58,6 +60,10 @@ module RunRabbitRun
 
       end
 
+      def starting?
+        @starting ||= true
+      end
+
       def exiting?
         @exiting ||= false
       end

data/lib/run_rabbit_run/rabbitmq.rb

@@ -4,7 +4,7 @@ module RunRabbitRun
   module Rabbitmq
     class Base
       include RunRabbitRun::Callbacks
-      
+
       define_callback :on_message_received
       define_callback :on_message_processed
 
@@ -12,7 +12,7 @@ module RunRabbitRun
         opts = options.dup
         time_logging   = opts.delete(:time_logging) || false
 
-        queue.subscribe do | header, payload |
+        queue.subscribe(options) do | header, payload |
           RunRabbitRun.logger.info "[#{queue.name}] [#{Time.now.to_f}] started" if time_logging
           call_callback :on_message_received, queue
 

data/lib/run_rabbit_run/version.rb

@@ -1,3 +1,3 @@
 module RunRabbitRun
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/run_rabbit_run/workers.rb

@@ -19,15 +19,15 @@ module RunRabbitRun
     def check
       @workers.each do | name, workers |
         processes = RunRabbitRun.config[:workers][name][:processes]
-        
+
         workers.each do | guid, worker |
-          unless worker.running?
+          if worker.pid && worker.pid > 0 && !worker.running?
             if processes == 0
               @workers[name].delete(guid)
             else
               worker.run
             end
-          end 
+          end
         end
         diff = processes - workers.size
         diff.times{ run_new_worker name } if diff > 0
@@ -73,7 +73,7 @@ module RunRabbitRun
     def stop
       # try to stop gracefully 
       @workers.each { | name, workers | workers.each { | guid, worker | worker.stop } }
-     
+
       sleep 1 
 
       @workers.each do | name, workers |

data/spec/dummy/config/rrr.rb

@@ -1,5 +1,3 @@
-require 'run_rabbit_run'
-
 #TODO working_directory '/path/to/working/directory'
 
 log "log/run_rabbit_run.log"

data/spec/dummy/workers/worker_name_1.rb

@@ -1,5 +1,5 @@
-output = channel.queue('output', auto_delete: false)
-input  = channel.queue('input', auto_delete: false)
+output = channel.queue('output', durable: true, auto_delete: false)
+input  = channel.queue('input', durable: true, auto_delete: false)
 
 publish(output, {some: 'data'})
 
@@ -8,6 +8,7 @@ subscribe(output, time_logging: true) do | header, data |
   publish(input, {received: 'data'})
 end
 
-subscribe(input) do | header, data |
+subscribe(input, ack: true) do | header, data |
   RunRabbitRun.logger.info data.inspect
+  header.ack
 end

data/spec/dummy/workers/worker_name_3.rb

@@ -1,5 +1,7 @@
-RunRabbitRun.logger.info "run worker 3 for 20 seconds"
+input  = channel.queue('input', durable: true, auto_delete: false)
 
-sleep 20
+10.times do | index |
+  publish(input, { some: 'zero data' })
+end
 
 stop

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: run_rabbit_run
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-21 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake