textgoeshere-daemon-kit 0.1.8rc3

data/lib/daemon_kit/xmpp.rb

@@ -0,0 +1,100 @@
+require 'blather/client/client'
+require 'blather/client/dsl'
+
+module DaemonKit
+  # Thin wrapper around the blather DSL
+  class XMPP
+    include ::Blather::DSL
+
+    class << self
+
+      def run( &block )
+        DaemonKit.trap('INT') { ::EM.stop }
+        DaemonKit.trap('TERM') { ::EM.stop }
+
+        DaemonKit::EM.run {
+
+          xmpp = new
+          xmpp.instance_eval( &block )
+          xmpp.run
+        }
+      end
+    end
+
+    def initialize
+      @config = DaemonKit::Config.load('xmpp')
+
+      if @config.enable_logging
+        Blather.logger = DaemonKit.logger
+      end
+
+      jid = if @config.resource
+        "#{@config.jabber_id}/#{@config.resource}"
+      else
+        @config.jabber_id
+      end
+
+      setup jid, @config.password
+
+      when_ready do
+        configure_roster!
+        become_available
+      end
+
+      return if @config['require_master'] == false
+
+      message do |m|
+        trusted?( m ) ? pass : halt
+      end
+    end
+
+    def configure_roster!
+      DaemonKit.logger.debug 'Configuring roster'
+
+      my_roster.each do |(jid, item)|
+        unless contacts.include?( jid )
+          DaemonKit.logger.debug "Removing #{jid} from roster"
+
+          my_roster.delete( item.jid )
+          next
+        end
+      end
+
+      contacts.each do |jid|
+        DaemonKit.logger.debug "Adding #{jid} to roster"
+
+        my_roster.add( Blather::JID.new( jid ) )
+      end
+
+      my_roster.each do |(jid,item)|
+        item.subscription = :both
+        item.ask = :subscribe
+      end
+    end
+
+    def become_available
+      set_status( :chat, "#{DaemonKit.configuration.daemon_name} is available" )
+    end
+
+    def trusted?( message )
+      @config.masters.include?( message.from.stripped.to_s )
+    end
+
+    def contacts
+      @config.masters + @config.supporters
+    end
+
+    def run
+      client.run
+    end
+
+    def busy( message = nil, &block )
+      set_status( :dnd, message )
+
+      block.call
+
+      become_available
+    end
+
+  end
+end

data/lib/daemon_kit.rb

@@ -0,0 +1,59 @@
+# Seems we need to load openssl before em or there are failures all around.
+# But we need to consider that people might not have ssl in the first place.
+begin
+  require 'openssl'
+rescue LoadError
+end
+require 'eventmachine'
+
+require File.dirname(__FILE__) + '/daemon_kit/core_ext'
+require File.dirname(__FILE__) + '/daemon_kit/exceptions'
+
+$:.unshift( File.dirname(__FILE__).to_absolute_path ) unless
+  $:.include?( File.dirname(__FILE__).to_absolute_path )
+
+module DaemonKit
+  VERSION = '0.1.8rc3'
+
+  autoload :Initializer,    'daemon_kit/initializer'
+  autoload :Application,    'daemon_kit/application'
+  autoload :Arguments,      'daemon_kit/arguments'
+  autoload :Config,         'daemon_kit/config'
+  autoload :Safety,         'daemon_kit/safety'
+  autoload :PidFile,        'daemon_kit/pid_file'
+  autoload :AbstractLogger, 'daemon_kit/abstract_logger'
+  autoload :EM,             'daemon_kit/em'
+  autoload :Configurable,   'daemon_kit/core_ext/configurable'
+  autoload :Generators,     'daemon_kit/generators'
+
+  autoload :Cron,                   'daemon_kit/cron'
+  autoload :Jabber,                 'daemon_kit/jabber'
+  autoload :AMQP,                   'daemon_kit/amqp'
+  autoload :Nanite,                 'daemon_kit/nanite'
+  autoload :RuoteParticipants,      'daemon_kit/ruote_participants'
+  autoload :RuoteWorkitem,          'daemon_kit/ruote_workitem'
+  autoload :RuotePseudoParticipant, 'daemon_kit/ruote_pseudo_participant'
+  autoload :XMPP,                   'daemon_kit/xmpp'
+
+  class << self
+    def logger
+      @logger
+    end
+
+    def logger=( logger )
+      @logger = logger
+    end
+
+    def root
+      DAEMON_ROOT
+    end
+
+    def env
+      DAEMON_ENV
+    end
+
+    def framework_root
+      @framework_root ||= File.join( File.dirname(__FILE__), '..' ).to_absolute_path
+    end
+  end
+end

data/lib/generators/daemon_kit/amqp/USAGE

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

data/lib/generators/daemon_kit/amqp/amqp_generator.rb

@@ -0,0 +1,24 @@
+module DaemonKit
+  module Generators
+    class AmqpGenerator < Base
+
+      def update_gemfile
+        append_file 'Gemfile', "gem 'amqp'\n"
+      end
+
+      def create_config_files
+        directory 'config'
+      end
+
+      def create_daemon
+        directory 'libexec'
+      end
+
+      protected
+
+      def self.source_root
+        File.expand_path( File.join( File.dirname(__FILE__), 'templates') )
+      end
+    end
+  end
+end

data/lib/generators/daemon_kit/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:
+# * user - Username for the broker
+# * pass - 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
+  user: guest
+  pass: guest
+  host: localhost
+  vhost: /
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/lib/generators/daemon_kit/amqp/templates/config/pre-daemonize/amqp.rb

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

data/lib/generators/daemon_kit/amqp/templates/libexec/%app_name%-daemon.rb

@@ -0,0 +1,37 @@
+# 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.
+
+  # Uncomment this for connection keep-alive
+  # AMQP.conn.connection_status do |status|
+  #   DaemonKit.logger.debug("AMQP connection status changed: #{status}")
+  #   if status == :disconnected
+  #     AMQP.conn.reconnect(true)
+  #   end
+  # end
+
+  amq = ::MQ.new
+  amq.queue('test').subscribe do |msg|
+    DaemonKit.logger.debug "Received message: #{msg.inspect}"
+  end
+end

data/lib/generators/daemon_kit/app/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/lib/generators/daemon_kit/app/app_generator.rb

@@ -0,0 +1,140 @@
+module DaemonKit
+  module Generators
+    class AppGenerator < Base
+      INSTALLERS = %w( default amqp cron nanite_agent ruote xmpp )
+      DEPLOYERS  = %w( capistrano )
+      TEST_FRAMEWORKS = %w( none rspec test_unit )
+      add_shebang_option!
+
+      argument :app_path, :type => :string
+
+      class_option :installer, :type => :string, :aliases => '-i', :default => 'default',
+                   :desc => "Pre-configured daemon to generate (options: #{INSTALLERS.join(', ')})"
+
+      class_option :deployer, :type => :string, :aliases => '-d',
+                   :desc => "Select an optional deployment mechanism (options: #{DEPLOYERS.join(', ')})"
+
+      class_option :test_framework, :type => :string, :aliases => '-t', :default => 'rspec',
+                   :desc => "Select your prefered test framework (options: #{TEST_FRAMEWORKS.join(', ')})"
+
+      class_option :cucumber, :type => :boolean, :aliases => '-c', :default => false,
+                   :desc => "Install cucumber support"
+
+      def initialize( *args )
+        super
+
+        unless INSTALLERS.include?( options[:installer] )
+          raise Error, "Invalid value for --installer option. Supported installers are: #{INSTALLERS.join(', ')}"
+        end
+
+        if options[:deployer] && !DEPLOYERS.include?( options[:deployer] )
+          raise Error, "Invalid value for --deployer option. Supported deployers are: #{DEPLOYERS.join(', ')}"
+        end
+
+        unless TEST_FRAMEWORKS.include?( options[:test_framework] )
+          raise Error, "Invalid value for --test_framework option. Supported frameworks are: #{TEST_FRAMEWORKS.join(', ')}"
+        end
+      end
+
+      def create_root
+        self.destination_root = File.expand_path( app_path, destination_root )
+        empty_directory('.')
+        FileUtils.cd( destination_root )
+      end
+
+      def create_root_files
+        template 'README.tt', 'README'
+        copy_file 'Rakefile'
+        copy_file 'Gemfile'
+      end
+
+      def create_bin_files
+        empty_directory 'bin'
+        template 'bin/daemon.tt', "bin/#{app_name}" do |content|
+          "#{shebang}\n" + content
+        end
+        chmod "bin", 0755, :verbose => false
+      end
+
+      def create_config_files
+        directory 'config'
+      end
+
+      def create_script_files
+        directory 'script' do |content|
+          "#{shebang}\n" + content
+        end
+        chmod 'script', 0755, :verbose => false
+      end
+
+      def create_task_directory
+        empty_directory 'tasks'
+      end
+
+      def create_log_directory
+        empty_directory 'log'
+      end
+
+      def create_tmp_directory
+        empty_directory 'tmp'
+      end
+
+      def create_vendor_directory
+        empty_directory 'vendor'
+      end
+
+      def create_lib_files
+        directory 'lib'
+      end
+
+      def create_lib_exec
+        case options[:installer]
+        when 'default'
+          directory 'libexec'
+        when 'amqp'
+          invoke DaemonKit::Generators::AmqpGenerator
+        when 'cron'
+          invoke DaemonKit::Generators::CronGenerator
+        when 'nanite_agent'
+          invoke DaemonKit::Generators::NaniteAgentGenerator
+        when 'ruote'
+          invoke DaemonKit::Generators::RuoteGenerator
+        when 'xmpp'
+          invoke DaemonKit::Generators::XmppGenerator
+        end
+      end
+
+      def create_deployment_config
+        return unless options[:deployer]
+
+        case options[:deployer]
+        when 'capistrano'
+          invoke DaemonKit::Generators::CapistranoGenerator
+        end
+      end
+
+      def create_test_environment
+        return if options[:test_framework] == 'none'
+
+        case options[:test_framework]
+        when 'rspec'
+          invoke DaemonKit::Generators::SpecGenerator
+        when 'test_unit'
+          invoke DaemonKit::Generators::TestUnitGenerator
+        end
+      end
+
+      def create_cucumber
+        return unless options.cucumber?
+        invoke DaemonKit::Generators::CucumberGenerator
+      end
+
+      protected
+
+      def self.source_root
+        File.expand_path( File.join( File.dirname(__FILE__), 'templates') )
+      end
+
+    end
+  end
+end

data/lib/generators/daemon_kit/app/templates/Gemfile

@@ -0,0 +1,8 @@
+# If you need to 'vendor your gems' for deploying your daemons, bundler is a
+# great option. Update this Gemfile with any additional dependencies and run
+# 'gem bundle' to get them all unpacked in vendor/gems.
+
+# daemon-kit
+gem 'daemon-kit'
+
+# For more information on bundler, please visit http://github.com/carlhuda/bundler

data/lib/generators/daemon_kit/app/templates/README.tt

@@ -0,0 +1,58 @@
+daemon-kit README
+================
+
+daemon-kit has generated a skeleton Ruby daemon for you to build on. Please read
+through this file to ensure you get going quickly.
+
+Directories
+===========
+
+bin/
+  <%= app_name %> - Stub executable to control your daemon with
+
+config/
+  Environment configuration files
+
+lib/
+  Place for your libraries
+
+libexec/
+  <%= app_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 getting insight into what your
+daemons are doing. Logging with daemon-kit 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.
+
+Bundler
+=======
+
+daemon-kit uses bundler to ease the nightmare of dependency loading in Ruby 
+projects. daemon-kit and its generators all create/update the Gemfile in the
+root of the daemon. You can satisfy the project's dependencies by running
+`bundle install` from within the project root.
+
+For more information on bundler, please see http://github.com/carlhuda/bundler