healthier 0.1.71 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aad15d777d50bce0e5ef2f620b4f34249298dc87b709b851fa06df41b3eb7152
-  data.tar.gz: 6fd08ae06b1c5e269b248776507c6fa20cbcb57502f5a7dc7004426559bb627a
+  metadata.gz: 79b6e112a7ffa5ea29b9d6d2e8448d15ffc07f435b509ca0fc1bbbb4110bd2e8
+  data.tar.gz: b6a5c3673cebc007cc71f94fd02d0a0e5fe7c1ddbd7dd664a5025cfa7e97d85e
 SHA512:
-  metadata.gz: 3f3540f1b7d0f90603e3ba7776b76873c761c11b28bfc8cfb5e3424040e34b0f9bfe3b277085a8b7ffc11eff6d5d7e896cfc57f43ce1a8d200ce9304563296d1
-  data.tar.gz: 37104cd689081b52a891c56feae0f7f6686f09afea731ad3120cc8df21dba3b8f94b57f4e49de3c411dc53f85069b415a14a54ad61e3d1d4b2cbc80bcf220b10
+  metadata.gz: 5fd0ab542308dc0fad393d1e3dd4ef0e3fe13643631f3270138c2fd22b3a438456ada91a85af844f1e19ad3c7afd89c1b4609a41826c9f85ed333e7d2765785d
+  data.tar.gz: e568f145d560f227d0423239c186b88d15540df3459fb1fff6b76830b48857c3694ed407406d1f0cc4d5dc7e3058eee1a75a4442337c74f80497c73bd0fa6d6f

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/application_controller.rb

@@ -3,6 +3,5 @@
 module Healthier
   # ApplicationController
   class ApplicationController < ActionController::Base
-    include Errors::ApiErrors
   end
 end

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/mongodb.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Connectors
+  # Mongodb health checker
+  class Mongodb
+    def connect
+      @client = Mongo::Client.new(
+        ENV.fetch('MONGO_DB_URI', nil) || ['localhost:27017']
+      )
+      @client.command(ping: 1)
+      true
+    rescue Mongo::Error::SocketError, Mongo::Error::NoServerAvailable
+      puts "Mongodb Connection Error: #{e.message}"
+      false
+    ensure
+      @client&.close
+    end
+
+    def self.configured?
+      raise StandardError, 'Please make sure you have MongoDB installed' unless defined?(::Mongo::Client)
+
+      'configured'
+    end
+  end
+end

data/lib/connectors/postgresql.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Connectors
+  # Postgres health checker
+  class Postgresql
+    def connect
+      @conn = ActiveRecord::Base.connection
+      true
+    rescue ::PG::ConnectionBad
+      puts "Postgres Connection Error: #{e.message}"
+      false
+    ensure
+      @conn&.close
+    end
+
+    def self.configured?
+      raise StandardError, 'Please make sure you have Postgres installed' unless defined?(::ActiveRecord::Base)
+
+      'configured'
+    end
+  end
+end

data/lib/connectors/rabbitmq.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Connectors
+  # Rabbitmq health checker
+  class Rabbitmq
+    def connect
+      @conn = ::Bunny.new
+      @conn.start
+      @channel = @conn.create_channel
+      @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
+      @conn&.close
+    end
+
+    def self.configured?
+      raise StandardError, 'Please make sure you have RabbitMQ installed' unless defined?(::Bunny)
+
+      'configured'
+    end
+  end
+end

data/lib/connectors/redis.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Connectors
+  # Redis health checker
+  class Redis
+    def connect
+      begin
+        @redis = ::Redis.new
+        @redis.ping == 'PONG'
+      rescue Redis::CannotConnectError
+        puts "Redis Connection Error: #{e.message}"
+        false
+      ensure
+        @redis&.close
+      end
+    end
+
+    def self.configured?
+      raise StandardError, 'Please make sure you have Redis installed' unless defined?(::Redis)
+
+      'configured'
+    end
+  end
+end

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

@@ -3,11 +3,10 @@
 module Healthier
   # Engine
   class ApiAuthenticator
-    attr_accessor :controller, :request
+    attr_accessor :controller
 
     def initialize(controller)
       @controller = controller
-      @request = controller.request
     end
 
     def authenticate
@@ -17,13 +16,14 @@ module Healthier
     end
 
     def authenticate_with_bearer_token
-      tok = request.headers['MONITORING']
-      raise StandardError, 'Invalid token' unless tok.eql?(ENV['BEARER_TOKEN'])
+      controller.authenticate_with_http_token do |token, _options|
+        ENV['HEALTHIER_BEARER_TOKEN'] == token
+      end
     end
 
     def authenticate_with_basic_auth
       controller.authenticate_or_request_with_http_basic do |username, password|
-        raise StandardError, 'Invalid credentials' unless 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,35 +1,28 @@
 # frozen_string_literal: true
 
-require_relative '../checkers/mongodb_checker'
-require_relative '../checkers/postgresql_checker'
-require_relative '../checkers/rabbitmq_checker'
-require_relative '../checkers/redis_checker'
+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
   class Engine < ::Rails::Engine
     isolate_namespace Healthier
 
-    def ping!
-      conf['depends_on'].each_with_object({}) do |dependant, obj|
-        obj[dependant['name']] = ping_it(dependant['name'])
-      end
-    end
-
-    def conf
-      @conf ||= Healthier.depends_on['healthier']
-    end
-
-    def ping_it(service)
-      checked = checker(service).check
+    initializer 'healthier.after_initialize' do
+      ActiveSupport.on_load(:after_initialize) do
+        dependent_services = Healthier.depends_on.dig('healthier', 'depends_on')
+        next unless dependent_services
 
-      return { status: Healthier::SUCCESS, message: 'pong' } if checked == true
-
-      { status: Healthier::FAILURE, message: "#{service.camelize} service is not running. Please check your connection" }
-    end
-
-    def checker(service)
-      "::Checkers::#{service.camelize}Checker".constantize
+        dependent_services.each do |service_conf|
+          connector_class = "::Connectors::#{service_conf['name'].camelize}".constantize
+          connector_class.configured?
+        end
+      end
     end
   end
 end

data/lib/healthier/version.rb

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

metadata

@@ -1,32 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: healthier
 version: !ruby/object:Gem::Version
-  version: 0.1.71
+  version: 0.2.4
 platform: ruby
 authors:
 - Nima Yonten
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2025-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !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:
-- 92887110+unimafy@users.noreply.github.com
+- bugloper@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -35,28 +38,30 @@ files:
 - README.md
 - Rakefile
 - app/controllers/healthier/application_controller.rb
-- app/controllers/healthier/checks_controller.rb
-- app/lib/errors/api_errors.rb
+- app/controllers/healthier/healthier_controller.rb
 - config/routes.rb
-- lib/checkers/mongodb_checker.rb
-- lib/checkers/postgresql_checker.rb
-- lib/checkers/rabbitmq_checker.rb
-- lib/checkers/redis_checker.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
-homepage: https://github.com/selisebt/healthier
+homepage: https://github.com/SELISEdigitalplatforms/healthier
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/selisebt/healthier
-  source_code_uri: https://github.com/selisebt/healthier
-  changelog_uri: https://github.com/selisebt/healthier
-  rubygems_mfa_required: 'true'
+  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: 'false'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -72,8 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+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: []

data/app/lib/errors/api_errors.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Errors
-  module ApiErrors
-    def self.included(base)
-      base.class_eval do
-        rescue_from StandardError, with: :bad_request
-      end
-    end
-
-    def bad_request(error)
-      render_error(:bad_request, error: { message: error.message })
-    end
-
-    def render_success(status, options = {})
-      options[:success] = true
-      render json: options, status: status
-    end
-
-    def render_error(status, options = {})
-      options[:error] = { message: I18n.t("api_errors.#{status}") } if options[:error].blank?
-      options[:success] = false
-      Rollbar.error(options[:error])
-      render json: options, status: status
-    end
-
-    def render_silent_error(status, options = {})
-      options[:error] = { message: I18n.t("api_errors.#{status}") } if options[:error].blank?
-      options[:success] = false
-      render json: options, status: status
-    end
-  end
-end

data/lib/checkers/mongodb_checker.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Checkers
-  # Mongodb health checker
-  class MongodbChecker
-    class << self
-      def check
-        raise 'Please make sure you have Mongodb installed' unless defined?(::Mongo::Client)
-
-        begin
-          @client = Mongo::Client.new(
-            ENV.fetch('MONGO_DB_URI', nil) || ['localhost:27017'],
-            max_retries: 2,
-            retry_interval: 1
-          )
-          @client.command(ping: 1)
-          true
-        rescue Mongo::Error::SocketError, Mongo::Error::NoServerAvailable
-          false
-        ensure
-          @client&.close
-        end
-      end
-    end
-  end
-end

data/lib/checkers/postgresql_checker.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Checkers
-  # Postgres health checker
-  class PostgresqlChecker
-    class << self
-      def check
-        raise 'Please make sure you have Postgres installed' unless defined?(::ActiveRecord::Base)
-
-        begin
-          # @conn = ::PG.connect(dbname: ENV['DATABASE_NAME'])
-          # @conn.exec('SELECT 1')
-          @conn = ActiveRecord::Base.connection
-          true
-        rescue ::PG::ConnectionBad
-          false
-        ensure
-          @conn&.close
-        end
-      end
-    end
-  end
-end

data/lib/checkers/rabbitmq_checker.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Checkers
-  # Rabbitmq health checker
-  class RabbitmqChecker
-    class << self
-      def check
-        raise 'Please make sure you have RabbitMQ installed' unless defined?(::Bunny)
-
-        begin
-          @conn = ::Bunny.new
-          @conn.start
-          channel = @conn.create_channel
-          queue = channel.queue('health_check')
-          queue.publish('ping')
-          true
-        rescue ::Bunny::Exception, ::Bunny::TCPConnectionFailed, ::Bunny::PossibleAuthenticationFailureError
-          false
-        ensure
-          @conn&.close
-        end
-      end
-    end
-  end
-end

data/lib/checkers/redis_checker.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Checkers
-  # Redis health checker
-  class RedisChecker
-    class << self
-      def check
-        raise 'Please make sure you have Redis installed' unless defined?(::Redis)
-
-        begin
-          @redis = Redis.new
-          @redis.ping == 'PONG'
-        rescue Redis::CannotConnectError
-          false
-        ensure
-          @redis&.close
-        end
-      end
-    end
-  end
-end