healthier 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 711f2ef8a3f208c3e4a4cc710fc86f73ff049a1734e0726caca32ef2d3c597f0
-  data.tar.gz: ceb81192506fb5d7132840da224ac48bdb6f31d216dc2867da3d2afca0bd5576
+  metadata.gz: eecccdf413d2d1d9f36ad797d3cbaae04f6e7d8e4dd4b625e45e87968005942b
+  data.tar.gz: 6b36f60acf3243c8bb6e0fb230043c0f938e71315de9cbedb814a4ac13b9eacc
 SHA512:
-  metadata.gz: 4c2b4a07809bdb88f6bd292ba9b284c5b6612ca525c0929341d4757aa01a6b98a56c3c0e60a160859e8e1b93d7c41cf13dfe9f1946997ec038b15d46b3516b8f
-  data.tar.gz: 8b260ec426e1544f745843ede0eaa38719aa08dd75636aa6a839a65412b7308d8bc2f0a90eba950779b76571d6b8117b9cb73de389861f24f6307fe335cc4731
+  metadata.gz: d45139aea688c64f0411b285c433c354447a2818ccba8d1dc49033a36dd825f9cdda0863fb863b1a6be6b5ea666b1ef67ab64847a30053f4fa57d2f6c54b8ec9
+  data.tar.gz: eb1e0cb5f18bc67aaa790f2724744514520f5f55b53892bb600056100effcc139e4a351e230e3740d7e0eb59d075e851afb260be75ad9a9e90f6d9c8b57e15f3

data/README.md

@@ -33,25 +33,37 @@ $ gem install healthier
 ```
 
 This will generate these two files:
+
 1. config/healthier.yml
+
 ```yaml
 ---
 healthier:
   depends_on:
-# Uncomment accordingly
-#    - name: 'postgresql'
-#    - name: 'mongodb'
-#    - name: 'redis'
-#    - name: 'rabbitmq'
+  # Uncomment accordingly
+  #    - name: 'postgresql'
+  #      config: {}
+  #    - name: 'mongodb'
+  #      config: {}
+  #    - name: 'redis'
+  #      config: {}
+  #    - name: 'rabbitmq'
+  #      config: {}
 ```
+NOTE: In future, config above will accept a hash each service's configuration
+
 2. config/initializers/healthier.rb
+
 ```ruby
 Healthier.setup do |config|
+  # If you don't specify auth_mechanism, then it defaults to http_basic.
+  # Currently, only http_basic and bearer_token are supported
+  config.auth_mechanism = 'bearer_token'
   config.depends_on = config.healthier.call
 end
 ```
 
-In your application routes.rb file:
+In your application routes.rb file(namespace according to your need):
 
 ```ruby
 mount Healthier::Engine => '/healthier'
@@ -64,6 +76,23 @@ USERNAME: 'demouser'
 PASSWORD: 'demouser@2023'
 ```
 
+ENVs for Bearer token authentication:
+
+```bash
+BEARER_TOKEN: 'e66cfadb3ce37a714fdf3df237dcfded9ed9a0f9ccb09e6a744d731e9214bae6fac7bf6d27cab3969702b7aa54c81fe1cff1842ac03b3d5f1a918e1f5061dcb80b80363976ae5f3b916c793fdfa5283ce5f387286152d62e2dcaa5c8c0f857ceb2cda045'
+```
+
+However, if you want to leave the API open, just set:
+
+```ruby
+  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'
+```
+
 ## Contributing
 
 Contribution directions go here.

data/app/controllers/healthier/application_controller.rb

@@ -3,12 +3,5 @@
 module Healthier
   # ApplicationController
   class ApplicationController < ActionController::Base
-    include ActionController::HttpAuthentication::Basic::ControllerMethods
-
-    before_action :authenticate_request
-
-    def authenticate_request
-      BasicAuthService.authorize(self)
-    end
   end
 end

data/app/controllers/healthier/checks_controller.rb

@@ -3,8 +3,22 @@
 module Healthier
   # Controller for performing health checks
   class ChecksController < ApplicationController
+    include ActionController::HttpAuthentication::Basic::ControllerMethods
+
+    before_action :authenticate_request
+
     def ping
       render json: Healthier::Engine.ping!
     end
+
+    protected
+
+    def authenticate_request
+      api_authenticator.authenticate
+    end
+
+    def api_authenticator
+      Healthier::ApiAuthenticator.new(self)
+    end
   end
 end

data/lib/checkers/mongodb_checker.rb

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,25 @@
+# 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

@@ -0,0 +1,21 @@
+# 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

data/lib/generators/healthier/config_generator.rb

@@ -10,6 +10,9 @@ module Healthier
         # frozen_string_literal: true
 
         Healthier.setup do |config|
+          # Currently, there are :basic_auth(default), :bearer_token for API authentication
+          # But if you want to leave the API open, then just set auth_mechanism to :none to skip authentication
+          # config.auth_mechanism = :bearer_token
           config.depends_on = config.healthier.call
         end
       RUBY
@@ -22,9 +25,13 @@ module Healthier
           # Uncomment accordingly
           depends_on:
         #    - name: 'postgresql'
+        #      config: {}
         #    - name: 'mongodb'
+        #      config: {}
         #    - name: 'redis'
+        #      config: {}
         #    - name: 'rabbitmq'
+        #      config: {}
       YAML
     end
   end

data/lib/healthier/api_authenticator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Healthier
+  # Engine
+  class ApiAuthenticator
+    attr_accessor :controller
+
+    def initialize(controller)
+      @controller = controller
+    end
+
+    def authenticate
+      return true if Healthier.auth_mechanism == :none
+
+      send("authenticate_with_#{Healthier.auth_mechanism}")
+    end
+
+    def authenticate_with_bearer_token
+      controller.authenticate_with_http_token do |token, _options|
+        ENV['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']
+      end
+    end
+  end
+end

data/lib/healthier/engine.rb

@@ -1,35 +1,15 @@
 # frozen_string_literal: true
 
+require_relative '../checkers/mongodb_checker'
+require_relative '../checkers/postgresql_checker'
+require_relative '../checkers/rabbitmq_checker'
+require_relative '../checkers/redis_checker'
+
 module Healthier
   # Engine
   class Engine < ::Rails::Engine
     isolate_namespace Healthier
 
-    PING_CONF = HashWithIndifferentAccess.new(
-      {
-        postgresql: {
-          pinger: -> { ActiveRecord::Base.connection },
-          message: 'PostgreSQL service is not running. Please check your connection'
-        },
-        mongodb: {
-          pinger: -> { Mongoid.default_client.command(ping: 1) },
-          message: 'MongoDB service is not running. Please check your connection'
-        },
-        redis: {
-          pinger: -> { Redis.new },
-          message: 'Redis service is not running. Please check your connection'
-        },
-        rabbitmq: {
-          pinger: -> { Bunny.new },
-          message: 'RabbitMQ service is not running. Please check your connection'
-        }
-      }
-    )
-
-    # TODO: Refactor this whole code
-    SUCCESS = 200
-    FAILURE = 400
-
     def ping!
       conf['depends_on'].each_with_object({}) do |dependant, obj|
         obj[dependant['name']] = ping_it(dependant['name'])
@@ -41,9 +21,15 @@ module Healthier
     end
 
     def ping_it(service)
-      return { status: SUCCESS, message: 'pong' } if PING_CONF[service]['pinger'].call
+      checked = checker(service).check
+
+      return { status: Healthier::SUCCESS, message: 'pong' } if checked == true
+
+      { status: Healthier::FAILURE, message: "#{service.camelize} service is not running. Please check your connection" }
+    end
 
-      { status: FAILURE, message: PING_CONF[service]['message'] }
+    def checker(service)
+      "::Checkers::#{service.camelize}Checker".constantize
     end
   end
 end

data/lib/healthier/version.rb

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

data/lib/healthier.rb

@@ -2,6 +2,7 @@
 
 require 'healthier/version'
 require 'healthier/engine'
+require 'healthier/api_authenticator'
 
 # Healthier
 module Healthier
@@ -9,6 +10,10 @@ module Healthier
     yield self
   end
 
+  SUCCESS = 200
+  FAILURE = 503
+
   mattr_accessor :healthier, default: -> { YAML.load_file(Rails.root.join('config/healthier.yml')) }
+  mattr_accessor :auth_mechanism, default: 'basic_auth'
   mattr_accessor :depends_on, default: {}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: healthier
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Nima Yonten
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,10 +36,14 @@ files:
 - Rakefile
 - app/controllers/healthier/application_controller.rb
 - app/controllers/healthier/checks_controller.rb
-- app/services/basic_auth_service.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/generators/healthier/config_generator.rb
 - lib/healthier.rb
+- lib/healthier/api_authenticator.rb
 - lib/healthier/engine.rb
 - lib/healthier/version.rb
 - lib/tasks/healthier_tasks.rake
@@ -51,6 +55,7 @@ metadata:
   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'
 post_install_message:
 rdoc_options: []
 require_paths:

data/app/services/basic_auth_service.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-# This module authenticates the API with Basic Auth
-class BasicAuthService
-  def self.authorize(controller)
-    controller.authenticate_or_request_with_http_basic do |username, password|
-      username == ENV['USERNAME'] && password == ENV['PASSWORD']
-    end
-  end
-end