rack-ecg 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83d08e1fb5c31c7f5883cbf1b698b207ce837980d511f35f7d7c32300067d5c4
-  data.tar.gz: 88688776e3d95f7b040b0701d9955830bfa833c6ec44e8bcf6a1ce647a30d7a7
+  metadata.gz: d9102753e910fc1dc1008ff19d2a1d3bd23db4fdb6f0ac24f322d0750294b429
+  data.tar.gz: 189b4f010c85128da3d317b813ab829023b2db2793e1df4ce01bfbd9d6b67bfb
 SHA512:
-  metadata.gz: d5c0db20e6bf5cfab2e64252ecce8d6f38a240d6356813929a134c8b1dc7fec25cb663b756230b9b81087fef1cef05c196be31258b699181b210a0c75877651b
-  data.tar.gz: e77ddb23c3b406fb3e51621364a38be99e3ef5fdb3a0fb91fb850fa21add92415a0e1e47539619fa5c148701eb076782d3de555ef63de15ec7286e48388e983e
+  metadata.gz: 6c7698889a12a7c2263b4f70c366423691d5d4a3cd7f9d74bbb94a3e974087143f2c9906bc9cdf0e234d3dc2ece5ea840458b0f60d2f94cb250288b1a86f6073
+  data.tar.gz: 96fc9feb30b537fccf7cd377716078c9bfd6a9c33f33f1ac9d9cf1375863e6b751f48ea2670ee7c1d4b03b9ddf4be9f4d1e63be258fe7936b70824bf59b16c0b

data/.github/dependabot.yml

@@ -5,3 +5,5 @@ updates:
   schedule:
     interval: daily
     time: "19:00"
+  ignore:
+    - dependency-name: "rubocop-*"

data/.github/workflows/test.yml

@@ -6,17 +6,16 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: ["2.6", "2.7", "3.0", "3.1"]
+        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.3.7
         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.6.9
+3.2.2

data/CHANGELOG.md

@@ -1,10 +1,21 @@
 # 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
@@ -74,7 +85,8 @@ 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.2.0...HEAD
+[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

data/README.md

@@ -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.2.0`
+gem 'rack-ecg', '~> 0.3.0`
 ```
 
 Then run `bundle install`.
@@ -241,7 +241,14 @@ 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
 
@@ -252,6 +259,10 @@ More examples are provided in [/examples](https://github.com/envato/rack-ecg/tre
 - 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)
@@ -262,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,6 +1,10 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
+begin
+  require "bundler/gem_tasks"
+rescue LoadError
+  # not a significant issue
+end
 
 require "rspec/core/rake_task"
 require "rubocop/rake_task"

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

@@ -23,6 +23,6 @@ def git_revision
   { name: :git_revision, status: status, value: value }
 end
 
-use(Rack::ECG, { checks: [[:static, git_revision]] })
+use(Rack::ECG, checks: [[:static, git_revision]])
 
 run(->(_env) { [200, {}, ["Hello, World"]] })

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./static"
+require_relative "static"
 
 module Rack
   class ECG

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./static"
+require_relative "static"
 
 module Rack
   class ECG

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

@@ -3,14 +3,13 @@
 module Rack
   class ECG
     module Check
-      # @!method initialize
-      #   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
       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

data/lib/rack/ecg/check_registry.rb

@@ -30,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

@@ -3,6 +3,6 @@
 module Rack
   class ECG
     # Library version.
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/rack/ecg.rb

@@ -11,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.
@@ -22,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 || []
@@ -30,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.
@@ -41,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/rack-ecg.gemspec

@@ -30,18 +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.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_runtime_dependency("rack")
 
-  spec.add_development_dependency("bundler", "~> 2.3.7")
-  spec.add_development_dependency("pry", "~> 0.14.1")
-  spec.add_development_dependency("rack-test", "~> 1.1.0")
+  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("redcarpet", "~> 3.5.0")
-  spec.add_development_dependency("rspec", "~> 3.11.0")
-  spec.add_development_dependency("rubocop-rake", "> 0")
-  spec.add_development_dependency("rubocop-rspec", "> 0")
-  spec.add_development_dependency("rubocop-shopify", "~> 2.4.0")
-  spec.add_development_dependency("yard", "~> 0.9.24")
+  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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rack-ecg
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Envato
 - Julian Doherty
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-21 00:00:00.000000000 Z
+date: 2023-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -26,47 +26,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.7
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.7
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rackup
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,84 +87,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop-shopify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.24
+        version: 0.9.34
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.24
+        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
@@ -193,6 +165,7 @@ files:
 - 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
@@ -220,7 +193,7 @@ metadata:
   homepage_uri: https://github.com/envato/rack-ecg
   source_code_uri: https://github.com/envato/rack-ecg
   changelog_uri: https://github.com/envato/rack-ecg/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -228,15 +201,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Rack middleware serving a health check page
 test_files: []