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

[HttpClient] Allow to pass user/pw as an array

Browse Source
This commit is contained in:
Kévin Dunglas 2019-03-13 18:34:10 +01:00
parent 535c482a4d
commit 8d5096a638
No known key found for this signature in database
GPG Key ID: 4D04EBEF06AAF3A6
5 changed files with 78 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -71,8 +71,17 @@ trait HttpClientTrait
throw new InvalidArgumentException(sprintf('Option "on_progress" must be callable, %s given.', \is_object($onProgress) ? \get_class($onProgress) : \gettype($onProgress)));
}
if (\is_array($options['auth_basic'] ?? null)) {
$count = \count($options['auth_basic']);
if ($count <= 0 || $count > 2) {
throw new InvalidArgumentException(sprintf('Option "auth_basic" must contain 1 or 2 elements, %s given.', $count));
}
$options['auth_basic'] = implode(':', $options['auth_basic']);
}
if (!\is_string($options['auth_basic'] ?? '')) {
throw new InvalidArgumentException(sprintf('Option "auth_basic" must be string, %s given.', \gettype($options['auth_basic'])));
throw new InvalidArgumentException(sprintf('Option "auth_basic" must be string or an array, %s given.', \gettype($options['auth_basic'])));
}
if (!\is_string($options['auth_bearer'] ?? '')) {

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

@ -34,9 +34,12 @@ class HttpOptions
/**
* @return $this
*/
public function setAuthBasic(string $userinfo)
public function setAuthBasic(string $user, string $password = '')
{
$this->options['auth'] = $userinfo;
$this->options['auth_basic'] = $user;
if ('' !== $password) {
$this->options['auth_basic'] .= ':'.$password;
}
return $this;
}

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

@ -185,8 +185,25 @@ class HttpClientTraitTest extends TestCase
* @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()
public function testSetAuthBasicAndBearerOptions()
{
self::prepareRequest('POST', 'http://example.com', ['auth_bearer' => 'foo', 'auth_basic' => 'foo:bar'], HttpClientInterface::OPTIONS_DEFAULTS);
}
public function providePrepareAuthBasic()
{
yield ['foo:bar', 'Zm9vOmJhcg=='];
yield [['foo', 'bar'], 'Zm9vOmJhcg=='];
yield ['foo', 'Zm9v'];
yield [['foo'], 'Zm9v'];
}
/**
* @dataProvider providePrepareAuthBasic
*/
public function testPrepareAuthBasic($arg, $result)
{
[, $options] = $this->prepareRequest('POST', 'http://example.com', ['auth_basic' => $arg], HttpClientInterface::OPTIONS_DEFAULTS);
$this->assertSame('Basic '.$result, $options['headers']['authorization'][0]);
}
}

37
src/Symfony/Component/HttpClient/Tests/HttpOptionsTest.php Normal file
View File

@ -0,0 +1,37 @@
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\HttpClient\Tests;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpClient\HttpOptions;
/**
* @author Kévin Dunglas <dunglas@gmail.com>
*/
class HttpOptionsTest extends TestCase
{
public function provideSetAuth()
{
yield ['user:password', 'user', 'password'];
yield ['user:password', 'user:password'];
yield ['user', 'user'];
yield ['user:0', 'user', '0'];
}
/**
* @dataProvider provideSetAuth
*/
public function testSetAuth(string $expected, string $user, string $password = '')
{
$this->assertSame($expected, (new HttpOptions())->setAuthBasic($user, $password)->toArray()['auth_basic']);
}
}

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

@ -26,7 +26,9 @@ use Symfony\Contracts\HttpClient\Test\HttpClientTestCase;
interface HttpClientInterface
{
public const OPTIONS_DEFAULTS = [
'auth_basic' => null, // string - a username:password enabling HTTP Basic authentication (RFC 7617)
'auth_basic' => null, // array|string - an array containing the username as first value, and optionally the
// password as the second one; or string like 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
@ -37,16 +39,16 @@ interface HttpClientInterface
// the JSON-encoded value and set the "content-type" headers to a JSON-compatible
// value it is they are not defined - typically "application/json"
'user_data' => null, // mixed - any extra data to attach to the request (scalar, callable, object...) that
// MUST be available via $response->getInfo('data') - not used internally
// MUST be available via $response->getInfo('data') - not used internally
'max_redirects' => 20, // int - the maximum number of redirects to follow; a value lower or equal to 0 means
// redirects should not be followed; "Authorization" and "Cookie" headers MUST
// NOT follow except for the initial host name
// redirects should not be followed; "Authorization" and "Cookie" headers MUST
// NOT follow except for the initial host name
'http_version' => null, // string - defaults to the best supported version, typically 1.1 or 2.0
'base_uri' => null, // string - the URI to resolve relative URLs, following rules in RFC 3986, section 2
'buffer' => true, // bool - whether the content of the response should be buffered or not
'on_progress' => null, // callable(int $dlNow, int $dlSize, array $info) - throwing any exceptions MUST abort
// the request; it MUST be called on DNS resolution, on arrival of headers and on
// completion; it SHOULD be called on upload/download of data and at least 1/s
// the request; it MUST be called on DNS resolution, on arrival of headers and on
// completion; it SHOULD be called on upload/download of data and at least 1/s
'resolve' => [], // string[] - a map of host to IP address that SHOULD replace DNS resolution
'proxy' => null, // string - by default, the proxy-related env vars handled by curl SHOULD be honored
'no_proxy' => null, // string - a comma separated list of hosts that do not require a proxy to be reached