daemon-kit 0.1.3

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

@@ -0,0 +1,19 @@
+# Be sure to restart your daemon when you modify this file
+
+# Uncomment below to force your daemon into production mode
+#ENV['DAEMON_ENV'] ||= 'production'
+
+# Boot up
+require File.join(File.dirname(__FILE__), 'boot')
+
+DaemonKit::Initializer.run do |config|
+
+  # The name of the daemon as reported by process monitoring tools
+  config.daemon_name = '<%= daemon_name %>'
+
+  # Uncomment to allow multiple instances to run
+  # config.mulitple = true
+
+  # Force the daemon to be killed after X seconds from asking it to
+  # config.force_kill_wait = 30
+end

data/app_generators/daemon_kit/templates/config/initializers/readme

@@ -0,0 +1,11 @@
+# You can place files in here to be loaded before the code is daemonized.
+#
+# DaemonKit looks for a file named '<config.daemon_name>.rb' and loads
+# that file with as if inside a DaemonKit::Initializer block.
+# 
+# These files are mostly useful for operations that should fail blatantly
+# before daemonizing, like loading gems.
+#
+# Be careful not to open any form of IO in here and expecting it to be
+# open inside the running daemon since all IO instances are closed when
+# daemonizing (including STDIN, STDOUT & STDERR).

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

@@ -0,0 +1,18 @@
+# Change this file to be a wrapper around your daemon code.
+
+# Do your post daemonization configuration here
+# At minimum you need just the first line (without the block), or a lot
+# of strange things might start happening...
+DaemonKit::Application.running! do |config|
+  # Trap signals with blocks or procs
+  # config.trap( 'INT' ) do
+  #   # do something clever
+  # end
+  # config.trap( 'TERM', Proc.new { puts 'Going down' } )
+end
+
+# Sample loop to show process
+loop do
+  DaemonKit.logger.info "I'm running"
+  sleep 60
+end

data/bin/daemon_kit

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rubigen'
+
+if %w(-v --version).include? ARGV.first
+  require 'daemon_kit'
+  puts "#{File.basename($0)} #{DaemonKit::VERSION}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+RubiGen::Base.use_application_sources! :rubygems
+RubiGen::Base.prepend_sources(*[
+  RubiGen::PathSource.new(:app, File.join(File.dirname(__FILE__), "..", "app_generators")),
+  RubiGen::PathSource.new(:app, File.join(File.dirname(__FILE__), "..", "daemon_generators")),
+  RubiGen::PathSource.new(:app, File.join(File.dirname(__FILE__), "..", "rubygems_generators"))
+])
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'daemon_kit')

data/daemon_generators/amqp/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/daemon_generators/amqp/amqp_generator.rb

@@ -0,0 +1,65 @@
+class AmqpGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      
+      # Create stubs
+      # m.template           "template.rb.erb", "some_file_after_erb.rb"
+      # m.template_copy_each ["template.rb", "template2.rb"]
+      # m.template_copy_each ["template.rb", "template2.rb"], "some/path"
+      # m.file           "file", "some_file_copied"
+      # m.file_copy_each ["path/to/file", "path/to/file2"]
+      # m.file_copy_each ["path/to/file", "path/to/file2"], "some/path"
+
+      # Copy over our configs
+      m.directory 'config'
+      m.template  'config/amqp.yml', 'config/amqp.yml'
+      m.directory 'config/initializers'
+      m.template  'config/initializers/amqp.rb', "config/initializers/#{name}.rb"
+
+      # Copy over our daemon
+      m.directory 'libexec'
+      m.template 'libexec/daemon.rb', "libexec/#{name}.rb"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+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("-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]
+    end
+end

data/daemon_generators/amqp/templates/config/amqp.yml

@@ -0,0 +1,28 @@
+# AMQP client configuration file
+
+# These values will be used to configure the ampq gem, any values
+# omitted will let the gem use it's own defaults.
+
+# The configuration specifies the following keys:
+# * username - Username for the broker
+# * password - Password for the broker
+# * host     - Hostname where the broker is running
+# * vhost    - Vhost to connect to
+# * port     - Port where the broker is running
+# * ssl      - Use ssl or not
+# * timeout  - Timeout
+
+defaults: &defaults
+  username: guest
+  password: guest
+  host: localhost
+  vhost: /
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/daemon_generators/amqp/templates/config/initializers/amqp.rb

@@ -0,0 +1,7 @@
+begin
+  require 'amqp'
+  require 'mq'
+rescue LoadError
+  $stderr.puts "Missing amqp gem. Please run 'gem install amqp'."
+  exit 1
+end

data/daemon_generators/amqp/templates/libexec/daemon.rb

@@ -0,0 +1,29 @@
+# Generated amqp daemon
+
+# Do your post daemonization configuration here
+# At minimum you need just the first line (without the block), or a lot
+# of strange things might start happening...
+DaemonKit::Application.running! do |config|
+  # Trap signals with blocks or procs
+  # config.trap( 'INT' ) do
+  #   # do something clever
+  # end
+  # config.trap( 'TERM', Proc.new { puts 'Going down' } )
+end
+
+# IMPORTANT CONFIGURATION NOTE
+#
+# Please review and update 'config/amqp.yml' accordingly or this
+# daemon won't work as advertised.
+
+# Run an event-loop for processing
+DaemonKit::AMQP.run do
+  # Inside this block we're running inside the reactor setup by the
+  # amqp gem. Any code in the examples (from the gem) would work just
+  # fine here.
+
+  amq = ::MQ.new
+  amq.queue('test').subscribe do |msg|
+    DaemonKit.logger.debug "Received message: #{msg.inspect}"
+  end
+end

data/daemon_generators/cron/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/daemon_generators/cron/cron_generator.rb

@@ -0,0 +1,64 @@
+class CronGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+
+      # Create stubs
+      # m.template           "template.rb.erb", "some_file_after_erb.rb"
+      # m.template_copy_each ["template.rb", "template2.rb"]
+      # m.template_copy_each ["template.rb", "template2.rb"], "some/path"
+      # m.file           "file", "some_file_copied"
+      # m.file_copy_each ["path/to/file", "path/to/file2"]
+      # m.file_copy_each ["path/to/file", "path/to/file2"], "some/path"
+      
+      # Copy over configs
+      m.directory 'config'
+      m.directory 'config/initializers'
+      m.template  'config/initializers/cron.rb', "config/initializers/#{name}.rb"
+
+      # Copy over our daemon
+      m.directory 'libexec'
+      m.template 'libexec/daemon.rb', "libexec/#{name}.rb"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+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("-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]
+    end
+end

data/daemon_generators/cron/templates/config/initializers/cron.rb

@@ -0,0 +1,7 @@
+begin
+  require 'rufus-scheduler'
+rescue LoadError => e
+  $stderr.puts "Missing rufus-scheduler gem. Please run 'gem install rufus-scheduler'."
+  exit 1
+end
+

data/daemon_generators/cron/templates/libexec/daemon.rb

@@ -0,0 +1,39 @@
+# Generated cron daemon
+
+# Do your post daemonization configuration here
+# At minimum you need just the first line (without the block), or a lot
+# of strange things might start happening...
+DaemonKit::Application.running! do |config|
+  # Trap signals with blocks or procs
+  # config.trap( 'INT' ) do
+  #   # do something clever
+  # end
+  # config.trap( 'TERM', Proc.new { puts 'Going down' } )
+end
+
+# Configuration documentation available at http://rufus.rubyforge.org/rufus-scheduler/
+# An instance of the scheduler is available through
+# DaemonKit::Cron.scheduler
+
+# Some samples to get you going:
+
+# Will call #regenerate_monthly_report in 3 days from starting up
+#DaemonKit::Cron.scheduler.in("3d") do
+#  regenerate_monthly_report()
+#end
+# 
+#DaemonKit::Cron.scheduler.every "10m10s" do
+#  check_score(favourite_team) # every 10 minutes and 10 seconds
+#end
+#
+#DaemonKit::Cron.scheduler.cron "0 22 * * 1-5" do
+#  log.info "activating security system..."
+#  activate_security_system()
+#end
+
+DaemonKit::Cron.scheduler.every("1m") do
+  DaemonKit.logger.debug "Scheduled task completed at #{Time.now}"
+end
+
+# Run our 'cron' daeon
+DaemonKit::Cron.run

data/daemon_generators/jabber/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/daemon_generators/jabber/jabber_generator.rb

@@ -0,0 +1,65 @@
+class JabberGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+
+      # Create stubs
+      # m.template           "template.rb.erb", "some_file_after_erb.rb"
+      # m.template_copy_each ["template.rb", "template2.rb"]
+      # m.template_copy_each ["template.rb", "template2.rb"], "some/path"
+      # m.file           "file", "some_file_copied"
+      # m.file_copy_each ["path/to/file", "path/to/file2"]
+      # m.file_copy_each ["path/to/file", "path/to/file2"], "some/path"
+      
+      # Copy over our configs
+      m.directory 'config'
+      m.template  'config/jabber.yml', 'config/jabber.yml'
+      m.directory 'config/initializers'
+      m.template  'config/initializers/jabber.rb', "config/initializers/#{name}.rb"
+
+      # Copy over our daemon
+      m.directory 'libexec'
+      m.template 'libexec/daemon.rb', "libexec/#{name}.rb"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+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("-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]
+    end
+end

data/daemon_generators/jabber/templates/config/initializers/jabber.rb

@@ -0,0 +1,7 @@
+begin
+  require 'xmpp4r-simple'
+rescue LoadError => e
+  $stderr.puts "Missing xmpp4-simple gem. Please run 'gem install xmpp4r-simple'."
+  exit 1
+end
+

data/daemon_generators/jabber/templates/config/jabber.yml

@@ -0,0 +1,26 @@
+# Jabber configuration file
+
+# The configuration specifies the following keys:
+# * jabber_id  - Identidy (username) of the user
+# * password   - Password used to authenticate
+# * resource   - Multiple connections can be made with the same credentials and different resources
+# * masters    - Array of Jabber ID's whose messages will be processed
+# * supporters - Additional 'buddies' to keep on roster, but messages won't be processed
+
+defaults: &defaults
+  jabber_id: <%= name %>@gmail.com
+  password: secret
+  resource: daemon_kit
+  masters: 
+    - you@gmail.com
+  supporters:
+    - someone@gmail.com
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults