healthy_rack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71fceaea319b30fb1a666c4fec1b2fb09cef701e2ed5aba1498747c9a72c6889
+  data.tar.gz: 5a4283544f58159dbc7295d39ff76637dcc5805b2223b7d66b8ee52e647577e0
+SHA512:
+  metadata.gz: 83bc126ecc8717a498cf1e4cf960a271d8b798ef15cea196c7701551348ccb0248b378d227dd09c332737600a12692f6ffeb8f269e638d8ca9ddd2f1e88ba07f
+  data.tar.gz: 1e75b8d0133c2e8a174cae13a672e5df5fd09e7622f482ad66d311acf7806c3fddc3e94b72a98b3ab0c851f79c7e1e05f12906ddcc00d854e6492c0b917487b9

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+*.gem
+
+# MacOS
+.DS_Store
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: single_quotes
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*_spec.rb'
+    - '*.gemspec'

data/.ruby-version

@@ -0,0 +1 @@
+ 2.5.0

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: required
+
+language: ruby
+
+services:
+  - docker
+
+before_install:
+  docker build -t healthy_rack .
+
+script:
+  - docker run healthy_rack:latest bundle exec rake

data/Dockerfile

@@ -0,0 +1,4 @@
+FROM ruby:2.5.0
+WORKDIR /healthy_rack
+COPY . ./
+RUN bundle install

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in healthy_rack.gemspec
+gemspec

data/README.md

@@ -0,0 +1,68 @@
+# HealthyRack
+
+A simple Rack middleware/application for checking health state.
+
+### Disclaimer
+
+This gem was made to fulfill personal needs and for fun. Hasn't been tested in production (yet?).
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'healthy_rack'
+```
+
+### Configuration
+
+*HealthyRack* comes with several built in checks available:
+
+```ruby
+HealthyRack::Checks::Redis
+HealthyRack::Checks::ActiveRecord
+HealthyRack::Checks::Sequel
+HealthyRack::Checks::Sidekiq
+```
+
+By default all of them are disabled.
+
+Also you can easily add custom check. Just provide a subclass of `HealthyRack::Check` or any object with similar interface.
+
+**Example configuration:**
+
+```ruby
+HealthyRack.configure do |config|
+  config.add_checks(
+    HealthyRack::Checks::ActiveRecord.new,
+    HealthyRack::Checks::Redis.new('redis://redis:7379/0')
+  )
+end
+```
+
+### Usage as middleware
+
+Just add `HealthyRack.middleware` to middleware stack of your rack application:
+
+```ruby
+use HealthyRack.middleware, path: '/health'
+```
+
+where `/health` is desired path.
+
+### Mounting as rack application
+
+Mount`HealthyRack.app` at your router:
+
+```ruby
+Rack::URLMap.new('/health' => HealthyRack.app)
+```
+
+### Similar projects
+You may be interested in other projects such as:
+
+* [Pinglish](https://github.com/jbarnette/pinglish)
+* [OK Computer](https://github.com/sportngin/okcomputer)
+* [Healthcheck](https://github.com/packethost/healthcheck-rb)
+
+Thanks for their authors for the inspiration :)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'healthy_rack'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

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/healthy_rack.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'healthy_rack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'healthy_rack'
+  spec.version       = HealthyRack::VERSION
+  spec.authors       = ['Konstantin Nizhegorodov']
+  spec.email         = ['k.nizhegorodov@gmail.com']
+
+  spec.summary       = 'Rack middleware for checking health status.'
+  spec.description   = "Checks that application's database, sidekiq etc are responding."
+  spec.homepage      = 'https://github.com/konstantinn/healthy_rack'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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 = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
+  spec.add_development_dependency 'rack-test', '~> 0.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.53'
+end

data/lib/healthy_rack/app.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module HealthyRack
+  class App
+    HEADERS = {
+      'Content-Type' => 'application/json; charset=UTF-8'
+    }.freeze
+
+    class << self
+      def call(_env)
+        failed_checks = HealthyRack.config.checks.reject(&:call)
+        if failed_checks.any?
+          [500, HEADERS.dup, [error_response_body(failed_checks)]]
+        else
+          [200, HEADERS.dup, [successful_response_body]]
+        end
+      end
+
+      private
+
+      def successful_response_body
+        JSON.generate(healthy: true)
+      end
+
+      def error_response_body(failed_checks)
+        JSON.generate(
+          healthy: false,
+          failed_checks: failed_checks.map(&:name)
+        )
+      end
+    end
+  end
+end

data/lib/healthy_rack/check.rb

@@ -0,0 +1,28 @@
+require 'healthy_rack/utils'
+
+module HealthyRack
+  class Check
+    def verify; end
+
+    def name
+      class_name = self.class.name
+      raise NotImplementedError if class_name.nil? # Anonymous Classes
+
+      demodulized = Utils::String.demodulize(class_name)
+      Utils::String.underscore(demodulized)
+    end
+
+    def call
+      raise NotImplementedError
+    end
+
+    def ==(other)
+      self.class == other.class && name == other.name
+    end
+    alias eql? ==
+
+    def hash
+      name.hash
+    end
+  end
+end

data/lib/healthy_rack/checks/active_record.rb

@@ -0,0 +1,19 @@
+require 'healthy_rack/check'
+require 'healthy_rack/verify_class_definition'
+
+module HealthyRack
+  module Checks
+    class ActiveRecord < Check
+      def verify
+        VerifyClassDefinition.call('ActiveRecord')
+      end
+
+      def call
+        ::ActiveRecord::Migrator.current_version
+        true
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/healthy_rack/checks/redis.rb

@@ -0,0 +1,27 @@
+require 'healthy_rack/check'
+require 'healthy_rack/verify_class_definition'
+
+module HealthyRack
+  module Checks
+    class Redis < Check
+      def initialize(redis_url)
+        @redis_url = redis_url
+      end
+
+      def verify
+        VerifyClassDefinition.call('Redis')
+      end
+
+      def call
+        response = ::Redis.new(redis_url).ping
+        response == 'PONG'
+      rescue
+        false
+      end
+
+      private
+
+      attr_reader :redis_url
+    end
+  end
+end

data/lib/healthy_rack/checks/sequel.rb

@@ -0,0 +1,19 @@
+require 'healthy_rack/check'
+require 'healthy_rack/verify_class_definition'
+
+module HealthyRack
+  module Checks
+    class Sequel < Check
+      def verify
+        VerifyClassDefinition.call('Sequel')
+      end
+
+      def call
+        ::Sequel::Model.db.select(nil).first
+        true
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/healthy_rack/checks/sidekiq.rb

@@ -0,0 +1,19 @@
+require 'healthy_rack/check'
+require 'healthy_rack/verify_class_definition'
+
+module HealthyRack
+  module Checks
+    class Sidekiq < Check
+      def verify
+        VerifyClassDefinition.call('Sidekiq')
+      end
+
+      def call
+        ::Sidekiq.redis_info
+        true
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/healthy_rack/configuration.rb

@@ -0,0 +1,28 @@
+require 'set'
+
+module HealthyRack
+  class Configuration
+    attr_reader :checks
+
+    def initialize
+      setup
+    end
+
+    def reset
+      setup
+    end
+
+    def add_checks(*checks_to_add)
+      checks_to_add.each do |check|
+        check.verify
+        checks.add(check)
+      end
+    end
+
+    private
+
+    def setup
+      @checks = Set.new
+    end
+  end
+end

data/lib/healthy_rack/errors.rb

@@ -0,0 +1,5 @@
+module HealthyRack
+  class Errors
+    UndefinedClassError = Class.new(StandardError)
+  end
+end

data/lib/healthy_rack/middleware.rb

@@ -0,0 +1,23 @@
+require 'healthy_rack/app'
+
+module HealthyRack
+  class Middleware
+    def initialize(app, path:)
+      @app = app
+      @path = path
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      if request.path_info == path
+        App.call(env)
+      else
+        app.call(env)
+      end
+    end
+
+    private
+
+    attr_reader :app, :path
+  end
+end

data/lib/healthy_rack/utils.rb

@@ -0,0 +1,24 @@
+module HealthyRack
+  module Utils
+    # https://github.com/hanami/utils/blob/v1.1.2/lib/hanami/utils/string.rb
+    class String
+      NAMESPACE_SEPARATOR = '::'.freeze
+      UNDERSCORE_SEPARATOR = '/'.freeze
+      UNDERSCORE_DIVISION_TARGET = '\1_\2'.freeze
+
+      def self.demodulize(input)
+        ::String.new(input.to_s).split(NAMESPACE_SEPARATOR).last
+      end
+
+      def self.underscore(input)
+        string = ::String.new(input.to_s)
+        string.gsub!(NAMESPACE_SEPARATOR, UNDERSCORE_SEPARATOR)
+        string.gsub!(NAMESPACE_SEPARATOR, UNDERSCORE_SEPARATOR)
+        string.gsub!(/([A-Z\d]+)([A-Z][a-z])/, UNDERSCORE_DIVISION_TARGET)
+        string.gsub!(/([a-z\d])([A-Z])/, UNDERSCORE_DIVISION_TARGET)
+        string.gsub!(/[[:space:]]|\-/, UNDERSCORE_DIVISION_TARGET)
+        string.downcase
+      end
+    end
+  end
+end

data/lib/healthy_rack/verify_class_definition.rb

@@ -0,0 +1,10 @@
+module HealthyRack
+  class VerifyClassDefinition
+    def self.call(claz)
+      Object.const_get(claz)
+    rescue NameError
+      raise Errors::UndefinedClassError,
+            "#{claz} is not defined. Is corresponding gem installed?"
+    end
+  end
+end

data/lib/healthy_rack/version.rb

@@ -0,0 +1,3 @@
+module HealthyRack
+  VERSION = '0.1.0'.freeze
+end

data/lib/healthy_rack.rb

@@ -0,0 +1,33 @@
+require 'healthy_rack/middleware'
+require 'healthy_rack/app'
+require 'healthy_rack/configuration'
+require 'healthy_rack/errors'
+
+require 'healthy_rack/checks/active_record'
+require 'healthy_rack/checks/redis'
+require 'healthy_rack/checks/sidekiq'
+require 'healthy_rack/checks/sequel'
+
+module HealthyRack
+  class << self
+    def middleware
+      Middleware
+    end
+
+    def app
+      App
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def reset_config
+      config.reset
+    end
+
+    def configure
+      yield(config)
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: healthy_rack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Konstantin Nizhegorodov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+description: Checks that application's database, sidekiq etc are responding.
+email:
+- k.nizhegorodov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- healthy_rack.gemspec
+- lib/healthy_rack.rb
+- lib/healthy_rack/app.rb
+- lib/healthy_rack/check.rb
+- lib/healthy_rack/checks/active_record.rb
+- lib/healthy_rack/checks/redis.rb
+- lib/healthy_rack/checks/sequel.rb
+- lib/healthy_rack/checks/sidekiq.rb
+- lib/healthy_rack/configuration.rb
+- lib/healthy_rack/errors.rb
+- lib/healthy_rack/middleware.rb
+- lib/healthy_rack/utils.rb
+- lib/healthy_rack/verify_class_definition.rb
+- lib/healthy_rack/version.rb
+homepage: https://github.com/konstantinn/healthy_rack
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Rack middleware for checking health status.
+test_files: []