Merge pull request #22 from evertharmeling/develop

Support use of Guzzle 7

Author: bart-van-amelsvoort

CHANGELOG.md

@@ -1,17 +1,40 @@
 # CHANGELOG
 
+## 4.0.1
+
+### Added
+
+* `psr/http-client` to support direct use of `Guzzle 7` by using the `ClientInterface`. 
+Change is BC because `Http\Client\HttpClient` implements the same interface. 
+
+## 4.0.0
+
+### Added
+
+* `getPostcodeDataByPostcode` function for `/postcodes/{postalCode}` endpoint.
+* Bumped PHPUnit version
+
+### Removed
+
+* Support for PHP <7.1
+
 ## 3.0.0
 
-* Dropped direct usage of Guzzle and now make use of [HTTPPlug](http://httplug.io/), see README.
+### Added
+
 * Added `getPostcodes()` call, to get postcodes based on provided `latitude, longitude`. Note that this call is only available with a premium account.
 
+### Removed
+
+* Support direct usage of Guzzle, now handled via [HTTPPlug](http://httplug.io/), see README.
+
 ## 2.0.0
 
 * Rewrite to support postcodeapi.nu version 2
 
 ## 1.0.2 (2015-06-11)
 
-*	Added call for type = P4 support
+* Added call for type = P4 support
 
 ## 1.0.1 (2013-08-06)
 

README.md

@@ -11,11 +11,6 @@ by [Freshheads](https://www.freshheads.com) and will be maintained in sync with
 * [More information](https://www.postcodeapi.nu)
 * [API documentation](https://swaggerhub.com/api/apiwise/postcode-api)
 
-Requirements
-------------
-
-FHPostcodeAPIClient works with PHP 7.1 and up. This library depends on the [HTTPPlug](http://httplug.io/), see http://docs.php-http.org/en/latest/httplug/introduction.html.
-
 Installation
 ------------
 
@@ -36,15 +31,13 @@ require_once 'vendor/autoload.php';
 
 // initiate client
 $apiKey = 'replace_with_your_own_api_key';
-// In this example we made use of the Guzzle6 as HTTPClient in combination with an HTTPPlug compatible adapter.
+// In this example we made use of the Guzzle as HTTPClient.
 $client = new \FH\PostcodeAPI\Client(
-    new Http\Adapter\Guzzle6\Client(
-        new GuzzleHttp\Client([
-            'headers' => [
-                'X-Api-Key' => $apiKey
-            ]
-        ])
-    )
+    new GuzzleHttp\Client([
+        'headers' => [
+            'X-Api-Key' => $apiKey
+        ]
+    ])
 );
 
 // call endpoints
@@ -56,17 +49,31 @@ $response = $client->getPostcode('5041EB');
 $response = $client->getPostcodes('51.566405', '5.077171');
 ```
 
-Note that to be able to run the example above you should have ran the following command, to have Guzzle6 and the Adapter available.
+Within a Symfony project
+----------------------
 
-```bash
-composer require php-http/guzzle6-adapter
-```
+We recommend to use [Guzzle](https://github.com/guzzle/guzzle), to be able to use Guzzle in combination with the PostcodeApiClient.
+Following definition is used with an implementation of `Guzzle 7`.
 
-Within Symfony project
-----------------------
+```yaml
+_defaults:
+        autowire: true
+        autoconfigure: true
+
+    project.http.client.postal_code:
+        class: GuzzleHttp\Client
+        bind:
+            $config: { headers: { X-Api-Key: '%postcode_api_nu.key%' } }
 
-We recommend to use [Guzzle](https://github.com/guzzle/guzzle), to be able to use Guzzle in combination with the PostcodeApiClient you should also make use of the
-[Guzzle6Adapter](https://github.com/php-http/guzzle6-adapter). By running the following command you automatically install Guzzle aswel.
+    FH\PostcodeAPI\Client:
+        $httpClient: '@project.http.client.postal_code'
+```
+ 
+You should now be able use the `FH\PostcodeAPI\Client` service to make requests to the PostcodeAPI.
+
+#### Guzzle 6 
+To make use of `Guzzle 6`, you should also make use of the
+[Guzzle6Adapter](https://github.com/php-http/guzzle6-adapter). By running the following command you automatically install Guzzle as well.
 
 ```bash
 composer require php-http/guzzle6-adapter
@@ -92,5 +99,3 @@ services:
     FH\PostcodeAPI\Client:
         $httpClient: '@project.http.adapter.guzzle.client'
 ```
-
-You should now be able use the `project.client.postal_code` service to make requests to the PostcodeAPI.

composer.json

@@ -3,7 +3,7 @@
     "type": "library",
     "description": "Client library for the postcodeapi.nu web service.",
     "keywords": ["postcode","api","client"],
-    "homepage": "http://www.postcodeapi.nu",
+    "homepage": "https://www.postcodeapi.nu",
     "license": "MIT",
     "authors": [
         {
@@ -18,8 +18,8 @@
     "require": {
         "php": "^7.1",
         "ext-json": "*",
-        "php-http/httplug": "^2.0",
-        "guzzlehttp/psr7": "^1.3"
+        "guzzlehttp/psr7": "^1.3",
+        "psr/http-client": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^7.5 || ^8.2",
@@ -33,7 +33,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "3.0.x-dev"
+            "dev-master": "4.x-dev"
         }
     },
     "scripts": {

lib/FH/PostcodeAPI/Client.php

@@ -6,7 +6,8 @@
 use FH\PostcodeAPI\Exception\InvalidApiKeyException;
 use FH\PostcodeAPI\Exception\ServerErrorException;
 use GuzzleHttp\Psr7\Request;
-use Http\Client\HttpClient;
+use Psr\Http\Client\ClientExceptionInterface;
+use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
@@ -18,10 +19,10 @@
  */
 class Client
 {
-    const POSTCODES_SORT_DISTANCE = 'distance';
+    public const POSTCODES_SORT_DISTANCE = 'distance';
 
     /**
-     * @var null|string
+     * @var string|null
      */
     private $url = 'https://api.postcodeapi.nu';
 
@@ -31,12 +32,12 @@ class Client
     private $version = 'v2';
 
     /**
-     * @var HttpClient
+     * @var ClientInterface
      */
     private $httpClient;
 
 
-    public function __construct(HttpClient $httpClient, $url = null)
+    public function __construct(ClientInterface $httpClient, string $url = null)
     {
         if (null !== $url) {
             $this->url = $url;
@@ -100,14 +101,11 @@ public function getPostcodesByCoordinates($latitude, $longitude, $sort = self::P
     }
 
     /**
-     * @param string $path
-     * @param array $params
-     *
      * @return \stdClass
      *
-     * @throws RequestException
+     * @throws ClientExceptionInterface
      */
-    private function get($path, array $params = [])
+    private function get(string $path, array $params = [])
     {
         $request = $this->createHttpGetRequest($this->buildUrl($path), $params);
 
@@ -116,39 +114,28 @@ private function get($path, array $params = [])
         return $this->parseResponse($response, $request);
     }
 
-    /**
-     * @param string $path
-     * @return string
-     */
-    private function buildUrl($path)
+    private function buildUrl(string $path): string
     {
         return sprintf('%s/%s%s', $this->url, $this->version, $path);
     }
 
-    /**
-     * @param string $method
-     * @param string $url
-     * @param array $queryParams
-     *
-     * @return Request
-     */
-    private function createHttpGetRequest($url, array $params = [])
+    private function createHttpGetRequest(string $url, array $params = []): Request
     {
         $url .= (count($params) > 0 ? '?' . http_build_query($params, null, '&', PHP_QUERY_RFC3986) : '');
 
         return new Request('GET', $url);
     }
 
     /**
-     * @param ResponseInterface $response
-     *
      * @return \stdClass
      *
      * @throws CouldNotParseResponseException
+     * @throws ServerErrorException
+     * @throws InvalidApiKeyException
      */
     private function parseResponse(ResponseInterface $response, RequestInterface $request)
     {
-        $result = json_decode((string) $response->getBody()->getContents());
+        $result = json_decode((string) $response->getBody()->getContents(), false);
 
         if (json_last_error() !== JSON_ERROR_NONE) {
             throw new CouldNotParseResponseException('Could not parse response', $response);
@@ -157,7 +144,7 @@ private function parseResponse(ResponseInterface $response, RequestInterface $re
         if (property_exists($result, 'error')) {
             switch ($result->error) {
                 case 'API key is invalid.':
-                    throw new InvalidApiKeyException();
+                    throw new InvalidApiKeyException('API key is invalid');
                 case 'An unknown server error occured.':
                     throw ServerErrorException::fromRequest($request);
             }

lib/FH/PostcodeAPI/Exception/CouldNotParseResponseException.php

@@ -25,10 +25,7 @@ public function __construct($message, ResponseInterface $response)
         $this->response = $response;
     }
 
-    /**
-     * @return ResponseInterface
-     */
-    public function getResponse()
+    public function getResponse(): ResponseInterface
     {
         return $this->response;
     }