RubyGems - max_bot_api - Versions diffs - 0.2.0 → 0.3.0 - Mend

max_bot_api 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

checksums.yaml +4 -4
data/README.md +25 -6
data/docs/02-listen-and-respond.md +1 -0
data/docs/04-keyboard.md +5 -0
data/docs/06-subscriptions.md +2 -0
data/docs/api/methods.md +59 -0
data/docs/api/objects.md +134 -0
data/docs/api/overview.md +73 -0
data/examples/keyboard.rb +4 -0
data/examples/webhook_rack.rb +4 -0
data/lib/max_bot_api/builders/keyboard_builder.rb +10 -0
data/lib/max_bot_api/builders/message_builder.rb +16 -1
data/lib/max_bot_api/client.rb +21 -0
data/lib/max_bot_api/resources/chats.rb +19 -0
data/lib/max_bot_api/resources/messages.rb +1 -0
data/lib/max_bot_api/version.rb +1 -1
metadata +5 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb9285c20da62a0c1fba896afde6af5fd10dff12079de7d44878f3cd4b3aea22
-  data.tar.gz: 11d42f73535db90bcbc32b89fa9886cc96d99222cca56e15ba3fb50eb4132ce8
+  metadata.gz: 97114d1ff6c7d35facca9459c0543540867c2d48c6235dd6bb204e47c31a75b3
+  data.tar.gz: e7dec618f4d73dae79c33e692478c9dc5c8b06fcc0d3f14949c1178083d15aa3
 SHA512:
-  metadata.gz: b10c0eb6c1bef5eedc551fc841cb65d43b65d4d43c28941cbbdf8bb85e0245b251b512b4a9b9f476ca859a189c1967e0ac81f9b09b225569bb66afffb70cfd02
-  data.tar.gz: 148837674accefde112f9e8195440bce6a7c6a9abd5b8243c87c076b6af72c9b1f148fe66a24104d0ecc3ac82e94011f8841ba3db900842dd8d58f183e895286
+  metadata.gz: 8fec44603bf0f56f43e865097608bc786a3549ffa6a754d87803eeb0ada8f6851a074d44469c1e9f9e8629d342af908d252d30e0c576a8d701649af7ffdb2022
+  data.tar.gz: 7ac3fe1abc5125e7e63d610506ddf100c77b47c40c5bfe5c50ead48eea04b14cd79fc8f2a86e8073ee82eaa8f85212fcf30b2adea1a8fdbdfd56a9ff9694a99c

data/README.md CHANGED Viewed

@@ -33,10 +33,10 @@ client.messages.send(
 ## Features
-- Full API coverage: Bots, Chats, Messages, Subscriptions, Uploads, Debugs.
+- Broad API coverage: Bots, Chats, Messages, Subscriptions, Uploads, Debugs.
 - Builder helpers for messages and keyboards.
 - Long polling updates with retry and backoff.
-- Webhook parsing helper.
+- Webhook parsing and secret validation helpers.
 - Upload helpers for files, photos, audio, video.
 ## Configuration
@@ -54,11 +54,10 @@ Notes:
 - The client uses `Authorization: <token>` (no `Bearer`).
 - Every request includes `v=<version>` query param.
-## 0.2.0 updates
+## Changelog
-- Default API host is now `https://platform-api.max.ru/` (override with `base_url:` if you need the legacy host).
-- Message send/edit retries automatically when the API responds with `attachment.not.ready`.
-- New helpers: `MessageBuilder#add_photo_by_token`, `KeyboardRowBuilder#add_message`.
+- See `CHANGELOG.md` for version-by-version release notes.
+- See `BREAKING_CHANGES_0.1.0_to_0.2.0.md` for the detailed `0.2.0` migration notes.
 Example:
@@ -125,9 +124,29 @@ end
 ```ruby
 body = request.body.read
+halt 401 unless client.webhook_secret_valid?(headers: request.env, secret: ENV.fetch("WEBHOOK_SECRET"))
 update = client.parse_webhook(body)
 ```
+### Disable link previews
+```ruby
+message = MaxBotApi::Builders::MessageBuilder.new
+  .set_chat(12345)
+  .set_text("https://max.ru")
+  .set_disable_link_preview(true)
+client.messages.send(message)
+```
+### Pin and unpin chat messages
+```ruby
+client.chats.pin_message(chat_id: 12345, message_id: "mid123")
+client.chats.get_pinned_message(chat_id: 12345)
+client.chats.unpin_message(chat_id: 12345)
+```
 ## Builders
 ### Keyboard

data/docs/02-listen-and-respond.md CHANGED Viewed

@@ -35,6 +35,7 @@ end
 ```ruby
 post "/webhook" do
+  halt 401 unless client.webhook_secret_valid?(headers: request.env, secret: ENV.fetch("WEBHOOK_SECRET"))
   update = client.parse_webhook(request.body.read)
   case update[:update_type]

data/docs/04-keyboard.md CHANGED Viewed

@@ -20,6 +20,10 @@ keyboard
   .add_callback("Picture", "positive", "picture")
   .add_message("Continue")
+keyboard
+  .add_row
+  .add_clipboard("Copy docs", "https://dev.max.ru/docs-api/methods/POST/messages")
 message = MaxBotApi::Builders::MessageBuilder.new
   .set_chat(12345)
   .add_keyboard(keyboard)
@@ -36,3 +40,4 @@ client.messages.send(message)
 - `add_geolocation(text, quick)`
 - `add_open_app(text, app, payload, contact_id)`
 - `add_message(text)`
+- `add_clipboard(text, payload)`

data/docs/06-subscriptions.md CHANGED Viewed

@@ -14,6 +14,8 @@ client.subscriptions.subscribe(
 )
 ```
+When handling webhook requests, validate the `X-Max-Bot-Api-Secret` header before parsing the body.
 ## Unsubscribe
 ```ruby

data/docs/api/methods.md ADDED Viewed

@@ -0,0 +1,59 @@
+# Методы API
+Источник: https://dev.max.ru/docs-api
+Клиент: MaxBotApi Ruby (`lib/max_bot_api/`).
+## bots
+| Метод | Путь | Описание | Клиент |
+| --- | --- | --- | --- |
+| `GET` | `/me` | Получение информации о боте | да |
+## chats
+| Метод | Путь | Описание | Клиент |
+| --- | --- | --- | --- |
+| `GET` | `/chats` | Получение списка всех групповых чатов | да |
+| `DELETE` | `/chats/{chatId}` | Удаление группового чата | нет |
+| `GET` | `/chats/{chatId}` | Получение информации о групповом чате | да |
+| `PATCH` | `/chats/{chatId}` | Изменение информации о групповом чате | да |
+| `POST` | `/chats/{chatId}/actions` | Отправка действия бота в групповой чат | да |
+| `DELETE` | `/chats/{chatId}/members` | Удаление участника из группового чата | частично (нет block) |
+| `GET` | `/chats/{chatId}/members` | Получение участников группового чата | да |
+| `POST` | `/chats/{chatId}/members` | Добавление участников в групповой чат | да |
+| `GET` | `/chats/{chatId}/members/admins` | Получение списка администраторов группового чата | да |
+| `POST` | `/chats/{chatId}/members/admins` | Назначить администратора группового чата | нет |
+| `DELETE` | `/chats/{chatId}/members/admins/{userId}` | Отменить права администратора в групповом чате | нет |
+| `DELETE` | `/chats/{chatId}/members/me` | Удаление бота из группового чата | да |
+| `GET` | `/chats/{chatId}/members/me` | Получение информации о членстве бота в групповом чате | да |
+| `DELETE` | `/chats/{chatId}/pin` | Удаление закреплённого сообщения в групповом чате | да |
+| `GET` | `/chats/{chatId}/pin` | Получение закреплённого сообщения в групповом чате | да |
+| `PUT` | `/chats/{chatId}/pin` | Закрепление сообщения в групповом чате | да |
+## subscriptions
+| Метод | Путь | Описание | Клиент |
+| --- | --- | --- | --- |
+| `DELETE` | `/subscriptions` | Отписка от обновлений | да |
+| `GET` | `/subscriptions` | Получение подписок | да |
+| `POST` | `/subscriptions` | Подписка на обновления | да (есть version) |
+| `GET` | `/updates` | Получение обновлений | да |
+## upload
+| Метод | Путь | Описание | Клиент |
+| --- | --- | --- | --- |
+| `POST` | `/uploads` | Загрузка файлов | да |
+## messages
+| Метод | Путь | Описание | Клиент |
+| --- | --- | --- | --- |
+| `POST` | `/answers` | Ответ на callback | да |
+| `DELETE` | `/messages` | Удалить сообщение | да |
+| `GET` | `/messages` | Получение сообщений | да |
+| `POST` | `/messages` | Отправить сообщение | да |
+| `PUT` | `/messages` | � едактировать сообщение | да |
+| `GET` | `/messages/{messageId}` | Получить сообщение | да |
+| `GET` | `/videos/{videoToken}` | Получить информацио о видео | нет |

data/docs/api/objects.md ADDED Viewed

@@ -0,0 +1,134 @@
+# Объекты API
+Источник: https://dev.max.ru/docs-api
+Всего объектов: 126
+| Объект | Краткое описание |
+| --- | --- |
+| `ActionRequestBody` |  |
+| `Attachment` | Общая схема, представляющая вложение сообщения |
+| `AttachmentPayload` |  |
+| `AttachmentRequest` | Запрос на прикрепление данных к сообщению |
+| `AudioAttachment` |  |
+| `AudioAttachmentRequest` | Запрос на прикрепление аудио к сообщению. ДОЛЖЕН быть единственным вложением в сообщении |
+| `BotAddedToChatUpdate` | Вы получите этот update, как только бот будет добавлен в чат |
+| `BotCommand` | до 32 элементов<br/>Команды, поддерживаемые ботом |
+| `BotInfo` | Объект включает общую информацию о боте, URL аватара и описание. Дополнительно содержит список команд, поддерживаемых… |
+| `BotPatch` |  |
+| `BotRemovedFromChatUpdate` | Вы получите этот update, как только бот будет удалён из чата |
+| `BotStartedUpdate` | Бот получает этот тип обновления, как только пользователь нажал кнопку `Start` |
+| `BotStoppedUpdate` | Бот получает этот тип обновления, как только пользователь останавливает бота |
+| `Button` |  |
+| `Callback` | Объект, отправленный боту, когда пользователь нажимает кнопку |
+| `CallbackAnswer` | Отправьте этот объект, когда ваш бот хочет отреагировать на нажатие кнопки |
+| `CallbackButton` | После нажатия на такую кнопку клиент отправляет на сервер полезную нагрузку, которая содержит |
+| `Chat` |  |
+| `ChatAdmin` |  |
+| `ChatAdminPermission` | Права администратора чата |
+| `ChatAdminsList` |  |
+| `ChatButton` | Кнопка, которая создает новый чат, как только первый пользователь на нее нажмёт. Бот будет добавлен в участники чата… |
+| `ChatList` |  |
+| `ChatMember` | Объект включает общую информацию о пользователе или боте, URL аватара и описание (при наличии). Дополнительно содержит… |
+| `ChatMembersList` |  |
+| `ChatPatch` |  |
+| `ChatStatus` | Статус чата для текущего бота |
+| `ChatTitleChangedUpdate` | Бот получит это обновление, когда будет изменено название чата |
+| `ChatType` | Тип чата: диалог, чат |
+| `ContactAttachment` |  |
+| `ContactAttachmentPayload` |  |
+| `ContactAttachmentRequest` | Запрос на прикрепление карточки контакта к сообщению. ДОЛЖЕН быть единственным вложением в сообщении |
+| `ContactAttachmentRequestPayload` |  |
+| `DataAttachment` | Attachment contains payload sent through `SendMessageButton` |
+| `DialogClearedUpdate` | Бот получает этот тип обновления сразу после очистки истории диалога. |
+| `DialogMutedUpdate` | Вы получите этот update, когда пользователь заглушит диалог с ботом |
+| `DialogRemovedUpdate` | Вы получите этот update, когда пользователь удаляет чат |
+| `DialogUnmutedUpdate` | Вы получите этот update, когда пользователь включит уведомления в диалоге с ботом |
+| `EmphasizedMarkup` | Представляет *курсив* |
+| `Error` | Сервер возвращает это, если возникло исключение при вашем запросе |
+| `FailedUserDetails` | Подробное описание, почему пользователь не был добавлен в чат |
+| `FileAttachment` |  |
+| `FileAttachmentPayload` |  |
+| `FileAttachmentRequest` | Запрос на прикрепление файла к сообщению. ДОЛЖЕН быть единственным вложением в сообщении |
+| `GetPinnedMessageResult` |  |
+| `GetSubscriptionsResult` | Список всех WebHook подписок |
+| `HeadingMarkup` | Представляет заголовок текста |
+| `HighlightedMarkup` | Представляет выделенную часть текста |
+| `Image` | Общая схема, описывающая объект изображения |
+| `InlineKeyboardAttachment` | Кнопки в сообщении |
+| `InlineKeyboardAttachmentRequest` | Запрос на прикрепление клавиатуры к сообщению |
+| `InlineKeyboardAttachmentRequestPayload` |  |
+| `Intent` | Намерение кнопки |
+| `Keyboard` | Клавиатура - это двумерный массив кнопок |
+| `LinkButton` | После нажатия на такую кнопку пользователь переходит по ссылке, которую она содержит |
+| `LinkMarkup` | Представляет ссылку в тексте |
+| `LinkedMessage` |  |
+| `LocationAttachment` |  |
+| `LocationAttachmentRequest` | Запрос на прикрепление клавиатуры к сообщению |
+| `MarkupElement` |  |
+| `MediaAttachmentPayload` |  |
+| `Message` | Сообщение в чате |
+| `MessageBody` | Схема, представляющая тело сообщения |
+| `MessageButton` | Кнопка для запуска мини-приложения |
+| `MessageCallbackUpdate` | Вы получите этот `update` как только пользователь нажмёт кнопку |
+| `MessageChatCreatedUpdate` | Бот получит это обновление, когда чат будет создан, как только первый пользователь нажмёт кнопку чата |
+| `MessageCreatedUpdate` | ы получите этот `update`, как только сообщение будет создано |
+| `MessageEditedUpdate` | Вы получите этот `update`, как только сообщение будет отредактировано |
+| `MessageLinkType` | Тип связанного сообщения |
+| `MessageList` | Пагинированный список сообщений |
+| `MessageRemovedUpdate` | Вы получите этот `update`, как только сообщение будет удалено |
+| `MessageStat` | Статистика сообщения |
+| `ModifyMembersResult` | � езультат запроса на изменение списка участников |
+| `MonospacedMarkup` | Представляет `моноширинный` или блок ```код``` в тексте |
+| `NewMessageBody` |  |
+| `NewMessageLink` |  |
+| `OpenAppButton` | Кнопка для запуска мини-приложения |
+| `PhotoAttachment` | Вложение изображения |
+| `PhotoAttachmentPayload` |  |
+| `PhotoAttachmentRequest` |  |
+| `PhotoAttachmentRequestPayload` | Запрос на прикрепление изображения (все поля являются взаимоисключающими) |
+| `PhotoToken` |  |
+| `PhotoTokens` | Это информация, которую вы получите, как только изображение будет загружено |
+| `PinMessageBody` |  |
+| `Recipient` | Новый получатель сообщения. Может быть пользователем или чатом |
+| `ReplyButton` | After pressing this type of button client will send a message on behalf of user with given payload |
+| `ReplyKeyboardAttachment` | Custom reply keyboard in message |
+| `ReplyKeyboardAttachmentRequest` | Request to attach reply keyboard to message |
+| `RequestContactButton` | AПосле нажатия на такую кнопку клиент отправляет новое сообщение с вложением текущего контакта пользователя |
+| `RequestGeoLocationButton` | После нажатия на такую кнопку клиент отправляет новое сообщение с вложением текущего географического положения… |
+| `SendContactButton` | AПосле нажатия на такую кнопку клиент отправляет новое сообщение с вложением текущего контакта пользователя |
+| `SendGeoLocationButton` | После нажатия на такую кнопку клиент отправляет новое сообщение с вложением текущего географического положения… |
+| `SendMessageButton` | After pressing this type of button client will send a message on behalf of user with given payload |
+| `SendMessageResult` |  |
+| `SenderAction` | Действие, отправляемое участникам чата. Возможные значения: - `"typing_on"` — Бот набирает сообщение. -… |
+| `ShareAttachment` |  |
+| `ShareAttachmentPayload` | Полезная нагрузка запроса ShareAttachmentRequest |
+| `ShareAttachmentRequest` | Запрос на прикрепление предпросмотра медиафайла по внешнему URL |
+| `SimpleQueryResult` | Простой ответ на запрос |
+| `StickerAttachment` |  |
+| `StickerAttachmentPayload` |  |
+| `StickerAttachmentRequest` | Запрос на прикрепление стикера. ДОЛЖЕН быть единственным вложением в сообщении |
+| `StickerAttachmentRequestPayload` |  |
+| `StrikethroughMarkup` | Представляет ~зачекрнутый~ текст |
+| `StrongMarkup` | Представляет **жирный** текст |
+| `Subscription` | Схема для описания подписки на WebHook |
+| `SubscriptionRequestBody` | Запрос на настройку подписки WebHook |
+| `TextFormat` | Формат текста сообщения |
+| `UnderlineMarkup` | Представляет <ins>подчеркнутый</ins> текст |
+| `Update` | Объект`Update` представляет различные типы событий, произошедших в чате. См. его наследников > Чтобы получать события… |
+| `UpdateList` | Список всех обновлений в чатах, в которых ваш бот участвовал |
+| `UploadEndpoint` | Точка доступа, куда следует загружать ваши бинарные файлы |
+| `UploadType` | Тип загружаемого файла Поддерживаемые форматы: - `image`: JPG, JPEG, PNG, GIF, TIFF, BMP, HEIC - `video`: MP4, MOV,… |
+| `UploadedInfo` | Это информация, которую вы получите, как только аудио/видео будет загружено |
+| `User` | Объект, описывающий один из вариантов наследования: - [`User`](/docs-api/objects/User) — объект содержит общую… |
+| `UserAddedToChatUpdate` | Вы получите это обновление, когда пользователь будет добавлен в чат, где бот является администратором |
+| `UserIdsList` |  |
+| `UserMentionMarkup` | Представляет упоминание пользователя в тексте. Упоминание может быть как по имени пользователя, так и по ID, если у… |
+| `UserRemovedFromChatUpdate` | Вы получите это обновление, когда пользователь будет удалён из чата, где бот является администратором |
+| `UserWithPhoto` | Объект с общей информацией о пользователе или боте, дополнительно содержит URL аватара и описание |
+| `VideoAttachment` |  |
+| `VideoAttachmentDetails` |  |
+| `VideoAttachmentRequest` | Запрос на прикрепление видео к сообщению |
+| `VideoThumbnail` |  |
+| `VideoUrls` |  |
+| `bigint` |  |

data/docs/api/overview.md ADDED Viewed

@@ -0,0 +1,73 @@
+# Обзор API MAX
+Источник: https://dev.max.ru/docs-api
+## Что такое API MAX
+API MAX — это интерфейс для взаимодействия ботов с платформой через HTTPS-запросы к `platform-api.max.ru`. Он позволяет получать данные и выполнять действия (получение, создание, редактирование, удаление ресурсов).
+## HTTP методы
+- `GET` — получить ресурсы
+- `POST` — создать ресурсы (например, отправить сообщения)
+- `PUT` — редактировать ресурсы
+- `DELETE` — удалить ресурсы
+- `PATCH` — исправить ресурсы
+Параметры передаются в пути, query-строке или теле запроса.
+## Авторизация
+Передавайте токен в заголовке:
+```
+Authorization: <token>
+```
+Передача токена через query-параметры не поддерживается.
+## Ответы и коды ошибок
+Сервер возвращает JSON и HTTP-код:
+- `200` — успешная операция
+- `400` — недействительный запрос
+- `401` — ошибка аутентификации
+- `404` — ресурс не найден
+- `405` — метод не допускается
+- `429` — превышено количество запросов
+- `503` — сервис недоступен
+## Рекомендации по получению обновлений
+- Long Polling — для разработки и тестирования
+- Webhook — для production-окружения
+Ограничение по нагрузке: до **30 rps** на `platform-api.max.ru`.
+## Клавиатуры
+Поддерживаются inline-клавиатуры с ограничениями:
+- до `210` кнопок
+- до `30` рядов
+- до `7` кнопок в ряду (до `3` для кнопок `link`, `open_app`, `request_geo_location`, `request_contact`)
+- для `link` максимальный размер ссылки — `2048` символов
+Основные типы кнопок:
+- `callback` — событие `message_callback`
+- `link` — ссылка
+- `request_contact` — запрос контакта
+- `request_geo_location` — запрос геолокации
+- `open_app` — открытие мини-приложения
+- `message` — отправка текста
+## Форматирование текста
+Поддерживаются `markdown` и `html` в поле `format` объекта `NewMessageBody`.
+- Markdown: `*курсив*`, `**жирный**`, `~~зачерк~~`, `++подчерк++`, `` `code` ``
+- HTML: `<i>`, `<b>`, `<del>`, `<ins>`, `<pre>/<code>`, `<a href="...">`
+Для упоминаний используйте `max://user/user_id` и полное имя пользователя.

data/examples/keyboard.rb CHANGED Viewed

@@ -17,6 +17,10 @@ keyboard
   .add_callback('Audio', 'negative', 'audio')
   .add_message('Continue')
+keyboard
+  .add_row
+  .add_clipboard('Copy docs', 'https://dev.max.ru/docs-api/methods/POST/messages')
 message = MaxBotApi::Builders::MessageBuilder.new
                                              .set_chat(chat_id)
                                              .add_keyboard(keyboard)

data/examples/webhook_rack.rb CHANGED Viewed

@@ -8,6 +8,10 @@ client = MaxBotApi::Client.new(token: ENV.fetch('TOKEN'))
 app = lambda do |env|
   req = Rack::Request.new(env)
   if req.post? && req.path == '/webhook'
+    unless client.webhook_secret_valid?(headers: env, secret: ENV.fetch('WEBHOOK_SECRET'))
+      return [401, { 'Content-Type' => 'text/plain' }, ['secret not allowed']]
+    end
     update = client.parse_webhook(req.body.read)
     if update[:update_type] == 'message_created'

data/lib/max_bot_api/builders/keyboard_builder.rb CHANGED Viewed

@@ -94,6 +94,16 @@ module MaxBotApi
         add_button(button)
       end
+      # Add a clipboard button.
+      def add_clipboard(text, payload)
+        button = {
+          type: 'clipboard',
+          text: text,
+          payload: payload
+        }
+        add_button(button)
+      end
       # Build row payload.
       def build
         @cols

data/lib/max_bot_api/builders/message_builder.rb CHANGED Viewed

@@ -7,7 +7,7 @@ module MaxBotApi
       FORMAT_HTML = 'html'
       FORMAT_MARKDOWN = 'markdown'
-      attr_reader :user_id, :chat_id, :reset
+      attr_reader :user_id, :chat_id, :reset, :disable_link_preview
       # Create a builder from an existing hash payload.
       # @param hash [Hash]
@@ -19,6 +19,9 @@ module MaxBotApi
         builder.set_user(hash[:user_id] || hash['user_id']) if hash.key?(:user_id) || hash.key?('user_id')
         builder.set_chat(hash[:chat_id] || hash['chat_id']) if hash.key?(:chat_id) || hash.key?('chat_id')
         builder.set_reset(hash[:reset] || hash['reset']) if hash.key?(:reset) || hash.key?('reset')
+        if hash.key?(:disable_link_preview) || hash.key?('disable_link_preview')
+          builder.set_disable_link_preview(hash[:disable_link_preview] || hash['disable_link_preview'])
+        end
         payload = hash[:message] || hash['message'] || hash
         builder.apply_payload(payload)
@@ -30,6 +33,7 @@ module MaxBotApi
         @user_id = nil
         @chat_id = nil
         @reset = false
+        @disable_link_preview = false
         @message = {
           attachments: []
         }
@@ -53,6 +57,12 @@ module MaxBotApi
         self
       end
+      # Toggle link previews in sent messages.
+      def set_disable_link_preview(disable_link_preview)
+        @disable_link_preview = !!disable_link_preview
+        self
+      end
       # Set message text.
       def set_text(text)
         @message[:text] = text
@@ -177,6 +187,11 @@ module MaxBotApi
         @reset
       end
+      # Whether link previews are disabled for message delivery.
+      def disable_link_preview?
+        @disable_link_preview
+      end
       # Return the message payload hash.
       def to_h
         @message

data/lib/max_bot_api/client.rb CHANGED Viewed

@@ -9,6 +9,8 @@ module MaxBotApi
     DEFAULT_BASE_URL = 'https://platform-api.max.ru/'
     # Default API version appended as query param.
     DEFAULT_VERSION = '1.2.5'
+    # Webhook secret header name.
+    SECRET_HEADER = 'X-Max-Bot-Api-Secret'
     # Default pause between update polling loops.
     DEFAULT_PAUSE = 1
     # Default limit for updates requests.
@@ -131,6 +133,13 @@ module MaxBotApi
       Updates::Parser.parse_update(body.to_s, debug: debug)
     end
+    # Validates the webhook secret header against the expected secret.
+    # @param headers [Hash]
+    # @param secret [String]
+    def webhook_secret_valid?(headers:, secret:)
+      header_value(headers, SECRET_HEADER) == secret.to_s
+    end
     # Perform an HTTP request.
     # @param method [Symbol]
     # @param path [String]
@@ -192,6 +201,18 @@ module MaxBotApi
       body.values.any? { |value| value.is_a?(Faraday::Multipart::FilePart) }
     end
+    def header_value(headers, name)
+      target = name.to_s.downcase
+      headers.each do |key, value|
+        normalized = key.to_s.downcase.tr('_', '-')
+        normalized = normalized.sub(/\Ahttp-/, '')
+        return value if normalized == target
+      end
+      nil
+    end
     def handle_response(response)
       return parse_body(response) if response.status == 200

data/lib/max_bot_api/resources/chats.rb CHANGED Viewed

@@ -86,6 +86,25 @@ module MaxBotApi
       def send_action(chat_id:, action:)
         @client.request(:post, "chats/#{chat_id}/actions", body: { action: action })
       end
+      # Pin a message in chat.
+      # @param chat_id [Integer]
+      # @param message_id [String]
+      def pin_message(chat_id:, message_id:)
+        @client.request(:put, "chats/#{chat_id}/pin", body: { message_id: message_id })
+      end
+      # Fetch the currently pinned message.
+      # @param chat_id [Integer]
+      def get_pinned_message(chat_id:)
+        @client.request(:get, "chats/#{chat_id}/pin")
+      end
+      # Remove the currently pinned message.
+      # @param chat_id [Integer]
+      def unpin_message(chat_id:)
+        @client.request(:delete, "chats/#{chat_id}/pin")
+      end
     end
   end
 end

data/lib/max_bot_api/resources/messages.rb CHANGED Viewed

@@ -110,6 +110,7 @@ module MaxBotApi
         query = {}
         query['chat_id'] = message.chat_id if message.chat_id && message.chat_id.to_i != 0
         query['user_id'] = message.user_id if message.user_id && message.user_id.to_i != 0
+        query['disable_link_preview'] = 'true' if message.disable_link_preview?
         response = @client.request(:post, 'messages', query: query, body: message_payload(message),
                                                       reset: message.reset?)

data/lib/max_bot_api/version.rb CHANGED Viewed

@@ -2,5 +2,5 @@
 module MaxBotApi
   # Gem version.
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: max_bot_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ChatGPT Codex
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-05 00:00:00.000000000 Z
+date: 2026-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -95,6 +95,9 @@ files:
 - docs/04-keyboard.md
 - docs/05-uploads.md
 - docs/06-subscriptions.md
+- docs/api/methods.md
+- docs/api/objects.md
+- docs/api/overview.md
 - examples/attachments.rb
 - examples/basic_send.rb
 - examples/keyboard.rb