rack-ecg 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7bd8eb96d04ad56746e1b5a29c1bf994706a4fe1
-  data.tar.gz: c64c43e74caa9020f24fab71f72a328cb3a194c6
+SHA256:
+  metadata.gz: daea3d8ff855b734db9fc65f7ed6859114f1a89e095d06f7c26f907d011b65e9
+  data.tar.gz: b311a75d0c8555c21e9db5633bbbf3dc7304fd8dc42497dfeb9957edeb1f9233
 SHA512:
-  metadata.gz: fc8fc08610d5e269889dc0d5f6717be7b468298f7469f2fa01754be67988aa242bbd0dd5b78ae9f5003d4c096800c2444a6e1d9eadd325a05d9fe71450f9af75
-  data.tar.gz: e173e7a8cf827fe3dd3d747afd8cb9d2440e64ec67d44fada6aaf9bf330e08953f78b69eb945fb4d30dba2fffedf98ad675d621423f0ae89f0f98ac7463b6d4e
+  metadata.gz: 2cd8743e07657aaaf35ff83fde2d38d3ba836b0b2a2b439260f0547c6ce173d065e9812f46d1915811fc6bf41eb2ec2c30285d492639f5d75970167d36078b8e
+  data.tar.gz: f52644422ecd24cf6e072b4ddd5bd8edcc1de2a8653f65d2d0e230f9bea91fd5dfe18a1b96a035aa86aec61a125440d4a94125fc0b7c9a33c0e2665231ec4bd6

data/.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+    runs-on: ubuntu-latest
+    name: Test (Ruby ${{ matrix.ruby }})
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.1
+        bundle install
+        bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,21 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/rack-ecg.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.5.8

data/.yardopts

@@ -0,0 +1 @@
+--files lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,69 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2020-12-16
+
+### Added
+
+- YARD-based gem documentation
+
+### Changed
+
+- **Breaking**: The Rack::ECG initializer now uses named options, instead of an options hash.
+
+  If you manually initialized an instance, you may need to use the `**` operator to pass these options. (e.g. `Rack::ECG.new(nil, **options)`)
+
+### Removed
+
+- **Breaking:** Dropped support for Ruby versions < 2.5.0
+
+## [0.0.5] - 2017-05-12
+
+### Added
+
+- A new `sequel` check (#8), which checks if the Sequel database connection is active.
+
+## [0.0.4] - 2017-05-04
+
+### Added
+
+- A new `active_record` check (#7), which checks if the ActiveRecord connection is active.
+- A new `redis` check (#7), which checks if the Redis connection is active.
+
+## [0.0.3] - 2017-02-13
+
+### Added
+
+- Accept a `hook` in configuration, which is run when all check results have been gathered (#6)
+
+### Fixed
+
+- Resolved an issue with the migration version check and MySQL connections (#3)
+
+## [0.0.2] - 2015-06-17
+
+### Added
+
+- Support running Rack::ECG as a standalone application
+- Support adding checks via the `CheckRegistry`
+
+## [0.0.1] - 2015-04-09
+
+### Added
+
+- Base middleware to use in Rails or Rack apps
+- `git_revision` check to return the current git revision
+- `migration_version` check to return the current ActiveRecord migration version
+
+[Unreleased]: https://github.com/envato/rack-ecg/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/envato/rack-ecg/compare/v0.0.5...v0.1.0
+[0.0.5]:      https://github.com/envato/rack-ecg/compare/v0.0.4...v0.0.5
+[0.0.4]:      https://github.com/envato/rack-ecg/compare/v0.0.3...v0.0.4
+[0.0.3]:      https://github.com/envato/rack-ecg/compare/v0.0.2...v0.0.3
+[0.0.2]:      https://github.com/envato/rack-ecg/compare/v0.0.1...v0.0.2
+[0.0.1]:      https://github.com/envato/rack-ecg/releases/tag/v0.0.1
+

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rack-ecg.gemspec

data/README.md

@@ -1,21 +1,23 @@
 # Rack::ECG
 
-An easy to configure Rack middleware for Ruby web apps to provide a simple
-health check endpoint that tells you vital life signs about your app. All
-without the boilerplate service checking code you've written 10 times before.
+[![Gem version](https://img.shields.io/gem/v/rack-ecg)][gem-page] [![Rubydoc](https://img.shields.io/badge/docs-rubydoc-success)][rubydoc]
 
-(it's ECG as in electrocardiogram - as in the machine that monitors how your
-heart works)
+Rack middleware for Ruby web apps, providing a simple and extensible health
+check endpoint, with minimal configuration.
+
+> Electrocardiogram (ECG): A recording of the electrical activity of the heart.
 
 ## Features
-- simple 1 line to drop into your `config.ru` or `config/application.rb` file to
-  set up
+
+- Start with a single line in your `config.ru` or `config/application.rb` file.
 - reports git revision status
 - reports ActiveRecord migration schema version
 - reports errors if any check can't be executed for whatever reason
 - JSON output
 
-## Development Status [![travis ci build](https://api.travis-ci.org/envato/rack-ecg.svg)](https://travis-ci.org/envato/rack-ecg)
+## Development Status
+
+[![Build Status](https://github.com/envato/rack-ecg/workflows/build/badge.svg?branch=main)](https://github.com/envato/rack-ecg/actions)
 
 `Rack::ECG` is extracted from production code in use at
 [Envato](http://envato.com). However, it is undergoing early development, and
@@ -23,23 +25,15 @@ APIs and features are almost certain to be in flux.
 
 ## Getting Started
 
-Add this line to your application's Gemfile:
+Add this to your application's `Gemfile`:
 
 ```ruby
-gem 'rack-ecg'
+gem 'rack-ecg', '~> 0.0.5`
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+Then run `bundle install`.
 
-    $ gem install rack-ecg
-
-### Rails
-
-In Rails you can add `Rack::ECG` to your `config/application.rb` as a middleware
+In Rails you can add `Rack::ECG` to your `config/application.rb` as a middleware:
 
 ```ruby
 # config/application.rb
@@ -48,9 +42,7 @@ config.middleware.use Rack::ECG
 # ...
 ```
 
-### Rack
-
-In Rack apps, you can add `Rack::ECG` to your `config.ru`
+In Rack apps, you can add `Rack::ECG` to your `config.ru`:
 
 ```ruby
 # config.ru
@@ -61,6 +53,8 @@ use Rack::ECG
 run MyRackApp
 ```
 
+## Usage
+
 You can now hit your app and get a basic health check response from `Rack::ECG`
 
 ```
@@ -185,11 +179,23 @@ a different path by setting the `at` option. e.g.
 use Rack::ECG, at: "/health_check"
 ```
 
-More examples are provided in [/examples](https://github.com/envato/rack-ecg/tree/master/examples)
+### `hook`
+
+The `hook` option takes a `Proc` or equivalent, and calls it after the checks
+have run, but before the response is complete.
+
+```ruby
+use Rack::ECG, hook: Proc.new { |success, _checks| puts "Is healthy? #{success}" }
+```
+
+- `success`: whether the response will indicate success
+- `checks`: an array of the check names and values
+
+More examples are provided in [/examples](https://github.com/envato/rack-ecg/tree/main/examples)
 
 ## Requirements
-- Ruby >= 1.9.3 (this may be increased to Ruby >= 2.0 if it makes sense to use
-  Ruby 2.0 features)
+
+- Ruby >= 2.5
 - Rack
 - To use optional `git_revision` check, your deployed code needs to be in a git repo, and
 `git` command must be accessible on the server
@@ -205,24 +211,24 @@ migrations stored in `schema_versions` table
 
 ## Maintainers
 
-- [Tao Guo](https://github.com/taoza)
-- [Warren Seen](https://github.com/warrenseen)
+- [Liam Dawson](https://github.com/liamdawson)
 
-## Authors
+## Contributors
 
+- [Tao Guo](https://github.com/taoza)
 - [Julian Doherty](https://github.com/madlep)
 - [Warren Seen](https://github.com/warrenseen)
 
 ## License
 
 `Rack::ECG` uses MIT license. See
-[`LICENSE.txt`](https://github.com/envato/rack-ecg/blob/master/LICENSE.txt) for
+[`LICENSE.txt`](https://github.com/envato/rack-ecg/blob/main/LICENSE.txt) for
 details.
 
 ## Code of conduct
 
 We welcome contribution from everyone. Read more about it in
-[`CODE_OF_CONDUCT.md`](https://github.com/envato/rack-ecg/blob/master/CODE_OF_CONDUCT.md)
+[`CODE_OF_CONDUCT.md`](https://github.com/envato/rack-ecg/blob/main/CODE_OF_CONDUCT.md)
 
 ## Contributing
 
@@ -248,3 +254,5 @@ Encouraging the use and creation of open source software is one of the ways we s
   [envato]: https://envato.com?utm_source=github
   [oss]: http://opensource.envato.com//?utm_source=github
   [careers]: http://careers.envato.com/?utm_source=github
+  [gem-page]: https://rubygems.org/gems/rack-ecg
+  [rubydoc]: https://www.rubydoc.info/gems/rack-ecg/

data/Rakefile

@@ -1,7 +1,16 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
 
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+YARD::Rake::YardocTask.new
 
-task :default => :spec
+task(default: [:rubocop, :spec, :yard])
+
+task(:watch_docs) do
+  sh "yard server --reload"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rack-ecg"
+
+# 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/examples/basic.ru

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 require 'rack/ecg'
 
-use Rack::ECG
+use(Rack::ECG)
 
-run -> (env) { [200, {}, ["Hello, World"]] }
+run(-> (_env) { [200, {}, ["Hello, World"]] })

data/examples/checks.ru

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 require 'rack/ecg'
 
-use Rack::ECG, checks: [:git_revision, :migration_version]
+use(Rack::ECG, checks: [:git_revision, :migration_version])
 
-run -> (env) { [200, {}, ["Hello, World"]] }
+run(-> (_env) { [200, {}, ["Hello, World"]] })

data/examples/hook.ru

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rack/ecg'
+
+log_check_results = proc do |success, checks|
+  next if success
+
+  checks.each do |check_name, check_status|
+    next unless check_status[:status] == 'error'
+
+    puts "Check #{check_name} failed: #{check_status[:value]}"
+  end
+end
+
+use(Rack::ECG, checks: [:git_revision, :migration_version], hook: log_check_results)
+
+run(->(_env) { [200, {}, ['Hello, World']] })

data/examples/mounted_path.ru

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 require 'rack/ecg'
 
-use Rack::ECG, at: "/health_check"
+use(Rack::ECG, at: "/health_check")
 
-run -> (env) { [200, {}, ["Hello, World"]] }
+run(-> (_env) { [200, {}, ["Hello, World"]] })

data/examples/parameters.ru

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
 require 'rack/ecg'
 require 'sequel'
 require 'sqlite3'
 
-use Rack::ECG, checks: [
+use(Rack::ECG, checks: [
   :http,
-  [:sequel, {connection: 'sqlite://events.db', name: 'events'}],
-  [:sequel, {connection: 'sqlite://projections.db', name: 'projections'}]
-]
+  [:sequel, { connection: 'sqlite://events.db', name: 'events' }],
+  [:sequel, { connection: 'sqlite://projections.db', name: 'projections' }],
+])
 
-run -> (env) { [200, {}, ["Hello, World"]] }
+run(-> (_env) { [200, {}, ["Hello, World"]] })

data/examples/stand_alone.ru

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rack/ecg'
 
-run Rack::ECG.new
+run(Rack::ECG.new)

data/lib/rack-ecg.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'rack/ecg'

data/lib/rack/ecg.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rack/ecg/version"
 require "json"
 require "open3"
@@ -5,34 +6,47 @@ require "rack/ecg/check_factory"
 
 module Rack
   class ECG
+    # Default mount path.
     DEFAULT_MOUNT_AT = "/_ecg"
-    DEFAULT_CHECKS = [ :http ]
-
-    def initialize(app=nil, options={})
+    # Checks enabled by default.
+    DEFAULT_CHECKS = [:http]
+
+    # Constructs an instance of ECG Rack middleware with the specified
+    # options.
+    #
+    # @param app [Object,nil] Underlying Rack application to receive unmatched
+    #   requests. If unset, any unmatched requests will return a 404.
+    # @param checks [Array<Symbol, Array<Symbol, Object>>] Sets and
+    #   configures the checks run by this instance.
+    # @param at [String, nil] Path which this ECG instance handles.
+    # @param hook [#call, nil] Callable which receives the success status and
+    #   check results
+    def initialize(app = nil, checks: DEFAULT_CHECKS, at: DEFAULT_MOUNT_AT, hook: nil)
       @app = app
 
-      check_configuration = options.delete(:checks) || []
+      check_configuration = checks || []
       @check_factory = CheckFactory.new(check_configuration, DEFAULT_CHECKS)
-      @at = options.delete(:at) || DEFAULT_MOUNT_AT
+      @mount_at = at || DEFAULT_MOUNT_AT
 
-      @hook = options.delete(:hook)
+      @result_hook = hook
     end
 
+    # Rack compatible call method. Not intended for direct usage.
     def call(env)
-      if env["PATH_INFO"] == @at
+      if env["PATH_INFO"] == @mount_at
         check_results = @check_factory.build_all.inject({}) do |results, check|
-          results.merge(check.result.to_json)
+          results.merge(check.result.as_json)
         end
 
         success = check_results.none? { |check| check[1][:status] == Check::Status::ERROR }
 
         response_status = success ? 200 : 500
 
-        @hook.call(success, check_results) if @hook
+        @result_hook&.call(success, check_results)
 
         response_headers = {
-          "X-Rack-ECG-Version"  => Rack::ECG::VERSION,
-          "Content-Type"        => "application/json"
+          "X-Rack-ECG-Version" => Rack::ECG::VERSION,
+          "Content-Type" => "application/json",
         }
 
         response_body = JSON.pretty_generate(check_results)
@@ -41,7 +55,7 @@ module Rack
       elsif @app
         @app.call(env)
       else
-        [404, {},[]]
+        [404, {}, []]
       end
     end
   end