health_check 2.1.0 → 2.2.0

data/.travis.yml

@@ -23,10 +23,6 @@ matrix:
       gemfile: test/rails_edge.gemfile
       env: RAILS_VERSION=edge
 
-    - rvm: ruby-head
-      gemfile: test/rails_edge.gemfile
-      env: RAILS_VERSION=edge
-
     - rvm: ruby-head
       gemfile: test/rails_5.0.gemfile
       env: RAILS_VERSION=5.0
@@ -38,12 +34,12 @@ matrix:
       gemfile: test/rails_edge.gemfile
       env: RAILS_VERSION=edge
 
-    - rvm: ruby-head
-      gemfile: test/rails_edge.gemfile
-      env: RAILS_VERSION=edge
-
     # ruby 5.0  Jun. 2016
     
+    - rvm: 2.3.1
+      gemfile: test/rails_5.0.gemfile
+      env: RAILS_VERSION=5.0
+
     - rvm: 2.2.2
       gemfile: test/rails_5.0.gemfile
       env: RAILS_VERSION=5.0

data/Gemfile

@@ -15,6 +15,6 @@ group :development, :test do
   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', RUBY_VERSION < '1.9.2' ? '< 2.0' : (defined?(JRUBY_VERSION) || RUBY_VERSION < '2.0' ? '< 3.0' : '>= 3.0')
+  gem 'mime-types', RUBY_VERSION < '1.9.2' ? '< 2.0' : (defined?(JRUBY_VERSION) || RUBY_VERSION < '2.0' ? '< 3' : '>= 3.0')
 
 end

data/README.rdoc

@@ -38,10 +38,10 @@ The health_check controller disables sessions for versions that eagerly load ses
 * 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\[-if-present\] - checks Redis connectivity
-* resque-redis\[-if-present\] - checks Resque connectivity to Redis
-* s3\[-if-present\] - checks proper permissions to s3 buckets
-* sidekiq-redis\[-if-present\] - checks Sidekiq connectivity to Redis
+* 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.
@@ -100,13 +100,23 @@ To change the configuration of health_check, create a file `config/initializers/
       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']
+      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
 
+      # 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'
     end
 
 You may call add_custom_check multiple times with different tests. These tests will be included in the default list ("standard").

data/lib/health_check.rb

@@ -23,10 +23,20 @@ module HealthCheck
   mattr_accessor :http_status_for_error_object
   self.http_status_for_error_object = 500
 
+  # max-age of response in seconds
+  # cache-control is public when max_age > 1 and basic authentication is used 
+  mattr_accessor :max_age
+  self.max_age = 1
+
   # s3 buckets
   mattr_accessor :buckets
   self.buckets = {}
 
+  # Basic Authentication
+  mattr_accessor :basic_auth_username, :basic_auth_password
+  self.basic_auth_username = nil
+  self.basic_auth_password = nil
+
   # Array of custom check blocks
   mattr_accessor :custom_checks
   mattr_accessor :full_checks

data/lib/health_check/health_check_controller.rb

@@ -5,35 +5,45 @@ module HealthCheck
   class HealthCheckController < ActionController::Base
 
     layout false if self.respond_to? :layout
+    before_filter :authenticate
 
     def index
-      checks = params[:checks] || 'standard'
-      begin
-        errors = HealthCheck::Utils.process_checks(checks)
-      rescue Exception => e
-        errors = e.message.blank? ? e.class.to_s : e.message.to_s
-      end     
-      if errors.blank?
-        response.headers['Last-Modified'] = Time.now.httpdate
-        obj = { :healthy => true, :message => HealthCheck.success }
-        respond_to do |format|
-          format.html { render :text => HealthCheck.success, :content_type => 'text/plain' }
-          format.json { render :json => obj }
-          format.xml { render :xml => obj }
-          format.any { render :text => HealthCheck.success, :content_type => 'text/plain' }
-        end
-      else
-        msg = "health_check failed: #{errors}"
-        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 :json => obj, :status => HealthCheck.http_status_for_error_object}
-          format.xml { render :xml => obj, :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
-          logger.info msg
+      last_modified = Time.now.utc
+      max_age = HealthCheck.max_age
+      if max_age > 1
+        last_modified = Time.at((last_modified.to_f / max_age).floor * max_age).utc
+      end
+      if stale?(:last_modified => last_modified, :public => (max_age > 1) && ! basic_auth_username)
+        # Rails 4.0 doesn't have :plain, but it is deprecated later on
+        plain_key = Rails.version < '4.1' ? :text : :plain
+        checks = params[:checks] || 'standard'
+        begin
+          errors = HealthCheck::Utils.process_checks(checks)
+        rescue Exception => e
+          errors = e.message.blank? ? e.class.to_s : e.message.to_s
+        end     
+        response.headers['Cache-control'] = 'private, no-cache, must-revalidate' + (max_age > 0 ? ", max-age=#{max_age}" : '')
+        if errors.blank?
+          obj = { :healthy => true, :message => HealthCheck.success }
+          respond_to do |format|
+            format.html { render plain_key => HealthCheck.success, :content_type => 'text/plain' }
+            format.json { render :json => obj }
+            format.xml { render :xml => obj }
+            format.any { render plain_key => HealthCheck.success, :content_type => 'text/plain' }
+          end
+        else
+          msg = "health_check failed: #{errors}"
+          obj = { :healthy => false, :message => msg }
+          respond_to do |format|
+            format.html { render plain_key => msg, :status => HealthCheck.http_status_for_error_text, :content_type => 'text/plain'  }
+            format.json { render :json => obj, :status => HealthCheck.http_status_for_error_object}
+            format.xml { render :xml => obj, :status => HealthCheck.http_status_for_error_object }
+            format.any { render plain_key => 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
+            logger.info msg
+          end
         end
       end
     end
@@ -41,6 +51,13 @@ module HealthCheck
 
     protected
 
+    def authenticate
+      return unless HealthCheck.basic_auth_username && HealthCheck.basic_auth_password
+      authenticate_or_request_with_http_basic do |username, password|
+        username == HealthCheck.basic_auth_username && password == HealthCheck.basic_auth_password
+      end
+    end
+
     # turn cookies for CSRF off
     def protect_against_forgery?
       false

data/lib/health_check/version.rb

@@ -1,3 +1,3 @@
 module HealthCheck
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/test/rails_4.0.gemfile

@@ -30,4 +30,4 @@ gem 'therubyrhino', :platform => :jruby # REQUIRED
 gem 'therubyracer', :platform => :ruby # REQUIRED
 # mime-types 2.0 requires Ruby version >= 1.9.2
 # mime-types 3.0 requires Ruby version >= 2.0
-gem 'mime-types', RUBY_VERSION < '1.9.2' ? '< 2.0' : (defined?(JRUBY_VERSION) || RUBY_VERSION < '2.0' ? '< 3.0' : '>= 3.0') # REQUIRED
+gem 'mime-types', RUBY_VERSION < '1.9.2' ? '< 2.0' : (defined?(JRUBY_VERSION) || RUBY_VERSION < '2.0' ? '< 3' : '>= 3.0') # REQUIRED

data/test/rails_4.1.gemfile

@@ -30,4 +30,4 @@ gem 'therubyrhino', :platform => :jruby # REQUIRED
 gem 'therubyracer', :platform => :ruby # REQUIRED
 # mime-types 2.0 requires Ruby version >= 1.9.2
 # mime-types 3.0 requires Ruby version >= 2.0
-gem 'mime-types', RUBY_VERSION < '1.9.2' ? '< 2.0' : (defined?(JRUBY_VERSION) || RUBY_VERSION < '2.0' ? '< 3.0' : '>= 3.0') # REQUIRED
+gem 'mime-types', RUBY_VERSION < '1.9.2' ? '< 2.0' : (defined?(JRUBY_VERSION) || RUBY_VERSION < '2.0' ? '< 3' : '>= 3.0') # REQUIRED

data/test/rails_4.2.gemfile

@@ -27,4 +27,4 @@ end
 
 # mime-types 2.0 requires Ruby version >= 1.9.2
 # mime-types 3.0 requires Ruby version >= 2.0
-gem 'mime-types', RUBY_VERSION < '1.9.2' ? '< 2.0' : (defined?(JRUBY_VERSION) || RUBY_VERSION < '2.0' ? '< 3.0' : '>= 3.0') # REQUIRED
+gem 'mime-types', RUBY_VERSION < '1.9.2' ? '< 2.0' : (defined?(JRUBY_VERSION) || RUBY_VERSION < '2.0' ? '< 3' : '>= 3.0') # REQUIRED

data/test/test_with_railsapp

@@ -166,6 +166,13 @@ finish()
         tail -50 $railsapp/log/test.log
     fi
 
+    if [ -s $railsapp/log/production.log ]
+    then
+        echo ========================================================
+        echo Last 50 lines of production log
+        tail -50 $railsapp/log/production.log
+    fi
+
     stop_server
     trap "" 0
     echo ========================================================
@@ -406,8 +413,17 @@ common_tests()
         echo
     fi
 
-    date > $custom_file
+    test_no=`expr 1 + $test_no`
+    if [ -z "$run_test" ] || [ $test_no == "$run_test" ]; then
+        echo "${test_no}: TESTING log files to check for deprecation warnings ..."
+        if egrep ' is deprecated|DEPRECATION WARNING' $railsapp/log/[tp][er][so][td]*.log 
+        then
+            echo Found deprecation warnings - failed test
+            exit 99
+        fi
+    fi
 
+    date > $custom_file
 }
 
 

data/test/testurl

@@ -27,7 +27,7 @@ end
 page_content = response.body
 
 puts "  response code: #{response.code} #{response.message}"
-puts "  content_type: #{response.content_type}"
+response.header.each_header {|key,value| puts "  #{key}: #{value}" }
 puts "  body: #{page_content}"
 
 if ARGV[1] and ARGV[1] != ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: health_check
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails