daemon-kit 0.1.8.2 → 0.2.0

data/History.txt

@@ -1,10 +1,17 @@
-== 0.1.9 (WIP)
+== 0.2.0 2012-09-30
 
 * Depend on the 'safely' gem for the safely method and logging backtraces
 * Fixed compatibility with ruote-amqp 2.2.0
-* AMQP fixes by @marcbowes
+* AMQP fixes by @marcbowes (version, reconnect)
 * Updated to rspec 2 (various contributors)
-* Up to AMQP gem 0.7.1 or later
+* Various documentation fixes by @ktrix
+* Remove vendored Thor
+* Various load/require fixes by @ktrix
+* SQS generator by @marcbowes
+
+== 0.1.8.2 2011-05-18
+
+* Convert to use Bundler
 
 == 0.1.18.1 2010-08-04
 

data/README.rdoc

@@ -15,6 +15,7 @@ Supported generators:
 
 * XMPP bot (evented)
 * AMQP consumer (evented)
+* SQS consumer
 * Nanite agent
 * Cron-style daemon
 * ruote remote participants

data/daemon-kit.gemspec

@@ -10,7 +10,9 @@ Gem::Specification.new do |gem|
   gem.post_install_message = %q{
 For more information on daemon-kit, see http://kit.rubyforge.org/daemon-kit
 
-To get started quickly run 'daemon-kit' without any arguments
+For usage options, run:
+
+$ daemon-kit -h
 
 
 }
@@ -27,12 +29,12 @@ To get started quickly run 'daemon-kit' without any arguments
                           "Deployment.txt",
                           "History.txt",
                           "Logging.txt",
-                          "PostInstall.txt",
                           "README.rdoc",
                           "RuoteParticipants.txt",
                           "TODO.txt",
                          ]
 
+  gem.add_dependency(%q<thor>)
   gem.add_development_dependency(%q<bundler>)
   gem.add_development_dependency(%q<rake>)  
   gem.add_development_dependency(%q<rdoc>)
@@ -42,4 +44,6 @@ To get started quickly run 'daemon-kit' without any arguments
   gem.add_development_dependency(%q<SyslogLogger>)
   gem.add_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
   gem.add_runtime_dependency(%q<safely>, [">= 0.3.1"])
+  gem.add_runtime_dependency(%q<rubigen>)
+  gem.add_runtime_dependency(%q<i18n>)
 end

data/lib/daemon_kit.rb

@@ -29,6 +29,7 @@ module DaemonKit
   autoload :Cron,                   'daemon_kit/cron'
   autoload :Jabber,                 'daemon_kit/jabber'
   autoload :AMQP,                   'daemon_kit/dk_amqp'
+  autoload :SQS,                    'daemon_kit/dk_sqs'
   autoload :Nanite,                 'daemon_kit/nanite'
   autoload :RuoteParticipants,      'daemon_kit/ruote_participants'
   autoload :RuoteWorkitem,          'daemon_kit/ruote_workitem'

data/lib/daemon_kit/application.rb

@@ -32,7 +32,7 @@ module DaemonKit
         self.chroot
         self.clean_fd
         self.redirect_io( true )
-
+        
         DaemonKit.configuration.log_stdout = true
 
         require file
@@ -50,7 +50,7 @@ module DaemonKit
       end
 
       def stop
-        @pid_file = PidFile.new( DaemonKit.configuration.pid_file )
+        @pid_file = PidFile.new( DaemonKit.configuration.pid_file( DaemonKit.configuration.instance ) )
 
         unless @pid_file.running?
           @pid_file.cleanup
@@ -153,7 +153,7 @@ module DaemonKit
 
       # Daemonize the process
       def daemonize
-        @pid_file = PidFile.new( DaemonKit.configuration.pid_file )
+        @pid_file = PidFile.new( DaemonKit.configuration.pid_file( DaemonKit.configuration.instance ) )
         @pid_file.ensure_stopped!
 
         if RUBY_VERSION < "1.9"

data/lib/daemon_kit/arguments.rb

@@ -65,13 +65,13 @@ module DaemonKit
 
         i = 0
         while i < argv.size
-          if argv[i] == "--config"
+          if argv[i] == "-c" || argv[i] == "--config"
             argv.delete_at( i )
             configs << argv.delete_at(i)
             next
           end
 
-          if argv[i] == "-e" || argv[i] == "--env"
+          if argv[i] == "-e" || argv[i] == "--env" || argv[i] == "--environment"
             argv.delete_at( i )
             configs << "environment=#{argv.delete_at(i)}"
             next
@@ -83,7 +83,13 @@ module DaemonKit
             next
           end
 
-          if argv[i] == "--pidfile" || argv[i] == "--pid"
+          if argv[i] == "-i" || argv[i] == "--instance"
+            argv.delete_at( i )
+            configs << "instance=#{argv.delete_at(i)}"
+            next
+          end
+
+          if argv[i] == "-p" || argv[i] == "--pidfile" || argv[i] == "--pid"
             argv.delete_at( i )
             configs << "pid_file=#{argv.delete_at(i)}"
             next
@@ -123,23 +129,27 @@ module DaemonKit
         arg_file = File.join( DaemonKit.root, 'config', 'arguments.rb' )
         eval(IO.read(arg_file), binding, arg_file) if File.exists?( arg_file )
 
-        opts.on("-e", "--env ENVIRONMENT", "Environment for the process", "Defaults to development") do
+        opts.on("-e", "--env", "--environment ENV", "Environment for the process", "  Default: development") do
+          # Nothing, just here for show
+        end
+
+        opts.on("-i", "--instance N", "Process instance number", "  Default: 1") do
           # Nothing, just here for show
         end
 
-        opts.on("--pidfile PATH", "Path to the pidfile", "Defaults to log/#{DaemonKit.configuration.daemon_name}.pid") do
+        opts.on("-p", "--pid", "--pidfile PATH", "Path to the pidfile", "  Default: log/#{DaemonKit.configuration.daemon_name}.N.pid") do
           # Nothing, just here for show
         end
 
-        opts.on("-l", "--log /path/to/logfile", "Path to the log file", "Defaults to log/[environment].log") do
+        opts.on("-l", "--log PATH", "Path to the log file", "  Default: log/[environment].log") do
           # Nothing, just here for show
         end
 
         opts.separator ""
         opts.separator "Advanced configurations:"
-        opts.on("--config ATTRIBUTE=VALUE",
+        opts.on("-c", "--config ATTRIBUTE=VALUE",
                 "Change values of the daemon-kit Configuration instance",
-                "Example: log_dir=/path/to/log-directory") do
+                "  Example: log_dir=/path/to/log-directory") do
           # Nothing, just here for show
         end
 

data/lib/daemon_kit/config.rb

@@ -16,6 +16,8 @@ module DaemonKit
   # Any of the keys can be called as methods as well.
   class Config
 
+    require "yaml"
+    
     class << self
 
       # Load the +config+.yml file from DAEMON_ROOT/config

data/lib/daemon_kit/dk_sqs.rb

@@ -0,0 +1,35 @@
+require "aws/sqs"
+
+module DaemonKit
+  # Thin wrapper around the aws-sdk gem, specifically designed to ease
+  # configuration of the SQS client
+  class SQS
+
+    @@instance = nil
+
+    class << self
+
+      def instance
+        @instance ||= new
+      end
+
+      private :new
+
+      def run(config = {}, &block)
+        instance.run(config, &block)
+      end
+    end
+
+    def initialize
+      @config = DaemonKit::Config.load("sqs").to_h(true)
+    end
+
+    def run(config = {}, &block)
+      sqs_config = @config.merge(config)
+      DaemonKit.logger.debug("AWS::SQS.new(#{sqs_config.inspect})")
+      sqs = ::AWS::SQS.new(sqs_config)
+      DaemonKit.logger.debug("# => #{sqs.client.inspect}")
+      block.call(sqs)
+    end
+  end
+end

data/lib/daemon_kit/generators.rb

@@ -1,6 +1,3 @@
-# TODO: Don't always depend on bundled thor
-$:.unshift File.dirname(__FILE__) + '/vendor/thor-0.13.6/lib'
-
 require 'daemon_kit/generators/base'
 
 module DaemonKit
@@ -8,6 +5,7 @@ module DaemonKit
     autoload :AppGenerator,         'generators/daemon_kit/app/app_generator'
     autoload :CucumberGenerator,    'generators/daemon_kit/cucumber/cucumber_generator'
     autoload :AmqpGenerator,        'generators/daemon_kit/amqp/amqp_generator'
+    autoload :SqsGenerator,         'generators/daemon_kit/sqs/sqs_generator'
     autoload :CronGenerator,        'generators/daemon_kit/cron/cron_generator'
     autoload :CapistranoGenerator,  'generators/daemon_kit/capistrano/capistrano_generator'
     autoload :NaniteAgentGenerator, 'generators/daemon_kit/nanite_agent/nanite_agent_generator'

data/lib/daemon_kit/initializer.rb

@@ -241,8 +241,11 @@ module DaemonKit
     # Duplicate log data to stdout
     attr_accessor :log_stdout
 
+    # Process instance number, defaults to 1
+    attr_accessor :instance
+
     # Path to the pid file, defaults to 'log/<daemon_name>.pid'
-    attr_accessor :pid_file
+    attr_writer :pid_file
 
     # The application name
     configurable :daemon_name, :locked => true
@@ -322,8 +325,12 @@ module DaemonKit
       @shutdown_hooks << ( proc || block )
     end
 
-    def pid_file
-      @pid_file ||= "#{File.dirname(self.log_path)}/#{self.daemon_name}.pid"
+    def pid_file( instance = nil )
+      @pid_file ||= "#{File.dirname(self.log_path)}/#{self.daemon_name}.#{instance}.pid"
+    end
+
+    def instance
+      @instance ||= 1
     end
 
     # Set the log level

data/lib/daemon_kit/version.rb

@@ -1,6 +1,6 @@
 module DaemonKit
   def version
-    '0.1.8.2'
+    '0.2.0'
   end
   module_function :version
 end

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

@@ -17,17 +17,15 @@ end
 # daemon won't work as advertised.
 
 # Run an event-loop for processing
-DaemonKit::AMQP.run do
+DaemonKit::AMQP.run do |connection|
   # 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|
+  # connection.on_tcp_connection_loss do |client, settings|
   #   DaemonKit.logger.debug("AMQP connection status changed: #{status}")
-  #   if status == :disconnected
-  #     AMQP.conn.reconnect(true)
-  #   end
+  #   client.reconnect(false, 1)
   # end
 
   amq = AMQP::Channel.new

data/lib/generators/daemon_kit/app/app_generator.rb

@@ -1,7 +1,7 @@
 module DaemonKit
   module Generators
     class AppGenerator < Base
-      INSTALLERS = %w( default amqp cron nanite_agent ruote xmpp )
+      INSTALLERS = %w( default amqp sqs cron nanite_agent ruote xmpp )
       DEPLOYERS  = %w( capistrano )
       TEST_FRAMEWORKS = %w( none rspec test_unit )
       add_shebang_option!
@@ -93,6 +93,8 @@ module DaemonKit
           directory 'libexec'
         when 'amqp'
           invoke DaemonKit::Generators::AmqpGenerator
+        when 'sqs'
+          invoke DaemonKit::Generators::SqsGenerator
         when 'cron'
           invoke DaemonKit::Generators::CronGenerator
         when 'nanite_agent'

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

@@ -3,6 +3,8 @@
 # 'bundle install' to get them all installed. Daemon-kit's capistrano
 # deployment will ensure that the bundle required by your daemon is properly
 # installed.
+#
+# For more information on bundler, please visit http://gembundler.com
 
 source :gemcutter
 
@@ -13,5 +15,3 @@ gem 'daemon-kit'
 gem 'safely'
 # gem 'toadhopper' # For reporting exceptions to hoptoad
 # gem 'mail' # For reporting exceptions via mail
-
-# For more information on bundler, please visit http://gembundler.com

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

@@ -34,6 +34,13 @@ vendor/
 tmp/
   Scratch folder
 
+Rake Tasks
+==========
+
+Note that the Rakefile does not load the `config/environments.rb` file, so if you have
+environment-specific tasks (such as tests), you will need to call rake with the environment:
+
+    DAEMON_ENV=staging bundle exec rake -T
 
 Logging
 =======

data/lib/generators/daemon_kit/app/templates/config/environment.rb.tt

@@ -6,7 +6,7 @@
 # Boot up
 require File.join(File.dirname(__FILE__), 'boot')
 
-# Auto-require default libraries and those for the current Rails environment.
+# Auto-require default libraries and those for the current ruby environment.
 Bundler.require :default, DaemonKit.env
 
 DaemonKit::Initializer.run do |config|

data/lib/generators/daemon_kit/rspec/rspec_generator.rb

@@ -2,6 +2,16 @@ module DaemonKit
   module Generators
     class SpecGenerator < Base
 
+      def update_gemfile
+        append_file 'Gemfile', "group :development, :test do\n  gem 'rspec'\nend\n"
+        append_file 'Gemfile', <<-GEM
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+end
+GEM
+      end
+
       def create_specs
         directory 'spec'
       end

data/lib/generators/daemon_kit/rspec/templates/spec/spec_helper.rb

@@ -1,17 +1,16 @@
 DAEMON_ENV = 'test' unless defined?( DAEMON_ENV )
 
 begin
-  require 'spec'
+  require 'rspec'
 rescue LoadError
   require 'rubygems'
-  gem 'rspec'
-  require 'spec'
+  require 'rspec'
 end
 
 require File.dirname(__FILE__) + '/../config/environment'
 DaemonKit::Application.running!
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   # == Mock Framework
   #
   # RSpec uses it's own mocking framework by default. If you prefer to

data/lib/generators/daemon_kit/rspec/templates/tasks/rspec.rake

@@ -1,21 +1,13 @@
-begin
-  require 'spec'
-  require 'spec/rake/spectask'
-rescue LoadError
-  puts <<-EOS
-To use rspec for testing you must install rspec gem:
-    gem install rspec
-EOS
-end
-
-begin
-  require 'spec/rake/spectask'
+if ['test', 'development'].include?(DAEMON_ENV)
+  require 'rspec'
+  require 'rspec/core/rake_task'
 
   desc "Run the specs under spec/"
-  Spec::Rake::SpecTask.new do |t|
-    t.spec_opts = ['--options', "spec/spec.opts"]
-    t.spec_files = FileList['spec/**/*_spec.rb']
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = ['--options', "spec/spec.opts"]
   end
-rescue NameError, LoadError
-  # No loss, warning printed already
+
+  # Want other tests/tasks run by default?
+  # Add them to the list
+  task :default => [:spec] #, :features]
 end

data/lib/generators/daemon_kit/sqs/USAGE

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

data/lib/generators/daemon_kit/sqs/sqs_generator.rb

@@ -0,0 +1,24 @@
+module DaemonKit
+  module Generators
+    class SqsGenerator < Base
+
+      def update_gemfile
+        append_file 'Gemfile', "gem 'aws-sdk'\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