Support authentication with URL-encoded special characters

Author: clue

README.md

@@ -121,6 +121,7 @@ $factory = new Clue\React\Ami\Factory($loop, $connector);
 
 The `createClient(string $url): PromiseInterface<Client,Exception>` method can be used to
 create a new [`Client`](#client).
+
 It helps with establishing a plain TCP/IP or secure TLS connection to the AMI
 and optionally issuing an initial `login` action.
 
@@ -154,6 +155,18 @@ to pass a username and secret for your AMI login details like this:
 $factory->createClient('user:secret@localhost');
 ```
 
+Note that both the username and password must be URL-encoded (percent-encoded)
+if they contain special characters:
+
+```php
+$user = 'he:llo';
+$pass = 'p@ss';
+
+$promise = $factory->createClient(
+    rawurlencode($user) . ':' . rawurlencode($pass) . '@localhost'
+);
+```
+
 The `Factory` defaults to establishing a plaintext TCP connection.
 If you want to create a secure TLS connection, you can use the `tls` scheme
 (which defaults to port `5039`):

src/Factory.php

@@ -52,6 +52,7 @@ public function __construct(LoopInterface $loop, ConnectorInterface $connector =
 
     /**
      * Create a new [`Client`](#client).
+     *
      * It helps with establishing a plain TCP/IP or secure TLS connection to the AMI
      * and optionally issuing an initial `login` action.
      *
@@ -85,6 +86,18 @@ public function __construct(LoopInterface $loop, ConnectorInterface $connector =
      * $factory->createClient('user:secret@localhost');
      * ```
      *
+     * Note that both the username and password must be URL-encoded (percent-encoded)
+     * if they contain special characters:
+     *
+     * ```php
+     * $user = 'he:llo';
+     * $pass = 'p@ss';
+     *
+     * $promise = $factory->createClient(
+     *     rawurlencode($user) . ':' . rawurlencode($pass) . '@localhost'
+     * );
+     * ```
+     *
      * The `Factory` defaults to establishing a plaintext TCP connection.
      * If you want to create a secure TLS connection, you can use the `tls` scheme
      * (which defaults to port `5039`):
@@ -116,7 +129,7 @@ public function createClient($url)
             $promise = $promise->then(function (Client $client) use ($parts) {
                 $sender = new ActionSender($client);
 
-                return $sender->login($parts['user'], $parts['pass'])->then(
+                return $sender->login(rawurldecode($parts['user']), rawurldecode($parts['pass']))->then(
                     function ($response) use ($client) {
                         return $client;
                     },

tests/FactoryTest.php

@@ -54,6 +54,49 @@ public function testCreateClientUsesTlsConnectorWithTlsLocation()
         $this->factory->createClient('tls://ami.local:1234');
     }
 
+    public function testCreateClientResolvesWithClientWhenConnectionResolves()
+    {
+        $connection = $this->getMockBuilder('React\Socket\ConnectionInterface')->getMock();
+        $this->tcp->expects($this->once())->method('connect')->willReturn(\React\Promise\resolve($connection));
+
+        $promise = $this->factory->createClient('localhost');
+
+        $client = null;
+        $promise->then(function ($value) use (&$client) {
+            $client = $value;
+        });
+
+        $this->assertInstanceOf('Clue\React\Ami\Client', $client);
+    }
+
+    public function testCreateClientWithAuthenticationWillSendLoginActionWithDecodedUserInfo()
+    {
+        $promiseAuthenticated = $this->getMockBuilder('React\Promise\PromiseInterface')->getMock();
+
+        $clientConnected = null;
+        $promiseClient = $this->getMockBuilder('React\Promise\PromiseInterface')->getMock();
+        $promiseClient->expects($this->once())->method('then')->with($this->callback(function ($callback) use (&$clientConnected) {
+            $clientConnected = $callback;
+            return true;
+        }))->willReturn($promiseAuthenticated);
+
+        $promiseConnecting = $this->getMockBuilder('React\Promise\PromiseInterface')->getMock();
+        $promiseConnecting->expects($this->once())->method('then')->willReturn($promiseClient);
+        $this->tcp->expects($this->once())->method('connect')->willReturn($promiseConnecting);
+
+        $action = $this->getMockBuilder('Clue\React\Ami\Protocol\Action')->getMock();
+        $client = $this->getMockBuilder('Clue\React\Ami\Client')->disableOriginalConstructor()->getMock();
+        $client->expects($this->once())->method('createAction')->with('Login', array('UserName' => 'user@host', 'Secret' => 'pass+word!', 'Events' => null))->willReturn($action);
+        $client->expects($this->once())->method('request')->with($action)->willReturn($promiseAuthenticated);
+
+        $promise = $this->factory->createClient('user%40host:pass+word%21@localhost');
+
+        $this->assertSame($promiseAuthenticated, $promise);
+
+        $this->assertNotNull($clientConnected);
+        $clientConnected($client);
+    }
+
     public function testCreateClientWithInvalidUrlWillRejectPromise()
     {
         $promise = $this->factory->createClient('///');