ntq_tools 0.5.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31adc13868bf234dece4f45a91e3f163ef8c9a72fe433a67e890d34efce043e2
-  data.tar.gz: b88556d68a75735690128006616bb37e30fec9ae3bbdf39640a3b90b1281d616
+  metadata.gz: a594621c88b14946e288aa2368c4163b6dcdbffcc6cd13fd5731034497777559
+  data.tar.gz: ec37118491ddd0477344ac0a1f17b5deeecbcf1e14a5da12d43c6f3335ec8b45
 SHA512:
-  metadata.gz: 5810e19e2b39d8002f5281d242d6dac226fdb20b3b5ad48fb01c51108ee3ea77fdcaf7ee3d6dd5e4431853941f876723e0f95877374937f0d1adc97b380ae17b
-  data.tar.gz: c7183009c3c6d2bbe3a784c2bdf13bbb71524a4b6824c29117e2e82c5492fd9f13bb20b0a6731228f5ed7ec7702f6f38a47855936d154fea87b43f4583bc1706
+  metadata.gz: d46da61dd5cc76c37fb6f9886ddef63fadda3965c24bc9a2f9e7659bf3844540172e8716423097d69840511cdd107b63f86c41fa24162e1b9f07fdaacc2dc766
+  data.tar.gz: d91a1e25634c89ebabbf52f148f686f2fcd2fc7d9ce7fdaec245d2eccf76d3ea2c4056f94a75246a4deba9deece97f49dbeee082f64a92303bbf352a394fea57

data/README.md

@@ -4,6 +4,14 @@ Short description and motivation.
 ## Usage
 How to use my plugin.
 
+## Monitoring
+Pour activer le monitoring, veillez à ajouter ces variables d'environnement
+
+```
+MONITORING_PASSWORD
+MONITORING_USERNAME
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/app/controllers/ntq_tools/impersonation_controller.rb

@@ -1,6 +1,9 @@
 module NtqTools
   class ImpersonationController < ::ApplicationController
-    
+    skip_before_action :authenticate_user!, raise: false, if: -> { Rails.env.development? }
+    skip_before_action :authenticate_back_user!, raise: false, if: -> { Rails.env.development? }
+    skip_before_action :authenticate_customer!, raise: false, if: -> { Rails.env.development? }
+
     before_action :check_impersonation_enabled, except: [:config]
     before_action :model_name_is_valid?, only: [:sign_in]
 

data/app/controllers/ntq_tools/monitors_controller.rb

@@ -0,0 +1,27 @@
+require 'ntq_tools/monitor'
+module NtqTools
+  class MonitorsController < ActionController::Base
+
+    before_action :check_basic_auth
+
+    def check
+      @status, @services_status = NtqTools::Monitor.check
+
+      respond_to do |format|
+        format.json do
+          render json: { status: @status, services_status: @services_status }, status: @status == 'OK' ? :ok : :service_unavailable
+        end
+        format.html do
+        end
+      end
+    end
+
+  private
+
+    def check_basic_auth
+      authenticate_or_request_with_http_basic do |username, password|
+        username == ENV['MONITORING_USERNAME'] && password == ENV['MONITORING_PASSWORD']
+      end
+    end
+  end
+end

data/app/controllers/ntq_tools/translations_controller.rb

@@ -5,8 +5,8 @@ module NtqTools
     before_action :check_presence_of_key, except: [:refresh]
 
     def show
-      return  render json: { data: nil }, status: 404 unless I18n.exists?(params[:key].to_s)
-      
+      return render json: { data: nil }, status: 404 unless I18n.exists?(params[:key].to_s)
+
       render json: {
         data: I18n.t(params[:key])
       }, status: 200

data/config/routes.rb

@@ -1,8 +1,12 @@
 NtqTools::Engine.routes.draw do
-  resource :translation, only: [:update, :show]
-  get '/translation/refresh' => "translations#refresh"
+  get '/check' => "monitors#check"
 
-  if NtqTools.impersonation_enabled && NtqTools.impersonation_user_models.any? && defined?(Devise)
+  if Rails.env.development?
+    resource :translation, only: [:update, :show]
+    get '/translation/refresh' => "translations#refresh"
+  end
+
+  if NtqTools.impersonation_enabled && NtqTools.impersonation_user_models.any? && defined?(Devise) && Rails.env.development?
     get '/impersonation/users' => "impersonation#index"
     get "/impersonation/:model_name/:id/sign_in" => "impersonation#signin"
   end

data/lib/ntq_tools/monitor.rb

@@ -0,0 +1,37 @@
+require 'ntq_tools/monitors/redis'
+require 'ntq_tools/monitors/database'
+require 'ntq_tools/monitors/sidekiq'
+
+module NtqTools
+  class Monitor
+
+    # Check if installed services are running, it return a tuple with the status and the services status
+    #
+    # eg: [:ok, [{name: 'redis', status: 'OK'}, {name: 'database', status: 'OK'}]]
+    # eg: [:error, [{name: 'redis', status: 'OK'}, {name: 'database', status: 'ERROR'}]]
+    #
+    # @return [Symbol, Array<Hash>]
+    def self.check
+      services_status = []
+      list.each do |monitor|
+        next unless monitor.is_installed?
+
+        services_status << {
+          name: monitor.name,
+          status: monitor.check ? 'OK' : 'ERROR'
+        }
+      end
+      status = services_status.all? { |service| service[:status] == 'OK' } ? :ok : :error
+      [status, services_status]
+    end
+    
+    def self.list
+      [
+        ::NtqTools::Monitors::Redis,
+        ::NtqTools::Monitors::Database,
+        ::NtqTools::Monitors::Sidekiq
+      ]
+    end
+  
+  end
+end

data/lib/ntq_tools/monitors/base.rb

@@ -0,0 +1,20 @@
+module NtqTools
+  module Monitors
+    class Base
+      class << self
+  
+        def name
+          "You must define the name method in your monitor class"
+        end
+  
+        def is_installed?
+          "You must define the is_installed? method in your monitor class"
+        end
+  
+        def check
+          "You must define the check method in your monitor class"
+        end
+      end
+    end
+  end
+end

data/lib/ntq_tools/monitors/database.rb

@@ -0,0 +1,21 @@
+require 'ntq_tools/monitors/base'
+module NtqTools
+  module Monitors
+    class Database < Base
+  
+      class << self
+        def name
+          "database"
+        end
+    
+        def is_installed?
+          defined?(::ActiveRecord).present?
+        end
+    
+        def check
+          ::ActiveRecord::Base.connection_pool.with_connection { |con| con.active? } rescue false
+        end
+      end
+    end
+  end
+end

data/lib/ntq_tools/monitors/redis.rb

@@ -0,0 +1,23 @@
+require 'ntq_tools/monitors/base'
+module NtqTools
+  module Monitors
+    class Redis < Base
+  
+      class << self
+        def name
+          'redis'
+        end
+    
+        def is_installed?
+          ::Gem.loaded_specs.has_key?("redis")
+        end
+    
+        def check
+          ::Sidekiq.redis { |con| con.ping }.present?
+        rescue ::Redis::CannotConnectError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/ntq_tools/monitors/sidekiq.rb

@@ -0,0 +1,22 @@
+require 'ntq_tools/monitors/base'
+module NtqTools
+  module Monitors
+    class Sidekiq < Base
+  
+      class << self
+        def name
+          "sidekiq"
+        end
+    
+        def is_installed?
+          ::Gem.loaded_specs.has_key?("sidekiq")
+        end
+    
+        def check
+          ::Sidekiq::ProcessSet.new.any? { |process| process['busy'] }
+        end
+      end
+  
+    end
+  end
+end

data/lib/ntq_tools/version.rb

@@ -1,3 +1,3 @@
 module NtqTools
-  VERSION = "0.5.2"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ntq_tools
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Kevin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-19 00:00:00.000000000 Z
+date: 2024-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,6 +58,7 @@ files:
 - app/assets/stylesheets/ntq_tools/application.css
 - app/controllers/ntq_tools/application_controller.rb
 - app/controllers/ntq_tools/impersonation_controller.rb
+- app/controllers/ntq_tools/monitors_controller.rb
 - app/controllers/ntq_tools/translations_controller.rb
 - app/helpers/ntq_tools/application_helper.rb
 - app/jobs/ntq_tools/application_job.rb
@@ -70,6 +71,11 @@ files:
 - lib/generators/templates/ntq_tools.rb
 - lib/ntq_tools.rb
 - lib/ntq_tools/engine.rb
+- lib/ntq_tools/monitor.rb
+- lib/ntq_tools/monitors/base.rb
+- lib/ntq_tools/monitors/database.rb
+- lib/ntq_tools/monitors/redis.rb
+- lib/ntq_tools/monitors/sidekiq.rb
 - lib/ntq_tools/translations/hash_utils.rb
 - lib/ntq_tools/translations/translation_tool.rb
 - lib/ntq_tools/translations/yaml_tool.rb