health_bit 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 712c992c9824246024965917be0bf884a757b163a5b4d027226fa15d090c886b
-  data.tar.gz: 3d9f192b7a93bed3dd706c8f7dddc965b446c40069b440d05353f585efac66be
+  metadata.gz: 1b89365fc234404da475087af408d01f927f8c58a0e41eadbe3d0f5bf172c551
+  data.tar.gz: 17a35b4d08227b12eb7d787843d760b01bd2d9f53d36eecb6b00d3811b689a8a
 SHA512:
-  metadata.gz: 3731cea2f52998e7b54202dbcf7f2b4cae9ad82772ba23be92bb1290ac2858dc71250b0eec4d79651cbfb6073fb223f2f443af09a4e34a33dd945d87eb36b43e
-  data.tar.gz: a59fa6db73a4888cdb3401abe2391d6ec73d44ac3a5023fd0806cf10d638e96e659a242f01de19fb7b8f9da349841613112b5e4eabe2d738ca7b837796a915f4
+  metadata.gz: 3e6441577cb24561a366b674978d501b86ae641ef40cdcccbea1054651a5aad1c3dd9d59a2f2b4cce34d3ce4f22fac8668265c87fbaa92771e9f61d1e522311f
+  data.tar.gz: 9e86554bad55338dcd40a5ca192e0aee79753936ad52935649a46980f66aac092359642cc41f53eadb5a55d8b61f6e895c181ee6206a4490266f02a3055d7620

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    health_bit (0.1.7)
+    health_bit (0.1.8)
       rack
 
 GEM

data/README.md

@@ -22,11 +22,18 @@ Key differences:
 * [Add Checks](#add-checks)
 * [Add a Route](#add-a-route)
 * [Password Protection](#password-protection)
+* [Multiple endpoints](#multiple-endpoints)
+
+## Check Examples
+
 * [Database check](#database-check)
 * [Redis check](#redis-check)
+* [Sidekiq check](#sidekiq-check)
 * [Rails cache check](#rails-cache-check)
 * [Elasticsearch check](#elasticsearch-check)
-* [Multiple endpoints](#multiple-endpoints)
+* [RabbitMQ check](#rabbitmq-check)
+* [HTTP check](#http-check)
+* [ClickHouse check](#clickhouse-check)
 
 ## Installation
     
@@ -40,8 +47,9 @@ gem 'health_bit'
 
 ```ruby
 # config/initializers/health_bit.rb
-# DEFAULT SETTINGS ARE SHOWN BELOW
+
 HealthBit.configure do |c|
+  # DEFAULT SETTINGS ARE SHOWN BELOW
   c.success_text = '%<count>d checks passed 🎉'
   c.headers = { 
     'Content-Type' => 'text/plain;charset=utf-8', 
@@ -87,9 +95,10 @@ HealthBit.add('Docker service') do
 end
 
 # The Check can be added as an object responding to a call
+# (to be able to test your check)
 class Covid19Check 
   def self.call
-    true 
+    false 
   end
 end
 
@@ -112,14 +121,14 @@ end
 ## Password Protection
 
 Since the gem is a common rack application, you can add any rack
-middleware. Below is an example with HTTP-auth for the Rails.
+middleware to it. Below is an example with HTTP-auth for the Rails.
 
 ```ruby
 # config/routes.rb
 
 Rails.application.routes.draw do
   HealthBit.rack.use Rack::Auth::Basic do |username, password|
-    ActiveSupport::SecurityUtils.secure_compare(Digest::SHA256.hexdigest(username), ::Digest::SHA256.hexdigest('user')) & ActiveSupport::SecurityUtils.secure_compare(Digest::SHA256.hexdigest(password), ::Digest::SHA256.hexdigest('password'))
+    ActiveSupport::SecurityUtils.secure_compare(Digest::SHA256.hexdigest(username), Digest::SHA256.hexdigest('user')) & ActiveSupport::SecurityUtils.secure_compare(Digest::SHA256.hexdigest(password), Digest::SHA256.hexdigest('password'))
   end
   
   mount HealthBit.rack => '/health'
@@ -138,7 +147,15 @@ end
 
 ```ruby
 HealthBit.add('Redis') do
-  Redis.current.ping == 'PONG' 
+  Redis.current.ping == 'PONG'
+end
+```
+
+## Sidekiq check
+
+```ruby
+HealthBit.add('Sidekiq') do
+  Sidekiq.redis(&:ping) == 'PONG'
 end
 ```
 
@@ -158,11 +175,35 @@ HealthBit.add('Elasticsearch') do
 end
 ```
 
+## RabbitMQ check
+
+```ruby
+HealthBit.add('RabbitMQ') do
+  Bunny::Connection.connect(&:connection)
+end
+```
+
+## HTTP check
+
+```ruby
+HealthBit.add('HTTP check') do
+  Net::HTTP.new('www.example.com', 80).request_get('/').kind_of?(Net::HTTPSuccess)
+end
+```
+
+## ClickHouse check
+
+```ruby
+HealthBit.add('ClickHouse') do
+  ClickHouse.connection.ping
+end
+```
+
 ## Multiple endpoints
 
 Sometimes you have to add several health check endpoints. Let's say 
 you have to check the docker container health and the health 
-of your application as a whole. Below is an example for rails.
+of your application as a whole. Below is an example for the Rails.
 
 ```ruby
 # config/initializers/health_bit.rb

data/lib/health_bit.rb

@@ -83,4 +83,10 @@ module HealthBit
       end
     end
   end
+
+  def clone
+    Module.new.tap do |dolly|
+      dolly.singleton_class.include(HealthBit)
+    end
+  end
 end

data/lib/health_bit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HealthBit
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: health_bit
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Aliaksandr Shylau
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack