kennethkalmer-daemon-kit 0.1.3 → 0.1.4

data/Manifest.txt

@@ -31,12 +31,20 @@ 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
+daemon_generators/nanite_agent/USAGE
+daemon_generators/nanite_agent/nanite_agent_generator.rb
+daemon_generators/nanite_agent/templates/config/initializers/nanite_agent.rb
+daemon_generators/nanite_agent/templates/config/nanite.yml
+daemon_generators/nanite_agent/templates/lib/actors/sample.rb
+daemon_generators/nanite_agent/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/nanite.rb
+lib/daemon_kit/nanite/agent.rb
 lib/daemon_kit/patches/force_kill_wait.rb
 lib/daemon_kit/tasks.rb
 lib/daemon_kit/tasks/framework.rake
@@ -60,3 +68,4 @@ test/test_cron_generator.rb
 test/test_daemon-kit_generator.rb
 test/test_generator_helper.rb
 test/test_jabber_generator.rb
+test/test_nanite_agent_generator.rb

data/TODO.txt

@@ -3,7 +3,7 @@ DaemonKit TODO List
 
 This is purely a drop in the bucket of what has to come...
 
-* [DONE] Easy way to trap signals 
+* [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:
@@ -20,5 +20,12 @@ This is purely a drop in the bucket of what has to come...
 * Improved and cleaned up logging
 * Plenty of docs, seriously a lot of docs
 * Specs & features, tons of them too
+* Integration tests for the specific daemons
 * Some level of thread safety, or mechanisms to ease thread safety
+* Built in utilities:
+  * Thread pool for 1.8
+  * Fibre pool for 1.9
+  * Some activesupport-esque functions until activesupport 3.0 hits the streets
+* DRY up the following:
+  * Loading configuration files for the daemons
 * DON'T FORGET 1.9 SUPPORT

data/app_generators/daemon_kit/daemon_kit_generator.rb

@@ -3,8 +3,8 @@ class DaemonKitGenerator < RubiGen::Base
   DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
                               Config::CONFIG['ruby_install_name'])
 
-  VALID_GENERATORS = ['default', 'jabber', 'cron', 'amqp']
-  
+  VALID_GENERATORS = ['default', 'jabber', 'cron', 'amqp', 'nanite_agent']
+
   default_options :shebang => DEFAULT_SHEBANG, :author => nil
 
   attr_reader :daemon_name
@@ -25,9 +25,9 @@ class DaemonKitGenerator < RubiGen::Base
       $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 ''
@@ -37,11 +37,11 @@ class DaemonKitGenerator < RubiGen::Base
       # 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
@@ -65,7 +65,7 @@ class DaemonKitGenerator < RubiGen::Base
 
       # Libraries
       m.directory "lib"
-      
+
       # Tests
       m.directory "tasks"
       m.dependency "install_rspec", [daemon_name], :destination => destination_root, :collision => :force

data/daemon_generators/nanite_agent/USAGE

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

data/daemon_generators/nanite_agent/nanite_agent_generator.rb

@@ -0,0 +1,68 @@
+class NaniteAgentGenerator < 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 'lib'
+      m.directory 'lib/actors'
+      m.file      'lib/actors/sample.rb', 'lib/actors/sample.rb'
+      m.directory 'config'
+      m.template  'config/nanite.yml', 'config/nanite.yml'
+      m.directory 'config/initializers'
+      m.template  'config/initializers/nanite_agent.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/nanite_agent/templates/config/initializers/nanite_agent.rb

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

data/daemon_generators/nanite_agent/templates/config/nanite.yml

@@ -0,0 +1,35 @@
+# Nanite agent configuration file
+
+# These values will be used to configure the nanite agent, any values
+# omitted will let the gem use it's own defaults.
+
+# The configuration specifies the following keys:
+# * user      - Specify the rabbitmq username
+# * pass      - Specify the rabbitmq password
+# * host      - Specify the rabbitmq hostname
+# * vhost     - Specify the rabbitmq vhost
+# * port      - Specify the rabbitmq PORT, default 5672
+# * token     - Specify the agent identity
+# * security  - Use Security features of rabbitmq to restrict nanites to themselves
+# * format    - The serialization type to use for transfering data. Can be marshal, json or yaml. Default is marshal
+# * tag       - YAML array of tags
+# * ping-time - Specify how often the agents contacts the mapper
+# * actors    - Comma separated list of actors to load (all ruby files in actors directory by default)
+
+defaults: &defaults
+  username: nanite
+  password: testing
+  host: localhost
+  vhost: /nanite
+# tag:
+#   - foo
+#   - bar
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/daemon_generators/nanite_agent/templates/lib/actors/sample.rb

@@ -0,0 +1,11 @@
+class Sample
+  include Nanite::Actor
+
+  expose :echo
+
+  # Print to STDOUT and return
+  def echo( payload )
+    p payload
+    payload
+  end
+end

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

@@ -0,0 +1,31 @@
+# Generated nanite agent 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/nanite.yml' accordingly or this
+# daemon won't work as advertised.
+#
+# Your actors live in DAEMON_ROOT/lib/actors
+
+# Run the agent, and get the running agent.
+DaemonKit::Nanite::Agent.run do |agent|
+  # Use the yielded agent instance to register your actors:
+  agent.register Sample.new
+  
+  # This block can used to make your agent perform other tasks as
+  # well. Remember that you have access to a running EventMachine
+  # reactor since the AMQP gem used by nanite uses it. Other than that
+  # you can mostly leave this file alone and concentrate on developing
+  # your actors in the lib/actors/ directory of the project.
+end

data/lib/daemon_kit/nanite/agent.rb

@@ -0,0 +1,60 @@
+module DaemonKit
+  module Nanite
+    # Pull support into a daemon for being a nanite agent.
+    class Agent
+
+      @@instance = nil
+
+      class << self
+
+        def instance
+          @instance ||= (
+            config = YAML.load_file( "#{DAEMON_ROOT}/config/nanite.yml" )[DAEMON_ENV]
+            raise ArgumentError, "Missing nanite configuration for #{DAEMON_ENV} environment" if config.nil?
+            new( config )
+          )
+        end
+
+        private :new
+
+        def run(&block)
+          instance.run(&block)
+        end
+
+      end
+
+      def initialize( options = {} )
+        @config = options.inject({}) { |m,c| m[c[0].to_sym] = c[1]; m } # symbolize_keys
+
+        config_agent
+      end
+
+      def run(&block)
+        # Ensure graceful shutdown of the connection to the broker
+        DaemonKit.trap('INT') { ::EM.stop }
+        DaemonKit.trap('TERM') { ::EM.stop }
+
+        # Start our mapper
+        mapper_thread = Thread.new do
+          EM.run do
+            agent = ::Nanite.start_agent( @config )
+            block.call( agent ) if block
+          end
+        end
+
+        #block.call if block
+
+        mapper_thread.join
+      end
+
+      private
+      
+      # Make sure to fine tune the agent config to be DK friendly
+      def config_agent
+        @config[:root] = DAEMON_ROOT
+        @config[:daemonize] = false
+        @config[:actors_dir] = File.join(DAEMON_ROOT, 'lib', 'actors')
+      end
+    end
+  end
+end

data/lib/daemon_kit/nanite.rb

@@ -0,0 +1,7 @@
+module DaemonKit
+  # For building daemons that integrate with nanite, either as mappers
+  # or agents. See #DaemonKit::Nanite::Agent so far
+  module Nanite
+    autoload :Agent, "daemon_kit/nanite/agent"
+  end
+end

data/lib/daemon_kit.rb

@@ -4,11 +4,12 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'rubygems'
 
 module DaemonKit
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
   
   autoload :Initializer, 'daemon_kit/initializer'
   autoload :Application, 'daemon_kit/application'
   autoload :Cron,        'daemon_kit/cron'
   autoload :Jabber,      'daemon_kit/jabber'
   autoload :AMQP,        'daemon_kit/amqp'
+  autoload :Nanite,      'daemon_kit/nanite'
 end

data/test/test_nanite_agent_generator.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+
+class TestNaniteAgentGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_options
+    name = "myapp"
+    run_generator('nanite_agent', [name], sources)
+    assert_directory_exists "lib/actors"
+    assert_generated_file   "lib/actors/sample.rb"
+    assert_directory_exists "config"
+    assert_generated_file   "config/nanite.yml"
+    assert_directory_exists "config/initializers"
+    assert_generated_file   "config/initializers/myapp.rb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "daemon_generators"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kennethkalmer-daemon-kit
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Kenneth Kalmer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-29 00:00:00 -07:00
+date: 2009-04-30 00:00:00 -07:00
 default_executable: daemon_kit
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -98,12 +98,20 @@ files:
 - daemon_generators/jabber/templates/config/initializers/jabber.rb
 - daemon_generators/jabber/templates/config/jabber.yml
 - daemon_generators/jabber/templates/libexec/daemon.rb
+- daemon_generators/nanite_agent/USAGE
+- daemon_generators/nanite_agent/nanite_agent_generator.rb
+- daemon_generators/nanite_agent/templates/config/initializers/nanite_agent.rb
+- daemon_generators/nanite_agent/templates/config/nanite.yml
+- daemon_generators/nanite_agent/templates/lib/actors/sample.rb
+- daemon_generators/nanite_agent/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/nanite.rb
+- lib/daemon_kit/nanite/agent.rb
 - lib/daemon_kit/patches/force_kill_wait.rb
 - lib/daemon_kit/tasks.rb
 - lib/daemon_kit/tasks/framework.rake
@@ -127,6 +135,7 @@ files:
 - test/test_daemon-kit_generator.rb
 - test/test_generator_helper.rb
 - test/test_jabber_generator.rb
+- test/test_nanite_agent_generator.rb
 has_rdoc: true
 homepage: 
 post_install_message: |+
@@ -166,3 +175,4 @@ test_files:
 - test/test_jabber_generator.rb
 - test/test_cron_generator.rb
 - test/test_amqp_generator.rb
+- test/test_nanite_agent_generator.rb