rails_health_check 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ece3b0c5fed38d6c9ccc1e60600284733553b5ae6caa8eaa40f4da34b1cf0339
+  data.tar.gz: 146bc1328a9f22300105500be926fe1d3cb982ae0f7410cfc725fa961e66062c
+SHA512:
+  metadata.gz: 8cd5439d276daf70a246f73d17df6fc5768881360018a488b5804149ddee18d384da602aaa99080f7ac715517a86bd83f3425165b1e5bd1c3126ae695d72c3f9
+  data.tar.gz: e7e76f22b9f8a6fe74d8b3fcbb3e4cc072ea2186cfb55d9b8a0d7a3b89b4b9af6b14a588a7266fe6d5146f11e86a07a0e2e8bc037d364da5b5cd8f5cf19d3396

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,49 @@
+# Suggested by bundler
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+
+## PROJECT::SPECIFIC
+bin/
+test/bin/
+railsapps/
+test/*.gemfile.lock
+,*
+
+# See: https://gist.github.com/ianheggie/9327010
+# for Global git ignore for OS/IDE/temp/backup files
+.vagrant/
+
+### Vim
+# Swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~

data/.travis.yml

@@ -0,0 +1,50 @@
+sudo: false
+addons:
+  apt:
+    packages:
+    - net-tools
+
+cache: bundler
+language: ruby
+notifications:
+  email:
+    on_success: change
+    on_failure: always
+
+before_install:
+  - gem update --system $RUBYGEMS_VERSION
+  - gem --version
+  - gem install bundler ${BUNDLER_VERSION:+-v} ${BUNDLER_VERSION}
+  - gem install smarter_bundler
+  - bundle --version
+  - mkdir -p tmp/bundle
+
+bundler_args: "--binstubs"
+
+script: ./test/test_with_railsapp
+
+matrix:
+  fast_finish: true
+
+  allow_failures:
+    - rvm: 2.4.3
+      gemfile: test/rails_edge.gemfile
+      env: RAILS_VERSION=edge MIDDLEWARE=YES
+
+    - rvm: ruby-head
+      gemfile: test/rails_5.1.gemfile
+      env: RAILS_VERSION=5.1 MIDDLEWARE=YES
+
+  include:
+    - rvm: 2.4.3
+      gemfile: test/rails_edge.gemfile
+      env: RAILS_VERSION=edge MIDDLEWARE=YES
+
+    - rvm: ruby-head
+      gemfile: test/rails_5.1.gemfile
+      env: RAILS_VERSION=5.1 MIDDLEWARE=YES
+
+    - rvm: 2.3.1
+      gemfile: test/rails_5.1.gemfile
+      env: RAILS_VERSION=5.1 MIDDLEWARE=YES
+

data/CHANGELOG

@@ -0,0 +1,64 @@
+= Change Log =
+
+* 2.7.0
+ * Add ability to check health of redis when url is non-standard redis url
+* 2.6.0
+ * Add named custom checks
+* 2.5.0
+ * Added whitelist for IP# (Thanks Fernando Alvarez)
+ * reworked whitelist PR
+ * Expanded tests for whitelist and basic authentication
+ * reworked middleware, simplified error codes, added whitelist and basic authentication into middleware
+ * Removed unit tests as they where aonly applicable under rails 2.3 when installed in vendor/plugins
+ * #55 by mnoack - correct binstubs arg in test
+ * #54 by gkop - Lograge config snippet works with Rails 4.2.7.1, lograge 0.4.1 
+ * Used ideas from #52 - use middleware to catch Rails stack exceptions
+ * #51 by tokenshift - Fixing NameError on `basic_auth_username`.
+ * Changes to address #50 by fillphafftek - allow standard check to be run from middleware if configured to do so, removed requirement for "middleware" to be passed in url for middleware tests
+* 2.4.0
+ * Added tests for middleware
+ * Changed contributed middleware code to conform to existing url scheme
+ * Allow both GET and POST calls
+ * Prefer config.uri for changing route prefix
+* 2.3.0
+ * Fix route reload issue
+ * Various fixes to get tests working with bundle/jruby and other gem issues
+ * Document additional branches
+ * Fix route reload issue (auto routing previosuly conflicted with devise)
+ * Removed ref to rails 2.3, 3.*
+
+* 2.2.1
+  * Adjust private/public cache-control based on max_age set
+* 2.2.0
+  * Add max_age so we can control the caching of responses, don't run tests if Last-modified still matches
+  * Added basic auth - Thanks omadahealth
+  * A few macinations due to gem changes and avoidning triggering deprecation notices
+  * Add single quote to README to make the configuration file valid - Thanks Ryan Selk <ryanselk@gmail.com>
+  * Fixed README formatting
+* 2.1.0
+  * Updated contributed tests so there is both the forced check and a *-if-present check which tests if the gem's class is loaded
+  * Added resque-redis check - Thanks filiphaftek <filip.haftek@airhelp.com>
+  * In addition to adding a test file to S3, we will also try to delete it to confirm that delete operations are possible - Thanks Anton Dimitrov <dimitrov.anton@gmail.com>
+  * Added redis, sidekiq-redis and s3 health-checks - Thanks Filip <filip.haftek@airhelp.com>
+  * Fix render options - Thanks Yuji Hanamura <yuji.developer@gmail.com>
+  * Fix to always return a 200 status code on success rather than 304 (adds Last-Modified) - Thanks macgregordennis <macgregordennis@gmail.com>
+  * Added Rails 5.0 tests
+
+* 2.0.0 - Removed silence - recommend to use a log filtering gem instead
+* 1.4.1 - Rails 4 and route changes
+  * Now handles routes being generated multiple times by some gem / rails / ruby combinations - Previously multiple calls to health_check_routes where ignored, now explicit calls to health_check_route always adds the route but flags that it doesn't have to be added again on the end of the list
+  * Uses ActiveRecord::Migration.check_pending! if available and returns the message if an exception is raised (Rails 4.0+)
+  * Simplified routing rules down to one rule for Rails 3.0+
+  * Includes some changes for rails 4.1 (edge) - but still a work in progress
+* 1.3.1 - Include changes from contributers:
+  * Migrations with dots are now handled
+  * the list of checks for "full" / "all" can be configured
+* 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 
+* 1.x - Includes Rails 3.x suppprt as an Engine
+* 0.x - Rails 2.3

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in health_check.gemspec
+
+gemspec
+
+group :development, :test do
+  if defined?(JRUBY_VERSION)
+    gem 'jruby-openssl'
+    gem 'activerecord-jdbcsqlite3-adapter'
+  else
+    gem 'sqlite3', '~> 1.3.7'
+  end
+  # run travis-lint to check .travis.yml
+  gem 'travis-lint'
+  # mime-types 2.0 requires Ruby version >= 1.9.2
+  # mime-types 3.0 requires Ruby version >= 2.0
+  gem 'mime-types', defined?(JRUBY_VERSION) || RUBY_VERSION < '2.0' ? '< 3' : '>= 3.0'
+
+end

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010-2013 Ian Heggie
+
+MIT License
+
+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,337 @@
+= health_check gem
+
+Simple health check of Rails edge apps for use with Pingdom, NewRelic, EngineYard or uptime.openacs.org etc.
+
+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)
+
+Use gem versions for stable releases, or github branch / commits for development versions:
+* gem versions ~> 3.0 for Rails 5.x, or the {rails5}[https://github.com/ianheggie/health_check/tree/rails5] development branch
+* gem versions ~> 2.0 for Rails 4.x, or the {rails4}[https://github.com/ianheggie/health_check/tree/rails4] development branch;
+* gem versions ~> 1.7 for Rails 3.x, or the {rails3}[https://github.com/ianheggie/health_check/tree/rails3] development branch;
+* gem versions ~> 1.6.1 for Rails 2.3, or the {rails2.3}[https://github.com/ianheggie/health_check/tree/rails2.3] development branch;
+* {master}[https://github.com/ianheggie/health_check/tree/master] branch for edge development;
+
+Note: it is best to pin to a specific commit if using a development branch as sometimes tests break.
+
+health_check provides various monitoring URIs, for example:
+
+    curl localhost:3000/health_check
+    success
+
+    curl localhost:3000/health_check/all.json
+    {"healthy":true,"message":"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>
+
+You may also issue POST calls instead of GET to these urls.
+
+On failure (detected by health_check) 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.
+
+The health_check controller disables sessions for versions that eagerly load sessions.
+
+== Checks
+
+* standard (default) - site, database and migrations checks are run plus email if ActionMailer is defined and it is not using the default configuration
+* all / full - all checks are run (can be overriden in config block)
+* cache - checks that a value can be written to the cache
+* custom - runs checks added via config.add_custom_check
+* 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
+* redis / redis-if-present - checks Redis connectivity
+* resque-redis / resque-redis-if-present - checks Resque connectivity to Redis
+* s3 / s3-if-present - checks proper permissions to s3 buckets
+* sidekiq-redis / sidekiq-redis-if-present - checks Sidekiq connectivity to Redis
+* site - checks rails is running sufficiently to render text
+
+Some checks have a *-if-present form, which only runs the check if the corresponding library has been required.
+
+The email gateway is not checked unless the smtp settings have been changed.
+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 by default in development mode and throws an ActiveRecord::PendingMigrationError exception (http error 500) if there is an error
+
+== Installation
+
+Add the following line to Gemfile
+
+    gem "health_check"
+
+And then execute
+
+    bundle
+
+Or install it yourself as:
+
+    gem install health_check
+
+== 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|
+
+      # uri prefix (no leading slash)
+      config.uri = 'health_check'
+
+      # Text output upon success
+      config.success = 'success'
+
+      # Timeout in seconds used when checking smtp server
+      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)
+
+      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)
+
+      config.http_status_for_error_object = 500
+
+      # bucket names to test connectivity - required only if s3 check used, access permissions can be mixed
+      config.buckets = {'bucket_name' => [:R, :W, :D]}
+
+      # You can customize which checks happen on a standard health check, eg to set an explicit list use:
+      config.standard_checks = [ 'database', 'migrations', 'custom' ]
+
+      # Or to exclude one check:
+      config.standard_checks -= [ 'emailconf' ]
+
+      # You can set what tests are run with the 'full' or 'all' parameter
+      config.full_checks = ['database', 'migrations', 'custom', 'email', 'cache', 'redis', 'resque-redis', 'sidekiq-redis', 's3']
+
+      # 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
+
+      # Add another custom check with a name, so you can call just specific custom checks. This can also be run using
+      # the standard 'custom' check.
+      # You can define multiple tests under the same name - they will be run one after the other.
+      config.add_custom_check('sometest') do
+        CustomHealthCheck.perform_another_check # any code that returns blank on success and non blank string upon failure
+      end
+
+      # max-age of response in seconds
+      # cache-control is public when max_age > 1 and basic_auth_username is not set
+      # You can force private without authentication for longer max_age by
+      # setting basic_auth_username but not basic_auth_password
+      config.max_age = 1
+
+      # Protect health endpoints with basic auth
+      # These default to nil and the endpoint is not protected
+      config.basic_auth_username = 'my_username'
+      config.basic_auth_password = 'my_password'
+
+      # Whitelist requesting IPs
+      # Defaults to blank and allows any IP
+      config.origin_ip_whitelist = %w(123.123.123.123)
+
+      # http status code used when the ip is not allowed for the request
+      config.http_status_for_ip_whitelist_error = 403
+
+      # When redis url is non-standard
+      config.redis_url = 'redis_url'
+
+      # Disable the error message to prevent /health_check from leaking
+      # sensitive information
+      config.include_error_in_response_body = false
+    end
+
+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 then add the following line above the catch all route (in `config/routes.rb`):
+   health_check_routes
+
+=== Installing As Middleware
+
+Install health_check as middleware if you want to sometimes ignore exceptions from later parts of the Rails middleware stack,
+eg DB connection errors from QueryCache. The "middleware" check will fail if you have not installed health_check as middleware.
+
+To install health_check as middleware add the following line to the config/application.rb:
+    config.middleware.insert_after Rails::Rack::Logger, HealthCheck::MiddlewareHealthcheck
+
+Note: health_check is installed as a full rails engine even if it has been installed as middleware. This is so the
+remaining checks continue to run through the complete rails stack.
+
+You can also adjust what checks are run from middleware, eg if you want to exclude the checking of the database etc, then set
+  config.middleware_checks = ['middleware', 'standard', 'custom']
+  config.standard_checks = ['middleware', 'custom']
+
+Middleware checks are run first, and then full stack checks.
+When installed as middleware, exceptions thrown when running the full stack tests are formatted in the standard way.
+
+== 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
+that any substitution of a different server or generic information page should also be reported as an error.
+
+If an error is encounted, the text "health_check failed: some error message/s" will be returned and the http status will be 500.
+
+See
+
+* 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)
+* Nagios check_http (with -s success) - https://www.nagios-plugins.org/doc/man/check_http.html
+* Any other montoring service that can be set to check for the word success in the text 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
+
+== Silencing log output
+
+It is recomended that you use silencer, lograge or one of the other log filtering gems.
+
+For example, with lograge use the following to exclude health_check from being logged:
+
+    config.lograge.ignore_actions = ["HealthCheck::HealthCheckController#index"]
+
+Likewise you will probably want to exclude health_check from monitoring systems like newrelic.
+
+== Caching
+
+Cache-control is set with
+* public if max_age is > 1 and basic_auth_username is not set (otherwise private)
+* no-cache
+* must-revalidate
+* max-age (default 1)
+
+Last-modified is set to the current time (rounded down to a multiple of max_age when max_age > 1)
+
+== Note on Patches/Pull Requests
+
+<em>Feedback welcome! Especially with suggested replacement code and corresponding tests</em>
+
+1. Fork it
+2. Create your feature branch (<tt>git checkout -b my-new-feature</tt>)
+3. Commit your changes (<tt>git commit -am 'Add some feature'</tt>)
+4. Push to the branch (<tt>git push origin my-new-feature</tt>)
+5. Create new Pull Request.
+
+== Known Issues
+
+* No inline documentation for methods
+* <b>rvm gemsets breaks the test</b> - specifically <tt>rvm use 1.9.3</tt> works but <tt>rvm gemset use ruby-1.9.3-p385@health_check --create</tt> triggers a "Could not find gem 'coffee-rails (~> 3.2.1) ruby' in the gems available on this machine." error in the last call to bundle (installing health_check as a gem via a path into the temp railsapp)
+
+== Similar projects
+
+* fitter_happier plugin by atmos - plugin with similar goals, but not compatible with uptime, and does not check email gateway
+
+== Testing
+
+=== Automated testing and other checks
+
+* {<img src="https://badge.fury.io/rb/health_check.png" alt="Gem Version" />}[http://badge.fury.io/rb/health_check] - Latest Gem
+* {<img src="https://travis-ci.org/ianheggie/health_check.png">}[https://travis-ci.org/ianheggie/health_check]  - Travis CI
+* {<img src="https://codeclimate.com/github/ianheggie/health_check.png" />}[https://codeclimate.com/github/ianheggie/health_check] - Code quality
+* {<img src="https://gemnasium.com/ianheggie/health_check.png">}[https://gemnasium.com/ianheggie/health_check] - Gem dependencies
+
+=== Manual testing
+
+The instructions have been changed to using a vagrant virtual box for consistant results.
+
+Install vagrant 1.9.7 or later and virtual_box or other local virtual machine providor.
+
+Create a temp directory for throw away testing, and clone the health_check gem into it
+
+    mkdir -p ~/tmp
+    cd ~/tmp
+    git clone https://github.com/ianheggie/health_check.git ~/tmp/health_check
+
+The Vagrantfile includes provisioning rules to install chruby (ruby version control),
+ruby-build will also be installed and run to build various rubies under /opt/rubies.
+
+Use <tt>vagrant ssh</tt> to connect to the virtual box and run tests.
+
+The test script will package up and install the gem under a temporary path, create a dummy rails app configured for sqlite,
+install the gem, and then run up tests against the server.
+This will require TCP port 3456 to be free.
+
+Cd to the checked out health_check directory and then run the test as follows:
+
+    cd ~/tmp/health_check
+
+    vagrant up   # this will also run vagrant provision and take some time
+                 # chruby and various ruby versions will be installed
+
+    vagrant ssh
+
+    cd /vagrant  # the current directory on your host is mounted here on the virtual machine
+
+    chruby 2.2.2 # or some other ruby version (run chruby with no arguments to see the current list)
+
+    test/test_with_railsapp
+
+    exit        # from virtual machine when finished
+
+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.
+
+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.
+
+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
+
+Copyright (c) 2010-2017 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.
+
+=== Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request (Code with BDD tests are favoured)

data/Rakefile

@@ -0,0 +1,29 @@
+require "bundler/gem_tasks"
+
+#require 'rubygems'
+require 'rake'
+
+#tests as gem
+task :test do
+  exec '/bin/bash', './test/test_with_railsapp'
+end
+
+task :default => :test
+
+begin
+  gem 'rdoc'
+  require 'rdoc/task'
+
+  Rake::RDocTask.new do |rdoc|
+    version = HealthCheck::VERSION
+
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "health_check #{version}"
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('CHANGELOG')
+    rdoc.rdoc_files.include('MIT-LICENSE')
+    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/Vagrantfile

@@ -0,0 +1,20 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  config.vm.box = "ubuntu/xenial64"
+
+  # set auto_update to false, if you do NOT want to check the correct 
+  # additions version when booting this machine
+  config.vbguest.auto_update = false
+    
+  # do NOT download the iso file from a webserver
+  config.vbguest.no_remote = true
+
+  # provision with a shell script.
+  config.vm.provision "shell", path: "./test/provision_vagrant"
+
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+unless HealthCheck::Engine.routes_explicitly_defined
+  Rails.application.routes.draw do
+    add_health_check_routes()
+  end
+end

data/health_check.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'health_check/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'rails_health_check'
+  gem.version       = HealthCheck::VERSION
+  gem.required_rubygems_version = Gem::Requirement.new('>= 0') if gem.respond_to? :required_rubygems_version=
+  gem.authors       = ['Ian Heggie']
+  gem.email         = ['ian@heggie.biz']
+  gem.summary = 'Simple health check of Rails app for uptime monitoring with Pingdom, NewRelic, EngineYard or uptime.openacs.org etc.'
+  gem.description = <<-EOF
+  	Fork of https://github.com/ianheggie/health_check.
+    Simple health check of Rails app for uptime monitoring with Pingdom, NewRelic, EngineYard or uptime.openacs.org etc.
+  EOF
+  gem.homepage      = 'https://github.com/FinalCAD/health_check'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.extra_rdoc_files = ['README.rdoc']
+  gem.require_paths = ['lib']
+  gem.required_ruby_version = '>= 2.2.2'
+  gem.add_dependency('rails', ['>= 4.0'])
+  gem.add_development_dependency('bundler')
+  gem.add_development_dependency('rake', ['>= 0.8.3'])
+  gem.add_development_dependency('shoulda', ['~> 2.11.0'])
+  gem.add_development_dependency('smarter_bundler', ['>= 0.1.0'])
+  gem.add_development_dependency 'sqlite3'
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'health_check'
+

data/lib/health_check/base_health_check.rb

@@ -0,0 +1,5 @@
+module BaseHealthCheck
+  def create_error(check_type, error_message)
+    "[#{check_type} - #{error_message}] "
+  end
+end