simple_daemon 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 watsonian
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,39 @@
+= simple_daemon
+
+This is a simple library for daemonizing scripts. It was extracted from Kenneth
+Kalmer's excellent daemon-kit project (http://github.com/kennethkalmer/daemon-kit).
+The daemon-kit framework is amazing for bootstrapping your daemons, but if
+you need something more lightweight (e.g., a single file daemon), then you're
+out of luck (for now). There are a number of daemon gem libraries available, but
+I was most impressed by the daemon-kit setup. This library lets you use the well
+thought out daemonization process from daemon-kit for simpler daemon setups.
+
+= Usage
+
+You set configuration options as follows:
+
+ SimpleDaemon.setup do |config
+   config.daemon_name = "some_name"
+   config.pid_file = "/var/run/some_name.pid"
+ end
+
+To actually daemonize your script, just run the code you want to run daemonized
+in a block as follows:
+
+ SimpleDaemon.daemonized do
+   loop {
+     # do something useful here
+   }
+ end
+
+The pid file is automatically created and the script is backgrounded when run. When
+the process exits the pid file is cleaned up automatically. If the process is dies
+or is forcibly killed with a KILL signal then the pid file will stay in place, but
+the daemonized blocks check to see if the process in the pid file is running or not.
+If it isn't, it will spin up a new process and replace the existing pid file. Keep
+in mind that there's no facility (yet) to handle the case where the process is still
+running, but no pid file exists.
+
+== Copyright
+
+Copyright (c) 2010 Joel Watson. Portions copyright Kenneth Kalmer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "simple_daemon"
+    gem.summary = %Q{A simple library for daemonizing scripts.}
+    gem.description = %Q{A simple library for daemonizing scripts.}
+    gem.email = "watsonian@gmail.com"
+    gem.homepage = "http://github.com/watsonian/simple_daemon"
+    gem.authors = ["watsonian"]
+    gem.add_dependency "simple_pid", ">=0.2.1"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_daemon #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/simple_daemon.rb

@@ -0,0 +1,221 @@
+require 'rubygems'
+require 'ostruct'
+require 'simple_pid'
+begin
+  require 'system_timer'
+  SimpleDaemonTimer = SystemTimer
+rescue LoadError
+  puts "Falling back to the default timeout library. You should install the SystemTimer gem for better timeout support."
+  require 'timeout'
+  SimpleDaemonTimer = Timeout
+end
+
+class SimpleDaemon
+  @@config = OpenStruct.new
+
+  class << self
+
+    def setup(&block)
+      yield @@config
+    end
+
+    # Run block in the foreground
+    def foreground(&block)
+      self.set_prerun_config_defaults
+      self.set_process_name
+      self.chroot
+      self.clean_fd
+      self.redirect_io(true)
+
+      yield
+    end
+
+    # Run block as a daemon
+    def daemonized(&block)
+      self.set_prerun_config_defaults
+      self.set_process_name
+      self.drop_privileges
+      self.daemonize
+      self.chroot
+      self.clean_fd
+      self.redirect_io
+
+      yield
+    end
+
+    # def stop
+    #   @pid_file = SimplePid.new(@@config.pid_file)
+    # 
+    #   unless @pid_file.running?
+    #     @pid_file.cleanup
+    #     puts "Nothing to stop"
+    #     exit
+    #   end
+    # 
+    #   target_pid = @pid_file.pid
+    # 
+    #   puts "Sending TERM to #{target_pid}"
+    #   Process.kill( 'TERM', target_pid )
+    # 
+    #   if seconds = @@config.force_kill_wait
+    #     begin
+    #       SimpleDaemonTimer::timeout(seconds) do
+    #         loop do
+    #           puts "Waiting #{seconds} seconds for #{target_pid} before sending KILL"
+    # 
+    #           break unless @pid_file.running?
+    # 
+    #           seconds -= 1
+    #           sleep 1
+    #         end
+    #       end
+    #     rescue Timeout::Error
+    #       Process.kill('KILL', target_pid)
+    #     end
+    #   end
+    # 
+    #   if @pid_file.running?
+    #     puts "Process still running, leaving pidfile behind! Consider using the :force_kill_wait configuration option."
+    #   else
+    #     @pid_file.cleanup
+    #   end
+    # end
+
+    # Exit the daemon
+    # TODO: Make configurable callback chain
+    # TODO: Hook into at_exit()
+    # def exit!(code = 0)
+    # end
+
+    # http://gist.github.com/304739
+    #
+    # Stolen from Unicorn::Util
+    #
+    # This reopens ALL logfiles in the process that have been rotated
+    # using logrotate(8) (without copytruncate) or similar tools.
+    # A +File+ object is considered for reopening if it is:
+    #   1) opened with the O_APPEND and O_WRONLY flags
+    #   2) opened with an absolute path (starts with "/")
+    #   3) the current open file handle does not match its original open path
+    #   4) unbuffered (as far as userspace buffering goes, not O_SYNC)
+    # Returns the number of files reopened
+    # def reopen_logs
+    #   nr = 0
+    #   append_flags = File::WRONLY | File::APPEND
+    #   @@logger.info "Rotating logs" if @@logger
+    # 
+    #   #logs = [STDOUT, STDERR]
+    #   #logs.each do |fp|
+    #   ObjectSpace.each_object(File) do |fp|
+    #     next if fp.closed?
+    #     next unless (fp.sync && fp.path[0..0] == "/")
+    #     next unless (fp.fcntl(Fcntl::F_GETFL) & append_flags) == append_flags
+    # 
+    #     begin
+    #       a, b = fp.stat, File.stat(fp.path)
+    #       next if a.ino == b.ino && a.dev == b.dev
+    #     rescue Errno::ENOENT
+    #     end
+    # 
+    #     open_arg = 'a'
+    #     if fp.respond_to?(:external_encoding) && enc = fp.external_encoding
+    #       open_arg << ":#{enc.to_s}"
+    #       enc = fp.internal_encoding and open_arg << ":#{enc.to_s}"
+    #     end
+    #     @@logger.info "Rotating path: #{fp.path}" if @@logger
+    #     fp.reopen(fp.path, open_arg)
+    #     fp.sync = true
+    #     nr += 1
+    #   end # each_object
+    #   nr
+    # end
+
+    protected
+    def set_process_name
+      $0 = @@config.daemon_name
+    end
+
+    # Set default options (called prior to yield blocks)
+    def set_prerun_config_defaults
+      @@config.daemon_name = File.basename(__FILE__) unless @@config.daemon_name
+      @@config.pid_file = "#{@@config.daemon_name}.pid" unless @@config.pid_file
+      @@config.force_kill_wait = nil unless @@config.force_kill_wait
+      @@config.group = nil unless @@config.group
+      @@config.user = nil unless @@config.user
+    end
+
+    # Daemonize the process
+    def daemonize
+      @pid_file = SimplePid.new(@@config.pid_file)
+      @pid_file.ensure_stopped!
+
+      if RUBY_VERSION < "1.9"
+        exit if fork
+        Process.setsid
+        exit if fork
+      else
+        Process.daemon( true, true )
+      end
+
+      @pid_file.write!
+
+      # TODO: Convert into shutdown hook
+      at_exit { @pid_file.cleanup }
+    end
+
+    # Release the old working directory and insure a sensible umask
+    # TODO: Make chroot directory configurable
+    def chroot
+      Dir.chdir '/'
+      File.umask 0000
+    end
+
+    # Make sure all file descriptors are closed (with the exception
+    # of STDIN, STDOUT & STDERR)
+    def clean_fd
+      ObjectSpace.each_object(IO) do |io|
+        unless [STDIN, STDOUT, STDERR].include?(io)
+          begin
+            unless io.closed?
+              io.close
+            end
+          rescue ::Exception
+          end
+        end
+      end
+    end
+
+    # Redirect our IO
+    # TODO: make this configurable
+    def redirect_io( simulate = false )
+      begin
+        STDIN.reopen '/dev/null'
+      rescue ::Exception
+      end
+
+      unless simulate
+        STDOUT.reopen '/dev/null', 'a'
+        STDERR.reopen '/dev/null', 'a'
+      end
+    end
+
+    def drop_privileges
+      if @@config.group
+        begin
+          group = Etc.getgrnam(@@config.group)
+          Process::Sys.setgid(group.gid.to_i)
+        rescue => e
+          $stderr.puts "Caught exception while trying to drop group privileges: #{e.message}"
+        end
+      end
+      if @@config.user
+        begin
+          user = Etc.getpwnam(@@config.user)
+          Process::Sys.setuid(user.uid.to_i)
+        rescue => e
+          $stderr.puts "Caught exception while trying to drop user privileges: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/simple_daemon.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simple_daemon}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["watsonian"]
+  s.date = %q{2010-06-01}
+  s.description = %q{A simple library for daemonizing scripts.}
+  s.email = %q{watsonian@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/simple_daemon.rb",
+     "simple_daemon.gemspec",
+     "test/helper.rb",
+     "test/test_simple_daemon.rb"
+  ]
+  s.homepage = %q{http://github.com/watsonian/simple_daemon}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple library for daemonizing scripts.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_simple_daemon.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<simple_pid>, [">= 0.2.1"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<simple_pid>, [">= 0.2.1"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<simple_pid>, [">= 0.2.1"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simple_daemon'
+
+class Test::Unit::TestCase
+end

data/test/test_simple_daemon.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSimpleDaemon < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: simple_daemon
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- watsonian
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: simple_pid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 2
+        - 1
+        version: 0.2.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A simple library for daemonizing scripts.
+email: watsonian@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/simple_daemon.rb
+- simple_daemon.gemspec
+- test/helper.rb
+- test/test_simple_daemon.rb
+has_rdoc: true
+homepage: http://github.com/watsonian/simple_daemon
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: A simple library for daemonizing scripts.
+test_files: 
+- test/helper.rb
+- test/test_simple_daemon.rb