Consistent end() semantics

Author: clue

README.md

@@ -6,9 +6,21 @@ Basic HTTP/1.0 client.
 
 ## Basic usage
 
-Requests are prepared using the ``Client#request()`` method. Body can be
-sent with ``Request#write()``. ``Request#end()`` finishes sending the request
-(or sends it at all if no body was written).
+Requests are prepared using the ``Client#request()`` method.
+
+The `Request#write(string $data)` method can be used to
+write data to the request body.
+Data will be buffered until the underlying connection is established, at which
+point buffered data will be sent and all further data will be passed to the
+underlying connection immediately.
+
+The `Request#end(?string $data = null)` method can be used to
+finish sending the request.
+You may optionally pass a last request body data chunk that will be sent just
+like a `write()` call.
+Calling this method finalizes the outgoing request body (which may be empty).
+Data will be buffered until the underlying connection is established, at which
+point buffered data will be sent and all further data will be ignored.
 
 Request implements WritableStreamInterface, so a Stream can be piped to it.
 Interesting events emitted by Request:

src/Request.php

@@ -31,6 +31,7 @@ class Request implements WritableStreamInterface
     private $responseFactory;
     private $response;
     private $state = self::STATE_INIT;
+    private $ended = false;
 
     private $pendingWrites = '';
 
@@ -42,7 +43,7 @@ public function __construct(ConnectorInterface $connector, RequestData $requestD
 
     public function isWritable()
     {
-        return self::STATE_END > $this->state;
+        return self::STATE_END > $this->state && !$this->ended;
     }
 
     private function writeHead()
@@ -107,15 +108,17 @@ public function write($data)
 
     public function end($data = null)
     {
-        if (null !== $data && !is_scalar($data)) {
-            throw new \InvalidArgumentException('$data must be null or scalar');
+        if (!$this->isWritable()) {
+            return;
         }
 
         if (null !== $data) {
             $this->write($data);
         } else if (self::STATE_WRITING_HEAD > $this->state) {
             $this->writeHead();
         }
+
+        $this->ended = true;
     }
 
     /** @internal */

tests/RequestTest.php

@@ -7,6 +7,7 @@
 use React\Stream\Stream;
 use React\Promise\RejectedPromise;
 use React\Promise\Deferred;
+use React\Promise\Promise;
 
 class RequestTest extends TestCase
 {
@@ -442,15 +443,36 @@ public function pipeShouldPipeDataIntoTheRequestBody()
 
     /**
      * @test
-     * @expectedException InvalidArgumentException
-     * @expectedExceptionMessage $data must be null or scalar
      */
-    public function endShouldOnlyAcceptScalars()
+    public function writeShouldStartConnecting()
     {
         $requestData = new RequestData('POST', 'http://www.example.com');
         $request = new Request($this->connector, $requestData);
 
-        $request->end(array());
+        $this->connector->expects($this->once())
+                        ->method('connect')
+                        ->with('www.example.com:80')
+                        ->willReturn(new Promise(function () { }));
+
+        $request->write('test');
+    }
+
+    /**
+     * @test
+     */
+    public function endShouldStartConnectingAndChangeStreamIntoNonWritableMode()
+    {
+        $requestData = new RequestData('POST', 'http://www.example.com');
+        $request = new Request($this->connector, $requestData);
+
+        $this->connector->expects($this->once())
+                        ->method('connect')
+                        ->with('www.example.com:80')
+                        ->willReturn(new Promise(function () { }));
+
+        $request->end();
+
+        $this->assertFalse($request->isWritable());
     }
 
     /**
@@ -479,6 +501,21 @@ public function writeAfterCloseReturnsFalse()
         $this->assertFalse($request->write('nope'));
     }
 
+    /**
+     * @test
+     */
+    public function endAfterCloseIsNoOp()
+    {
+        $requestData = new RequestData('POST', 'http://www.example.com');
+        $request = new Request($this->connector, $requestData);
+
+        $this->connector->expects($this->never())
+                        ->method('connect');
+
+        $request->close();
+        $request->end();
+    }
+
     /** @test */
     public function requestShouldRelayErrorEventsFromResponse()
     {