Documentation and some fix

2026-08-18 03:32:06 +00:00 · 2025-08-15 20:15:33 +03:00
parent ea1947239e
commit 00da3af39d
6 changed files with 154 additions and 20 deletions
@@ -31,7 +31,11 @@ composer require bushlanov-dev/max-bot-api-client-php
 Отправка сообщения с клавиатурой

 ```php
-$api = new \BushlanovDev\MaxMessengerBot\Api('YOUR_BOT_API_TOKEN');
+require __DIR__.'/vendor/autoload.php';
+
+use BushlanovDev\MaxMessengerBot\Api;
+
+$api = new Api('YOUR_BOT_API_TOKEN');

 $api->sendMessage(
    userId: 123,     // ID пользователя получателя сообщения
@@ -47,6 +51,26 @@ $api->sendMessage(
 );
 ```

+Создание универсального обработчика обновлений
+
+```php
+$dispatcher = $api->getUpdateDispatcher();
+
+$dispatcher->onMessageCreated(function (MessageCreatedUpdate $update, Api $api) {
+    $api->sendMessage(
+        userId: $update->message->recipient->userId,
+        text: 'Привет!',
+    );
+});
+// или
+$dispatcher->addHandler(UpdateType::BotStarted, function (BotStartedUpdate $update, Api $api) {
+    $api->sendMessage(
+        chatId: $update->chatId,
+        text: 'Я запущен!',
+    );
+});
+```
+
 Подписка на вэб хуки

 ```php
@@ -61,19 +85,18 @@ $api->subscribe(
 );
 ```

-Обработка хуков
+Обработка обновлений

 ```php
-$webhookHandler = $api->createWebhookHandler();
+$handler = $api->createWebhookHandler('super_secret'); // Обновления через вебхук
+// ИЛИ
+$handler = $api->createLongPollingHandler();           // Обновления через лонгполлинг

-$webhookHandler->addHandler(UpdateType::BotStarted, function (BotStartedUpdate $update, Api $api) {
-    $api->sendMessage(
-        chatId: $update->chatId,
-        text: 'Я запущен!',
-    );
-});
+$handler->handle();
 ```

+> ℹ️ С полной документацией [вы можете ознакомиться тут](./docs/README.md).
+
 ## Реализованные методы

 #### Bots
@@ -0,0 +1,102 @@
+- [Быстрый старт](#Быстрый-старт)
+    - [Получение токена](#Получение-токена)
+    - [Установка библиотеки](#Установка-библиотеки)
+    - [Инициализация бота](#Инициализация-бота)
+- [Информация о боте](#Информация-о-боте)
+    - `GET /me` (`getBotInfo`) - [*Получение информации о боте.*](#Получение-информации-о-боте)
+    - `PATCH /me` (`editBotInfo`) - [*Редактирование информации о боте.*](#Редактирование-информации-о-боте)
+- Чаты
+    - `GET /chats` (`getChats`) - *Получение списка всех чатов бота.*
+    - `GET /chats/{chatLink}` (`getChatByLink`) - *Получение информации о чате по ссылке.*
+    - `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` (`addAdmins`) - *Назначение администраторов чата.*
+    - `DELETE /chats/{chatId}/members/admins/{userId}` (`deleteAdmins`) - *Снятие прав администратора.*
+    - `GET /chats/{chatId}/members` (`getMembers`) - *Получение участников чата.*
+    - `POST /chats/{chatId}/members` (`addMembers`) - *Добавление участников в чат.*
+    - `DELETE /chats/{chatId}/members` (`deleteMember`) - *Удаление участника из чата.*
+- Получение обновлений
+    - `GET /subscriptions` (`getSubscriptions`) - *Получение списка Webhook-подписок.*
+    - `POST /subscriptions` (`subscribe`) - *Создание Webhook-подписки.*
+    - `DELETE /subscriptions` (`unsubscribe`) - *Удаление Webhook-подписки.*
+    - `GET /updates` (`getUpdates`) - *Получение обновлений через Long-Polling.*
+- Загрузка файлов
+    - `POST /uploads` (`getUploadUrl`) - *Получение URL для загрузки файла.*
+- Сообщения
+    - `GET /messages` (`getMessages`) - *Получение списка сообщений из чата.*
+    - `POST /messages` (`sendMessage`) - *Отправка сообщения.*
+    - `PUT /messages` (`editMessage`) - *Редактирование сообщения.*
+    - `DELETE /messages` (`deleteMessage`) - *Удаление сообщения.*
+    - `GET /messages/{messageId}` (`getMessageById`) - *Получение сообщения по ID.*
+    - `GET /videos/{videoToken}` (`getVideoAttachmentDetails`) - *Получение детальной информации о видео.*
+    - `POST /answers` (`answerOnCallback`) - *Ответ на нажатие callback-кнопки.*
+
+## Быстрый старт
+
+> Если вы новичок, то можете прочитать [официальную документацию](https://dev.max.ru/), написанную разработчиками Max.
+
+### Получение токена
+
+Откройте диалог с [MasterBot](https://max.ru/MasterBot), следуйте инструкциям и создайте нового бота. После создания
+бота MasterBot отправит вам токен.
+
+### Установка библиотеки
+
+```bash
+composer require bushlanov-dev/max-bot-api-client-php
+```
+
+### Инициализация бота
+
+Единственной обязательной настройкой является токен вашего бота.  
+⚠️ Никогда, и ни при каких обстоятельствах не храните токен в коде. ⚠️  
+Используйте переменные окружения!
+
+```php
+require __DIR__.'/vendor/autoload.php';
+
+use BushlanovDev\MaxMessengerBot\Api;
+
+$api = new Api('YOUR_BOT_API_TOKEN');
+```
+
+Так же вы можете создать экземпляр бота гибко настроив все зависимости под свои нужды.
+
+```php
+$api = new Api(
+    client: new Client(...),
+    modelFactory: new ModelFactory(),
+    logger: new YourPsrLogger(),
+);
+```
+
+## Информация о боте
+
+### Получение информации о боте
+
+```php
+$botInfo = $api->getBotInfo();
+```
+
+### Редактирование информации о боте
+
+Обратите внимание что данный метод отправляется PATCH запросом. Это значит, что будут обновлены только переданные
+поля.  
+В следующем примере мы изменяем только название бота и отчистим его описание. Остальные поля останутся неизменными.
+
+```php
+$botInfo = $api->editBotInfo(
+    new BotPatch(
+        name: 'Супер бот',
+        description: null,
+    )
+);
+```
@@ -47,7 +47,7 @@ use RuntimeException;
 */
 class Api
 {
-    public const string LIBRARY_VERSION = '1.0.0';
+    public const string LIBRARY_VERSION = '1.0.1';

    public const string API_VERSION = '0.0.6';

@@ -85,21 +85,23 @@ class Api
    /**
     * Api constructor.
     *
-     * @param string $accessToken Your bot's access token from @MasterBot.
+     * @param string|null $accessToken Your bot's access token from @MasterBot.
     * @param ClientApiInterface|null $client Http api client.
     * @param ModelFactory|null $modelFactory The model factory.
     * @param LoggerInterface|null $logger PSR LoggerInterface.
-     * @param UpdateDispatcher|null $updateDispatcher The update dispatcher.
     *
     * @throws InvalidArgumentException
     */
    public function __construct(
-        string $accessToken,
+        ?string $accessToken = null,
        ?ClientApiInterface $client = null,
        ?ModelFactory $modelFactory = null,
        ?LoggerInterface $logger = null,
-        ?UpdateDispatcher $updateDispatcher = null,
    ) {
+        if (empty($accessToken) && $client === null) {
+            throw new InvalidArgumentException('You must provide either an access token or a client.');
+        }
+
        $this->logger = $logger ?? new NullLogger();

        if ($client === null) {
@@ -130,7 +132,7 @@ class Api

        $this->client = $client;
        $this->modelFactory = $modelFactory ?? new ModelFactory();
-        $this->updateDispatcher = $updateDispatcher ?? new UpdateDispatcher($this);
+        $this->updateDispatcher = new UpdateDispatcher($this);
    }

    /**
@@ -102,7 +102,6 @@ class MaxBotServiceProvider extends ServiceProvider
                $app->make(ClientApiInterface::class),
                $app->make(ModelFactory::class),
                $app->make(LoggerInterface::class),
-                null,
            );
        });

@@ -35,15 +35,11 @@ final class ApiFactoryMethodsTest extends TestCase
        $this->modelFactoryMock = $this->createMock(ModelFactory::class);
        $this->loggerMock = $this->createMock(LoggerInterface::class);

-        $apiForDispatcher = $this->createMock(Api::class);
-        $dispatcher = new UpdateDispatcher($apiForDispatcher);
-
        $this->api = new Api(
            'fake-token',
            $this->clientMock,
            $this->modelFactoryMock,
            $this->loggerMock,
-            $dispatcher,
        );
    }

@@ -1980,4 +1980,16 @@ final class ApiTest extends TestCase

        $this->assertSame($expectedDetails, $result);
    }
+
+    #[Test]
+    public function constructorThrowsExceptionWhenNoTokenAndNoClientProvided(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('You must provide either an access token or a client.');
+
+        new Api(
+            accessToken: null,
+            client: null
+        );
+    }
 }