VG-2746: Change user-key header to appKey

- The config should contain only the Base URI without context.
- The header key has changed from user-key to apiKey.

Author: zero2one

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All Notable changes to the `district09/gent-lez` package.
 
+## [Unreleased]
+
+### Changed
+
+- VG-2746: Change user-key header to appKey.
+
 ## [3.0.0]
 
 ### Added

examples/DetailsFromLambert72.php

@@ -12,7 +12,7 @@
 require_once __DIR__ . '/bootstrap.php';
 
 /** @var string $apiEndpoint */
-/** @var string $apiUserKey */
+/** @var string|null $apiKey */
 
 printTitle('Get the LEZ details (if any) for a given Lambert72 coordinate.');
 
@@ -31,7 +31,7 @@
 }
 
 printStep('Create the API client configuration.');
-$configuration = new Configuration($apiEndpoint, $apiUserKey);
+$configuration = new Configuration(endpointUri: $apiEndpoint, apiKey: $apiKey);
 
 printStep('Create the Guzzle client.');
 $guzzleClient = new GuzzleHttp\Client(['base_uri' => $configuration->getUri()]);

examples/DetailsFromWgs84.php

@@ -12,7 +12,7 @@
 require_once __DIR__ . '/bootstrap.php';
 
 /** @var string $apiEndpoint */
-/** @var string $apiUserKey */
+/** @var string|null $apiKey */
 
 printTitle('Get the LEZ details (if any) for a given WGS84 coordinate.');
 
@@ -31,7 +31,7 @@
 }
 
 printStep('Create the API client configuration.');
-$configuration = new Configuration($apiEndpoint, $apiUserKey);
+$configuration = new Configuration(endpointUri: $apiEndpoint, apiKey: $apiKey);
 
 printStep('Create the Guzzle client.');
 $guzzleClient = new GuzzleHttp\Client(['base_uri' => $configuration->getUri()]);

examples/Lambert72InLez.php

@@ -12,7 +12,7 @@
 require_once __DIR__ . '/bootstrap.php';
 
 /** @var string $apiEndpoint */
-/** @var string $apiUserKey */
+/** @var string $apiKey */
 
 printTitle('Check if given Lambert72 coordinate is within Gent LEZ.');
 
@@ -31,7 +31,7 @@
 }
 
 printStep('Create the API client configuration.');
-$configuration = new Configuration($apiEndpoint, $apiUserKey);
+$configuration = new Configuration(endpointUri: $apiEndpoint, apiKey: $apiKey);
 
 printStep('Create the Guzzle client.');
 $guzzleClient = new GuzzleHttp\Client(['base_uri' => $configuration->getUri()]);

examples/README.md

@@ -7,9 +7,9 @@ and how to retrieve data from the webservice.
 
 The examples require the `config.php` file being in place and filled in.
 
-Copy the `config.example.php` file to `config.php` and fill in the
-values. Do not alter the example scripts, all variables are defined in
-the `config.php` file.
+Copy the `config.example.php` file to `config.php` and fill in the values. Do
+not alter the example scripts, all variables are defined in the `config.php`
+file.
 
 Install the libraries:
 

examples/Wgs84InLez.php

@@ -12,7 +12,7 @@
 require_once __DIR__ . '/bootstrap.php';
 
 /** @var string $apiEndpoint */
-/** @var string $apiUserKey */
+/** @var string $apiKey */
 
 printTitle('Check if given WGS84 coordinate is within Gent LEZ.');
 
@@ -31,7 +31,7 @@
 }
 
 printStep('Create the API client configuration.');
-$configuration = new Configuration($apiEndpoint, $apiUserKey);
+$configuration = new Configuration(endpointUri: $apiEndpoint, apiKey: $apiKey);
 
 printStep('Create the Guzzle client.');
 $guzzleClient = new GuzzleHttp\Client(['base_uri' => $configuration->getUri()]);

examples/config.example.php

@@ -7,5 +7,5 @@
 // The service endpoint.
 $apiEndpoint = '';
 
-// Optional api endpoint user key.
-$apiUserKey = null;
+// Optional api endpoint key.
+$apiKey = null;

src/Client/Client.php

@@ -42,10 +42,10 @@ protected function injectHeaders(RequestInterface $request): RequestInterface
 
         /** @var \District09\Gent\Lez\Configuration\ConfigurationInterface $configuration */
         $configuration = $this->configuration;
-        if (!empty($configuration->userKey())) {
+        if (!empty($configuration->apiKey())) {
             $request = $request->withHeader(
-                'user-key',
-                $configuration->userKey()
+                'apiKey',
+                $configuration->apiKey()
             );
         }
 

src/Configuration/Configuration.php

@@ -12,30 +12,31 @@
 final class Configuration extends BaseConfiguration implements ConfigurationInterface
 {
     /**
-     * The API user key.
+     * Create configuration by its parameters.
      *
-     * @var string|null
+     * @param string $endpointUri
+     *   The base endpoint URI.
+     * @param array|null $options
+     *    The client options.
+     * @param string|null $apiKey
+     *   The API key to use (if any).
      */
-    private $userKey;
-
-    /**
-     * @inheritDoc
-     */
-    public function __construct(string $endpointUri, ?string $userKey, array $options = [])
-    {
-        if (\substr($endpointUri, -1) !== '/') {
+    public function __construct(
+        string $endpointUri,
+        ?array $options = [],
+        private ?string $apiKey = null,
+    ) {
+        if (!str_ends_with($endpointUri, '/')) {
             $endpointUri .= '/';
         }
-        parent::__construct($endpointUri, $options);
-
-        $this->userKey = $userKey;
+        parent::__construct($endpointUri, $options ?? []);
     }
 
     /**
      * @inheritDoc
      */
-    public function userKey(): ?string
+    public function apiKey(): ?string
     {
-        return $this->userKey;
+        return $this->apiKey;
     }
 }

src/Configuration/ConfigurationInterface.php

@@ -16,5 +16,5 @@ interface ConfigurationInterface extends BaseConfigurationInterface
      *
      * @return string|null
      */
-    public function userKey(): ?string;
+    public function apiKey(): ?string;
 }