Prefix "basic" and "bearer" opts by "auth_"

symfony · Mar 13, 2019 · f262b78 · f262b78
1 parent 190258f
commit f262b78
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 19 deletions.
diff --git a/src/Symfony/Component/HttpClient/HttpClientTrait.php b/src/Symfony/Component/HttpClient/HttpClientTrait.php
@@ -71,26 +71,30 @@ private static function prepareRequest(?string $method, ?string $url, array $opt
             throw new InvalidArgumentException(sprintf('Option "on_progress" must be callable, %s given.', \is_object($onProgress) ? \get_class($onProgress) : \gettype($onProgress)));
         }
 
-        if (!\is_string($options['auth'] ?? '')) {
-            throw new InvalidArgumentException(sprintf('Option "auth" must be string, %s given.', \gettype($options['auth'])));
+        if (!\is_string($options['auth_basic'] ?? '')) {
+            throw new InvalidArgumentException(sprintf('Option "auth_basic" must be string, %s given.', \gettype($options['auth_basic'])));
         }
 
-        if (!\is_string($options['bearer'] ?? '')) {
-            throw new InvalidArgumentException(sprintf('Option "bearer" must be string, %s given.', \gettype($options['bearer'])));
+        if (!\is_string($options['auth_bearer'] ?? '')) {
+            throw new InvalidArgumentException(sprintf('Option "auth_bearer" must be string, %s given.', \gettype($options['auth_bearer'])));
+        }
+
+        if (isset($options['auth_basic'], $options['auth_bearer'])) {
+            throw new InvalidArgumentException('Define either the "auth_basic" or the "auth_bearer" option, setting both is not supported.');
         }
 
         if (null !== $url) {
             // Merge auth with headers
-            if (($options['auth'] ?? false) && !($headers['authorization'] ?? false)) {
-                $rawHeaders[] = 'authorization: '.$headers['authorization'][] = 'Basic '.base64_encode($options['auth']);
+            if (($options['auth_basic'] ?? false) && !($headers['authorization'] ?? false)) {
+                $rawHeaders[] = 'authorization: '.$headers['authorization'][] = 'Basic '.base64_encode($options['auth_basic']);
             }
             // Merge bearer with headers
-            if (($options['bearer'] ?? false) && !($headers['authorization'] ?? false)) {
-                $rawHeaders[] = 'authorization: '.$headers['authorization'][] = 'Bearer '.$options['bearer'];
+            if (($options['auth_bearer'] ?? false) && !($headers['authorization'] ?? false)) {
+                $rawHeaders[] = 'authorization: '.$headers['authorization'][] = 'Bearer '.$options['auth_bearer'];
             }
 
             $options['raw_headers'] = $rawHeaders;
-            unset($options['auth'], $options['bearer']);
+            unset($options['auth_basic'], $options['auth_bearer']);
 
             // Parse base URI
             if (\is_string($options['base_uri'])) {

diff --git a/src/Symfony/Component/HttpClient/HttpOptions.php b/src/Symfony/Component/HttpClient/HttpOptions.php
@@ -34,13 +34,23 @@ public function toArray(): array
     /**
      * @return $this
      */
-    public function setAuth(string $userinfo)
+    public function setAuthBasic(string $userinfo)
     {
         $this->options['auth'] = $userinfo;
 
         return $this;
     }
 
+    /**
+     * @return $this
+     */
+    public function setAuthBearer(string $token)
+    {
+        $this->options['bearer'] = $token;
+
+        return $this;
+    }
+
     /**
      * @return $this
      */

diff --git a/src/Symfony/Component/HttpClient/Tests/HttpClientTraitTest.php b/src/Symfony/Component/HttpClient/Tests/HttpClientTraitTest.php
@@ -165,19 +165,28 @@ public function provideRemoveDotSegments()
         yield ['/a///b', '/a///b'];
     }
 
-    public function testBearerOption()
+    public function testAuthBearerOption()
     {
-        [, $options] = self::prepareRequest('POST', 'http://example.com', ['bearer' => 'foobar'], HttpClientInterface::OPTIONS_DEFAULTS);
+        [, $options] = self::prepareRequest('POST', 'http://example.com', ['auth_bearer' => 'foobar'], HttpClientInterface::OPTIONS_DEFAULTS);
         $this->assertSame('Bearer foobar', $options['headers']['authorization'][0]);
         $this->assertSame('authorization: Bearer foobar', $options['raw_headers'][0]);
     }
 
     /**
      * @expectedException \Symfony\Component\HttpClient\Exception\InvalidArgumentException
-     * @expectedExceptionMessage Option "bearer" must be string, object given.
+     * @expectedExceptionMessage Option "auth_bearer" must be string, object given.
      */
-    public function testInvalidBearerOption()
+    public function testInvalidAuthBearerOption()
     {
-        self::prepareRequest('POST', 'http://example.com', ['bearer' => new \stdClass()], HttpClientInterface::OPTIONS_DEFAULTS);
+        self::prepareRequest('POST', 'http://example.com', ['auth_bearer' => new \stdClass()], HttpClientInterface::OPTIONS_DEFAULTS);
+    }
+
+    /**
+     * @expectedException \Symfony\Component\HttpClient\Exception\InvalidArgumentException
+     * @expectedExceptionMessage Define either the "auth_basic" or the "auth_bearer" option, setting both is not supported.
+     */
+    public function testSetBasicAndBearerOption()
+    {
+        self::prepareRequest('POST', 'http://example.com', ['auth_bearer' => 'foo', 'auth_basic' => 'foo:bar'], HttpClientInterface::OPTIONS_DEFAULTS);
     }
 }
diff --git a/src/Symfony/Contracts/HttpClient/HttpClientInterface.php b/src/Symfony/Contracts/HttpClient/HttpClientInterface.php
@@ -26,8 +26,8 @@
 interface HttpClientInterface
 {
     public const OPTIONS_DEFAULTS = [
-        'auth' => null,         // string - a username:password enabling HTTP Basic authentication (RFC 7617)
-        'bearer' => null,       // string - a token enabling HTTP Bearer authorization (RFC 6750)
+        'auth_basic' => null,   // string - a username:password enabling HTTP Basic authentication (RFC 7617)
+        'auth_bearer' => null,  // string - a token enabling HTTP Bearer authorization (RFC 6750)
         'query' => [],          // string[] - associative array of query string values to merge with the request's URL
         'headers' => [],        // iterable|string[]|string[][] - headers names provided as keys or as part of values
         'body' => '',           // array|string|resource|\Traversable|\Closure - the callback SHOULD yield a string

diff --git a/src/Symfony/Contracts/HttpClient/Test/HttpClientTestCase.php b/src/Symfony/Contracts/HttpClient/Test/HttpClientTestCase.php
@@ -214,7 +214,7 @@ public function testRedirects()
     {
         $client = $this->getHttpClient();
         $response = $client->request('POST', 'http://localhost:8057/301', [
-            'auth' => 'foo:bar',
+            'auth_basic' => 'foo:bar',
             'body' => function () {
                 yield 'foo=bar';
             },
@@ -291,7 +291,7 @@ public function testMaxRedirects()
         $client = $this->getHttpClient();
         $response = $client->request('GET', 'http://localhost:8057/301', [
             'max_redirects' => 1,
-            'auth' => 'foo:bar',
+            'auth_basic' => 'foo:bar',
         ]);
 
         try {