health_bit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f324e56b8bd7bebc16987f7fc231712a41cc7068c61422deda0c5e6f50a8b6b6
+  data.tar.gz: e88622bf2101e68697127b253c0a746af19be3d9c589707afe3f3d568b26246f
+SHA512:
+  metadata.gz: 6f63e601e275aba3c441b2425c0b1ccf25377ac317b10617815632e0da4826ad069d81f85a9b7415bd7b4cf7eae760e5abfa48db6f9b43c493619a25bc899dfa
+  data.tar.gz: 15a4c2b5ed7b6f4595010fdcfede4294098db2c1032ddd8556db7bc131c01d3afd53797e7b679af729ad2eeb6ed5e520ac08342456a97fba3eb2047bf93ea526

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,139 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  AutoCorrect: false
+  Exclude:
+    - 'click_house.gemspec'
+    - 'bin/*'
+    - 'spec/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 2.7.1
+
+Bundler/OrderedGems:
+  Enabled: false
+
+# ============================== Documentation ======================
+Style/Documentation:
+  Enabled: false
+
+# ============================== Metrics ============================
+Metrics/ClassLength:
+  Max: 180
+Metrics/BlockLength:
+  Enabled: true
+Metrics/MethodLength:
+  Max: 25
+Metrics/AbcSize:
+  Max: 40
+
+# ============================== Naming =============================
+Naming/PredicateName:
+  ForbiddenPrefixes:
+    - is_
+Naming/FileName:
+  Enabled: true
+  Exclude:
+    - 'Gemfile'
+Naming/MethodParameterName:
+  Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false
+
+# ============================== Layout =============================
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+Layout/CaseIndentation:
+  EnforcedStyle: case
+  IndentOneStep: false
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+Layout/SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: space
+Layout/EmptyLines:
+  Enabled: true
+Layout/EmptyLineAfterMagicComment:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Layout/HeredocIndentation:
+  Enabled: false
+Layout/RescueEnsureAlignment:
+  Enabled: false
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Layout/LineLength:
+  Max: 140
+
+# ============================== Style ==============================
+Style/RescueModifier:
+  Enabled: true
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '[]'
+    '%i':    '[]'
+    '%w':    '[]'
+  Exclude:
+    - 'config/routes.rb'
+Style/StringLiterals:
+  Enabled: true
+Style/AsciiComments:
+  Enabled: false
+Style/Copyright:
+  Enabled: false
+Style/SafeNavigation:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method
+Style/ClassAndModuleChildren:
+  Enabled: true
+  EnforcedStyle: nested
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+Style/RescueStandardError:
+  Enabled: true
+  EnforcedStyle: explicit
+Style/InverseMethods:
+  AutoCorrect: false
+  Enabled: true
+Style/IfUnlessModifier:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false
+Style/BlockComments:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+
+# ============================== Lint ==============================
+Lint/DuplicateMethods:
+  Enabled: false
+Lint/AmbiguousOperator:
+  Enabled: false
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.7.1
+
+before_install:
+  - gem install bundler -v 2.1.4
+  - bundle install
+
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+ruby '2.7.1'
+
+# Specify your gem's dependencies in health_bit.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'pry'
+gem 'rubocop'
+gem 'rubocop-performance'

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    health_bit (0.1.0)
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  health_bit!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+
+RUBY VERSION
+   ruby 2.7.1p83
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aliaksandr Shylau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,188 @@
+[![pipeline status](https://travis-ci.com/shlima/health_bit.svg?branch=master)](https://travis-ci.com/shlima/click_house)
+
+# HealthBit
+
+![](./doc/logo.png?sanitize=true)
+
+This gem was inspired by the [health_check](https://github.com/ianheggie/health_check), but is simpler and more 
+extensible and contains up to 95% less code.
+
+Key differences:
+* is a rack application
+* can be used with rails, sinatra or any other rack application
+* can add custom checks
+* can add multiple endpoints with independent checks
+* can use any Rack middleware (http authorization, ip address check)
+
+## Toc
+
+* [Installation](#installation)
+* [Configuration](#configuration)
+* [Add Checks](#add-checks)
+* [Add a Route](#add-a-route)
+* [Password Protection](#password-protection)
+* [Database check](#database-check)
+* [Redis check](#redis-check)
+* [Rails cache check](#rails-cache-check)
+* [Elasticsearch check](#elasticsearch-check)
+* [Multiple endpoints](#multiple-endpoints)
+
+## Installation
+    
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'health_bit'
+```
+
+## Configuration
+
+```ruby
+# config/initializers/health_bit.rb
+# DEFAULT SETTINGS ARE SHOWN BELOW
+HealthBit.configure do |c|
+  c.success_text = '%<count>d checks passed 🎉'
+  c.headers = { 
+    'Content-Type' => 'text/plain', 
+    'Cache-Control' => 'private,max-age=0,must-revalidate,no-store' 
+  }
+  c.success_code = 200
+  c.fail_code = 500
+  c.show_backtrace = false
+
+  c.add('Check name') do
+    # Body check, should returns `true` 
+    true
+  end
+end
+```
+        
+## Add Checks
+
+By default, the **gem does not contain any checks**, **you should add the 
+necessary checks by yourself**. The check should return `false` or `nil` 
+to be considered unsuccessful or throw an exception, any other 
+values are considered satisfactory.
+
+Example checks:
+
+```ruby
+## Successful checks
+HealthBit.add('PostgreSQL') do
+  ApplicationRecord.connection.select_value('SELECT 1') == 1
+end
+
+HealthBit.add('Custom') do
+  true
+end
+
+## Failed checks
+HealthBit.add('Database') do
+  false
+end
+
+HealthBit.add('Docker service') do
+  raise 'not responding'
+end
+
+# The Check can be added as an object responding to a call
+class Covid19Check 
+  def self.call
+    true 
+  end
+end
+
+HealthBit.add('COVID-19 Checker', Covid19Check)
+```
+
+## Add a Route
+
+Since the gem is a rack application, you must mount it to app's 
+routes. Below is an example for the Rails.
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  mount HealthBit.rack => '/health'
+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.
+
+```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'))
+  end
+  
+  mount HealthBit.rack => '/health'
+end
+```
+
+## Database check
+
+```ruby
+HealthBit.add('Database') do
+  ApplicationRecord.connection.select_value('SELECT 1') == 1
+end
+```
+
+## Redis check
+
+```ruby
+HealthBit.add('Redis') do
+  Redis.current.ping == 'PONG' 
+end
+```
+
+## Rails cache check
+
+```ruby
+HealthBit.add('Rails cache') do
+  Rails.cache.read('1').nil?
+end
+```
+
+## Elasticsearch check
+
+```ruby
+HealthBit.add('Elasticsearch') do
+  Elasticsearch::Client.new.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.
+
+```ruby
+# config/initializers/health_bit.rb
+
+DockerCheck = HealthBit.clone
+AppCheck = HealthBit.clone
+
+DockerCheck.add('Docker Health') do
+  true
+end
+
+AppCheck.add('App Health') do
+  ApplicationRecord.connection.select_value("SELECT 't'::boolean")
+end
+```
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  mount DockerCheck.rack => '/docker'
+  mount AppCheck.rack => '/app'
+end
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'health_bit'
+require 'pry'
+
+Pry.start

data/bin/release.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+rm ./*.gem
+gem build health_bit.gemspec
+gem push health_bit-*

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/health_bit.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'lib/health_bit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'health_bit'
+  spec.version       = HealthBit::VERSION
+  spec.authors       = ['Aliaksandr Shylau']
+  spec.email         = %w[alex.shilov.by@gmail.com]
+
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/shlima/health_bit'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_dependency 'rack'
+end

data/lib/health_bit.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'rack'
+require 'health_bit/version'
+
+module HealthBit
+  DEFAULT_SUCCESS_TEXT = '%<count>d checks passed 🎉'
+  DEFAULT_HEADERS = {
+    'Content-Type' => 'text/plain',
+    'Cache-Control' => 'private,max-age=0,must-revalidate,no-store'
+  }.freeze
+  DEFAULT_SUCCESS_CODE = 200
+  DEFAULT_FAIL_CODE = 500
+
+  autoload :Check, 'health_bit/check'
+  autoload :CheckError, 'health_bit/check_error'
+
+  extend self # rubocop:disable Style/ModuleFunction
+
+  attr_writer :success_text, :success_code, :fail_code, :headers
+  attr_accessor :show_backtrace
+
+  def success_text
+    format(@success_text || DEFAULT_SUCCESS_TEXT, count: checks.length)
+  end
+
+  def success_code
+    @success_code || DEFAULT_SUCCESS_CODE
+  end
+
+  def fail_code
+    @fail_code || DEFAULT_FAIL_CODE
+  end
+
+  def headers
+    @headers || DEFAULT_HEADERS
+  end
+
+  def checks
+    @checks ||= []
+  end
+
+  def configure
+    yield(self)
+  end
+
+  # @return [self]
+  def add(name, handler = nil, &block)
+    raise ArgumentError, <<~MSG if handler && block
+      Both <handler> and <block> were passed to the <#{name}> check
+    MSG
+
+    raise ArgumentError, <<~MSG unless handler || block
+      Not <handler> or <block> were passed to the <#{name}> check
+    MSG
+
+    checks.push(Check.new(name, handler || block))
+
+    self
+  end
+
+  # @return [nil, CheckError]
+  def check
+    checks.each do |check|
+      (exception = check.call).nil? ? next : (return exception)
+    end
+
+    nil
+  end
+
+  def rack(this = self)
+    @rack ||= begin
+      format = this.show_backtrace ? CheckError::FORMAT_FULL : CheckError::FORMAT_SHORT
+
+      Rack::Builder.new do
+        run ->(_env) do
+          if (error = this.check)
+            [this.fail_code, this.headers, [error.to_s(format)]]
+          else
+            [this.success_code, this.headers, [this.success_text]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/health_bit/check.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module HealthBit
+  class Check
+    attr_reader :name, :handler
+
+    def initialize(name, handler)
+      @name = name
+      @handler = handler
+    end
+
+    # @return [nil] if its ok
+    # @return [CheckError] if not
+    def call
+      raise('') unless handler.call
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      CheckError.new(name, exception: e)
+    end
+  end
+end

data/lib/health_bit/check_error.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module HealthBit
+  class CheckError < StandardError
+    FORMAT_FULL = :full
+    FORMAT_SHORT = nil
+
+    attr_reader :name, :exception
+
+    def initialize(name, exception: nil)
+      @name = name
+      @exception = exception
+    end
+
+    # @return [String]
+    def to_s(format = nil)
+      io = StringIO.new
+      io.puts "Check <#{name}> failed"
+
+      case format
+      when FORMAT_FULL
+        describe_exception(io)
+      end
+
+      io.string
+    end
+
+    private
+
+    def describe_exception(io)
+      return if exception.nil?
+
+      io.puts exception.inspect
+      io.puts exception.backtrace.join("\n")
+    end
+  end
+end

data/lib/health_bit/version.rb

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

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: health_bit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aliaksandr Shylau
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- alex.shilov.by@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/release.sh
+- bin/setup
+- doc/logo.png
+- health_bit.gemspec
+- lib/health_bit.rb
+- lib/health_bit/check.rb
+- lib/health_bit/check_error.rb
+- lib/health_bit/version.rb
+homepage: https://github.com/shlima/health_bit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shlima/health_bit
+  source_code_uri: https://github.com/shlima/health_bit
+  changelog_uri: https://github.com/shlima/health_bit
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []