process-daemon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9fd3e1daea454199404057b9b504216e8a93a5e
+  data.tar.gz: 0b3858725986811d62424f5182deba146f7d96a0
+SHA512:
+  metadata.gz: c65fb3fd1f265a5fc532331435eb2905d7ca0bcc8de4d3b8cc2c0598196a0d3c5627d1542ed8baa93839595247902e5238e79342c8ed41a05d83d3b5bbcba502
+  data.tar.gz: 8a121e07c4d44af7c8c2a653ec44ed2c78455b5b372057f7f14b05f52ffbc8405e7f0f4979bf1f42d6630851a5c0337aac7110c0030bafa38cf36c9fe78d3dc0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in process-daemon.gemspec
+gemspec
+
+group :test do
+	gem "minitest"
+end

data/README.md

@@ -0,0 +1,77 @@
+# Process::Daemon
+
+`Process::Daemon` is a stable and helpful base class for long running tasks and daemons. Provides standard `start`, `stop`, `restart`, `status` operations.
+
+[![Build Status](https://travis-ci.org/ioquatix/process-daemon.svg)](https://travis-ci.org/ioquatix/process-daemon)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'process-daemon'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install process-daemon
+
+## Usage
+
+Create a file for your daemon, e.g. `daemon.rb`:
+
+	#!/usr/bin/env ruby
+	
+	require 'process/daemon'
+	
+	# Very simple XMLRPC daemon
+	class XMLRPCDaemon < Process::Daemon
+		def base_directory
+			# Should be an absolute path:
+			File.join(__dir__, "tmp")
+		end
+	
+		def startup
+			puts "Starting server..."
+			
+			@rpc_server = WEBrick::HTTPServer.new(
+				:Port => 31337,
+				:BindAddress => "0.0.0.0"
+			)
+			
+			@listener = XMLRPC::WEBrickServlet.new
+			
+			@listener.add_handler("fourty-two") do |amount|
+				"Hello World"
+			end
+			
+			@rpc_server.mount("/RPC2", @listener)
+			
+			begin
+				@rpc_server.start
+			rescue Interrupt
+				puts "Daemon interrupted..."
+			ensure
+				@rpc_server.shutdown
+			end
+		end
+		
+		def shutdown
+			puts "Stopping the RPC server..."
+			@rpc_server.stop
+		end
+	end
+	
+	XMLRPCDaemon.daemonize
+
+Then run `daemon.rb start`. To stop the daemon, run `daemon.rb stop`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/process/daemon.rb

@@ -0,0 +1,139 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'fileutils'
+
+require_relative 'daemon/controller'
+
+require_relative 'daemon/log_file'
+require_relative 'daemon/process_file'
+
+module Process
+	# This class is the base daemon class. If you are writing a daemon, you should inherit from this class.
+	#
+	# The basic structure of a daemon is as follows:
+	# 	
+	# 	class Server < Process::Daemon
+	# 		def startup
+	# 			# Long running process, e.g. web server, game server, etc.
+	# 		end
+	# 		
+	# 		def shutdown
+	# 			# Stop the process above, usually called on SIGINT.
+	# 		end
+	# 	end
+	# 	
+	# 	Server.daemonize
+	#
+	# The base directory specifies a path such that:
+	#   working_directory = "."
+	#   log_directory = #{working_directory}/log
+	#   log_file_path = #{log_directory}/#{daemon_name}.log
+	#   runtime_directory = #{working_directory}/run
+	#   process_file_path = #{runtime_directory}/#{daemon_name}.pid
+	class Daemon
+		def initialize(base_directory = ".")
+			@base_directory = base_directory
+		end
+		
+		# Return the name of the daemon
+		def daemon_name
+			return self.class.name.gsub(/[^a-zA-Z0-9]+/, '-')
+		end
+
+		# The directory the daemon will run in.
+		def working_directory
+			@base_directory
+		end
+
+		# Return the directory to store log files in.
+		def log_directory
+			File.join(working_directory, "log")
+		end
+
+		# Standard log file for stdout and stderr.
+		def log_file_path
+			File.join(log_directory, "#{daemon_name}.log")
+		end
+
+		# Runtime data directory for the daemon.
+		def runtime_directory
+			File.join(working_directory, "run")
+		end
+
+		# Standard location of process pid file.
+		def process_file_path
+			File.join(runtime_directory, "#{daemon_name}.pid")
+		end
+
+		# Mark the output log.
+		def mark_log
+			File.open(log_file_path, "a") do |log_file|
+				log_file.puts "=== Log Marked @ #{Time.now.to_s} ==="
+			end
+		end
+
+		# Prints some information relating to daemon startup problems.
+		def tail_log(output)
+			lines = LogFile.open(log_file_path).tail_log do |line|
+				line.match("=== Log Marked") || line.match("=== Daemon Exception Backtrace")
+			end
+			
+			output.puts lines
+		end
+
+		# Check the last few lines of the log file to find out if the daemon crashed.
+		def crashed?
+			count = 3
+			
+			LogFile.open(log_file_path).tail_log do |line|
+				return true if line.match("=== Daemon Crashed")
+
+				break if (count -= 1) == 0
+			end
+
+			return false
+		end
+
+		# The main function to setup any environment required by the daemon
+		def prefork
+			@base_directory = File.expand_path(@base_directory) if @base_directory
+
+			FileUtils.mkdir_p(log_directory)
+			FileUtils.mkdir_p(runtime_directory)
+		end
+
+		# The main function to start the daemon
+		def startup
+		end
+
+		# The main function to stop the daemon
+		def shutdown
+			# Interrupt all children processes, preferably to stop them so that they are not left behind.
+			Process.kill(0, :INT)
+		end
+		
+		def self.daemonize(argv = ARGV)
+			@@instance ||= self.new
+			
+			Controller.daemonize(@@instance, argv)
+		end
+	end
+end

data/lib/process/daemon/controller.rb

@@ -0,0 +1,197 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'rainbow'
+
+module Process
+	class Daemon
+		# Daemon startup timeout
+		TIMEOUT = 5
+
+		# This module contains functionality related to starting and stopping the daemon, and code for processing command line input.
+		module Controller
+			# This function is called from the daemon executable. It processes ARGV and checks whether the user is asking for `start`, `stop`, `restart`, `status`.
+			def self.daemonize(daemon, argv = ARGV)
+				case argv.shift
+				when 'start'
+					start(daemon)
+					status(daemon)
+				when 'stop'
+					stop(daemon)
+					status(daemon)
+					ProcessFile.cleanup(daemon)
+				when 'restart'
+					stop(daemon)
+					ProcessFile.cleanup(daemon)
+					start(daemon)
+					status(daemon)
+				when 'status'
+					status(daemon)
+				else
+					puts "Invalid command. Please specify start, restart, stop or status."
+					exit
+				end
+			end
+
+			# This function starts the supplied daemon
+			def self.start(daemon)
+				puts Rainbow("Starting daemon...").color(:blue)
+
+				case ProcessFile.status(daemon)
+				when :running
+					$stderr.puts Rainbow("Daemon already running!").color(:blue)
+					return
+				when :stopped
+					# We are good to go...
+				else
+					$stderr.puts Rainbow("Daemon in unknown state! Will clear previous state and continue.").color(:red)
+					status(daemon)
+					ProcessFile.clear(daemon)
+				end
+
+				daemon.prefork
+				daemon.mark_log
+
+				fork do
+					Process.setsid
+					exit if fork
+
+					ProcessFile.store(daemon, Process.pid)
+
+					File.umask 0000
+					Dir.chdir daemon.working_directory
+
+					$stdin.reopen "/dev/null"
+					$stdout.reopen daemon.log_file_path, "a"
+					$stdout.sync = true
+					
+					$stderr.reopen $stdout
+					$stderr.sync = true
+
+					begin
+						daemon.startup
+						
+						trap("INT") do
+							daemon.shutdown
+						end
+					rescue
+						$stderr.puts "=== Daemon Exception Backtrace @ #{Time.now.to_s} ==="
+						$stderr.puts "#{$!.class}: #{$!.message}"
+						$!.backtrace.each { |at| $stderr.puts at }
+						$stderr.puts "=== Daemon Crashed ==="
+						$stderr.flush
+					ensure
+						$stderr.puts "=== Daemon Stopping @ #{Time.now.to_s} ==="
+						$stderr.flush
+					end
+				end
+
+				puts Rainbow("Waiting for daemon to start...").color(:blue)
+				sleep 0.1
+				timer = TIMEOUT
+				pid = ProcessFile.recall(daemon)
+
+				while pid == nil and timer > 0
+					# Wait a moment for the forking to finish...
+					puts Rainbow("Waiting for daemon to start (#{timer}/#{TIMEOUT})").color(:blue)
+					sleep 1
+
+					# If the daemon has crashed, it is never going to start...
+					break if daemon.crashed?
+
+					pid = ProcessFile.recall(daemon)
+
+					timer -= 1
+				end
+			end
+
+			# Prints out the status of the daemon
+			def self.status(daemon)
+				case ProcessFile.status(daemon)
+				when :running
+					puts Rainbow("Daemon status: running pid=#{ProcessFile.recall(daemon)}").color(:green)
+				when :unknown
+					if daemon.crashed?
+						puts Rainbow("Daemon status: crashed").color(:red)
+
+						$stdout.flush
+						$stderr.puts Rainbow("Dumping daemon crash log:").color(:red)
+						daemon.tail_log($stderr)
+					else
+						puts Rainbow("Daemon status: unknown").color(:red)
+					end
+				when :stopped
+					puts Rainbow("Daemon status: stopped").color(:blue)
+				end
+			end
+
+			# Stops the daemon process.
+			def self.stop(daemon)
+				puts Rainbow("Stopping daemon...").color(:blue)
+
+				# Check if the pid file exists...
+				unless File.file?(daemon.process_file_path)
+					puts Rainbow("Pid file not found. Is the daemon running?").color(:red)
+					return
+				end
+
+				pid = ProcessFile.recall(daemon)
+
+				# Check if the daemon is already stopped...
+				unless ProcessFile.running(daemon)
+					puts Rainbow("Pid #{pid} is not running. Has daemon crashed?").color(:red)
+
+					daemon.tail_log($stderr)
+
+					return
+				end
+
+				# Interrupt the process group:
+				pgid = -Process.getpgid(pid)
+				Process.kill("INT", pgid)
+				sleep 0.1
+
+				sleep 1 if ProcessFile.running(daemon)
+
+				# Kill/Term loop - if the daemon didn't die easily, shoot
+				# it a few more times.
+				attempts = 5
+				while ProcessFile.running(daemon) and attempts > 0
+					sig = (attempts >= 2) ? "KILL" : "TERM"
+
+					puts Rainbow("Sending #{sig} to process group #{pgid}...").color(:red)
+					Process.kill(sig, pgid)
+
+					attempts -= 1
+					sleep 1
+				end
+
+				# If after doing our best the daemon is still running (pretty odd)...
+				if ProcessFile.running(daemon)
+					puts Rainbow("Daemon appears to be still running!").color(:red)
+					return
+				end
+
+				# Otherwise the daemon has been stopped.
+				ProcessFile.clear(daemon)
+			end
+		end
+	end
+end

data/lib/process/daemon/log_file.rb

@@ -0,0 +1,112 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Process
+	class Daemon
+		class LogFile < File
+			# Yields the lines of a log file in reverse order, once the yield statement returns true, stops, and returns the lines in order.
+			def tail_log
+				lines = []
+
+				seek_end
+				
+				reverse_each_line do |line|
+					lines << line
+					
+					break if yield line
+				end
+
+				return lines.reverse
+			end
+			
+			private
+			
+			# Seek to the end of the file
+			def seek_end(offset = 0)
+				seek(offset, IO::SEEK_END)
+			end
+	
+			# Read a chunk of data and then move the file pointer backwards.
+			#
+			# Calling this function multiple times will return new data and traverse the file backwards.
+			#
+			def read_reverse(length)
+				offset = tell
+
+				if offset == 0
+					return nil
+				end
+
+				start = [0, offset-length].max
+
+				seek(start, IO::SEEK_SET)
+
+				buf = read(offset-start)
+
+				seek(start, IO::SEEK_SET)
+
+				return buf
+			end
+
+			REVERSE_BUFFER_SIZE = 128
+
+			# This function is very similar to gets but it works in reverse.
+			#
+			# You can use it to efficiently read a file line by line backwards.
+			# 
+			# It returns nil when there are no more lines.
+			def reverse_gets(sep_string=$/)
+				end_pos = tell
+
+				offset = nil
+				buf = ""
+
+				while offset == nil
+					chunk = read_reverse(REVERSE_BUFFER_SIZE)
+					return (buf == "" ? nil : buf) if chunk == nil
+
+					buf = chunk + buf
+
+					offset = buf.rindex(sep_string)
+				end
+
+				line = buf[offset...buf.size].sub(sep_string, "")
+
+				seek((end_pos - buf.size) + offset, IO::SEEK_SET)
+
+				return line
+			end
+
+			# Similar to each_line but works in reverse. Don't forget to call
+			# seek_end before you start!
+			def reverse_each_line(sep_string=$/, &block)
+				return to_enum(:reverse_each_line) unless block_given?
+		
+				line = reverse_gets(sep_string)
+
+				while line != nil
+					yield line
+
+					line = reverse_gets(sep_string)
+				end
+			end
+		end
+	end
+end

data/lib/process/daemon/priviledges.rb

@@ -0,0 +1,48 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'etc'
+
+module Process
+	class Daemon
+		module Priviledges
+			# Set the user of the current process. Supply either a user ID
+			# or a user name.
+			#
+			# Be aware that on Mac OS X / Ruby 1.8 there are bugs when the user id
+			# is negative (i.e. it doesn't work). For example "nobody" with uid -2
+			# won't work.
+			def self.change_user(user)
+				if user.kind_of?(String)
+					user = Etc.getpwnam(user).uid
+				end
+
+				Process::Sys.setuid(user)
+			end
+
+			# Get the user of the current process. Returns the user name.
+			def self.current_user
+				uid = Process::Sys.getuid
+
+				Etc.getpwuid(uid).name
+			end
+		end
+	end
+end

data/lib/process/daemon/process_file.rb

@@ -0,0 +1,71 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'fileutils'
+
+module Process
+	class Daemon
+		# This module controls the storage and retrieval of process id files.
+		class ProcessFile
+			# Saves the pid for the given daemon
+			def self.store(daemon, pid)
+				File.write(daemon.process_file_path, pid)
+			end
+
+			# Retrieves the pid for the given daemon
+			def self.recall(daemon)
+				File.read(daemon.process_file_path).to_i rescue nil
+			end
+
+			# Removes the pid saved for a particular daemon
+			def self.clear(daemon)
+				if File.exist? daemon.process_file_path
+					FileUtils.rm(daemon.process_file_path)
+				end
+			end
+
+			# Checks whether the daemon is running by checking the saved pid and checking the corresponding process
+			def self.running(daemon)
+				pid = recall(daemon)
+
+				return false if pid == nil
+
+				gpid = Process.getpgid(pid) rescue nil
+
+				return gpid != nil ? true : false
+			end
+
+			# Remove the pid file if the daemon is not running
+			def self.cleanup(daemon)
+				clear(daemon) unless running(daemon)
+			end
+
+			# This function returns the status of the daemon. This can be one of +:running+, +:unknown+ (pid file exists but no 
+			# corresponding process can be found) or +:stopped+.
+			def self.status(daemon)
+				if File.exist? daemon.process_file_path
+					return ProcessFile.running(daemon) ? :running : :unknown
+				else
+					return :stopped
+				end
+			end
+		end
+	end
+end

data/lib/process/daemon/version.rb

@@ -0,0 +1,25 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Process
+	class Daemon
+		VERSION = "0.1.0"
+	end
+end

data/process-daemon.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'process/daemon/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "process-daemon"
+	spec.version       = Process::Daemon::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.summary       = %q{`Process::Daemon` is a stable and helpful base class for long running tasks and daemons. Provides standard `start`, `stop`, `restart`, `status` operations.}
+	spec.homepage      = ""
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_dependency "rainbow", "~> 2.0"
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+end

data/test/test_daemon.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2007, 2009, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
+
+require 'minitest/autorun'
+
+require 'process/daemon'
+
+require 'webrick'
+require 'webrick/https'
+
+require 'xmlrpc/server'
+require 'xmlrpc/client'
+
+# Very simple XMLRPC daemon
+class XMLRPCDaemon < Process::Daemon
+	def working_directory
+		File.join(__dir__, "tmp")
+	end
+	
+	def startup
+		puts "Starting server..."
+
+		@rpc_server = WEBrick::HTTPServer.new(
+			:Port => 31337,
+			:BindAddress => "0.0.0.0"
+		)
+
+		@listener = XMLRPC::WEBrickServlet.new
+
+		@listener.add_handler("add") do |amount|
+			@count ||= 0
+			@count += amount
+		end
+
+		@listener.add_handler("total") do
+			@count
+		end
+
+		@rpc_server.mount("/RPC2", @listener)
+
+		$stdout.flush
+		$stderr.flush
+		
+		begin
+			@rpc_server.start
+		rescue Interrupt
+			puts "Daemon interrupted..."
+		ensure
+			@rpc_server.shutdown
+		end
+	end
+
+	def shutdown
+		puts "Stopping the RPC server..."
+		@rpc_server.stop
+	end
+end
+
+class DaemonTest < MiniTest::Test
+	def setup
+		@daemon = XMLRPCDaemon.new
+		Process::Daemon::Controller.start(@daemon)
+	end
+
+	def teardown
+		Process::Daemon::Controller.stop(@daemon)
+	end
+
+	def test_connection
+		rpc = XMLRPC::Client.new_from_uri("http://localhost:31337")
+		rpc.call("add", 10)
+
+		total = rpc.call("total")
+
+		assert_equal 10, total
+	end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: process-daemon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/process/daemon.rb
+- lib/process/daemon/controller.rb
+- lib/process/daemon/log_file.rb
+- lib/process/daemon/priviledges.rb
+- lib/process/daemon/process_file.rb
+- lib/process/daemon/version.rb
+- process-daemon.gemspec
+- test/test_daemon.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: '`Process::Daemon` is a stable and helpful base class for long running tasks
+  and daemons. Provides standard `start`, `stop`, `restart`, `status` operations.'
+test_files:
+- test/test_daemon.rb