rack-ecg 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 15da50402ccd3b3dcc2efab39fcdfde5a320931f
-  data.tar.gz: b0ee8b09dd75d9f25796c70a31e7477c320c38e7
+SHA256:
+  metadata.gz: daea3d8ff855b734db9fc65f7ed6859114f1a89e095d06f7c26f907d011b65e9
+  data.tar.gz: b311a75d0c8555c21e9db5633bbbf3dc7304fd8dc42497dfeb9957edeb1f9233
 SHA512:
-  metadata.gz: 8da335a59221c75231ca7bc618748c59a2926a4a3a15326ff0246a10b19b1bcd7e2f118218f78f80adcacb65d2b4b8420f4843373805470f1fdcc77635b9a4bd
-  data.tar.gz: ba2660ec5a305e5758cee866aa0c8e466256209b82d8ad8999742b00deb739a5b8fde4cfa9a8a3153f329c2a91142273a1785e8642a84f2d58db9604ae1d4b98
+  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
+Then run `bundle install`.
 
-Or install it yourself as:
-
-    $ 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`
 
 ```
@@ -91,11 +85,13 @@ HTTP responses can be returned. There are a number of built in checks that
 - `:migration_version` - this assumes you are using ActiveRecord migrations. It
   queries the `schema_versions` table and tells you what version the database is
 at.
+- `:active_record` - this checks if an ActiveRecord connection is active.
+- `:redis` - this checks if a Redis connection is active.
 
-So using `git_revision` and `migration_version` would look like:
+So using `git_revision`, `migration_version`, `active_record`, and `redis` would look like:
 
 ```ruby
-use Rack::ECG, checks: [:git_revision, :migration_version]
+use Rack::ECG, checks: [:git_revision, :migration_version, :active_record, :redis]
 ```
 
 ```
@@ -112,6 +108,64 @@ $ curl http://localhost:9292/_ecg
   "migration_version": {
     "status": "ok",
     "value": "20150319050250"
+  },
+  "active_record": {
+    "status": "ok",
+    "value": "true"
+  },
+  "redis": {
+    "status": "ok",
+    "value": "true"
+  }
+}
+```
+
+#### Checks with parameters
+Some checks, such as the `sequel` check, require a parameter hash. In this case, you must provide the check as a tuple consisting of both the check name, and a hash of parameters:
+
+```ruby
+use Rack::ECG, checks: [:http, [:sequel, {connection: "sqlite://my-sqlite.db"}]]
+```
+
+```
+$ curl http://localhost:9292/_ecg
+{
+  "http": {
+    "status": "ok",
+    "value": "online"
+  },
+  "sequel": {
+    "status": "ok",
+    "value": "true"
+  }
+}
+```
+
+Because the `sequel` check operates on a per-connection basis, you can specify multiple Sequel databases to independently check, and provide a friendly name for disambiguation purposes:
+
+```ruby
+use Rack::ECG, checks: [
+  :http,
+  [:sequel, {connection: 'sqlite://events.db', name: 'events'}],
+  [:sequel, {connection: 'sqlite://projections.db', name: 'projections'}]
+]
+```
+
+```
+$ curl http://localhost:9292/_ecg
+
+{
+  "http": {
+    "status": "ok",
+    "value": "online"
+  },
+  "sequel_events": {
+    "status": "ok",
+    "value": "true"
+  },
+  "sequel_projections": {
+    "status": "ok",
+    "value": "true"
   }
 }
 ```
@@ -125,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
@@ -145,18 +211,24 @@ migrations stored in `schema_versions` table
 
 ## Maintainers
 
+- [Liam Dawson](https://github.com/liamdawson)
+
+## 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
 
@@ -168,4 +240,19 @@ For bug fixes, documentation changes, and small features:
 4. Push to the branch (git push origin my-new-feature)
 5. Create a new Pull Request
 
-For larger new features: Do everything as above, but first also make contact with the project maintainers to be sure your change fits with the project direction and you won't be wasting effort going in the wrong direction
+For larger new features: Do everything as above, but first also make contact with the project maintainers to be sure your change fits with the project direction and you won't be wasting effort going in the wrong direction.
+
+## About
+
+This project is maintained by the [Envato engineering team][webuild] and funded by [Envato][envato].
+
+[<img src="http://opensource.envato.com/images/envato-oss-readme-logo.png" alt="Envato logo">][envato]
+
+Encouraging the use and creation of open source software is one of the ways we serve our community. See [our other projects][oss] or [come work with us][careers] where you'll find an incredibly diverse, intelligent and capable group of people who help make our company succeed and make our workplace fun, friendly and happy.
+
+  [webuild]: http://webuild.envato.com?utm_source=github
+  [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,6 +1,6 @@
+# frozen_string_literal: true
 require 'rack/ecg'
 
-use Rack::ECG
-use Rack::Reloader
+use(Rack::ECG)
 
-run -> (env) { [200, {}, ["Hello, World"]] }
+run(-> (_env) { [200, {}, ["Hello, World"]] })

data/examples/checks.ru

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 require 'rack/ecg'
 
-use Rack::ECG, checks: [:git_revision, :migration_version]
-use Rack::Reloader
+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']] })