Added AudioAttachmentRequest & ContactAttachmentRequest & FileAttachmentRequest & LocationAttachmentRequest & ShareAttachmentRequest & StickerAttachmentRequest & VideoAttachmentRequest

Author: BushlanovDev

README.md

@@ -6,8 +6,8 @@
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 
 > [!CAUTION]  
-> На мой взгляд `Max Messenger` является ни чем иным как малварью, созданной для слежки за гражданами РФ.
-> Настоятельно не рекомендую использовать на реальных устройствах, с настоящим номером телефона, и для личной переписки.
+> На мой взгляд `Max Messenger` является ни чем иным как малварью, созданной для слежки за гражданами РФ. Настоятельно
+> не рекомендую использовать его на реальных устройствах, с настоящим номером телефона, и для личной переписки.
 
 > [!IMPORTANT]  
 > Библиотека в стадии активной разработки.
@@ -25,46 +25,46 @@
 
 #### Bots
 
-- `[x] GET /me` (`getBotInfo`) — *Получение информации о боте.*
-- `[ ] PATCH /me` (`editBotInfo`) — *Редактирование информации о боте.*
+- [x] `GET /me` (`getBotInfo`) — *Получение информации о боте.*
+- [ ] `PATCH /me` (`editBotInfo`) — *Редактирование информации о боте.*
 
 #### Chats
 
-- `[ ] GET /chats` (`getChats`) — *Получение списка всех чатов бота.*
-- `[ ] GET /chats/{chatLink}` (`getChatByLink`) — *Получение информации о чате по ссылке.*
-- `[x] GET /chats/{chatId}` (`getChat`) — *Получение информации о чате по ID.*
-- `[ ] PATCH /chats/{chatId}` (`editChat`) — *Редактирование информации о чате.*
-- `[ ] DELETE /chats/{chatId}` (`deleteChat`) — *Удаление чата.*
-- `[ ] POST /chats/{chatId}/actions` (`sendAction`) — *Отправка действия в чат (например, "печатает...").*
-- `[ ] GET /chats/{chatId}/pin` (`getPinnedMessage`) — *Получение закрепленного сообщения.*
-- `[ ] PUT /chats/{chatId}/pin` (`pinMessage`) — *Закрепление сообщения.*
-- `[ ] DELETE /chats/{chatId}/pin` (`unpinMessage`) — *Открепление сообщения.*
-- `[ ] GET /chats/{chatId}/members/me` (`getMembership`) — *Получение информации о членстве бота в чате.*
-- `[ ] DELETE /chats/{chatId}/members/me` (`leaveChat`) — *Выход бота из чата.*
-- `[ ] GET /chats/{chatId}/members/admins` (`getAdmins`) — *Получение администраторов чата.*
-- `[ ] POST /chats/{chatId}/members/admins` (`postAdmins`) — *Назначение администраторов чата.*
-- `[ ] DELETE /chats/{chatId}/members/admins/{userId}` (`deleteAdmins`) — *Снятие прав администратора.*
-- `[ ] GET /chats/{chatId}/members` (`getMembers`) — *Получение участников чата.*
-- `[ ] POST /chats/{chatId}/members` (`addMembers`) — *Добавление участников в чат.*
-- `[ ] DELETE /chats/{chatId}/members` (`removeMember`) — *Удаление участника из чата.*
+- [ ] `GET /chats` (`getChats`) — *Получение списка всех чатов бота.*
+- [ ] `GET /chats/{chatLink}` (`getChatByLink`) — *Получение информации о чате по ссылке.*
+- [x] `GET /chats/{chatId}` (`getChat`) — *Получение информации о чате по ID.*
+- [ ] `PATCH /chats/{chatId}` (`editChat`) — *Редактирование информации о чате.*
+- [ ] `DELETE /chats/{chatId}` (`deleteChat`) — *Удаление чата.*
+- [ ] `POST /chats/{chatId}/actions` (`sendAction`) — *Отправка действия в чат (например, "печатает...").*
+- [ ] `GET /chats/{chatId}/pin` (`getPinnedMessage`) — *Получение закрепленного сообщения.*
+- [ ] `PUT /chats/{chatId}/pin` (`pinMessage`) — *Закрепление сообщения.*
+- [ ] `DELETE /chats/{chatId}/pin` (`unpinMessage`) — *Открепление сообщения.*
+- [ ] `GET /chats/{chatId}/members/me` (`getMembership`) — *Получение информации о членстве бота в чате.*
+- [ ] `DELETE /chats/{chatId}/members/me` (`leaveChat`) — *Выход бота из чата.*
+- [ ] `GET /chats/{chatId}/members/admins` (`getAdmins`) — *Получение администраторов чата.*
+- [ ] `POST /chats/{chatId}/members/admins` (`postAdmins`) — *Назначение администраторов чата.*
+- [ ] `DELETE /chats/{chatId}/members/admins/{userId}` (`deleteAdmins`) — *Снятие прав администратора.*
+- [ ] `GET /chats/{chatId}/members` (`getMembers`) — *Получение участников чата.*
+- [ ] `POST /chats/{chatId}/members` (`addMembers`) — *Добавление участников в чат.*
+- [ ] `DELETE /chats/{chatId}/members` (`removeMember`) — *Удаление участника из чата.*
 
 #### Subscriptions
 
-- `[x] GET /subscriptions` (`getSubscriptions`) — *Получение списка Webhook-подписок.*
-- `[x] POST /subscriptions` (`subscribe`) — *Создание Webhook-подписки.*
-- `[x] DELETE /subscriptions` (`unsubscribe`) — *Удаление Webhook-подписки.*
-- `[x] GET /updates` (`getUpdates`) — *Получение обновлений через Long-Polling.*
+- [x] `GET /subscriptions` (`getSubscriptions`) — *Получение списка Webhook-подписок.*
+- [x] `POST /subscriptions` (`subscribe`) — *Создание Webhook-подписки.*
+- [x] `DELETE /subscriptions` (`unsubscribe`) — *Удаление Webhook-подписки.*
+- [x] `GET /updates` (`getUpdates`) — *Получение обновлений через Long-Polling.*
 
 #### Upload
 
-- `[x] POST /uploads` (`getUploadUrl`) — *Получение URL для загрузки файла.*
+- [x] `POST /uploads` (`getUploadUrl`) — *Получение URL для загрузки файла.*
 
 #### Messages
 
-- `[ ] GET /messages` (`getMessages`) — *Получение списка сообщений из чата.*
-- `[x] POST /messages` (`sendMessage`) — *Отправка сообщения.*
-- `[ ] PUT /messages` (`editMessage`) — *Редактирование сообщения.*
-- `[ ] DELETE /messages` (`deleteMessage`) — *Удаление сообщения.*
-- `[ ] GET /messages/{messageId}` (`getMessageById`) — *Получение сообщения по ID.*
-- `[ ] GET /videos/{videoToken}` (`getVideoAttachmentDetails`) — *Получение детальной информации о видео.*
-- `[ ] POST /answers` (`answerOnCallback`) — *Ответ на нажатие callback-кнопки.*
+- [ ] `GET /messages` (`getMessages`) — *Получение списка сообщений из чата.*
+- [x] `POST /messages` (`sendMessage`) — *Отправка сообщения.*
+- [ ] `PUT /messages` (`editMessage`) — *Редактирование сообщения.*
+- [ ] `DELETE /messages` (`deleteMessage`) — *Удаление сообщения.*
+- [ ] `GET /messages/{messageId}` (`getMessageById`) — *Получение сообщения по ID.*
+- [ ] `GET /videos/{videoToken}` (`getVideoAttachmentDetails`) — *Получение детальной информации о видео.*
+- [ ] `POST /answers` (`answerOnCallback`) — *Ответ на нажатие callback-кнопки.*

badge-coverage.svg

@@ -24,6 +24,8 @@
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3.77",
     "jaschilz/php-coverage-badger": "^2.0",
+    "mikey179/vfsstream": "^1.6",
+    "php-mock/php-mock-phpunit": "^2.13",
     "phpstan/phpstan": "^2.1",
     "phpunit/phpunit": "^12.0",
     "roave/security-advisories": "dev-latest"

composer.json

@@ -13,7 +13,10 @@
 use BushlanovDev\MaxMessengerBot\Exceptions\SerializationException;
 use BushlanovDev\MaxMessengerBot\Models\AbstractModel;
 use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\AbstractAttachmentRequest;
+use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\AudioAttachmentRequest;
+use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\FileAttachmentRequest;
 use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\PhotoAttachmentRequest;
+use BushlanovDev\MaxMessengerBot\Models\Attachments\Requests\VideoAttachmentRequest;
 use BushlanovDev\MaxMessengerBot\Models\BotInfo;
 use BushlanovDev\MaxMessengerBot\Models\Chat;
 use BushlanovDev\MaxMessengerBot\Models\Message;
@@ -71,12 +74,10 @@ public function __construct(
     ) {
         if ($client === null) {
             if (!class_exists(\GuzzleHttp\Client::class) || !class_exists(\GuzzleHttp\Psr7\HttpFactory::class)) {
-                // @codeCoverageIgnoreStart
                 throw new LogicException(
                     'No client was provided and "guzzlehttp/guzzle" is not found. ' .
                     'Please run "composer require guzzlehttp/guzzle" or create and pass your own implementation of ClientApiInterface.'
                 );
-                // @codeCoverageIgnoreEnd
             }
 
             $guzzle = new \GuzzleHttp\Client();
@@ -429,7 +430,7 @@ public function uploadAttachment(UploadType $type, string $filePath): AbstractAt
             throw new InvalidArgumentException("File not found or not readable: $filePath");
         }
 
-        $fileHandle = fopen($filePath, 'r');
+        $fileHandle = @fopen($filePath, 'r');
         if ($fileHandle === false) {
             throw new RuntimeException("Could not open file for reading: $filePath");
         }
@@ -450,6 +451,9 @@ public function uploadAttachment(UploadType $type, string $filePath): AbstractAt
 
         return match ($type) {
             UploadType::Image => PhotoAttachmentRequest::fromToken($uploadResult['token']),
+            UploadType::Video => new VideoAttachmentRequest($uploadResult['token']),
+            UploadType::Audio => new AudioAttachmentRequest($uploadResult['token']),
+            UploadType::File => new FileAttachmentRequest($uploadResult['token']), // @phpstan-ignore-line
             default => throw new LogicException(
                 "Attachment creation for type '$type->value' is not yet implemented."
             ),

src/Api.php

@@ -11,7 +11,7 @@ enum  AttachmentType: string
     case Audio = 'audio';
     case File = 'file';
     case Sticker = 'sticker';
-    case Contract = 'contract';
+    case Contact = 'contact';
     case InlineKeyboard = 'inline_keyboard';
     case Location = 'location';
     case Share = 'share';

src/Enums/AttachmentType.php

@@ -6,6 +6,6 @@
 
 use BushlanovDev\MaxMessengerBot\Models\AbstractModel;
 
-abstract readonly class AbstractAttachmentPayload extends AbstractModel
+abstract readonly class AbstractAttachmentRequestPayload extends AbstractModel
 {
 }

src/Models/Attachments/Payloads/AbstractAttachmentPayload.php renamed to src/Models/Attachments/Payloads/AbstractAttachmentRequestPayload.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads;
+
+/**
+ * Payload for a contact attachment request.
+ */
+final readonly class ContactAttachmentRequestPayload extends AbstractAttachmentRequestPayload
+{
+    /**
+     * @param string|null $name Contact name.
+     * @param int|null $contactId Contact identifier if it is a registered Max user.
+     * @param string|null $vcfInfo Full information about the contact in VCF format.
+     * @param string|null $vcfPhone Contact phone in VCF format.
+     */
+    public function __construct(
+        public ?string $name = null,
+        public ?int $contactId = null,
+        public ?string $vcfInfo = null,
+        public ?string $vcfPhone = null,
+    ) {
+    }
+}

src/Models/Attachments/Payloads/ContactAttachmentRequestPayload.php

@@ -6,7 +6,7 @@
 
 use BushlanovDev\MaxMessengerBot\Models\Attachments\Buttons\AbstractButton;
 
-final readonly class InlineKeyboardPayload extends AbstractAttachmentPayload
+final readonly class InlineKeyboardAttachmentRequestPayload extends AbstractAttachmentRequestPayload
 {
     /**
      * @param AbstractButton[][] $buttons

src/Models/Attachments/Payloads/InlineKeyboardPayload.php renamed to src/Models/Attachments/Payloads/InlineKeyboardAttachmentRequestPayload.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BushlanovDev\MaxMessengerBot\Models\Attachments\Payloads;
+
+/**
+ * Payload for a location attachment request.
+ */
+final readonly class LocationAttachmentRequestPayload extends AbstractAttachmentRequestPayload
+{
+    /**
+     * @param float $latitude Latitude as a floating-point number.
+     * @param float $longitude Longitude as a floating-point number.
+     */
+    public function __construct(
+        public float $latitude,
+        public float $longitude,
+    ) {
+    }
+}

src/Models/Attachments/Payloads/LocationAttachmentRequestPayload.php

@@ -10,7 +10,7 @@
 /**
  * Request to attach image. All fields are mutually exclusive.
  */
-final readonly class PhotoAttachmentPayload extends AbstractAttachmentPayload
+final readonly class PhotoAttachmentRequestPayload extends AbstractAttachmentRequestPayload
 {
     /**
      * @param string|null $url Any external image URL you want to attach.
@@ -25,7 +25,7 @@ public function __construct(
     ) {
         if (count(array_filter([$this->url, $this->token, $this->photos])) !== 1) {
             throw new InvalidArgumentException(
-                'Provide exactly one of "url", "token", or "photos" for PhotoAttachmentPayload.'
+                'Provide exactly one of "url", "token", or "photos" for PhotoAttachmentRequestPayload.'
             );
         }
     }