diogo/symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[HttpClient] Add new bearer option

Browse Source
This commit is contained in:
Kévin Dunglas 2019-03-13 14:50:36 +01:00 committed by Fabien Potencier
parent 29f81b003f
commit f79ef21458
5 changed files with 58 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/Symfony/Component/HttpClient/HttpClientTrait.php
View File

@ -71,18 +71,30 @@ trait HttpClientTrait
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['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['auth_bearer'] ?? false) && !($headers['authorization'] ?? false)) {
$rawHeaders[] = 'authorization: '.$headers['authorization'][] = 'Bearer '.$options['auth_bearer'];
}
$options['raw_headers'] = $rawHeaders;
unset($options['auth']);
unset($options['auth_basic'], $options['auth_bearer']);
// Parse base URI
if (\is_string($options['base_uri'])) {

12
src/Symfony/Component/HttpClient/HttpOptions.php
View File

@ -34,13 +34,23 @@ class HttpOptions
/**
* @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
*/

26
src/Symfony/Component/HttpClient/Tests/HttpClientTraitTest.php
View File

@ -13,6 +13,7 @@ namespace Symfony\Component\HttpClient\Tests;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpClient\HttpClientTrait;
use Symfony\Contracts\HttpClient\HttpClientInterface;
class HttpClientTraitTest extends TestCase
{
@ -163,4 +164,29 @@ class HttpClientTraitTest extends TestCase
yield ['/a/', '/a/b/..'];
yield ['/a///b', '/a///b'];
}
public function testAuthBearerOption()
{
[, $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 "auth_bearer" must be string, object given.
*/
public function testInvalidAuthBearerOption()
{
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);
}
}

3
src/Symfony/Contracts/HttpClient/HttpClientInterface.php
View File

@ -26,7 +26,8 @@ use Symfony\Contracts\HttpClient\Test\HttpClientTestCase;
interface HttpClientInterface
{
public const OPTIONS_DEFAULTS = [
'auth' => null, // string - a username:password enabling HTTP Basic authentication
'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

4
src/Symfony/Contracts/HttpClient/Test/HttpClientTestCase.php
View File

@ -214,7 +214,7 @@ abstract class HttpClientTestCase extends TestCase
{
$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 @@ abstract class HttpClientTestCase extends TestCase
$client = $this->getHttpClient();
$response = $client->request('GET', 'http://localhost:8057/301', [
'max_redirects' => 1,
'auth' => 'foo:bar',
'auth_basic' => 'foo:bar',
]);
try {