konsierge-notifier 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3679299ae685f421a56aeb7158c38c02d54d2202b42912cb16389ec0c49c6453
+  data.tar.gz: 1f617cb829dc394371c9b123765c767171bc335b43345baadc43a30ad0d9ccdf
+SHA512:
+  metadata.gz: 9ad9637bf1d6e037cbbfd1dd94ff5c1b3876a47c8028a6dfd75e453eb854e0925101fc9610477510e12e07e3995a1be6f75218ef4cf4a2d43c410da8afe51a31
+  data.tar.gz: 5f7db0f81d015207a1cee5d48828f7ea1745e3702d65a4eeec980163157d840bd8853ba40990ae489c40bfcaad80f649e2957138888faa6bdcd88199ca3033d5

data/.env.sample

@@ -0,0 +1,7 @@
+TELEGRAM_BOT_ENABLED=""
+TELEGRAM_BOT_TOKEN=""
+TELEGRAM_BOT_USERNAME=""
+TELEGRAM_CHANNEL_ID=""
+
+KONSIERGE_SMTP_MAILER_HOST=""
+KONSIERGE_SMTP_MAILER_AUTH_KEY=""

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,64 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7.4
+  SuggestExtensions: false
+  NewCops: enable
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Style/Documentation:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Style/OpenStructUse:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/NonDeterministicRequireOrder:
+  Exclude:
+    - 'spec/**/*'
+
+Style/StringLiterals:
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/VerifiedDoubleReference:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/NoExpectationExample:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'spec/support/shared_examples/**/*'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-11
+
+- Initial release

data/README.md

@@ -0,0 +1,15 @@
+# Konsierge::Notifier
+
+## Installation
+
+## Usage
+
+### Telegram
+
+
+### Mailer
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/konsierge-notifier

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'konsierge/notifier'

data/konsierge-notifier.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'lib/konsierge/notifier'
+
+Gem::Specification.new do |spec|
+  spec.name = 'konsierge-notifier'
+  spec.version = Konsierge::Notifier::VERSION
+  spec.author = 'David Rybolovlev'
+  spec.email = ['golifox911@gmail.com']
+
+  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'
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        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'
+
+  # All notifiers
+  spec.add_dependency 'dry-configurable', '~> 1.0'
+
+  # Telegram notifier
+  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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# lib/generators/install/install_generator.rb
+require 'rails/generators/base'
+
+namespace 'konsierge-notifier'
+
+module Generators
+  class KonsiergeNotifier < Rails::Generators::Base
+    def self.source_root
+      @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+    end
+
+    desc 'Creates a Konsierge::Notifier initializer for your application'
+
+    def copy_initializer
+      template 'konsierge_notifier_telegram.rb', 'config/initializers/konsierge_notifier_telegram.rb'
+
+      # Code to copy the message and error_message erb templates
+      copy_file 'message_template.html.erb', 'lib/templates/konsierge_notifier/message.html.erb'
+      copy_file 'error_template.html.erb', 'lib/templates/konsierge_notifier/error.html.erb'
+    end
+  end
+end

data/lib/generators/install/templates/error_template.html.erb

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

data/lib/generators/install/templates/konsierge_notifier_telegram.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'konsierge'
+
+Telegram.bots_config = {
+  default: {
+    token:    ENV.fetch('TELEGRAM_BOT_TOKEN', nil),
+    username: 'Konsierge notifier'
+  }
+}
+
+Konsierge::Notifier::Telegram.configure do |config|
+  config.app_name = Rails.application.class.module_parent_name
+  config.bot_enabled = ENV.fetch('TELEGRAM_BOT_ENABLED', false)
+  config.chat_id = ENV.fetch('TELEGRAM_CHANNEL_ID', nil)
+  config.logger = Rails.logger
+end

data/lib/generators/install/templates/template.html.erb

@@ -0,0 +1,2 @@
+<b><%= "#{CGI.escape_html(app_name.to_s)}\n" %></b>
+<%= CGI.escape_html(message.to_s) %>

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

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

@@ -0,0 +1,18 @@
+===============================================================================
+
+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

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

@@ -0,0 +1,8 @@
+<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") %>

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

@@ -0,0 +1,2 @@
+<b><%= "#{app_name}\n" %></b>
+<%= message %>

data/lib/konsierge/notifier.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'dry-configurable'
+require 'logger'
+require 'telegram/bot'
+
+module Konsierge
+  class Notifier
+    extend ::Dry::Configurable
+
+    setting :app_name
+    setting :chat_id, default: ENV.fetch('TELEGRAM_CHANNEL_ID', nil)
+    setting :bot_enabled, default: ENV.fetch('TELEGRAM_BOT_ENABLED', false)
+    setting :message_template_path, default: File.expand_path('notifier/template.html.erb', __dir__)
+    setting :error_template_path, default: File.expand_path('notifier/error_template.html.erb', __dir__)
+    setting :logger, default: Logger.new($stdout)
+    setting :parse_mode, default: 'HTML'
+
+    VERSION = '0.1.2'
+
+    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 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
+
+      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
+        )
+      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)
+      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
+      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
+      end
+
+      def check_chat_id!(chat_id)
+        chat_id ||= config.chat_id
+
+        raise TELEGRAM_CHAT_ID_NOT_SET unless chat_id
+
+        chat_id
+      end
+
+      def bot_enabled?
+        config.bot_enabled
+      end
+
+      def log_disabled_bot_warning
+        config.logger.warn(TELEGRAM_BOT_DISABLED)
+        false
+      end
+    end
+  end
+end

data/sig/konsierge/notifier/mailer.rbs

@@ -0,0 +1,31 @@
+module Konsierge
+  module Notifier
+    class Mailer
+      @connection: ::Faraday::Connection
+
+      def initialize: (*untyped, **untyped) -> void
+
+      def configure: -> void
+
+      def config: -> ::Dry::Configurable::Config
+
+      def deliver!: (::Mail mail) -> void
+
+      private
+
+      def build_payload: (::Mail mail) -> Hash[Symbol, Object]
+
+      def check_config!: -> void
+
+      def connection: -> ::Faraday::Connection
+
+      def determine_body: (::Mail mail) -> String
+
+      def process_attachments: (Array[untyped] attachments) -> Array[::Faraday::Multipart::FilePart]
+
+      def with_error_handle: -> void
+
+      def with_temp_file_deletion: -> void
+    end
+  end
+end

data/sig/konsierge/notifier/telegram.rbs

@@ -0,0 +1,30 @@
+module Konsierge
+  module Notifier
+    class Telegram
+      TELEGRAM_CHAT_ID_NOT_SET: String
+      TELEGRAM_BOT_ERROR: String
+      TELEGRAM_BOT_DISABLED: String
+      PATH_OR_CHAT_ID_NOT_PROVIDED: String
+
+      def self.send_message: (String) -> bool
+
+      def self.report_error: (Exception, source?: String) -> bool
+
+      def self.send_error: (Exception, source?: String) -> bool
+
+      private
+      
+      def self.send_with_message_template: (Hash[Symbol, String]) -> bool
+
+      def self.sanitize_template_options!: (Hash[Symbol, String]) -> Hash[Symbol, String]
+
+      def self.check_chat_id!: (String | NilClass) -> String
+
+      def self.send_to_telegram: (String, chat_id?: String) -> bool
+
+      def self.bot_enabled?: () -> bool
+
+      def self.log_disabled_bot_warning: () -> false
+    end
+  end
+end

data/sig/konsierge.rbs

@@ -0,0 +1,3 @@
+module Konsierge
+  VERSION: String
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: konsierge-notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- David Rybolovlev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-21 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: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: telegram-bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Notifier for Konsierge.
+email:
+- golifox911@gmail.com
+executables:
+- konsierge-notifier
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- exe/konsierge-notifier
+- 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/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/error_template.html.erb
+- lib/konsierge/notifier/template.html.erb
+- sig/konsierge.rbs
+- sig/konsierge/notifier/mailer.rbs
+- sig/konsierge/notifier/telegram.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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Notifier for Konsierge.
+test_files: []