telegram_alerts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27ed353f8f0cf2082df344ecf42243dc14ec87de19812ca3baf1f2d94b632d13
+  data.tar.gz: 1b70bdff3253101393271bf49bc5515e4e835ec6b36f51b7f9ae2f3a25a2972f
+SHA512:
+  metadata.gz: 2583bb7e479888c8a12d028016549c0b8514f92a20c2277fe288b5408e6064ebdbb7dbaecca707c96e89307ed1f4a09ad6512fcf021398bf34e184c6df528094
+  data.tar.gz: defdccd1a5f5c375357ab2aa2bb286c51325351f2bf9afb4cd995cff6e3abc8a93b038a7d9c99e613d20b6cebff9c8d66c45f106832c7b65e718c977a5a282cb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+*.gem
+.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in telegram_alerts.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 mikael
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# TelegramAlerts
+TelegramAlerts is a Ruby gem that allows you to receive notifications about exceptions and alerts in your Ruby applications through Telegram. The notifications include information such as the exception class, message, backtrace, environment, and time of occurrence.
+
+## Installation
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add telegram_alerts
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install telegram_alerts
+
+## Description
+In order to use TelegramAlerts, you need to create a subclass of TelegramAlerts::ChatMixin and set the chat key.
+
+### _exception_ method
+The `exception` function returns a message in HTML format. The message includes:
+
+- Emoji corresponding to the severity level
+- Exception class
+- Exception message
+- Custom message if any
+- Simplified backtrace
+- Environment details such as host name, ruby version, project name and path, date and time, timezone
+
+Each piece of information is separated by newlines and formatted with either bold or italic text to distinguish different elements of the message.
+
+### _message_ method
+The `message` function is responsible for sending an message to the specified Telegram channel. The message includes information about the severity of the issue, the date and time, and a descriptive message.
+
+### Available severity levels
+The available severity levels in the TelegramAlert gem are:
+
+- FATAL (🔥): represents a critical error that requires immediate attention;
+- ERROR (❌): represents an error that is not critical but requires attention;
+- WARN (⚠️): represents a warning that does not require immediate attention;
+- INFO (ℹ️): represents an informational message;
+- DEBUG (🔍): represents a message that is useful for debugging purposes.
+
+## Usage
+
+Here's an example of how to use TelegramAlerts in a Ruby application:
+
+```ruby
+require 'telegram_alerts'
+
+TelegramAlerts.chats_settings.merge!({
+  monitor: {
+    bot_token: 'BOT_TOKEN',
+    chat_id: 'MONITOR_CHAT_ID',
+    host_name: `hostname`.strip,
+    project_name: 'AwesomeProject'
+  },
+  logs: {
+    bot_token: 'BOT_TOKEN',
+    chat_id: 'LOGS_CHAT_ID',
+    host_name: `hostname`.strip,
+    project_name: 'AwesomeProject'
+  }
+})
+
+module AwesomeProjectAlertsChats
+  class MonitorChat < TelegramAlerts::ChatMixin
+    def self.chat
+      :monitor
+    end
+  end
+
+  class LogsChat < TelegramAlerts::ChatMixin
+    def self.chat
+      :logs
+    end
+  end
+end
+```
+
+Then, In your application code, you can use the `log_exception` method to log an exception and receive a notification to the Telegram chat or group:
+
+```ruby
+
+begin
+  # Some code that raises an exception
+rescue => e
+  AwesomeProjectAlertsChats::MonitorChat.exception(e, 'FATAL', 'A fatal error has occurred.')
+end
+```
+
+You can also use the `message` method to send an notification to Telegram:
+
+```ruby
+AwesomeProjectAlertsChats::LogsChat.message('User created', 'INFO')
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/telegram_alerts.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "telegram_alerts"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/telegram_alerts/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TelegramAlerts
+  VERSION = "0.1.0"
+end

data/lib/telegram_alerts.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require_relative 'telegram_alerts/version'
+
+module TelegramAlerts
+
+  def self.chats_settings
+    @chats_settings ||= {}
+  end
+
+  def self.special_telegram_chars
+    @special_telegram_chars ||= {
+      '<' => '',
+      '>' => '()',
+    }
+  end
+
+  def self.severity_parser
+    @severity_parser ||= {
+      'ALERT' => '🔔',
+      'FATAL' => '🔥',
+      'ERROR' => '❌',
+      'WARN' => '⚠️',
+      'INFO' => 'ℹ️',
+      'DEBUG' => '🔍'
+    }
+  end
+
+  class ChatMixin
+
+    def self.chat
+      raise 'You must define a chat key'
+    end
+
+    def self.bot_token
+      token = TelegramAlerts.chats_settings[chat]['bot_token'] || TelegramAlerts.chats_settings[chat][:bot_token]
+      if token.nil?
+        raise 'You must define a bot token'
+      end
+      token
+    end
+
+    def self.chat_id
+      _id = TelegramAlerts.chats_settings[chat]['chat_id'] || TelegramAlerts.chats_settings[chat][:chat_id]
+      if _id.nil?
+        raise 'You must define a chat id'
+      end
+      _id
+    end
+
+    def self.host_name
+      name = TelegramAlerts.chats_settings[chat]['host_name'] || TelegramAlerts.chats_settings[chat][:host_name]
+      if name.nil?
+        raise 'You must define a host name'
+      end
+      name
+    end
+
+    def self.project_name
+      name = TelegramAlerts.chats_settings[chat]['project_name'] || TelegramAlerts.chats_settings[chat][:project_name]
+      if name.nil?
+        raise 'You must define a project name'
+      end
+      name
+    end
+
+    def self.exception(e, severity, message: nil)
+      message = parse_exception(e, severity, message: message)
+      send_message(message, bot_token, chat_id)
+    end
+
+    def self.send_message(message, bot_token, chat_id)
+      body = {
+        'chat_id' => chat_id,
+        'text' => message,
+        'parse_mode' => 'HTML'
+      }
+      telegram_endpoint_uri = URI("https://api.telegram.org/bot#{bot_token}/sendMessage")
+      Net::HTTP.post_form(telegram_endpoint_uri, body)
+    end
+
+    def self.message(message, severity = 'INFO')
+      severity_emoji = TelegramAlerts.severity_parser[severity]
+      title = "<b>#{severity_emoji} #{severity.capitalize}</b>"
+      time = "<i>#{Time.now.strftime('%H:%M:%S %d-%m-%Y %z')}</i>"
+      send_message("#{title}\n\n#{message}\n\n#{time}", bot_token, chat_id)
+    end
+
+    def self.parse_exception(exception, severity, message = nil)
+      severity_emoji = TelegramAlerts.severity_parser[severity]
+      project_path = File.expand_path('../..', __FILE__)
+
+      lines = exception.backtrace.map{ |x|
+        x.match(/^(.+?):(\d+)(|:in `(.+)')$/);
+        [$1,$2,$4]
+      }.reject { |x| x.first&.include?('.rvm/') }
+
+      now = Time.now
+
+      formatted_message = [
+        "#{severity_emoji} <b>#{exception.class}</b>",
+        "\n<b>Message</b>",
+        "<i>#{exception.message}</i>",
+        # Custom message goes here if any
+        "\n<b>Backtrace</b>",
+        lines.map do
+        |file, line, method|
+          output = "#{file}:#{line} in `#{method}'"
+          TelegramAlerts.special_telegram_chars.each do |k, v|
+            output = output.gsub(k, v)
+          end
+          output
+        end,
+        "\n<b>Environment</b>",
+        " Env: #{host_name} server with ruby #{RUBY_VERSION}",
+        " Project: #{project_name}",
+        " Path: #{project_path}",
+        "\n<i>#{now.strftime('%H:%M:%S %d-%m-%Y')}</i>",
+        "\n<i>#{now.strftime('%z')} #{ENV['TZ']}</i>"
+      ]
+
+      formatted_message.insert(3, "<i>#{message}</i>") unless message.nil?
+
+      return formatted_message.join("\n")
+    end
+
+  end
+end

data/sig/telegram_alerts.rbs

@@ -0,0 +1,4 @@
+module TelegramAlerts
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/telegram_alerts.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative 'lib/telegram_alerts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'telegram_alerts'
+  spec.version       = TelegramAlerts::VERSION
+  spec.authors       = ['mikael']
+  spec.email         = ['mikael.santilio@gmail.com']
+
+  spec.summary       = 'Telegram Alerts'
+  spec.description   = 'A Ruby gem that allows you to receive notifications about exceptions and alerts in your Ruby applications through Telegram.'
+  spec.homepage      = 'https://github.com/MikaelSantilio/telegram_alerts'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/MikaelSantilio/telegram_alerts'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: telegram_alerts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mikael
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-02-04 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby gem that allows you to receive notifications about exceptions
+  and alerts in your Ruby applications through Telegram.
+email:
+- mikael.santilio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/telegram_alerts.rb
+- lib/telegram_alerts/version.rb
+- sig/telegram_alerts.rbs
+- telegram_alerts.gemspec
+homepage: https://github.com/MikaelSantilio/telegram_alerts
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/MikaelSantilio/telegram_alerts
+  source_code_uri: https://github.com/MikaelSantilio/telegram_alerts
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Telegram Alerts
+test_files: []