rack-ecg 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daea3d8ff855b734db9fc65f7ed6859114f1a89e095d06f7c26f907d011b65e9
-  data.tar.gz: b311a75d0c8555c21e9db5633bbbf3dc7304fd8dc42497dfeb9957edeb1f9233
+  metadata.gz: d9102753e910fc1dc1008ff19d2a1d3bd23db4fdb6f0ac24f322d0750294b429
+  data.tar.gz: 189b4f010c85128da3d317b813ab829023b2db2793e1df4ce01bfbd9d6b67bfb
 SHA512:
-  metadata.gz: 2cd8743e07657aaaf35ff83fde2d38d3ba836b0b2a2b439260f0547c6ce173d065e9812f46d1915811fc6bf41eb2ec2c30285d492639f5d75970167d36078b8e
-  data.tar.gz: f52644422ecd24cf6e072b4ddd5bd8edcc1de2a8653f65d2d0e230f9bea91fd5dfe18a1b96a035aa86aec61a125440d4a94125fc0b7c9a33c0e2665231ec4bd6
+  metadata.gz: 6c7698889a12a7c2263b4f70c366423691d5d4a3cd7f9d74bbb94a3e974087143f2c9906bc9cdf0e234d3dc2ece5ea840458b0f60d2f94cb250288b1a86f6073
+  data.tar.gz: 96fc9feb30b537fccf7cd377716078c9bfd6a9c33f33f1ac9d9cf1375863e6b751f48ea2670ee7c1d4b03b9ddf4be9f4d1e63be258fe7936b70824bf59b16c0b

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "19:00"
+  ignore:
+    - dependency-name: "rubocop-*"

data/.github/workflows/{main.yml → test.yml}

@@ -1,4 +1,4 @@
-name: Ruby
+name: test
 
 on: [push,pull_request]
 
@@ -6,17 +6,16 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.5, 2.6, 2.7]
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
     runs-on: ubuntu-latest
     name: Test (Ruby ${{ matrix.ruby }})
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - 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

@@ -13,6 +13,8 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
+  SuggestExtensions: false
+  NewCops: disable
   Exclude:
     - 'vendor/**/*'
 

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+3.2.2

data/CHANGELOG.md

@@ -1,10 +1,36 @@
 # 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.3.0] - 2023-09-08
+
+### Added
+
+- (#53) Add a configuration option for the unhealthy status code - thanks @floere!
+
+### Removed
+
+- **Breaking:** Dropped support for Ruby versions < 2.7.0
+
+## [0.2.0] - 2022-02-21
+
+### Added
+
+- The `static` check, which uses the provided check parameters to return the same result every time.
+
+### Changed
+
+- **Breaking**: The Redis check now requires being configured with an instance of the Redis client, via the named `instance` parameter
+- **Deprecated**: The `git_revision` check will be removed in rack-ecg version 1.0.0. For a suggested replacement, [see the GitRevision Check Replacement example](./examples/gitrevision_check_replacement.ru), which uses the `static` check to memoize the value.
+
+### Removed
+
+- **Breaking:** Dropped support for Ruby versions < 2.6.0
+
 ## [0.1.0] - 2020-12-16
 
 ### Added
@@ -59,11 +85,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - `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
+[Unreleased]: https://github.com/envato/rack-ecg/compare/v0.3.0...HEAD
+[0.3.0]:      https://github.com/envato/rack-ecg/compare/v0.2.0...v0.3.0
+[0.2.0]:      https://github.com/envato/rack-ecg/compare/v0.1.0...v0.2.0
+[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,5 +1,6 @@
 # frozen_string_literal: true
-source 'https://rubygems.org'
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in rack-ecg.gemspec
 gemspec

data/README.md

@@ -17,7 +17,7 @@ check endpoint, with minimal configuration.
 
 ## Development Status
 
-[![Build Status](https://github.com/envato/rack-ecg/workflows/build/badge.svg?branch=main)](https://github.com/envato/rack-ecg/actions)
+[![Build Status](https://github.com/envato/rack-ecg/workflows/test/badge.svg?branch=main)](https://github.com/envato/rack-ecg/actions?query=branch%3Amain)
 
 `Rack::ECG` is extracted from production code in use at
 [Envato](http://envato.com). However, it is undergoing early development, and
@@ -28,7 +28,7 @@ APIs and features are almost certain to be in flux.
 Add this to your application's `Gemfile`:
 
 ```ruby
-gem 'rack-ecg', '~> 0.0.5`
+gem 'rack-ecg', '~> 0.3.0`
 ```
 
 Then run `bundle install`.
@@ -73,99 +73,149 @@ status if any of the checks fail.
 
 ## Configuration
 
-There are options that can be passed to `use Rack::ECG` to customise how it
-works.
+There are options that can be passed to `use Rack::ECG` to customise how it works.
 
-### `checks`
-Out of the box `Rack::ECG` doesn't do much and just checks that
-HTTP responses can be returned. There are a number of built in checks that
-`Rack::ECG` can be told to do (more to come)
-- `:git_revision` - this assumes your code is deployed via git and exists in a
-  git repo, and that the `git` command can access it
-- `: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.
+### Checks
 
-So using `git_revision`, `migration_version`, `active_record`, and `redis` would look like:
+By default, `Rack::ECG` indicates that the service is reponsive via a `http` check. Additional checks are included in this gem, and can be enabled by passing their configuration to the `checks` parameter. To enable a check, add its name, and optionally configuration, to the `checks` array:
 
 ```ruby
-use Rack::ECG, checks: [:git_revision, :migration_version, :active_record, :redis]
+use Rack::ECG, checks: [
+  # no configuration required, or allowed
+  :http,
+  # passing configuration options
+  [:static, { name: "app", value: "my-cool-app" }],
+  # some checks can be used multiple times
+  [:static, { name: "env", value: Rails.env }],
+]
+```
+
+#### `active_record`
+
+Requires a configured ActiveRecord connection. Does not support configuration. Indicates whether the connection to the default database is currently open. On success, returns something in the following format:
+
+```json
+{
+  "active_record": {
+    "status": "ok",
+    "value": true
+  }
+}
 ```
 
+#### `error`
+
+Does not support configuration. Always returns the following:
+
+```json
+{
+  "error": {
+    "status": "error",
+    "value": "PC LOAD ERROR"
+  }
+}
 ```
-$ curl http://localhost:9292/_ecg
+
+#### `git_revision`
+
+**Deprecated**: will be removed in version 1.0.0. [See the GitRevision Check Replacement example](./examples/git_revision_check_replacement.ru), which uses the `static` check to memoize the value.
+
+Requires the `git` executable on path, and that the application's working directory is within a Git repository. Does not support configuration. On success, returns something in the following format:
+
+```json
+{
+  "git_revision": {
+    "status": "ok",
+    "value": "dc840f9d5563e6e5a8b34da29c298764e3046039"
+  }
+}
+```
+
+#### `http`
+
+Automatically included, and does not support configuration. Always returns the following:
+
+```json
 {
   "http": {
     "status": "ok",
     "value": "online"
-  },
-  "git_revision": {
-    "status": "ok",
-    "value": "fb16e2c3b88af671c42880e6977bba34d7b05ba6\n"
-  },
+  }
+}
+```
+
+#### `migration_version`
+
+Requires a configured ActiveRecord connection, and that ActiveRecord migrations are in use. Does not support configuration. Queries the `schema_versions` table on the default database to report the current migration version. On success, returns something in the following format:
+
+```json
+{
   "migration_version": {
     "status": "ok",
-    "value": "20150319050250"
-  },
-  "active_record": {
-    "status": "ok",
-    "value": "true"
-  },
+    "value": "20210506024055"
+  }
+}
+```
+
+#### `redis`
+
+Requires the Redis gem. Requires configuration, an instance of a Redis client. Indicates whether the Redis client passed in is currently connected to the Redis database. On success, returns something in the following format:
+
+```json
+{
   "redis": {
     "status": "ok",
-    "value": "true"
+    "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:
+#### `sequel`
+
+Requires the Sequel gem. Requires configuration, and can be configured multiple times. Indicates whether a (new) connection can be established to the configured Sequel database.
+
+Given the following configuration:
 
 ```ruby
-use Rack::ECG, checks: [:http, [:sequel, {connection: "sqlite://my-sqlite.db"}]]
+{
+  connection: "sqlite://events.db",
+  name: "events", # must be unique per sequel check
+}
 ```
 
-```
-$ curl http://localhost:9292/_ecg
+Returns the something in the following format on success:
+
+```json
 {
-  "http": {
-    "status": "ok",
-    "value": "online"
-  },
-  "sequel": {
+  "sequel_events": {
     "status": "ok",
-    "value": "true"
+    "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:
+#### `static`
+
+Returns the same value every time. Requires configuration, and can be configured multiple times.
+
+Given the following configuration:
 
 ```ruby
-use Rack::ECG, checks: [
-  :http,
-  [:sequel, {connection: 'sqlite://events.db', name: 'events'}],
-  [:sequel, {connection: 'sqlite://projections.db', name: 'projections'}]
-]
+{
+  name: "image_build_url",               # must be unique per static check
+  success: true,                         # default value
+  status: Rack::ECG::Check::Status::OK,  # optional, overrides `success`
+  value: ENV["IMAGE_BUILD_URL"], 
+}
 ```
 
-```
-$ curl http://localhost:9292/_ecg
+Returns the something in the following format:
 
+```json
 {
-  "http": {
+  "image_build_url": {
     "status": "ok",
-    "value": "online"
-  },
-  "sequel_events": {
-    "status": "ok",
-    "value": "true"
-  },
-  "sequel_projections": {
-    "status": "ok",
-    "value": "true"
+    "value": "https://example.com/pipelines/my-cool-app/builds/1234"
   }
 }
 ```
@@ -191,17 +241,28 @@ 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)
+### `failure_status`
+
+By default, check failures result in a HTTP status code `500` (Internal Server
+Error). You can change this code by setting the `failure_status` option. e.g.
+
+```ruby
+use Rack::ECG, checks: [:error], failure_status: 503
+```
 
 ## Requirements
 
-- Ruby >= 2.5
+- Ruby >= 2.6
 - 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
 - To use optional `migration_version` check, you must be using ActiveRecord and
 migrations stored in `schema_versions` table
 
+## Examples
+
+Some configuration examples are provided in [/examples](https://github.com/envato/rack-ecg/tree/main/examples).
+
 ## Contact
 
 - [github project](https://github.com/envato/rack-ecg)
@@ -212,6 +273,7 @@ migrations stored in `schema_versions` table
 ## Maintainers
 
 - [Liam Dawson](https://github.com/liamdawson)
+- [Andrew Davis](https://github.com/andyjdavis)
 
 ## Contributors
 

data/Rakefile

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
-require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'yard'
+begin
+  require "bundler/gem_tasks"
+rescue LoadError
+  # not a significant issue
+end
+
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)

data/docker-compose.yml

@@ -0,0 +1,18 @@
+# for running tests across different versions locally
+
+version: "3"
+services:
+  ruby30: &ruby30
+    image: ruby:3.0
+    volumes:
+      - ./:/app
+    command: bash -c 'gem update --system && cd /app && { ! [ -f Gemfile.lock ] || rm Gemfile.lock; } && bundle install && bundle exec rake'
+  ruby27:
+    <<: *ruby30
+    image: ruby:2.7
+  ruby26:
+    <<: *ruby30
+    image: ruby:2.6
+  ruby25:
+    <<: *ruby30
+    image: ruby:2.5

data/examples/basic.ru

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

data/examples/checks.ru

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

data/examples/custom_failure_status.ru

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rack/ecg"
+
+use(
+  Rack::ECG,
+  checks: [:error],
+  failure_status: 503,
+)
+
+run(->(_env) { [200, {}, ["Hello, World"]] })

data/examples/git_revision_check_replacement.ru

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rack/ecg"
+
+# This example behaves just like the deprecated GitRevision check, except that the value is memoized.
+#   i.e. "Fetching the git revision" shouldn't show up for every `GET /_ecg` request.
+#
+# Also consider writing the git revision to a file, or storing it in an environment variable, so it can found more
+# efficiently and with fewer dependencies.
+
+def git_revision
+  puts "Fetching the git revision"
+
+  _stdin, stdout, stderr, wait_thread = Open3.popen3("git rev-parse HEAD")
+
+  success = wait_thread.value.success?
+
+  status = success ? Rack::ECG::Check::Status::OK : Rack::ECG::Check::Status::ERROR
+
+  value = success ? stdout.read : stderr.read
+  value = value.strip
+
+  { name: :git_revision, status: status, value: value }
+end
+
+use(Rack::ECG, checks: [[:static, git_revision]])
+
+run(->(_env) { [200, {}, ["Hello, World"]] })

data/examples/hook.ru

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'rack/ecg'
+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'
+    next unless check_status[:status] == "error"
 
     puts "Check #{check_name} failed: #{check_status[:value]}"
   end
@@ -14,4 +14,4 @@ end
 
 use(Rack::ECG, checks: [:git_revision, :migration_version], hook: log_check_results)
 
-run(->(_env) { [200, {}, ['Hello, World']] })
+run(->(_env) { [200, {}, ["Hello, World"]] })

data/examples/mounted_path.ru

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

data/examples/parameters.ru

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
-require 'rack/ecg'
-require 'sequel'
-require 'sqlite3'
+
+require "rack/ecg"
+require "sequel"
+require "sqlite3"
 
 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,4 +1,5 @@
 # frozen_string_literal: true
-require 'rack/ecg'
+
+require "rack/ecg"
 
 run(Rack::ECG.new)

data/lib/rack/ecg/check/active_record_connection.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Rack
   class ECG
     module Check

data/lib/rack/ecg/check/error.rb

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
+
+require_relative "static"
+
 module Rack
   class ECG
     module Check
       # @!method initialize
       #   Always returns a basic error for testing purposes.
-      class Error
-        def result
-          Result.new(:error, Status::ERROR, "PC LOAD LETTER")
+      class Error < Static
+        STATIC_PARAMETERS = {
+          name: :error,
+          success: false,
+          value: "PC LOAD LETTER",
+        }.freeze
+
+        def initialize
+          super(STATIC_PARAMETERS)
         end
       end
 

data/lib/rack/ecg/check/git_revision.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
+
 module Rack
   class ECG
     module Check
+      # @deprecated This check requires the presence of the git executable, and executes it every time to determine the
+      #   current revision. Consider checking the revision at initialization time, and returning it via a {Static} check
+      #   instead.
+      #
       # @!method initialize
       #   Returns the SHA1 of the current commit, as reported by the git
       #   executable.

data/lib/rack/ecg/check/http.rb

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
+
+require_relative "static"
+
 module Rack
   class ECG
     module Check
       # @!method initialize
       #   Always returns a success.
-      class Http
-        def result
-          Result.new(:http, Status::OK, "online")
+      class Http < Static
+        STATIC_PARAMETERS = {
+          name: :http,
+          success: true,
+          value: "online",
+        }.freeze
+
+        def initialize
+          super(STATIC_PARAMETERS)
         end
       end
 

data/lib/rack/ecg/check/migration_version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Rack
   class ECG
     module Check

data/lib/rack/ecg/check/redis_connection.rb

@@ -1,19 +1,28 @@
 # frozen_string_literal: true
+
 module Rack
   class ECG
     module Check
-      # @!method initialize
-      #   Checks whether the global Redis client is currently connected to the
-      #   database.
-      #
-      #   Does not take any options.
       class RedisConnection
+        attr_reader :redis_instance
+
+        # Checks whether the given Redis client is currently connected to the
+        # database as identified by the ++instance++ option.
+        #
+        # @option parameters instance [Redis] The Redis client
+        def initialize(parameters = {})
+          @redis_instance = parameters[:instance]
+        end
+
         def result
           value = ""
           status = Status::OK
           begin
-            if defined?(::Redis)
-              value = ::Redis.current.connected?
+            if redis_instance.nil?
+              status = Status::ERROR
+              value = "Redis instance parameters not found"
+            elsif defined?(::Redis)
+              value = redis_instance.connected?
               status = value ? Status::OK : Status::ERROR
             else
               status = Status::ERROR

data/lib/rack/ecg/check/sequel_connection.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Rack
   class ECG
     module Check
@@ -41,7 +42,7 @@ module Rack
 
         def result_key
           if name
-            "sequel #{name.downcase}".gsub(/\W+/, '_')
+            "sequel #{name.downcase}".gsub(/\W+/, "_")
           else
             "sequel"
           end

data/lib/rack/ecg/check/static.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Rack
+  class ECG
+    module Check
+      class Static
+        # Always returns the provided ++value++ under the ++name++ key, with the result set by ++status++.
+        #
+        # @example Return "Hello, world!" under ++static++
+        #   use(Rack::ECG, { checks: [[:static, { value: "Hello, world!" }]] })
+        #
+        # @example Return "Paper jam in tray 2" as an error under ++printer_status++
+        #   use(Rack::ECG, {
+        #     checks: [
+        #       [
+        #         :static,
+        #         {
+        #           value: "Paper jam in tray 2",
+        #           success: false, # or status: Rack::ECG::Check::Status::ERROR
+        #           name: :printer_status,
+        #         },
+        #       ],
+        #     ],
+        #   })
+        #
+        # @option parameters value [Object] (nil) Result value
+        # @option parameters status [Status::ERROR, Status::OK, nil] (nil) Result status (takes precedence over
+        #   ++success++)
+        # @option parameters success [Boolean] (true) Whether the result is successful
+        # @option parameters name [Symbol, #to_sym] (:static) Key for the check result in the response
+        def initialize(parameters)
+          parameters ||= {}
+
+          @name = parameters.fetch(:name, :static).to_sym
+          @value = parameters.fetch(:value, nil)
+
+          @status = if parameters.key?(:status)
+            parameters[:status]
+          else
+            parameters.fetch(:success, true) ? Status::OK : Status::ERROR
+          end
+        end
+
+        def result
+          Result.new(@name, @status, @value)
+        end
+      end
+
+      CheckRegistry.instance.register(:static, Static)
+    end
+  end
+end

data/lib/rack/ecg/check.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
+
 require "rack/ecg/check_registry"
+require "rack/ecg/check/active_record_connection"
 require "rack/ecg/check/error"
 require "rack/ecg/check/git_revision"
 require "rack/ecg/check/http"
 require "rack/ecg/check/migration_version"
-require "rack/ecg/check/active_record_connection"
 require "rack/ecg/check/redis_connection"
 require "rack/ecg/check/sequel_connection"
+require "rack/ecg/check/static"
 
 module Rack
   class ECG

data/lib/rack/ecg/check_factory.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "rack/ecg/check"
 
 module Rack

data/lib/rack/ecg/check_registry.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "singleton"
 
 module Rack
@@ -29,14 +30,16 @@ module Rack
         @registry.fetch(name) { raise CheckNotRegistered, "Check '#{name}' is not registered" }
       end
 
-      # (see #lookup)
-      def self.lookup(name)
-        instance.lookup(name)
-      end
+      class << self
+        # (see #lookup)
+        def lookup(name)
+          instance.lookup(name)
+        end
 
-      # (see #register)
-      def self.register(name, check_class)
-        instance.register(name, check_class)
+        # (see #register)
+        def register(name, check_class)
+          instance.register(name, check_class)
+        end
       end
     end
   end

data/lib/rack/ecg/version.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module Rack
   class ECG
     # Library version.
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/rack/ecg.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "rack/ecg/version"
 require "json"
 require "open3"
@@ -10,6 +11,8 @@ module Rack
     DEFAULT_MOUNT_AT = "/_ecg"
     # Checks enabled by default.
     DEFAULT_CHECKS = [:http]
+    # Default failure response status.
+    DEFAULT_FAILURE_STATUS = 500
 
     # Constructs an instance of ECG Rack middleware with the specified
     # options.
@@ -21,7 +24,9 @@ module Rack
     # @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)
+    # @param failure_status [Integer] Status code to return on check failure
+    def initialize(app = nil, checks: DEFAULT_CHECKS, at: DEFAULT_MOUNT_AT, hook: nil,
+      failure_status: DEFAULT_FAILURE_STATUS)
       @app = app
 
       check_configuration = checks || []
@@ -29,6 +34,8 @@ module Rack
       @mount_at = at || DEFAULT_MOUNT_AT
 
       @result_hook = hook
+
+      @failure_response_status = failure_status
     end
 
     # Rack compatible call method. Not intended for direct usage.
@@ -40,13 +47,13 @@ module Rack
 
         success = check_results.none? { |check| check[1][:status] == Check::Status::ERROR }
 
-        response_status = success ? 200 : 500
+        response_status = success ? 200 : @failure_response_status
 
         @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)

data/lib/rack-ecg.rb

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

data/rack-ecg.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Rack::ECG::VERSION
   spec.authors       = ["Envato", "Julian Doherty"]
   spec.email         = ["julian@envato.com"]
-  spec.summary       = 'Rack middleware serving a health check page'
+  spec.summary       = "Rack middleware serving a health check page"
   spec.description   = <<-EOF
     rack-ecg allows you to serve a page that shows you facts about your deployed
     app to allow you to check that everything is running as it should: git
@@ -30,16 +30,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_runtime_dependency("rack")
 
+  spec.add_development_dependency("pry", "~> 0.14.2")
+  spec.add_development_dependency("rack-test", "~> 2.1.0")
+  spec.add_development_dependency("rackup", "~> 2.1.0")
   spec.add_development_dependency("rake", "~> 13.0")
-  spec.add_development_dependency("bundler", "~> 2.2.1")
-  spec.add_development_dependency("rspec", "~> 3.10.0")
-  spec.add_development_dependency("rack-test", "~> 1.1.0")
-  spec.add_development_dependency("pry", "~> 0.13.0")
-  spec.add_development_dependency("rubocop-shopify", "~> 1.0.0")
-  spec.add_development_dependency("yard", "~> 0.9.24")
-  spec.add_development_dependency("redcarpet", "~> 3.5.0")
+  spec.add_development_dependency("redcarpet", "~> 3.6.0")
+  spec.add_development_dependency("rspec", "~> 3.12.0")
+  spec.add_development_dependency("rubocop-shopify", "~> 2.14")
+  spec.add_development_dependency("yard", "~> 0.9.34")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-ecg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Envato
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2023-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -26,117 +26,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rackup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-shopify
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop-shopify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.24
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.24
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 0.9.34
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 0.9.34
 description: |2
       rack-ecg allows you to serve a page that shows you facts about your deployed
       app to allow you to check that everything is running as it should: git
@@ -147,7 +147,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -161,8 +162,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - examples/basic.ru
 - examples/checks.ru
+- examples/custom_failure_status.ru
+- examples/git_revision_check_replacement.ru
 - examples/hook.ru
 - examples/mounted_path.ru
 - examples/parameters.ru
@@ -177,6 +181,7 @@ files:
 - lib/rack/ecg/check/migration_version.rb
 - lib/rack/ecg/check/redis_connection.rb
 - lib/rack/ecg/check/sequel_connection.rb
+- lib/rack/ecg/check/static.rb
 - lib/rack/ecg/check_factory.rb
 - lib/rack/ecg/check_registry.rb
 - lib/rack/ecg/version.rb
@@ -196,14 +201,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.2
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Rack middleware serving a health check page