feat: get cities by code route + refactoring

Author: smotim

app/Console/Commands/SyncKitGeography.php

@@ -20,4 +20,4 @@ public function handle(): void
         UpdateKitGeographyData::dispatchSync();
         $this->info('Synchronization completed');
     }
-}
+}

app/DTO/CityByCodeDTO.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\DTO;
+
+use service\KitAPI\Model\Request\Geography\GetListCityRequest;
+
+class CityByCodeDTO
+{
+    private string $code;
+
+    public function __construct(string $code)
+    {
+        $this->code = $code;
+    }
+
+    public function toGetListCityRequest(): GetListCityRequest
+    {
+        return new GetListCityRequest($this->code);
+    }
+}

app/DTO/KitTerminalsRequestDTO.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\DTO;
+
+use service\KitAPI\Model\Request\Geography\GetListAddressRequest;
+
+class KitTerminalsRequestDTO
+{
+    private ?string $cityId;
+    private bool $withPhone;
+    private bool $withEmail;
+
+    public function __construct(?string $cityId = null, bool $withPhone = true, bool $withEmail = true)
+    {
+        $this->cityId = $cityId;
+        $this->withPhone = $withPhone;
+        $this->withEmail = $withEmail;
+    }
+
+    public function toGetListAddressRequest(): GetListAddressRequest
+    {
+        if ($this->cityId) {
+            return new GetListAddressRequest($this->cityId, $this->withPhone, $this->withEmail);
+        }
+
+        return new GetListAddressRequest(withPhone: $this->withPhone, withEmail: $this->withEmail);
+    }
+}

app/DTO/SearchCitiesDTO.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\DTO;
+
+use service\KitAPI\Model\Request\Tdd\SearchByNameRequest;
+
+class SearchCitiesDTO
+{
+    private string $query;
+
+    public function __construct(string $query)
+    {
+        $this->query = $query;
+    }
+
+    public function toSearchByNameRequest(): SearchByNameRequest
+    {
+        return new SearchByNameRequest($this->query);
+    }
+}

app/Http/Controllers/DeliveryController.php

@@ -4,26 +4,30 @@
 
 namespace App\Http\Controllers;
 
+use App\DTO\CityByCodeDTO;
+use App\DTO\DeliveryCalculationDTO;
+use App\DTO\KitTerminalsRequestDTO;
+use App\DTO\SearchCitiesDTO;
 use App\Services\KitDeliveryService;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
-use Psr\Http\Client\ClientExceptionInterface;
 use Symfony\Component\HttpFoundation\Response;
 
 readonly class DeliveryController
 {
     public function __construct(
         private KitDeliveryService $kitService
-    ) {}
+    ) {
+    }
 
     /**
      * @return JsonResponse
-     * @throws ClientExceptionInterface
      */
     public function getAllTerminals(): JsonResponse
     {
         try {
-            $terminals = $this->kitService->getTerminals();
+            $dto = new KitTerminalsRequestDTO();
+            $terminals = $this->kitService->getTerminals($dto);
             return response()->json($terminals, Response::HTTP_OK);
         } catch (\Exception $e) {
             return response()->json([
@@ -35,12 +39,12 @@ public function getAllTerminals(): JsonResponse
     /**
      * @param string $cityId
      * @return JsonResponse
-     * @throws ClientExceptionInterface
      */
     public function getCityTerminals(string $cityId): JsonResponse
     {
         try {
-            $terminals = $this->kitService->getTerminals($cityId);
+            $dto = new KitTerminalsRequestDTO($cityId);
+            $terminals = $this->kitService->getTerminals($dto);
             return response()->json($terminals, Response::HTTP_OK);
         } catch (\Exception $e) {
             return response()->json([
@@ -52,12 +56,12 @@ public function getCityTerminals(string $cityId): JsonResponse
     /**
      * @param Request $request
      * @return JsonResponse
-     * @throws ClientExceptionInterface
      */
     public function calculateDelivery(Request $request): JsonResponse
     {
         try {
-            $result = $this->kitService->calculateDelivery($request->all());
+            $dto = DeliveryCalculationDTO::fromArray($request->all());
+            $result = $this->kitService->calculateDelivery($dto);
             return response()->json([
                 'data' => $result
             ], Response::HTTP_OK);
@@ -71,7 +75,6 @@ public function calculateDelivery(Request $request): JsonResponse
     /**
      * @param Request $request
      * @return JsonResponse
-     * @throws ClientExceptionInterface
      */
     public function searchCities(Request $request): JsonResponse
     {
@@ -82,12 +85,30 @@ public function searchCities(Request $request): JsonResponse
         }
 
         try {
-            $cities = $this->kitService->searchCitiesByName($request->get('query'));
+            $dto = new SearchCitiesDTO($request->get('query'));
+            $cities = $this->kitService->searchCitiesByName($dto);
             return response()->json($cities, Response::HTTP_OK);
         } catch (\Exception $e) {
             return response()->json([
                 'message' => $e->getMessage()
             ], Response::HTTP_INTERNAL_SERVER_ERROR);
         }
     }
-}
+
+    /**
+     * @param string $code
+     * @return JsonResponse
+     */
+    public function getCityByCode(string $code): JsonResponse
+    {
+        try {
+            $dto = new CityByCodeDTO($code);
+            $city = $this->kitService->getCityByCode($dto);
+            return response()->json($city, Response::HTTP_OK);
+        } catch (\Exception $e) {
+            return response()->json([
+                'message' => $e->getMessage()
+            ], Response::HTTP_INTERNAL_SERVER_ERROR);
+        }
+    }
+}

app/Http/Controllers/TerminalController.php

@@ -4,29 +4,26 @@
 
 namespace App\Http\Controllers;
 
+use App\Http\Requests\TerminalSearchRequest;
 use App\Repositories\TerminalRepository;
 use Illuminate\Http\JsonResponse;
-use Illuminate\Http\Request;
 use Symfony\Component\HttpFoundation\Response;
 
 readonly class TerminalController
 {
     public function __construct(
         private TerminalRepository $repository
-    ) {}
+    ) {
+    }
 
     /**
-     * @param Request $request
+     * @param TerminalSearchRequest $request
      * @return JsonResponse
      */
-    public function search(Request $request): JsonResponse
+    public function search(TerminalSearchRequest $request): JsonResponse
     {
-        $validated = $request->validate([
-            'query' => 'required|string|min:2'
-        ]);
-
         try {
-            $terminals = $this->repository->search($validated['query']);
+            $terminals = $this->repository->search($request->validated('query'));
             return response()->json([
                 'data' => $terminals
             ], Response::HTTP_OK);
@@ -36,4 +33,4 @@ public function search(Request $request): JsonResponse
             ], Response::HTTP_UNPROCESSABLE_ENTITY);
         }
     }
-}
+}

app/Http/Requests/TerminalSearchRequest.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class TerminalSearchRequest extends FormRequest
+{
+    public function rules(): array
+    {
+        return [
+            'query' => 'required|string|min:2'
+        ];
+    }
+
+    public function authorize(): bool
+    {
+        return true;
+    }
+}

app/Jobs/UpdateKitGeographyData.php

@@ -4,6 +4,7 @@
 
 namespace App\Jobs;
 
+use App\DTO\KitTerminalsRequestDTO;
 use App\Repositories\TerminalRepository;
 use App\Services\KitDeliveryService;
 use Illuminate\Bus\Queueable;
@@ -27,7 +28,8 @@ public function handle(KitDeliveryService $kitService, TerminalRepository $termi
 
             $start = microtime(true);
 
-            $terminals = $kitService->getTerminals();
+            $dto = new KitTerminalsRequestDTO();
+            $terminals = $kitService->getTerminals($dto);
             Log::info('Retrieved ' . count($terminals) . ' terminals from API');
 
             if (count($terminals) === 0) {
@@ -68,4 +70,4 @@ public function handle(KitDeliveryService $kitService, TerminalRepository $termi
             Log::error($e->getTraceAsString());
         }
     }
-}
+}