@fleetbase/fleetops-engine 0.6.58 → 0.6.59

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

@@ -24,40 +24,14 @@ class ServiceRateController extends Controller
     public function create(CreateServiceRateRequest $request)
     {
         // get request input
-        $input = $request->only([
-            'service_name',
-            'service_type',
-            'rate_calculation_method',
-            'currency',
-            'base_fee',
-            'max_distance_unit',
-            'max_distance',
-            'per_meter_unit',
-            'per_meter_flat_rate_fee',
-            'meter_fees',
-            'meter_fees.*.distance',
-            'meter_fees.*.fee',
-            'algorithm',
-            'has_cod_fee',
-            'cod_calculation_method',
-            'cod_flat_fee',
-            'cod_percent',
-            'has_peak_hours_fee',
-            'peak_hours_calculation_method',
-            'peak_hours_flat_fee',
-            'peak_hours_percent',
-            'peak_hours_start',
-            'peak_hours_end',
-            'duration_terms',
-            'estimated_days',
-        ]);
+        $input = $this->serviceRateInputFromRequest($request);
 
         // make sure company is set
         $input['company_uuid'] = session('company');
 
         // service area assignment
         if ($request->has('service_area')) {
-            $input['service_area_uuid'] = Utils::getUuid('service_areas', [
+            $input['service_area_uuid'] = $this->resolveUuid('service_areas', [
                 'public_id'    => $request->input('service_area'),
                 'company_uuid' => session('company'),
             ]);
@@ -65,31 +39,25 @@ class ServiceRateController extends Controller
 
         // zone assignment
         if ($request->has('zone')) {
-            $input['zone_uuid'] = Utils::getUuid('zones', [
+            $input['zone_uuid'] = $this->resolveUuid('zones', [
                 'public_id'    => $request->input('zone'),
                 'company_uuid' => session('company'),
             ]);
         }
 
         // create the serviceRate
-        $serviceRate = ServiceRate::create($input);
+        $serviceRate = $this->createServiceRate($input);
 
         // create service rate fee's if applicable
-        if ($request->has('meter_fees') && $serviceRate->isRateCalculationMethod(['fixed_meter', 'fixed_rate']) && is_array($request->input('meter_fees'))) {
+        if ($this->shouldCreateMeterFees($request, $serviceRate)) {
             foreach ($request->input('meter_fees') as $meterFee) {
-                ServiceRateFee::create([
-                    'service_rate_uuid' => $serviceRate->uuid,
-                    'distance'          => Utils::get($meterFee, 'distance'),
-                    'distance_unit'     => $request->input('per_meter_unit', 'm'),
-                    'fee'               => Utils::get($meterFee, 'fee'),
-                    'currency'          => $serviceRate->currency,
-                ]);
+                $this->createServiceRateFee($this->meterFeeInputFromRequest($request, $serviceRate, $meterFee));
             }
             $serviceRate->makeVisible('meter_fees');
         }
 
         // response the driver resource
-        return new ServiceRateResource($serviceRate);
+        return $this->serviceRateResource($serviceRate);
     }
 
     /**
@@ -104,7 +72,7 @@ class ServiceRateController extends Controller
     {
         // find for the serviceRate
         try {
-            $serviceRate = ServiceRate::findRecordOrFail($id);
+            $serviceRate = $this->findServiceRate($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
             return response()->json(
                 [
@@ -115,37 +83,11 @@ class ServiceRateController extends Controller
         }
 
         // get request input
-        $input = $request->only([
-            'service_name',
-            'service_type',
-            'rate_calculation_method',
-            'currency',
-            'base_fee',
-            'max_distance_unit',
-            'max_distance',
-            'per_meter_unit',
-            'per_meter_flat_rate_fee',
-            'meter_fees',
-            'meter_fees.*.distance',
-            'meter_fees.*.fee',
-            'algorithm',
-            'has_cod_fee',
-            'cod_calculation_method',
-            'cod_flat_fee',
-            'cod_percent',
-            'has_peak_hours_fee',
-            'peak_hours_calculation_method',
-            'peak_hours_flat_fee',
-            'peak_hours_percent',
-            'peak_hours_start',
-            'peak_hours_end',
-            'duration_terms',
-            'estimated_days',
-        ]);
+        $input = $this->serviceRateInputFromRequest($request);
 
         // service area assignment
         if ($request->has('service_area')) {
-            $input['service_area_uuid'] = Utils::getUuid('service_areas', [
+            $input['service_area_uuid'] = $this->resolveUuid('service_areas', [
                 'public_id'    => $request->input('service_area'),
                 'company_uuid' => session('company'),
             ]);
@@ -153,7 +95,7 @@ class ServiceRateController extends Controller
 
         // zone assignment
         if ($request->has('zone')) {
-            $input['zone_uuid'] = Utils::getUuid('zones', [
+            $input['zone_uuid'] = $this->resolveUuid('zones', [
                 'public_id'    => $request->input('zone'),
                 'company_uuid' => session('company'),
             ]);
@@ -163,7 +105,7 @@ class ServiceRateController extends Controller
         $serviceRate->update($input);
 
         // response the serviceRate resource
-        return new ServiceRateResource($serviceRate);
+        return $this->serviceRateResource($serviceRate);
     }
 
     /**
@@ -173,9 +115,9 @@ class ServiceRateController extends Controller
      */
     public function query(Request $request)
     {
-        $results = ServiceRate::queryWithRequest($request);
+        $results = $this->queryServiceRates($request);
 
-        return ServiceRateResource::collection($results);
+        return $this->serviceRateResourceCollection($results);
     }
 
     /**
@@ -187,7 +129,7 @@ class ServiceRateController extends Controller
     {
         // find for the serviceRate
         try {
-            $serviceRate = ServiceRate::findRecordOrFail($id);
+            $serviceRate = $this->findServiceRate($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
             return response()->json(
                 [
@@ -198,7 +140,7 @@ class ServiceRateController extends Controller
         }
 
         // response the serviceRate resource
-        return new ServiceRateResource($serviceRate);
+        return $this->serviceRateResource($serviceRate);
     }
 
     /**
@@ -210,7 +152,7 @@ class ServiceRateController extends Controller
     {
         // find for the driver
         try {
-            $serviceRate = ServiceRate::findRecordOrFail($id);
+            $serviceRate = $this->findServiceRate($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
             return response()->json(
                 [
@@ -224,6 +166,93 @@ class ServiceRateController extends Controller
         $serviceRate->delete();
 
         // response the serviceRate resource
+        return $this->deletedServiceRateResource($serviceRate);
+    }
+
+    protected function serviceRateInputFromRequest(Request $request): array
+    {
+        return $request->only([
+            'service_name',
+            'service_type',
+            'rate_calculation_method',
+            'currency',
+            'base_fee',
+            'max_distance_unit',
+            'max_distance',
+            'per_meter_unit',
+            'per_meter_flat_rate_fee',
+            'meter_fees',
+            'meter_fees.*.distance',
+            'meter_fees.*.fee',
+            'algorithm',
+            'has_cod_fee',
+            'cod_calculation_method',
+            'cod_flat_fee',
+            'cod_percent',
+            'has_peak_hours_fee',
+            'peak_hours_calculation_method',
+            'peak_hours_flat_fee',
+            'peak_hours_percent',
+            'peak_hours_start',
+            'peak_hours_end',
+            'duration_terms',
+            'estimated_days',
+        ]);
+    }
+
+    protected function shouldCreateMeterFees(Request $request, ServiceRate $serviceRate): bool
+    {
+        return $request->has('meter_fees') && $serviceRate->isRateCalculationMethod(['fixed_meter', 'fixed_rate']) && is_array($request->input('meter_fees'));
+    }
+
+    protected function meterFeeInputFromRequest(Request $request, ServiceRate $serviceRate, array $meterFee): array
+    {
+        return [
+            'service_rate_uuid' => $serviceRate->uuid,
+            'distance'          => Utils::get($meterFee, 'distance'),
+            'distance_unit'     => $request->input('per_meter_unit', 'm'),
+            'fee'               => Utils::get($meterFee, 'fee'),
+            'currency'          => $serviceRate->currency,
+        ];
+    }
+
+    protected function resolveUuid(string $table, array $where): ?string
+    {
+        return Utils::getUuid($table, $where);
+    }
+
+    protected function createServiceRate(array $input): ServiceRate
+    {
+        return ServiceRate::create($input);
+    }
+
+    protected function createServiceRateFee(array $input): ServiceRateFee
+    {
+        return ServiceRateFee::create($input);
+    }
+
+    protected function findServiceRate(string $id): ServiceRate
+    {
+        return ServiceRate::findRecordOrFail($id);
+    }
+
+    protected function queryServiceRates(Request $request)
+    {
+        return ServiceRate::queryWithRequest($request);
+    }
+
+    protected function serviceRateResource(ServiceRate $serviceRate)
+    {
+        return new ServiceRateResource($serviceRate);
+    }
+
+    protected function serviceRateResourceCollection($serviceRates)
+    {
+        return ServiceRateResource::collection($serviceRates);
+    }
+
+    protected function deletedServiceRateResource(ServiceRate $serviceRate)
+    {
         return new DeletedResource($serviceRate);
     }
 }

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

@@ -30,7 +30,7 @@ class TrackingNumberController extends Controller
 
         // owner assignment
         if ($request->has('owner')) {
-            $owner = Utils::getUuid(
+            $owner = $this->getOwnerUuid(
                 ['orders', 'entities'],
                 [
                     'public_id'    => $request->input('owner'),
@@ -48,10 +48,10 @@ class TrackingNumberController extends Controller
         }
 
         // create the trackingNumber
-        $trackingNumber = TrackingNumber::create($input);
+        $trackingNumber = $this->createTrackingNumber($input);
 
         // response the driver resource
-        return new TrackingNumberResource($trackingNumber);
+        return $this->trackingNumberResource($trackingNumber);
     }
 
     /**
@@ -61,9 +61,9 @@ class TrackingNumberController extends Controller
      */
     public function query(Request $request)
     {
-        $results = TrackingNumber::queryWithRequest($request);
+        $results = $this->queryTrackingNumbers($request);
 
-        return TrackingNumberResource::collection($results);
+        return $this->trackingNumberResourceCollection($results);
     }
 
     /**
@@ -75,9 +75,9 @@ class TrackingNumberController extends Controller
     {
         // find for the trackingNumber
         try {
-            $trackingNumber = TrackingNumber::findTrackingOrFail($id);
+            $trackingNumber = $this->findTrackingNumber($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'TrackingNumber resource not found.',
                 ],
@@ -86,7 +86,7 @@ class TrackingNumberController extends Controller
         }
 
         // response the trackingNumber resource
-        return new TrackingNumberResource($trackingNumber);
+        return $this->trackingNumberResource($trackingNumber);
     }
 
     /**
@@ -98,9 +98,9 @@ class TrackingNumberController extends Controller
     {
         // find for the driver
         try {
-            $trackingNumber = TrackingNumber::findTrackingOrFail($id);
+            $trackingNumber = $this->findTrackingNumber($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'TrackingNumber resource not found.',
                 ],
@@ -112,7 +112,7 @@ class TrackingNumberController extends Controller
         $trackingNumber->delete();
 
         // response the trackingNumber resource
-        return new DeletedResource($trackingNumber);
+        return $this->deletedTrackingNumberResource($trackingNumber);
     }
 
     /**
@@ -128,11 +128,11 @@ class TrackingNumberController extends Controller
         $code = $request->input('code');
 
         // get the model of from the code
-        $model = Utils::findModel(['entities', 'orders'], ['uuid' => $code]);
+        $model = $this->findQrModel(['entities', 'orders'], ['uuid' => $code]);
 
         // if no model response with error
         if (!$model) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Unable to find QR code value',
                 ],
@@ -141,9 +141,78 @@ class TrackingNumberController extends Controller
         }
 
         // get the model class name
+        return $this->qrModelResource($model);
+    }
+
+    protected function getOwnerUuid(array $tables, array $where, array $options)
+    {
+        return Utils::getUuid($tables, $where, $options);
+    }
+
+    protected function createTrackingNumber(array $input): TrackingNumber
+    {
+        return TrackingNumber::create($input);
+    }
+
+    protected function queryTrackingNumbers(Request $request)
+    {
+        return TrackingNumber::queryWithRequest($request);
+    }
+
+    protected function findTrackingNumber(string $id): TrackingNumber
+    {
+        return TrackingNumber::findTrackingOrFail($id);
+    }
+
+    protected function trackingNumberResource(TrackingNumber $trackingNumber)
+    {
+        return new TrackingNumberResource($trackingNumber);
+    }
+
+    protected function trackingNumberResourceCollection($results)
+    {
+        return TrackingNumberResource::collection($results);
+    }
+
+    protected function deletedTrackingNumberResource(TrackingNumber $trackingNumber)
+    {
+        return new DeletedResource($trackingNumber);
+    }
+
+    protected function findQrModel(array $tables, array $where)
+    {
+        // Hydrate through the eloquent models so the resolved record can be
+        // wrapped in its typed resource — raw rows have no model class.
+        $modelMap = [
+            'entities' => \Fleetbase\FleetOps\Models\Entity::class,
+            'orders'   => \Fleetbase\FleetOps\Models\Order::class,
+        ];
+
+        foreach ($tables as $table) {
+            $modelClass = $modelMap[$table] ?? null;
+            if (!$modelClass) {
+                continue;
+            }
+
+            $model = $modelClass::where($where)->first();
+            if ($model) {
+                return $model;
+            }
+        }
+
+        return Utils::findModel($tables, $where);
+    }
+
+    protected function qrModelResource($model)
+    {
         $modelType         = class_basename($model);
-        $resourceNamespace = '\\Fleetbase\\Http\\Resources\\v1\\' . $modelType;
+        $resourceNamespace = '\\Fleetbase\\FleetOps\\Http\\Resources\\v1\\' . $modelType;
 
         return new $resourceNamespace($model);
     }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }

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

@@ -41,7 +41,7 @@ class TrackingStatusController extends Controller
 
         // if no code set create a code from the status
         if (empty($input['code'])) {
-            $input['code'] = TrackingStatus::prepareCode($input['status']);
+            $input['code'] = $this->prepareTrackingStatusCode($input['status']);
         }
 
         // make sure company is set
@@ -49,7 +49,7 @@ class TrackingStatusController extends Controller
 
         // tracking number assignment
         if ($request->has('tracking_number')) {
-            $input['tracking_number_uuid'] = Utils::getUuid('tracking_numbers', [
+            $input['tracking_number_uuid'] = $this->getTrackingNumberUuid('tracking_numbers', [
                 'public_id'    => $request->input('tracking_number'),
                 'company_uuid' => session('company'),
             ]);
@@ -57,14 +57,14 @@ class TrackingStatusController extends Controller
 
         // tracking number assignment
         if ($request->has('order')) {
-            $input['tracking_number_uuid'] = Order::where('public_id', $request->input('order'))->value('tracking_number_uuid');
+            $input['tracking_number_uuid'] = $this->getOrderTrackingNumberUuid($request->input('order'));
         }
 
         // create the trackingStatus
-        $trackingStatus = TrackingStatus::create($input);
+        $trackingStatus = $this->createTrackingStatus($input);
 
         // response the driver resource
-        return new TrackingStatusResource($trackingStatus);
+        return $this->trackingStatusResource($trackingStatus);
     }
 
     /**
@@ -79,9 +79,9 @@ class TrackingStatusController extends Controller
     {
         // find for the trackingStatus
         try {
-            $trackingStatus = TrackingStatus::findRecordOrFail($id);
+            $trackingStatus = $this->findTrackingStatus($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'TrackingStatus resource not found.',
                 ],
@@ -106,14 +106,14 @@ class TrackingStatusController extends Controller
 
         // if no code set create a code from the status
         if (empty($trackingStatus->code)) {
-            $input['code'] = TrackingStatus::prepareCode(data_get($input, 'status', $trackingStatus->status));
+            $input['code'] = $this->prepareTrackingStatusCode(data_get($input, 'status', $trackingStatus->status));
         }
 
         // update the trackingStatus
         $trackingStatus->update($input);
 
         // response the trackingStatus resource
-        return new TrackingStatusResource($trackingStatus);
+        return $this->trackingStatusResource($trackingStatus);
     }
 
     /**
@@ -123,9 +123,9 @@ class TrackingStatusController extends Controller
      */
     public function query(Request $request)
     {
-        $results = TrackingStatus::queryWithRequest($request);
+        $results = $this->queryTrackingStatuses($request);
 
-        return TrackingStatusResource::collection($results);
+        return $this->trackingStatusResourceCollection($results);
     }
 
     /**
@@ -137,9 +137,9 @@ class TrackingStatusController extends Controller
     {
         // find for the trackingStatus
         try {
-            $trackingStatus = TrackingStatus::findRecordOrFail($id);
+            $trackingStatus = $this->findTrackingStatus($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'TrackingStatus resource not found.',
                 ],
@@ -148,7 +148,7 @@ class TrackingStatusController extends Controller
         }
 
         // response the trackingStatus resource
-        return new TrackingStatusResource($trackingStatus);
+        return $this->trackingStatusResource($trackingStatus);
     }
 
     /**
@@ -160,9 +160,9 @@ class TrackingStatusController extends Controller
     {
         // find for the driver
         try {
-            $trackingStatus = TrackingStatus::findRecordOrFail($id);
+            $trackingStatus = $this->findTrackingStatus($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'TrackingStatus resource not found.',
                 ],
@@ -174,6 +174,56 @@ class TrackingStatusController extends Controller
         $trackingStatus->delete();
 
         // response the trackingStatus resource
+        return $this->deletedTrackingStatusResource($trackingStatus);
+    }
+
+    protected function prepareTrackingStatusCode(string $status): string
+    {
+        return TrackingStatus::prepareCode($status);
+    }
+
+    protected function getTrackingNumberUuid(string $table, array $where): ?string
+    {
+        return Utils::getUuid($table, $where);
+    }
+
+    protected function getOrderTrackingNumberUuid(string $orderId): ?string
+    {
+        return Order::where('public_id', $orderId)->value('tracking_number_uuid');
+    }
+
+    protected function createTrackingStatus(array $input): TrackingStatus
+    {
+        return TrackingStatus::create($input);
+    }
+
+    protected function findTrackingStatus(string $id): TrackingStatus
+    {
+        return TrackingStatus::findRecordOrFail($id);
+    }
+
+    protected function queryTrackingStatuses(Request $request)
+    {
+        return TrackingStatus::queryWithRequest($request);
+    }
+
+    protected function trackingStatusResource(TrackingStatus $trackingStatus)
+    {
+        return new TrackingStatusResource($trackingStatus);
+    }
+
+    protected function trackingStatusResourceCollection($results)
+    {
+        return TrackingStatusResource::collection($results);
+    }
+
+    protected function deletedTrackingStatusResource(TrackingStatus $trackingStatus)
+    {
         return new DeletedResource($trackingStatus);
     }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }