rails-healthcheck 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22fb393936d02fef7c715773678079e8bd55dda200a2691b09c6ef1e5bd8d16e
-  data.tar.gz: 4922a32a61ab5099aeedd14087a5b76567a34b41acec65a79b7dd7cde093ecb9
+  metadata.gz: eb62ca798614c3adf6326d3b15cac4dd404f177d1dc5ad5f491938f2e3534530
+  data.tar.gz: 531f13e1c8cf658a26e85569e3d72b47b38498a17843cc0c28722c757369d929
 SHA512:
-  metadata.gz: 3f0967885d9c1f473ba3c0aedc951430f766f76da7e74da2cdb5301801f62fd52c631a1bb2d4cac6d009a41d2c1fe15a5cc22c582b1edeb5c4543b9c83d7c445
-  data.tar.gz: 513bb01b1d0c3dc472fd96d935eeb70bd26ffec2295a001ed2737228a04d0c0b9c7753eb3737d9eba18b5352cee737dee273dc7b0e7bf309abd0244538d4190f
+  metadata.gz: 0c347e99945ed94ce23ee3c4e4c9250b12da9381aa371392ff08e8bd5d247e72179f38f1c57edb1a51008cb113e22e6029795b8c5e22d31a620f30c133085837
+  data.tar.gz: a40b7c53c042fa550507fd3d9102eaf4ffb0ec84503f538976a7463c435832d18a0be1816683b9a2157c657c100a09847572ec9864762d454074e987599bc9d4

data/README.md

@@ -3,7 +3,6 @@
 [![Gem Version][gem_version_image]][gem_version_page]
 [![Build Status][travis_status_image]][travis_page]
 [![Maintainability][code_climate_maintainability_image]][code_climate_maintainability_page]
-[![Test Coverage][code_climate_test_coverage_image]][code_climate_test_coverage_page]
 
 A simple way to configure a healthcheck route in Rails applications
 
@@ -11,6 +10,7 @@ A simple way to configure a healthcheck route in Rails applications
 - [Getting started](#getting-started)
   - [Installation](#installation)
   - [Settings](#settings)
+  - [Custom Response](#custom-response)
   - [Verbose Errors](#verbose-errors)
   - [Ignoring logs](#ignoring-logs)
     - [Lograge](#lograge)
@@ -35,7 +35,7 @@ and run the command bellow to create the initializer:
 rails generate healthcheck:install
 ```
 
-## Settings
+### Settings
 
 You can set the settings in the initializer file (_config/initializers/healthcheck.rb_):
 
@@ -49,6 +49,12 @@ Healthcheck.configure do |config|
   config.route = '/healthcheck'
   config.method = :get
 
+  # -- Custom Response --
+  # config.custom = lambda { |controller, checker|
+  #   controller.render json: my_custom_response unless checker.errored?
+  #   ...
+  # }
+
   # -- Checks --
   # config.add_check :database,     -> { ActiveRecord::Base.connection.execute('select 1') }
   # config.add_check :migrations,   -> { ActiveRecord::Migration.check_pending! }
@@ -57,6 +63,26 @@ Healthcheck.configure do |config|
 end
 ```
 
+### Custom Response
+
+You can override the configs `success`, `error` and `verbose` and write your custom behaviour for the healthcheck api using the field `custom` in the initializer:
+
+```ruby
+Healthcheck.configure do |config|
+  # ...
+
+  # -- Custom Response --
+  config.custom = lambda { |controller, checker|
+    controller.render json: { field_name: 'my custom field value' } unless checker.errored?
+    ...
+  }
+
+  # ...
+end
+```
+
+Pass a `lambda` or `proc` receiving the params `controller` and `checker` to use it correctly. To use checker, you can see the avialable methods [here][checker_url] and [how][healthcheck_controller_url] it is implemented on HealthcheckController.
+
 ### Verbose Errors
 
 When happen an error and verbose is enabled (`config.verbose = true`), the response will be like this:
@@ -114,17 +140,6 @@ Datadog::Pipeline.before_flush(filter)
 curl -i localhost:3000/healthcheck
 
 HTTP/1.1 200 OK
-X-Frame-Options: SAMEORIGIN
-X-XSS-Protection: 1; mode=block
-X-Content-Type-Options: nosniff
-X-Download-Options: noopen
-X-Permitted-Cross-Domain-Policies: none
-Referrer-Policy: strict-origin-when-cross-origin
-Content-Type: text/html
-Cache-Control: no-cache
-X-Request-Id: cbc9fdd0-8090-4927-b061-1e82bcf2e039
-X-Runtime: 0.003599
-Transfer-Encoding: chunked
 ```
 
 - Error
@@ -132,17 +147,6 @@ Transfer-Encoding: chunked
 curl -i localhost:3000/healthcheck
 
 HTTP/1.1 503 Service Unavailable
-X-Frame-Options: SAMEORIGIN
-X-XSS-Protection: 1; mode=block
-X-Content-Type-Options: nosniff
-X-Download-Options: noopen
-X-Permitted-Cross-Domain-Policies: none
-Referrer-Policy: strict-origin-when-cross-origin
-Content-Type: text/html
-Cache-Control: no-cache
-X-Request-Id: e07eb20f-7d32-4f1a-86ad-32403de2b19a
-X-Runtime: 0.033772
-Transfer-Encoding: chunked
 ```
 
 - Error (Verbose)
@@ -150,18 +154,6 @@ Transfer-Encoding: chunked
 curl -i localhost:3000/healthcheck
 
 HTTP/1.1 503 Service Unavailable
-X-Frame-Options: SAMEORIGIN
-X-XSS-Protection: 1; mode=block
-X-Content-Type-Options: nosniff
-X-Download-Options: noopen
-X-Permitted-Cross-Domain-Policies: none
-Referrer-Policy: strict-origin-when-cross-origin
-Content-Type: application/json; charset=utf-8
-Cache-Control: no-cache
-X-Request-Id: 8fa5e69a-bfe3-4bbc-875b-ce86f4269467
-X-Runtime: 0.019992
-Transfer-Encoding: chunked
-
 {"code":503,"errors":[{"name":"zero_division","exception":"ZeroDivisionError","message":"divided by 0"}]}
 ```
 
@@ -189,7 +181,7 @@ Everyone interacting in the Rails::Healthcheck project’s codebases, issue trac
 [travis_page]: https://travis-ci.org/linqueta/rails-healthcheck
 [code_climate_maintainability_image]: https://api.codeclimate.com/v1/badges/670d851a6c06f77fa36e/maintainability
 [code_climate_maintainability_page]: https://codeclimate.com/github/linqueta/rails-healthcheck/maintainability
-[code_climate_test_coverage_image]: https://api.codeclimate.com/v1/badges/670d851a6c06f77fa36e/test_coverage
-[code_climate_test_coverage_page]: https://codeclimate.com/github/linqueta/rails-healthcheck/test_coverage
 [gem_version_image]: https://badge.fury.io/rb/rails-healthcheck.svg
 [gem_version_page]: https://rubygems.org/gems/rails-healthcheck
+[checker_url]: https://github.com/linqueta/rails-healthcheck/blob/master/lib/healthcheck/checker.rb
+[healthcheck_controller_url]: https://github.com/linqueta/rails-healthcheck/blob/master/app/controllers/healthcheck/healthchecks_controller.rb

data/app/controllers/healthcheck/healthchecks_controller.rb

@@ -5,6 +5,7 @@ module Healthcheck
   class HealthchecksController < ActionController::Base
     def check
       checker = Healthcheck.check
+      return Healthcheck.configuration.custom.call(self, checker) if Healthcheck.configuration.custom
       return head Healthcheck.configuration.success unless checker.errored?
 
       verbose? ? verbose_error(checker) : head_error
@@ -13,7 +14,7 @@ module Healthcheck
     private
 
     def head_error
-      head(Healthcheck.configuration.error)
+      head Healthcheck.configuration.error
     end
 
     def verbose_error(checker)

data/lib/generators/healthcheck/install_generator.rb

@@ -18,6 +18,12 @@ module Healthcheck
             config.route = '/healthcheck'
             config.method = :get
 
+            # -- Custom Response --
+            # config.custom = lambda { |controller, checker|
+            #   controller.render json: my_custom_response unless checker.errored?
+            #   ...
+            # }
+
             # -- Checks --
             # config.add_check :database,     -> { ActiveRecord::Base.connection.execute('select 1') }
             # config.add_check :migrations,   -> { ActiveRecord::Migration.check_pending! }

data/lib/healthcheck/configuration.rb

@@ -2,7 +2,7 @@
 
 module Healthcheck
   class Configuration
-    SETTINGS = %i[success error verbose route method checks].freeze
+    SETTINGS = %i[success error verbose route method checks custom].freeze
 
     attr_accessor(*SETTINGS)
 

data/lib/healthcheck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Healthcheck
-  VERSION = '1.1.5'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-healthcheck
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - linqueta
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -98,16 +98,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +159,7 @@ homepage: https://github.com/linqueta/rails-healthcheck
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Healthcheck route for a Rails application
 test_files: []