fallen 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -0,0 +1,86 @@
+# Fallen
+A simpler daemon library for Ruby processes.
+
+## Usage
+
+```
+require "fallen"
+
+module Azazel
+  extend Fallen
+  
+  def self.run
+    while running?
+      puts "My name is Legion"
+      sleep 666
+    end
+  end
+end
+
+Azazel.start!
+```
+
+This will print _My name is Legion_ every 666 seconds on `STDOUT`. You can stop the daemon by pressing `CTRL+c`.
+
+## Control your daemon
+`Fallen` accepts the following methods:
+
+* `daemonize!`: detaches the process and keep running it on background;
+* `chdir!`: changes the current working directory of the process (useful for log and pid files);
+* `pid_file`: allows to indicate a file path where the daemon `PID` will be stored; could be either an absolute path or a relative path to the current working directory (see `chdir!`);
+* `stdout`, `stderr` & `stdin`: redirects the process `STDOUT`, `STDERR` and `STDIN` to either an absolute or relative file path; note that when a process is daemonized by default all these streams are redirected to `/dev/null`.
+
+For example, the previous example could have the following lines before `Azazel.start!` to store the `PID` and log to a file:
+
+```
+Azazel.pid_file "/var/run/azazel.pid"
+Azazel.stdout "/var/log/azazel.log"
+Azazel.daemonize!
+Azazel.start!
+```
+
+## CLI support
+`Fallen` supports command line parameters, by default using the [`clap`](https://github.com/soveran/clap) gem. In order to enable command line support you need to do the following:
+
+```
+require "fallen"
+require "fallen/cli"
+
+module Azazel
+  extend Fallen
+  extend Fallen::CLI
+  
+  # ...
+  
+  def usage
+    puts "..." # Your usage message
+    # Default Fallen usage options
+    puts fallen_usage
+  end
+end
+
+case Clap.run(ARGV, Azazel.cli).first
+when "start"
+  Azazel.start!
+when "stop"
+  Azazel.stop!
+else
+  Azazel.usage
+end
+```
+
+`Azazel.usage` will print the following:
+
+```
+Fallen introduced command line arguments:
+
+  -D    Daemonize this process
+  -C    Change directory.
+  -P    Path to PID file. Only used in daemonized process.
+  -out  Path to redirect STDOUT.
+  -err  Path to redirect STDERR.
+  -in   Path to redirect STDIN.
+```
+
+## License
+See the `UNLICENSE` file included with this gem distribution.

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/examples/azazel.rb

@@ -0,0 +1,14 @@
+require_relative "../lib/fallen"
+
+module Azazel
+  extend Fallen
+
+  def self.run
+    while running?
+      puts "My name is Legion"
+      sleep 666
+    end
+  end
+end
+
+Azazel.start!

data/examples/azazel_cli.rb

@@ -0,0 +1,27 @@
+require_relative "../lib/fallen"
+require_relative "../lib/fallen/cli"
+
+module Azazel
+  extend Fallen
+  extend Fallen::CLI
+
+  def self.run
+    while running?
+      puts "My name is Legion"
+      sleep 666
+    end
+  end
+
+  def self.usage
+    puts fallen_usage
+  end
+end
+
+case Clap.run(ARGV, Azazel.cli).first
+when "start"
+  Azazel.start!
+when "stop"
+  Azazel.stop!
+else
+  Azazel.usage
+end

data/fallen.gemspec

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "fallen"
+  s.version     = "0.0.1"
+  s.summary     = "A simpler daemon library"
+  s.description = "A simpler way to create Ruby fallen angels, better known as daemons"
+  s.authors     = ["Leandro López"]
+  s.email       = ["inkel.ar@gmail.com"]
+  s.homepage    = "https://github.com/inkel/fallen"
+
+  s.files       = `git ls-files`.split("\n")
+end

data/lib/fallen.rb

@@ -0,0 +1,86 @@
+module Fallen
+  @running = false
+  @pidfile = nil
+  @stdin   = nil
+  @stdout  = nil
+  @stderr  = nil
+
+  def daemonize!
+    Process.daemon true
+  end
+
+  def chdir! path
+    Dir.chdir File.absolute_path(path)
+  end
+
+  def pid_file path
+    @pid_file = File.absolute_path(path)
+  end
+
+  def stdin path
+    @stdin = File.absolute_path(path)
+    STDIN.reopen @stdin
+  end
+
+  def stdout path
+    @stdout = File.absolute_path(path)
+    STDOUT.reopen @stdout, "a"
+  end
+
+  def stderr path
+    @stderr = File.absolute_path(path)
+    STDERR.reopen @stderr, "a"
+  end
+
+  def running?
+    @running
+  end
+
+  def start!
+    if @pid_file && File.exists?(@pid_file)
+      pid = File.read(@pid_file).strip
+      begin
+        Process.kill 0, pid.to_i
+        STDERR.puts "Daemon is already running with PID #{pid}"
+        exit 2
+      rescue Errno::ESRCH
+        run!
+      end
+    else
+      run!
+    end
+  end
+
+  def run!
+    save_pid_file
+    @running = true
+    trap(:INT) { @running = false; stop }
+    trap(:TERM) { @running = false; stop }
+    run
+  end
+
+  def stop!
+    if @pid_file && File.exists?(@pid_file)
+      pid = File.read(@pid_file).strip
+      begin
+        Process.kill :INT, pid.to_i
+      rescue Errno::ESRCH
+        STDERR.puts "No daemon is running with PID #{pid}"
+        exit 3
+      end
+    else
+      STDERR.puts "Couldn't find a PID file"
+      exit 1
+    end
+  end
+
+  def stop; end
+
+  private
+
+  def save_pid_file
+    File.open(@pid_file, "w") do |fp|
+      fp.write(Process.pid)
+    end if @pid_file
+  end
+end

data/lib/fallen/cli.rb

@@ -0,0 +1,27 @@
+require "clap"
+
+module Fallen::CLI
+  def cli
+    {
+      "-D"   => self.method(:daemonize!),
+      "-C"   => self.method(:chdir!),
+      "-P"   => self.method(:pid_file),
+      "-out" => self.method(:stdout),
+      "-err" => self.method(:stderr),
+      "-in"  => self.method(:stdin)
+    }
+  end
+
+  def fallen_usage
+    <<-USAGE
+Fallen introduced command line arguments:
+
+  -D    Daemonize this process
+  -C    Change directory.
+  -P    Path to PID file. Only used in daemonized process.
+  -out  Path to redirect STDOUT.
+  -err  Path to redirect STDERR.
+  -in   Path to redirect STDIN.
+    USAGE
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: fallen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Leandro López
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-29 00:00:00.000000000 Z
+dependencies: []
+description: A simpler way to create Ruby fallen angels, better known as daemons
+email:
+- inkel.ar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- UNLICENSE
+- examples/azazel.rb
+- examples/azazel_cli.rb
+- fallen.gemspec
+- lib/fallen.rb
+- lib/fallen/cli.rb
+homepage: https://github.com/inkel/fallen
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simpler daemon library
+test_files: []