Merge pull request #51 from packagist/f/improved-ux

Improve developer UX for token API

Author: glaubinix

src/Api/Tokens.php

@@ -20,6 +20,10 @@ public function all()
 
     public function create(array $tokenData)
     {
+        if (isset($tokenData['teamId'], $tokenData['accessToAllPackages'])) {
+            throw new InvalidArgumentException('Only set either "accessToAllPackages" or "teamId"');
+        }
+
         return $this->post('/tokens/', $tokenData);
     }
 

src/HttpClient/Plugin/ExceptionThrower.php

@@ -47,7 +47,15 @@ protected function doHandleRequest(RequestInterface $request, callable $next, ca
                 }
             }
 
-            throw new HttpTransportException(isset($content['message']) ? $content['message'] : $content, $response->getStatusCode(), $request->getUri());
+            if (isset($content['message'])) {
+                $message = $content['message'];
+            } elseif (is_string($content)) {
+                $message = $content;
+            } else {
+                $message = json_encode($content);
+            }
+
+            throw new HttpTransportException($message, $response->getStatusCode(), $request->getUri());
         });
     }
 }

src/HttpClient/Plugin/RequestSignature.php

@@ -27,6 +27,10 @@ class RequestSignature implements Plugin
      */
     public function __construct($token, $secret)
     {
+        if (!$token || !$secret) {
+            throw new \InvalidArgumentException('$token and $secret must be set');
+        }
+
         $this->token = $token;
         $this->secret = $secret;
     }

tests/Api/TokensTest.php

@@ -67,6 +67,22 @@ public function testCreate()
         ]));
     }
 
+    public function testCreateTeamIdAndAllAccess()
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        /** @var Tokens&MockObject $api */
+        $api = $this->getApiMock();
+        $api->expects($this->never())
+            ->method('post');
+
+        $api->create([
+            'description' => 'Team Token',
+            'access' => 'read',
+            'teamId' => 1,
+            'accessToAllPackages' => true,
+        ]);
+    }
+
     public function testRemove()
     {
         $expected = [];

tests/HttpClient/Plugin/RequestSignatureTest.php

@@ -65,4 +65,23 @@ public function testPrefixRequestPathSmoke()
 
         $this->assertNotNull($promise->wait(true)->getHeader('Authorization')[0]);
     }
+
+    /**
+     * @dataProvider tokenSecretProvider
+     */
+    public function testMissingTokenOrSecret(string $token, string $secret): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        new RequestSignature($token, $secret);
+    }
+
+    public function tokenSecretProvider(): array
+    {
+        return [
+            ['', ''],
+            ['token', ''],
+            ['', 'secret'],
+        ];
+    }
 }