health_check 1.2.0 → 1.3.1

data/.travis.yml

@@ -62,12 +62,10 @@ matrix:
 
     # rails 4.0 - in development as of 5 mar 2013 - ruby 2.0
     - rvm: 2.0.0
-      gemfile: test/rails_4.0-beta.gemfile
+      gemfile: test/rails_4.0.gemfile
       env: RUBYGEMS_VERSION=
 
     - rvm: jruby-19mode
       gemfile: test/rails_3.2.gemfile
       env: RUBYGEMS_VERSION=1.8.25
 
-  allow_failures:
-    - gemfile: test/rails_4.0-beta.gemfile

data/README.rdoc

@@ -9,13 +9,17 @@ health_check provides various monitoring URIs, for example:
     curl localhost:3000/health_check
     success
 
-    curl localhost:3000/health_check/all
-    success
+    curl localhost:3000/health_check/all.json
+    {"healthy":true,"message":"success"}
 
-    curl localhost:3000/health_check/database_cache_migration
-    success
+    curl localhost:3000/health_check/database_cache_migration.xml
+    <?xml version="1.0" encoding="UTF-8"?>
+    <hash>
+      <healthy type="boolean">true</healthy>
+      <message>success</message>
+    </hash>
 
-On failure a 500 http status is returned with a simple explination of the failure
+On failure a 500 http status is returned with a simple explanation of the failure
 
     curl localhost:3000/health_check/fail
     health_check failed: invalid argument to health_test.
@@ -25,18 +29,19 @@ The health_check controller disables sessions and logging for its actions to min
 == Checks
 
 * standard (default) - site, database and migrations checks are run plus email if settings have been changed
-* all / full - all checks are run
+* all / full - all checks are run (can be overriden in config block)
 * 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
 * cache - checks that a value can be written to the cache
 * site - checks rails is running sufficiently to render text
+* custom - runs checks added via config.add_custom_check
 
 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
+Specify full or include email in the list of checks to verify the smtp settings
 (eg use 127.0.0.1 instead of localhost).
 
-Note: rails 4.0 also checks migrations and throws a ActiveRecord::PendingMigrationError (http error 500)
+Note: rails 4.0 also checks migrations and throws an ActiveRecord::PendingMigrationError exception (http error 500) if there is an error
 
 == Installation
 
@@ -81,19 +86,22 @@ To change the configuration of health_check, create a file `config/initializers/
       config.success = 'success'
 
       # Timeout in seconds used when checking smtp server
-      self.smtp_timeout = 30.0
+      config.smtp_timeout = 30.0
 
       # http status code used when plain text error message is output
       # Set to 200 if you want your want to distinguish between partial (text does not include success) and
       # total failure of rails application (http status of 500 etc)
 
-      self.http_status_for_error_text = 500
+      config.http_status_for_error_text = 500
 
       # http status code used when an error object is output (json or xml)
       # Set to 200 if you want your want to distinguish between partial (healthy property == false) and
       # total failure of rails application (http status of 500 etc)
 
-      self.http_status_for_error_object = 500
+      config.http_status_for_error_object = 500
+
+      # You can set what tests are run with the 'full' or 'all' parameter
+      self.full_checks = ['database', 'migrations', 'custom', 'email', 'cache']
 
       # Add one or more custom checks that return a blank string if ok, or an error message if there is an error
       config.add_custom_check do
@@ -104,6 +112,9 @@ To change the configuration of health_check, create a file `config/initializers/
 
 You may call add_custom_check multiple times with different tests. These tests will be included in the default list ("standard").
 
+If you have a catchall route in a rails 3.0 or later application then add the following line above the catch all route (in `config/routes.rb`):
+   health_check_routes
+
 == Uptime Monitoring
 
 Use a website monitoring service to check the url regularly for the word "success" (without the quotes) rather than just a 200 http status so
@@ -175,11 +186,13 @@ See https://github.com/ianheggie/health_check/wiki/Ajax-Example for an Ajax exam
 
 == Testing
 
-=== Automated testing
+=== Automated testing and other checks
 
-See Travis CI testing result: {<img src="https://travis-ci.org/ianheggie/health_check.png">}[https://travis-ci.org/ianheggie/health_check]
+Travis CI runs the tests: {<img src="https://travis-ci.org/ianheggie/health_check.png">}[https://travis-ci.org/ianheggie/health_check]
 
-Code Climate also monitors this project for code quality: {<img src="https://codeclimate.com/github/ianheggie/health_check.png" />}[https://codeclimate.com/github/ianheggie/health_check]
+Code Climate monitors code quality: {<img src="https://codeclimate.com/github/ianheggie/health_check.png" />}[https://codeclimate.com/github/ianheggie/health_check]
+
+Gemnasium monitors gem dependencies {<img src="https://gemnasium.com/ianheggie/health_check.png">}[https://gemnasium.com/ianheggie/health_check]
 
 === Manual testing
 
@@ -219,3 +232,7 @@ The command `rake test` will also launch these tests, except it cannot install t
 Copyright (c) 2010-2013 Ian Heggie, released under the MIT license.
 See MIT-LICENSE for details.
 
+== Contributors
+
+Thanks go to the various people who have given feedback and suggestions via the issues list and pull requests
+

data/config/routes.rb

@@ -1,8 +1,5 @@
 if defined?(HealthCheck::Engine)
   Rails.application.routes.draw do
-    get 'health_check', :to => 'health_check/health_check#index'
-    get 'health_check.:format', :to => 'health_check/health_check#index'
-    get 'health_check/:checks', :to => 'health_check/health_check#index'
-    get 'health_check/:checks.:format', :to => 'health_check/health_check#index'
+    health_check_routes
   end
 end

data/health_check.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.description = <<-EOF
   	Simple health check of Rails app for uptime monitoring with Pingdom, NewRelic, EngineYard or uptime.openacs.org etc.
   EOF
-  gem.homepage      = "https://github.com/ianheggie/health_check"
+  gem.homepage      = "http://ianheggie.github.io/health_check/"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/health_check.rb

@@ -5,6 +5,7 @@ module HealthCheck
 
   if Rails.version >= '3.0'
     class Engine < Rails::Engine
+      cattr_accessor :routes_defined
     end
   end
 
@@ -26,12 +27,14 @@ module HealthCheck
 
   # Array of custom check blocks
   mattr_accessor :custom_checks
+  mattr_accessor :full_checks
   self.custom_checks = [ ]
+  self.full_checks = ['database', 'migrations', 'custom', 'email', 'cache']
 
   def self.add_custom_check(&block)
     custom_checks << block
   end
-
+  
   def self.setup
     yield self
   end
@@ -42,7 +45,9 @@ require "health_check/version"
 require 'health_check/utils'
 require 'health_check/health_check_controller'
 
-unless defined?(HealthCheck::Engine)
+if defined?(HealthCheck::Engine)
+  require 'health_check/health_check_routes'
+else
   require 'health_check/add_23_routes'
 end
 

data/lib/health_check/health_check_routes.rb

@@ -0,0 +1,17 @@
+if defined?(HealthCheck::Engine)
+
+  module ActionDispatch::Routing
+    class Mapper
+      def health_check_routes
+        unless HealthCheck::Engine.routes_defined
+          HealthCheck::Engine.routes_defined = true
+          get 'health_check', :to => 'health_check/health_check#index'
+          get 'health_check.:format', :to => 'health_check/health_check#index'
+          get 'health_check/:checks', :to => 'health_check/health_check#index'
+          get 'health_check/:checks.:format', :to => 'health_check/health_check#index'
+        end
+      end
+    end
+  end
+
+end

data/lib/health_check/utils.rb

@@ -44,7 +44,7 @@ module HealthCheck
               errors << custom_check.call(self)
             end
           when "all", "full"
-            errors << HealthCheck::Utils.process_checks("database_migrations_custom_email_cache")
+            errors << HealthCheck::Utils.process_checks(HealthCheck.full_checks.join('_'))
           else
             return "invalid argument to health_test. "
         end
@@ -67,13 +67,13 @@ module HealthCheck
     end
 
     def self.get_database_version
-      ActiveRecord::Migrator.current_version
+      ActiveRecord::Migrator.current_version if defined?(ActiveRecord)
     end
 
     def self.get_migration_version(dir = self.db_migrate_path)
       latest_migration = nil
       Dir[File.join(dir, "[0-9]*_*.rb")].each do |f|
-        l = f.scan(/0*([0-9]+)_[_a-zA-Z0-9]*.rb/).first.first
+        l = f.scan(/0*([0-9]+)_[_.a-zA-Z0-9]*.rb/).first.first rescue -1
         latest_migration = l if !latest_migration || l.to_i > latest_migration.to_i
       end
       latest_migration

data/lib/health_check/version.rb

@@ -1,4 +1,4 @@
 module HealthCheck
-  VERSION = "1.2.0"
+  VERSION = "1.3.1"
 end
 

data/test/migrate/twelve/011_create_roles.roles.rb

@@ -0,0 +1,11 @@
+class CreateRoles < ActiveRecord::Migration
+  def self.up
+    create_table :roles do |t|
+      t.column :name, :string
+    end
+  end
+
+  def self.down
+    drop_table :roles
+  end
+end

data/test/{rails_4.0-beta.gemfile → rails_4.0.gemfile}

@@ -6,7 +6,7 @@ source 'https://rubygems.org'
 
 ruby "1.9.3" if RUBY_VERSION < '1.9'
 
-gem 'rails', "~> 4.0.0.beta1"
+gem 'rails', "~> 4.0.0"
 gem 'rake', '>= 0.8.3'
 gem "rack", '~> 1.5.2'
 

data/test/setup_railsapp

@@ -227,12 +227,12 @@ cat > public/ajax_example.html <<'EOF'
       <ul>
 	<li><a href="#" onclick="dynamic_call('text', 'http://localhost:3000/health_check/site');">Minimal health check should always work</a>
 	  (<a href="#" onclick="dynamic_call('json', 'http://localhost:3000/health_check/site.json');">json</a>,
-	  <a href="#" onclick="dynamic_call('site', 'http://localhost:3000/health_check/site.xml');">xml</a>,
+	  <a href="#" onclick="dynamic_call('xml', 'http://localhost:3000/health_check/site.xml');">xml</a>,
 	  <a href="#" onclick="dynamic_call('text', 'http://localhost:3000/health_check/site.html');">html</a>)
 
 	<li><a href="#" onclick="dynamic_call('text', 'http://localhost:3000/health_check/fail');">Force health check to fail!</a>
 	  (<a href="#" onclick="dynamic_call('json', 'http://localhost:3000/health_check/fail.json');">json</a>,
-	  <a href="#" onclick="dynamic_call('site', 'http://localhost:3000/health_check/fail.xml');">xml</a>,
+	  <a href="#" onclick="dynamic_call('xml', 'http://localhost:3000/health_check/fail.xml');">xml</a>,
 	  <a href="#" onclick="dynamic_call('text', 'http://localhost:3000/health_check/fail.html');">html</a>)
 	<li>Last results sent to success:<ul>
 	  <li><b>Data:</b><span id=data_success></span>

data/test/test_with_railsapp

@@ -129,6 +129,13 @@ echo
 
 echo 'TESTING health_check/migration should fail without all migrations ...'
 cp $base_dir/test/migrate/twelve/* db/migrate
+
+case "$actual_rails_version" in
+    *' '[12].*|*' '3.[01]*)
+        echo removing db/migrate/*.*.rb "($actual_rails_version does not support extra dots in migration names)"
+        rm -f db/migrate/*.*.rb
+        ;;
+esac
 ls db/migrate
 $testurl ${host}/health_check/migration 550 text/plain failed
 echo

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: health_check
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 25
   prerelease: 
   segments: 
   - 1
-  - 2
-  - 0
-  version: 1.2.0
+  - 3
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Ian Heggie
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-03-06 00:00:00 +11:00
+date: 2013-09-25 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -122,19 +122,21 @@ files:
 - lib/health_check.rb
 - lib/health_check/add_23_routes.rb
 - lib/health_check/health_check_controller.rb
+- lib/health_check/health_check_routes.rb
 - lib/health_check/utils.rb
 - lib/health_check/version.rb
 - test/fake_smtp_server
 - test/init_variables
 - test/migrate/empty/do_not_remove.txt
 - test/migrate/nine/9_create_countries.rb
+- test/migrate/twelve/011_create_roles.roles.rb
 - test/migrate/twelve/012_create_users.rb
 - test/migrate/twelve/9_create_countries.rb
 - test/rails_2.3.gemfile
 - test/rails_3.0.gemfile
 - test/rails_3.1.gemfile
 - test/rails_3.2.gemfile
-- test/rails_4.0-beta.gemfile
+- test/rails_4.0.gemfile
 - test/setup_railsapp
 - test/test_helper.rb
 - test/test_with_railsapp
@@ -142,7 +144,7 @@ files:
 - test/unit/health_check_controller_test.rb
 - test/unit/routes_test.rb
 has_rdoc: true
-homepage: https://github.com/ianheggie/health_check
+homepage: http://ianheggie.github.io/health_check/
 licenses: []
 
 post_install_message: 
@@ -180,13 +182,14 @@ test_files:
 - test/init_variables
 - test/migrate/empty/do_not_remove.txt
 - test/migrate/nine/9_create_countries.rb
+- test/migrate/twelve/011_create_roles.roles.rb
 - test/migrate/twelve/012_create_users.rb
 - test/migrate/twelve/9_create_countries.rb
 - test/rails_2.3.gemfile
 - test/rails_3.0.gemfile
 - test/rails_3.1.gemfile
 - test/rails_3.2.gemfile
-- test/rails_4.0-beta.gemfile
+- test/rails_4.0.gemfile
 - test/setup_railsapp
 - test/test_helper.rb
 - test/test_with_railsapp