Add support for using Buzz\Browser instance (fixes #2)

composer.json

@@ -17,6 +17,7 @@
         "php-http/discovery": "^0.9"
     },
     "require-dev": {
+        "ext-curl": "*",
         "php-http/adapter-integration-tests": "^0.3",
         "php-http/client-common": "^1.0",
         "guzzlehttp/psr7": "^1.2",

src/Client.php

@@ -2,10 +2,13 @@
 
 namespace Http\Adapter\Buzz;
 
+use Buzz\Browser;
 use Buzz\Client\ClientInterface;
+use Buzz\Client\Curl;
 use Buzz\Client\FileGetContents;
 use Buzz\Exception as BuzzException;
 use Buzz\Message\Request as BuzzRequest;
+use Buzz\Message\RequestInterface as BuzzRequestInterface;
 use Buzz\Message\Response as BuzzResponse;
 use Http\Client\HttpClient;
 use Http\Discovery\MessageFactoryDiscovery;
@@ -30,13 +33,28 @@ class Client implements HttpClient
     private $messageFactory;
 
     /**
-     * @param FileGetContents|null $client
-     * @param MessageFactory|null  $messageFactory
+     * @param ClientInterface|Browser|null $client
+     * @param MessageFactory|null          $messageFactory
      */
-    public function __construct(FileGetContents $client = null, MessageFactory $messageFactory = null)
+    public function __construct($client = null, MessageFactory $messageFactory = null)
     {
-        $this->client = $client ?: new FileGetContents();
-        $this->client->setMaxRedirects(0);
+        $this->client = $client;
+
+        if ($this->client === null) {
+            $this->client = new FileGetContents();
+            $this->client->setMaxRedirects(0);
+        }
+
+        if ((!$this->client instanceof ClientInterface) && (!$this->client instanceof Browser)) {
+            throw new \InvalidArgumentException(
+                sprintf(
+                    'The client passed to the Buzz adapter must either implement %s or be an instance of %s. You passed %s.',
+                    ClientInterface::class,
+                    Browser::class,
+                    is_object($client) ? get_class($client) : gettype($client)
+                )
+            );
+        }
 
         $this->messageFactory = $messageFactory ?: MessageFactoryDiscovery::find();
     }
@@ -46,6 +64,8 @@ public function __construct(FileGetContents $client = null, MessageFactory $mess
      */
     public function sendRequest(RequestInterface $request)
     {
+        $this->assertRequestHasValidBody($request);
+
         $buzzRequest = $this->createRequest($request);
 
         try {
@@ -133,4 +153,31 @@ private function getBuzzHeaders(BuzzResponse $response)
 
         return $headers;
     }
+
+    /**
+     * Assert that the request has a valid body based on the request method.
+     *
+     * @param RequestInterface $request
+     */
+    private function assertRequestHasValidBody(RequestInterface $request)
+    {
+        $validMethods = [
+            BuzzRequestInterface::METHOD_POST,
+            BuzzRequestInterface::METHOD_PUT,
+            BuzzRequestInterface::METHOD_DELETE,
+            BuzzRequestInterface::METHOD_PATCH,
+            BuzzRequestInterface::METHOD_OPTIONS,
+        ];
+
+        // The Buzz Curl client does not send request bodies for request methods such as GET, HEAD and TRACE. Instead of
+        // silently ignoring the request body in these cases, throw an exception to make users aware.
+        if ($this->client instanceof Curl &&
+            $request->getBody()->getSize() &&
+            !in_array(strtoupper($request->getMethod()), $validMethods, true)
+        ) {
+            throw new \InvalidArgumentException(
+                sprintf('%s does not support %s requests with a body', Curl::class, $request->getMethod())
+            );
+        }
+    }
 }

tests/BrowserHttpAdapterTest.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Http\Adapter\Buzz\Tests;
+
+use Buzz\Browser;
+use Buzz\Client\FileGetContents;
+
+class BrowserHttpAdapterTest extends HttpAdapterTest
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function createBuzzClient()
+    {
+        $browser = new Browser();
+        $browser->getClient()->setMaxRedirects(0);
+
+        return $browser;
+    }
+}

tests/CurlHttpAdapterTest.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Http\Adapter\Buzz\Tests;
+
+use Buzz\Client\Curl;
+use Http\Adapter\Buzz\Client;
+use Buzz\Message\RequestInterface as BuzzRequestInterface;
+
+class CurlHttpAdapterTest extends HttpAdapterTest
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function createBuzzClient()
+    {
+        $curl = new Curl();
+        $curl->setMaxRedirects(0);
+
+        return $curl;
+    }
+
+    /**
+     * @dataProvider requestProvider
+     * @group        integration
+     */
+    public function testSendRequest($method, $uri, array $headers, $body)
+    {
+        $validMethods = [
+            BuzzRequestInterface::METHOD_POST,
+            BuzzRequestInterface::METHOD_PUT,
+            BuzzRequestInterface::METHOD_DELETE,
+            BuzzRequestInterface::METHOD_PATCH,
+            BuzzRequestInterface::METHOD_OPTIONS,
+        ];
+
+        if (!in_array($method, $validMethods, true) && $body) {
+            $this->setExpectedException(
+                \InvalidArgumentException::class,
+                sprintf('Buzz\Client\Curl does not support %s requests with a body', $method)
+            );
+        }
+
+        parent::testSendRequest($method, $uri, $headers, $body);
+    }
+
+    /**
+     * @dataProvider requestWithOutcomeProvider
+     * @group        integration
+     */
+    public function testSendRequestWithOutcome($uriAndOutcome, $protocolVersion, array $headers, $body)
+    {
+        if ($body && $protocolVersion === '1.1') {
+            $this->setExpectedException(
+                \InvalidArgumentException::class,
+                'Buzz\Client\Curl does not support GET requests with a body'
+            );
+        }
+
+        parent::testSendRequestWithOutcome($uriAndOutcome, $protocolVersion, $headers, $body);
+    }
+}

tests/DefaultHttpAdapterTest.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Http\Adapter\Buzz\Tests;
+
+class DefaultHttpAdapterTest extends HttpAdapterTest
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function createBuzzClient()
+    {
+        // returning null here should cause the adapter to create a default client for us
+        return null;
+    }
+}

tests/FileGetContentsHttpAdapterTest.php

@@ -14,6 +14,9 @@ class FileGetContentsHttpAdapterTest extends HttpAdapterTest
      */
     protected function createBuzzClient()
     {
-        return new FileGetContents();
+        $fileGetContents = new FileGetContents();
+        $fileGetContents->setMaxRedirects(0);
+
+        return $fileGetContents;
     }
 }

tests/InvalidHttpAdapterTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Http\Adapter\Buzz\Tests;
+
+use Http\Adapter\Buzz\Client;
+use Http\Message\MessageFactory\GuzzleMessageFactory;
+
+class InvalidHttpAdapterTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage The client passed to the Buzz adapter must either implement Buzz\Client\ClientInterface
+     * or be an instance of Buzz\Browser. You passed stdClass.
+     */
+    public function testConstructorThrowsExceptionWhenInvalidClientInstanceIsUsed()
+    {
+        return new Client(
+            new \stdClass(),
+            new GuzzleMessageFactory()
+        );
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage The client passed to the Buzz adapter must either implement Buzz\Client\ClientInterface
+     * or be an instance of Buzz\Browser. You passed string.
+     */
+    public function testConstructorThrowsExceptionWhenNonObjectClientIsUsed()
+    {
+        return new Client(
+            'This should be an object!',
+            new GuzzleMessageFactory()
+        );
+    }
+}