telegram-support-bot 0.1.03 → 0.1.04

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d61645170c11693b5022efec80d4a7e439ab8378c377ed010d121c0429518be
-  data.tar.gz: 565dc25a57ed67dbd428c79b8e08bc7682a537d9ba467f918f646ff03db412a2
+  metadata.gz: 7136195dca0f9287a9534c5ef4004610d897a4b1033e5a45505826e472c927d8
+  data.tar.gz: 80556619e8db83f143d445df3ffb033d3f72838bb5bb69d4182c8379c441e522
 SHA512:
-  metadata.gz: d17862439a4fb473284529a3420e69e47ab114418b4b166bdb77bcef4dbc578e25b1fbe768f87c3e9c53be566145221322c04e4eee2b4c83d26d2fb5b458c8b3
-  data.tar.gz: 296405e4807e520564eb679086343c8b1f45e95c1148911b37a9a16157e8a6333f71e949912ac1b4568e62d6fc2f4a302212fa0b4d9b9a1268e1d56e1fa52a69
+  metadata.gz: d40c42dcca1f66a0a3c9fb9d563371699969a26a58d6719b49097c53f645aec5af86c5d1794a04d8e69cb0f90bb4e46cfeab8b3f1e2d74137c4dd0701b7e2350
+  data.tar.gz: 2c5b4fd82fa459cb6f8aed6004af0f7f2fff1a7958b32e3f947b7be45a965b5d445a5a00b52c94c2a37887b91208fee213522c48146d690b590eb9bcf437de59

data/README.md

@@ -1,60 +1,138 @@
 # TelegramSupportBot
 
 ## Introduction
-`TelegramSupportBot` is a Ruby gem designed to enhance customer support through Telegram, allowing for the management of queries directly from a designated chat while ensuring privacy and confidentiality.
+
+`TelegramSupportBot` is a Ruby gem designed to enhance customer support through Telegram, allowing
+for the management of queries directly from a designated chat while ensuring privacy and
+confidentiality.
 
 ## Features
+
 - Forward messages between users and a support chat
 - Supports various message types (text, images, videos, documents, audio, stickers)
 - Auto-away messages for off-hours
 - Simple configuration and deployment
 
 ## Installation
+
 Add to your Gemfile:
+
 ```ruby
 gem 'telegram-support-bot'
 ```
 
 ## Usage
-### Webhook Integration
 
-#### Creating and Configuring Your Bot
+### Creating and Configuring Your Bot
+
 1. **Create Your Bot** via BotFather on Telegram to get your bot token.
-2. **Deploy Your Application** and set up a controller action for webhook callbacks, directing them to `TelegramSupportBot.process_update`.
+2. **Deploy Your Application** and set up a controller action for webhook callbacks, directing them
+   to `TelegramSupportBot.process_update`.
 3. **Set the Webhook URL** using the Telegram Bot API to your controller action.
 
-#### Setting Up Your Telegram Bot
-1. **Add Your Bot to a Support Chat** and obtain the `support_chat_id` by sending the `/start` command to the bot inside the support chat.
-2. **Configure Your Bot** in your Ruby application with the token and `support_chat_id`, and set a welcome message.
+### Setting Up Your Telegram Bot
+
+1. **Add Your Bot to a Support Chat** and obtain the `support_chat_id` by sending the `/start`
+   command to the bot inside the support chat.
+2. **Configure Your Bot** in your Ruby application with the token and `support_chat_id`, and set a
+   welcome message.
 
 ```ruby
 TelegramSupportBot.configure do |config|
-  config.adapter = :telegram_bot
+  config.adapter         = :telegram_bot
   config.adapter_options = { token: 'YOUR_TELEGRAM_BOT_TOKEN' }
   config.support_chat_id = 'YOUR_SUPPORT_CHAT_ID'
   config.welcome_message = 'Hi! How can we help you?'
 end
 ```
 
-3. **Interact with Users**: Messages to your bot will be forwarded to the support chat, and replies in the chat will be sent back to the users.
+3. **Interact with Users**: Messages to your bot will be forwarded to the support chat, and replies
+   in the chat will be sent back to the users.
+
+## Adapters
+
+`TelegramSupportBot` supports integration through adapters. Currently, `telegram-bot`
+and `telegram-bot-ruby` are supported.
+
+Configuration is pretty much the same for both gems:
+
+```ruby
+TelegramSupportBot.configure do |config|
+  config.adapter         = :telegram_bot
+  config.adapter_options = { token: 'YOUR_TELEGRAM_BOT_TOKEN' }
+end
+```
+
+```ruby
+TelegramSupportBot.configure do |config|
+  config.adapter         = :telegram_bot_ruby
+  config.adapter_options = { token: 'YOUR_TELEGRAM_BOT_TOKEN' }
+end
+```
+
+## Examples
 
-### Adapters
-`TelegramSupportBot` supports integration through adapters. Currently, `telegram-bot` is supported with plans to add `telegram-bot-ruby`.
+**Basically, just make sure you call `TelegramSupportBot.process_update` somewhere in you workflow
+cycle and pass it a parsed json update received from Telegram servers.**
+
+### Using `telegram-bot` Gem with a Webhook Controller
+
+If you're using the `telegram-bot` gem, set up a Rails controller to handle incoming webhook
+requests. Here's an example of how you might implement such a controller:
+
+```ruby
+
+class TelegramWebhooksController < ApplicationController
+
+  def webhook
+    update = JSON.parse(request.body.read)
+    TelegramSupportBot.process_update(update)
+    head :ok
+  end
+end
+```
+
+Make sure to configure your routes to direct webhook callbacks to this controller action.
+
+### Using `telegram-bot-ruby` Gem with bot.listen
+
+For those utilizing telegram-bot-ruby, you can set up a simple listener loop to process incoming
+messages. This approach is more suited for polling rather than webhooks:
+require 'telegram/bot'
+
+```ruby
+token = 'YOUR_TELEGRAM_BOT_TOKEN'
+
+Telegram::Bot::Client.run(token) do |bot|
+  bot.listen do |message|
+    TelegramSupportBot.process_update(update.to_h)
+  end
+end
+```
+
+## Custom Adapter Implementation
+
+Implement custom adapters by inheriting from `TelegramSupportBot::Adapter::Base` and defining
+message sending and forwarding methods.
 
-#### Custom Adapter Implementation
-Implement custom adapters by inheriting from `TelegramSupportBot::Adapter::Base` and defining message sending and forwarding methods.
 
 ## Development
+
 - Run `bin/setup` to install dependencies.
 - Use `rake spec` for tests and `bin/console` for an interactive prompt.
 - To install locally, use `bundle exec rake install`.
 - For releases, update `version.rb`, and run `bundle exec rake release`.
 
 ## Contributing
-Contributions are welcome via GitHub, adhering to the [code of conduct](https://github.com/austerlitz/telegram_support_bot/blob/main/CODE_OF_CONDUCT.md).
+
+Contributions are welcome via GitHub, adhering to
+the [code of conduct](https://github.com/austerlitz/telegram_support_bot/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
+
 Available under the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
-Follow the project's [code of conduct](https://github.com/austerlitz/telegram_support_bot/blob/main/CODE_OF_CONDUCT.md).
+
+Follow the
+project's [code of conduct](https://github.com/austerlitz/telegram_support_bot/blob/main/CODE_OF_CONDUCT.md).

data/lib/telegram_support_bot/adapters/base.rb

@@ -3,6 +3,7 @@
 module TelegramSupportBot
   module Adapters
     class Base
+
       attr_reader :bot
 
       def initialize(**options)
@@ -19,7 +20,15 @@ module TelegramSupportBot
       end
 
       def send_media(chat_id:, type:, media:, **options)
-        # send photos, videos, documents
+        method = "send_#{type}"
+        args = { chat_id: chat_id, **options }
+        args[type] = media
+
+        if respond_to?(method, true)
+          send(method, **args)
+        else
+          raise ArgumentError, "Unsupported media type: #{type}"
+        end
       end
 
       def forward_message(from_chat_id:, chat_id:, message_id:)

data/lib/telegram_support_bot/adapters/telegram_bot.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'telegram/bot'
 module TelegramSupportBot
   module Adapters
     class TelegramBot < Base
@@ -13,6 +14,8 @@ module TelegramSupportBot
         @bot.send_message(chat_id: chat_id, text: text, **options)
       end
 
+      alias_method :send_text, :send_message
+
       def send_photo(chat_id:, photo:, **options)
         @bot.send_photo(chat_id: chat_id, photo: photo, **options)
       end
@@ -29,6 +32,7 @@ module TelegramSupportBot
       def send_audio(chat_id:, audio:, **options)
         @bot.send_audio(chat_id: chat_id, audio: audio, **options)
       end
+
       # Handles sending audio messages
       def send_voice(chat_id:, voice:, **options)
         @bot.send_voice(chat_id: chat_id, voice: voice, **options)
@@ -39,30 +43,6 @@ module TelegramSupportBot
         @bot.send_sticker(chat_id: chat_id, sticker: sticker, **options)
       end
 
-      # New generic send_media method
-      def send_media(chat_id:, type:, media:, **options)
-        case type.to_sym
-        when :text
-          send_message(chat_id: chat_id, text: media, **options)
-        when :photo
-          send_photo(chat_id: chat_id, photo: media, **options)
-        when :video
-          send_video(chat_id: chat_id, video: media, **options)
-        when :video_note
-          send_video_note(chat_id: chat_id, video_note: media, **options)
-        when :document
-          send_document(chat_id: chat_id, document: media, **options)
-        when :audio
-          send_audio(chat_id: chat_id, audio: media, **options)
-        when :voice
-          send_voice(chat_id: chat_id, voice: media, **options)
-        when :sticker
-          send_sticker(chat_id: chat_id, sticker: media, **options)
-        else
-          raise ArgumentError, "Unsupported media type: #{type}"
-        end
-      end
-
       def forward_message(from_chat_id:, chat_id:, message_id:)
         @bot.forward_message(
           chat_id:      chat_id,

data/lib/telegram_support_bot/adapters/telegram_bot_ruby.rb

@@ -1,8 +1,48 @@
 # frozen_string_literal: true
 
+require 'telegram/bot'
 module TelegramSupportBot
   module Adapters
-    class TelegramBotRuby
+    class TelegramBotRuby < Base
+
+      def initialize(**options)
+        super
+        @bot = Telegram::Bot::Client.new(@options[:token])
+      end
+
+      def send_message(chat_id:, text:, **options)
+        bot.api.send_message(chat_id: chat_id, text: text, **options)
+      end
+
+      alias_method :send_text, :send_message
+
+      def send_photo(chat_id:, photo:, **options)
+        bot.api.send_photo(chat_id: chat_id, photo: photo, **options)
+      end
+
+      def send_video(chat_id:, video:, **options)
+        bot.api.send_video(chat_id: chat_id, video: video, **options)
+      end
+
+      def send_document(chat_id:, document:, **options)
+        bot.api.send_document(chat_id: chat_id, document: document, **options)
+      end
+
+      def send_audio(chat_id:, audio:, **options)
+        bot.api.send_audio(chat_id: chat_id, audio: audio, **options)
+      end
+
+      def send_voice(chat_id:, voice:, **options)
+        bot.api.send_voice(chat_id: chat_id, voice: voice, **options)
+      end
+
+      def send_sticker(chat_id:, sticker:, **options)
+        bot.api.send_sticker(chat_id: chat_id, sticker: sticker, **options)
+      end
+
+      def forward_message(from_chat_id:, chat_id:, message_id:)
+        bot.api.forward_message(chat_id: chat_id, from_chat_id: from_chat_id, message_id: message_id)
+      end
     end
   end
 end

data/lib/telegram_support_bot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TelegramSupportBot
-  VERSION = "0.1.03"
+  VERSION = "0.1.04"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telegram-support-bot
 version: !ruby/object:Gem::Version
-  version: 0.1.03
+  version: 0.1.04
 platform: ruby
 authors:
 - Max Buslaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies: []
 description: |-
   The telegram_support_bot gem provides Rails applications with an