@fleetbase/fleetops-engine 0.6.58 → 0.6.59

package/server/src/Http/Controllers/Api/v1/ServiceQuoteController.php

@@ -13,6 +13,7 @@ use Fleetbase\FleetOps\Models\ServiceQuoteItem;
 use Fleetbase\FleetOps\Models\ServiceRate;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Http\Controllers\Controller;
+use Illuminate\Http\Request;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Str;
 
@@ -33,7 +34,7 @@ class ServiceQuoteController extends Controller
         $serviceType      = $request->input('service_type'); // the specific type of service rate to query
         $single           = $request->boolean('single');
         $isRouteOptimized = $request->boolean('is_route_optimized', true);
-        $requestId        = ServiceQuote::generatePublicId('request');
+        $requestId        = $this->generateServiceQuoteRequestId();
 
         if (Utils::isPublicId($payload)) {
             $payload = Payload::with(['pickup', 'dropoff', 'waypoints', 'entities'])
@@ -54,7 +55,7 @@ class ServiceQuoteController extends Controller
                 try {
                     $serviceQuotes = $integratedVendor->api()->setRequestId($requestId)->getQuoteFromPayload($payload, $serviceType, $scheduledAt, $isRouteOptimized);
                 } catch (\Exception $e) {
-                    return response()->json([
+                    return $this->jsonResponse([
                         'errors' => [$e->getMessage()],
                     ], 400);
                 }
@@ -62,14 +63,14 @@ class ServiceQuoteController extends Controller
 
             // send single quote back
             if ($single) {
-                return new ServiceQuoteResource($serviceQuotes);
+                return $this->serviceQuoteResource($serviceQuotes);
             }
 
             if (!is_array($serviceQuotes)) {
                 $serviceQuotes = [$serviceQuotes];
             }
 
-            return ServiceQuoteResource::collection($serviceQuotes);
+            return $this->serviceQuoteResourceCollection($serviceQuotes);
         }
 
         // get all waypoints
@@ -77,21 +78,13 @@ class ServiceQuoteController extends Controller
 
         // if quote for single service
         if ($service && $service !== 'all') {
-            $serviceRate = ServiceRate::where(
-                function ($query) use ($service) {
-                    $query->where('uuid', $service)->orWhere('public_id', $service);
-                })->where(
-                    function ($q) use ($currency) {
-                        if ($currency) {
-                            $q->where(DB::raw('lower(currency)'), strtolower($currency));
-                        }
-                    })->first();
+            $serviceRate   = $this->findServiceRateForQuote($service, $currency);
             $serviceQuotes = collect();
 
             if ($serviceRate) {
                 [$subTotal, $lines] = $serviceRate->quote($payload);
 
-                $quote = ServiceQuote::create([
+                $quote = $this->createServiceQuote([
                     'request_id'        => $requestId,
                     'company_uuid'      => $serviceRate->company_uuid,
                     'service_rate_uuid' => $serviceRate->uuid,
@@ -101,13 +94,7 @@ class ServiceQuoteController extends Controller
                 $quote->setRelation('serviceRate', $serviceRate);
 
                 $items = $lines->map(function ($line) use ($quote) {
-                    return ServiceQuoteItem::create([
-                        'service_quote_uuid' => $quote->uuid,
-                        'amount'             => $line['amount'],
-                        'currency'           => $line['currency'],
-                        'details'            => $line['details'],
-                        'code'               => $line['code'],
-                    ]);
+                    return $this->createServiceQuoteItem($this->serviceQuoteItemInput($quote, $line));
                 });
 
                 $quote->setRelation('items', $items);
@@ -115,15 +102,15 @@ class ServiceQuoteController extends Controller
 
                 // if single quotation requested
                 if ($single) {
-                    return new ServiceQuoteResource($quote);
+                    return $this->serviceQuoteResource($quote);
                 }
 
-                return ServiceQuoteResource::collection($serviceQuotes);
+                return $this->serviceQuoteResourceCollection($serviceQuotes);
             }
         }
 
         // get all service rates
-        $serviceRates = ServiceRate::getServicableForPlaces(
+        $serviceRates = $this->getServicableServiceRates(
             $waypoints,
             $serviceType,
             $currency,
@@ -137,7 +124,7 @@ class ServiceQuoteController extends Controller
         foreach ($serviceRates as $serviceRate) {
             [$subTotal, $lines] = $serviceRate->quote($payload);
 
-            $quote = ServiceQuote::create([
+            $quote = $this->createServiceQuote([
                 'request_id'        => $requestId,
                 'company_uuid'      => $serviceRate->company_uuid,
                 'service_rate_uuid' => $serviceRate->uuid,
@@ -147,7 +134,7 @@ class ServiceQuoteController extends Controller
             $quote->setRelation('serviceRate', $serviceRate);
 
             $items = $lines->map(function ($line) use ($quote) {
-                return ServiceQuoteItem::create([
+                return $this->createServiceQuoteItem([
                     'service_quote_uuid' => $quote->uuid,
                     'amount'             => $line['amount'],
                     'currency'           => $line['currency'],
@@ -163,12 +150,12 @@ class ServiceQuoteController extends Controller
         // if single quotation requested
         if ($single) {
             // find the best quotation
-            $bestQuote = $serviceQuotes->sortBy('amount')->first();
+            $bestQuote = $this->bestQuote($serviceQuotes);
 
-            return new ServiceQuoteResource($bestQuote);
+            return $this->serviceQuoteResource($bestQuote);
         }
 
-        return ServiceQuoteResource::collection($serviceQuotes);
+        return $this->serviceQuoteResourceCollection($serviceQuotes);
     }
 
     /**
@@ -188,42 +175,32 @@ class ServiceQuoteController extends Controller
         $currency         = $request->has('currency');
         $totalDistance    = $request->input('distance');
         $totalTime        = $request->input('time');
-        $pickup           = $request->or(['payload.pickup', 'pickup']);
-        $dropoff          = $request->or(['payload.dropoff', 'dropoff']);
-        $return           = $request->or(['payload.return', 'return']);
-        $waypoints        = $request->or(['payload.waypoints', 'waypoints'], []);
-        $entities         = $request->or(['payload.entities', 'entities']);
+        $preliminaryData  = $this->preliminaryDataFromRequest($request);
+        $pickup           = $preliminaryData['pickup'];
+        $dropoff          = $preliminaryData['dropoff'];
+        $return           = $preliminaryData['return'];
+        $waypoints        = $preliminaryData['waypoints'];
+        $entities         = $preliminaryData['entities'];
         $single           = $request->boolean('single');
         $isRouteOptimized = $request->boolean('is_route_optimized', true);
 
-        // store preliminary data in service quotes meta
-        $preliminaryData = [
-            'pickup'    => $pickup,
-            'dropoff'   => $dropoff,
-            'return'    => $return,
-            'waypoints' => $waypoints,
-            'entities'  => $entities,
-            'cod'       => $isCashOnDelivery,
-            'currency'  => $currency,
-        ];
-
-        $requestId     = ServiceQuote::generatePublicId('request');
+        $requestId     = $this->generateServiceQuoteRequestId();
         $serviceQuotes = [];
 
         if (Utils::isNotScalar($pickup)) {
-            $pickup = Place::createFromMixed($pickup);
+            $pickup = $this->createPlaceFromMixed($pickup);
         }
 
         if (Utils::isNotScalar($dropoff)) {
-            $dropoff = Place::createFromMixed($dropoff);
+            $dropoff = $this->createPlaceFromMixed($dropoff);
         }
 
         if (Utils::isPublicId($pickup)) {
-            $pickup = Place::where('public_id', $pickup)->first();
+            $pickup = $this->findPlaceByPublicId($pickup);
         }
 
         if (Utils::isPublicId($dropoff)) {
-            $dropoff = Place::where('public_id', $dropoff)->first();
+            $dropoff = $this->findPlaceByPublicId($dropoff);
         }
 
         // convert waypoints to place instances
@@ -231,8 +208,8 @@ class ServiceQuoteController extends Controller
         $entities  = collect($entities)->mapInto(Entity::class);
 
         // should all be Place like
-        $waypoints     = collect([$pickup, ...$waypoints, $dropoff])->filter();
-        $endpointCount = (int) ($pickup instanceof Place) + (int) ($dropoff instanceof Place);
+        $waypoints     = $this->preliminaryStops($pickup, $waypoints, $dropoff);
+        $endpointCount = $this->endpointCount($pickup, $dropoff);
 
         // if facilitator is an integrated partner resolve service quotes from bridge
         if ($facilitator && Utils::isIntegratedVendorId($facilitator)) {
@@ -246,7 +223,7 @@ class ServiceQuoteController extends Controller
                     /** @var \Fleetbase\Models\ServiceQuote $serviceQuote */
                     $serviceQuote = $integratedVendor->api()->setRequestId($requestId)->getQuoteFromPreliminaryPayload($waypoints, $entities, $serviceType, $scheduledAt, $isRouteOptimized);
                 } catch (\Exception $e) {
-                    return response()->json([
+                    return $this->jsonResponse([
                         'errors' => [$e->getMessage()],
                     ], 400);
                 }
@@ -257,19 +234,19 @@ class ServiceQuoteController extends Controller
 
             // send single quote back
             if ($single) {
-                return new ServiceQuoteResource($serviceQuote);
+                return $this->serviceQuoteResource($serviceQuote);
             }
 
             if (!is_array($serviceQuote)) {
                 $serviceQuote = [$serviceQuote];
             }
 
-            return ServiceQuoteResource::collection($serviceQuote);
+            return $this->serviceQuoteResourceCollection($serviceQuote);
         }
 
         // if no total distance recalculate totalDistance and totalTime based on waypoints collected
         if (!$totalDistance) {
-            $matrix = Utils::distanceMatrix([$waypoints->first()], $waypoints->skip(1));
+            $matrix = $this->distanceMatrix([$waypoints->first()], $waypoints->skip(1));
 
             // set totalDistance and totalTime
             $totalDistance = $matrix->distance ?? 0;
@@ -278,13 +255,13 @@ class ServiceQuoteController extends Controller
 
         // if quote for single service
         if ($service !== 'all') {
-            $serviceRate   = ServiceRate::where('uuid', $service)->first();
+            $serviceRate   = $this->findServiceRateByUuid($service);
             $serviceQuotes = collect();
 
             if ($serviceRate) {
                 [$subTotal, $lines] = $serviceRate->quoteFromPreliminaryData($entities, $waypoints, $totalDistance, $totalTime, $isCashOnDelivery, $endpointCount);
 
-                $quote = ServiceQuote::create([
+                $quote = $this->createServiceQuote([
                     'request_id'        => $requestId,
                     'company_uuid'      => $serviceRate->company_uuid,
                     'service_rate_uuid' => $serviceRate->uuid,
@@ -297,28 +274,22 @@ class ServiceQuoteController extends Controller
                 $quote->updateMeta('preliminary_data', $preliminaryData);
 
                 $items = $lines->map(function ($line) use ($quote) {
-                    return ServiceQuoteItem::create([
-                        'service_quote_uuid' => $quote->uuid,
-                        'amount'             => $line['amount'],
-                        'currency'           => $line['currency'],
-                        'details'            => $line['details'],
-                        'code'               => $line['code'],
-                    ]);
+                    return $this->createServiceQuoteItem($this->serviceQuoteItemInput($quote, $line));
                 });
 
                 $quote->setRelation('items', $items);
                 $serviceQuotes->push($quote);
 
                 if ($single) {
-                    return new ServiceQuoteResource($quote);
+                    return $this->serviceQuoteResource($quote);
                 }
 
-                return ServiceQuoteResource::collection($serviceQuotes);
+                return $this->serviceQuoteResourceCollection($serviceQuotes);
             }
         }
 
         // get all service rates
-        $serviceRates = ServiceRate::getServicableForPlaces(
+        $serviceRates = $this->getServicableServiceRates(
             $waypoints,
             $serviceType,
             $currency,
@@ -332,7 +303,7 @@ class ServiceQuoteController extends Controller
         foreach ($serviceRates as $serviceRate) {
             [$subTotal, $lines] = $serviceRate->quoteFromPreliminaryData($entities, $waypoints, $totalDistance, $totalTime, $isCashOnDelivery, $endpointCount);
 
-            $quote = ServiceQuote::create([
+            $quote = $this->createServiceQuote([
                 'request_id'        => $requestId,
                 'company_uuid'      => $serviceRate->company_uuid,
                 'service_rate_uuid' => $serviceRate->uuid,
@@ -345,13 +316,7 @@ class ServiceQuoteController extends Controller
             $quote->updateMeta('preliminary_data', $preliminaryData);
 
             $items = $lines->map(function ($line) use ($quote) {
-                return ServiceQuoteItem::create([
-                    'service_quote_uuid' => $quote->uuid,
-                    'amount'             => $line['amount'],
-                    'currency'           => $line['currency'],
-                    'details'            => $line['details'],
-                    'code'               => $line['code'],
-                ]);
+                return $this->createServiceQuoteItem($this->serviceQuoteItemInput($quote, $line));
             });
 
             $quote->setRelation('items', $items);
@@ -361,14 +326,127 @@ class ServiceQuoteController extends Controller
         // if single quotation requested
         if ($single) {
             // find the best quotation
-            $bestQuote = $serviceQuotes->sortBy('amount')->first();
+            $bestQuote = $this->bestQuote($serviceQuotes);
 
-            return new ServiceQuoteResource($bestQuote);
+            return $this->serviceQuoteResource($bestQuote);
         }
 
+        return $this->serviceQuoteResourceCollection($serviceQuotes);
+    }
+
+    protected function generateServiceQuoteRequestId(): string
+    {
+        return ServiceQuote::generatePublicId('request');
+    }
+
+    protected function createPlaceFromMixed(mixed $value): Place
+    {
+        return Place::createFromMixed($value);
+    }
+
+    protected function findPlaceByPublicId(string $publicId): ?Place
+    {
+        return Place::where('public_id', $publicId)->first();
+    }
+
+    protected function distanceMatrix(array $origins, iterable $destinations): mixed
+    {
+        return Utils::distanceMatrix($origins, $destinations);
+    }
+
+    protected function findServiceRateForQuote(string $service, ?string $currency): ?ServiceRate
+    {
+        return ServiceRate::where(
+            function ($query) use ($service) {
+                $query->where('uuid', $service)->orWhere('public_id', $service);
+            })->where(
+                function ($q) use ($currency) {
+                    if ($currency) {
+                        $q->where(DB::raw('lower(currency)'), strtolower($currency));
+                    }
+                })->first();
+    }
+
+    protected function findServiceRateByUuid(string $service): ?ServiceRate
+    {
+        return ServiceRate::where('uuid', $service)->first();
+    }
+
+    protected function getServicableServiceRates(iterable $waypoints, ?string $serviceType, mixed $currency, callable $callback): iterable
+    {
+        return ServiceRate::getServicableForPlaces($waypoints, $serviceType, $currency, $callback);
+    }
+
+    protected function createServiceQuote(array $attributes): ServiceQuote
+    {
+        return ServiceQuote::create($attributes);
+    }
+
+    protected function createServiceQuoteItem(array $attributes): ServiceQuoteItem
+    {
+        return ServiceQuoteItem::create($attributes);
+    }
+
+    protected function serviceQuoteResource(ServiceQuote $serviceQuote)
+    {
+        return new ServiceQuoteResource($serviceQuote);
+    }
+
+    protected function serviceQuoteResourceCollection(iterable $serviceQuotes)
+    {
         return ServiceQuoteResource::collection($serviceQuotes);
     }
 
+    protected function preliminaryDataFromRequest(Request $request): array
+    {
+        return [
+            'pickup'    => $this->requestFirst($request, ['payload.pickup', 'pickup']),
+            'dropoff'   => $this->requestFirst($request, ['payload.dropoff', 'dropoff']),
+            'return'    => $this->requestFirst($request, ['payload.return', 'return']),
+            'waypoints' => $this->requestFirst($request, ['payload.waypoints', 'waypoints'], []),
+            'entities'  => $this->requestFirst($request, ['payload.entities', 'entities']),
+            'cod'       => $request->has('cod'),
+            'currency'  => $request->has('currency'),
+        ];
+    }
+
+    protected function requestFirst(Request $request, array $keys, mixed $default = null): mixed
+    {
+        foreach ($keys as $key) {
+            if ($request->has($key)) {
+                return $request->input($key);
+            }
+        }
+
+        return $default;
+    }
+
+    protected function preliminaryStops(mixed $pickup, iterable $waypoints, mixed $dropoff): \Illuminate\Support\Collection
+    {
+        return collect([$pickup, ...$waypoints, $dropoff])->filter();
+    }
+
+    protected function endpointCount(mixed $pickup, mixed $dropoff): int
+    {
+        return (int) ($pickup instanceof Place) + (int) ($dropoff instanceof Place);
+    }
+
+    protected function serviceQuoteItemInput(ServiceQuote $quote, array $line): array
+    {
+        return [
+            'service_quote_uuid' => $quote->uuid,
+            'amount'             => $line['amount'],
+            'currency'           => $line['currency'],
+            'details'            => $line['details'],
+            'code'               => $line['code'],
+        ];
+    }
+
+    protected function bestQuote(iterable $serviceQuotes): mixed
+    {
+        return collect($serviceQuotes)->sortBy('amount')->first();
+    }
+
     /**
      * Finds a single Fleetbase ServiceQuote resources.
      *
@@ -378,14 +456,24 @@ class ServiceQuoteController extends Controller
     {
         // find for the serviceQuote
         try {
-            $serviceQuote = ServiceQuote::findRecordOrFail($id);
+            $serviceQuote = $this->findServiceQuote($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json([
+            return $this->jsonResponse([
                 'error' => 'ServiceQuote resource not found.',
             ], 404);
         }
 
         // response the serviceQuote resource
-        return new ServiceQuoteResource($serviceQuote);
+        return $this->serviceQuoteResource($serviceQuote);
+    }
+
+    protected function findServiceQuote(string $id): ServiceQuote
+    {
+        return ServiceQuote::findRecordOrFail($id);
+    }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
     }
 }