konsierge-notifier 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 392db80e0f625751fe214faa879dc1a4e6218c77d5338a69a35c44cad0ca0eb0
-  data.tar.gz: cb3ab8bb6983b4cc97220a691d975f1796d47b05f1cd1ea3230b84723273ef4d
+  metadata.gz: cc425bfa6f9517f101566c0eafc628825b199bab158a745ed774bed0c671cc6f
+  data.tar.gz: dd3e91fcbdedebf8b0103dcb10fb092b7c1075202f5073c75b78e2289855f569
 SHA512:
-  metadata.gz: 5fa88d757296eeb57e9d5e691c0e2a85e189fc4790e9fca1da88596f958c63231fc73e76bdd6bda848b9444331882b287455f73af8999faffa3ab81561316084
-  data.tar.gz: acb2407a783958a0d6e2e902aacd054b122783d911e1e983b517c7b309d548619eab52684f844af23c23cc1734f058b851f8362eae17f429bf649a5de183c1e5
+  metadata.gz: 7b52bc1f695f699711c5d0a195db9828787919daafaa71b968a4be790eac813aa36ee7302c559998c4f4af5b2229c7f329352a0cb818487edc73c24f67e837ac
+  data.tar.gz: 05fb8eecec7b5d8f2f9f5db32bc8a3f0290271d08ba9ddd096d491bb0c1645f9e61542f50c1652d399c835b6e090c06183c8a029e33fa1f5be75ecb738e7ff00

data/.rubocop.yml

@@ -27,6 +27,9 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
+Metrics/MethodLength:
+  Max: 20
+
 Lint/NonDeterministicRequireOrder:
   Exclude:
     - 'spec/**/*'

data/Rakefile

@@ -2,11 +2,9 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
 
-task default: %i[spec rubocop]
+task default: %i[rubocop spec]

data/konsierge-notifier.gemspec

@@ -3,13 +3,13 @@
 require_relative 'lib/konsierge/notifier/version'
 
 Gem::Specification.new do |spec|
-  spec.name = 'konsierge-notifier'
+  spec.name    = 'konsierge-notifier'
   spec.version = Konsierge::Notifier::VERSION
-  spec.author = 'David Rybolovlev'
-  spec.email = ['golifox911@gmail.com']
+  spec.author  = 'David Rybolovlev'
+  spec.email   = ['golifox911@gmail.com']
 
-  spec.summary = 'Notifier for Konsierge.'
-  spec.description = spec.summary
+  spec.summary               = 'Notifier for Konsierge.'
+  spec.description           = spec.summary
   spec.required_ruby_version = '>= 2.7.4'
 
   spec.metadata['source_code_uri'] = 'https://gitlab.konsierge.com/digitalbox/gem/konsierge-notifier'
@@ -20,23 +20,14 @@ Gem::Specification.new do |spec|
         f.start_with?(*%w[bin/ spec/ features/ .git .circleci appveyor Gemfile])
     end
   end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
 
-  spec.add_dependency 'dotenv', '~> 2.7'
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  # Telegram notifier
+  spec.add_dependency 'dotenv', '>= 2.0'
+  spec.add_dependency 'erb', '>= 2.0'
   spec.add_dependency 'telegram-bot', '~> 0.16.1'
 
-  # Development and test dependencies
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rspec', '~> 3.10'
-  spec.add_development_dependency 'rspec-mocks', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '~> 1.60'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.11'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.11'
-  spec.add_development_dependency 'simplecov', '~> 0.22'
-
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/generators/install/konsierge_notifier.rb

@@ -14,7 +14,7 @@ module Generators
     desc 'Creates a Konsierge::Notifier initializer for your application'
 
     def copy_initializer
-      template 'konsierge_notifier_telegram.rb', 'config/initializers/konsierge_notifier_telegram.rb'
+      template 'konsierge_notifier.rb', 'config/initializers/konsierge_notifier.rb'
 
       # Code to copy the message and error_message erb templates
       copy_file 'message_template.html.erb', 'lib/templates/konsierge_notifier/message.html.erb'

data/lib/generators/install/templates/{konsierge_notifier_telegram.rb → konsierge_notifier.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'konsierge'
+require 'konsierge/notifier'
 
 Telegram.bots_config = {
   default: {

data/lib/konsierge/notifier/adapters/base_adapter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Konsierge
+  module Notifier
+    module Adapters
+      class BaseAdapter
+        def send_message(message, context: {}, **options)
+          raise NotImplementedError
+        end
+
+        def send_error(error, context: {}, source: nil, **options)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/konsierge/notifier/adapters/telegram.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'json'
+
+require_relative 'base_adapter'
+
+module Konsierge
+  module Notifier
+    module Adapters
+      class Telegram < BaseAdapter
+        TELEGRAM_CHAT_ID_NOT_SET     = 'Telegram Chat ID is not set'
+        TELEGRAM_BOT_ERROR           = 'TelegramBot Error: %s'
+        TELEGRAM_BOT_DISABLED        = 'TelegramBot is disabled! Message not sent.'
+        PATH_OR_CHAT_ID_NOT_PROVIDED = 'Please, provide path and chat_id'
+
+        def send_message(message, context: {}, **options)
+          chat_id = options.delete(:chat_id)
+
+          template_params = {
+            app_name: Notifier.config.app_name,
+            message:  message,
+            context:  context
+          }
+
+          send_with_message_template(
+            path:            Notifier.config.message_template_path,
+            chat_id:         chat_id,
+            template_params: template_params
+          )
+        end
+
+        def send_error(error, context: {}, source: nil, **options)
+          chat_id = options.delete(:chat_id)
+
+          template_params = {
+            app_name: Notifier.config.app_name,
+            error:    error,
+            source:   source,
+            context:  context
+          }
+
+          send_with_message_template(
+            path:            Notifier.config.error_template_path,
+            chat_id:         chat_id,
+            template_params: template_params
+          )
+        end
+
+        private
+
+        def send_with_message_template(**options)
+          return log_disabled_bot_warning unless bot_enabled?
+
+          opts = sanitize_template_options!(options)
+
+          provided_chat_id = opts.delete(:chat_id)
+          chat_id          = check_chat_id!(provided_chat_id)
+
+          provided_path = opts.delete(:path)
+          template      = ::ERB.new(File.read(provided_path))
+
+          template_params = opts.delete(:template_params)
+          message         = template.result_with_hash(template_params)
+
+          send_to_telegram(message, chat_id: chat_id)
+        end
+
+        def send_to_telegram(text, chat_id:)
+          ::Telegram.bot.send_message(chat_id: chat_id, text: text, parse_mode: Notifier.config.parse_mode)
+
+          true
+        rescue StandardError => e
+          Notifier.config.logger.error(TELEGRAM_BOT_ERROR % e.message)
+          false
+        end
+
+        def sanitize_template_options!(options)
+          opts = options.dup
+
+          unless %i[path chat_id template_params].all? { |key| opts.key?(key) }
+            raise ArgumentError, PATH_OR_CHAT_ID_NOT_PROVIDED
+          end
+
+          opts
+        end
+
+        def check_chat_id!(chat_id)
+          chat_id ||= Notifier.config.chat_id
+
+          raise TELEGRAM_CHAT_ID_NOT_SET unless chat_id
+
+          chat_id
+        end
+
+        def bot_enabled?
+          Notifier.config.bot_enabled
+        end
+
+        def log_disabled_bot_warning # rubocop:disable Naming/PredicateMethod
+          Notifier.config.logger.warn(TELEGRAM_BOT_DISABLED)
+
+          false
+        end
+      end
+    end
+  end
+end

data/lib/konsierge/notifier/configuration.rb

@@ -1,17 +1,26 @@
 # frozen_string_literal: true
 
+require_relative 'adapters/telegram'
+
 module Konsierge
   module Notifier
     class Configuration
-      attr_accessor :app_name, :chat_id, :bot_enabled, :message_template_path, :error_template_path, :logger,
-                    :parse_mode
+      class Error < StandardError; end
+
+      ADAPTER_IMPLEMENTATIONS = {
+        telegram: Adapters::Telegram
+      }.freeze
+
+      attr_accessor :app_name, :adapter, :chat_id, :bot_enabled,
+                    :message_template_path, :error_template_path, :logger, :parse_mode
 
       def initialize
         @app_name              = nil
+        @adapter               = :telegram
         @chat_id               = ENV.fetch('TELEGRAM_CHANNEL_ID', nil)
         @bot_enabled           = ENV.fetch('TELEGRAM_BOT_ENABLED', false)
-        @message_template_path = File.expand_path('template.html.erb', __dir__)
-        @error_template_path   = File.expand_path('error_template.html.erb', __dir__)
+        @message_template_path = File.expand_path('templates/telegram/message.html.erb', __dir__)
+        @error_template_path   = File.expand_path('templates/telegram/error.html.erb', __dir__)
         @logger                = Logger.new($stdout)
         @parse_mode            = 'HTML'
       end
@@ -21,6 +30,15 @@ module Konsierge
           hash[var.to_s.delete('@').to_sym] = instance_variable_get(var)
         end
       end
+
+      def adapter_class
+        unless ADAPTER_IMPLEMENTATIONS[@adapter]
+          error_msg = "#{@adapter} must be one of #{ADAPTER_IMPLEMENTATIONS.keys.join(', ')}"
+          raise Error, error_msg
+        end
+
+        ADAPTER_IMPLEMENTATIONS[@adapter.to_s.to_sym]
+      end
     end
   end
 end

data/lib/konsierge/notifier/rails_report_subscriber.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Konsierge
+  module Notifier
+    class RailsReportSubscriber
+      # rubocop:disable Lint/UnusedMethodArgument
+      def report(error, handled:, severity:, context:, source: nil)
+        Notifier.send_error(error, source: source, context: context)
+      end
+      # rubocop:enable Lint/UnusedMethodArgument
+    end
+  end
+end

data/lib/konsierge/notifier/templates/telegram/error.html.erb

@@ -0,0 +1,14 @@
+<b><%= CGI.escape_html(app_name.to_s) %></b>
+<% "\n" %>
+<b>Error</b>: <%= CGI.escape_html(error.class.to_s) %> - <%= CGI.escape_html(error.message.to_s) %>
+<% "\n" %>
+<b>Source</b>: <%= CGI.escape_html(source.to_s) %>
+<% if context %>
+<b>Context</b>: <%= CGI.escape_html(JSON.pretty_generate(context)) %>
+<% end %>
+<% if error&.backtrace && error.backtrace.any? %>
+<b>Trace:</b>
+<%= error.backtrace[0..2].map { |trace| "===> #{CGI.escape_html(trace.to_s)}" }.join("\n") %>
+<% else %>
+<b>No backtrace available</b>
+<% end %>

data/lib/konsierge/notifier/version.rb

@@ -2,6 +2,6 @@
 
 module Konsierge
   module Notifier
-    VERSION = '0.1.3'
+    VERSION = '0.1.6'
   end
 end

data/lib/konsierge/notifier.rb

@@ -2,92 +2,46 @@
 
 require 'logger'
 require 'telegram/bot'
+
+require_relative 'notifier/version'
 require_relative 'notifier/configuration'
+require_relative 'notifier/adapters/telegram'
+require_relative 'notifier/rails_report_subscriber'
 
 module Konsierge
   module Notifier
-    TELEGRAM_CHAT_ID_NOT_SET = 'Telegram Chat ID is not set'
-    TELEGRAM_BOT_ERROR = 'TelegramBot Error: %s'
-    TELEGRAM_BOT_DISABLED = 'TelegramBot is disabled! Message not sent.'
-    PATH_OR_CHAT_ID_NOT_PROVIDED = 'Please, provide path and chat_id'
-
     class << self
       def config
         @config ||= Configuration.new
       end
 
       def configure
-        yield(config)
-      end
-
-      def send_message(text, chat_id: nil)
-        send_with_message_template(
-          path:     config.message_template_path,
-          chat_id:  chat_id,
-          app_name: config.app_name,
-          message:  text
-        )
-      end
+        subscribe_on_reporter
 
-      def report_error(error, source: nil, chat_id: nil)
-        send_with_message_template(
-          path:     config.error_template_path,
-          chat_id:  chat_id,
-          app_name: config.app_name,
-          error:    error,
-          source:   source
-        )
+        yield(config)
       end
 
-      alias send_error report_error
-
-      private
-
-      def send_with_message_template(**options)
-        return log_disabled_bot_warning unless bot_enabled?
-
-        opts = sanitize_template_options!(options)
-        chat_id = check_chat_id!(opts[:chat_id])
-
-        template = ERB.new(File.read(opts[:path]))
-
-        template_params = opts.except(:path, :chat_id)
-        message = template.result_with_hash(template_params)
-
-        send_to_telegram(message, chat_id: chat_id)
+      def adapter_instance
+        @adapter_instance ||= config.adapter_class.new
       end
 
-      def send_to_telegram(text, chat_id:)
-        ::Telegram.bot.send_message(chat_id: chat_id, text: text, parse_mode: config.parse_mode)
-
-        true
-      rescue StandardError => e
-        config.logger.error(TELEGRAM_BOT_ERROR % e.message)
-        false
+      def send_message(...)
+        adapter_instance.send_message(...)
       end
 
-      def sanitize_template_options!(options)
-        opts = options.dup
-        raise ArgumentError, PATH_OR_CHAT_ID_NOT_PROVIDED unless %i[path chat_id].all? { |key| opts.key?(key) }
-
-        opts
+      def send_error(...)
+        adapter_instance.send_error(...)
       end
 
-      def check_chat_id!(chat_id)
-        chat_id ||= config.chat_id
-
-        raise TELEGRAM_CHAT_ID_NOT_SET unless chat_id
+      alias report_error send_error
 
-        chat_id
-      end
+      private
 
-      def bot_enabled?
-        config.bot_enabled
-      end
+      def subscribe_on_reporter
+        return unless Gem::Version.new(::Rails.version).segments.first >= 7
 
-      def log_disabled_bot_warning
-        config.logger.warn(TELEGRAM_BOT_DISABLED)
-        false
+        config.logger.debug { 'Konsierge notifier is subscribing to Rails error reporter...' }
+        Rails.error.subscribe(RailsReportSubscriber.new)
       end
     end
   end

metadata

@@ -1,141 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: konsierge-notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
 - David Rybolovlev
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: telegram-bot
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: erb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-- !ruby/object:Gem::Dependency
-  name: rspec-mocks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.10'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.60'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.60'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
-- !ruby/object:Gem::Dependency
-  name: simplecov
+  name: telegram-bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
-  type: :development
+        version: 0.16.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: 0.16.1
 description: Notifier for Konsierge.
 email:
 - golifox911@gmail.com
@@ -154,25 +69,23 @@ files:
 - konsierge-notifier.gemspec
 - lib/generators/install/konsierge_notifier.rb
 - lib/generators/install/templates/error_template.html.erb
-- lib/generators/install/templates/konsierge_notifier_telegram.rb
+- lib/generators/install/templates/konsierge_notifier.rb
 - lib/generators/install/templates/template.html.erb
-- lib/generators/konsierge/notifier/mailer/install_generator.rb
-- lib/generators/konsierge/notifier/mailer/templates/README
-- lib/generators/konsierge/notifier/mailer/templates/initializer.rb
 - lib/konsierge/notifier.rb
+- lib/konsierge/notifier/adapters/base_adapter.rb
+- lib/konsierge/notifier/adapters/telegram.rb
 - lib/konsierge/notifier/configuration.rb
-- lib/konsierge/notifier/error_template.html.erb
-- lib/konsierge/notifier/template.html.erb
+- lib/konsierge/notifier/rails_report_subscriber.rb
+- lib/konsierge/notifier/templates/telegram/error.html.erb
+- lib/konsierge/notifier/templates/telegram/message.html.erb
 - lib/konsierge/notifier/version.rb
 - mise.toml
 - sig/konsierge.rbs
 - sig/konsierge/notifier.rbs
-homepage:
 licenses: []
 metadata:
   source_code_uri: https://gitlab.konsierge.com/digitalbox/gem/konsierge-notifier
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -187,8 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Notifier for Konsierge.
 test_files: []

data/lib/generators/konsierge/notifier/mailer/install_generator.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/generators'
-
-module KonsiergeSmtpMailer
-  class InstallGenerator < ::Rails::Generators::Base
-    source_root File.expand_path('templates', __dir__)
-    desc 'Installs KonsiergeSmtpMailer.'
-
-    def install
-      template 'initializer.rb', 'config/initializers/konsierge-smtp-mailer.rb'
-      readme 'README'
-    end
-  end
-end

data/lib/generators/konsierge/notifier/mailer/templates/README

@@ -1,18 +0,0 @@
-===============================================================================
-
-There is a setup that you need to do before you can use KonsiergeSmtpMailer.
-
-Step 1.
-Go to config/initializers/konsierge-smtp-mailer.rb and configure
-smtp_mailer_host and smtp_mailer_auth_key.
-
-Step 2.
-Set new mailer in environment files:
-
-    config.action_mailer.delivery_method = :konsierge_smtp_mailer
-
-Step 3.
-That's it, that's all. Enjoy!
-
-===============================================================================
-

data/lib/generators/konsierge/notifier/mailer/templates/initializer.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-ActionMailer::Base.add_delivery_method :konsierge_notifier, Konsierge::Notifier::Mailer
-
-Konsierge::Notifier::Mailer.configure do |config|
-  config.smtp_mailer_host = ENV.fetch('KONSIERGE_SMTP_MAILER_HOST', nil)
-  config.smtp_mailer_auth_key = ENV.fetch('KONSIERGE_SMTP_MAILER_AUTH_KEY', nil)
-end

data/lib/konsierge/notifier/error_template.html.erb

@@ -1,8 +0,0 @@
-<b><%= CGI.escape_html(app_name.to_s) %></b>
-<% "\n" %>
-<b>Error</b>: <%= CGI.escape_html(error.class.to_s) %> - <%= CGI.escape_html(error.message.to_s) %>
-<% "\n" %>
-<b>Source</b>: <%= CGI.escape_html(source.to_s) %>
-<% "\n" %>
-<b>Trace:</b>
-<%= error.backtrace[0..2].flatten.map { |trace| "===> #{CGI.escape_html(trace.to_s)}" }.join("\n") %>