Create interface for HttpClient

Author: barryvdh

src/Common/Http/Client.php

@@ -2,6 +2,7 @@
 
 namespace Omnipay\Common\Http;
 
+use function GuzzleHttp\Psr7\str;
 use Http\Client\HttpClient;
 use Http\Discovery\HttpClientDiscovery;
 use Http\Discovery\MessageFactoryDiscovery;
@@ -11,10 +12,11 @@
 use Psr\Http\Message\StreamInterface;
 use Psr\Http\Message\UriInterface;
 
-class Client implements RequestFactory
+class Client implements ClientInterface
 {
     /**
      * The Http Client which implements `public function sendRequest(RequestInterface $request)`
+     * Note: Will be changed to PSR-18 when released
      *
      * @var HttpClient
      */
@@ -39,32 +41,15 @@ public function __construct($httpClient = null, RequestFactory $requestFactory =
      * @param string $protocolVersion
      * @return ResponseInterface
      */
-    public function request($method, $uri, array $headers = [], $body = null, $protocolVersion = '1.1')
-    {
-        $request = $this->createRequest($method, $uri, $headers, $body, $protocolVersion);
-
-        return $this->sendRequest($request);
-    }
-
-    /**
-     * @param $method
-     * @param $uri
-     * @param array $headers
-     * @param string|resource|StreamInterface|null $body
-     * @param string $protocolVersion
-     * @return RequestInterface
-     */
-    public function createRequest($method, $uri, array $headers = [], $body = null, $protocolVersion = '1.1')
-    {
-        return $this->requestFactory->createRequest($method, $uri, $headers, $body, $protocolVersion);
-    }
+    public function request(
+        string $method,
+        $uri,
+        array $headers = [],
+        $body = null,
+        string $protocolVersion = '1.1'
+    ) : ResponseInterface {
+        $request = $this->requestFactory->createRequest($method, $uri, $headers, $body, $protocolVersion);
 
-    /**
-     * @param  RequestInterface $request
-     * @return ResponseInterface
-     */
-    public function sendRequest(RequestInterface $request)
-    {
         return $this->httpClient->sendRequest($request);
     }
 }

src/Common/Http/ClientInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace Omnipay\Common\Http;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\StreamInterface;
+use Psr\Http\Message\UriInterface;
+
+interface ClientInterface
+{
+    /**
+     * Creates a new PSR-7 request.
+     *
+     * @param string                               $method
+     * @param string|UriInterface                  $uri
+     * @param array                                $headers
+     * @param resource|string|StreamInterface|null $body
+     * @param string                               $protocolVersion
+     *
+     * @return ResponseInterface
+     */
+    public function request(
+        string $method,
+        $uri,
+        array $headers = [],
+        $body = null,
+        string $protocolVersion = '1.1'
+    ) : ResponseInterface;
+}

tests/Omnipay/Common/Http/ClientTest.php

@@ -2,6 +2,7 @@
 
 namespace Omnipay\Common\Http;
 
+use GuzzleHttp\Psr7\Response;
 use Mockery as m;
 use GuzzleHttp\Psr7\Request;
 use Http\Client\HttpClient;
@@ -18,25 +19,14 @@ public function testEmptyConstruct()
         $this->assertAttributeInstanceOf(RequestFactory::class, 'requestFactory', $client);
     }
 
-    public function testCreateRequest()
-    {
-         $client = $this->getHttpClient();
-
-         $request = $client->createRequest('GET', '/path', ['foo' => 'bar']);
-
-         $this->assertInstanceOf(Request::class, $request);
-         $this->assertEquals('/path', $request->getUri());
-         $this->assertEquals(['bar'], $request->getHeader('foo'));
-    }
-
-
     public function testSend()
     {
         $mockClient = m::mock(HttpClient::class);
         $mockFactory = m::mock(RequestFactory::class);
         $client = new Client($mockClient, $mockFactory);
 
         $request = new Request('GET', '/path');
+        $response = new Response();
 
         $mockFactory->shouldReceive('createRequest')->withArgs([
             'GET',
@@ -46,8 +36,12 @@ public function testSend()
             '1.1',
         ])->andReturn($request);
 
-        $mockClient->shouldReceive('sendRequest')->with($request)->once();
+        $mockClient->shouldReceive('sendRequest')
+            ->with($request)
+            ->andReturn($response)
+            ->once();
+
+        $this->assertSame($response, $client->request('GET', '/path'));
 
-        $client->request('GET', '/path');
     }
 }