feat(Shop): add /shop/address route to interact with the 'La Poste' API

env: add LA_POSTE_KEY environment variable

Author: lefuturiste

.env.example

@@ -57,4 +57,6 @@ REDIS_PREFIX=retrobox:
 WEBSOCKET_SERVER_ENDPOINT=http://localhost:3008
 
 SENTRY_DSN=https://[email protected]/XXX
-SENTRY_ENABLE=1
+SENTRY_ENABLE=1
+
+LA_POSTE_KEY=XXX

App/App.php

@@ -67,6 +67,7 @@ public function __construct()
         })->add(new Middlewares\JWTMiddleware($this->getContainer()));
 
         $this->group('/shop', function () {
+            $this->get('/address', [Controllers\ShopController::class, 'getQueryAddress']);
             $this->get('/storage-prices', [Controllers\ShopController::class, 'getStoragePrices']);
             $this->get('/shipping-prices', [Controllers\ShopController::class, 'getShippingPrices']);
             $this->get('/{locale}/categories', [Controllers\ShopController::class, 'getCategories']);

App/Controllers/ShopController.php

@@ -6,6 +6,7 @@
 use App\Utils\CacheManager;
 use App\Utils\Chronopost;
 use App\Utils\Countries;
+use App\Utils\LaPoste;
 use Illuminate\Database\Capsule\Manager;
 use Psr\Container\ContainerInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -140,4 +141,31 @@ public function getShippingPrices(ServerRequestInterface $request, Response $res
             ]
         ]);
     }
+
+    public function getQueryAddress(ServerRequestInterface $request, Response $response, ContainerInterface $container)
+    {
+        $validator = new Validator($request->getQueryParams());
+        $validator->required('query');
+        $validator->notEmpty('query');
+        if (!$validator->isValid())
+            return $response->withJson([
+                'success' => false,
+                'errors' => $validator->getErrors(true)
+            ], 400);
+
+        $result = $container->get(LaPoste::class)->searchAddress($validator->getValue('query'));
+        if (empty($result))
+            return $response->withJson([
+                'success' => false,
+                'errors' => [
+                    ['code' => 'unknown-address', 'message' => 'This address seems to be incorrect']
+                ]
+            ], 404);
+
+        return $response->withJson([
+            'success' => true,
+            'data' => $result
+        ]);
+    }
+
 }

App/Utils/LaPoste.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Utils;
+
+use GuzzleHttp\Client;
+
+class LaPoste
+{
+    /**
+     * @var Client
+     */
+    private Client $client;
+
+    private string $endpoint = "https://api.laposte.fr/controladresse/v1";
+
+    public function __construct(string $apiKey)
+    {
+        $this->client = new Client(['headers' => ['X-Okapi-Key' => $apiKey]]);
+    }
+
+    /**
+     * Look for an address into the public laposte database
+     * The address is compacted as a single string
+     * The search result is a array of possible address (address object)
+     * Each address object contain an 'address' key which is the valid address as a single string
+     * It also contain an 'code' key which is the id of the address in the public laposte database
+     *
+     * @param string $query
+     * @return array
+     */
+    public function searchAddress(string $query): array
+    {
+        $res = $this->client->get($this->endpoint . '/adresses', ['query' => ['q' => $query]]);
+        $content = json_decode($res->getBody()->getContents(), true);
+        return array_map(fn ($a) => ['address' => $a['adresse'], 'code' => $a['code']], $content);
+    }
+}

App/config/api.php

@@ -34,5 +34,8 @@
     "account" => [
         "redirection_url_cookie" => "login_redirection_url",
         "jwt_cookie" => "user_token"
+    ],
+    "la_poste" => [
+        "key" => getenv('LA_POSTE_KEY')
     ]
 ];

App/config/containers.php

@@ -2,6 +2,7 @@
 
 use App\NotFoundHandler;
 use App\NotAllowedHandler;
+use App\Utils\LaPoste;
 use App\Utils\MailChimp;
 use App\Utils\WebSocketServerClient;
 use DI\Container;
@@ -100,5 +101,9 @@
         );
         $client->createConnexion();
         return $client;
+    },
+
+    LaPoste::class => function (ContainerInterface $container) {
+        return new LaPoste($container->get('la_poste')['key']);
     }
 ];