djinn 0.0.1 → 0.0.2

data/.gitignore

@@ -19,3 +19,6 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+*.log
+log
+**/*.log

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "djinn"
-    gem.summary = %Q{Poorly-named Daemon Helper}
+    gem.summary = %Q{Simple helper for creating daemons}
     gem.description = %Q{Helper for creating custom daemon, mostly for rails}
     gem.email = "darksavant@gmail.com"
     gem.homepage = "http://github.com/craigp/djinn"

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/djinn.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{djinn}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Craig Paterson"]
@@ -24,7 +24,14 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "djinn.gemspec",
+     "example/basic.rb",
+     "example/em.rb",
      "lib/djinn.rb",
+     "lib/djinn/logging_helpers.rb",
+     "lib/djinn/pid_file.rb",
+     "lib/djinn/rails/boot_daemon.rb",
+     "lib/djinn/rails/daemon_base.rb",
+     "lib/djinn/tonic.rb",
      "test/helper.rb",
      "test/test_djinn.rb"
   ]
@@ -32,7 +39,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Poorly-named Daemon Helper}
+  s.summary = %q{Simple helper for creating daemons}
   s.test_files = [
     "test/helper.rb",
      "test/test_djinn.rb"

data/example/basic.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "../lib/"))
+
+require 'djinn'
+require 'rubygems'
+
+class Basic
+  
+  include Djinn
+  
+  # not providing a "perform" method falls back to the
+  # base method in Djinn..
+  
+  def handle_exit
+    puts "Handling a nice graceful exit myself.."
+    super
+  end
+  
+end
+
+puts "Running for 10 secs and then stopping.."
+
+djinn = Basic.new
+# djinn.run
+djinn.start
+sleep(10)
+djinn.stop

data/example/em.rb

@@ -0,0 +1,58 @@
+$:.unshift(File.join(File.dirname(__FILE__), "../lib/"))
+
+require 'djinn'
+require 'rubygems'
+require 'eventmachine'
+
+WORKER_INTERVAL = 5
+
+class Worker
+
+  include EM::Deferrable
+  
+  def do_stuff
+    puts "Worker doing stuff.."
+    succeed(Time.now)
+  rescue => e
+    fail(e)    
+  end
+
+end
+
+class EventMachineDjinn
+  
+  include Djinn
+  
+  def perform
+    
+    worker = EM.spawn do
+      worker = Worker.new
+      worker.callback { |time| puts "Worker completed at: #{time}" }
+      worker.errback { |ex| puts "Twitter worker failed: #{ex}" }
+      worker.do_stuff
+    end
+    
+    EM.run do
+      log "Workers will run every #{WORKER_INTERVAL} secs"
+      EM::PeriodicTimer.new(WORKER_INTERVAL) do
+        worker.notify
+      end
+    end
+
+  end
+  
+  def handle_exit
+    EM.stop
+    super
+  end
+  
+end
+
+puts "Running for 30 secs and then stopping.."
+
+djinn = EventMachineDjinn.new
+djinn.start
+sleep(30)
+djinn.stop
+
+

data/lib/djinn.rb

@@ -0,0 +1,104 @@
+module Djinn
+
+  require 'djinn/tonic'
+  require 'djinn/pid_file'
+  require 'djinn/logging_helpers'
+
+  include Djinn::Tonic
+  include Djinn::LoggingHelpers
+  
+  attr_reader :config
+
+  def log msg
+    puts "#{Time.now.strftime("%m/%d/%Y %H:%M:%S")}: #{msg}"
+    STDOUT.flush
+  end
+
+  def perform
+    # base implementation does nothing worthwhile
+    trap('TERM') { handle_exit }
+    trap('INT')  { handle_exit }
+    while true
+      log("[#{name}] Djinn is running..")
+      sleep(5)
+    end 
+  end
+  
+  def handle_exit
+    # override this with useful exit code if you need it
+    exit(0)
+  end
+
+  def start config={}
+    @config = (config.empty?) ? load_config : config.empty?
+    log "Starting #{underscore(name)} in the background.."
+    logfile = get_logfile(config)
+    daemonize(logfile, get_pidfile(config)) do
+      trap('TERM') { handle_exit }
+      trap('INT')  { handle_exit }
+      perform
+    end
+  end
+
+  def run config={}
+    @config = (config.empty?) ? load_config : config.empty?
+    log "Starting #{underscore(name)} in the foreground.."
+    trap('TERM') { handle_exit }
+    trap('INT')  { handle_exit }
+    perform
+  end
+
+  def restart
+    stop
+    start
+  end
+
+  def stop
+    pidfile = get_pidfile(load_config)
+    log 'No such process' and exit unless pidfile.pid
+    begin
+      log "Sending TERM signal to process #{pidfile.pid}"
+      Process.kill("TERM", pidfile.pid)
+    rescue
+      log 'Could not find process'
+    ensure
+      pidfile.remove
+    end
+  end
+
+  private
+  
+    def name
+      self.class
+    end
+
+    def get_pidfile config
+      pid_file_path = config[:pid_file_path] || 
+        File.join(Dir.pwd, "#{underscore(name)}.pid")
+      PidFile.new(pid_file_path)
+    end
+
+    def get_logfile config
+      log_file_path = config[:log_file_path] || 
+        File.join(Dir.pwd, "#{underscore(name)}.log")
+      log_file_path
+    end
+
+    def load_config
+      config_path = File.join(Dir.pwd, "#{underscore(name)}.yml")
+      if File.exists?(config_path)
+        YAML.load_file(config_path)
+      else
+        {}
+      end
+    end
+
+    def underscore(camel_cased_word)
+      camel_cased_word.to_s.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+
+end

data/lib/djinn/logging_helpers.rb

@@ -0,0 +1,21 @@
+module Djinn
+  module LoggingHelpers
+  
+    def green text
+      colorize 32, text
+    end
+
+    def red text
+      colorize 31, text
+    end
+  
+    def cyan text
+      colorize 36, text
+    end
+
+    def colorize color, text
+      "\033[#{color}m#{text}\033[0m"
+    end
+  
+  end
+end

data/lib/djinn/pid_file.rb

@@ -0,0 +1,30 @@
+module Djinn
+  class PidFile
+
+    attr_reader :file
+
+    def initialize(file)
+      @file = file 
+    end
+
+    def pid
+      File.exists?(@file) and IO.read(@file).to_i
+    end
+
+    def remove
+      File.unlink(@file) if pid
+    end
+
+    def create
+      File.open(@file, "w") { |f| f.write($$) }
+    end
+
+    def ensure_empty!(msg = nil)
+      if self.pid
+        $stdout.puts msg if msg
+        exit 1
+      end
+    end
+
+  end
+end

data/lib/djinn/rails/boot_daemon.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'optparse'
+
+environment = ENV["RAILS_ENV"] || "development"
+@action = "run"
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: social_daemon [options] {start|stop|restart|run}"
+  
+  opts.on("-e", "--environment ENV", "Run in specific Rails environment") do |e|
+    environment = e
+  end
+
+  @action = opts.permute!(ARGV)
+  # (puts opts; exit(1)) unless action.size == 1
+
+  @action = @action.first || "run"
+  (puts opts; exit(1)) unless %w(start stop restart run).include?(@action)
+  
+end.parse!
+
+ENV["RAILS_ENV"] = environment
+
+require 'daemon_base'
+

data/lib/djinn/rails/daemon_base.rb

@@ -0,0 +1,99 @@
+module Djinn
+  module Rails
+    class Base
+
+      require 'yaml'
+      require 'daemon'
+      require 'pid_file'
+      require 'daemon_logging'
+
+      extend Djinn::Daemon
+      include Djinn::LoggingHelpers
+  
+      def log m
+        DaemonBase.log m
+      end
+    
+      class << self
+    
+        def log m
+          puts "#{Time.now.strftime("%m/%d/%Y %H:%M:%S")}: #{m}"
+          STDOUT.flush
+        end
+    
+        def perform config
+          raise "Not implemented"
+        end
+  
+        def start
+          log "Starting #{underscore(self.name)} in the background.."
+          config = load_config
+          logfile = get_logfile(config)
+          daemonize(config, logfile, get_pidfile(config)) do
+            load_rails
+            self.new(config).do_stuff
+          end
+        end
+  
+        def run
+          log "Starting #{underscore(self.name)} in the foreground.."
+          load_rails
+          self.new(load_config).do_stuff
+        end
+  
+        def restart
+          stop
+          start
+        end
+  
+        def stop
+          pidfile = get_pidfile(load_config)
+          log 'No such process' and exit unless pidfile.pid
+          begin
+            log "Sending TERM signal to process #{pidfile.pid}"
+            Process.kill("TERM", pidfile.pid)
+          rescue
+            log 'Could not find process'
+          ensure
+            pidfile.remove
+          end
+        end
+    
+        private
+    
+        def get_pidfile(config)
+          PidFile.new(File.join(File.dirname(__FILE__), '..', '..', 'log', config['pid_file']))
+        end
+    
+        def get_logfile(config)
+          File.join(File.dirname(__FILE__), '..', '..', 'log', config['log_file'])
+        end
+    
+        def load_rails
+          log "Loading Rails in #{ENV['RAILS_ENV']} environment"
+          require File.join(File.dirname(__FILE__), '..', '..', 'config', 'environment')
+        end
+    
+        def load_config
+          path = File.join(File.dirname(__FILE__), '..', '..', 'config', "#{underscore(self.name)}.yml")
+          unless File.exists?(path)
+            log "No config file for daemon: #{path}"
+            exit(1)
+          else
+            YAML.load_file(path)[ENV['RAILS_ENV']]
+          end
+        end
+    
+        def underscore(camel_cased_word)
+          camel_cased_word.to_s.gsub(/::/, '/').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").
+            downcase
+        end
+      
+      end
+  
+    end
+  end
+end

data/lib/djinn/tonic.rb

@@ -0,0 +1,55 @@
+module Djinn
+  module Tonic
+  
+    def daemonize(logfile, pidfile, &block)
+    
+      pidfile.ensure_empty! "ERROR: It looks like I'm already running. Not starting."
+    
+      puts "Djinn is leaving process #{$$}"
+    
+      srand # Split rand streams between spawning and daemonized process
+      #fork and exit # Fork and exit from the parent
+      fork do
+    
+        puts "Daemonizing on process #{$$}" 
+        puts system("ps aux | grep #{$$}")
+    
+        # trap('TERM') { do_exit }
+        # trap('INT') { do_exit }
+        
+        #Dir.chdir "/"   # Release old working directory
+        File.umask 0000 # Ensure sensible umask
+    
+        puts 'Making sure all file descriptors are closed'
+        ObjectSpace.each_object(IO) do |io|
+          unless [STDIN, STDOUT, STDERR].include?(io)
+            begin
+              io.close unless io.closed?
+            rescue ::Exception
+            end
+          end
+        end
+        
+        puts "Writing PID file: #{pidfile.file}"
+        pidfile.create
+    
+        puts 'Detaching from the controlling terminal'
+        unless sess_id = Process.setsid
+          raise 'cannot detach from controlling terminal'
+        end
+    
+        # Redirect IO
+        puts "Logging to: #{logfile}"
+        STDIN.reopen('/dev/null')
+        STDOUT.reopen(logfile, 'a')
+        STDERR.reopen(STDOUT)
+    
+        yield
+    
+      end
+    
+    end
+  
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: djinn
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Craig Paterson
@@ -51,7 +51,14 @@ files:
 - Rakefile
 - VERSION
 - djinn.gemspec
+- example/basic.rb
+- example/em.rb
 - lib/djinn.rb
+- lib/djinn/logging_helpers.rb
+- lib/djinn/pid_file.rb
+- lib/djinn/rails/boot_daemon.rb
+- lib/djinn/rails/daemon_base.rb
+- lib/djinn/tonic.rb
 - test/helper.rb
 - test/test_djinn.rb
 has_rdoc: true
@@ -87,7 +94,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Poorly-named Daemon Helper
+summary: Simple helper for creating daemons
 test_files: 
 - test/helper.rb
 - test/test_djinn.rb