daemonite 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9035bd4b47554cc494ad4d131f55a98f29658470
+  data.tar.gz: 2fb54ca71a405695d5cc5f2bf42ba883e52d03f8
+SHA512:
+  metadata.gz: f18d348471836f7043264ba26cd5c963e463a6f150a4e1fc2d803d3fc89ba3aba45d7a6835e21bb90e43a4a05441ba1b81c33077ba6573a9bb654fbba6a17635
+  data.tar.gz: b04555a09ad5d52484d307cdf555c4e9a35bf762977a58325339a68f372678b4c1c52b979876cd27f0e90f8dc53de80b85ce6d1e36bdfbff5459a2b9da805583

data/AUTHORS

@@ -0,0 +1 @@
+Jürgen Mangler <juergen.mangler@univie.ac.at>

data/COPYING

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Changelog

@@ -0,0 +1,2 @@
+0.1 "nothing to see"
+  * Initial version

data/README.md

@@ -0,0 +1,59 @@
+# Damonite
+
+Copyright (C) 2004-2018 Jürgen "eTM" Mangler <juergen.mangler@gmail.com>
+
+Daemonite is freely distributable according to the terms of the GNU Lesser General
+Public License 3.0 (see the file 'COPYING').
+
+This code is distributed without any warranty. See the file 'COPYING' for
+details.
+
+## Introduction
+
+Deamonite is just syntactic sugar around Process.daemon and argparse, which are
+part of standard ruby. An it only works on Linux because it runs 'ps ax'. I
+know, thats clumsy and doesn't run on windows. Please contribute a better
+solution if you have to.
+
+## Usage
+
+Its fairly simple for now:
+
+```ruby
+Daemonite.new do |opts|
+  opts['bla']
+
+  run do |opts|
+    p opts
+    sleep 1
+  end
+end.loop!
+```
+
+Everything inside the #new block is executed once. Everything inside the #run
+block is executed periodically. So make sure to include sleep to not bog down
+your CPU. #loop! finally starts a periodical loop.
+
+In order to override options, or provide your own options at start:
+
+```ruby
+Daemonite.new(opts)
+```
+
+Also be aware that a json configuration file $PROGRAM_NAME.sub /\.rb$/, '.conf'
+is automatically read, if it exists.
+
+## Usage - Alternative
+
+```ruby
+daemon = Daemonite.new(opts)
+daemon.run do |opts|
+  p opts
+  sleep 1
+end
+daemon.loop!
+```
+
+## TODO
+
+1. An example how to integrate with EventMachine (replace the #loop!).

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rubygems/package_task'
+require 'rake/testtask'
+
+spec = eval(File.read('daemonite.gemspec'))
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+  `rm pkg/* -rf`
+  `ln -sf #{pkg.name}.gem pkg/daemonite.gem`
+end
+
+task :push => :gem do |r|
+  `gem push pkg/daemonite.gem`
+end
+
+task :install => :gem do |r|
+  `sudo gem install pkg/daemonite.gem`
+end

data/TODO

@@ -0,0 +1,5 @@
+Todo + Ideas:
+
+* no functional wishes so far
+* create detailed documention, not only examples
+* create unit test

data/daemonite.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name             = "daemonite"
+  s.version          = "0.1"
+  s.platform         = Gem::Platform::RUBY
+  s.license          = "LGPL-3.0"
+  s.summary          = "Daemonite - Process.daemon and argparse wrapper."
+
+  s.description      = "Daemonite - Process.daemon and argparse wrapper."
+
+  s.files            = Dir['{example/**/*,lib/*}'] + %w(COPYING Changelog Rakefile daemonite.gemspec README.md AUTHORS TODO)
+  s.require_path     = 'lib'
+  s.extra_rdoc_files = ['README.md']
+
+  s.required_ruby_version = '>=1.9.3'
+
+  s.authors          = ['Juergen eTM Mangler']
+  s.email            = 'juergen.mangler@gmail.com'
+  s.homepage         = 'https://github.com/etm/daemonite.rb'
+end

data/lib/daemonite.rb

@@ -0,0 +1,152 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+#
+# This file is part of Daemonite.
+#
+# Daemonite is free software: you can redistribute it and/or modify it under the terms
+# of the GNU General Public License as published by the Free Software Foundation,
+# either version 3 of the License, or (at your option) any later version.
+#
+# Daemonite is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+# PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# Daemonite (file COPYING in the main directory).  If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'optparse'
+require 'psych'
+
+class Daemonite
+  OPTS = {
+    :mode            => :debug,
+    :verbose         => false,
+    :basepath        => File.expand_path(File.dirname($0)),
+    :pidfile         => File.basename($0,'.rb') + '.pid',
+    :pidwrite        => true,
+    :conffile        => File.basename($0,'.rb') + '.conf',
+    :runtime_options => [],
+    :cmdl_parsing    => true,
+    :cmdl_operation  => 'start'
+  }
+
+  def initialize(opts={},&block)
+    @opts = OPTS.merge(opts)
+
+    if File.exists?(@opts[:basepath] + '/' + @opts[:conffile])
+      @opts.merge!(Psych::load_file(@opts[:basepath] + '/' + @opts[:conffile]))
+    end
+
+    ########################################################################################################################
+    # parse arguments
+    ########################################################################################################################
+    if @opts[:cmdl_parsing]
+      @opts[:cmdl_operation] = "start"
+      ARGV.options { |opt|
+        opt.summary_indent = ' ' * 4
+        opt.banner = "Usage:\n#{opt.summary_indent}ruby #{$PROGRAM_NAME} [options] start|stop|restart|info" + (@opts[:runtime_options].length > 0 ? '|' : '') + @opts[:runtime_options].map{|ro| ro[0]}.join('|') + "\n"
+        opt.on("--verbose", "-v", "Do not daemonize. Write ouput to console.") { @opts[:verbose] = true }
+        opt.on("--help", "-h", "This text.") { puts opt; exit }
+        opt.separator(opt.summary_indent + "start|stop|restart|info".ljust(opt.summary_width+1) + "Do operation start, stop, restart or get information.")
+        @opts[:runtime_options].each do |ro|
+          opt.separator(opt.summary_indent + ro[0].ljust(opt.summary_width+1) + ro[1])
+        end
+        opt.parse!
+      }
+      unless (%w{start stop restart info} + @opts[:runtime_options].map{|ro| ro[0] }).include?(ARGV[0])
+        puts ARGV.options
+        exit
+      end
+      @opts[:cmdl_operation] = ARGV[0]
+      @at_exit = nil
+    end
+    ########################################################################################################################
+
+    @opts[:repeat] = nil
+    instance_exec(@opts,&block) if block_given?
+
+    ########################################################################################################################
+    # status and info
+    ########################################################################################################################
+    pid = File.read(@opts[:basepath] + '/' + @opts[:pidfile]).to_i rescue pid = -1
+    status = Proc.new do
+      begin
+        Process.getpgid pid
+        true
+      rescue Errno::ESRCH
+        false
+      end
+    end
+    if @opts[:cmdl_operation] == "info" && status.call == false
+      puts "Server not running"
+      exit
+    end
+    if @opts[:cmdl_operation] == "info" && status.call == true
+      puts "Server running as #{pid}"
+      begin
+        stats = `ps -o "vsz,rss,lstart,time" -p #{pid}`.split("\n")[1].strip.split(/ +/)
+        puts "Virtual:  #{"%0.2f" % (stats[0].to_f/1024)} MiB"
+        puts "Resident: #{"%0.2f" % (stats[1].to_f/1024)} MiB"
+        puts "Started:  #{stats[2..-2].join(' ')}"
+        puts "CPU Time: #{stats.last}"
+      rescue
+      end
+      exit
+    end
+    if %w{start}.include?(@opts[:cmdl_operation]) && status.call == true
+      puts "Server already started"
+      exit
+    end
+
+    ########################################################################################################################
+    # stop/restart server
+    ########################################################################################################################
+    if %w{stop restart}.include?(@opts[:cmdl_operation])
+      if status.call == false
+        puts "Server maybe not started?"
+      else
+        puts "Server stopped"
+        puts "Waiting while server goes down ..."
+        while status.call
+          Process.kill "SIGTERM", pid
+          sleep 0.3
+        end
+      end
+      exit unless @opts[:cmdl_operation] == "restart"
+    end
+
+    ########################################################################################################################
+    # go through user defined startup thingis
+    ########################################################################################################################
+    @opts[:runtime_options].each do |ro|
+      ro[2].call(status.call) if @opts[:cmdl_operation] == ro[0]
+    end
+
+    puts "Server started as PID:#{Process.pid}"
+    File.write(@opts[:basepath] + '/' + @opts[:pidfile],Process.pid)
+    Process.daemon(@opts[:basepath]) unless @opts[:verbose]
+    Dir.chdir(@opts[:basepath])
+    ::Kernel::at_exit do
+      File.unlink(@opts[:basepath] + '/' + @opts[:pidfile])
+      @at_exit.call if @at_exit
+    end
+  end
+
+  def run(&block)
+    @opts[:repeat] = block
+  end
+  def at_exit(&blk)
+    @at_exit = blk
+  end
+
+  def loop!
+    begin
+      loop do
+        @opts[:repeat].call(@opts)
+      end unless @opts[:repeat].nil?
+    rescue => e
+      puts "Server stopped due to error (PID:#{Process.pid})"
+    end
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: daemonite
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Juergen eTM Mangler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-04 00:00:00.000000000 Z
+dependencies: []
+description: Daemonite - Process.daemon and argparse wrapper.
+email: juergen.mangler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- AUTHORS
+- COPYING
+- Changelog
+- README.md
+- Rakefile
+- TODO
+- daemonite.gemspec
+- lib/daemonite.rb
+homepage: https://github.com/etm/daemonite.rb
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Daemonite - Process.daemon and argparse wrapper.
+test_files: []