semi_daemon 0.9.1

data/lib/semi_daemon/version.rb

@@ -0,0 +1,12 @@
+class SemiDaemon
+  
+  module Version
+    MAJOR = 0
+    MINOR = 9
+    TINY = 1
+    
+    # 0.9.1
+    FULL = [MAJOR, MINOR, TINY].join(".")
+  end
+    
+end

data/lib/semi_daemon.rb

@@ -0,0 +1,147 @@
+require File.dirname(__FILE__) + "/../vendor/god/system/process"
+
+class SemiDaemon
+
+  class SimpleLogFormatter
+    def call(severity, time, progname, msg)
+      "#{time.strftime("%Y-%m-%d %H:%M:%S")}: #{msg}\n"
+    end
+  end
+  
+  class << self
+
+    def daemon_name
+      self.to_s.underscore
+    end
+    
+    def log_file(log=nil)
+      log ? @log_file=log : @log_file
+    end
+  
+    def pid_file(pid_file=nil)
+      pid_file ? @pid_file=pid_file : @pid_file
+    end    
+  
+    def interval(int=nil)
+      int ? @interval=int : @interval
+    end
+    
+    def inherited(child)
+      child.log_file "#{child.daemon_name}.log"
+      child.pid_file "#{child.daemon_name}.pid"
+    end
+
+    def stop_file
+      "#{daemon_name}.stop"
+    end
+
+  end
+  
+  # create instance methods for our class methods
+  def method_missing(m,*args)
+    if [:log_file, :pid_file, :interval, :daemon_name,:stop_file].include?(m)
+      self.class.send(m) 
+    else
+      super(m,*args)
+    end
+  end
+  
+  # logging
+
+  def logger
+    @logger ||= begin
+      l=Logger.new root("log/#{log_file}")
+      l.formatter = SimpleLogFormatter.new
+      l
+    end
+  end
+
+  # process management
+  
+  def root(path)
+    if defined?(Rails)
+      (Rails.root + path).to_s
+    else
+      dir = File.dirname(__FILE__)
+      path[0..0]=="/" ? path : File.join(dir, path)
+    end
+  end
+
+  def stop_file_path
+    root stop_file
+  end
+  
+  def pid_file_path
+    root pid_file
+  end
+
+  def create_pid_file
+    File.open(pid_file_path,"w") { |f| f.write(Process.pid) }
+  end
+
+  def running?
+     if File.exists?(pid_file_path)
+       pid=File.read(pid_file_path)
+       God::System::Process.new(pid).exists?
+     end
+   end
+  
+  def work
+    raise "You need to define the work method in your subclass of SemiDaemon."
+  end
+  
+  def terminate
+    logger.info "#{daemon_name} stopped."
+    Rails.logger.info "#{daemon_name} stopped." if defined?(Rails)
+    File.delete(pid_file_path) rescue nil
+    File.delete(stop_file_path) rescue nil
+    exit
+  end
+  
+  def transaction(&block)
+    terminate if @quit
+    @safe_to_quit=false
+    r=block.call
+    @safe_to_quit=true
+    terminate if @quit
+    r
+  end
+  
+  def initialize
+    @safe_to_quit=true
+  end
+  
+  def wants_quit?
+    File.exists?(stop_file_path) or @quit
+  end
+  
+  def run
+    raise "You must specify `interval 1.minute` or similar in your class to set the interval." if interval.nil?
+    return if running?
+    Signal.trap("TERM") do 
+      @quit=true
+      # if it's not safe to quit then we have to trust that our
+      # child class will quit when it can or else we'll quit at
+      # the beginning of the next event loop
+      terminate if @safe_to_quit
+    end
+
+    create_pid_file
+    logger.info "#{daemon_name} started (PID: #{Process.pid})."
+    while(true)
+      if wants_quit?
+        logger.info "Being asked to stop (#{@quit ? "TERM" : "stop file"}), stopping..."
+        terminate
+      end
+      logger.info "Working..."
+      work
+      if defined?(ActiveRecord::Base)
+        ActiveRecord::Base.clear_active_connections! 
+      end
+      logger.info "Sleeping for #{interval/60} minutes..."
+      # we do this so we can stop more quickly while sleeping
+      interval.to_i.times { sleep 1 unless @quit }
+    end
+  end
+  
+end

data/readme.markdown

@@ -0,0 +1,49 @@
+SemiDaemon
+==========
+
+Why
+---
+
+Before this I've tried `backgroundDRB`, `daemon_generator` (I think that's the name), and they never really worked to my satisfaction.  I did find `background_job` for scheduled background stuff and liked how simple it was to setup and get started.  SemiDaemon is kind of patterned after the simplicity of setting up it's daemon process.
+
+
+An example class
+----------------
+
+    class CampaignSender < SemiDaemon
+  
+      # defaulted based on the name of the class if you don't provide them
+      # log and pid will both be stored in your RAILS_ROOT/log folder
+      log_file "campaign_sender.log"
+      pid_file "campaign_sender.pid"
+
+      # you must provide an interval that your work function is called
+      interval 2.hours
+  
+      # your work function is called every 2 hours
+      def work
+        logger.info "Running the queue..."
+        Campaign.run_queue!
+      rescue StandardError => e
+        logger.error "-----"
+        logger.error e.message
+        e.backtrace.each { |x| logger.error x }
+        logger.error "-----"
+      end
+  
+    end
+
+Setting it up with crontab
+--------------------------
+
+The following cron entry will start the daemon every hour.  If the process is already running them the new process will simply quit.
+
+    0 * * * * /usr/bin/ruby /u/apps/your_app/current/script/runner -e production "CampaignSender.new.run"
+    
+If the process ever dies for any reason cron will send you the stack trace via e-mail (if you have that setup right).  And one hour (or less) later the process will fire itself right back up again.
+
+
+Enjoy,
+
+Josh Goebel
+Dreamer3 on #rubyonrails/freenode

data/vendor/god/system/process.rb

@@ -0,0 +1,17 @@
+module God
+  module System
+  
+    class Process
+      def initialize(pid)
+        @pid = pid.to_i
+      end
+      
+      # Return true if this process is running, false otherwise
+      def exists?
+        !!::Process.kill(0, @pid) rescue false
+      end
+      
+    end
+  
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: semi_daemon
+version: !ruby/object:Gem::Version 
+  hash: 57
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  - 1
+  version: 0.9.1
+platform: ruby
+authors: 
+- Josh Goebel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-06 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: simple class for creating long running daemon processes easily
+email: josh@autoraptor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- readme.markdown
+files: 
+- Rakefile
+- lib/semi_daemon/version.rb
+- lib/semi_daemon.rb
+- vendor/god/system/process.rb
+- readme.markdown
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: simple class for creating long running daemon processes
+test_files: []
+