@fleetbase/fleetops-engine 0.6.58 → 0.6.60

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

@@ -32,47 +32,35 @@ class VehicleController extends Controller
     public function create(CreateVehicleRequest $request)
     {
         // get request input
-        $input = $request->only([
-            'status', 'make', 'model', 'year', 'trim', 'type', 'plate_number', 'vin',
-            'meta', 'online', 'location', 'altitude', 'heading', 'speed',
-            // Capacity
-            'payload_capacity', 'payload_capacity_volume',
-            'payload_capacity_pallets', 'payload_capacity_parcels',
-            // Orchestrator constraints
-            'skills', 'max_tasks', 'time_window_start', 'time_window_end', 'return_to_depot',
-        ]);
+        $input = $this->vehicleInputFromRequest($request);
 
         // make sure company is set
         $input['company_uuid'] = session('company');
 
         // set default online
-        if (!isset($input['online'])) {
-            $input['online'] = 0;
-        }
+        $input = $this->withDefaultOnline($input);
 
         // vendor assignment
         if ($request->has('vendor')) {
-            $input['vendor_uuid'] = Utils::getUuid('vendors', [
+            $input['vendor_uuid'] = $this->getVendorUuid('vendors', [
                 'public_id'    => $request->input('vendor'),
                 'company_uuid' => session('company'),
             ]);
         }
 
         // latitude / longitude
-        if ($request->has(['latitude', 'longitude'])) {
-            $input['location'] = Utils::getPointFromCoordinates($request->only(['latitude', 'longitude']));
-        }
+        $input = $this->withCoordinateLocation($input, $request);
 
         // create the vehicle (fires 'created' event for billing resource tracking)
-        $vehicle = Vehicle::create($input);
+        $vehicle = $this->createVehicle($input);
 
         // driver assignment
         if ($request->exists('driver') && !empty($request->input('driver'))) {
             // set this vehicle to the driver
             try {
-                $driver = Driver::findRecordOrFail($request->input('driver'));
+                $driver = $this->findDriver($request->input('driver'));
             } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-                return response()->json(
+                return $this->jsonResponse(
                     [
                         'error' => 'The driver attempted to assign this vehicle was not found.',
                     ],
@@ -84,7 +72,7 @@ class VehicleController extends Controller
         }
 
         // response the driver resource
-        return new VehicleResource($vehicle);
+        return $this->vehicleResource($vehicle);
     }
 
     /**
@@ -99,9 +87,9 @@ class VehicleController extends Controller
     {
         // find for the vehicle
         try {
-            $vehicle = Vehicle::findRecordOrFail($id);
+            $vehicle = $this->findVehicle($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Vehicle resource not found.',
                 ],
@@ -110,33 +98,21 @@ class VehicleController extends Controller
         }
 
         // get request input
-        $input = $request->only([
-            'status', 'make', 'model', 'year', 'trim', 'type', 'plate_number', 'vin',
-            'meta', 'location', 'online', 'altitude', 'heading', 'speed',
-            // Capacity
-            'payload_capacity', 'payload_capacity_volume',
-            'payload_capacity_pallets', 'payload_capacity_parcels',
-            // Orchestrator constraints
-            'skills', 'max_tasks', 'time_window_start', 'time_window_end', 'return_to_depot',
-        ]);
+        $input = $this->vehicleInputFromRequest($request);
 
         // vendor assignment
         if ($request->has('vendor')) {
-            $input['vendor_uuid'] = Utils::getUuid('vendors', [
+            $input['vendor_uuid'] = $this->getVendorUuid('vendors', [
                 'public_id'    => $request->input('vendor'),
                 'company_uuid' => session('company'),
             ]);
         }
 
         // set default online
-        if (!isset($input['online'])) {
-            $input['online'] = 0;
-        }
+        $input = $this->withDefaultOnline($input);
 
         // latitude / longitude
-        if ($request->has(['latitude', 'longitude'])) {
-            $input['location'] = Utils::getPointFromCoordinates($request->only(['latitude', 'longitude']));
-        }
+        $input = $this->withCoordinateLocation($input, $request);
 
         // update the vehicle w/ user input
         $vehicle->fill($input);
@@ -154,10 +130,10 @@ class VehicleController extends Controller
                 $vehicle->unassignDriver();
             } else {
                 try {
-                    $driver = Driver::findRecordOrFail($request->input('driver'));
+                    $driver = $this->findDriver($request->input('driver'));
                     $vehicle->assignDriver($driver);
                 } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-                    return response()->json(
+                    return $this->jsonResponse(
                         [
                             'error' => 'The driver attempted to assign this vehicle was not found.',
                         ],
@@ -171,7 +147,7 @@ class VehicleController extends Controller
         $vehicle = $vehicle->refresh();
 
         // response the vehicle resource
-        return new VehicleResource($vehicle);
+        return $this->vehicleResource($vehicle);
     }
 
     /**
@@ -181,15 +157,9 @@ class VehicleController extends Controller
      */
     public function query(Request $request)
     {
-        $results = Vehicle::queryWithRequest($request, function (&$query, $request) {
-            if ($request->has('vendor')) {
-                $query->whereHas('vendor', function ($q) use ($request) {
-                    $q->where('public_id', $request->input('vendor'));
-                });
-            }
-        });
+        $results = $this->queryVehicles($request);
 
-        return VehicleResource::collection($results);
+        return $this->vehicleResourceCollection($results);
     }
 
     /**
@@ -203,9 +173,9 @@ class VehicleController extends Controller
     {
         // find for the vehicle
         try {
-            $vehicle = Vehicle::findRecordOrFail($id);
+            $vehicle = $this->findVehicle($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Vehicle resource not found.',
                 ],
@@ -214,7 +184,7 @@ class VehicleController extends Controller
         }
 
         // response the vehicle resource
-        return new VehicleResource($vehicle);
+        return $this->vehicleResource($vehicle);
     }
 
     /**
@@ -228,9 +198,9 @@ class VehicleController extends Controller
     {
         // find for the driver
         try {
-            $vehicle = Vehicle::findRecordOrFail($id);
+            $vehicle = $this->findVehicle($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Vehicle resource not found.',
                 ],
@@ -242,7 +212,7 @@ class VehicleController extends Controller
         $vehicle->delete();
 
         // response the vehicle resource
-        return new DeletedResource($vehicle);
+        return $this->deletedVehicleResource($vehicle);
     }
 
     /**
@@ -259,24 +229,17 @@ class VehicleController extends Controller
         $speed     = $request->input('speed');
 
         try {
-            $vehicle = Vehicle::findRecordOrFail($id);
+            $vehicle = $this->findVehicle($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->apiError('Vehicle resource not found.', 404);
+            return $this->apiError('Vehicle resource not found.', 404);
         }
 
         // If no lat/lng provided, maintain compatibility and just return existing driver resource
         if (empty($latitude) && empty($longitude)) {
-            return new VehicleResource($vehicle);
+            return $this->vehicleResource($vehicle);
         }
 
-        $positionData = [
-            'location'  => new Point($latitude, $longitude),
-            'latitude'  => $latitude,
-            'longitude' => $longitude,
-            'altitude'  => $altitude,
-            'heading'   => $heading,
-            'speed'     => $speed,
-        ];
+        $positionData = $this->positionDataFromTrackingInput($latitude, $longitude, $altitude, $heading, $speed);
 
         // Get vehicle driver
         $vehicle->loadMissing('driver');
@@ -309,7 +272,7 @@ class VehicleController extends Controller
             }
         }
 
-        return new VehicleResource($vehicle);
+        return $this->vehicleResource($vehicle);
     }
 
     private function processVehicleGeofenceCrossings(Vehicle $vehicle, Point $newLocation, array $crossings): void
@@ -383,4 +346,95 @@ class VehicleController extends Controller
             }
         }
     }
+
+    protected function vehicleInputFromRequest(Request $request): array
+    {
+        return $request->only([
+            'status', 'make', 'model', 'year', 'trim', 'type', 'plate_number', 'vin',
+            'meta', 'online', 'location', 'altitude', 'heading', 'speed',
+            'payload_capacity', 'payload_capacity_volume',
+            'payload_capacity_pallets', 'payload_capacity_parcels',
+            'skills', 'max_tasks', 'time_window_start', 'time_window_end', 'return_to_depot',
+        ]);
+    }
+
+    protected function withDefaultOnline(array $input): array
+    {
+        if (!isset($input['online'])) {
+            $input['online'] = 0;
+        }
+
+        return $input;
+    }
+
+    protected function withCoordinateLocation(array $input, Request $request): array
+    {
+        if ($request->has(['latitude', 'longitude'])) {
+            $input['location'] = Utils::getPointFromCoordinates($request->only(['latitude', 'longitude']));
+        }
+
+        return $input;
+    }
+
+    protected function positionDataFromTrackingInput(float $latitude, float $longitude, mixed $altitude = null, mixed $heading = null, mixed $speed = null): array
+    {
+        return [
+            'location'  => new Point($latitude, $longitude),
+            'latitude'  => $latitude,
+            'longitude' => $longitude,
+            'altitude'  => $altitude,
+            'heading'   => $heading,
+            'speed'     => $speed,
+        ];
+    }
+
+    protected function getVendorUuid(string $table, array $where): ?string
+    {
+        return Utils::getUuid($table, $where);
+    }
+
+    protected function createVehicle(array $input): Vehicle
+    {
+        return Vehicle::create($input);
+    }
+
+    protected function findVehicle(string $id): Vehicle
+    {
+        return Vehicle::findRecordOrFail($id);
+    }
+
+    protected function findDriver(string $id): Driver
+    {
+        return Driver::findRecordOrFail($id);
+    }
+
+    protected function queryVehicles(Request $request)
+    {
+        return Vehicle::queryWithRequest($request);
+    }
+
+    protected function vehicleResource(Vehicle $vehicle)
+    {
+        return new VehicleResource($vehicle);
+    }
+
+    protected function vehicleResourceCollection($results)
+    {
+        return VehicleResource::collection($results);
+    }
+
+    protected function deletedVehicleResource(Vehicle $vehicle)
+    {
+        return new DeletedResource($vehicle);
+    }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
+
+    protected function apiError(string $message, int $status = 400)
+    {
+        return response()->apiError($message, $status);
+    }
 }

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

@@ -30,7 +30,7 @@ class VendorController extends Controller
 
         // address assignment
         if ($request->has('address')) {
-            $input['place_uuid'] = Utils::getUuid(
+            $input['place_uuid'] = $this->getPlaceUuid(
                 'places',
                 [
                     'public_id'    => $request->input('address'),
@@ -40,7 +40,7 @@ class VendorController extends Controller
         }
 
         // create the vendor
-        $vendor = Vendor::updateOrCreate(
+        $vendor = $this->updateOrCreateVendor(
             [
                 'company_uuid' => session('company'),
                 'name'         => strtoupper($input['name']),
@@ -49,7 +49,7 @@ class VendorController extends Controller
         );
 
         // response the driver resource
-        return new VendorResource($vendor);
+        return $this->vendorResource($vendor);
     }
 
     /**
@@ -64,9 +64,9 @@ class VendorController extends Controller
     {
         // find for the vendor
         try {
-            $vendor = Vendor::findRecordOrFail($id);
+            $vendor = $this->findVendorRecord($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Vendor resource not found.',
                 ],
@@ -79,7 +79,7 @@ class VendorController extends Controller
 
         // address assignment
         if ($request->has('address')) {
-            $input['place_uuid'] = Utils::getUuid(
+            $input['place_uuid'] = $this->getPlaceUuid(
                 'places',
                 [
                     'public_id'    => $request->input('address'),
@@ -93,7 +93,7 @@ class VendorController extends Controller
         $vendor->flushAttributesCache();
 
         // response the vendor resource
-        return new VendorResource($vendor);
+        return $this->vendorResource($vendor);
     }
 
     /**
@@ -103,9 +103,9 @@ class VendorController extends Controller
      */
     public function query(Request $request)
     {
-        $results = Vendor::queryWithRequest($request);
+        $results = $this->queryVendors($request);
 
-        return VendorResource::collection($results);
+        return $this->vendorResourceCollection($results);
     }
 
     /**
@@ -117,9 +117,9 @@ class VendorController extends Controller
     {
         // find for the vendor
         try {
-            $vendor = Vendor::findRecordOrFail($id);
+            $vendor = $this->findVendorRecord($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Vendor resource not found.',
                 ],
@@ -128,7 +128,7 @@ class VendorController extends Controller
         }
 
         // response the vendor resource
-        return new VendorResource($vendor);
+        return $this->vendorResource($vendor);
     }
 
     /**
@@ -140,9 +140,9 @@ class VendorController extends Controller
     {
         // find for the driver
         try {
-            $vendor = Vendor::findRecordOrFail($id);
+            $vendor = $this->findVendorRecord($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Vendor resource not found.',
                 ],
@@ -154,6 +154,46 @@ class VendorController extends Controller
         $vendor->delete();
 
         // response the vendor resource
+        return $this->deletedVendorResource($vendor);
+    }
+
+    protected function getPlaceUuid(string $table, array $where): ?string
+    {
+        return Utils::getUuid($table, $where);
+    }
+
+    protected function updateOrCreateVendor(array $where, array $input): Vendor
+    {
+        return Vendor::updateOrCreate($where, $input);
+    }
+
+    protected function findVendorRecord(string $id): Vendor
+    {
+        return Vendor::findRecordOrFail($id);
+    }
+
+    protected function queryVendors(Request $request)
+    {
+        return Vendor::queryWithRequest($request);
+    }
+
+    protected function vendorResource(Vendor $vendor)
+    {
+        return new VendorResource($vendor);
+    }
+
+    protected function vendorResourceCollection($results)
+    {
+        return VendorResource::collection($results);
+    }
+
+    protected function deletedVendorResource(Vendor $vendor)
+    {
         return new DeletedResource($vendor);
     }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }

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

@@ -25,9 +25,9 @@ class WorkOrderController extends Controller
         $input                 = $this->input($request);
         $input['company_uuid'] = session('company');
 
-        $workOrder = WorkOrder::create($input)->load(['target', 'assignee']);
+        $workOrder = $this->createWorkOrder($input)->load(['target', 'assignee']);
 
-        return new WorkOrderResource($workOrder);
+        return $this->workOrderResource($workOrder);
     }
 
     public function update(string $id, UpdateWorkOrderRequest $request)
@@ -42,18 +42,18 @@ class WorkOrderController extends Controller
 
         $workOrder->update($this->input($request));
 
-        return new WorkOrderResource($workOrder->refresh()->load(['target', 'assignee']));
+        return $this->workOrderResource($workOrder->refresh()->load(['target', 'assignee']));
     }
 
     public function query(Request $request)
     {
         $this->rejectUuidIdentifiers($request);
 
-        $results = WorkOrder::queryWithRequest($request, function (&$query) {
+        $results = $this->queryWorkOrdersWithRequest($request, function (&$query) {
             $query->with(['target', 'assignee']);
         });
 
-        return WorkOrderResource::collection($results);
+        return $this->workOrderResourceCollection($results);
     }
 
     public function find(string $id)
@@ -64,7 +64,7 @@ class WorkOrderController extends Controller
             return response()->json(['error' => 'WorkOrder resource not found.'], 404);
         }
 
-        return new WorkOrderResource($workOrder);
+        return $this->workOrderResource($workOrder);
     }
 
     public function delete(string $id)
@@ -77,7 +77,7 @@ class WorkOrderController extends Controller
 
         $workOrder->delete();
 
-        return new DeletedResource($workOrder);
+        return $this->deletedWorkOrderResource($workOrder);
     }
 
     public function send(string $id): JsonResponse
@@ -98,12 +98,9 @@ class WorkOrderController extends Controller
             return response()->json(['error' => 'The assigned vendor has no email address on file.'], 422);
         }
 
-        Mail::to($email)->send(new WorkOrderDispatched($workOrder));
+        $this->sendWorkOrderDispatchedMail($email, $workOrder);
 
-        activity('work_order_sent')
-            ->performedOn($workOrder)
-            ->withProperties(['sent_to' => $email])
-            ->log('Work order emailed to vendor');
+        $this->recordWorkOrderSentActivity($workOrder, $email);
 
         return response()->json([
             'status'  => 'ok',
@@ -158,4 +155,42 @@ class WorkOrderController extends Controller
 
         return $input;
     }
+
+    protected function createWorkOrder(array $input): WorkOrder
+    {
+        return WorkOrder::create($input);
+    }
+
+    protected function queryWorkOrdersWithRequest(Request $request, callable $callback)
+    {
+        return WorkOrder::queryWithRequest($request, $callback);
+    }
+
+    protected function workOrderResource(WorkOrder $workOrder)
+    {
+        return new WorkOrderResource($workOrder);
+    }
+
+    protected function workOrderResourceCollection($workOrders)
+    {
+        return WorkOrderResource::collection($workOrders);
+    }
+
+    protected function deletedWorkOrderResource(WorkOrder $workOrder)
+    {
+        return new DeletedResource($workOrder);
+    }
+
+    protected function sendWorkOrderDispatchedMail(string $email, WorkOrder $workOrder): void
+    {
+        Mail::to($email)->send(new WorkOrderDispatched($workOrder));
+    }
+
+    protected function recordWorkOrderSentActivity(WorkOrder $workOrder, string $email): void
+    {
+        activity('work_order_sent')
+            ->performedOn($workOrder)
+            ->withProperties(['sent_to' => $email])
+            ->log('Work order emailed to vendor');
+    }
 }