healthier 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54a75f98f4a16fb6e7c63563baedcbd7dee7d05a16848488a7eb02c416f139c3
-  data.tar.gz: b2bbff5440b799ac64161c151f3633d8e534569bba013b85a3426915ac517716
+  metadata.gz: 5f347f1274991b95aa7403f00501e5fc901d48ac74c9d6d6ae44c68a5ee7bdc6
+  data.tar.gz: c8f8f1b4fca3b876d3ab3d134f14bc5e46514f45211d7df81a22b8202f3872df
 SHA512:
-  metadata.gz: 19577350a2b28642f9b654d5c4bdb14b245b0de85f29e54f2ec7812a943d545eeda0757b9e0509462cdb82d6803fe029bead9f819660ffbce985a11dc8980dcb
-  data.tar.gz: 4a7278b141c18f6523882acac1fc8255ab7e44c05d599269169b00684575b5631b97298375c3047567fef6f92ff39dd00b8269b114504cdd63b53a9dae179a92
+  metadata.gz: ce524e72bfe8aec9444c0602d7488362047d0b0bb33e674e922f8398e942a626113b4241eed3647c820b1ddba1ecedcf2e3611698d936c91c38f5399c6840b4d
+  data.tar.gz: d07d6415672d8e0c28865813d29a8ef959aace1a0491a6c439ede5c283856a0f5c25aace7cf2955184a195dc633f247dfc531d34204705a3a35aa5a26aa640e6

data/README.md

@@ -72,8 +72,8 @@ mount Healthier::Engine => '/healthier'
 ENVs for basic authentication:
 
 ```bash
-USERNAME: 'demouser'
-PASSWORD: 'demouser@2023'
+HEALTHIER_USERNAME: 'demouser'
+HEALTHIER_PASSWORD: 'demouser@2023'
 ```
 
 ENVs for Bearer token authentication:
@@ -88,9 +88,59 @@ However, if you want to leave the API open, just set:
   Healthier.auth_mechanism = :none
 ```
 
-Example Curl:
-```curl
- curl -H "Bearer b5f3396a876e4f2ec828d11514c94d95d2f2330d251496a78cbe0e9bc330d775" -H "Content-Type: application/json" 'https://migros.selise.dev/api/v2/cnc_rsp/healthier/ping'
+## Health Check Endpoints
+
+Healthier provides three distinct health check endpoints for monitoring your application:
+
+### 1. Ping Endpoint (`GET /healthier/ping`)
+Returns detailed health status of all configured services.
+
+**Response:** JSON object with service health statuses
+```json
+{
+  "postgresql": {
+    "status": "success",
+    "message": "PostgreSQL service is healthy"
+  },
+  "redis": {
+    "status": "success",
+    "message": "Redis service is healthy"
+  }
+}
+```
+
+### 2. Live Endpoint (`GET /healthier/live`)
+Basic liveness check that verifies if the application is running.
+
+**Response:** Boolean value
+```json
+true
+```
+
+### 3. Ready Endpoint (`GET /healthier/ready`)
+Readiness check that verifies if all configured services are healthy and the application is ready to serve requests.
+
+**Response:** Boolean value
+```json
+true
+```
+
+## Example Usage
+
+```bash
+# Ping - detailed service health
+curl http://localhost:3000/healthier/ping
+
+# Live - basic liveness check
+curl http://localhost:3000/healthier/live
+
+# Ready - service readiness check
+curl http://localhost:3000/healthier/ready
+```
+
+Example Curl with authentication:
+```bash
+curl -H "Bearer your_token_here" -H "Content-Type: application/json" 'http://localhost:3000/healthier/ping'
 ```
 
 ## Contributing

data/app/controllers/healthier/{checks_controller.rb → healthier_controller.rb}

@@ -2,13 +2,22 @@
 
 module Healthier
   # Controller for performing health checks
-  class ChecksController < ApplicationController
+  class HealthierController < ApplicationController
     include ActionController::HttpAuthentication::Basic::ControllerMethods
 
-    before_action :authenticate_request
+    before_action :authenticate_request, except: [:live]
 
     def ping
-      render json: Healthier::Engine.ping!
+      render json: Healthier::Doctor.ping!
+    end
+
+    # NOTE: Just return 200
+    def live
+      render json: Healthier::Doctor.up?
+    end
+
+    def ready
+      render json: Healthier::Doctor.ping!
     end
 
     protected

data/config/routes.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 Healthier::Engine.routes.draw do
-  get 'ping', to: 'checks#ping'
+  get 'ping', to: 'healthier#ping'
+  get 'live', to: 'healthier#live'
+  get 'ready', to: 'healthier#ready'
 end

data/lib/connectors/elastic_search.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Connectors
+  # ElasticSearch health checker
+  class ElasticSearch
+    def connect
+      url = ENV.fetch('ELASTICSEARCH_URL', 'http://localhost:9200')
+
+      require 'net/http'
+      require 'uri'
+      require 'json'
+
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = 2
+      http.open_timeout = 2
+
+      response = http.get('/_cluster/health')
+      if response.code.to_i == 200
+        health_data = JSON.parse(response.body)
+        health_data['status'] != 'red'
+      else
+        false
+      end
+    rescue StandardError => e
+      puts "ElasticSearch Connection Error: #{e.message}"
+      false
+    end
+
+    def self.configured? # rubocop:disable Naming/PredicateMethod
+      raise StandardError, 'Please make sure you have Elasticsearch installed' unless defined?(::Elasticsearch::Client)
+
+      'configured'
+    end
+  end
+end

data/lib/connectors/rabbitmq.rb

@@ -7,13 +7,14 @@ module Connectors
       @conn = ::Bunny.new
       @conn.start
       @channel = @conn.create_channel
-      @queue = @channel.queue('health_check')
+      @queue = @channel.queue('health_check', auto_delete: true)
       @queue.publish('ping')
       true
     rescue ::Bunny::Exception, ::Bunny::TCPConnectionFailed, ::Bunny::PossibleAuthenticationFailureError => e
       puts "RabbitMQ Connection Error: #{e.message}"
       false
     ensure
+      # Queue with auto_delete: true will be automatically deleted when connection closes.
       @queue&.delete
       @queue&.purge
       @channel&.close

data/lib/connectors/sidekiq.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Connectors
+  # Sidekiq health checker
+  class Sidekiq
+    def connect
+      ::Sidekiq.redis do |r|
+        r.ping == 'PONG'
+      end
+    rescue StandardError => e
+      puts "Sidekiq Connection Error: #{e.message}"
+      false
+    end
+
+    def self.configured?
+      raise StandardError, 'Please make sure you have Sidekiq installed' unless defined?(::Sidekiq)
+
+      'configured'
+    end
+  end
+end

data/lib/generators/healthier/config_generator.rb

@@ -32,6 +32,11 @@ module Healthier
         #      config: {}
         #    - name: 'rabbitmq'
         #      config: {}
+        #    - name: 'sidekiq'
+        #      config: {}
+        #    - name: 'elastic_search'
+        #      config: {}
+
       YAML
     end
   end

data/lib/healthier/api_authenticator.rb

@@ -17,13 +17,13 @@ module Healthier
 
     def authenticate_with_bearer_token
       controller.authenticate_with_http_token do |token, _options|
-        ENV['BEARER_TOKEN'] == token
+        ENV['HEALTHIER_BEARER_TOKEN'] == token
       end
     end
 
     def authenticate_with_basic_auth
       controller.authenticate_or_request_with_http_basic do |username, password|
-        username == ENV['USERNAME'] && password == ENV['PASSWORD']
+        username == ENV['HEALTHIER_USERNAME'] && password == ENV['HEALTHIER_PASSWORD']
       end
     end
   end

data/lib/healthier/doctor.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Healthier
+  # Health Checker Doctor
+  class Doctor
+    SUCCESS = :success
+    FAILURE = :failure
+
+    def initialize(config = nil)
+      @config = config || Healthier.depends_on['healthier'] || {}
+      @connectors = load_connectors
+    end
+
+    def self.ping!
+      new.ping
+    end
+
+    def self.up?
+      new.up?
+    end
+
+    def self.running?
+      new.running?
+    end
+
+    def up?
+      # Basic health check - just return true for now
+      # Could be extended to check basic application health
+      true
+    end
+
+    def running?
+      # Check if all configured services are running
+      ping.values.all? { |service_result| service_result[:status] == SUCCESS }
+    end
+
+    def ping
+      @config.fetch('depends_on', []).each_with_object({}) do |service_config, result|
+        result[service_config['name']] = diagnose(service_config)
+      end
+    end
+
+    private
+
+    def load_connectors
+      @config.fetch('depends_on', []).to_h do |service_config|
+        [
+          service_config['name'],
+          "::Connectors::#{service_config['name'].camelize}".constantize
+        ]
+      end
+    end
+
+    def diagnose(service_config)
+      connector_class = @connectors[service_config['name']]
+
+      return custom_diagnosis(service_config) if service_config['custom_checker']
+
+      begin
+        connector = connector_class.new
+        connection_result = connector.connect
+
+        if connection_result == true
+          {
+            status: SUCCESS,
+            message: "#{service_config['name'].camelize} service is healthy"
+          }
+        else
+          {
+            status: FAILURE,
+            message: "#{service_config['name'].camelize} service is not responding"
+          }
+        end
+      rescue StandardError => e
+        {
+          status: FAILURE,
+          message: "Diagnosis failed for #{service_config['name']}: #{e.message}"
+        }
+      end
+    end
+
+    def custom_diagnosis(service_config)
+      custom_checker = service_config['custom_checker']
+
+      if custom_checker.respond_to?(:call)
+        custom_checker.call
+      elsif custom_checker.is_a?(String)
+        connector_class = @connectors[service_config['name']]
+        connector_class.send(custom_checker)
+      else
+        {
+          status: FAILURE,
+          message: "Invalid diagnosis method for #{service_config['name']}"
+        }
+      end
+    end
+  end
+end

data/lib/healthier/engine.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'doctor'
 require_relative '../connectors/mongodb'
 require_relative '../connectors/postgresql'
 require_relative '../connectors/rabbitmq'
 require_relative '../connectors/redis'
+require_relative '../connectors/sidekiq'
+require_relative '../connectors/elastic_search'
 
 module Healthier
   # Engine
@@ -13,38 +16,13 @@ module Healthier
     initializer 'healthier.after_initialize' do
       ActiveSupport.on_load(:after_initialize) do
         dependent_services = Healthier.depends_on.dig('healthier', 'depends_on')
+        next unless dependent_services
+
         dependent_services.each do |service_conf|
-          connector = "::Connectors::#{service_conf['name'].camelize}".constantize
-          connector.configured?
+          connector_class = "::Connectors::#{service_conf['name'].camelize}".constantize
+          connector_class.configured?
         end
       end
     end
-
-    def ping!
-      conf['depends_on'].each_with_object({}) do |dependent, obj|
-        obj[dependent['name']] = ping_it(dependent['name'])
-      end
-    end
-
-    def conf
-      @conf ||= Healthier.depends_on['healthier']
-    end
-
-    def ping_it(service)
-      connector = "::Connectors::#{service.camelize}".constantize
-      connection = connector.new.connect
-
-      if connection == true
-        return {
-          status: Healthier::SUCCESS,
-          message: 'pong'
-        }
-      end
-
-      {
-        status: Healthier::FAILURE,
-        message: "#{service.camelize} service is not running. Please check your connection"
-      }
-    end
   end
 end

data/lib/healthier/version.rb

@@ -2,5 +2,5 @@
 
 module Healthier
   # MAJOR.MINOR.PATCH
-  VERSION = '0.2.3'
+  VERSION = '0.2.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: healthier
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Nima Yonten
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-17 00:00:00.000000000 Z
+date: 2025-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,9 +24,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-description: Description of Healthier.
+description: Healthier provides comprehensive health check endpoints (live, ready,
+  ping) for Rails applications with support for monitoring multiple backing services
+  including PostgreSQL, MongoDB, Redis, RabbitMQ, Sidekiq, and ElasticSearch. It includes
+  built-in authentication and flexible configuration options.
 email:
-- nima.yonten1729@gmail.com
+- bugloper@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -35,15 +38,18 @@ files:
 - README.md
 - Rakefile
 - app/controllers/healthier/application_controller.rb
-- app/controllers/healthier/checks_controller.rb
+- app/controllers/healthier/healthier_controller.rb
 - config/routes.rb
+- lib/connectors/elastic_search.rb
 - lib/connectors/mongodb.rb
 - lib/connectors/postgresql.rb
 - lib/connectors/rabbitmq.rb
 - lib/connectors/redis.rb
+- lib/connectors/sidekiq.rb
 - lib/generators/healthier/config_generator.rb
 - lib/healthier.rb
 - lib/healthier/api_authenticator.rb
+- lib/healthier/doctor.rb
 - lib/healthier/engine.rb
 - lib/healthier/version.rb
 - lib/tasks/healthier_tasks.rake
@@ -55,8 +61,8 @@ metadata:
   homepage_uri: https://github.com/SELISEdigitalplatforms/healthier
   source_code_uri: https://github.com/SELISEdigitalplatforms/healthier
   changelog_uri: https://github.com/SELISEdigitalplatforms/healthier
-  rubygems_mfa_required: 'true'
-post_install_message: 
+  rubygems_mfa_required: 'false'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,8 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
-summary: Summary of Healthier.
+summary: Healthier is a gem that provides a health check endpoint for your Rails application.
 test_files: []