raemon 0.1.0 → 0.1.1

data/README

@@ -2,17 +2,70 @@ Raemon
 ======
 
 Raemon is a Ruby framework for building daemons. It's designed for writing
-master/worker pre-forking servers running on UNIX. More to come.
+master/worker pre-forking servers running on UNIX. The library has been
+tested on both 1.8.7 and 1.9.1 and carries no dependencies outside of the
+Ruby core. More to come.
 
-
-Credits
--------
 By: Peter Kieltyka
 Copyright (c) 2007-2009 NuLayer Inc. All rights reserved.
 
 
+Usage
+=====
+
+Raemon supports two modes of use: as a lightweight master/worker library
+or as a full daemon server.
+
+
+Lightweight master/worker library
+---------------------------------
+Simply mixin the Raemon::Worker module into any class and implement the
+'start' and 'execute' methods.
+
+start   - called when the worker process is first created
+execute - called to begin the execution of the worker
+
+The Raemon::Worker module also provides a 'shutting_down?' helper method
+that should be tested between iterations in the worker loop to gracefully
+shutdown the worker.
+
+To start the workers use the Raemon::Master class.
+
+See examples/test.rb and examples/beanstalk.rb for how the library works
+in this scenario.
+
+Also, you can find an evented Beanstalk example in examples/evented.rb.
+
+
+Daemon server
+-------------
+Raemon::Server provides tools that helps build daemon applications
+that feel like a Ruby on Rails application. See examples/sampled.
+
+
+Installation
+============
+Via gemcutter:
+$ gem install raemon
+
+From source:
+$ git clone git://github.com/pkieltyka/raemon.git
+$ cd raemon && rake build
+$ gem install pkg/raemon-X.X.X.gem
+
+
+TODO
+====
+1. Test cases
+2. Create a UNIX socket connection between the master and workers
+3. Setup a heartbeat between the master and the workers
+4. Monitor memory usage of the workers in the master and restart/stop
+   a worker if its out of whack
+5. Write a daemon generator (as examples/sampled)
+
+
 Thanks
-------
+======
 Raemon was influenced by the following projects:
 
 servolux   - http://github.com/TwP/servolux

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/examples/beanstalk.rb

@@ -4,7 +4,7 @@ require 'rubygems'
 require 'raemon'
 require 'beanstalk-client'
 
-class Test
+class JobWorker
   include Raemon::Worker
   
   def start
@@ -40,12 +40,12 @@ class Test
 
 end
 
-ROOT_DIR = '/Users/peter/Desktop'
+ROOT_DIR = File.expand_path('~')
 
-# Raemon::Master.startup 3, Test, {
+# Raemon::Master.startup 3, JobWorker, {
 #   :detach   => true,
 #   :logger   => Logger.new("#{ROOT_DIR}/beanstalk.log"),
 #   :pid_file => "#{ROOT_DIR}/beanstalk.pid"
 # }
 
-Raemon::Master.startup 3, Test
+Raemon::Master.startup 3, JobWorker

data/examples/evented.rb

@@ -0,0 +1,47 @@
+$:.unshift ::File.dirname(__FILE__) + '/../lib'
+
+require 'rubygems'
+require 'raemon'
+require 'em-jack'
+
+class EventedJobWorker
+  include Raemon::Worker
+  
+  def start
+    logger.info "=> Starting worker #{Process.pid}"
+  end
+  
+  def stop
+    logger.info "=> Stopping worker #{Process.pid}"
+    
+    EM.stop_event_loop if EM.reactor_running?
+    exit
+  end
+  
+  def execute
+    EventMachine.run do
+      @queue = EMJack::Connection.new
+      
+      @queue.each_job(5) do |job|        
+        logger.info "(#{Process.ppid}:#{Process.pid}) got job: #{job.inspect}"
+        # process(job)
+        @queue.delete(job)
+        
+        stop if shutting_down?
+      end
+      
+      @queue.on_error do |error|
+        case error
+        when :timed_out
+          # We use the reserve timeout to check if we should shutdown
+          stop if shutting_down?
+        else
+          logger.error error.to_s
+        end
+      end
+    end
+  end
+
+end
+
+Raemon::Master.startup 2, EventedJobWorker

data/examples/sampled/config/environment.rb

@@ -1,12 +1,10 @@
 # Be sure to restart your daemon when you modify this file
 
 # Uncomment below to force your daemon into production mode
-#ENV['DAEMON_ENV'] ||= 'production'
+#ENV['RAEMON_ENV'] ||= 'production'
 
 require File.join(File.dirname(__FILE__), 'boot')
 
-require 'ruby-debug'
-
 Raemon::Server.run do |config|
   config.name         = 'Sampled'
   config.worker_klass = 'Sampled::Worker'

data/examples/sampled/config/environments/development.rb

@@ -1,5 +1,5 @@
 config.detach       = false
-config.num_workers  = 2
+config.num_workers  = 1
 config.log_level    = :debug
 
 require 'ruby-debug'

data/examples/sampled/config/environments/test.rb

@@ -1 +1,3 @@
-config.log_level = :debug
+config.detach       = false
+config.num_workers  = 1
+config.log_level    = :debug

data/examples/sampled/test/example_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class ExampleTest < Test::Unit::TestCase
+
+  def test_nothing
+    assert true
+    
+    assert defined? Sampled::Worker
+  end
+
+end

data/examples/sampled/test/test_helper.rb

@@ -0,0 +1,7 @@
+ENV['RAEMON_ENV'] = 'test'
+
+# Add any libs you need for your test suite here
+require 'rubygems'
+
+require File.dirname(__FILE__) + '/../config/environment'
+Raemon::Server.startup!

data/examples/test.rb

@@ -26,6 +26,4 @@ class Test
 
 end
 
-ROOT_DIR = '/Users/peter/Desktop'
-
 Raemon::Master.startup 3, Test

data/lib/raemon/master.rb

@@ -74,7 +74,5 @@ module Raemon
       trap('TERM', shutdown_block)
     end
     
-    def debugging?; @debug; end
-    
   end
 end

data/lib/raemon/server.rb

@@ -59,11 +59,13 @@ module Raemon
       end
       
       def load_initializers
-        load_folder("#{RAEMON_ROOT}/config/initializers")
+        load_folder "#{RAEMON_ROOT}/config/initializers"
       end
 
       def load_lib
-        load_folder("#{RAEMON_ROOT}/lib")
+        libdir = "#{RAEMON_ROOT}/lib"
+        $LOAD_PATH.unshift libdir
+        load_folder libdir
       end
       
       def load_folder(path)

data/lib/raemon.rb

@@ -2,7 +2,7 @@ require 'socket'
 require 'logger'
 
 module Raemon
-  VERSION = '0.1'
+  VERSION = '0.1.1'
 end
 
 require 'raemon/server'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: raemon
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Peter Kieltyka
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-26 00:00:00 -05:00
+date: 2009-11-27 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,7 @@ files:
 - Rakefile
 - VERSION
 - examples/beanstalk.rb
+- examples/evented.rb
 - examples/sampled/bin/sampled
 - examples/sampled/config/boot.rb
 - examples/sampled/config/environment.rb
@@ -38,6 +39,9 @@ files:
 - examples/sampled/config/initializers/settings.rb
 - examples/sampled/config/settings.yml
 - examples/sampled/lib/sampled.rb
+- examples/sampled/test/.keep
+- examples/sampled/tmp/pids/.keep
+- examples/sampled/vendor/.keep
 - examples/test.rb
 - lib/raemon.rb
 - lib/raemon/master.rb
@@ -73,6 +77,7 @@ specification_version: 3
 summary: Raemon is a Ruby framework for building UNIX daemons.
 test_files: 
 - examples/beanstalk.rb
+- examples/evented.rb
 - examples/sampled/config/boot.rb
 - examples/sampled/config/environment.rb
 - examples/sampled/config/environments/development.rb
@@ -80,4 +85,6 @@ test_files:
 - examples/sampled/config/environments/test.rb
 - examples/sampled/config/initializers/settings.rb
 - examples/sampled/lib/sampled.rb
+- examples/sampled/test/example_test.rb
+- examples/sampled/test/test_helper.rb
 - examples/test.rb