heaven 0.0.12

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem "god", ">= 0"
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    god (0.11.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  god
+  jeweler (~> 1.6.4)
+  rcov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Eugen Minciu
+
+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,19 @@
+= heaven
+
+A set of utilities to make it easier to work with god.
+
+== Contributing to heaven
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Eugen Minciu. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "heaven"
+  gem.homepage = "http://github.com/minciue/heaven"
+  gem.license = "MIT"
+  gem.summary = %Q{A set of utilities to make it easier to work with god.}
+  gem.description = %Q{A set of utilities to make it easier to work with god.}
+  gem.email = "eugen@lesseverything.com"
+  gem.authors = ["Eugen Minciu"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "heaven #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.12

data/lib/heaven.rb

@@ -0,0 +1,2 @@
+require 'heaven/heaven'
+require 'heaven/god_watcher'

data/lib/heaven/god_watcher.rb

@@ -0,0 +1,143 @@
+class HeavenConfigurationError < StandardError; end
+class GodWatcher # :nodoc:all
+  def initialize(name, options = {})
+    @name     = name
+    @start    = options[:start]
+    @stop     = options[:stop]
+    @restart  = options[:restart]
+    @pid_file = options[:pid_file]
+    @log_file = options[:log_file]
+    @uid      = options[:uid]
+    @gid      = options[:gid]
+
+    @interval = options[:interval] || 15.seconds
+    @grace    = options[:grace]     || 15.seconds
+
+    @behaviors     = options[:behaviors] || [:clean_pid_file]
+
+    @max_memory = options[:max_memory] || 250.megabytes
+    @max_cpu    = options[:max_cpu]    || 50.percent
+    @max_times  = options[:max_times]  || 5
+
+    @check_flapping = options[:check_flapping].nil? ? true : options[:check_flapping]
+    @check_memory   = options[:check_memory].nil? ? true : options[:check_memory]
+    @check_cpu      = options[:check_cpu].nil? ? true : options[:check_cpu]
+
+    @email_notifications = options[:email_notifications] || false
+    @from_email          = options[:from_email]
+    @from_name           = options[:from_name] || "God"
+    @delivery_method     = options[:delivery_method] || :sendmail
+    @to_emails           = options[:to_emails] || []
+
+    @campfire_notifications = options[:campfire_notifications] || false
+    @campfire_subdomain     = options[:campfire_subdomain]
+    @campfire_token         = options[:campfire_token]
+    @campfire_room          = options[:campfire_room]
+  end
+
+  def watch
+    raise HeavenConfigurationError, "start command not specified" if @start.nil?
+    raise HeavenConfigurationError, "stop command not specified" if @stop.nil?
+    set_god_defaults unless @god_defaults_set
+
+    God.watch do |w|
+      w.name     = @name
+      w.interval = @interval
+      w.start    = @start
+      w.stop     = @stop
+      w.restart  = @restart  if @restart # not mandatory, if we don't specify it god will do a stop and a start
+      w.pid_file = @pid_file if @pid_file
+      w.log      = @log_file if @log_file
+
+      w.start_grace   = @grace
+      w.restart_grace = @grace
+
+      @behaviors.each { |b| w.behavior(b) }
+
+      # determine the state on startup
+      w.transition(:init, { true => :up, false => :start }) do |on|
+	on.condition(:process_running) do |c|
+	  c.running = true
+	end
+      end
+
+      # determine when process has finished starting
+      w.transition([:start, :restart], :up) do |on|
+	on.condition(:process_running) do |c|
+	  c.running = true
+	end
+
+	# failsafe
+	on.condition(:tries) do |c|
+	  c.times = @max_times
+	  c.transition = :start
+	end
+      end
+
+      # start if process is not running
+      w.transition(:up, :start) do |on|
+	on.condition(:process_exits)
+      end
+      
+      if @check_memory || @check_cpu
+	# restart if memory or cpu is too high
+	w.transition(:up, :restart) do |on|
+	  if @check_memory
+	    on.condition(:memory_usage) do |c|
+	      c.above    = @max_memory
+	      c.times    = @max_times
+	    end
+	  end
+
+	  if @check_cpu 
+	    on.condition(:cpu_usage) do |c|
+	      c.above    = @max_cpu
+	      c.times    = @max_times
+	    end
+	  end
+	end
+      end
+
+      w.lifecycle do |check|
+	check.condition(:flapping) do |c|
+	  c.to_state = [:start, :restart]
+	  c.times    = 5
+	  c.within   = 5.minutes
+	  c.transition = :unmonitored
+	  c.retry_in = 10.minutes
+	  c.retry_times = 5
+	  c.retry_within = 2.hours
+	end
+      end
+    end
+  end
+
+  def set_god_defaults
+    raise HeavenConfigurationError, "You must specify at least one email address" if @email_notifications == true && @to_emails.empty?
+
+    if @email_notifications
+      God::Contacts::Email.defaults do |d|
+	d.from_email = @from_email
+	d.from_name =  @from_name
+	d.delivery_method = @delivery_method
+      end
+
+      @to_emails.each do |email|
+	God.contact(:email) do |c|
+	  c.name     = email
+	  c.to_email = email
+	end
+      end
+    end
+
+    if @campfire_notifications 
+      God::Contacts::Campfire.defaults do |d|
+	d.subdomain = @campfire_subdomain
+	d.token     = @campfire_token
+	d.room      = @campfire_room
+	d.ssl       = true
+      end
+    end
+    @god_defaults_set = true
+  end
+end

data/lib/heaven/heaven.rb

@@ -0,0 +1,47 @@
+class Heaven
+  class << self
+    # Set the default options for all subsequent watch calls
+    #
+    # Available options are:
+    #
+    # start::      start command;mandatory
+    # stop::       stop command; mandatory
+    # restart::    restart command; optional, if none is specified then god will execute a stop and a start
+    #
+    # pid_file::   the full path of the pid file the service uses
+    # log_file::   the full path of the log file where all the daemon's output will be dumped
+    #
+    # uid::        the user this service needs to be run as
+    # gid::        the group this service needs to be run as
+    #
+    # interval::   interval to poll the service and check against the conditions (default: 15s)
+    # grace::      wait interval while starting or restarting the service before beginning to monitor it again (default: 15s)
+    # behaviors::  god behaviors to enforce for this service, see god documentation (default: [:clean_pid_file])
+    #
+    # check_flapping:: check to see if the process keeps being restarted ad-infinitum and stop trying to restart it
+    # check_memory::   check memory usage (default: true)
+    # check_cpu::      check cpu usage (default: true)
+    #
+    # max_memory:: restart the service if its memory usage exceeds this much on [max_times] consecutive polls (default: 250.megabytes)
+    # max_cpu::    restart the service if its cpu usage exceeds this much on [max_times] consecutive polls (default: 50.percent)
+    # max_times::  see the above (default: 5)
+    def defaults(options)
+      @defaults = options
+    end
+
+    # Watch a run-of-the-mill UNIX daemon
+    #
+    # It has all the options available to defaults *and*:
+    # script:: name of the daemon's command script (it must take options stop, start and restart)
+    def watch_daemon(name, options = {})
+      script = options.delete(:script)
+      if script
+	options[:start] = "#{script} start"
+	options[:stop] = "#{script} stop"
+	options[:restart] = "#{script} restart"
+      end
+	
+      GodWatcher.new(name, @defaults.merge(options)).watch
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'heaven'
+
+class Test::Unit::TestCase
+end

data/test/test_heaven.rb

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

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: heaven
+version: !ruby/object:Gem::Version 
+  hash: 7
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 12
+  version: 0.0.12
+platform: ruby
+authors: 
+- Eugen Minciu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-18 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+  name: god
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id003
+  prerelease: false
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  prerelease: false
+  name: rcov
+description: A set of utilities to make it easier to work with god.
+email: eugen@lesseverything.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/heaven.rb
+- lib/heaven/god_watcher.rb
+- lib/heaven/heaven.rb
+- test/helper.rb
+- test/test_heaven.rb
+has_rdoc: true
+homepage: http://github.com/minciue/heaven
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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.4.2
+signing_key: 
+specification_version: 3
+summary: A set of utilities to make it easier to work with god.
+test_files: []
+