daemon-kit 0.1.3

data/History.txt

@@ -0,0 +1,17 @@
+== 0.1.2 2009-04-28
+
+* Added missing rubigen dependency
+
+== 0.1.1 2009-04-27
+
+* AMQP consumer generator added
+* 'cron' style generator added
+* Allow configuring dir_mode and dir (pid file location) (Jim Lindley)
+
+== 0.1.0 2009-01-08
+
+* Ability to freeze the gem/edge copies of DaemonKit
+* Simple non-evented Jabber generator
+* Flexible UNIX signal trapping configuration
+* Basic generator completed
+* 1 small step for man, 1 giant leap for mankind

data/Manifest.txt

@@ -0,0 +1,62 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.textile
+Rakefile
+TODO.txt
+app_generators/daemon_kit/USAGE
+app_generators/daemon_kit/daemon_kit_generator.rb
+app_generators/daemon_kit/templates/README
+app_generators/daemon_kit/templates/Rakefile
+app_generators/daemon_kit/templates/bin/daemon.erb
+app_generators/daemon_kit/templates/config/boot.rb
+app_generators/daemon_kit/templates/config/environment.rb
+app_generators/daemon_kit/templates/config/environments/development.rb
+app_generators/daemon_kit/templates/config/environments/production.rb
+app_generators/daemon_kit/templates/config/environments/test.rb
+app_generators/daemon_kit/templates/config/initializers/readme
+app_generators/daemon_kit/templates/libexec/daemon.erb
+bin/daemon_kit
+daemon_generators/amqp/USAGE
+daemon_generators/amqp/amqp_generator.rb
+daemon_generators/amqp/templates/config/amqp.yml
+daemon_generators/amqp/templates/config/initializers/amqp.rb
+daemon_generators/amqp/templates/libexec/daemon.rb
+daemon_generators/cron/USAGE
+daemon_generators/cron/cron_generator.rb
+daemon_generators/cron/templates/config/initializers/cron.rb
+daemon_generators/cron/templates/libexec/daemon.rb
+daemon_generators/jabber/USAGE
+daemon_generators/jabber/jabber_generator.rb
+daemon_generators/jabber/templates/config/initializers/jabber.rb
+daemon_generators/jabber/templates/config/jabber.yml
+daemon_generators/jabber/templates/libexec/daemon.rb
+lib/daemon_kit.rb
+lib/daemon_kit/amqp.rb
+lib/daemon_kit/application.rb
+lib/daemon_kit/cron.rb
+lib/daemon_kit/initializer.rb
+lib/daemon_kit/jabber.rb
+lib/daemon_kit/patches/force_kill_wait.rb
+lib/daemon_kit/tasks.rb
+lib/daemon_kit/tasks/framework.rake
+rubygems_generators/install_rspec/USAGE
+rubygems_generators/install_rspec/install_rspec_generator.rb
+rubygems_generators/install_rspec/templates/spec.rb
+rubygems_generators/install_rspec/templates/spec/spec.opts
+rubygems_generators/install_rspec/templates/spec/spec_helper.rb
+rubygems_generators/install_rspec/templates/tasks/rspec.rake
+script/console
+script/destroy
+script/generate
+script/txt2html
+spec/daemon_kit_spec.rb
+spec/initializer_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake
+test/test_amqp_generator.rb
+test/test_cron_generator.rb
+test/test_daemon-kit_generator.rb
+test/test_generator_helper.rb
+test/test_jabber_generator.rb

data/PostInstall.txt

@@ -0,0 +1,6 @@
+
+For more information on daemon-kit, see http://daemon-kit.rubyforge.org
+
+To get started quickly run 'daemon_kit' without any arguments
+
+

data/README.textile

@@ -0,0 +1,94 @@
+h1. Daemon Kit
+
+* http://daemon-kit.rubyforge.org/ (coming soon)
+
+h2. Description
+
+Daemon Kit aims to simplify creating Ruby daemons by providing a sound application skeleton (through a generator), task specific generators (jabber bot, etc) and robust environment management code.
+
+Using simple built-in generators it is easy to created evented and non-evented daemons that perform a multitude of different tasks.
+
+Supported generators:
+
+* Evented and non-evented Jabber Bot (coming next)
+* Evented and non-evented loops (coming soon)
+* Queue poller (SQS, AMQP, etc) (coming soon)
+
+h2. Features/Problems
+
+* Build it
+* Review TODO.txt
+
+h2. Synopsis
+
+  $ daemon-kit [/path/to/your/daemon] [options]
+
+The above command generates a skeleton daemon environment for you to adapt.
+
+  $ daemon-kit [/path/to/your/daemon] -i jabber
+
+Use the 'jabber' generator instead of the default one.
+
+h2. Generators
+
+Currently only two generators exist, a 'default' generator and a 'jabber' generator.
+
+The default generator creates a simple daemon with an infinite loop inside that you can adapt.
+
+h3. Jabber Generator
+
+The jabber generator creates a simple daemon that leverages the "xmpp4r-simple":http://xmpp4r-simple.rubyforge.org/ gem to process inbound messages. The daemon will manage the roster and other little tasks, leaving you to provide the hooks for processing messages, presence notifications and subscription request.
+
+h3. Cron Generator
+
+The cron generator creates a simple daemon that leverages the "rufus-scheduler":http://github.com/jmettraux/rufus-scheduler gem to create a simple cron-lie daemon. Please be aware that this daemon could never be a replacement for the battle-tested "cron utility":http://www.gentoo.org/doc/en/cron-guide.xml shipped standard with most *nix distributions.
+
+h3. AMQP Consumer Generator
+
+The AMQP generator creates a simple daemon that has all the stub code and configuration in place to help you write AMQP consumers quickly and effectively. The generated daemon relies on the presence of the "amqp":http://github.com/tmm1/amqp gem.
+
+h2. Requirements
+
+* Ruby 1.8.6
+* daemons 1.0.10
+* rspec 1.1.11 (for writing/running your specs)
+
+h3. Generator Requirements
+
+Depending on the generator you choose for your daemon, it might require additional gems to run.
+
+|.Generator|.Dependencies|
+|jabber|"xmpp4r-simple":http://xmpp4r-simple.rubyforge.org/|
+|cron|"rufus-scheduler":http://github.com/jmettraux/rufus-scheduler|
+|amqp|"amqp":http://github.com/tmm1/amqp|
+
+h2. Install
+
+  $ git clone git://github.com/kennethkalmer/daemon-kit.git
+  $ rake gem
+  $ gem install pkg/daemon-kit-X.X.X.gem
+
+h2. License
+
+(The MIT License)
+
+Copyright (c) 2009 Kenneth Kalmer (Internet Exchange CC, Clear Planet Information Solutions Pty Ltd)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,31 @@
+
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/daemon_kit'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('daemon-kit', DaemonKit::VERSION) do |p|
+  p.summary = 'Daemon Kit aims to simplify creating Ruby daemons by providing a sound application skeleton (through a generator), task specific generators (jabber bot, etc) and robust environment management code.'
+  p.developer('Kenneth Kalmer', 'kenneth.kalmer@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = IO.read( 'PostInstall.txt' ) # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps = [
+                  ['daemons','>= 1.0.10'],
+                  ['rubigen', '>= 1.5.2']
+                 ]
+  p.extra_dev_deps = [
+                      ['newgem', ">= #{::Newgem::VERSION}"]
+                     ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+task :default => [:spec] #, :features]

data/TODO.txt

@@ -0,0 +1,24 @@
+DaemonKit TODO List
+===================
+
+This is purely a drop in the bucket of what has to come...
+
+* [DONE] Easy way to trap signals 
+* Error handling to the degree Rails does
+* Easy configuration of an ORM of choice, including patching it if needed (ActiveRecord *cough*)
+* Improved generators for creating skeleton daemons:
+  * [DONE] Jabber bot
+  * Evented jabber bot
+  * Empty periodic event loop
+  * Empty periodic loop (non-evented)
+  * Queue (SQS, AMQP, etc) pollers
+* Rake tasks for generating:
+  * god configs
+* Pre-built capistrano configs for easy deployment
+* Support for dropping privileges
+* Support for chroot'ing
+* Improved and cleaned up logging
+* Plenty of docs, seriously a lot of docs
+* Specs & features, tons of them too
+* Some level of thread safety, or mechanisms to ease thread safety
+* DON'T FORGET 1.9 SUPPORT

data/app_generators/daemon_kit/USAGE

@@ -0,0 +1,7 @@
+Description:
+  This generator creates a new skeleton project suitable for easy
+  Ruby daemon development. The generated project is preconfigured
+  and just requires your task specific code.
+
+  Use one of the provided generators to stub out even more 
+  functionality for common daemon patterns.

data/app_generators/daemon_kit/daemon_kit_generator.rb

@@ -0,0 +1,120 @@
+class DaemonKitGenerator < RubiGen::Base
+
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  VALID_GENERATORS = ['default', 'jabber', 'cron', 'amqp']
+  
+  default_options :shebang => DEFAULT_SHEBANG, :author => nil
+
+  attr_reader :daemon_name
+  attr_reader :installer
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @daemon_name = base_name
+    extract_options
+  end
+
+  def manifest
+    # ensure some sanity
+    unless VALID_GENERATORS.include?( installer )
+      $stderr.puts "Invalid generator: '#{installer}'."
+      $stderr.puts "Valid generators are: #{VALID_GENERATORS.join(', ')}"
+      exit 1
+    end
+          
+    script_options = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
+    
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+
+      # Create stubs
+      # m.template "template.rb",  "some_file_after_erb.rb"
+      # m.template_copy_each ["template.rb", "template2.rb"]
+      # m.file     "file",         "some_file_copied"
+      # m.file_copy_each ["path/to/file", "path/to/file2"]
+      
+      # Readme
+      m.template  "README", "README"
+      m.template  "Rakefile", "Rakefile"
+      
+      # Executable
+      m.directory "bin"
+      m.template  "bin/daemon.erb", "bin/#{daemon_name}", script_options
+
+      # Generator
+      if installer == "default"
+        m.directory "libexec"
+        m.template  "libexec/daemon.erb", "libexec/#{daemon_name}.rb"
+      else
+        m.dependency installer, [daemon_name], :destination => destination_root, :collision => :force
+      end
+
+      # Config/Environment
+      m.directory "config"
+      m.file      "config/boot.rb", "config/boot.rb"
+      m.template  "config/environment.rb", "config/environment.rb"
+      m.directory "config/environments"
+      %w{ development test production }.each { |f| m.file "config/environments/#{f}.rb", "config/environments/#{f}.rb" }
+      m.directory "config/initializers"
+      m.file      "config/initializers/readme", "config/initializers/readme"
+
+      # Libraries
+      m.directory "lib"
+      
+      # Tests
+      m.directory "tasks"
+      m.dependency "install_rspec", [daemon_name], :destination => destination_root, :collision => :force
+
+      # Others
+      m.directory "log"
+      m.directory "tmp"
+      m.directory "vendor"
+
+      m.dependency "install_rubigen_scripts", [destination_root, 'daemon_kit'],
+        :shebang => options[:shebang], :collision => :force
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a preconfigured environment for writing Ruby daemon processes.
+
+USAGE: #{spec.name} /path/to/your/daemon [options]
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |o| options[:author] = o }
+      opts.on("-i", "--install=generator", String,
+              "Select a generator to use (other than the default).",
+              "Available generators: #{VALID_GENERATORS.join(', ')}",
+              "Defaults to: default") do |installer|
+        options[:installer] = installer
+      end
+      opts.on("-r", "--ruby=path", String,
+              "Path to the Ruby binary of your choice (otherwise scripts use env, dispatchers current path).",
+              "Default: #{DEFAULT_SHEBANG}") { |x| options[:shebang] = x }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+      @installer = options[:installer] || 'default'
+    end
+
+end

data/app_generators/daemon_kit/templates/README

@@ -0,0 +1,48 @@
+DaemonKit README
+================
+
+DaemonKit has generated a skeleton Ruby daemon for you to build on. Please read
+through this file to ensure you get going quickly.
+
+Directories
+===========
+
+bin/
+  <%= daemon_name %> - Stub executable to control your daemon with
+
+config/
+  Environment configuration files
+
+lib/
+  Place for your libraries
+
+libexec/
+  <%= daemon_name %>.rb - Your daemon code
+
+log/
+  Log files based on the environment name
+
+spec/
+  rspec's home
+
+tasks/
+  Place for rake tasks
+
+vendor/
+  Place for unpacked gems and DaemonKit
+
+tmp/
+  Scratch folder
+
+
+Logging
+=======
+
+One of the biggest issues with writing daemons are gettign insight into what your
+daemons are doing. Logging with DaemonKit is simplified as DaemonKit creates log
+files per environment in log.
+
+On all environments except production the log level is set to DEBUG, but you can
+toggle the log level by sending the running daemon SIGUSR1 and SIGUSR2 signals.
+SIGUSR1 will toggle between DEBUG and INFO levels, SIGUSR2 will blatantly set the
+level to DEBUG.

data/app_generators/daemon_kit/templates/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'daemon_kit/tasks'
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |rake| load rake }

data/app_generators/daemon_kit/templates/bin/daemon.erb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+#
+# Stub executable for <%= daemon_name %>
+
+require File.dirname(__FILE__) + '/../config/environment'
+
+DaemonKit::Application.run( DAEMON_ROOT + '/libexec/<%= daemon_name %>.rb' )

data/app_generators/daemon_kit/templates/config/boot.rb

@@ -0,0 +1,68 @@
+# Don't change this file!
+# Configure your daemon in config/environment.rb
+
+DAEMON_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?( DAEMON_ROOT )
+
+module DaemonKit
+  class << self
+    def boot!
+      unless booted?
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? DaemonKit::Initializer
+    end
+
+    def pick_boot
+      (vendor_kit? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_kit?
+      File.exists?( "#{DAEMON_ROOT}/vendor/daemon_kit" )
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      DaemonKit::Initializer.run
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{DAEMON_ROOT}/vendor/daemon_kit/lib/daemon_kit/initializer"
+    end
+  end
+  
+  class GemBoot < Boot
+    def load_initializer
+      begin
+        require 'rubygems'
+        gem 'kennethkalmer-daemon-kit'
+        require 'daemon_kit/initializer'
+      rescue Gem::LoadError
+        begin
+          gem 'daemon-kit'
+          require 'daemon_kit/initializer'
+        rescue Gem::LoadError => e
+          msg = <<EOF
+You are missing the daemon-kit gem. Please install one of the following gems:
+
+* Unstable - sudo gem install kennethkalmer-daemon-kit -s http://gems.github.com/
+* Stable   - sudo gem install daemon-kit
+
+NOTE: The 'unstable' gem is loaded first, before falling back to the stable gem!
+
+EOF
+          $stderr.puts msg
+          exit 1
+        end
+      end
+    end
+  end
+end
+
+DaemonKit.boot!