liveness 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb9ece76b575586d5edbabc8b95571434e680653385589ec4f986d55fc3ccc8f
-  data.tar.gz: 880fd29159c5a5ce9d0344a0a3542322fcc515445608a6f19aaf63a45af14043
+  metadata.gz: 616d00dcf3710bb5aa51435b45eade04577d463bba6e7b806c5fe9d25d072dce
+  data.tar.gz: 0d8b14684881ab3d2d2c926e152492f129d3638c3934d67ff4b8d369b6713528
 SHA512:
-  metadata.gz: bd7366f49056af9feefaf7eb74fee9b0707652378e1c41cec4f0390af5f2156a01b434e78e980ad2e5f9bdb1372fb4dd3577573f2031711a432b879026a37b06
-  data.tar.gz: 4418096a94fb37c10db94497e295e40b6038b50f51035eb79efaf3ac5bbd428bcc366b222f81e7d0ff7bc4a378de3b08793854302ebc705375276ff500f2d8dc
+  metadata.gz: fddf5127aab3a4e090ff6085f95d522629a6ec880eb2212dbf9baa22470665ac7ba7950393c8c86ebe1119cb2acc302bda512266e7b8e523c5622555a8dccf75
+  data.tar.gz: 12007e1950eaa7d91041438e9b1c25308fe3291ebd0f80e61df369a04df55637e42293df394fc73bbaaa7c2eecbdd5f1494c3de2815f26721e3c9eb1f222f233

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    liveness (0.1.0)
+    liveness (0.2.0)
       rack (>= 1.0)
 
 GEM
@@ -22,7 +22,7 @@ GEM
     parallel (1.21.0)
     parser (3.1.0.0)
       ast (~> 2.4.1)
-    rack (1.6.13)
+    rack (2.2.3)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.2.0)
@@ -67,6 +67,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   bundler-audit

data/README.md

@@ -20,12 +20,44 @@ Liveness.config do |c|
 end
 ```
 
+### Named Dependency
+
+```ruby
+Liveness.config do |c|
+  c.add :postgres, name: :primary_db, timeout: 10
+  c.add :postgres, name: :read_replica, timeout: 10
+end
+```
+
+### Customize Connector
+
+```ruby
+Liveness.config do |c|
+  c.add :redis, timeout: 10 do
+    Redis.new(url: 'redis://example:6379/15')
+  end
+end
+```
+
+### Rails Application
+
+Mount the `Liveness::Status` to `config/routes.rb`
+
+```ruby
+Rails.application.routes.draw do
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+
+  mount Liveness::Status => '/health'
+end
+```
+
 ## Dependency Providers
 
-| Name       | Descroption                                           |
+| Name       | Description                                           |
 |------------|-------------------------------------------------------|
 | `postgres` | The PostgreSQL adapter which for `ActiveRecord::Base` |
 | `mysql`    | The MySQL adapter which for `ActiveRecord::Base`      |
+| `redis`    | Test Redis via `redis-rb` gem via `#ping` method      |
 
 ## Roadmap
 
@@ -38,7 +70,8 @@ end
   * [ ] MySQL
     * [x] ActiveRecord
     * [ ] Sequel
-  * Redis
+  * [x] Redis
+  * [ ] HTTP Endpoint
 
 ## Development
 

data/lib/liveness/dependencies/redis.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Liveness
+  # :nodoc:
+  module Dependencies
+    # The PostgreSQL Provider
+    #
+    # @since 0.2.0
+    class Redis < Dependency
+      # @see [Liveness::Dependency#check!]
+      #
+      # @since 0.2.0
+      def check!
+        return false unless defined?(::Redis)
+
+        redis = connect || ::Redis.new
+        redis.ping == 'PONG'
+      rescue ::Redis::BaseError
+        false
+      end
+    end
+
+    Liveness.container.register(:redis, Redis)
+  end
+end

data/lib/liveness/dependencies.rb

@@ -7,5 +7,6 @@ module Liveness
   module Dependencies
     require_relative 'dependencies/postgresql'
     require_relative 'dependencies/mysql'
+    require_relative 'dependencies/redis'
   end
 end

data/lib/liveness/dependency.rb

@@ -14,8 +14,18 @@ module Liveness
     def initialize(name: nil, timeout: 5, &block)
       @name = name
       @timeout = timeout
+      @connector = block
+    end
 
-      instance_exec(self, &block) if defined?(yield)
+    # Return status
+    #
+    # @return [Hash]
+    #
+    # @since 0.2.0
+    def status
+      {
+        status: alive? ? 'ok' : 'failed'
+      }
     end
 
     # Check the dependency service alive
@@ -29,6 +39,8 @@ module Liveness
       rescue StandardError
         false
       end
+    rescue Timeout::Error
+      false
     end
 
     # Check the dependency service alive
@@ -39,5 +51,16 @@ module Liveness
     def check!
       raise NotImplementedError
     end
+
+    # Connect with connector
+    #
+    # @return [Object]
+    #
+    # @since 0.2.0
+    def connect
+      return unless @connector.respond_to?(:call)
+
+      instance_exec(self, &@connector)
+    end
   end
 end

data/lib/liveness/status.rb

@@ -27,7 +27,7 @@ module Liveness
     # @since 0.1.0
     def metrics
       @metrics ||= @config.dependencies.map do |dependency|
-        Thread.new { [dependency.name, dependency.alive?] }
+        Thread.new { [dependency.name, dependency.status] }
       end.map(&:value).to_h
     end
 

data/lib/liveness/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Liveness
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: liveness
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - 蒼時弦也
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -47,6 +47,7 @@ files:
 - lib/liveness/dependencies.rb
 - lib/liveness/dependencies/mysql.rb
 - lib/liveness/dependencies/postgresql.rb
+- lib/liveness/dependencies/redis.rb
 - lib/liveness/dependency.rb
 - lib/liveness/status.rb
 - lib/liveness/version.rb