fix(pagination): Update client cursor pagination (#178)

Author: Ercogx

docs/2-usage.md

@@ -77,9 +77,6 @@ do {
 } while (!empty($cursor));
 ```
 
->Note: the virtual methods are not yet documented with PHPDoc so your IDE will
-not autocomplete them.
-
 ## Concrete examples
 
 Here are some real-life examples of interacting with the SDK:

src/Client.php

@@ -14,19 +14,31 @@
 namespace JoliCode\Slack;
 
 use JoliCode\Slack\Api\Client as ApiClient;
+use JoliCode\Slack\Api\Model\ObjsConversation;
+use JoliCode\Slack\Api\Model\ObjsMessage;
+use JoliCode\Slack\Api\Model\ObjsSubteam;
+use JoliCode\Slack\Api\Model\ObjsUser;
 
+/**
+ * @method iterable<ObjsMessage>      iterateConversationsHistory(array $arguments = [])
+ * @method iterable<ObjsConversation> iterateConversationsList(array $arguments = [])
+ * @method iterable<string>           iterateConversationsMembers(array $arguments = [])
+ * @method iterable<mixed>            iterateConversationsReplies(array $arguments = [])
+ * @method iterable<mixed>            iterateFilesInfo(array $arguments = [])
+ * @method iterable<ObjsSubteam>      iterateUsergroupsList(array $arguments = [])
+ * @method iterable<mixed>            iterateReactionsList(array $arguments = [])
+ * @method iterable<mixed>            iterateStarsList(array $arguments = [])
+ * @method iterable<ObjsUser>         iterateUsersList(array $arguments = [])
+ */
 class Client extends ApiClient
 {
     public const CURSOR_PAGINATION = [
-        'channelsList' => 'channels',
         'conversationsHistory' => 'messages',
         'conversationsList' => 'channels',
         'conversationsMembers' => 'members',
         'conversationsReplies' => 'messages',
         'filesInfo' => 'comments',
-        'groupsList' => 'groups',
-        'imList' => 'ims',
-        'mpimList' => 'groups',
+        'usergroupsList' => 'usergroups',
         'reactionsList' => 'items',
         'starsList' => 'items',
         'usersList' => 'members',

tests/ClientTest.php

@@ -14,6 +14,7 @@
 namespace JoliCode\Slack\Tests;
 
 use JoliCode\Slack\Api\Model\ObjsUser;
+use JoliCode\Slack\Client;
 
 class ClientTest extends SlackTokenDependentTest
 {
@@ -52,4 +53,65 @@ public function testItThrowsExceptionOnUnknownMethod(): void
 
         $client->foobar();
     }
+
+    public function testAllCursorPaginationMethodExists()
+    {
+        $client = $this->createClient();
+
+        foreach (Client::CURSOR_PAGINATION as $methodName => $getterMethod) {
+            $getterMethod = 'get' . $getterMethod;
+            $method = lcfirst(str_replace('iterate', '', $methodName));
+
+            $responseFromMethod = $client->{$method}($this->argumentsForCursorPaginationRequest($method, $client));
+
+            self::assertTrue(
+                method_exists($responseFromMethod, $getterMethod),
+                \sprintf('Expected that response from %s would contain method %s', $method, $getterMethod)
+            );
+        }
+    }
+
+    private function argumentsForCursorPaginationRequest(string $method, Client $client): array
+    {
+        if (\in_array($method, ['conversationsMembers', 'conversationsHistory'])) {
+            return ['channel' => $_SERVER['SLACK_TEST_CHANNEL']];
+        }
+
+        if ('conversationsReplies' === $method) {
+            return [
+                'channel' => $_SERVER['SLACK_TEST_CHANNEL'],
+                'ts' => $this->findLastThreadTsInChannel($client),
+            ];
+        }
+
+        if ('filesInfo' === $method) {
+            return ['file' => $this->findLastFileIdInChannel($client)];
+        }
+
+        return [];
+    }
+
+    private function findLastThreadTsInChannel(Client $client): string
+    {
+        $messages = $client->conversationsHistory([
+            'channel' => $_SERVER['SLACK_TEST_CHANNEL'],
+            'limit' => 100,
+        ])->getMessages();
+
+        foreach ($messages as $message) {
+            if (\is_string($message->getThreadTs()) && $message->getThreadTs() === $message->getTs()) {
+                return $message->getThreadTs();
+            }
+        }
+
+        throw new \RuntimeException('Unable to find thread in your test channel');
+    }
+
+    private function findLastFileIdInChannel(Client $client): string
+    {
+        return $client->filesList(['channel' => $_SERVER['SLACK_TEST_CHANNEL']])
+            ->getFiles()[0]
+            ?->getId() ?? throw new \RuntimeException('Unable to find file in your test channel')
+        ;
+    }
 }