rails-healthcheck 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d25b4cf169226744a322cf74972627d1091753e66ba5fe6eec51f3bba7af225
-  data.tar.gz: 60fe9a9689b2c21e4cac94f5cc8baf6586720fe70bda3e2ea6cd1da2086983d4
+  metadata.gz: 5a5cf78b04593281cfd2e3018a79703e07aadc3d2a4ace5cc2d972f7ad083705
+  data.tar.gz: d0559dc632284d6f0a7f853632998973e6f2937974b1e20606a55851e1cd7c46
 SHA512:
-  metadata.gz: a73b3ae6bfe2395d17ef0867db9811e4db58cfa539c4cb9f8d97849b2555206c6b879e1cf82038175760a7a3378436c6daed1bf033df94f975548dd0da3f1fd6
-  data.tar.gz: a36bfef4ea3fca59937a309646f7bd4fc278b9571df00fa98929dd0048e63de6631afcf0264b255c3df8c8bbb1a22eade6bc8b107f1cd889c458812de91f98b4
+  metadata.gz: c9e1c73e1314bd9731e0f81f4aa45364490e64b9fbdb3339b93506337c9778a76172347af086fe7cb834f5e5740cb63df9203968554685febaaf0e65e21c1e5b
+  data.tar.gz: 453b5a2ce77392ad5b1763d3e56b386d2a078c2fc3d9f950e30b673b331f1400a4f966228141de6cb2ee7a31eef09d022d68901abe2ff1e31c024867a6a13321

data/README.md

@@ -1,20 +1,19 @@
 # [Rails::Healthcheck][gem_page]
 
 [![Gem Version][gem_version_image]][gem_version_page]
-[![Build Status][travis_status_image]][travis_page]
-[![Maintainability][code_climate_maintainability_image]][code_climate_maintainability_page]
 
 A simple way to configure a healthcheck route in Rails applications
 
 ## Table of Contents
+
 - [Getting started](#getting-started)
   - [Installation](#installation)
   - [Settings](#settings)
   - [Custom Response](#custom-response)
-  - [Verbose Errors](#verbose-errors)
+  - [Verbose](#verbose)
   - [Ignoring logs](#ignoring-logs)
     - [Lograge](#lograge)
-    - [Datadog](#lograge)
+    - [Datadog](#datadog)
   - [Requests Examples](#requests-examples)
 - [Contributing](#contributing)
 - [License](#license)
@@ -51,8 +50,8 @@ Healthcheck.configure do |config|
 
   # -- Custom Response --
   # config.custom = lambda { |controller, checker|
-  #   controller.render json: my_custom_response unless checker.errored?
-  #   ...
+  #   return controller.render(plain: 'Everything is awesome!') unless checker.errored?
+  #   controller.verbose? ? controller.verbose_error(checker) : controller.head_error
   # }
 
   # -- Checks --
@@ -83,25 +82,39 @@ 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
+### Verbose
+
+You can enable verbose responses setting `config.verbose = true`.
 
-When happen an error and verbose is enabled (`config.verbose = true`), the response will be like this:
+- On success
 
 ```json
 {
-    "code": 503,
-    "errors": [
-        {
-            "name": "migrations",
-            "exception": "ActiveRecord::PendingMigrationError",
-            "message": "Migrations are pending. To resolve this issue, run: bin/rails db:migrate RAILS_ENV=production"
-        },
-        {
-            "name": "environments",
-            "exception": "Dotenv::MissingKeys",
-            "message": "Missing required configuration key: [\"RAILS_ENV\"]"
-        }
-    ]
+  "code": 200,
+  "status": {
+    "migrations": "OK",
+    "environments": "OK"
+  }
+}
+```
+
+- On error
+
+```json
+{
+  "code": 503,
+  "errors": [
+    {
+      "name": "migrations",
+      "exception": "ActiveRecord::PendingMigrationError",
+      "message": "Migrations are pending. To resolve this issue, run: bin/rails db:migrate RAILS_ENV=production"
+    },
+    {
+      "name": "environments",
+      "exception": "Dotenv::MissingKeys",
+      "message": "Missing required configuration key: [\"RAILS_ENV\"]"
+    }
+  ]
 }
 ```
 
@@ -143,6 +156,7 @@ HTTP/1.1 200 OK
 ```
 
 - Error
+
 ```shell
 curl -i localhost:3000/healthcheck
 
@@ -150,6 +164,7 @@ HTTP/1.1 503 Service Unavailable
 ```
 
 - Error (Verbose)
+
 ```shell
 curl -i localhost:3000/healthcheck
 
@@ -177,10 +192,6 @@ Everyone interacting in the Rails::Healthcheck project’s codebases, issue trac
 [code_of_conduct_page]: https://github.com/linqueta/rails-healthcheck/blob/master/CODE_OF_CONDUCT.md
 [mit_license_page]: https://opensource.org/licenses/MIT
 [contributor_convenant_page]: http://contributor-covenant.org
-[travis_status_image]: https://travis-ci.org/linqueta/rails-healthcheck.svg?branch=master
-[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
 [gem_version_image]: https://badge.fury.io/rb/rails-healthcheck.svg
 [gem_version_page]: https://badge.fury.io/rb/rails-healthcheck
 [checker_url]: https://github.com/linqueta/rails-healthcheck/blob/master/lib/healthcheck/checker.rb

data/app/controllers/healthcheck/healthchecks_controller.rb

@@ -1,32 +1,19 @@
 # frozen_string_literal: true
 
 require 'action_controller/railtie'
+
 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
-    end
-
-    private
+      return Healthcheck.custom!(self) if Healthcheck.custom?
 
-    def head_error
-      head Healthcheck.configuration.error
-    end
-
-    def verbose_error(checker)
-      render status: Healthcheck.configuration.error,
-             json: {
-               code: Healthcheck.configuration.error,
-               errors: checker.errors.as_json
-             }
-    end
-
-    def verbose?
-      Healthcheck.configuration.verbose
+      checker = Healthcheck.check
+      response = if checker.errored?
+                   Healthcheck::Response::Error.new(self, checker)
+                 else
+                   Healthcheck::Response::Success.new(self, checker)
+                 end
+      response.execute!
     end
   end
 end

data/lib/generators/healthcheck/install_generator.rb

@@ -20,8 +20,8 @@ module Healthcheck
 
             # -- Custom Response --
             # config.custom = lambda { |controller, checker|
-            #   controller.render json: my_custom_response unless checker.errored?
-            #   ...
+            #   return controller.render(plain: 'Everything is awesome!') unless checker.errored?
+            #   controller.verbose? ? controller.verbose_error(checker) : controller.head_error
             # }
 
             # -- Checks --

data/lib/healthcheck.rb

@@ -8,6 +8,10 @@ require 'healthcheck/error'
 require 'healthcheck/router'
 require 'healthcheck/engine'
 
+require 'healthcheck/response/base'
+require 'healthcheck/response/success'
+require 'healthcheck/response/error'
+
 module Healthcheck
   CONTROLLER_ACTION = 'Healthcheck::HealthchecksController#check'
 
@@ -22,10 +26,18 @@ module Healthcheck
   end
 
   def routes(router)
-    Healthcheck::Router.mount(router)
+    Router.mount(router)
   end
 
   def check
-    Healthcheck::Checker.new.tap(&:check)
+    Checker.new.tap(&:check)
+  end
+
+  def custom!(controller)
+    configuration.custom.call(controller, check)
+  end
+
+  def custom?
+    configuration.custom
   end
 end

data/lib/healthcheck/response/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  module Response
+    class Base
+      def initialize(controller, checker)
+        @controller = controller
+        @checker = checker
+        @configuration = Healthcheck.configuration
+      end
+
+      def execute!
+        verbose? ? @controller.render(verbose) : @controller.head(status)
+      end
+
+      private
+
+      def verbose?
+        @configuration.verbose
+      end
+    end
+  end
+end

data/lib/healthcheck/response/error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  module Response
+    class Error < Base
+      def verbose
+        {
+          status: Healthcheck.configuration.error,
+          json: {
+            code: Healthcheck.configuration.error,
+            errors: @checker.errors.as_json
+          }
+        }
+      end
+
+      def status
+        @configuration.error
+      end
+    end
+  end
+end

data/lib/healthcheck/response/success.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Healthcheck
+  module Response
+    class Success < Base
+      def verbose
+        {
+          status: @configuration.success,
+          json: {
+            code: @configuration.success,
+            status: @configuration.checks.each_with_object({}) { |check, obj| obj[check.name] = 'OK' }
+          }
+        }
+      end
+
+      def status
+        @configuration.success
+      end
+    end
+  end
+end

data/lib/healthcheck/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-healthcheck
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - linqueta
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -166,6 +166,9 @@ files:
 - lib/healthcheck/configuration.rb
 - lib/healthcheck/engine.rb
 - lib/healthcheck/error.rb
+- lib/healthcheck/response/base.rb
+- lib/healthcheck/response/error.rb
+- lib/healthcheck/response/success.rb
 - lib/healthcheck/router.rb
 - lib/healthcheck/version.rb
 - lib/rails-healthcheck.rb