rails-healthcheck 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90d8e05e3632eea15ad496a96cad8ab62120f22bfa1b2b9e5d0d58965fc6015b
-  data.tar.gz: baa0baa4729818b03ec644ffbfcf1f5b41741458422c6a1c4baff96cef6dca95
+  metadata.gz: 41e3825b8a1931d4740ab2a7dd883decbd5de9799bcfbc707078babd111789a8
+  data.tar.gz: fc76c416917531adfc415d8b1f67e741abfd48f3132bfcf5298b4a38b1b8fe2f
 SHA512:
-  metadata.gz: bc248fa637568e69c70389b6d74ae9d1a88608781f9b5b31488355a836cf9549aaec03e5d258cde1c61a44c0d1bb2ca61df019540b60b35276c5d2979059ff78
-  data.tar.gz: 6e23c81ce1702ddbd4ba205de93194c19384e06c7ca92ff69b1fbc964b2abf2b8af007e96b2f53d757dc77d17dad28030bff31532edc04ad2a179de4b958c258
+  metadata.gz: 1194978affdbf2c2a6340e7c3a23e28867df07431cf0cf24005fd6c42d63ef9ab5527e4871ead6f6efd2624d5af8b685fbf033568f4b1deca31e01f7247b0ddc
+  data.tar.gz: 810207678952fe7831d803afe44951fda41cd03ad84879a801a530845562e826ff66fd09d19715d354cb81f96bd35bcc9bf8db2edfdce542d957e8799505aca3

data/README.md

@@ -1,13 +1,26 @@
 # [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]
 [![Test Coverage][code_climate_test_coverage_image]][code_climate_test_coverage_page]
-[![Gem Version][gem_version_image]][gem_version_page]
 
 A simple way to configure a healthcheck route in Rails applications
 
-## Installation
+## Table of Contents
+- [Getting started](#getting-started)
+  - [Installation](#installation)
+  - [Settings](#settings)
+  - [Verbose Errors](#verbose-errors)
+  - [Ignoring logs](#ignoring-logs)
+    - [Lograge](#lograge)
+  - [Requests Examples](#requests-examples)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Getting started
+
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -15,14 +28,15 @@ Add this line to your application's Gemfile:
 gem 'rails-healthcheck'
 ```
 
-and run:
+and run the command bellow to create the initializer:
 
 ```
 rails generate healthcheck:install
 ```
 
 ## Settings
-Set the settings in the file _config/initializers/healthcheck.rb_:
+
+You can set the settings in the initializer file (_config/initializers/healthcheck.rb_):
 
 ```ruby
 # frozen_string_literal: true
@@ -35,18 +49,15 @@ Healthcheck.configure do |config|
   config.method = :get
 
   # -- Checks --
-  # Check if the db is available
   # config.add_check :database, -> { ActiveRecord::Base.connection.execute('select 1') }
-  # Check if the db is available and without pending migrations
   # config.add_check :migrations,-> { ActiveRecord::Migration.check_pending! }
-  # Check if the cache is available
   # config.add_check :cache, -> { Rails.cache.read('some_key') }
-  # Check if the application required envs are defined
   # config.add_check :environments, -> { Dotenv.require_keys('ENV_NAME', 'ANOTHER_ENV') }
 end
 ```
 
-### Verbose errors
+### Verbose Errors
+
 When happen an error and verbose is enabled (`config.verbose = true`), the response will be like this:
 
 ```json
@@ -67,10 +78,26 @@ When happen an error and verbose is enabled (`config.verbose = true`), the respo
 }
 ```
 
-### Requests
+## Ignoring logs
 
-- Success
+### Lograge
+
+If you are using [Lograge](https://github.com/roidrage/lograge) you can ignore Healthcheck logs using this code:
+
+```ruby
+# config/environments/production.rb
+
+Rails.application.configure do
+  config.lograge.enabled = true
+  config.lograge.ignore_actions = [Healthcheck::CONTROLLER_ACTION]
+end
 ```
+
+### Requests Examples
+
+- Success
+
+```shell
 curl -i localhost:3000/healthcheck
 
 HTTP/1.1 200 OK
@@ -88,7 +115,7 @@ Transfer-Encoding: chunked
 ```
 
 - Error
-```
+```shell
 curl -i localhost:3000/healthcheck
 
 HTTP/1.1 503 Service Unavailable
@@ -106,7 +133,7 @@ Transfer-Encoding: chunked
 ```
 
 - Error (Verbose)
-```
+```shell
 curl -i localhost:3000/healthcheck
 
 HTTP/1.1 503 Service Unavailable
@@ -125,21 +152,6 @@ Transfer-Encoding: chunked
 {"code":503,"errors":[{"name":"zero_division","exception":"ZeroDivisionError","message":"divided by 0"}]}
 ```
 
-## Ignoring logs
-
-### Lograge
-
-If you are using [Lograge](https://github.com/roidrage/lograge) you can ignore Healthcheck logs using this code:
-
-```ruby
-# config/environments/production.rb
-
-Rails.application.configure do
-  config.lograge.enabled = true
-  config.lograge.ignore_actions = [Healthcheck::CONTROLLER_ACTION]
-end
-```
-
 ## Contributing
 
 1. Fork it

data/lib/generators/healthcheck/install_generator.rb

@@ -5,6 +5,7 @@ require 'rails/generators/base'
 module Healthcheck
   class InstallGenerator < Rails::Generators::Base
     def create_initializer_file
+      desc 'It creates an initialize to set the healthcheck settings'
       create_file(
         'config/initializers/healthcheck.rb',
         <<~HEALTHCHECK_INITIALIZER_TEXT

data/lib/healthcheck/configuration.rb

@@ -7,7 +7,6 @@ module Healthcheck
     attr_accessor(*SETTINGS)
 
     def initialize
-      SETTINGS.each { |key, _| instance_variable_set("@#{key}", nil) }
       clear!
     end
 

data/lib/healthcheck/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-healthcheck
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - linqueta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -164,5 +164,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A simple way to configure a healthcheck route for a Rails application
+summary: Healthcheck route for a Rails application
 test_files: []