@fleetbase/fleetops-engine 0.6.57 → 0.6.59

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

@@ -25,30 +25,11 @@ class EntityController extends Controller
     public function create(CreateEntityRequest $request)
     {
         // get request input
-        $input = $request->only([
-            'name',
-            'type',
-            'internal_id',
-            'description',
-            'meta',
-            'length',
-            'width',
-            'height',
-            'weight',
-            'weight_unit',
-            'dimensions_unit',
-            'declared_value',
-            'price',
-            'sales_price',
-            'sku',
-            'currency',
-            'meta',
-            'supplier_uuid',
-        ]);
+        $input = $this->entityInputFromRequest($request);
 
         // payload assignment
         if ($request->has('payload')) {
-            $input['payload_uuid'] = Utils::getUuid('payloads', [
+            $input['payload_uuid'] = $this->getUuid('payloads', [
                 'public_id'    => $request->input('payload'),
                 'company_uuid' => session('company'),
             ]);
@@ -56,7 +37,7 @@ class EntityController extends Controller
 
         // customer assignment
         if ($request->has('customer')) {
-            $customer = Utils::getUuid(
+            $customer = $this->getUuid(
                 ['contacts', 'vendors'],
                 [
                     'public_id'    => $request->input('customer'),
@@ -65,14 +46,14 @@ class EntityController extends Controller
             );
 
             if (is_array($customer)) {
-                $input['customer_uuid'] = Utils::get($customer, 'uuid');
-                $input['customer_type'] = Utils::getModelClassName(Utils::get($customer, 'table'));
+                $input['customer_uuid'] = $this->getValue($customer, 'uuid');
+                $input['customer_type'] = $this->getModelClassName($this->getValue($customer, 'table'));
             }
         }
 
         // driver assignment
         if ($request->has('driver')) {
-            $input['driver_uuid'] = Utils::getUuid('drivers', [
+            $input['driver_uuid'] = $this->getUuid('drivers', [
                 'public_id'    => $request->input('driver'),
                 'company_uuid' => session('company'),
             ]);
@@ -83,7 +64,7 @@ class EntityController extends Controller
             $destinationKey = $request->or(['destination', 'waypoint']);
 
             if ($request->has('payload')) {
-                $payload = Payload::where('public_id', $request->input('payload'))->first();
+                $payload = $this->findPayloadByPublicId($request->input('payload'));
 
                 if ($payload) {
                     // if a destination or waypoint is explicitly set
@@ -99,10 +80,10 @@ class EntityController extends Controller
         $input['company_uuid'] = session('company');
 
         // create the entity
-        $entity = Entity::create($input);
+        $entity = $this->createEntity($input);
 
         // response the driver resource
-        return new EntityResource($entity);
+        return $this->entityResource($entity);
     }
 
     /**
@@ -117,9 +98,9 @@ class EntityController extends Controller
     {
         // find for the entity
         try {
-            $entity = Entity::findRecordOrFail($id);
+            $entity = $this->findEntityOrFail($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Entity resource not found.',
                 ],
@@ -128,30 +109,11 @@ class EntityController extends Controller
         }
 
         // get request input
-        $input = $request->only([
-            'name',
-            'type',
-            'internal_id',
-            'description',
-            'meta',
-            'length',
-            'width',
-            'height',
-            'weight',
-            'weight_unit',
-            'dimensions_unit',
-            'declared_value',
-            'price',
-            'sales_price',
-            'sku',
-            'currency',
-            'meta',
-            'supplier_uuid',
-        ]);
+        $input = $this->entityInputFromRequest($request);
 
         // payload assignment
         if ($request->has('payload')) {
-            $input['payload_uuid'] = Utils::getUuid('payloads', [
+            $input['payload_uuid'] = $this->getUuid('payloads', [
                 'public_id'    => $request->input('payload'),
                 'company_uuid' => session('company'),
             ]);
@@ -159,22 +121,22 @@ class EntityController extends Controller
 
         // customer assignment
         if ($request->has('customer')) {
-            $customer = Utils::getUuid(
+            $customer = $this->getUuid(
                 ['contacts', 'vendors'],
                 [
-                    'public_id'    => $request->input('payload'),
+                    'public_id'    => $request->input('customer'),
                     'company_uuid' => session('company'),
                 ]
             );
             if (is_array($customer)) {
-                $input['customer_uuid']   = Utils::get($customer, 'uuid');
-                $input['customer_object'] = Utils::singularize(Utils::get($customer, 'table'));
+                $input['customer_uuid']   = $this->getValue($customer, 'uuid');
+                $input['customer_object'] = $this->singularize($this->getValue($customer, 'table'));
             }
         }
 
         // driver assignment
         if ($request->has('driver')) {
-            $input['driver_uuid'] = Utils::getUuid('drivers', [
+            $input['driver_uuid'] = $this->getUuid('drivers', [
                 'public_id'    => $request->input('driver'),
                 'company_uuid' => session('company'),
             ]);
@@ -185,13 +147,13 @@ class EntityController extends Controller
             $destinationKey = $request->or(['destination', 'waypoint']);
 
             if ($request->has('payload')) {
-                $payload = Payload::where('public_id', $request->input('payload'))->first();
+                $payload = $this->findPayloadByPublicId($request->input('payload'));
 
                 if ($payload) {
                     // if a destination or waypoint is explicitly set
                     $destination = $payload->findDestinationFromKey($destinationKey);
                     if ($destination instanceof Place) {
-                        $attributes['destination_uuid'] = $destination->uuid;
+                        $input['destination_uuid'] = $destination->uuid;
                     }
                 }
             }
@@ -201,7 +163,7 @@ class EntityController extends Controller
         $entity->update($input);
 
         // response the entity resource
-        return new EntityResource($entity);
+        return $this->entityResource($entity);
     }
 
     /**
@@ -211,9 +173,9 @@ class EntityController extends Controller
      */
     public function query(Request $request)
     {
-        $results = Entity::queryWithRequest($request);
+        $results = $this->queryEntities($request);
 
-        return EntityResource::collection($results);
+        return $this->entityResourceCollection($results);
     }
 
     /**
@@ -225,9 +187,9 @@ class EntityController extends Controller
     {
         // find for the entity
         try {
-            $entity = Entity::findRecordOrFail($id);
+            $entity = $this->findEntityOrFail($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Entity resource not found.',
                 ],
@@ -236,7 +198,7 @@ class EntityController extends Controller
         }
 
         // response the entity resource
-        return new EntityResource($entity);
+        return $this->entityResource($entity);
     }
 
     /**
@@ -248,9 +210,9 @@ class EntityController extends Controller
     {
         // find for the driver
         try {
-            $entity = Entity::findRecordOrFail($id);
+            $entity = $this->findEntityOrFail($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Entity resource not found.',
                 ],
@@ -262,6 +224,90 @@ class EntityController extends Controller
         $entity->delete();
 
         // response the entity resource
+        return $this->deletedEntityResource($entity);
+    }
+
+    protected function entityInputFromRequest(Request $request): array
+    {
+        return $request->only([
+            'name',
+            'type',
+            'internal_id',
+            'description',
+            'meta',
+            'length',
+            'width',
+            'height',
+            'weight',
+            'weight_unit',
+            'dimensions_unit',
+            'declared_value',
+            'price',
+            'sales_price',
+            'sku',
+            'currency',
+            'meta',
+            'supplier_uuid',
+        ]);
+    }
+
+    protected function getUuid(array|string $table, array $where): mixed
+    {
+        return Utils::getUuid($table, $where);
+    }
+
+    protected function getValue(array|object $data, string $key): mixed
+    {
+        return Utils::get($data, $key);
+    }
+
+    protected function getModelClassName(?string $table): ?string
+    {
+        return $table ? Utils::getModelClassName($table) : null;
+    }
+
+    protected function singularize(?string $value): ?string
+    {
+        return $value ? Utils::singularize($value) : null;
+    }
+
+    protected function findPayloadByPublicId(string $publicId): ?Payload
+    {
+        return Payload::where('public_id', $publicId)->first();
+    }
+
+    protected function createEntity(array $input): Entity
+    {
+        return Entity::create($input);
+    }
+
+    protected function findEntityOrFail(string $id): Entity
+    {
+        return Entity::findRecordOrFail($id);
+    }
+
+    protected function queryEntities(Request $request): mixed
+    {
+        return Entity::queryWithRequest($request);
+    }
+
+    protected function entityResource(Entity $entity)
+    {
+        return new EntityResource($entity);
+    }
+
+    protected function entityResourceCollection(mixed $results): mixed
+    {
+        return EntityResource::collection($results);
+    }
+
+    protected function deletedEntityResource(Entity $entity)
+    {
         return new DeletedResource($entity);
     }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }

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

@@ -24,9 +24,9 @@ class EquipmentController extends Controller
         $input                 = $this->input($request);
         $input['company_uuid'] = session('company');
 
-        $equipment = Equipment::create($input)->load(['warranty', 'photo', 'equipable']);
+        $equipment = $this->createEquipment($input)->load(['warranty', 'photo', 'equipable']);
 
-        return new EquipmentResource($equipment);
+        return $this->equipmentResource($equipment);
     }
 
     public function update(string $id, UpdateEquipmentRequest $request)
@@ -36,23 +36,23 @@ class EquipmentController extends Controller
         try {
             $equipment = $this->resolveModel(Equipment::class, $id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(['error' => 'Equipment resource not found.'], 404);
+            return $this->jsonResponse(['error' => 'Equipment resource not found.'], 404);
         }
 
         $equipment->update($this->input($request));
 
-        return new EquipmentResource($equipment->refresh()->load(['warranty', 'photo', 'equipable']));
+        return $this->equipmentResource($equipment->refresh()->load(['warranty', 'photo', 'equipable']));
     }
 
     public function query(Request $request)
     {
         $this->rejectUuidIdentifiers($request);
 
-        $results = Equipment::queryWithRequest($request, function (&$query) {
+        $results = $this->queryEquipment($request, function (&$query) {
             $query->with(['warranty', 'photo', 'equipable']);
         });
 
-        return EquipmentResource::collection($results);
+        return $this->equipmentResourceCollection($results);
     }
 
     public function find(string $id)
@@ -60,10 +60,10 @@ class EquipmentController extends Controller
         try {
             $equipment = $this->resolveModel(Equipment::class, $id)->load(['warranty', 'photo', 'equipable']);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(['error' => 'Equipment resource not found.'], 404);
+            return $this->jsonResponse(['error' => 'Equipment resource not found.'], 404);
         }
 
-        return new EquipmentResource($equipment);
+        return $this->equipmentResource($equipment);
     }
 
     public function delete(string $id)
@@ -71,12 +71,12 @@ class EquipmentController extends Controller
         try {
             $equipment = $this->resolveModel(Equipment::class, $id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(['error' => 'Equipment resource not found.'], 404);
+            return $this->jsonResponse(['error' => 'Equipment resource not found.'], 404);
         }
 
         $equipment->delete();
 
-        return new DeletedResource($equipment);
+        return $this->deletedEquipmentResource($equipment);
     }
 
     protected function input(Request $request): array
@@ -111,4 +111,34 @@ class EquipmentController extends Controller
 
         return $input;
     }
+
+    protected function createEquipment(array $input): Equipment
+    {
+        return Equipment::create($input);
+    }
+
+    protected function queryEquipment(Request $request, callable $callback)
+    {
+        return Equipment::queryWithRequest($request, $callback);
+    }
+
+    protected function equipmentResource(Equipment $equipment)
+    {
+        return new EquipmentResource($equipment);
+    }
+
+    protected function equipmentResourceCollection($results)
+    {
+        return EquipmentResource::collection($results);
+    }
+
+    protected function deletedEquipmentResource(Equipment $equipment)
+    {
+        return new DeletedResource($equipment);
+    }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }

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

@@ -30,17 +30,17 @@ class FleetController extends Controller
 
         // service area assignment
         if ($request->has('service_area')) {
-            $input['service_area_uuid'] = Utils::getUuid('service_areas', [
+            $input['service_area_uuid'] = $this->getServiceAreaUuid('service_areas', [
                 'public_id'    => $request->input('service_area'),
                 'company_uuid' => session('company'),
             ]);
         }
 
         // create the fleet
-        $fleet = Fleet::create($input);
+        $fleet = $this->createFleet($input);
 
         // response the driver resource
-        return new FleetResource($fleet);
+        return $this->fleetResource($fleet);
     }
 
     /**
@@ -55,9 +55,9 @@ class FleetController extends Controller
     {
         // find for the fleet
         try {
-            $fleet = Fleet::findRecordOrFail($id);
+            $fleet = $this->findFleet($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Fleet resource not found.',
                 ],
@@ -70,7 +70,7 @@ class FleetController extends Controller
 
         // service area assignment
         if ($request->has('service_area')) {
-            $input['service_area_uuid'] = Utils::getUuid('service_areas', [
+            $input['service_area_uuid'] = $this->getServiceAreaUuid('service_areas', [
                 'public_id'    => $request->input('service_area'),
                 'company_uuid' => session('company'),
             ]);
@@ -80,7 +80,7 @@ class FleetController extends Controller
         $fleet->update($input);
 
         // response the fleet resource
-        return new FleetResource($fleet);
+        return $this->fleetResource($fleet);
     }
 
     /**
@@ -90,9 +90,9 @@ class FleetController extends Controller
      */
     public function query(Request $request)
     {
-        $results = Fleet::queryWithRequest($request);
+        $results = $this->queryFleets($request);
 
-        return FleetResource::collection($results);
+        return $this->fleetResourceCollection($results);
     }
 
     /**
@@ -104,9 +104,9 @@ class FleetController extends Controller
     {
         // find for the fleet
         try {
-            $fleet = Fleet::findRecordOrFail($id);
+            $fleet = $this->findFleet($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Fleet resource not found.',
                 ],
@@ -115,7 +115,7 @@ class FleetController extends Controller
         }
 
         // response the fleet resource
-        return new FleetResource($fleet);
+        return $this->fleetResource($fleet);
     }
 
     /**
@@ -127,9 +127,9 @@ class FleetController extends Controller
     {
         // find for the driver
         try {
-            $fleet = Fleet::findRecordOrFail($id);
+            $fleet = $this->findFleet($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Fleet resource not found.',
                 ],
@@ -141,6 +141,46 @@ class FleetController extends Controller
         $fleet->delete();
 
         // response the fleet resource
+        return $this->deletedFleetResource($fleet);
+    }
+
+    protected function getServiceAreaUuid(string $table, array $where): ?string
+    {
+        return Utils::getUuid($table, $where);
+    }
+
+    protected function createFleet(array $input): Fleet
+    {
+        return Fleet::create($input);
+    }
+
+    protected function findFleet(string $id): Fleet
+    {
+        return Fleet::findRecordOrFail($id);
+    }
+
+    protected function queryFleets(Request $request)
+    {
+        return Fleet::queryWithRequest($request);
+    }
+
+    protected function fleetResource(Fleet $fleet)
+    {
+        return new FleetResource($fleet);
+    }
+
+    protected function fleetResourceCollection($results)
+    {
+        return FleetResource::collection($results);
+    }
+
+    protected function deletedFleetResource(Fleet $fleet)
+    {
         return new DeletedResource($fleet);
     }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }

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

@@ -35,9 +35,9 @@ class FuelReportController extends Controller
 
         // Find driver who is reporting
         try {
-            $driver = Driver::findRecordOrFail($request->input('driver'));
+            $driver = $this->findDriverRecord($request->input('driver'));
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Driver reporting fuel report not found.',
                 ],
@@ -52,10 +52,10 @@ class FuelReportController extends Controller
         $input['vehicle_uuid']      = $driver->vehicle_uuid;
 
         // create the fuel report
-        $fuelReport = FuelReport::create($input);
+        $fuelReport = $this->createFuelReport($input);
 
         // response the driver resource
-        return new FuelReportResource($fuelReport);
+        return $this->fuelReportResource($fuelReport);
     }
 
     /**
@@ -70,9 +70,9 @@ class FuelReportController extends Controller
     {
         // find for the fuel report
         try {
-            $fuelReport = FuelReport::findRecordOrFail($id);
+            $fuelReport = $this->findFuelReportRecord($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'FuelReport resource not found.',
                 ],
@@ -93,7 +93,7 @@ class FuelReportController extends Controller
         $fuelReport->update($input);
 
         // response the fuel report resource
-        return new FuelReportResource($fuelReport);
+        return $this->fuelReportResource($fuelReport);
     }
 
     /**
@@ -103,9 +103,9 @@ class FuelReportController extends Controller
      */
     public function query(Request $request)
     {
-        $results = FuelReport::queryWithRequest($request);
+        $results = $this->queryFuelReports($request);
 
-        return FuelReportResource::collection($results);
+        return $this->fuelReportResourceCollection($results);
     }
 
     /**
@@ -117,9 +117,9 @@ class FuelReportController extends Controller
     {
         // find for the fuel report
         try {
-            $fuelReport = FuelReport::findRecordOrFail($id);
+            $fuelReport = $this->findFuelReportRecord($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'FuelReport resource not found.',
                 ],
@@ -128,7 +128,7 @@ class FuelReportController extends Controller
         }
 
         // response the fuel report resource
-        return new FuelReportResource($fuelReport);
+        return $this->fuelReportResource($fuelReport);
     }
 
     /**
@@ -140,9 +140,9 @@ class FuelReportController extends Controller
     {
         // find for the driver
         try {
-            $fuelReport = FuelReport::findRecordOrFail($id);
+            $fuelReport = $this->findFuelReportRecord($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'FuelReport resource not found.',
                 ],
@@ -154,6 +154,46 @@ class FuelReportController extends Controller
         $fuelReport->delete();
 
         // response the fuel report resource
+        return $this->deletedFuelReportResource($fuelReport);
+    }
+
+    protected function findDriverRecord(string $id): Driver
+    {
+        return Driver::findRecordOrFail($id);
+    }
+
+    protected function createFuelReport(array $input): FuelReport
+    {
+        return FuelReport::create($input);
+    }
+
+    protected function findFuelReportRecord(string $id): FuelReport
+    {
+        return FuelReport::findRecordOrFail($id);
+    }
+
+    protected function queryFuelReports(Request $request)
+    {
+        return FuelReport::queryWithRequest($request);
+    }
+
+    protected function fuelReportResource(FuelReport $fuelReport)
+    {
+        return new FuelReportResource($fuelReport);
+    }
+
+    protected function fuelReportResourceCollection($results)
+    {
+        return FuelReportResource::collection($results);
+    }
+
+    protected function deletedFuelReportResource(FuelReport $fuelReport)
+    {
         return new DeletedFuelReport($fuelReport);
     }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }