Merge pull request #69 from jolicode/collection-client-decorator

Introduce client decorator to handle collection

Author: pyrech

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+* Add a new Client to ease iteration over Slack paginated endpoints thanks to `iterateXxxx` methods (where `xxxx` is the endpoint name to iterate over)
+
 ## 4.1.1 (2021-03-16)
 
 * Upgrade Jane to from 6.3.3 to v6.3.5, fix an error with very long string / payload

composer.json

@@ -38,7 +38,7 @@
         "symfony/http-client": "^4.3.3 || ^5.1",
         "nyholm/psr7": "^1.2",
         "friendsofphp/php-cs-fixer": "^2.17",
-        "symfony/phpunit-bridge": "^4.3",
+        "symfony/phpunit-bridge": "^5.2",
         "opis/json-schema": "^1.0",
         "symfony/console": "^5.1",
         "symfony/contracts": "^2.1",

doc/examples/retrieve-users.php

@@ -8,21 +8,9 @@
 
 $client = ClientFactory::create('Your token');
 
-/** @var ObjsUser[] $users */
-$users = [];
-$cursor = '';
-
 try {
-    do {
-        // This method requires your token to have the scope "users:read"
-        $response = $client->usersList([
-            'limit' => 200,
-            'cursor' => $cursor,
-        ]);
-
-        $users = array_merge($users, $response->getMembers());
-        $cursor = $response->getResponseMetadata() ? $response->getResponseMetadata()->getNextCursor() : '';
-    } while (!empty($cursor));
+    /** @var ObjsUser[] $users */
+    $users = iterator_to_array($client->iterateUsersList());
 
     echo sprintf('Here is the names of the members of your workspace: %s', implode(', ', array_map(function(ObjsUser $user) {
         return $user->getName();

src/Client.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of JoliCode's Slack PHP API project.
+ *
+ * (c) JoliCode <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace JoliCode\Slack;
+
+use JoliCode\Slack\Api\Client as ApiClient;
+
+class Client extends ApiClient
+{
+    const CURSOR_PAGINATION = [
+        'channelsList' => 'channels',
+        'conversationsHistory' => 'messages',
+        'conversationsList' => 'channels',
+        'conversationsMembers' => 'members',
+        'conversationsReplies' => 'messages',
+        'filesInfo' => 'comments',
+        'groupsList' => 'groups',
+        'imList' => 'ims',
+        'mpimList' => 'groups',
+        'reactionsList' => 'items',
+        'starsList' => 'items',
+        'usersList' => 'members',
+    ];
+
+    public function __call(string $name, $arguments)
+    {
+        $method = lcfirst(str_replace('iterate', '', $name));
+
+        if (isset(self::CURSOR_PAGINATION[$method])) {
+            return $this->iterate($method, $arguments);
+        }
+
+        throw new \BadMethodCallException(sprintf('Unknown method %s::%s()', self::class, $name));
+    }
+
+    public function iterate(string $method, array $arguments): iterable
+    {
+        $getter = 'get'.self::CURSOR_PAGINATION[$method];
+
+        $arguments[0] = $arguments[0] ?? [];
+        $arguments[0]['limit'] = $arguments[0]['limit'] ?? 1000;
+
+        $cursor = '';
+
+        do {
+            $arguments[0]['cursor'] = $cursor;
+
+            $response = $this->{$method}(...$arguments);
+
+            foreach ($response->{$getter}() as $item) {
+                yield $item;
+            }
+
+            $cursor = $response->getResponseMetadata() ? $response->getResponseMetadata()->getNextCursor() : '';
+        } while (!empty($cursor));
+    }
+}

src/ClientFactory.php

@@ -18,7 +18,6 @@
 use Http\Client\Common\PluginClient;
 use Http\Discovery\Psr17FactoryDiscovery;
 use Http\Discovery\Psr18ClientDiscovery;
-use JoliCode\Slack\Api\Client;
 use JoliCode\Slack\HttpPlugin\AddSlackPathAndHostPlugin;
 use JoliCode\Slack\HttpPlugin\SlackErrorPlugin;
 use Psr\Http\Client\ClientInterface;
@@ -43,7 +42,7 @@ public static function create(string $token, ClientInterface $httpClient = null)
             ]),
         ]);
 
-        // Instantiate an OpenApi client generated by Jane
+        // Instantiate our client extending the one generated by Jane
         return Client::create($pluginClient);
     }
 }

tests/ClientTest.php

@@ -0,0 +1,64 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of JoliCode's Slack PHP API project.
+ *
+ * (c) JoliCode <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace JoliCode\Slack\Tests;
+
+use JoliCode\Slack\Api\Model\ObjsUser;
+use JoliCode\Slack\ClientFactory;
+use PHPUnit\Framework\TestCase;
+
+class ClientTest extends TestCase
+{
+    protected function setUp(): void
+    {
+        if (!\array_key_exists('SLACK_TOKEN', $_SERVER)) {
+            $this->markTestSkipped('SLACK_TOKEN env var not present, skip the test.');
+        }
+    }
+
+    public function testItCanIterate()
+    {
+        $client = ClientFactory::create($_SERVER['SLACK_TOKEN']);
+
+        $users = $client->iterateUsersList([
+            'limit' => 1000,
+        ]);
+
+        self::assertIsIterable($users);
+
+        $users = iterator_to_array($users);
+
+        self::assertGreaterThan(1000, \count($users));
+        self::assertInstanceOf(ObjsUser::class, $users[0]);
+    }
+
+    public function testItThrowsExceptionOnUnknownIterate()
+    {
+        $client = ClientFactory::create($_SERVER['SLACK_TOKEN']);
+
+        self::expectException(\BadMethodCallException::class);
+        self::expectExceptionMessage('Unknown method JoliCode\Slack\Client::iterateFooBar()');
+
+        $client->iterateFooBar();
+    }
+
+    public function testItThrowsExceptionOnUnknownMethod()
+    {
+        $client = ClientFactory::create($_SERVER['SLACK_TOKEN']);
+
+        self::expectException(\BadMethodCallException::class);
+        self::expectExceptionMessage('Unknown method JoliCode\Slack\Client::foobar()');
+
+        $client->foobar();
+    }
+}