Add getChatAdministrators, getChatMemberCount and getChatMember methods

CHANGELOG.md

@@ -31,6 +31,7 @@
 - New #43: Add `setChatTitle` and `setChatDescription` methods.
 - New #44: Add `pinChatMessage`, `unpinChatMessage` and `unpinAllChatMessages` methods.
 - New #46: Add `leaveChat` method.
+- New #47: Add `getChatAdministrators`, `getChatMemberCount` and `getChatMember` methods.
 - Chg #24: Move update methods to `Vjik\TelegramBot\Api\Method\Update` namespace, and update types to
   `Vjik\TelegramBot\Api\Type\Update` namespace.
 - Chg #30: Remove `TelegramRequestWithFilesInterface`.

src/Method/GetChatAdministrators.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Method;
+
+use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
+use Vjik\TelegramBot\Api\Type\ChatMember;
+use Vjik\TelegramBot\Api\Type\ChatMemberFactory;
+
+/**
+ * @see https://core.telegram.org/bots/api#getchatadministrators
+ */
+final readonly class GetChatAdministrators implements TelegramRequestWithResultPreparingInterface
+{
+    public function __construct(
+        private int|string $chatId,
+    ) {
+    }
+
+    public function getHttpMethod(): HttpMethod
+    {
+        return HttpMethod::GET;
+    }
+
+    public function getApiMethod(): string
+    {
+        return 'getChatAdministrators';
+    }
+
+    public function getData(): array
+    {
+        return ['chat_id' => $this->chatId];
+    }
+
+    /**
+     * @return ChatMember[]
+     */
+    public function prepareResult(mixed $result): array
+    {
+        ValueHelper::assertArrayResult($result);
+        return array_map(
+            static fn(mixed $item) => ChatMemberFactory::fromTelegramResult($item),
+            $result
+        );
+    }
+}

src/Method/GetChatMember.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Method;
+
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
+use Vjik\TelegramBot\Api\Type\ChatMember;
+use Vjik\TelegramBot\Api\Type\ChatMemberFactory;
+
+/**
+ * @see https://core.telegram.org/bots/api#getchatmember
+ */
+final readonly class GetChatMember implements TelegramRequestWithResultPreparingInterface
+{
+    public function __construct(
+        private int|string $chatId,
+        private int $userId,
+    ) {
+    }
+
+    public function getHttpMethod(): HttpMethod
+    {
+        return HttpMethod::GET;
+    }
+
+    public function getApiMethod(): string
+    {
+        return 'getChatMember';
+    }
+
+    public function getData(): array
+    {
+        return [
+            'chat_id' => $this->chatId,
+            'user_id' => $this->userId,
+        ];
+    }
+
+    public function prepareResult(mixed $result): ChatMember
+    {
+        return ChatMemberFactory::fromTelegramResult($result);
+    }
+}

src/Method/GetChatMemberCount.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Method;
+
+use Vjik\TelegramBot\Api\ParseResult\ValueHelper;
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+use Vjik\TelegramBot\Api\Request\TelegramRequestWithResultPreparingInterface;
+
+/**
+ * @see https://core.telegram.org/bots/api#getchatmembercount
+ */
+final readonly class GetChatMemberCount implements TelegramRequestWithResultPreparingInterface
+{
+    public function __construct(
+        private int|string $chatId,
+    ) {
+    }
+
+    public function getHttpMethod(): HttpMethod
+    {
+        return HttpMethod::GET;
+    }
+
+    public function getApiMethod(): string
+    {
+        return 'getChatMemberCount';
+    }
+
+    public function getData(): array
+    {
+        return ['chat_id' => $this->chatId];
+    }
+
+    public function prepareResult(mixed $result): int
+    {
+        ValueHelper::assertIntegerResult($result);
+        return $result;
+    }
+}

src/ParseResult/ValueHelper.php

@@ -44,6 +44,18 @@ public static function assertStringResult(mixed $result): void
         }
     }
 
+    /**
+     * @psalm-assert int $result
+     */
+    public static function assertIntegerResult(mixed $result): void
+    {
+        if (!is_int($result)) {
+            throw new TelegramParseResultException(
+                'Expected result as integer. Got "' . get_debug_type($result) . '".'
+            );
+        }
+    }
+
     /**
      * @psalm-assert true $result
      */

src/TelegramBotApi.php

@@ -23,6 +23,9 @@
 use Vjik\TelegramBot\Api\Method\ForwardMessage;
 use Vjik\TelegramBot\Api\Method\ForwardMessages;
 use Vjik\TelegramBot\Api\Method\GetChat;
+use Vjik\TelegramBot\Api\Method\GetChatAdministrators;
+use Vjik\TelegramBot\Api\Method\GetChatMember;
+use Vjik\TelegramBot\Api\Method\GetChatMemberCount;
 use Vjik\TelegramBot\Api\Method\GetChatMenuButton;
 use Vjik\TelegramBot\Api\Method\GetFile;
 use Vjik\TelegramBot\Api\Method\GetMe;
@@ -78,6 +81,7 @@
 use Vjik\TelegramBot\Api\Type\BotShortDescription;
 use Vjik\TelegramBot\Api\Type\ChatFullInfo;
 use Vjik\TelegramBot\Api\Type\ChatInviteLink;
+use Vjik\TelegramBot\Api\Type\ChatMember;
 use Vjik\TelegramBot\Api\Type\ChatPermissions;
 use Vjik\TelegramBot\Api\Type\File;
 use Vjik\TelegramBot\Api\Type\ForceReply;
@@ -421,6 +425,38 @@ public function getChat(int|string $chatId): FailResult|ChatFullInfo
         return $this->send(new GetChat($chatId));
     }
 
+    /**
+     * @see https://core.telegram.org/bots/api#getchatadministrators
+     *
+     * @return FailResult|ChatMember[]
+     *
+     * @psalm-suppress MixedInferredReturnType,MixedReturnStatement
+     */
+    public function getChatAdministrators(int|string $chatId): FailResult|array
+    {
+        return $this->send(new GetChatAdministrators($chatId));
+    }
+
+    /**
+     * @see https://core.telegram.org/bots/api#getchatmembercount
+     *
+     * @psalm-suppress MixedInferredReturnType,MixedReturnStatement
+     */
+    public function getChatMemberCount(int|string $chatId): FailResult|int
+    {
+        return $this->send(new GetChatMemberCount($chatId));
+    }
+
+    /**
+     * @see https://core.telegram.org/bots/api#getchatmember
+     *
+     * @psalm-suppress MixedInferredReturnType,MixedReturnStatement
+     */
+    public function getChatMember(int|string $chatId, int $userId): FailResult|ChatMember
+    {
+        return $this->send(new GetChatMember($chatId, $userId));
+    }
+
     /**
      * @see https://core.telegram.org/bots/api#getchatmenubutton
      *

tests/Method/GetChatAdministratorsTest.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Tests\Method;
+
+use PHPUnit\Framework\TestCase;
+use Vjik\TelegramBot\Api\Method\GetChatAdministrators;
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+use Vjik\TelegramBot\Api\Type\ChatMemberMember;
+
+final class GetChatAdministratorsTest extends TestCase
+{
+    public function testBase(): void
+    {
+        $method = new GetChatAdministrators(1);
+
+        $this->assertSame(HttpMethod::GET, $method->getHttpMethod());
+        $this->assertSame('getChatAdministrators', $method->getApiMethod());
+        $this->assertSame(
+            [
+                'chat_id' => 1,
+            ],
+            $method->getData(),
+        );
+    }
+
+    public function testPrepareResult(): void
+    {
+        $method = new GetChatAdministrators(1);
+
+        $preparedResult = $method->prepareResult([
+            [
+                'status' => 'member',
+                'user' => ['id' => 23, 'is_bot' => false, 'first_name' => 'Mike'],
+            ],
+        ]);
+
+        $this->assertCount(1, $preparedResult);
+        $this->assertInstanceOf(ChatMemberMember::class, $preparedResult[0]);
+        $this->assertSame(23, $preparedResult[0]->user->id);
+    }
+}

tests/Method/GetChatMemberCountTest.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Tests\Method;
+
+use PHPUnit\Framework\TestCase;
+use Vjik\TelegramBot\Api\Method\GetChatMemberCount;
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+
+final class GetChatMemberCountTest extends TestCase
+{
+    public function testBase(): void
+    {
+        $method = new GetChatMemberCount(1);
+
+        $this->assertSame(HttpMethod::GET, $method->getHttpMethod());
+        $this->assertSame('getChatMemberCount', $method->getApiMethod());
+        $this->assertSame(
+            [
+                'chat_id' => 1,
+            ],
+            $method->getData(),
+        );
+    }
+
+    public function testPrepareResult(): void
+    {
+        $method = new GetChatMemberCount(1);
+
+        $preparedResult = $method->prepareResult(23);
+
+        $this->assertSame(23, $preparedResult);
+    }
+}

tests/Method/GetChatMemberTest.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Vjik\TelegramBot\Api\Tests\Method;
+
+use PHPUnit\Framework\TestCase;
+use Vjik\TelegramBot\Api\Method\GetChatMember;
+use Vjik\TelegramBot\Api\Request\HttpMethod;
+use Vjik\TelegramBot\Api\Type\ChatMemberMember;
+
+final class GetChatMemberTest extends TestCase
+{
+    public function testBase(): void
+    {
+        $method = new GetChatMember(1, 2);
+
+        $this->assertSame(HttpMethod::GET, $method->getHttpMethod());
+        $this->assertSame('getChatMember', $method->getApiMethod());
+        $this->assertSame(
+            [
+                'chat_id' => 1,
+                'user_id' => 2,
+            ],
+            $method->getData(),
+        );
+    }
+
+    public function testPrepareResult(): void
+    {
+        $method = new GetChatMember(1, 2);
+
+        $preparedResult = $method->prepareResult([
+            'status' => 'member',
+            'user' => ['id' => 23, 'is_bot' => false, 'first_name' => 'Mike'],
+        ]);
+
+        $this->assertInstanceOf(ChatMemberMember::class, $preparedResult);
+        $this->assertSame(23, $preparedResult->user->id);
+    }
+}

tests/ParseResult/ValueHelperTest.php

@@ -44,6 +44,15 @@ public function testAssertStringResult(): void
         ValueHelper::assertStringResult([]);
     }
 
+    public function testAssertIntegerResult(): void
+    {
+        ValueHelper::assertIntegerResult(25);
+
+        $this->expectException(TelegramParseResultException::class);
+        $this->expectExceptionMessage('Expected result as integer. Got "array".');
+        ValueHelper::assertIntegerResult([]);
+    }
+
     public function testAssertTrueResult(): void
     {
         ValueHelper::assertTrueResult(true);