Merge pull request #50 from packagist/t/add-tokens-api

Authentication Tokens: add API endpoints

Author: glaubinix

README.md

@@ -15,6 +15,11 @@
             * [List all private packages a team has access to](#list-all-private-packages-a-team-has-access-to)
             * [Grant a team access to a list of private packages](#grant-a-team-access-to-a-list-of-private-packages)
             * [Remove access for a package from a team](#remove-access-for-a-package-from-a-team)
+         * [Authentication Tokens](#authentication-tokens)
+            * [List an organization's team authentication tokens](#list-an-organizations-team-authentication-tokens)
+            * [Create a new team authentication token](#create-a-new-team-authentication-token)
+            * [Delete a team authentication token](#delete-a-team-authentication-token)
+            * [Regenerate a team authentication token](#regenerate-a-team-authentication-token)
          * [Customer](#customer)
             * [List an organization's customers](#list-an-organizations-customers)
             * [Show a customer](#show-a-customer)
@@ -102,7 +107,7 @@
          * [Validate incoming webhook payloads](#validate-incoming-webhook-payloads)
       * [License](#license)
 
-<!-- Added by: wissem, at: Wed May 26 12:28:19 CEST 2021 -->
+<!-- Added by: glaubinix, at: Thu 13 Jan 2022 13:34:48 GMT -->
 
 <!--te-->
 
@@ -176,6 +181,47 @@ $teamId = 1;
 $packages = $client->teams()->removePackage($teamId, 'acme-website/package');
 ```
 
+### Authentication Tokens
+
+#### List an organization's team authentication tokens
+```php
+$tokens = $client->tokens()->all();
+```
+Returns an array of team tokens.
+
+#### Create a new team authentication token
+```php
+// Create a new token with access to all packages
+$token = $client->tokens()->create([
+    'description' => 'New Team Token',
+    'access' => 'read',
+    'accessToAllPackages' => true,
+]);
+
+// Create a new token with access to packages a team has access to
+$token = $client->tokens()->create([
+    'description' => 'New Team Token',
+    'access' => 'read',
+    'teamId' => 1, // Get teamId from the list of teams to determine to which packages the token has access to
+]);
+```
+Returns the created token.
+
+#### Delete a team authentication token
+```php
+$client->tokens()->remove($tokenId));
+```
+
+#### Regenerate a team authentication token
+```php
+$customerId = 42;
+$confirmation = [
+    'IConfirmOldTokenWillStopWorkingImmediately' => true,
+];
+$token = $client->tokens()->regenerateToken($tokenId, $confirmation);
+```
+Returns the regenerated token.
+
 ### Customer
 
 #### List an organization's customers

src/Api/Tokens.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * (c) Packagist Conductors GmbH <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace PrivatePackagist\ApiClient\Api;
+
+use PrivatePackagist\ApiClient\Exception\InvalidArgumentException;
+
+class Tokens extends AbstractApi
+{
+    public function all()
+    {
+        return $this->get('/tokens/');
+    }
+
+    public function create(array $tokenData)
+    {
+        return $this->post('/tokens/', $tokenData);
+    }
+
+    public function remove($tokenId)
+    {
+        return $this->delete(sprintf('/tokens/%s/', $tokenId));
+    }
+
+    public function regenerate($tokenId, array $confirmation)
+    {
+        if (!isset($confirmation['IConfirmOldTokenWillStopWorkingImmediately'])) {
+            throw new InvalidArgumentException('Confirmation is required to regenerate the Composer repository token.');
+        }
+
+        return $this->post(sprintf('/tokens/%s/regenerate', $tokenId), $confirmation);
+    }
+}

src/Client.php

@@ -97,7 +97,6 @@ public function securityIssues()
         return new Api\SecurityIssues($this, $this->responseMediator);
     }
 
-
     public function jobs()
     {
         return new Api\Jobs($this, $this->responseMediator);
@@ -108,6 +107,11 @@ public function mirroredRepositories()
         return new Api\MirroredRepositories($this, $this->responseMediator);
     }
 
+    public function tokens()
+    {
+        return new Api\Tokens($this, $this->responseMediator);
+    }
+
     public function getHttpClient()
     {
         return $this->getHttpClientBuilder()->getHttpClient();

tests/Api/TokensTest.php

@@ -0,0 +1,105 @@
+<?php
+
+/*
+ * (c) Packagist Conductors GmbH <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace PrivatePackagist\ApiClient\Api;
+
+use PHPUnit\Framework\MockObject\MockObject;
+
+class TokensTest extends ApiTestCase
+{
+    public function testAll()
+    {
+        $expected = [
+            [
+                'description' => 'Team Token',
+                'access' => 'read',
+                'teamId' => 1,
+                'url' => 'https://repo.packagist.com/acme-websites/',
+                'user' => 'token',
+                'token' => 'password',
+                'lastUsed' => '2018-03-14T11:36:00+00:00'
+            ],
+        ];
+
+        /** @var Tokens&MockObject $api */
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('get')
+            ->with($this->equalTo('/tokens/'))
+            ->willReturn($expected);
+
+        $this->assertSame($expected, $api->all());
+    }
+
+    public function testCreate()
+    {
+        $expected = [
+            'description' => 'Team Token',
+            'access' => 'read',
+            'teamId' => 1,
+            'url' => 'https://repo.packagist.com/acme-websites/',
+            'user' => 'token',
+            'token' => 'password',
+            'lastUsed' => '2018-03-14T11:36:00+00:00'
+        ];
+
+        /** @var Tokens&MockObject $api */
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with($this->equalTo('/tokens/'), $this->equalTo([
+                'description' => 'Team Token',
+                'access' => 'read',
+                'teamId' => 1,
+            ]))
+            ->willReturn($expected);
+
+        $this->assertSame($expected, $api->create([
+            'description' => 'Team Token',
+            'access' => 'read',
+            'teamId' => 1,
+        ]));
+    }
+
+    public function testRemove()
+    {
+        $expected = [];
+
+        /** @var Tokens&MockObject $api */
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('delete')
+            ->with($this->equalTo('/tokens/1/'))
+            ->willReturn($expected);
+
+        $this->assertSame($expected, $api->remove(1));
+    }
+
+    public function testRegenerateToken()
+    {
+        $expected = [];
+
+        /** @var Tokens&MockObject $api */
+        $api = $this->getApiMock();
+        $api->expects($this->once())
+            ->method('post')
+            ->with($this->equalTo('/tokens/1/regenerate'), $this->equalTo(['IConfirmOldTokenWillStopWorkingImmediately' => true]))
+            ->willReturn($expected);
+
+        $this->assertSame($expected, $api->regenerate(1, ['IConfirmOldTokenWillStopWorkingImmediately' => true]));
+    }
+
+    /**
+     * @return string
+     */
+    protected function getApiClass()
+    {
+        return Tokens::class;
+    }
+}