Support redis:// URI scheme and deprecate default tcp:// URI scheme

Author: clue

README.md

@@ -111,7 +111,7 @@ It helps with establishing a plain TCP/IP connection to Redis
 and optionally authenticating (AUTH) and selecting the right database (SELECT).
 
 ```php
-$factory->createClient('localhost:6379')->then(
+$factory->createClient('redis://localhost:6379')->then(
     function (Client $client) {
         // client connected (and authenticated)
     },
@@ -121,26 +121,37 @@ $factory->createClient('localhost:6379')->then(
 );
 ```
 
-You can omit the port if you're connecting to the default port 6379:
+The `$redisUri` can be given in the form `[redis://][:auth@]host[:port][/db]`.
+You can omit the URI scheme and port if you're connecting to the default port 6379:
 
 ```php
+// both are equivalent due to defaults being applied
 $factory->createClient('localhost');
+$factory->createClient('redis://localhost:6379');
 ```
 
-You can optionally include a password that will be used to authenticate (AUTH command) the client:
+Redis supports password-based authentication (`AUTH` command). Note that Redis'
+authentication mechanism does not employ a username, so you can pass the
+password "secret" as part of the URI like this:
 
 ```php
-$factory->createClient('auth@localhost');
+$factory->createClient('redis://ignored:secret@localhost');
 ```
 
+> Legacy notice: The `redis://` scheme is defined and preferred as of `v1.2.0`.
+  For BC reasons, the `Factory` defaults to the `tcp://` scheme in which case
+  the authentication details would include the otherwise unused username.
+  This legacy API will be removed in a future `v2.0.0` version, so it's highly
+  recommended to upgrade to the above API.
+
 You can optionally include a path that will be used to select (SELECT command) the right database:
 
 ```php
-$factory->createClient('localhost/2');
+$factory->createClient('redis://localhost/2');
 ```
 
 [Deprecated] You can omit the complete URI if you want to connect to the default
-address `localhost:6379`. This legacy API will be removed in a future
+address `redis://localhost:6379`. This legacy API will be removed in a future
 `v2.0.0` version, so it's highly recommended to upgrade to the above API.
 
 ```php

src/Factory.php

@@ -109,7 +109,7 @@ private function parseUrl($target)
         }
 
         $parts = parse_url($target);
-        if ($parts === false || !isset($parts['host']) || $parts['scheme'] !== 'tcp') {
+        if ($parts === false || !isset($parts['scheme'], $parts['host']) || !in_array($parts['scheme'], array('tcp', 'redis'))) {
             throw new InvalidArgumentException('Given URL can not be parsed');
         }
 
@@ -122,11 +122,11 @@ private function parseUrl($target)
         }
 
         $auth = null;
-        if (isset($parts['user'])) {
+        if (isset($parts['user']) && $parts['scheme'] === 'tcp') {
             $auth = $parts['user'];
         }
         if (isset($parts['pass'])) {
-            $auth .= ':' . $parts['pass'];
+            $auth .= ($parts['scheme'] === 'tcp' ? ':' : '') . $parts['pass'];
         }
         if ($auth !== null) {
             $parts['auth'] = $auth;

tests/FactoryTest.php

@@ -65,10 +65,19 @@ public function testWillWriteSelectCommandIfTargetContainsPath()
         $stream->expects($this->once())->method('write')->with("*2\r\n$6\r\nselect\r\n$4\r\ndemo\r\n");
 
         $this->connector->expects($this->once())->method('connect')->willReturn(Promise\resolve($stream));
-        $this->factory->createClient('tcp://127.0.0.1/demo');
+        $this->factory->createClient('redis://127.0.0.1/demo');
     }
 
-    public function testWillWriteAuthCommandIfTargetContainsUserInfo()
+    public function testWillWriteAuthCommandIfRedisUriContainsUserInfo()
+    {
+        $stream = $this->getMockBuilder('React\Socket\ConnectionInterface')->getMock();
+        $stream->expects($this->once())->method('write')->with("*2\r\n$4\r\nauth\r\n$5\r\nworld\r\n");
+
+        $this->connector->expects($this->once())->method('connect')->willReturn(Promise\resolve($stream));
+        $this->factory->createClient('redis://hello:world@127.0.0.1');
+    }
+
+    public function testWillWriteAuthCommandIfTcpUriContainsUserInfo()
     {
         $stream = $this->getMockBuilder('React\Socket\ConnectionInterface')->getMock();
         $stream->expects($this->once())->method('write')->with("*2\r\n$4\r\nauth\r\n$11\r\nhello:world\r\n");