Improve example code to be more consistent

Author: clue

README.md

@@ -84,9 +84,9 @@ to google.com via a local SOCKS proxy server:
 ```php
 $loop = React\EventLoop\Factory::create();
 $connector = new React\Socket\Connector($loop);
-$client = new Clue\React\Socks\Client('127.0.0.1:1080', $connector);
+$proxy = new Clue\React\Socks\Client('127.0.0.1:1080', $connector);
 
-$client->connect('tcp://www.google.com:80')->then(function (React\Socket\ConnectionInterface $connection) {
+$proxy->connect('tcp://www.google.com:80')->then(function (React\Socket\ConnectionInterface $connection) {
     $connection->write("GET / HTTP/1.0\r\n\r\n");
 
     $connection->on('data', function ($chunk) {
@@ -130,13 +130,13 @@ like this:
 
 ```php
 $connector = new React\Socket\Connector($loop);
-$client = new Clue\React\Socks\Client('127.0.0.1:1080', $connector);
+$proxy = new Clue\React\Socks\Client('127.0.0.1:1080', $connector);
 ```
 
 You can omit the port if you're using the default SOCKS port 1080:
 
 ```php
-$client = new Clue\React\Socks\Client('127.0.0.1', $connector);
+$proxy = new Clue\React\Socks\Client('127.0.0.1', $connector);
 ```
 
 If you need custom connector settings (DNS resolution, TLS parameters, timeouts,
@@ -151,7 +151,7 @@ $connector = new React\Socket\Connector($loop, array(
     )
 ));
 
-$client = new Clue\React\Socks\Client('my-socks-server.local:1080', $connector);
+$proxy = new Clue\React\Socks\Client('my-socks-server.local:1080', $connector);
 ```
 
 This is one of the two main classes in this package.
@@ -169,9 +169,9 @@ This makes it fairly simple to add SOCKS proxy support to pretty much any
 higher-level component:
 
 ```diff
-- $client = new SomeClient($connector);
+- $acme = new AcmeApi($connector);
 + $proxy = new Clue\React\Socks\Client('127.0.0.1:1080', $connector);
-+ $client = new SomeClient($proxy);
++ $acme = new AcmeApi($proxy);
 ```
 
 #### Plain TCP connections
@@ -183,7 +183,12 @@ As documented above, you can simply invoke its `connect()` method to establish
 a streaming plain TCP/IP connection and use any higher level protocol like so:
 
 ```php
-$client->connect('tcp://www.google.com:80')->then(function (React\Socket\ConnectionInterface $connection) {
+$proxy = new Clue\React\Socks\Client(
+    '127.0.0.1:1080',
+    new React\Socket\Connector($loop)
+);
+
+$proxy->connect('tcp://www.google.com:80')->then(function (React\Socket\ConnectionInterface $connection) {
     echo 'connected to www.google.com:80';
     $connection->write("GET / HTTP/1.0\r\n\r\n");
 
@@ -197,8 +202,13 @@ You can either use the `Client` directly or you may want to wrap this connector
 in ReactPHP's [`Connector`](https://github.com/reactphp/socket#connector):
 
 ```php
+$proxy = new Clue\React\Socks\Client(
+    '127.0.0.1:1080',
+    new React\Socket\Connector($loop)
+);
+
 $connector = new React\Socket\Connector($loop, array(
-    'tcp' => $client,
+    'tcp' => $proxy,
     'dns' => false
 ));
 
@@ -238,8 +248,13 @@ ReactPHP's [`Connector`](https://github.com/reactphp/socket#connector) or the
 low-level [`SecureConnector`](https://github.com/reactphp/socket#secureconnector):
 
 ```php
+$proxy = new Clue\React\Socks\Client(
+    '127.0.0.1:1080',
+    new React\Socket\Connector($loop)
+);
+
 $connector = new React\Socket\Connector($loop, array(
-    'tcp' => $client,
+    'tcp' => $proxy,
     'dns' => false
 ));
 
@@ -274,7 +289,7 @@ to the constructor like this:
 
 ```php
 $connector = new React\Socket\Connector($loop, array(
-    'tcp' => $client,
+    'tcp' => $proxy,
     'tls' => array(
         'verify_peer' => false,
         'verify_peer_name' => false
@@ -294,7 +309,7 @@ This allows you to send both plain HTTP and TLS-encrypted HTTPS requests like th
 
 ```php
 $proxy = new Clue\React\Socks\Client(
-    'socks://127.0.0.1:1080',
+    '127.0.0.1:1080',
     new React\Socket\Connector($loop)
 );
 
@@ -391,16 +406,16 @@ URI scheme acts as an alias for the default `socks://` URI scheme.
 
 ```php
 // all three forms are equivalent
-$client = new Clue\React\Socks\Client('127.0.0.1', $connector);
-$client = new Clue\React\Socks\Client('socks://127.0.0.1', $connector);
-$client = new Clue\React\Socks\Client('socks5://127.0.0.1', $connector);
+$proxy = new Clue\React\Socks\Client('127.0.0.1', $connector);
+$proxy = new Clue\React\Socks\Client('socks://127.0.0.1', $connector);
+$proxy = new Clue\React\Socks\Client('socks5://127.0.0.1', $connector);
 ```
 
 If want to explicitly set the protocol version to SOCKS4(a), you can use the URI
 scheme `socks4://` as part of the SOCKS URI:
 
 ```php
-$client = new Clue\React\Socks\Client('socks4://127.0.0.1', $connector);
+$proxy = new Clue\React\Socks\Client('socks4://127.0.0.1', $connector);
 ```
 
 #### DNS resolution
@@ -429,11 +444,16 @@ However, wrapping the `Client` in ReactPHP's
 [`Connector`](https://github.com/reactphp/socket#connector) actually
 performs local DNS resolution unless explicitly defined otherwise.
 Given that remote DNS resolution is assumed to be the preferred mode, all
-other examples explicitly disable DNS resoltion like this:
+other examples explicitly disable DNS resolution like this:
 
 ```php
+$proxy = new Clue\React\Socks\Client(
+    '127.0.0.1:1080',
+    new React\Socket\Connector($loop)
+);
+
 $connector = new React\Socket\Connector($loop, array(
-    'tcp' => $client,
+    'tcp' => $proxy,
     'dns' => false
 ));
 ```
@@ -442,9 +462,14 @@ If you want to explicitly use *local DNS resolution* (such as when explicitly
 using SOCKS4), you can use the following code:
 
 ```php
+$proxy = new Clue\React\Socks\Client(
+    '127.0.0.1:1080',
+    new React\Socket\Connector($loop)
+);
+
 // set up Connector which uses Google's public DNS (8.8.8.8)
 $connector = new React\Socket\Connector($loop, array(
-    'tcp' => $client,
+    'tcp' => $proxy,
     'dns' => '8.8.8.8'
 ));
 ```
@@ -475,7 +500,7 @@ so this methods should not be used on a network where you have to worry about ea
 You can simply pass the authentication information as part of the SOCKS URI:
 
 ```php
-$client = new Clue\React\Socks\Client('username:[email protected]', $connector);
+$proxy = new Clue\React\Socks\Client('username:[email protected]', $connector);
 ```
 
 Note that both the username and password must be percent-encoded if they contain
@@ -485,7 +510,7 @@ special characters:
 $user = 'he:llo';
 $pass = 'p@ss';
 
-$client = new Clue\React\Socks\Client(
+$proxy = new Clue\React\Socks\Client(
     rawurlencode($user) . ':' . rawurlencode($pass) . '@127.0.0.1',
     $connector
 );
@@ -589,8 +614,13 @@ It provides the same `connect()` method, but will automatically reject the
 underlying connection attempt if it takes too long:
 
 ```php
+$proxy = new Clue\React\Socks\Client(
+    '127.0.0.1:1080',
+    new React\Socket\Connector($loop)
+);
+
 $connector = new React\Socket\Connector($loop, array(
-    'tcp' => $client,
+    'tcp' => $proxy,
     'dns' => false,
     'timeout' => 3.0
 ));
@@ -632,12 +662,12 @@ You can use the `sockss://` URI scheme or use an explicit
 [SOCKS protocol version](#protocol-version) like this:
 
 ```php
-$client = new Clue\React\Socks\Client(
+$proxy = new Clue\React\Socks\Client(
     'sockss://127.0.0.1:1080',
     new React\Socket\Connector($loop)
 );
 
-$client = new Clue\React\Socks\Client(
+$proxy = new Clue\React\Socks\Client(
     'socks4s://127.0.0.1:1080',
     new React\Socket\Connector($loop)
 );
@@ -649,7 +679,7 @@ Similarly, you can also combine this with [authentication](#authentication)
 like this:
 
 ```php
-$client = new Clue\React\Socks\Client(
+$proxy = new Clue\React\Socks\Client(
     'sockss://user:[email protected]:1080',
     new React\Socket\Connector($loop)
 );
@@ -684,12 +714,12 @@ You can use the `socks+unix://` URI scheme or use an explicit
 [SOCKS protocol version](#protocol-version) like this:
 
 ```php
-$client = new Clue\React\Socks\Client(
+$proxy = new Clue\React\Socks\Client(
     'socks+unix:///tmp/proxy.sock'
     new React\Socket\Connector($loop)
 );
 
-$client = new Clue\React\Socks\Client(
+$proxy = new Clue\React\Socks\Client(
     'socks4+unix:///tmp/proxy.sock',
     new React\Socket\Connector($loop)
 );
@@ -699,7 +729,7 @@ Similarly, you can also combine this with [authentication](#authentication)
 like this:
 
 ```php
-$client = new Clue\React\Socks\Client(
+$proxy = new Clue\React\Socks\Client(
     'socks+unix://user:pass@/tmp/proxy.sock',
     new React\Socket\Connector($loop)
 );
@@ -865,10 +895,10 @@ $loop = React\EventLoop\Factory::create();
 
 // set next SOCKS server example.com:1080 as target
 $connector = new React\Socket\Connector($loop);
-$client = new Clue\React\Socks\Client('user:[email protected]:1080', $connector);
+$proxy = new Clue\React\Socks\Client('user:[email protected]:1080', $connector);
 
 // start a new server which forwards all connections to the other SOCKS server
-$server = new Clue\React\Socks\Server($loop, $client);
+$server = new Clue\React\Socks\Server($loop, $proxy);
 
 // listen on localhost:1080
 $socket = new React\Socket\Server('127.0.0.1:1080', $loop);
@@ -1005,7 +1035,18 @@ $ ssh -D 1080 example.com
 Now you can simply use this SSH SOCKS server like this:
 
 ```PHP
-$client = new Clue\React\Socks\Client('127.0.0.1:1080', $connector);
+$proxy = new Clue\React\Socks\Client(
+    '127.0.0.1:1080',
+    new React\Socket\Connector($loop)
+);
+
+$proxy->connect('tcp://www.google.com:80')->then(function (React\Socket\ConnectionInterface $connection) {
+    $connection->write("GET / HTTP/1.0\r\n\r\n");
+
+    $connection->on('data', function ($chunk) {
+        echo $chunk;
+    });
+});
 ```
 
 Note that the above will allow all users on the local system to connect over
@@ -1021,7 +1062,18 @@ $ ssh -D/tmp/proxy.sock example.com
 Now you can simply use this SSH SOCKS server like this:
 
 ```PHP
-$client = new Clue\React\Socks\Client('socks+unix:///tmp/proxy.sock', $connector);
+$proxy = new Clue\React\Socks\Client(
+    'socks+unix:///tmp/proxy.sock',
+    new React\Socket\Connector($loop)
+);
+
+$proxy->connect('tcp://www.google.com:80')->then(function (React\Socket\ConnectionInterface $connection) {
+    $connection->write("GET / HTTP/1.0\r\n\r\n");
+
+    $connection->on('data', function ($chunk) {
+        echo $chunk;
+    });
+});
 ```
 
 > As an alternative to requiring this manual setup, you may also want to look
@@ -1038,7 +1090,18 @@ It presents a SOCKS5 and SOCKS4(a) interface on TCP port 9050 by default
 which allows you to tunnel any traffic through the anonymity network:
 
 ```php
-$client = new Clue\React\Socks\Client('127.0.0.1:9050', $connector);
+$proxy = new Clue\React\Socks\Client(
+    '127.0.0.1:9050',
+    new React\Socket\Connector($loop)
+);
+
+$proxy->connect('tcp://www.google.com:80')->then(function (React\Socket\ConnectionInterface $connection) {
+    $connection->write("GET / HTTP/1.0\r\n\r\n");
+
+    $connection->on('data', function ($chunk) {
+        echo $chunk;
+    });
+});
 ```
 
 In most common scenarios you probably want to stick to default

examples/01-https-request.php

@@ -22,10 +22,13 @@
 }
 
 $loop = React\EventLoop\Factory::create();
-$client = new Clue\React\Socks\Client($url, new React\Socket\Connector($loop));
+$proxy = new Clue\React\Socks\Client(
+    $url,
+    new React\Socket\Connector($loop)
+);
 
 $connector = new React\Socket\Connector($loop, array(
-    'tcp' => $client,
+    'tcp' => $proxy,
     'timeout' => 3.0,
     'dns' => false
 ));
@@ -37,5 +40,5 @@
 }, function (Exception $e) {
     echo 'Error: ' . $e->getMessage() . PHP_EOL;
 });
-    
+
 $loop->run();

examples/02-optional-proxy-https-request.php

@@ -20,10 +20,12 @@
 $connector = null;
 $url = getenv('socks_proxy');
 if ($url !== false) {
-    $connector = new React\Socket\Connector($loop);
-    $client = new Clue\React\Socks\Client($url, $connector);
+    $proxy = new Clue\React\Socks\Client(
+        $url,
+        new React\Socket\Connector($loop)
+    );
     $connector = new React\Socket\Connector($loop, array(
-        'tcp' => $client,
+        'tcp' => $proxy,
         'timeout' => 3.0,
         'dns' => false
     ));

examples/11-proxy-raw-http-protocol.php

@@ -26,9 +26,12 @@
 
 $loop = React\EventLoop\Factory::create();
 
-$client = new Clue\React\Socks\Client($url, new React\Socket\Connector($loop));
+$proxy = new Clue\React\Socks\Client(
+    $url,
+    new React\Socket\Connector($loop)
+);
 $connector = new React\Socket\Connector($loop, array(
-    'tcp' => $client,
+    'tcp' => $proxy,
     'timeout' => 3.0,
     'dns' => false
 ));

examples/12-optional-proxy-raw-http-protocol.php

@@ -28,9 +28,9 @@
 
 $url = getenv('socks_proxy');
 if ($url !== false) {
-    $client = new Clue\React\Socks\Client($url, $connector);
+    $proxy = new Clue\React\Socks\Client($url, $connector);
     $connector = new React\Socket\Connector($loop, array(
-        'tcp' => $client,
+        'tcp' => $proxy,
         'timeout' => 3.0,
         'dns' => false
     ));