asmodai 0.1.0

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+play.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in asmodai.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    asmodai (0.1.0)
+      thor (>= 0.14.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  asmodai!
+  bundler (>= 1.0.0.rc.5)
+  thor (>= 0.14.6)

data/README.md

@@ -0,0 +1,109 @@
+# Asmodai
+
+## Description
+
+Asmodai is a simple-to-use generator for daemon tasks written in Ruby. It makes 
+creating a daemon as straight forward as creating a Rails-application and saves 
+you the hassle of boring and repetitive tasks like creating start- and 
+stop-scripts, pid-file logic or implementing logging.
+
+## Installation
+
+$ gem install asmodai
+
+## Usage
+
+$ asmodai new foobar
+
+$ cd foobar
+
+Here you will find a dummy implementation:
+
+    class Foobar < Asmodai::Daemon
+      attr_accessor :running
+      
+      def on_signal(sig)
+        # perform cleanup or stop an eventloop
+        self.running=false
+      end
+      
+      def run
+        self.running=true
+        while running
+          logger.info { "I'm still running" }
+          sleep 1
+        end
+      end
+    end
+
+You can develop your daemon by executing 
+
+$ asmodai foreground
+
+This executes the daemon in the foreground and outputs all logging to standard
+output. It can be terminated with Ctrl-C.
+
+To start your daemon in the background run
+
+$ asmodai start
+
+Check the status of the daemon
+
+$ asmodai status
+  => foobar runs with pid 75952
+  
+Stop the daemon
+
+$ asmodai stop
+
+## Example: Using Asmodai with EventMachine
+
+$ asmodai new echo
+$ cd echo
+
+Edit the Gemfile
+
+    source 'http://rubygems.org'
+
+    gem 'activesupport', ">= 3.0.0"
+    gem 'eventmachine'
+  
+Edit lib/server.rb
+
+    module Echo::Server
+      def post_init
+        puts "-- someone connected to the echo server!"
+      end
+    
+      def receive_data data
+        send_data ">>>you sent: #{data}"
+        close_connection if data =~ /quit/i
+      end
+    
+      def unbind
+        puts "-- someone disconnected from the echo server!"
+      end
+    end
+
+Edit echo.rb
+
+    class Echo < Asmodai::Daemon
+      require 'server' # lib is automatically added to the $LOAD_PATH
+      
+      attr_accessor :running
+      
+      def on_signal(sig)
+        EventMachine::stop_event_loop
+      end
+      
+      def run
+        EventMachine::run do 
+          EventMachine::start_server "127.0.0.1", 8081, Echo::Server
+        end
+      end
+    end
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+namespace :asmodai do
+  desc "Runs the unit tests"
+  task :test do 
+    $LOAD_PATH.unshift(File.dirname(__FILE__))
+    Dir['test/*_test.rb'].each do |f|
+      require f
+    end
+  end
+end

data/asmodai.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'asmodai/version'
+
+Gem::Specification.new do |s|
+  s.name        = "asmodai"
+  s.version     = Asmodai::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Sebastian Morawietz"]
+  s.email       = []
+  s.homepage    = "http://rubygems.org/gems/asmodai"
+  s.summary     = "A simple daemon generator"
+  s.description = "A simple daemon generator"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "asmodai"
+
+  s.add_development_dependency "bundler", ">= 1.0.0.rc.5"
+  s.add_dependency 'thor', ">=0.14.6"
+  
+  s.files        = (`git ls-files`.split("\n")+Dir['lib/asmodai/generator/templates/*']).uniq
+  s.executables  = ['asmodai']
+  s.require_path = 'lib'
+end

data/bin/asmodai

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'asmodai'
+require 'asmodai/cli'
+
+Asmodai.root = Pathname.new(Dir.pwd)
+$LOAD_PATH.unshift(Asmodai.root.join("lib").to_s)
+Asmodai::CLI.start

data/lib/asmodai.rb

@@ -0,0 +1,30 @@
+require 'pathname'
+require 'logger'
+
+module Asmodai
+  class << self
+    attr_accessor :root
+    
+    def log_file_path
+      @log_file_path ||=
+        Asmodai.root.join("log/#{Asmodai::Info.current.daemon_name}.log")
+    end
+  
+    def log_file
+      @log_file ||= 
+        log_file_path.open("a").tap do |r|
+          r.sync = true
+        end
+    end
+
+    def logger
+      @logger ||= Logger.new($stdout).tap do |logger|
+        logger.formatter = Logger::Formatter.new
+      end
+    end
+  end
+  
+  require 'asmodai/info'  
+  require 'asmodai/logging'
+  require 'asmodai/daemon'
+end

data/lib/asmodai/cli.rb

@@ -0,0 +1,86 @@
+require 'thor'
+require 'thor/group'
+require 'thor/actions'
+require 'active_support'
+require 'active_support/core_ext'
+
+class Asmodai::CLI < Thor
+  include Thor::Actions
+  attr_accessor :app_name
+  
+  def self.source_root
+    File.join(File.dirname(__FILE__), "generator")
+  end
+  
+  desc "new <appname>", "create a new Asmodai-App"
+  def new(name)
+    @app_name=name
+    empty_directory "#{name}/log"
+    empty_directory "#{name}/lib"    
+    template 'templates/daemon.rb.erb', "#{name}/#{name}.rb"
+    copy_file 'templates/Gemfile', "#{name}/Gemfile"
+  end
+  
+  desc "install", "Installs startup scripts to /etc/init.d"
+  method_option :autostart,
+                :type => :boolean,
+                :desc => %{If you provide this, startup-links will be generated for the given runlevel. This is currently only supported on Debian/Ubuntu.}
+  def install
+    @info = Asmodai::Info.current
+    path = "/etc/init.d/#{@info.daemon_name}"
+    template "templates/init_d.erb", path
+    system "chmod a+x #{path}"
+    if options[:autostart]
+      if (update_bin=`which update-rc.d`.strip).blank?
+        warn "update-rc.d was not found. Omitting autostart installation."
+      else
+        `#{update_bin} #{@info.daemon_name} defaults`
+      end
+    end
+  end
+    
+  desc "foreground", "Runs the daemon in foreground logging to stdout"
+  def foreground
+    instance=Asmodai::Info.current.daemon_class.new
+    instance.foreground
+  end
+  
+  desc "start", "Runs the daemon in the background"
+  def start
+    klass = Asmodai::Info.current.daemon_class
+    puts "Starting #{klass.daemon_name}"
+    if klass.start
+      puts "Ok."
+    else
+      puts "#{klass.daemon_name} seems to be already running"
+    end
+  end
+
+  desc "stop", "Stops the daemon"
+  def stop
+    Asmodai::Info.current.daemon_class.tap do |klass|
+      puts "Stopping #{klass.daemon_name}"
+      if klass.terminate
+        puts "Ok."
+      else
+        puts "#{klass.daemon_name} doesn't seem to be running."
+      end
+    end
+  end
+
+  desc "status", "Prints the current status of the daemon"
+  def status
+    klass = Asmodai::Info.current.daemon_class
+    if !klass.is_running?
+      puts "#{klass.daemon_name} doesn't seem to be running"
+    else
+      puts "#{klass.daemon_name} runs with pid #{klass.pid}"
+    end      
+  end
+
+  desc "console", "Starts a console with loaded environment"
+  def console
+    klass = Asmodai::Info.current.daemon_class
+    exec "irb -r rubygems -r asmodai -r ./#{klass.daemon_name}"
+  end
+end

data/lib/asmodai/daemon.rb

@@ -0,0 +1,83 @@
+class Asmodai::Daemon
+  require 'asmodai/daemon/process_management'
+  require 'asmodai/daemon/rake_task'  
+
+  extend Asmodai::Logging
+  include Asmodai::Logging
+  extend ProcessManagement
+  extend RakeTask
+
+  class << self
+    def autoload_paths
+      @autoload_paths ||= []
+    end
+    
+    def set_daemon_name(name)
+      @daemon_name=name.to_s.underscore
+    end
+    
+    def daemon_name
+      @daemon_name || name.split("::").last.to_s.underscore
+    end
+  end
+
+  def initialize
+  end
+  
+  def daemon_name
+    self.class.daemon_name
+  end
+
+  def on_signal(sig)
+    # dummy implementation
+  end
+  
+  
+  def foreground
+    prepare_run
+    perform_run
+  end
+  
+  def start 
+    prepare_run
+    pid = fork do 
+      $stdin.close
+      $stdout.reopen(log_file)
+      $stderr.reopen(log_file)
+      logger.info "Starting up #{daemon_name} at #{Time.now}, pid: #{Process.pid}"
+
+      perform_run
+    end
+    
+    self.class.pid_file_path.open("w") do |f|
+      f.puts pid
+    end
+
+    Process.detach(pid)
+  end
+
+  protected
+
+    def prepare_run
+      %w(INT TERM).each do |sig|
+        trap sig do 
+          logger.info { "Received signal #{sig}"}
+          on_signal(sig)
+        end
+      end
+      
+      
+      require 'rubygems'
+      require 'bundler'
+    
+      Bundler.setup
+      Bundler.require    
+    end
+  
+    def perform_run
+      unless respond_to? :run
+        raise ArgumentError.new("#{self.class} does not implement 'run'")
+      end
+      run
+    end
+end

data/lib/asmodai/daemon/process_management.rb

@@ -0,0 +1,35 @@
+module Asmodai::Daemon::ProcessManagement
+  def pid_file_path
+    Asmodai.root.join("log/#{daemon_name}.pid")
+  end
+  
+  def pid
+    pid_file_path.read.strip.to_i rescue 0
+  end
+  
+  def is_running?
+    pid_file_path.exist? and ( Process.kill(0,pid); true ) rescue false
+  end
+    
+  def start
+    if is_running?
+      false
+    else
+      self.new.start
+      true
+    end
+  end
+  
+  def terminate
+    if is_running?
+      Process.kill('TERM', pid)
+      while is_running?
+        sleep 0.1
+      end
+      FileUtils.rm pid_file_path.to_s
+      true
+    else
+      false
+    end
+  end
+end

data/lib/asmodai/daemon/rake_task.rb

@@ -0,0 +1,21 @@
+module Asmodai::Daemon::RakeTask
+  def install_rake_task(namespace)
+    daemon = self
+    namespace.class_eval do 
+      desc "Run the Master server in the background"
+      task :start do 
+        daemon.start
+      end
+
+      desc "Terminate the Master server"
+      task :stop do 
+        daemon.terminate
+      end
+
+      desc "Run the Master server"
+      task :run do 
+        daemon.new.perform_run
+      end
+    end
+  end
+end

data/lib/asmodai/generator/templates/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'activesupport', ">= 3.0.0"

data/lib/asmodai/generator/templates/daemon.rb.erb

@@ -0,0 +1,18 @@
+class <%= @app_name.camelize %> < Asmodai::Daemon
+  attr_accessor :running
+  
+  def on_signal(sig)
+    # perform cleanup or stop an eventloop
+    self.running=false
+  end
+  
+  def run
+    # Your real implementation goes here
+    
+    self.running=true
+    while running
+      logger.info { "I'm still running" }
+      sleep 1
+    end
+  end
+end

data/lib/asmodai/generator/templates/init_d.erb

@@ -0,0 +1,55 @@
+#! /bin/sh
+### BEGIN INIT INFO
+# Provides:          <%= @info.daemon_name %>
+# Required-Start:    $remote_fs $network
+# Required-Stop:     $remote_fs $network
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Example initscript
+# Description:       This file should be used to construct scripts to be
+#                    placed in /etc/init.d.
+### END INIT INFO
+
+DESC="Asmodai-generated daemon"
+NAME="<%= @info.daemon_name %>"
+SCRIPTNAME=/etc/init.d/$NAME
+
+do_start()
+{
+        sudo -u <%= @info.base_file_owner.name %> bash -l -c "cd <%= @info.path %> && asmodai start"
+}
+
+do_stop()
+{
+        sudo -u <%= @info.base_file_owner.name %> bash -l -c "cd <%= @info.path %> && asmodai stop"
+
+	return 0
+}
+
+#
+# Function that sends a SIGHUP to the daemon/service
+#
+do_reload() {
+        do_stop
+        do_start
+	return 0
+}
+
+case "$1" in
+  start)
+	do_start
+	;;
+  stop)
+	do_stop
+	;;
+  restart|force-reload)
+    do_stop
+    do_start
+	;;
+  *)
+	echo "Usage: $SCRIPTNAME {start|stop|restart}" >&2
+	exit 3
+	;;
+esac
+
+:

data/lib/asmodai/info.rb

@@ -0,0 +1,43 @@
+require 'pathname'
+require 'etc'
+
+class Asmodai::Info
+  attr_accessor :path
+  
+  class << self
+    def current
+      @current||=self.new
+    end
+  end
+  
+  def initialize(path=Asmodai.root)
+    self.path = path
+  end
+
+  # Returns the name of the daemon which is equal to the
+  # name of the directory, the daemon lives in
+  def daemon_name
+    File.basename(self.path)
+  end
+  
+  # Returns the camelized daemon name
+  def daemon_class_name
+    daemon_name.camelize
+  end
+  
+  # Returns the class of the Daemon
+  def daemon_class
+    require "./#{daemon_name}"
+    eval(daemon_class_name)
+  end
+  
+  # Returns the generated base file where the daemon class is
+  # declared in.
+  def base_file
+    path.join("#{daemon_name}.rb")
+  end
+  
+  def base_file_owner
+    Etc.getpwuid(Pathname.new(base_file).stat.uid)
+  end
+end

data/lib/asmodai/logging.rb

@@ -0,0 +1,7 @@
+module Asmodai::Logging
+  %w(log_file_path log_file logger).each do |method|
+    define_method method do 
+      Asmodai.send(method)
+    end
+  end
+end

data/lib/asmodai/version.rb

@@ -0,0 +1,3 @@
+module Asmodai
+  VERSION = "0.1.0"
+end

data/test/daemon_test.rb

@@ -0,0 +1,64 @@
+require 'test/test_helper'
+
+class DaemonTest < ActiveSupport::TestCase
+  TEST_APP_PATH = Pathname.new(File.join(File.dirname(__FILE__), "test_daemon" ))
+  
+  class TestDaemon < Asmodai::Daemon
+    attr_accessor :running
+    
+    def on_signal(signal)
+      self.running=false
+    end
+    
+    def run
+      self.running = true
+      while running
+        puts "Still running #{self}"
+        sleep 0.01
+      end
+    end
+  end
+
+  Asmodai.root = TEST_APP_PATH
+
+  def setup
+    %w(log/test_daemon.log log/test_daemon.pid).map do |e| 
+      TEST_APP_PATH.join(e)
+    end.each do |p|
+      p.delete rescue nil
+    end
+  end
+  
+  test "Naming the daemons" do 
+    assert_equal "test_daemon", TestDaemon.daemon_name
+  end
+  
+  test "Daemon-specific paths" do 
+    assert_equal TEST_APP_PATH, Asmodai.root
+    assert TestDaemon.log_file_path.to_s.match( /test_daemon\.log$/ )
+    assert TestDaemon.pid_file_path.to_s.match( /test_daemon\.pid$/ )    
+  end
+  
+  test "Starting and stopping the daemons" do 
+    assert !TestDaemon.is_running?
+    assert !TestDaemon.log_file_path.exist?    
+    
+    TestDaemon.start
+    assert TestDaemon.is_running?
+    assert TestDaemon.pid > 0
+
+    assert TestDaemon.log_file_path.exist?
+        
+    # Wait until some lines have been written to the log file
+    while TestDaemon.log_file_path.size < 500
+      sleep 0.1
+    end
+
+    TestDaemon.terminate
+    assert !TestDaemon.pid_file_path.exist?
+    assert TestDaemon.log_file_path.size > 0
+    TestDaemon.log_file_path.open do |f|
+      assert f.lines.to_a.last.match( /Received signal TERM/)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "../lib"))
+
+require 'test/unit'
+require 'active_support/test_case'
+require 'asmodai'
+
+ASMODAI_APP_ROOT = Pathname.new(File.join(File.dirname(__FILE__), ".."))

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: asmodai
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sebastian Morawietz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-21 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        - rc
+        - 5
+        version: 1.0.0.rc.5
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 14
+        - 6
+        version: 0.14.6
+  type: :runtime
+  version_requirements: *id002
+description: A simple daemon generator
+email: []
+
+executables: 
+- asmodai
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .bundle/config
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- asmodai.gemspec
+- bin/asmodai
+- lib/asmodai.rb
+- lib/asmodai/cli.rb
+- lib/asmodai/daemon.rb
+- lib/asmodai/daemon/process_management.rb
+- lib/asmodai/daemon/rake_task.rb
+- lib/asmodai/generator/templates/Gemfile
+- lib/asmodai/generator/templates/daemon.rb.erb
+- lib/asmodai/generator/templates/init_d.erb
+- lib/asmodai/info.rb
+- lib/asmodai/logging.rb
+- lib/asmodai/version.rb
+- test/daemon_test.rb
+- test/test_daemon/.gitignore
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/asmodai
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: asmodai
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple daemon generator
+test_files: []
+