health_check 0.2.4 → 1.0.1

data/Gemfile

@@ -0,0 +1,18 @@
+# Gemfile for health_test
+
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'rake', '>= 0.8.3'
+  gem 'jeweler', '~> 1.8.4'
+  gem 'shoulda', "~> 2.11.0"
+  gem 'sqlite3', "~> 1.3.7"
+  gem 'activerecord', ">= 2.3.0"
+end
+
+group :misc do
+  # run travis-lint to check .travis.yml
+  gem 'travis-lint'
+  # required to run rake test:plugins
+  gem 'ruby-prof', '>= 0.6.1'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activerecord (2.3.15)
+      activesupport (= 2.3.15)
+    activesupport (2.3.15)
+    git (1.2.5)
+    hashr (0.0.22)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.6)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    ruby-prof (0.12.1)
+    shoulda (2.11.3)
+    sqlite3 (1.3.7)
+    travis-lint (1.5.0)
+      hashr (~> 0.0.22)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 2.3.0)
+  jeweler (~> 1.8.4)
+  rake (>= 0.8.3)
+  ruby-prof (>= 0.6.1)
+  shoulda (~> 2.11.0)
+  sqlite3 (~> 1.3.7)
+  travis-lint

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Ian Heggie
+Copyright (c) 2010-2013 Ian Heggie
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,11 +1,11 @@
 = health_check
 
-Simple health check of Rails app for use with uptime.openacs.org, wasitup.com or newrelic.com
+Simple health check of Rails app for use with Pingdom, NewRelic, EngineYard or uptime.openacs.org etc.
 
-The basic goal is to check that rails is being launched and that it has access to correctly configured resources (database, email gateway)
+The basic goal is to quickly check that rails is up and running and that it has access to correctly configured resources (database, email gateway)
 
-The email gateway is not checked unless the smtp settings have been changed,
-specify full or include email in the list of checks or varify the smtp settings
+The email gateway is not checked unless the smtp settings have been changed.
+Specify full or include email in the list of checks to varify the smtp settings
 (eg use 127.0.0.1 instead of localhost). 
 
 health_check provides various monitoring URIs 
@@ -24,30 +24,49 @@ health_check provides various monitoring URIs
 
 == Installation
 
-As a Plugin
+*As a Gem from rubygems (Rails 3.0 and above)*
 
-    % cd vendor/plugins
-    % git clone git://github.com/ianheggie/health_check.git
+Add the following line to Gemfile
+
+    gem "health_check"
+
+Then run 
+
+    % bundle
 
-As a Gem from gemcutter
+*As a Gem from rubygems (Rails 2.3)*
+
+Install the gem using the following command
 
     % gem install health_check    
-    # Add the following line to config/environment.rb
+
+Then add the following line to config/environment.rb within the config block
+
     config.gem "health_check"
 
+*As a Plugin (Rails 2.3.x)*
+
+Run the following commands from the root of your rails application
+
+    % cd vendor/plugins
+    % git clone git://github.com/ianheggie/health_check.git
+
 == Uptime Monitoring
 
+Use a website monitoring service to check the url regularly for the word "success" rather than just a 200 return code.
+
 See
-* [WasItUp](http://wasitup.com/)
-* [Uptime by OpenACS](http://uptime.openacs.org/uptime/)
-* [Engine Yard's guide](http://community-support.engineyard.com/faqs/guides/uptime-monitoring-for-your-rails-application) guide based on fitter_happier plugin includes monit and other setup help
+* [Pingdom Website Monitoring](https://www.pingdom.com)
 * [NewRelic Availability Monitoring](http://newrelic.com/docs/features/availability-monitoring-faq)
+* [Uptime by OpenACS](http://uptime.openacs.org/uptime/)
+* [Engine Yard's guide](https://support.cloud.engineyard.com/entries/20996821-monitor-application-uptime) although the guide is based on fitter_happier plugin it will also work with this gem
+* Any other montoring service that can be set to check for the word success in the test returned from a url
 
 == Checks
 
 * standard (default) - site, database and migrations checks are run plus email if settings have been changed
 * all / full - all checks are run
-* database - checks that the database contains the current migration level
+* database - checks that the current migration level can be read from the database
 * email - basic check of email - :test returns true, :sendmail checks file is present and executable, :smtp sends HELO command to server and checks response 
 * migration - checks that the database migration level matches that in db/migrations
 * site - checks rails is running sufficiently to render text 
@@ -64,13 +83,11 @@ See
 
 == Copyright
 
-Copyright (c) 2010-2011 Ian Heggie, released under the MIT license.
+Copyright (c) 2010-2013 Ian Heggie, released under the MIT license.
 See MIT-LICENSE for details.
 
 == Known Issues
 
-* Rails 1.x s not currently supported (smtp_settings versus server_settings)
-* I wasn't able to get tests to work standalone - the gem has to be installed as a plugin for the tests to work
 * No inline documentation for methods
 
 * Feedback welcome especially with suggested replacement code and corresponding tests
@@ -78,3 +95,8 @@ See MIT-LICENSE for details.
 == Similar projects
 
 * fitter_happier plugin by atmos - plugin with similar goals, but not compatible with uptime, and does not check email gateway 
+
+== Continuous integration tests
+
+Travis CI testing result: {<img src="https://travis-ci.org/ianheggie/health_check.png" />}[https://travis-ci.org/ianheggie/health_check]
+

data/Rakefile

@@ -5,52 +5,71 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "health_check"
-    gem.summary = %Q{Simple health check of Rails app}
-    gem.description = %Q{Simple health check of Rails app for use with uptime.openacs.org or wasitup.com}
+    gem.summary = %Q{Simple health check of Rails app for uptime monitoring}
+    gem.description = %Q{Simple health check of Rails app for use with Pingdom, NewRelic, EngineYard or uptime.openacs.org etc.}
     gem.email = "ian@heggie.biz"
     gem.homepage = "http://github.com/ianheggie/health_check"
     gem.authors = ["Ian Heggie"]
-    gem.add_development_dependency "shoulda", ">= 0"
-    gem.add_development_dependency "sqlite3-ruby", ">= 0"
-    gem.add_development_dependency 'activerecord', '>= 1.15.4.7794'
+    # Gemfile contains gem dependencies, apart from bundler itself
+    gem.add_development_dependency 'bundler', '~> 1.2.0'
+    gem.files.exclude 'gemfiles/*', '.travis.yml'
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
+
+  #task :test => :check_dependencies
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
+# Tests are conducted with health_test as a plugin
+environment_file = File.join(File.dirname(__FILE__), '..', '..', '..', 'config', 'environment.rb')
+plugin_dir = File.join(File.dirname(__FILE__), '..', 'plugins')
+if File.exists?(environment_file) and File.directory?(plugin_dir)
+  # test as plugin
+  
+  require 'rake/testtask'
+  Rake::TestTask.new(:test) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/**/*_test.rb'
     test.verbose = true
   end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+
+  begin
+    require 'rcov/rcovtask'
+    Rcov::RcovTask.new do |test|
+      test.libs << 'test'
+      test.pattern = 'test/**/*_test.rb'
+      test.verbose = true
+    end
+  rescue LoadError
+    task :rcov do
+      abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+    end
   end
-end
 
-task :test => :check_dependencies
+else
+  #tests as gem
+  task :test do
+    exec '/bin/bash', './test/test_with_railsapp'
+  end
+end
 
 task :default => :test
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+begin
+  gem 'rdoc'
+  require 'rdoc/task'
+
+  Rake::RDocTask.new do |rdoc|
+    version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "health_check #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "health_check #{version}"
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+rescue Gem::LoadError
+  puts "rdoc (or a dependency) not available. Install it with: gem install rdoc"
 end

data/VERSION

@@ -1 +1 @@
-0.2.4
+1.0.1

data/config/routes.rb

@@ -1,13 +1,6 @@
-if defined?(Rails) and Rails.respond_to?(:version) && Rails.version =~ /^3/
-  if defined? Rails31
-    Rails31::Application.routes.draw do
-      match 'health_check', :to => 'health_check#index'
-      match 'health_check/:checks', :to => 'health_check#check'
-    end
-  else
-    Rails.application.routes.draw do |map|
-      match 'health_check', :to => 'health_check#index'
-      match 'health_check/:checks', :to => 'health_check#check'
-    end
+if defined?(HealthCheck::Engine)
+  Rails.application.routes.draw do
+    match 'health_check', :to => 'health_check/health_check#index'
+    match 'health_check/:checks', :to => 'health_check/health_check#check'
   end
 end

data/health_check.gemspec

@@ -1,72 +1,75 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{health_check}
-  s.version = "0.2.4"
+  s.name = "health_check"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ian Heggie"]
-  s.date = %q{2011-11-16}
-  s.description = %q{Simple health check of Rails app for use with uptime monitoring sites}
-  s.email = %q{ian@heggie.biz}
+  s.date = "2013-01-23"
+  s.description = "Simple health check of Rails app for use with Pingdom, NewRelic, EngineYard or uptime.openacs.org etc."
+  s.email = "ian@heggie.biz"
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "MIT-LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "health_check.gemspec",
-     "init.rb",
-     "config/routes.rb",
-     "lib/health_check.rb",
-     "lib/health_check/add_23_routes.rb",
-     "lib/health_check/add_3x_routes.rb",
-     "lib/health_check/health_check_class.rb",
-     "lib/health_check/health_check_controller.rb",
-     "test/helper.rb",
-     "test/migrate/empty/do_not_remove.txt",
-     "test/migrate/twelve/012_create_users.rb",
-     "test/migrate/twelve/9_create_countries.rb",
-     "test/test_health_check_controller.rb",
-     "test/test_routes.rb"
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "config/routes.rb",
+    "health_check.gemspec",
+    "init.rb",
+    "lib/health_check.rb",
+    "lib/health_check/add_23_routes.rb",
+    "lib/health_check/health_check_controller.rb",
+    "lib/health_check/utils.rb",
+    "test/migrate/empty/do_not_remove.txt",
+    "test/migrate/nine/9_create_countries.rb",
+    "test/migrate/twelve/012_create_users.rb",
+    "test/migrate/twelve/9_create_countries.rb",
+    "test/test_helper.rb",
+    "test/test_with_railsapp",
+    "test/testurl",
+    "test/unit/health_check_controller_test.rb",
+    "test/unit/routes_test.rb"
   ]
-  s.homepage = %q{http://github.com/ianheggie/health_check}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.homepage = "http://github.com/ianheggie/health_check"
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Simple health check of Rails app for use with uptime monitoring sites}
-  s.test_files = [
-    "test/helper.rb",
-     "test/migrate/twelve/012_create_users.rb",
-     "test/migrate/twelve/9_create_countries.rb",
-     "test/test_health_check_controller.rb",
-     "test/test_routes.rb"
-  ]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Simple health check of Rails app for uptime monitoring"
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
-      s.add_development_dependency(%q<activerecord>, [">= 1.15.4.7794"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, [">= 0.8.3"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<shoulda>, ["~> 2.11.0"])
+      s.add_development_dependency(%q<sqlite3>, ["~> 1.3.7"])
+      s.add_development_dependency(%q<activerecord>, [">= 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2.0"])
     else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
-      s.add_dependency(%q<activerecord>, [">= 1.15.4.7794"])
+      s.add_dependency(%q<rake>, [">= 0.8.3"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<shoulda>, ["~> 2.11.0"])
+      s.add_dependency(%q<sqlite3>, ["~> 1.3.7"])
+      s.add_dependency(%q<activerecord>, [">= 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.2.0"])
     end
   else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
-    s.add_dependency(%q<activerecord>, [">= 1.15.4.7794"])
+    s.add_dependency(%q<rake>, [">= 0.8.3"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<shoulda>, ["~> 2.11.0"])
+    s.add_dependency(%q<sqlite3>, ["~> 1.3.7"])
+    s.add_dependency(%q<activerecord>, [">= 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.2.0"])
   end
 end
 

data/lib/health_check.rb

@@ -1,8 +1,20 @@
-require 'health_check/health_check_class'
+# Copyright (c) 2010-2013 Ian Heggie, released under the MIT license.
+# See MIT-LICENSE for details.
+
+module HealthCheck
+
+  if Rails.version >= '3.0'
+    class Engine < Rails::Engine
+    end
+  end
+
+end
+
+require 'health_check/utils'
 require 'health_check/health_check_controller'
-if defined?(Rails) and Rails.respond_to?(:version) && Rails.version =~ /^3/
-  require 'health_check/add_3x_routes'
-else
+
+unless defined?(HealthCheck::Engine)
   require 'health_check/add_23_routes'
 end
 
+# vi: sw=2 sm ai:

data/lib/health_check/add_23_routes.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2010-2013 Ian Heggie, released under the MIT license.
+# See MIT-LICENSE for details.
+
 # rails prior to 3.0
 module ActionController
   module Routing #:nodoc:
@@ -6,9 +9,9 @@ module ActionController
       def draw
 	draw_without_health_check_routes do |map|
 	  map.connect 'health_check',
-	    :controller => 'health_check', :action => 'index'
+	    :controller => 'health_check/health_check', :action => 'index'
 	  map.connect 'health_check/:checks',
-	    :controller => 'health_check', :action => 'check'
+	    :controller => 'health_check/health_check', :action => 'check'
 	  yield map
 	end
       end