telegrama 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df42e5f329649ab529e46515818ec4ddce70388341455cd383a03b9852c84233
-  data.tar.gz: 1c7411979c5d2376aaa0b9307cde1e51f380548b86fa76ba04025f8e8f39b434
+  metadata.gz: 973c12ff30ac29dd071ec63827d398756de990ab574bf9e18011a1509b7d4d4c
+  data.tar.gz: ab22a8f8eb8b3805be54f454b35b804495b5a3b3a6c56a024d8e236c463a7a99
 SHA512:
-  metadata.gz: e936c11b1532985345a06ee0724110f653dcaa621f2250f31c1ae74d59940471107e6022f3ba0887cc389c958fd33eb4e4a0d7cb2cb26245fb7ce098f8527fb8
-  data.tar.gz: 9bcbd009525da8d7cec77effb0cad2791da32beb2806bb321aaeedba73f94f1ffa3f34e89d1ee7e9d7ed29e583682be9c9d7297ed4ffdc974a48c3d1926d431f
+  metadata.gz: 05d3a61ba2149a9a90f4d1e8d7180770baafc857b26403770c27ee1894c09f685f36bd65c3e5f15ad404648f035c9812691b1619652bd8d3cb6db7fccae51a69
+  data.tar.gz: a8708abb6978b2ba6165d16a30c5c8dbc6bd2f18ab78f9eed3bf6e20141c3ef88e27587135a53e6b11257c111f5dcf5d22b2544bc88a45df86a563262ebcbd41

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.1.2] - 2025-02-19
+
+- Added optional message prefix and suffix configuration
+
 ## [0.1.1] - 2025-02-18
 
 - Rebranded `telegrams` to `telegrama`

data/README.md

@@ -1,16 +1,56 @@
 # 💬 `telegrama` – a tiny wrapper to send admin Telegram messages
 
-[![Gem Version](https://badge.fury.io/rb/telegrama.svg?v=0.1.0)](https://badge.fury.io/rb/telegrama?v=0.1.0)
+[![Gem Version](https://badge.fury.io/rb/telegrama.svg?v=0.1.1)](https://badge.fury.io/rb/telegrama?v=0.1.1)
 
 Send quick, simple admin / logging Telegram messages via a Telegram bot.
 
-I'm making this gem because I'm tired of copy-pasting the same Telegram wrapper from Rails project to Rails project just to send myself admin messages and notifications. The goal with this gem is to provide a straightforward, minimal API to send Telegram messages reliably. All I want to do is this:
+Useful for Rails developers using Telegram messages for notifications, admin alerts, errors, logs, daily summaries, and status updates, like:
 
 ```ruby
 Telegrama.send_message("Important admin notification!")
 ```
 
-This is useful for Rails developers using Telegram messages for notifications, admin alerts, errors, logs, daily summaries, and status updates.
+I use it all the time to alert me of new sales, important notifications, and daily summaries, like this:
+
+> 💸 **New sale!**
+> 
+> joh...e@gmail.com paid **$49.99** for Business Plan.
+> 
+> 📈 MRR: $12,345
+> 
+> 📈 Total customers: 1,234
+> 
+> [🔗 View purchase details](https://example.com/admin/subscriptions/123)
+
+Which is a beautifully formatted message you'll in Telegram with only this:
+
+```ruby
+message = <<~MSG
+  💸 *New sale\!* 
+  
+  #{customer.email} paid *$#{amount}* for #{product.name}\.
+  
+  📈 MRR: $#{Profitable.mrr}
+  📈 Total customers: $#{Profitable.total_customers}
+  
+  [🔗 View purchase details](#{admin_subscription_url(subscription)})
+MSG
+
+Telegrama.send_message(message, formatting: { obfuscate_emails: true })
+```
+
+Note how the email gets redacted automatically to avoid leaking personal information (`john.doe@gmail.com` -> `joh...e@gmail.com`)
+
+The gem sanitizes weird characters, you can also escape Markdown, HTML, etc.
+
+For the MRR and revenue metrics you can use my gem [`profitable`](https://github.com/rameerez/profitable); and if you have different group chats for marketing, management, etc. you can send different messages with different information to each of them:
+
+```ruby
+Telegrama.send_message(a_general_message, chat_id: general_chat_id)
+Telegrama.send_message(marketing_message, chat_id: marketing_chat_id)
+```
+
+The goal with this gem is to provide a straightforward, no-frills, minimal API to send Telegram messages reliably for admin purposes, without you having to write your own wrapper over the Telegram API.
 
 ## Quick start
 
@@ -34,6 +74,10 @@ Telegrama.configure do |config|
   config.chat_id   = Rails.application.credentials.dig(Rails.env.to_sym, :telegram, :chat_id)
   config.default_parse_mode = 'MarkdownV2'
   
+  # Optional prefix/suffix for all messages (useful to identify messages from different apps or environments)
+  config.message_prefix = nil  # Will be prepended to all messages if set
+  config.message_suffix = nil  # Will be appended to all messages if set
+  
   # Default formatting options
   config.formatting_options = {
     escape_markdown: true,    # Escape markdown special characters
@@ -65,6 +109,43 @@ Sometimes you want to report user actions including a sufficiently identifiable
 
 You can pass an options hash to `Telegrama.send_message` to override default behavior on a per‑message basis:
 
+### Message Prefix and Suffix
+
+You may have multiple applications sending messages to the same Telegram group chat, and it can be hard to identify which message came from which application. Using message prefixes and suffixes, you can easily label messages from different sources:
+
+```ruby
+# Label which environment this message is coming from
+config.message_prefix = "[#{Rails.env}] \n"
+
+# Or for different applications:
+config.message_prefix = "[🛍️ Shop App] \n"
+config.message_suffix = "\n--\nSent from Shop App"
+
+config.message_prefix = "[📊 Analytics] \n"
+config.message_suffix = "\n--\nSent from Analytics"
+```
+
+This way, when multiple applications send messages to the same chat, you'll see:
+```
+[🛍️ Shop App] 
+New order received: $99.99
+--
+Sent from Shop App
+
+[📊 Analytics] 
+Daily Report: 150 new users today
+--
+Sent from Analytics
+```
+
+Both `message_prefix` and `message_suffix` are optional and can be used independently. They're particularly useful for:
+- Distinguishing between staging and production environments
+- Identifying messages from different microservices
+- Adding environment-specific tags or warnings
+- Including standardized footers or timestamps
+
+### `send_message` options
+
 - **`chat_id`**
   *Override the default chat ID set in your configuration.*
   **Usage Example:**

data/lib/telegrama/configuration.rb

@@ -16,6 +16,12 @@ module Telegrama
     # Whether to disable web page previews by default.
     attr_accessor :disable_web_page_preview
 
+    # Optional prefix to prepend to all messages (e.g. "[MyApp] \n")
+    attr_accessor :message_prefix
+
+    # Optional suffix to append to all messages (e.g. "\n-- Sent from MyApp")
+    attr_accessor :message_suffix
+
     # =========================================
     # Formatting Options
     # =========================================
@@ -45,6 +51,10 @@ module Telegrama
       @default_parse_mode = 'MarkdownV2'
       @disable_web_page_preview = true
 
+      # Message prefix/suffix defaults to nil (no prefix/suffix)
+      @message_prefix = nil
+      @message_suffix = nil
+
       # Sensible defaults for formatting options.
       @formatting_options = {
         escape_markdown: true,

data/lib/telegrama/formatter.rb

@@ -2,7 +2,7 @@ module Telegrama
   module Formatter
     MARKDOWN_SPECIAL_CHARS = %w[_ * [ ] ( ) ~ ` > # + - = | { } . !].freeze
     # Characters that should always be escaped in Telegram messages, even when Markdown is enabled
-    ALWAYS_ESCAPE_CHARS = %w[. !].freeze
+    ALWAYS_ESCAPE_CHARS = %w[. ! -].freeze
     # Characters used for Markdown formatting that need special handling
     MARKDOWN_FORMAT_CHARS = %w[* _].freeze
 
@@ -12,6 +12,14 @@ module Telegrama
       opts = defaults.merge(options)
 
       text = text.to_s
+
+      # Apply prefix and suffix if configured
+      prefix = Telegrama.configuration.message_prefix
+      suffix = Telegrama.configuration.message_suffix
+
+      text = "#{prefix}#{text}" if prefix
+      text = "#{text}#{suffix}" if suffix
+
       text = obfuscate_emails(text) if opts[:obfuscate_emails]
       text = escape_html(text)    if opts[:escape_html]
       if opts[:escape_markdown]
@@ -21,6 +29,7 @@ module Telegrama
         text = escape_special_chars(text)
       end
       text = truncate(text, opts[:truncate]) if opts[:truncate]
+
       text
     end
 

data/lib/telegrama/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telegrama
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: telegrama
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Javi R
 bindir: exe
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 2025-02-19 00:00:00.000000000 Z
 dependencies: []
 description: Send quick, simple admin / logging Telegram messages via a Telegram bot.
   Useful for Rails developers using Telegram messages for notifications, admin alerts,