rx-healthcheck 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebf9af8d3b43d1640503ddcba7138d1ef6c04f298faa09b39c8d93fcb0d4eb50
-  data.tar.gz: e22f89c795207f5a3a78bb6f63c362624e6b4104e3834f6ca928ecb1c6fd5b79
+  metadata.gz: 0a13e928ecfa7c5c8682acbe7a23dd10d4436eab15bde8b90814292f1a272505
+  data.tar.gz: 8bde613b1ff1c3dc35dae09301daaf08556219119f0d0e02e03e5e37addfb715
 SHA512:
-  metadata.gz: a194f56c544904474062a866aa7c91cfe6de9548b97802beaa448b4b082dab4c1fc3ffa7f41e3c0aa14b8f94c11d518e586d6984f1a82cbfaf0d2479abc9ce06
-  data.tar.gz: 1fc1ea21c9586cb3583d25ab7c8ab7177d0789ec085cc4de316dd136ebeb3c03872f30c2b54293c2efd254ea5ebae6d0255d86816488020a584e7c1b8c8b39f9
+  metadata.gz: f157a6e801558bb7155bba0d8654216c7c38a1a1259cd797a6d36dad1506b49b19998bb5078e4efa62ee0b48765caa1c69fe992ac37b8d0738455f623107a61f
+  data.tar.gz: 44f380e98847f3c5ffe00e7ee62b9e06ed2bfcfb5af86e510759f762e18955a33aa63de8eb19782d9f3645e49bd894f96953099babae9f0ef48385ad3f79bd3f

data/Gemfile

@@ -5,7 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in rx.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "rake", "~> 13.3"
 
-gem "minitest",  "~> 5.0"
-gem "simplecov", "0.21.2"
+gem "minitest",      "~> 6"
+gem "minitest-mock", "~> 5"
+gem "simplecov", "0.22"

data/Gemfile.lock

@@ -1,15 +1,18 @@
 PATH
   remote: .
   specs:
-    rx-healthcheck (0.1.8)
+    rx-healthcheck (0.1.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
     docile (1.4.0)
-    minitest (5.14.4)
-    rake (13.0.3)
-    simplecov (0.21.2)
+    minitest (6.0.1)
+      prism (~> 1.5)
+    minitest-mock (5.27.0)
+    prism (1.9.0)
+    rake (13.3.1)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
@@ -21,10 +24,11 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  minitest (~> 5.0)
-  rake (~> 13.0)
+  minitest (~> 6)
+  minitest-mock (~> 5)
+  rake (~> 13.3)
   rx-healthcheck!
-  simplecov (= 0.21.2)
+  simplecov (= 0.22)
 
 BUNDLED WITH
-   2.2.29
+   2.6.9

data/README.md

@@ -20,7 +20,7 @@ Rx provides three levels of health checks:
 
 ### Rails Applications
 
-Add `rx` to your Gemfile, and then create a new initializer with something like this:
+Add `rx-healthcheck` to your Gemfile, and then create a new initializer with something like this:
 
 ```ruby
 Rails.application.config.middleware.insert(
@@ -97,6 +97,19 @@ options: {
  }
 ```
 
+### Customizing health-check endpoints
+
+By default, Rx will mount the health checks at `/liveness`, `/readiness`, and `/deep`. You can customize these endpoints by passing a `liveness_path`, `readiness_path`, and `deep_path` options to the middleware:
+
+```ruby
+# in this example, liveness and readiness endpoints have been customized. the deep
+# endpoint will use the default path (/deep).
+Rx::Middleware.new(options: {
+  liveness_path: "/other_liveness",
+  readiness_path: "/other_readiness"
+})
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/zachpendleton/rx.

data/lib/rx/check/active_record_check.rb

@@ -13,6 +13,7 @@ module Rx
             raise StandardError.new("Undefined class ActiveRecord::Base")
           end
 
+          ActiveRecord::Base.connection.connect! unless ActiveRecord::Base.connection.active?
           ActiveRecord::Base.connection.active?
         end
       end
@@ -24,4 +25,4 @@ module Rx
       end
     end
   end
-end
+end

data/lib/rx/middleware.rb

@@ -4,7 +4,10 @@ module Rx
   class Middleware
     DEFAULT_OPTIONS = {
       cache: true,
-      authorization: nil
+      authorization: nil,
+      liveness_path: "/liveness",
+      readiness_path: "/readiness",
+      deep_path: "/deep"
     }.freeze
 
     def initialize(app,
@@ -29,12 +32,12 @@ module Rx
       end
 
       case path(env)
-      when "/liveness"
+      when @options[:liveness_path]
         ok = check_to_component(liveness_checks).map { |x| x[:status] == 200 }.all?
         liveness_response(ok)
-      when "/readiness"
+      when @options[:readiness_path]
         readiness_response(check_to_component(readiness_checks))
-      when "/deep"
+      when @options[:deep_path]
         if !Rx::Util::HealthCheckAuthorization.new(env, @options[:authorization]).ok?
           deep_response_authorization_failed
         else
@@ -68,7 +71,7 @@ module Rx
     end
 
     def health_check_request?(path)
-      %w[/liveness /readiness /deep].include?(path)
+      [@options[:liveness_path], @options[:readiness_path], @options[:deep_path]].include?(path)
     end
 
     def liveness_response(is_ok)

data/lib/rx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rx
-  VERSION = "0.1.9"
+  VERSION = "0.1.11"
 end

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rx-healthcheck
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Zach Pendleton
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: 
 email:
 - zachpendleton@gmail.com
 executables: []
@@ -47,7 +45,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/zachpendleton/rx
   source_code_uri: https://github.com/zachpendleton/rx
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -62,8 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Standard health checks for Rails and Rack applications
 test_files: []