bunnicula 0.2.0 → 0.2.1

data/Rakefile

@@ -20,13 +20,13 @@ begin
     s.name = "bunnicula"
     s.version = Bunnicula::VERSION
     s.summary = "A very simple relay for moving messages from a local broker to a remote broker"
-    s.description = "A very simple relay for moving messages from a local broker to a remote broker"
+    s.description = "Bunnicula is a simple AMQP relay implemented as a ruby daemon (a-la daemon-kit). Similar in intent to shovel, Bunnicula is intended to enable the common messaging scenario where services and applications publish messages to an AMQP broker on the local LAN for speed and reliability which are then subsequently relayed to a remote AMQP instance by a relay process which isn�t so irritable as message producers tend to be when it comes to network speed and reliability. Bunnicula can be configured via configuration file (a Ruby DSL) or, for most common configurations, through command line arguments."
     s.email = "hereiam@sonic.net"
     s.homepage = "http://github.com/PlasticLizard/bunnicula"
     s.authors = ["Nathan Stults"]
     s.has_rdoc = false #=>Should be true, someday
     s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
-    s.files = FileList["[A-Z]*", "{bin,lib,config,libexec,test}/**/*"]
+    s.files = FileList["[A-Z]*", "{bin,lib,config,vendor,libexec,test}/**/*"]
 
     s.add_dependency('bunny', '0.6.0')
     s.add_dependency('amqp', '0.6.7')

data/bunnicula.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bunnicula}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Stults"]
   s.date = %q{2010-07-12}
   s.default_executable = %q{bunnicula}
-  s.description = %q{A very simple relay for moving messages from a local broker to a remote broker}
+  s.description = %q{Bunnicula is a simple AMQP relay implemented as a ruby daemon (a-la daemon-kit). Similar in intent to shovel, Bunnicula is intended to enable the common messaging scenario where services and applications publish messages to an AMQP broker on the local LAN for speed and reliability which are then subsequently relayed to a remote AMQP instance by a relay process which isn�t so irritable as message producers tend to be when it comes to network speed and reliability. Bunnicula can be configured via configuration file (a Ruby DSL) or, for most common configurations, through command line arguments.}
   s.email = %q{hereiam@sonic.net}
   s.executables = ["bunnicula"]
   s.extra_rdoc_files = [
@@ -48,7 +48,184 @@ Gem::Specification.new do |s|
      "libexec/bunnicula-daemon.rb",
      "test/config/Relayfile.rb",
      "test/lib/bunnicula_test.rb",
-     "test/test_helper.rb"
+     "test/test_helper.rb",
+     "vendor/daemon_kit/daemon-kit/Configuration.txt",
+     "vendor/daemon_kit/daemon-kit/Deployment.txt",
+     "vendor/daemon_kit/daemon-kit/History.txt",
+     "vendor/daemon_kit/daemon-kit/Logging.txt",
+     "vendor/daemon_kit/daemon-kit/Manifest.txt",
+     "vendor/daemon_kit/daemon-kit/PostInstall.txt",
+     "vendor/daemon_kit/daemon-kit/README.rdoc",
+     "vendor/daemon_kit/daemon-kit/Rakefile",
+     "vendor/daemon_kit/daemon-kit/RuoteParticipants.txt",
+     "vendor/daemon_kit/daemon-kit/TODO.txt",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/USAGE",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/daemon_kit_generator.rb",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/README",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/Rakefile",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/bin/daemon.erb",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/arguments.rb",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/boot.rb",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/environment.rb",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/environments/development.rb",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/environments/production.rb",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/environments/test.rb",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/post-daemonize/readme",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/config/pre-daemonize/readme",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/lib/daemon.rb",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/libexec/daemon.erb",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/script/console",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/script/destroy",
+     "vendor/daemon_kit/daemon-kit/app_generators/daemon_kit/templates/script/generate",
+     "vendor/daemon_kit/daemon-kit/bin/daemon-kit",
+     "vendor/daemon_kit/daemon-kit/config/website.yml",
+     "vendor/daemon_kit/daemon-kit/daemon-kit.gemspec",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/amqp/USAGE",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/amqp/amqp_generator.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/amqp/templates/config/amqp.yml",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/amqp/templates/config/initializers/amqp.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/amqp/templates/libexec/daemon.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/cron/USAGE",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/cron/cron_generator.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/cron/templates/config/initializers/cron.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/cron/templates/libexec/daemon.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/cucumber/USAGE",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/cucumber/cucumber_generator.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/cucumber/templates/cucumber",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/cucumber/templates/cucumber.rake",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/cucumber/templates/cucumber_environment.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/cucumber/templates/env.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/deploy_capistrano/deploy_capistrano_generator.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/deploy_capistrano/templates/Capfile",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/deploy_capistrano/templates/USAGE",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/deploy_capistrano/templates/config/deploy.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/deploy_capistrano/templates/config/deploy/production.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/deploy_capistrano/templates/config/deploy/staging.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/deploy_capistrano/templates/config/environments/staging.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/jabber/USAGE",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/jabber/jabber_generator.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/jabber/templates/config/initializers/jabber.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/jabber/templates/config/jabber.yml",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/jabber/templates/libexec/daemon.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/nanite_agent/USAGE",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/nanite_agent/nanite_agent_generator.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/nanite_agent/templates/config/initializers/nanite_agent.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/nanite_agent/templates/config/nanite.yml",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/nanite_agent/templates/lib/actors/sample.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/nanite_agent/templates/libexec/daemon.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/rspec/USAGE",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/rspec/rspec_generator.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/rspec/templates/spec.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/rspec/templates/spec/spec.opts",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/rspec/templates/spec/spec_helper.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/rspec/templates/tasks/rspec.rake",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/ruote/USAGE",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/ruote/ruote_generator.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/ruote/templates/config/amqp.yml",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/ruote/templates/config/initializers/ruote.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/ruote/templates/config/ruote.yml",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/ruote/templates/lib/daemon.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/ruote/templates/lib/sample.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/ruote/templates/libexec/daemon.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/test_unit/USAGE",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/test_unit/templates/tasks/test_unit.rake",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/test_unit/templates/test/test.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/test_unit/templates/test/test_helper.rb",
+     "vendor/daemon_kit/daemon-kit/daemon_generators/test_unit/test_unit_generator.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/abstract_logger.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/amqp.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/application.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/arguments.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/commands/console.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/config.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/console_daemon.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/core_ext.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/core_ext/configurable.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/core_ext/string.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/cron.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/cucumber/world.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/deployment/capistrano.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/em.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/error_handlers/base.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/error_handlers/hoptoad.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/error_handlers/mail.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/exceptions.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/initializer.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/jabber.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/nanite.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/nanite/agent.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/pid_file.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/ruote_participants.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/ruote_pseudo_participant.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/ruote_workitem.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/safety.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/tasks.rb",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/tasks/environment.rake",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/tasks/framework.rake",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/tasks/god.rake",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/tasks/log.rake",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/tasks/monit.rake",
+     "vendor/daemon_kit/daemon-kit/lib/daemon_kit/xmpp.rb",
+     "vendor/daemon_kit/daemon-kit/script/console",
+     "vendor/daemon_kit/daemon-kit/script/destroy",
+     "vendor/daemon_kit/daemon-kit/script/generate",
+     "vendor/daemon_kit/daemon-kit/script/txt2html",
+     "vendor/daemon_kit/daemon-kit/spec/abstract_logger_spec.rb",
+     "vendor/daemon_kit/daemon-kit/spec/argument_spec.rb",
+     "vendor/daemon_kit/daemon-kit/spec/config_spec.rb",
+     "vendor/daemon_kit/daemon-kit/spec/configurable_spec.rb",
+     "vendor/daemon_kit/daemon-kit/spec/daemon_kit_spec.rb",
+     "vendor/daemon_kit/daemon-kit/spec/error_handlers_spec.rb",
+     "vendor/daemon_kit/daemon-kit/spec/fixtures/env.yml",
+     "vendor/daemon_kit/daemon-kit/spec/fixtures/noenv.yml",
+     "vendor/daemon_kit/daemon-kit/spec/initializer_spec.rb",
+     "vendor/daemon_kit/daemon-kit/spec/spec.opts",
+     "vendor/daemon_kit/daemon-kit/spec/spec_helper.rb",
+     "vendor/daemon_kit/daemon-kit/tasks/cucumber.rake",
+     "vendor/daemon_kit/daemon-kit/tasks/rspec.rake",
+     "vendor/daemon_kit/daemon-kit/tasks/tests.rake",
+     "vendor/daemon_kit/daemon-kit/templates/god/god.erb",
+     "vendor/daemon_kit/daemon-kit/templates/monit/monit.erb",
+     "vendor/daemon_kit/daemon-kit/test/test_amqp_generator.rb",
+     "vendor/daemon_kit/daemon-kit/test/test_cron_generator.rb",
+     "vendor/daemon_kit/daemon-kit/test/test_daemon-kit_generator.rb",
+     "vendor/daemon_kit/daemon-kit/test/test_daemon_kit_config.rb",
+     "vendor/daemon_kit/daemon-kit/test/test_deploy_capistrano_generator.rb",
+     "vendor/daemon_kit/daemon-kit/test/test_generator_helper.rb",
+     "vendor/daemon_kit/daemon-kit/test/test_helper.rb",
+     "vendor/daemon_kit/daemon-kit/test/test_jabber_generator.rb",
+     "vendor/daemon_kit/daemon-kit/test/test_nanite_agent_generator.rb",
+     "vendor/daemon_kit/daemon-kit/test/test_ruote_generator.rb",
+     "vendor/daemon_kit/daemon-kit/test/test_test_unit_generator.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/address.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/attachments.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/base64.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/compat.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/config.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/core_extensions.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/encode.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/header.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/index.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/interface.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/loader.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/mail.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/mailbox.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/main.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/mbox.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/net.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/obsolete.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/parser.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/port.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/quoting.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/require_arch.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/scanner.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/scanner_r.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/stringio.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/utils.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail-1.2.3/tmail/version.rb",
+     "vendor/daemon_kit/daemon-kit/vendor/tmail.rb"
   ]
   s.homepage = %q{http://github.com/PlasticLizard/bunnicula}
   s.rdoc_options = ["--charset=UTF-8"]

data/lib/bunnicula/version.rb

@@ -1,3 +1,3 @@
 module Bunnicula
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/vendor/daemon_kit/daemon-kit/Configuration.txt

@@ -0,0 +1,110 @@
+= Configuring your daemon
+
+daemon-kit provides a multitude of ways to configure your daemon, this document
+will outline the different options available to you.
+
+== Configuration files and #DaemonKit::Config
+
+#DaemonKit::Config gives you easy access to any YAML configuration
+files you have in your <em>config</em> directory.
+
+You can access the configuration files like this:
+
+  config = DaemonKit::Config.load('sample')
+
+The above snippet relies on the presence of a <em>config/sample.yml</em> file.
+
+#DaemonKit::Config is environment aware, so configuration files are
+parsed for a top-level key that is the same as the value of
+<em>DAEMON_ENV</em>, and if present is loaded into the object as the
+configuration data. If the key is not present, the whole YAML
+document is exposed as configuration data.
+
+== Command line arguments
+
+The most flexible way to configure your daemon is through command line
+arguments, or switches.
+
+DaemonKit includes a couple of its own arguments that can be used:
+
+  -e ENV (or --env ENV) to set the daemon environment
+  --pid /path/to/pidfile to set the path to a pidfile
+  -l path (or --log path) to set the path for the log file
+  -v shows the DaemonKit version
+  -h shows a useful help message
+
+=== Custom arguments
+
+It is possible for you to specify your own arguments as well, by
+updating the <em>config/arguments.rb</em> file. This file is eval'd
+inside #DaemonKit::Arguments and gives you access to the following two
+variables:
+
+* opts - Instance of OptionParser[http://www.ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html]
+* @options - A standard Ruby hash that you can populate and access later
+
+Your custom arguments can be accessed like this:
+
+  DaemonKit.arguments.options
+
+=== Advanced Configuration
+
+All the writable attributes of the default #DaemonKit::Configuration
+instance call also be modified from the command line using the special
+<em>--config</em> arguments:
+
+  --config force_kill_wait=30
+
+This happens after <em>config/environment.rb</em> is processed, so all
+command line arguments will overwrite those values.
+
+=== Daemon umask
+
+By default daemon processes run with a umask of 022, but this can be changed
+on the command line or in +config/environment.rb+.
+
+To set a more restrictive umask via command line arguments, you can start your
+daemon like this:
+
+  $ ./bin/daemon start --config umask=0077
+
+Or the same in +config/environment.rb+
+
+  DaemonKit::Initializer.run do |config|
+    # ...
+
+    # restrictive umask
+    config.umask = 0077
+
+    # ...
+  end
+
+=== Privilege Separation
+
+By default daemon processes run as the user that starts them, inheriting all
+their privileges (or lack thereof). Getting daemon-kit to drop privileges
+can currently only be done using command-line parameters, and only works
+reliable on *nix (OSX seemed cranky at the time of testing).
+
+  $ ./bin/daemon start --config user=nobody --config group=nobody
+
+Privileges are dropped at the earliest possible phase of starting the daemon.
+
+Things to note on privilege separation:
+
+* You generally have to be root to be able to perform this
+* File system permissions for +log/+ needs to be correct
+* Daemon-kit will only shed privileges on the +start+ command, not on +run+
+* Make sure your code is secure if accepting stuff from the outside world
+* The daemon will continue to run if it failed, this is because the feature is experimental and could change in the future.
+* The damon logs the reduced privileges in the log file shortly after booting, please check it carefully
+
+The implementation stems from the advice given by Joe Damato on his blog post
+http://timetobleed.com/tag/privilege-escalation/
+
+IMPORTANT NOTE FOR OSX USERS:
+
+Testing on my iBook with OSX 10.5.8 using Ruby 1.8.6-p287 failed to drop
+privileges correctly because of the 'nobody' user's UID being too large
+(Bignum), however testing with Ruby 1.9.1-p129 on OSX 10.5.8 did work as
+expected.

data/vendor/daemon_kit/daemon-kit/Deployment.txt

@@ -0,0 +1,113 @@
+= Deploying your daemons
+
+daemon-kit provides built-in support for
+Capistrano[http://www.capify.org] deployments, using a customized
+version of the standard 'deploy' recipe for Ruby on Rails
+applications.
+
+User of Vlad[http://hitsquad.rubyforge.org/vlad/]? Get in touch so we
+can discuss your contribution to daemon-kit ;)
+
+== Generating capistrano configurations
+
+When generating a new daemon, you can pass the <em>-d capistrano</em>
+argument to the <em>daemon_kit</em> command. In case you already have
+a generated daemon, run the following command inside your project:
+
+  $ ruby script/generate deploy_capistrano
+
+== Overview of generated configurations
+
+The generator creates the following files worth noticing:
+
+  config/deploy.rb
+  config/deploy/*.rb
+
+The generator also creates a new environment for you, a
+<em>staging</em> environment. Useful for testing your deployments
+before taking anything into production.
+
+== Configuring capistrano
+
+For each environment (staging & production) you only need to specify
+the target hosts in <em>config/deploy/(staging|production).rb</em>.
+
+Each of the stub files have example configuration values you can just
+edit.
+
+The rest of your configuration generally occurs in
+<em>config/deploy.rb</em>.
+
+Everything works exactly like standard capistrano, with the exception
+of the following directives:
+
+* :config_files
+* :shared_children
+
+=== :config_files
+
+Since the daemon configuration files will almost always differ between
+your development environment and your staging/production environment,
+the deployment recipe makes adequate provision for this.
+
+Use the :config_files directive to set an array of file names from the
+<em>config</em> directory that you want replaced with production
+configuration files found on the server:
+
+  set :config_files, %w{ amqp.yaml }
+
+On your target server, in the <em>:deploy_to</em> folder, create a
+<em>config</em> directory and place your configuration files in
+there. One each deploy, capistrano will rename the files in your
+deployed configuration directory with a <em>.orig</em> extension, and copy
+the files from <em>:deploy_to/config</em> into the newly deployed
+release.
+
+This makes it easy to keep production configurations out of your
+working directories or version control systems.
+
+=== :shared_children
+
+The original capistrano recipe that daemon-kit's recipe is built from
+provided support for tracking shared directories between
+deployments. This works by removing the deployed directory, and
+creating a symlink from <em>:deploy_to/shared/</em> into the correct
+location within the deployed release.
+
+You specify your list of directories with the
+<em>:shared_children</em>, each being relative to the DAEMON_ROOT.
+
+  set :shared_children, %w{ log }
+
+The daemon-kit deployment recipe makes no assumptions on shared
+directories, and gives you full control. The default only includes the
+log directory, which you can remove if you want separate log
+directories for each deployed release.
+
+== Remote dependencies
+
+By default, the deployment configuration file is configured to check
+the remote dependencies before updating the code on the target
+host. You can disable this behaviour by commenting out the following
+line:
+
+  before "deploy:update_code", "deploy:check"
+
+The only default remote dependency is the daemon-kit gem, and it will
+check for the same version you currently have installed (or a later
+one).
+
+== More capistrano resources
+
+To see a list of available commands, please run the following command
+in the root of your project:
+
+  $ cap -vT
+
+For more information on capistrano, please refer to the following list
+of online resources:
+
+* Capistrano Website[http://www.capify.org]
+* Capistrano Wiki[http://wiki.capify.org]
+* Capistrano Group[http://groups.google.com/group/capistrano]
+* #capistrano on Freenode

data/vendor/daemon_kit/daemon-kit/History.txt

@@ -0,0 +1,113 @@
+== 0.1.7.12 2009-12-04
+
+* Bug fix, don't load environment files twice [grockit]
+
+== 0.1.7.11 2009-11-30
+
+* Renamed 'daemon_kit' executable to 'daemon-kit'
+* Fixed some broken links in README.rdoc
+* Sneaked in << on AbstractLogger for better Logger compatibility
+* Support for Test::Unit in generated projects [skaar]
+* Fixed missing DAEMON_ENV for test helpers
+* Fixes for nanite configuration [skaar]
+* Toughened up the ruote workitem parser
+* Fixed issue with nanite services not being advertised correctly [Wijnand]
+* Fixed some woes with rake if rspec gem is missing
+
+== 0.1.7.10 2009-08-12
+
+* Ruote remote participants
+* Allow process umask to be configured, defaults to 022
+* Updates to DaemonKit::Config hashes
+* Fixed argument parsing bug (reported by Mathijs Kwik (bluescreen303)
+* Support for privilege separation (See Configuration.txt)
+
+== 0.1.7.9 2009-06-22
+
+* Backtraces only logged on unclean shutdown
+* AMQP generator got new keep alive code
+
+== 0.1.7.8 2009-06-22
+
+* Optional logging of all exceptions when the daemon process dies
+  unexpectedly
+* Update generated environment.rb to reflect new backtraces option
+
+== 0.1.7.7 2009-06-22
+
+* Fixed compatibility with rufus-scheduler-2.0.0 (or newer) in cron
+  generator
+* Started central eventmachine reactor management code
+* Now depends on eventmachine
+
+== 0.1.7.6 (Not released)
+
+* Support for cucumber
+* Fixed issue in daemon_kit:upgrade task
+* Moved rspec generator into new home
+* Removed conflicting rubigen generator, messed with our script directory
+* Fixed bug where environment.rb overwrites some --config values (reported by Josh Owens)
+
+== 0.1.7.5 2009-06-08
+
+* New AbstractLogger
+** Default Logger backend
+** SysLogLogger support
+* More documentation
+
+== 0.1.7.4 2009-06-05
+
+* Fixed bug with control script generator (thanks Sho Fukamachi)
+* Enhanced deploy.rb template to check for current dk gem verion,
+  unless vendored
+* Fix bug in capistrano recipe for restarting daemons
+* Added log:truncate rake task
+* Error mails now handled by TMail
+
+== 0.1.7.3 2009-05-31
+
+* Removed dependency on daemons gem, now handled in house
+* New argument management
+* Some more docs
+
+== 0.1.7.1 2009-05-28
+
+* Fixed some minor issue with Capistrano support
+* Added support for generating dog/monit configuration files via rake
+* Initial implementation of ./script/* utilities
+
+== 0.1.7 2009-05-26
+
+* Capistrano deployment support
+
+== 0.1.6 2009-05-13
+
+* DaemonKit::Safety class to handle the trapping and logging of
+  exceptions, as well as email notifications or Hoptoad notifications.
+* New config/pre-daemonize and config/post-daemonize structure
+* New tasks to simplify upgrading daemon-kit projects
+* Fixed some other annoyances and bugs
+* Bigger TODO list
+
+== 0.1.5 2009-05-07
+
+* DaemonKit::Config class to easy the use of YAML configs internally,
+  and in generated daemons
+
+== 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