Expect a PSR-18 client instead of a PHP-HTTP client (#18)

Author: JaZo

README.md

@@ -18,13 +18,13 @@ composer require --dev geocoder-php/provider-integration-tests:dev-master
 Create a test that looks like this: 
 
 ```php
-use Http\Client\HttpClient;
 use Geocoder\IntegrationTest\ProviderIntegrationTest;
 use Geocoder\Provider\GoogleMaps\GoogleMaps;
+use Psr\Http\Client\ClientInterface;
 
 class IntegrationTest extends ProviderIntegrationTest
 {
-    protected function createProvider(HttpClient $httpClient)
+    protected function createProvider(ClientInterface $httpClient)
     {
         return new GoogleMaps($httpClient);
     }

composer.json

@@ -17,6 +17,7 @@
         "php": "^7.3 || ^8.0",
         "phpunit/phpunit": "^9.5",
         "php-http/mock-client": "^1.2",
+        "psr/http-client": "^1.0",
         "nyholm/psr7": "^1.0"
     },
     "require-dev": {

src/BaseTestCase.php

@@ -11,10 +11,10 @@
 namespace Geocoder\IntegrationTest;
 
 use Http\Client\Curl\Client as HttplugClient;
-use Http\Client\HttpClient;
 use Http\Mock\Client as MockedHttpClient;
 use Nyholm\Psr7\Response;
 use PHPUnit\Framework\TestCase;
+use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
@@ -31,7 +31,7 @@ abstract protected function getCacheDir();
     /**
      * Get a real HTTP client. If a cache dir is set to a path it will use cached responses.
      *
-     * @return HttpClient
+     * @return ClientInterface
      */
     protected function getHttpClient($apiKey = null)
     {
@@ -48,7 +48,7 @@ protected function getHttpClient($apiKey = null)
      * @param string|null $body
      * @param int         $statusCode
      *
-     * @return HttpClient
+     * @return ClientInterface
      */
     protected function getMockedHttpClient($body = null, $statusCode = 200)
     {
@@ -64,11 +64,11 @@ protected function getMockedHttpClient($body = null, $statusCode = 200)
      * @param string|null $body
      * @param int         $statusCode
      *
-     * @return HttpClient
+     * @return ClientInterface
      */
     protected function getMockedHttpClientCallback(callable $requestCallback)
     {
-        $client = $this->getMockBuilder(HttpClient::class)->getMock();
+        $client = $this->getMockBuilder(ClientInterface::class)->getMock();
 
         $client
             ->expects($this->once())

src/CachedResponseClient.php

@@ -10,22 +10,21 @@
 
 namespace Geocoder\IntegrationTest;
 
-use Http\Client\HttpClient;
 use Nyholm\Psr7\Factory\HttplugFactory;
 use Nyholm\Psr7\Response;
+use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * Serve responses from local file cache.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
-class CachedResponseClient implements HttpClient
+class CachedResponseClient implements ClientInterface
 {
-    use HttpClientTrait;
-
     /**
-     * @var HttpClient
+     * @var ClientInterface
      */
     private $delegate;
 
@@ -45,12 +44,12 @@ class CachedResponseClient implements HttpClient
     private $cacheDir;
 
     /**
-     * @param HttpClient  $delegate
-     * @param string      $cacheDir
-     * @param string|null $apiKey
-     * @param string|null $appCode
+     * @param ClientInterface $delegate
+     * @param string          $cacheDir
+     * @param string|null     $apiKey
+     * @param string|null     $appCode
      */
-    public function __construct(HttpClient $delegate, $cacheDir, $apiKey = null, $appCode = null)
+    public function __construct(ClientInterface $delegate, $cacheDir, $apiKey = null, $appCode = null)
     {
         $this->delegate = $delegate;
         $this->cacheDir = $cacheDir;
@@ -61,7 +60,7 @@ public function __construct(HttpClient $delegate, $cacheDir, $apiKey = null, $ap
     /**
      * {@inheritdoc}
      */
-    protected function doSendRequest(RequestInterface $request)
+    public function sendRequest(RequestInterface $request): ResponseInterface
     {
         $host = (string) $request->getUri()->getHost();
         $cacheKey = (string) $request->getUri();

src/HttpClientTrait.php

@@ -22,10 +22,10 @@
 use Geocoder\Provider\Provider;
 use Geocoder\Query\GeocodeQuery;
 use Geocoder\Query\ReverseQuery;
-use Http\Client\HttpClient;
-use Http\Discovery\HttpClientDiscovery;
+use Http\Discovery\Psr18ClientDiscovery;
 use Nyholm\Psr7\Response;
 use PHPUnit\Framework\TestCase;
+use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\ResponseInterface;
 
 /**
@@ -47,7 +47,7 @@ abstract class ProviderIntegrationTest extends TestCase
     /**
      * @return Provider that is used in the tests.
      */
-    abstract protected function createProvider(HttpClient $httpClient);
+    abstract protected function createProvider(ClientInterface $httpClient);
 
     /**
      * @return string the directory where cached responses are stored
@@ -62,11 +62,11 @@ abstract protected function getApiKey();
     /**
      * @param ResponseInterface $response
      *
-     * @return \PHPUnit_Framework_MockObject_MockObject|HttpClient
+     * @return \PHPUnit_Framework_MockObject_MockObject|ClientInterface
      */
     private function getHttpClient(ResponseInterface $response)
     {
-        $client = $this->getMockForAbstractClass(HttpClient::class);
+        $client = $this->getMockForAbstractClass(ClientInterface::class);
 
         $client
             ->expects($this->any())
@@ -84,9 +84,9 @@ private function getHttpClient(ResponseInterface $response)
     private function getCachedHttpClient()
     {
         try {
-            $client = HttpClientDiscovery::find();
-        } catch (\Http\Discovery\NotFoundException $e) {
-            $client = $this->getMockForAbstractClass(HttpClient::class);
+            $client = Psr18ClientDiscovery::find();
+        } catch (\Http\Discovery\Exception\NotFoundException $e) {
+            $client = $this->getMockForAbstractClass(ClientInterface::class);
 
             $client
                 ->expects($this->any())

src/ProviderIntegrationTest.php

@@ -12,7 +12,7 @@
 
 use Geocoder\IntegrationTest\ProviderIntegrationTest;
 use Geocoder\Provider\Nominatim\Nominatim;
-use Http\Client\HttpClient;
+use Psr\Http\Client\ClientInterface;
 
 /**
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
@@ -22,7 +22,7 @@ class NominatimTest extends ProviderIntegrationTest
     protected $testIpv4 = false;
     protected $testIpv6 = false;
 
-    protected function createProvider(HttpClient $httpClient)
+    protected function createProvider(ClientInterface $httpClient)
     {
         return Nominatim::withOpenStreetMapServer($httpClient, 'Geocoder PHP/Nominatim Provider/Nominatim Test');
     }