cicloid-backdrop 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-09-10
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2008 Jonathan Weiss, based on work taken
+from Based on Highrise to LDAP Gateway http://svn.thoughtbot.com/highrise-ldap-proxy/
+
+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/Manifest.txt

@@ -0,0 +1,31 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+bin/backdrop-daemon
+config/hoe.rb
+config/requirements.rb
+lib/backdrop.rb
+lib/backdrop/formatter.rb
+lib/backdrop/pid_file.rb
+lib/backdrop/runner.rb
+lib/backdrop/server.rb
+lib/backdrop/version.rb
+lib/daemon.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_backdrop.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,11 @@
+
+For more information on backdrop, see http://backdrop.rubyforge.org
+
+In order to run a backdrop daemon:
+
+* Create an Backdrop::Runner implementation
+
+* Create matching config.yml
+
+See the README at http://github.com/peritor/backdrop/tree/master for details
+

data/README.txt

@@ -0,0 +1,93 @@
+= backdrop
+
+  http://labs.peritor.com/backdrop
+
+== DESCRIPTION:
+
+ 	A Ruby daemon library that makes writing background daemons easy
+ 	 
+== FEATURES/PROBLEMS:
+
+  Backdrop allows you to easily create Ruby background daemons. It utilizes the daemon gem to go
+  into the background and has some additional management utilities that allow you to control the
+  running backdrop.
+
+== SYNOPSIS:
+
+  $ backdrop-daemon start config.yml
+  
+  $ backdrop-daemon stop config.yml
+  
+  $ backdrop-daemon restart config.yml
+  
+  
+  Where config.yml is:
+  
+  ---
+  daemon_path: /path/to/my/daemon.rb
+  log_file: /path/to/mylog
+  pid_file: /path/to/store.pid
+  debug: false
+  
+  The `daemon_path` config parameter refers to your Ruby library that will be required by backdrop.
+  This file needs to implement the actual processing task and can react to start/stop.
+  
+  Example:
+  
+  module Backdrop
+    class Runner
+      def self.run(logger)
+        logger.info "Running im my loop"
+        # .. doing the background operation once
+        # will be called in a loop
+      end
+      
+      def self.start(logger)
+        # optional - react to starting the daemon
+        # e.g. do setup
+      end
+      
+      def self.run(logger)
+        # optional - react to stopping the daemon
+        # e.g. do resource teardown
+      end
+    end
+  end
+
+== REQUIREMENTS:
+
+* ActiveSupport
+
+== INSTALL:
+
+* sudo gem install backdrop
+
+* Create an Backdrop::Runner implementation
+
+* Create matching config.yml
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Jonathan Weiss, based on work taken
+from Based on Highrise to LDAP Gateway http://svn.thoughtbot.com/highrise-ldap-proxy/
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+# require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 1

data/bin/backdrop-daemon

@@ -0,0 +1,11 @@
+#! /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby
+
+require 'rubygems'
+require 'backdrop'
+
+case ARGV[0]
+  when "start":   Backdrop::Server.new(ARGV[1]).start
+  when "stop":    Backdrop::Server.new(ARGV[1]).stop
+  when "restart": Backdrop::Server.new(ARGV[1]).restart
+  else puts "Usage: #{File.basename(__FILE__)} {start|stop|restart} [config file]"
+end

data/lib/backdrop.rb

@@ -0,0 +1,15 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Backdrop
+end
+
+%w( rubygems thread etc active_support yaml erb fileutils logger resolv-replace daemon tmpdir).each do |lib|
+  require lib
+end
+
+require "backdrop/version"
+require "backdrop/pid_file"
+require "backdrop/formatter"
+require "backdrop/runner"
+require "backdrop/server"

data/lib/backdrop/formatter.rb

@@ -0,0 +1,7 @@
+module Backdrop
+  class Formatter < Logger::Formatter
+    def call(severity, timestamp, progname, msg)
+      "#{timestamp.strftime("%H:%M:%S")}: #{severity} - #{msg}\n"
+    end
+  end
+end

data/lib/backdrop/pid_file.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+module Backdrop
+  class PidFile
+    attr_reader :file
+    def initialize(file)
+      @file = file 
+    end
+  
+    def pid
+      File.file?(@file) and IO.read(@file) 
+    end
+  
+    def remove
+      if self.pid
+        FileUtils.rm @file 
+      end
+    end
+  
+    def create
+      File.open(@file, "w") { |f| f.write($$) }
+    end
+  
+    def ensure_empty!(msg = nil)
+      if self.pid
+        puts msg if msg
+        exit 1
+      end
+    end
+  end
+end

data/lib/backdrop/runner.rb

@@ -0,0 +1,13 @@
+module Backdrop
+  class Runner
+    def self.run(logger)
+      raise "please implement Backdrop::Runner.run yourself!"
+    end
+    
+    def self.start(logger)
+    end
+    
+    def self.stop(logger)
+    end
+  end
+end

data/lib/backdrop/server.rb

@@ -0,0 +1,100 @@
+module Backdrop
+  class Server
+    attr_accessor :config, :logger, :pidfile
+    include Daemon  
+
+    def initialize(config_file = nil)
+      options = YAML.load(ERB.new(File.read(config_file)).result).symbolize_keys
+
+      @config = {
+        :log_file => "#{Dir.tmpdir}/backdrop.log",
+        :pid_file => "#{Dir.tmpdir}/backdrop.pid",
+        :debug => false,
+        :daemon_path => nil # set to path pointing to you daemon implementation
+      }.update(options)
+    
+      validate!
+    
+      self.logger = Logger.new(config[:log_file])
+      self.logger.level = config[:debug] ? Logger::DEBUG : Logger::INFO 
+      self.logger.formatter = Backdrop::Formatter.new
+      self.logger.info ""
+
+      @pidfile = Backdrop::PidFile.new(config[:pid_file])
+    end
+    
+    def validate!
+      raise ArgumentError, "Need a main daemon implementation class, please set :daemon_path" if config[:daemon_path].blank?
+    end
+  
+    def become_user(username = 'nobody', chroot = false)
+      user = Etc::getpwnam(username) 
+
+      Dir.chroot(user.dir) and Dir.chdir('/') if chroot
+
+      Process::initgroups(username, user.gid) 
+      Process::Sys::setegid(user.gid) 
+      Process::Sys::setgid(user.gid) 
+      Process::Sys::setuid(user.uid) 
+    end
+  
+    def start
+      pidfile.ensure_empty! "ERROR: It looks like I'm already running.  Not starting."
+    
+      logger.info "Starting server"
+      logger.info "logging to #{config[:log_file]}"
+      logger.info "storing PID at #{config[:pid_file]}"
+      logger.info "requiring main implementation from #{config[:daemon_path]}"
+      
+      require config[:daemon_path]
+      
+      daemonize(logger)
+
+      logger.info "Became daemon with process id: #{$$}"
+      begin
+        pidfile.create
+      rescue Exception => e
+        logger.info "Exception caught while creating pidfile: #{e}"
+        exit
+      end
+
+      trap("TERM") do 
+        logger.info("Received signal TERM - Shutting down") if logger
+        pidfile.remove if pidfile
+        exit
+      end
+    
+      Backdrop::Runner.start(logger)
+    
+      # main loop run
+      begin
+        loop do
+          Backdrop::Runner.run(logger)
+        end
+      rescue Object => e
+        logger.error "Exception in runner: #{e.message}\n#{e.backtrace.join("\n")}"
+        stop
+      end
+    end
+
+    def stop
+      if @pidfile.pid
+        
+        Backdrop::Runner.stop(logger)
+        
+        puts "Sending signal TERM to process #{pidfile.pid}" if config[:debug]
+        logger.info("Killing server with PID #{pidfile.pid}")
+        Process.kill("TERM", pidfile.pid.to_i)
+        @pidfile.remove
+      else
+        puts "PID cannot be found. Server not running?"
+      end
+    end
+
+    def restart
+      stop
+      sleep 5
+      start
+    end  
+  end
+end

data/lib/backdrop/version.rb

@@ -0,0 +1,9 @@
+module Backdrop
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/daemon.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+class Logger
+  attr_accessor :logdev
+end
+
+module Daemon
+  def daemonize(logger = nil)
+    # This causes the grandchild process to be orphaned, 
+    # so the init process is responsible for cleaning it up.
+    Kernel.fork and Kernel.exit
+    Process.setsid
+    Kernel.fork and Kernel.exit
+
+    File.umask 0
+    Dir.chdir '/'
+
+    ObjectSpace.each_object(IO) do |io|
+      unless (logger and logger.logdev.dev == io)
+        io.close rescue nil
+      end
+    end
+
+    STDIN.reopen( '/dev/null')
+    STDOUT.reopen('/dev/null', 'a')
+    STDERR.reopen('/dev/null', 'a')
+  end
+end

data/test/test.yml

@@ -0,0 +1,5 @@
+---
+daemon_path: <%= File.expand_path(File.dirname(__FILE__) + "/test/test_impl.rb") %>
+log_file: /tmp/foo.log
+pid_file: /tmp/foo.pid
+debug: true

data/test/test_backdrop.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestBackdrop < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_calling_runner
+    # Daemon.expects(:daemonize).returns(true)
+    # Backdrop::Runner.expects(:run).raises(RuntimeError)
+    # Backdrop::Runner.expects(:start).returns(nil)
+    # Backdrop::Runner.expects(:stop).returns(nil)
+    # 
+    # server = Backdrop::Server.new(File.dirname(__FILE__) + '/test.yml')
+    # server.pidfile.expects(:ensure_empty!).returns(true)
+    # server.start
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+require File.dirname(__FILE__) + '/../lib/backdrop'

data/test/test_impl.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'backdrop'
+
+module Backdrop
+  class Runner
+    def self.run(logger)
+      logger.info "Running im my loop"
+      system("echo 'c' >> /tmp/c")
+    end
+  end
+end
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: cicloid-backdrop
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Gustavo Barr\xC3\xB3n"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-14 00:00:00 -07:00
+default_executable: backdrop-daemon
+dependencies: []
+
+description: TODO
+email: gustavo@foobarra.com
+executables: 
+- backdrop-daemon
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+- Rakefile
+- VERSION.yml
+- bin/backdrop-daemon
+- lib/backdrop.rb
+- lib/backdrop/formatter.rb
+- lib/backdrop/pid_file.rb
+- lib/backdrop/runner.rb
+- lib/backdrop/server.rb
+- lib/backdrop/version.rb
+- lib/daemon.rb
+- test/test.yml
+- test/test_backdrop.rb
+- test/test_helper.rb
+- test/test_impl.rb
+has_rdoc: true
+homepage: http://github.com/cicloid/backdrop
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/test_backdrop.rb
+- test/test_helper.rb
+- test/test_impl.rb