health_check 1.1.2 → 1.2.0

data/.gitignore

@@ -17,6 +17,9 @@ test/tmp
 test/version_tmp
 tmp
 
+## RUBYMINE
+.idea/
+
 ## MAC OS
 .DS_Store
 
@@ -35,7 +38,9 @@ tmtags
 
 ## PROJECT::SPECIFIC
 bin/
+test/bin/
 railsapps/
+test/*.gemfile.lock
 ,*
 
 # Local ruby version config

data/.travis.yml

@@ -3,60 +3,71 @@ notifications:
   email:
     on_success: change
     on_failure: always
-rvm:
-  - 1.8.7
-  - 1.9.3
-  - rbx-18mode
-  - rbx-19mode
-  - jruby-18mode
-  - jruby-19mode
-  #- jruby-head
-  #- ruby-head
-  - ree
+
 before_install:
-  - gem update --system
+  - gem update --system $RUBYGEMS_VERSION
   - gem --version
   - gem install bundler
   - bundle --version
   - mkdir -p tmp/bundle
 
-gemfile:
-  - rails2_3.gemfile
-  - rails3_0.gemfile
-  - rails3_1.gemfile
-  - rails3_2.gemfile
-  #- rails_edge.gemfile
-
 bundler_args: "--binstubs"
 
 script: ./test/test_with_railsapp
 
+rvm: 
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+  - ree
+
+gemfile:
+  - test/rails_3.2.gemfile
+
+env:
+  - RUBYGEMS_VERSION=
+
 matrix:
   exclude:
-    - rvm: rbx-18mode
-      gemfile: rails2_3.gemfile
-    - rvm: rbx-19mode
-      gemfile: rails2_3.gemfile
-    - rvm: jruby-18mode
-      gemfile: rails2_3.gemfile
+    - rvm: 1.8.7
+      gemfile: test/rails_3.2.gemfile
+      env: RUBYGEMS_VERSION=
+
     - rvm: jruby-19mode
-      gemfile: rails2_3.gemfile
-    - rvm: jruby-head
-      gemfile: rails2_3.gemfile
-    - rvm: ruby-head
-      gemfile: rails2_3.gemfile
-    - rvm: 1.9.3
-      gemfile: rails2_3.gemfile
+      gemfile: test/rails_3.2.gemfile
+      env: RUBYGEMS_VERSION=
+
+  include:
+    # rails 2.3 march 16 2009 - ruby 1.8.7
+    - rvm: 1.8.7
+      gemfile: test/rails_2.3.gemfile
+      env: RUBYGEMS_VERSION=1.8.25
 
+    # rails 3.0 aug 29 2010 - ruby 1.8.7
     - rvm: 1.8.7
-      gemfile: rails_edge.gemfile
-    - rvm: rbx-18mode
-      gemfile: rails_edge.gemfile
-    - rvm: jruby-18mode
-      gemfile: rails_edge.gemfile
-    - rvm: ree
-      gemfile: rails_edge.gemfile
+      gemfile: test/rails_3.0.gemfile
+      env: RUBYGEMS_VERSION=
+
+    # rails 3.1 aug 31, 2011 - ruby 1.8.7 or 1.9.2
+    - rvm: 1.8.7
+      gemfile: test/rails_3.1.gemfile
+      env: RUBYGEMS_VERSION=
+
+    - rvm: 1.9.2
+      gemfile: test/rails_3.1.gemfile
+      env: RUBYGEMS_VERSION=
+
+    # rails 4.0 - in development as of 5 mar 2013 - ruby 2.0
+    - rvm: 2.0.0
+      gemfile: test/rails_4.0-beta.gemfile
+      env: RUBYGEMS_VERSION=
+
+    - rvm: jruby-19mode
+      gemfile: test/rails_3.2.gemfile
+      env: RUBYGEMS_VERSION=1.8.25
+
   allow_failures:
-    - gemfile: rails_edge.gemfile
-    - rvm: jruby-head
-    - rvm: ruby-head
+    - gemfile: test/rails_4.0-beta.gemfile

data/CHANGELOG

@@ -1,5 +1,9 @@
 = Change Log =
 
+* 1.2.0 - The gem can now be configured, including timeouts, status codes and text returned on success
+        - Customn checks can be added via initializer like config.add_custom_check { CustomCheckClass.a_custom_check }
+	- You can now request the response to be json or xml (via url or Content-accepted header)
+	- reduced tests to the versions of ruby recomended for the different versions of rails
 * 1.1.2 - Change to bundler support for building gems, as jeweler gem was broken by v2.0.0 of rubygems
 * 1.1.0 - Include cache check (Thanks to https://github.com/mgomes1 ) and some changes to test setup to workaround and diagnose test failures under rvm
 * 1.0.2 - Included travis config and gemfiles used in travis tests in gem and changes to test setup so that gem test 

data/README.rdoc

@@ -1,4 +1,4 @@
-= health\_check gem
+= health_check gem
 
 Simple health check of Rails app for use with Pingdom, NewRelic, EngineYard or uptime.openacs.org etc.
 
@@ -36,6 +36,8 @@ 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).
 
+Note: rails 4.0 also checks migrations and throws a ActiveRecord::PendingMigrationError (http error 500)
+
 == Installation
 
 === As a Gem from rubygems (Rails 3.0 and above)
@@ -69,6 +71,39 @@ Run the following commands from the root of your rails application
     cd vendor/plugins
     git clone git://github.com/ianheggie/health_check.git
 
+== Configuration
+
+To change the configuration of health_check, create a file `config/initializers/health_check.rb` and add a configuration block like:
+
+    HealthCheck.setup do |config|
+
+      # Text output upon success
+      config.success = 'success'
+
+      # Timeout in seconds used when checking smtp server
+      self.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
+
+      # 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
+
+      # 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
+        CustomHealthCheck.perform_check # any code that returns blank on success and non blank string upon failure
+      end
+
+    end
+
+You may call add_custom_check multiple times with different tests. These tests will be included in the default list ("standard").
+
 == 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
@@ -84,6 +119,41 @@ See
 * 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
 
+=== Requesting Json and XML responses
+
+Health_check will respond with an encoded hash object if json or xml is requested.
+Either set the HTTP Accept header or append .json or .xml to the url.
+
+The hash contains two keys:
+* healthy - true if requested checks pass (boolean)
+* message - text message ("success" or error message)
+
+The following commands 
+
+  curl -v localhost:3000/health_check.json
+  curl -v localhost:3000/health_check/email.json
+  curl -v -H "Accept: application/json" localhost:3000/health_check
+
+Will return a result with Content-Type: application/json and body like:
+
+  {"healthy":true,"message":"success"}
+
+These following commands
+
+  curl -v localhost:3000/health_check.xml
+  curl -v localhost:3000/health_check/migration_cache.xml
+  curl -v -H "Accept: text/xml" localhost:3000/health_check/cache
+
+Will return a result with Content-Type: application/xml and body like:
+
+  <?xml version="1.0" encoding="UTF-8"?>
+  <hash>
+    <healthy type="boolean">true</healthy>
+    <message>success</message>
+  </hash>
+
+See https://github.com/ianheggie/health_check/wiki/Ajax-Example for an Ajax example
+
 == Note on Patches/Pull Requests
 
 <em>Feedback welcome! Especially with suggested replacement code and corresponding tests</em>
@@ -105,11 +175,11 @@ See
 
 == Testing
 
-=== Automated continuous integration tests
+=== Automated testing
 
 See Travis CI testing result: {<img src="https://travis-ci.org/ianheggie/health_check.png">}[https://travis-ci.org/ianheggie/health_check]
 
-Code Climate also monitors this project: {<img src="https://codeclimate.com/github/ianheggie/health_check.png" />}[https://codeclimate.com/github/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]
 
 === Manual testing
 
@@ -119,7 +189,7 @@ This will require TCP port 3456 to be free.
 
 Using rbenv or rvm, install and set the version of ruby you wish to test against.
 You will need to install the bundler gem if using rbenv.
-See the <tt>.travis.yml</tt> file for a list of supported ruby versions.
+See the <tt>.travis.yml</tt> file for the list of ruby versions that we test against.
 
 * rbenv command: <tt>rbenv shell 1.8.7-p371</tt>
 * rvm command: <tt>rvm use 1.9.3</tt>
@@ -130,26 +200,19 @@ Create a temp directory for throw away testing, and clone the health_check gem i
     cd ~/tmp
     git clone https://github.com/ianheggie/health_check.git
 
-All of the following commands should be run under the checked out gem
+Cd to the checked out health_check directory and then run the test as follows:
 
     cd ~/tmp/health_check
 
-Configure which rails version you want to test against, and load the gems appropriate for the ruby version - use one of the following commands:
-
-    export BUNDLE_GEMFILE=$PWD/rails2_3.gemfile
-    export BUNDLE_GEMFILE=$PWD/rails3_0.gemfile
-    export BUNDLE_GEMFILE=$PWD/rails3_1.gemfile
-    export BUNDLE_GEMFILE=$PWD/rails3_2.gemfile
-    unset BUNDLE_GEMFILE # for installed version of rails
-
-Then install the required gems, and update rbenv shims (if using rbenv)
+    test/test_with_railsapp
 
-    bundle install --binstubs
-    rbenv rehash
+The script will first call `test/setup_railsapp` to setup a rails app with health_check installed and then
+run up the rails server and perform veraious tests.
 
-Run the tests
+The script `test/setup_railsapp` will prompt you for which gemfile under test you wish to use to install the appropriate rails version, and then
+setup tmp/railsapp accordingly.
 
-    bin/rake test
+The command `rake test` will also launch these tests, except it cannot install the bundler and rake gems if they are missing first (unlike test/test_with_railsapp)
 
 == Copyright
 

data/config/routes.rb

@@ -1,6 +1,8 @@
 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'
+    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

data/health_check.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency(%q<rake>, [">= 0.8.3"])
   gem.add_development_dependency(%q<shoulda>, ["~> 2.11.0"])
   gem.add_development_dependency(%q<sqlite3>, ["~> 1.3.7"])
-  gem.add_development_dependency(%q<bundler>, ["~> 1.2.0"])
+  gem.add_development_dependency(%q<bundler>, ["~> 1.2"])
 end

data/lib/health_check.rb

@@ -8,6 +8,34 @@ module HealthCheck
     end
   end
 
+  # Text output upon success
+  mattr_accessor :success
+  self.success = "success"
+
+  # Timeout in seconds used when checking smtp server
+  mattr_accessor :smtp_timeout
+  self.smtp_timeout = 30.0
+
+  # http status code used when plain text error message is output
+  mattr_accessor :http_status_for_error_text
+  self.http_status_for_error_text = 500
+
+  # http status code used when an error object is output (json or xml)
+  mattr_accessor :http_status_for_error_object
+  self.http_status_for_error_object = 500
+
+  # Array of custom check blocks
+  mattr_accessor :custom_checks
+  self.custom_checks = [ ]
+
+  def self.add_custom_check(&block)
+    custom_checks << block
+  end
+
+  def self.setup
+    yield self
+  end
+
 end
 
 require "health_check/version"

data/lib/health_check/add_23_routes.rb

@@ -6,14 +6,19 @@ module ActionController
   module Routing #:nodoc:
     class RouteSet #:nodoc:
       alias_method :draw_without_health_check_routes, :draw
+
       def draw
-	draw_without_health_check_routes do |map|
-	  map.connect 'health_check',
-	    :controller => 'health_check/health_check', :action => 'index'
-	  map.connect 'health_check/:checks',
-	    :controller => 'health_check/health_check', :action => 'check'
-	  yield map
-	end
+        draw_without_health_check_routes do |map|
+          map.connect 'health_check',
+                      :controller => 'health_check/health_check', :action => 'index'
+          map.connect 'health_check.:format',
+                      :controller => 'health_check/health_check', :action => 'index'
+          map.connect 'health_check/:checks',
+                      :controller => 'health_check/health_check', :action => 'index'
+          map.connect 'health_check/:checks.:format',
+                      :controller => 'health_check/health_check', :action => 'index'
+          yield map
+        end
       end
     end
   end

data/lib/health_check/health_check_controller.rb

@@ -9,26 +9,29 @@ module HealthCheck
     layout nil
 
     def index
-      do_check('standard')
-    end
-
-    def check
-      do_check(params[:checks])
-    end
-
-    private
-
-    def do_check(checks)
+      checks = params[:checks] || 'standard'
       begin
-        errors = process_checks(checks)
+        errors = HealthCheck::Utils.process_checks(checks)
       rescue Exception => e
         errors = e.message
       end     
       if errors.blank?
-        render :text => HealthCheck::Utils.success, :content_type => 'text/plain'
+        obj = { :healthy => true, :message => HealthCheck.success }
+        respond_to do |format|
+          format.html { render :text => HealthCheck.success, :content_type => 'text/plain' }
+          format.json { render :xml => obj.to_json }
+          format.xml { render :xml => obj.to_xml }
+          format.any { render :text => HealthCheck.success, :content_type => 'text/plain' }
+        end
       else
         msg = "health_check failed: #{errors}"
-        render :text => msg, :status => 500, :content_type => 'text/plain'
+        obj = { :healthy => false, :message => msg }
+        respond_to do |format|
+          format.html { render :text => msg, :status => HealthCheck.http_status_for_error_text, :content_type => 'text/plain'  }
+          format.json { render :xml => obj.to_json, :status => HealthCheck.http_status_for_error_object}
+          format.xml { render :xml => obj.to_xml, :status => HealthCheck.http_status_for_error_object }
+          format.any { render :text => msg, :status => HealthCheck.http_status_for_error_text, :content_type => 'text/plain'  }
+        end
         # Log a single line as some uptime checkers only record that it failed, not the text returned
         if logger
           silence_level, logger.level = logger.level, @old_logger_level
@@ -38,35 +41,6 @@ module HealthCheck
       end
     end
 
-    def process_checks(checks)
-      errors = ''
-      checks.split('_').each do |check|
-        case check
-        when 'and', 'site'
-          # do nothing
-        when "database"
-          HealthCheck::Utils.get_database_version
-        when "email"
-          errors << HealthCheck::Utils.check_email
-        when "migrations", "migration"
-          database_version = HealthCheck::Utils.get_database_version
-          migration_version = HealthCheck::Utils.get_migration_version
-          if database_version.to_i != migration_version.to_i
-            errors << "Current database version (#{database_version}) does not match latest migration (#{migration_version}). "
-          end
-        when 'cache'
-          errors << HealthCheck::Utils.check_cache
-        when "standard"
-          errors << process_checks("database_migrations")
-          errors << process_checks("email") unless HealthCheck::Utils.default_action_mailer_configuration?
-        when "all", "full"
-          errors << process_checks("database_migrations_email_cache")
-        else
-          return "invalid argument to health_test. "
-        end
-      end
-      return errors
-    end
 
     protected