telegram-support-bot 0.1.03

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d61645170c11693b5022efec80d4a7e439ab8378c377ed010d121c0429518be
+  data.tar.gz: 565dc25a57ed67dbd428c79b8e08bc7682a537d9ba467f918f646ff03db412a2
+SHA512:
+  metadata.gz: d17862439a4fb473284529a3420e69e47ab114418b4b166bdb77bcef4dbc578e25b1fbe768f87c3e9c53be566145221322c04e4eee2b4c83d26d2fb5b458c8b3
+  data.tar.gz: 296405e4807e520564eb679086343c8b1f45e95c1148911b37a9a16157e8a6333f71e949912ac1b4568e62d6fc2f4a302212fa0b4d9b9a1268e1d56e1fa52a69

data/.idea/workspace.xml

@@ -0,0 +1,151 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AutoImportSettings">
+    <option name="autoReloadType" value="SELECTIVE" />
+  </component>
+  <component name="ChangeListManager">
+    <list default="true" id="edf498b0-8552-42f1-846d-0c79d29ff991" name="Changes" comment="">
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/Gemfile" beforeDir="false" afterPath="$PROJECT_DIR$/Gemfile" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/telegram_support_bot/adapters/telegram_bot_adapter.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/telegram_support_bot/adapters/telegram_bot_adapter.rb" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/spec/telegram_support_bot/adapters/telegram_bot_adapter_spec.rb" beforeDir="false" afterPath="$PROJECT_DIR$/spec/telegram_support_bot/adapters/telegram_bot_adapter_spec.rb" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="FileTemplateManagerImpl">
+    <option name="RECENT_TEMPLATES">
+      <list>
+        <option value="Minitest Spec" />
+      </list>
+    </option>
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectColorInfo">{
+  &quot;associatedIndex&quot;: 4
+}</component>
+  <component name="ProjectId" id="2ciiVgDyGIIwTjG6xCPIunFNdqZ" />
+  <component name="ProjectLevelVcsManager">
+    <ConfirmationsSetting value="2" id="Add" />
+  </component>
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "DefaultRubyCreateTestTemplate": "Minitest Spec",
+    "RSpec.Unnamed.executor": "Run",
+    "Ruby.scratch_61.executor": "Run",
+    "RunOnceActivity.OpenProjectViewOnStart": "true",
+    "RunOnceActivity.ShowReadmeOnStart": "true",
+    "git-widget-placeholder": "main",
+    "last_opened_file_path": "/home/max/code/gems/telegram_support_bot",
+    "node.js.detected.package.eslint": "true",
+    "node.js.detected.package.tslint": "true",
+    "node.js.selected.package.eslint": "(autodetect)",
+    "node.js.selected.package.tslint": "(autodetect)",
+    "nodejs_package_manager_path": "npm",
+    "ruby.structure.view.model.defaults.configured": "true",
+    "settings.editor.selected.configurable": "org.jetbrains.plugins.ruby.settings.RubyActiveModuleSdkConfigurable",
+    "vue.rearranger.settings.migration": "true"
+  },
+  "keyToStringList": {
+    "com.intellij.ide.scratch.ScratchImplUtil$2/New Scratch File": [
+      "ruby"
+    ]
+  }
+}]]></component>
+  <component name="RecentsManager">
+    <key name="CopyFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/spec/telegram_support_bot/adapters" />
+      <recent name="$PROJECT_DIR$/spec/support" />
+      <recent name="$PROJECT_DIR$/spec" />
+      <recent name="$PROJECT_DIR$/lib/telegram_support_bot" />
+      <recent name="$PROJECT_DIR$/lib/telegram_support_bot/adapters" />
+    </key>
+  </component>
+  <component name="RunManager" selected="Ruby.scratch_61">
+    <configuration name="Unnamed" type="RSpecRunConfigurationType" factoryName="RSpec" nameIsGenerated="true">
+      <module name="telegram_support_bot" />
+      <predefined_log_file enabled="true" id="RUBY_RSPEC" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="WORK DIR" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SHOULD_USE_SDK" VALUE="false" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="ALTERN_SDK_NAME" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="myPassParentEnvs" VALUE="true" />
+      <EXTENSION ID="BundlerRunConfigurationExtension" BUNDLE_MODE="AUTO" bundleExecEnabled="true" />
+      <EXTENSION ID="RubyCoverageRunConfigurationExtension" track_test_folders="true" runner="rcov" ENABLE_BRANCH_COVERAGE="true" ENABLE_FORKED_COVERAGE="true">
+        <COVERAGE_PATTERN ENABLED="true">
+          <PATTERN REGEXPS="/.rvm/" INCLUDED="false" />
+        </COVERAGE_PATTERN>
+      </EXTENSION>
+      <EXTENSION ID="org.jetbrains.plugins.ruby.rails.run.RailsRunConfigurationExtension" SCRATCH_USE_RAILS_RUNNER="false" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TESTS_FOLDER_PATH" VALUE="$MODULE_DIR$/spec" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATHS" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_RUNNER_PATH" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="**/*_spec.rb" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_EXAMPLE_NAME" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="USE_EXAMPLE_MATCHES" VALUE="false" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="LINE_NUMBER_EXAMPLE_IDS" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="ALL_IN_FOLDER" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPEC_ARGS" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="RUNNER_VERSION" VALUE="" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="USE_CUSTOM_SPEC_RUNNER" VALUE="false" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="DRB" VALUE="false" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="ZEUS" VALUE="false" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="SPRING" VALUE="false" />
+      <RSPEC_RUN_CONFIG_SETTINGS_ID NAME="FULL_BACKTRACE" VALUE="false" />
+      <method v="2" />
+    </configuration>
+    <configuration name="scratch_61" type="RubyRunConfigurationType" factoryName="Ruby" temporary="true">
+      <RUBY_RUN_CONFIG NAME="RUBY_ARGS" VALUE="" />
+      <RUBY_RUN_CONFIG NAME="WORK DIR" VALUE="$PROJECT_DIR$" />
+      <RUBY_RUN_CONFIG NAME="SHOULD_USE_SDK" VALUE="false" />
+      <RUBY_RUN_CONFIG NAME="ALTERN_SDK_NAME" VALUE="" />
+      <RUBY_RUN_CONFIG NAME="myPassParentEnvs" VALUE="true" />
+      <EXTENSION ID="BundlerRunConfigurationExtension" BUNDLE_MODE="AUTO" bundleExecEnabled="true" />
+      <EXTENSION ID="org.jetbrains.plugins.ruby.rails.run.RailsRunConfigurationExtension" SCRATCH_USE_RAILS_RUNNER="false" />
+      <RUBY_RUN_CONFIG NAME="SCRIPT_PATH" VALUE="$APPLICATION_CONFIG_DIR$/scratches/scratch_61.rb" />
+      <RUBY_RUN_CONFIG NAME="SCRIPT_ARGS" VALUE="" />
+      <method v="2" />
+    </configuration>
+    <list>
+      <item itemvalue="RSpec.Unnamed" />
+      <item itemvalue="Ruby.scratch_61" />
+    </list>
+    <recent_temporary>
+      <list>
+        <item itemvalue="Ruby.scratch_61" />
+      </list>
+    </recent_temporary>
+  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="SpringUtil" SPRING_PRE_LOADER_OPTION="true" RAKE_SPRING_PRE_LOADER_OPTION="true" RAILS_SPRING_PRE_LOADER_OPTION="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="edf498b0-8552-42f1-846d-0c79d29ff991" name="Changes" comment="" />
+      <created>1708600824931</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1708600824931</updated>
+      <workItem from="1708600827139" duration="10157000" />
+      <workItem from="1708784534887" duration="682000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+  <component name="com.intellij.coverage.CoverageDataManagerImpl">
+    <SUITE FILE_PATH="coverage/telegram_support_bot@Unnamed.rcov" NAME="Unnamed Coverage Results" MODIFIED="1708610177774" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="rcov" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="" MODULE_NAME="telegram_support_bot" />
+  </component>
+</project>

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at max@buslaev.net. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in telegram-support-bot.gemspec
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.0"
+  gem 'pry'
+  gem 'amazing_print'
+  gem 'telegram-bot'
+  gem 'telegram-bot-types'
+  # gem 'telegram-bot-ruby'
+end
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Max Buslaev
+
+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,60 @@
+# 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.
+
+## 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
+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`.
+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.
+
+```ruby
+TelegramSupportBot.configure do |config|
+  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.
+
+### Adapters
+`TelegramSupportBot` supports integration through adapters. Currently, `telegram-bot` is supported with plans to add `telegram-bot-ruby`.
+
+#### 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).
+
+## 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).

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/lib/telegram_support_bot/adapter_factory.rb

@@ -0,0 +1,22 @@
+# lib/telegram_support_bot/adapter_factory.rb
+module TelegramSupportBot
+  module AdapterFactory
+    ADAPTERS = {
+      telegram_bot: 'TelegramSupportBot::Adapters::TelegramBot',
+      telegram_bot_ruby: 'TelegramSupportBot::Adapters::TelegramBotRuby'
+      # Add more predefined adapters here
+    }.freeze
+
+    def self.build(adapter_specification, adapter_options = {})
+      case adapter_specification
+      when Symbol
+        adapter_class = ADAPTERS[adapter_specification].constantize
+        adapter_class.new(adapter_options)
+      when Class
+        adapter_specification.new(adapter_options)
+      else
+        raise ArgumentError, "Unsupported adapter specification: #{adapter_specification}"
+      end
+    end
+  end
+end

data/lib/telegram_support_bot/adapters/base.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module TelegramSupportBot
+  module Adapters
+    class Base
+      attr_reader :bot
+
+      def initialize(**options)
+        @options = options
+        setup(options)
+      end
+
+      def setup(options)
+        # Setup based on options, to be overridden by child classes if necessary
+      end
+
+      def send_message(chat_id:, text:)
+        # Implementation using the telegram-bot gem
+      end
+
+      def send_media(chat_id:, type:, media:, **options)
+        # send photos, videos, documents
+      end
+
+      def forward_message(from_chat_id:, chat_id:, message_id:)
+        # forward messages to the support chat
+      end
+
+      def on_message(&block)
+        # Implementation to register a block to be called on new messages
+      end
+    end
+  end
+end
+

data/lib/telegram_support_bot/adapters/telegram_bot.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module TelegramSupportBot
+  module Adapters
+    class TelegramBot < Base
+
+      def initialize(**options)
+        super
+        @bot = Telegram::Bot::Client.new(@options[:token], @options[:username])
+      end
+
+      def send_message(chat_id:, text:, **options)
+        @bot.send_message(chat_id: chat_id, text: text, **options)
+      end
+
+      def send_photo(chat_id:, photo:, **options)
+        @bot.send_photo(chat_id: chat_id, photo: photo, **options)
+      end
+
+      def send_video(chat_id:, video:, **options)
+        @bot.send_video(chat_id: chat_id, video: video, **options)
+      end
+
+      def send_document(chat_id:, document:, **options)
+        @bot.send_document(chat_id: chat_id, document: document, **options)
+      end
+
+      # Handles sending audio messages
+      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)
+      end
+
+      # Handles sending sticker messages
+      def send_sticker(chat_id:, sticker:, **options)
+        @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,
+          from_chat_id: from_chat_id,
+          message_id:   message_id
+        )
+      end
+    end
+  end
+end

data/lib/telegram_support_bot/adapters/telegram_bot_ruby.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module TelegramSupportBot
+  module Adapters
+    class TelegramBotRuby
+    end
+  end
+end

data/lib/telegram_support_bot/auto_away_scheduler.rb

@@ -0,0 +1,54 @@
+module TelegramSupportBot
+  class AutoAwayScheduler
+    def initialize(adapter, configuration)
+      @adapter = adapter
+      @configuration = configuration
+      @scheduled_tasks = {}
+    end
+
+    def schedule_auto_away_message(user_message_id, chat_id)
+      # Cancel any existing scheduled task for this message to avoid duplicate messages
+      cancel_scheduled_task(user_message_id)
+
+      # Only proceed if auto-away is configured
+      auto_away_interval = @configuration.auto_away_interval || 60
+
+      # Immediately store the thread object in the hash to mark this message ID as scheduled
+      @scheduled_tasks[user_message_id] = Thread.new do
+        sleep(auto_away_interval) # Wait for the specified interval
+
+        # After waking up, check if the task is still relevant
+        if @scheduled_tasks[user_message_id]
+          send_auto_away_message(chat_id)
+          notify_support_chat
+
+          # Once the auto-away message has been sent, remove this task from the schedule
+          @scheduled_tasks.delete(user_message_id)
+        end
+      end
+    end
+
+
+    def cancel_scheduled_task(user_message_id)
+      if task = @scheduled_tasks[user_message_id]
+        task.kill # Terminate the scheduled thread
+        @scheduled_tasks.delete(user_message_id)
+      end
+    end
+
+    private
+
+    def send_auto_away_message(chat_id)
+      auto_away_message = @configuration.auto_away_message
+      @adapter.send_message(chat_id: chat_id, text: auto_away_message)
+    end
+
+    def notify_support_chat
+      @adapter.send_message(
+        chat_id: @configuration.support_chat_id,
+        text: 'Auto-away message has been sent to user: "'+@configuration.auto_away_message+'"',
+      )
+
+    end
+  end
+end

data/lib/telegram_support_bot/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TelegramSupportBot
+  class Configuration
+    attr_accessor :adapter, :adapter_options, :support_chat_id, :welcome_message,
+                  :auto_away_message, :auto_away_interval
+
+    def initialize
+      @adapter            = :telegram_bot
+      @adapter_options    = {}
+      @welcome_message    = 'Welcome! How can we help you?'
+      @auto_away_interval = 10 # seconds
+      @auto_away_message  = 'We are sorry, all operators are busy at the moment. Please wait'
+    end
+  end
+end

data/lib/telegram_support_bot/version.rb

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

data/lib/telegram_support_bot.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require_relative "telegram_support_bot/version"
+require_relative 'telegram_support_bot/configuration'
+require_relative 'telegram_support_bot/auto_away_scheduler'
+require_relative 'telegram_support_bot/adapter_factory'
+require_relative 'telegram_support_bot/adapters/base'
+require_relative 'telegram_support_bot/adapters/telegram_bot'
+require_relative 'telegram_support_bot/adapters/telegram_bot_ruby'
+
+module TelegramSupportBot
+  class << self
+    attr_accessor :configuration
+    attr_reader :message_chat_id
+
+    # Provides a method to configure the gem.
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+
+    # Lazily builds and returns the adapter based on the current configuration.
+    # This method initializes the adapter when it's first called.
+    def adapter
+      @adapter ||= AdapterFactory.build(configuration.adapter, configuration.adapter_options)
+    end
+
+    def scheduler
+      @scheduler ||= AutoAwayScheduler.new(adapter, configuration)
+    end
+
+    def process_update(update)
+      # Handle different types of updates
+      if update['message']
+        # Process standard messages
+        process_message(update['message'])
+      elsif update['my_chat_member']
+        # Handle the bot being added to or removed from a chat
+        handle_my_chat_member_update(update['my_chat_member'])
+        # Add other update types as needed
+      else
+        # Log or handle unknown update types
+        puts "Received an unknown type of update: #{update}"
+      end
+    end
+
+    private
+
+    def process_message(message)
+      @message_chat_id = message['chat']['id']
+      ap message
+
+      if message_chat_id == configuration.support_chat_id
+        process_support_chat_message(message)
+      else
+        # Message is from an individual user, forward it to the support chat
+        if message['text'] == '/start'
+          # Send welcome message to the user
+          adapter.send_message(chat_id: message_chat_id, text: configuration.welcome_message)
+        else
+          forward_message_to_support_chat(message)
+        end
+      end
+    end
+
+    def process_support_chat_message(message)
+      if message.key?('reply_to_message')
+        # It's a reply in the support chat
+        process_reply_in_support_chat(message)
+      elsif message['text']&.start_with?('/')
+        process_command(message)
+      else
+        # For non-command messages, you might want to handle differently or just ignore
+        # For now, let's just acknowledge the message
+        acknowledge_non_command_message(message)
+      end
+    end
+
+    def acknowledge_non_command_message(message)
+      reply_message = 'I received your message, but I only respond to commands. Please use /start to get started.'
+      adapter.send_message(
+        chat_id:             message_chat_id,
+        text:                reply_message,
+        reply_to_message_id: message['message_id']
+      )
+    end
+
+    def process_command(message)
+      command = message['text'].split(/[ \@]/).first.downcase # Extract the command, normalize to lowercase
+
+      case command
+      when '/start'
+        send_welcome_message(chat_id: message_chat_id)
+      else
+        # Respond to unknown commands
+        unknown_command_response = "I don't know the command #{command}. Please use /start to begin or check the available commands."
+        adapter.send_message(chat_id: message_chat_id, text: unknown_command_response)
+      end
+    end
+
+    def process_reply_in_support_chat(message)
+      reply_to_message = message['reply_to_message']
+
+      if reply_to_message.key?('forward_from')
+        # The reply is to a forwarded message
+        original_user_id = reply_to_message['forward_from']['id']
+        caption          = message['caption'] if message.key?('caption')
+
+        # Determine the type of media and prepare the content and options
+        type, media, options = extract_media_info(message)
+        options[:caption]    = caption if caption
+
+        message_id = message['message_id']
+        if :unknown == type
+          # Handle other types of messages or default case
+          warning_message = "Warning: The message type received from the user is not supported by the bot. Please assist the user directly."
+          adapter.send_message(
+            chat_id:             configuration.support_chat_id,
+            text:                warning_message,
+            reply_to_message_id: message_id
+          )
+        else
+          adapter.send_media(chat_id: original_user_id, type: type, media: media, **options)
+          # scheduler.cancel_scheduled_task(message_id)
+        end
+      end
+    end
+
+    def extract_media_info(message)
+      if message.key?('text')
+        [:text, message['text'], { entities: message.fetch('entities', []) }]
+      elsif message.key?('photo')
+        photo = message['photo'].last # Assuming you want to send the highest quality photo
+        [:photo, photo['file_id'], {}]
+      elsif message.key?('video')
+        [:video, message['video']['file_id'], {}]
+      elsif message.key?('video_note')
+        [:video, message['video_note']['file_id'], {}]
+      elsif message.key?('document')
+        [:document, message['document']['file_id'], {}]
+      elsif message.key?('audio')
+        [:audio, message['audio']['file_id'], {
+          duration:  message['audio'].fetch('duration', 0),
+          performer: message['audio'].fetch('performer', ''),
+          title:     message['audio'].fetch('title', '')
+        }]
+      elsif message.key?('voice')
+        [:voice, message['voice']['file_id'], {}]
+      elsif message.key?('sticker')
+        [:sticker, message['sticker']['file_id'], {}]
+      else
+        [:unknown, "This type of message is not supported.", {}]
+      end
+    end
+
+    def forward_message_to_support_chat(message)
+      message_id = message['message_id']
+      adapter.forward_message(
+        from_chat_id: message_chat_id,
+        message_id:   message_id,
+        chat_id:      configuration.support_chat_id)
+      # scheduler.schedule_auto_away_message(message_id, message_chat_id)
+    end
+
+    def handle_my_chat_member_update(update)
+      # Check if the bot has been added to the chat
+      if update['new_chat_member']
+        chat_id = update['chat']['id']
+        send_welcome_message(chat_id: chat_id)
+      end
+    end
+
+    def send_welcome_message(chat_id:)
+      welcome_text = "Hello! Thank you for adding me to your chat. To configure your system, please use the following support chat ID: <code>#{chat_id}</code>."
+      adapter.send_message(chat_id: chat_id, text: welcome_text, parse_mode: 'HTML')
+    end
+
+  end
+
+  # Reset the adapter instance (useful for testing or reconfiguration).
+  def self.reset_adapter!
+    @adapter = nil
+  end
+end
+

data/sig/telegram_support_bot.rbs

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

data/telegram_support_bot.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/telegram_support_bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'telegram-support-bot'
+  spec.version = TelegramSupportBot::VERSION
+  spec.authors = ['Max Buslaev']
+  spec.email = ['max@buslaev.net']
+
+  spec.summary = 'A Rails gem for integrating a Telegram bot into your application for seamless
+support desk functionality.'
+  spec.description = 'The telegram_support_bot gem provides Rails applications with an
+easy-to-integrate Telegram bot, designed to enhance customer support services.
+By leveraging this gem, developers can swiftly add a Telegram-based support desk to their
+application, enabling direct communication between users and support agents through Telegram.
+Features include automatic message forwarding to a designated secret chat for support agents,
+the ability to reply directly from the secret chat to users, and customizable responses
+for common queries. This gem simplifies the process of setting up a robust support channel on one of
+the most popular messaging platforms, making it an ideal solution for businesses looking to improve
+their customer service experience.'
+  spec.homepage = 'https://github.com/austerlitz/telegram_support_bot'
+  spec.license = 'MIT'
+  # spec.required_ruby_version = '>= 2.6.0'
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: telegram-support-bot
+version: !ruby/object:Gem::Version
+  version: 0.1.03
+platform: ruby
+authors:
+- Max Buslaev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-02-25 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  The telegram_support_bot gem provides Rails applications with an
+  easy-to-integrate Telegram bot, designed to enhance customer support services.
+  By leveraging this gem, developers can swiftly add a Telegram-based support desk to their
+  application, enabling direct communication between users and support agents through Telegram.
+  Features include automatic message forwarding to a designated secret chat for support agents,
+  the ability to reply directly from the secret chat to users, and customizable responses
+  for common queries. This gem simplifies the process of setting up a robust support channel on one of
+  the most popular messaging platforms, making it an ideal solution for businesses looking to improve
+  their customer service experience.
+email:
+- max@buslaev.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/workspace.xml"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/telegram_support_bot.rb
+- lib/telegram_support_bot/adapter_factory.rb
+- lib/telegram_support_bot/adapters/base.rb
+- lib/telegram_support_bot/adapters/telegram_bot.rb
+- lib/telegram_support_bot/adapters/telegram_bot_ruby.rb
+- lib/telegram_support_bot/auto_away_scheduler.rb
+- lib/telegram_support_bot/configuration.rb
+- lib/telegram_support_bot/version.rb
+- sig/telegram_support_bot.rbs
+- telegram_support_bot.gemspec
+homepage: https://github.com/austerlitz/telegram_support_bot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A Rails gem for integrating a Telegram bot into your application for seamless
+  support desk functionality.
+test_files: []