@fleetbase/fleetops-engine 0.6.58 → 0.6.60

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

@@ -25,9 +25,9 @@ class PartController extends Controller
         $input                 = $this->input($request);
         $input['company_uuid'] = session('company');
 
-        $part = Part::create($input)->load(['vendor', 'warranty', 'photo', 'asset']);
+        $part = $this->createPart($input)->load(['vendor', 'warranty', 'photo', 'asset']);
 
-        return new PartResource($part);
+        return $this->partResource($part);
     }
 
     public function update(string $id, UpdatePartRequest $request)
@@ -37,23 +37,23 @@ class PartController extends Controller
         try {
             $part = $this->resolveModel(Part::class, $id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(['error' => 'Part resource not found.'], 404);
+            return $this->jsonResponse(['error' => 'Part resource not found.'], 404);
         }
 
         $part->update($this->input($request));
 
-        return new PartResource($part->refresh()->load(['vendor', 'warranty', 'photo', 'asset']));
+        return $this->partResource($part->refresh()->load(['vendor', 'warranty', 'photo', 'asset']));
     }
 
     public function query(Request $request)
     {
         $this->rejectUuidIdentifiers($request);
 
-        $results = Part::queryWithRequest($request, function (&$query) {
+        $results = $this->queryParts($request, function (&$query) {
             $query->with(['vendor', 'warranty', 'photo', 'asset']);
         });
 
-        return PartResource::collection($results);
+        return $this->partResourceCollection($results);
     }
 
     public function find(string $id)
@@ -61,10 +61,10 @@ class PartController extends Controller
         try {
             $part = $this->resolveModel(Part::class, $id)->load(['vendor', 'warranty', 'photo', 'asset']);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(['error' => 'Part resource not found.'], 404);
+            return $this->jsonResponse(['error' => 'Part resource not found.'], 404);
         }
 
-        return new PartResource($part);
+        return $this->partResource($part);
     }
 
     public function delete(string $id)
@@ -72,12 +72,12 @@ class PartController extends Controller
         try {
             $part = $this->resolveModel(Part::class, $id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(['error' => 'Part resource not found.'], 404);
+            return $this->jsonResponse(['error' => 'Part resource not found.'], 404);
         }
 
         $part->delete();
 
-        return new DeletedResource($part);
+        return $this->deletedPartResource($part);
     }
 
     protected function input(Request $request): array
@@ -117,4 +117,34 @@ class PartController extends Controller
 
         return $input;
     }
+
+    protected function createPart(array $input): Part
+    {
+        return Part::create($input);
+    }
+
+    protected function queryParts(Request $request, callable $callback)
+    {
+        return Part::queryWithRequest($request, $callback);
+    }
+
+    protected function partResource(Part $part)
+    {
+        return new PartResource($part);
+    }
+
+    protected function partResourceCollection($results)
+    {
+        return PartResource::collection($results);
+    }
+
+    protected function deletedPartResource(Part $part)
+    {
+        return new DeletedResource($part);
+    }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }

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

@@ -25,23 +25,19 @@ class PayloadController extends Controller
      */
     public function create(CreatePayloadRequest $request)
     {
-        $input                  = $request->all();
-        $entities               = data_get($input, 'entities', []);
-        $waypoints              = data_get($input, 'waypoints', []);
-        $pickup                 = data_get($input, 'pickup');
-        $dropoff                = data_get($input, 'dropoff');
-        $return                 = data_get($input, 'return');
-        $hasPickupField         = array_key_exists('pickup', $input);
-        $hasDropoffField        = array_key_exists('dropoff', $input);
-        $hasReturnField         = array_key_exists('return', $input);
-        $hasWaypointsField      = array_key_exists('waypoints', $input);
-        $hasRouteEndpointFields = $hasPickupField || $hasDropoffField || $hasReturnField;
+        $input      = $request->all();
+        $routeShape = $this->payloadRouteShapeFromInput($input);
+        $entities   = $routeShape['entities'];
+        $waypoints  = $routeShape['waypoints'];
+        $pickup     = $routeShape['pickup'];
+        $dropoff    = $routeShape['dropoff'];
+        $return     = $routeShape['return'];
 
         // make sure company is set
         $input['company_uuid'] = session('company');
 
         // create the payload
-        $payload = new Payload(Arr::only($input, ['type', 'provider', 'meta', 'cod_amount', 'cod_currency', 'cod_payment_method']));
+        $payload = $this->newPayload($this->payloadFillInputFromInput($input));
 
         // set pickup point
         if ($pickup) {
@@ -72,7 +68,7 @@ class PayloadController extends Controller
         }
 
         // response the driver resource
-        return new PayloadResource($payload);
+        return $this->payloadResource($payload);
     }
 
     /**
@@ -87,9 +83,9 @@ class PayloadController extends Controller
     {
         // find for the payload
         try {
-            $payload = Payload::findRecordOrFail($id, ['waypoints']);
+            $payload = $this->findPayloadOrFail($id, ['waypoints']);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Payload resource not found.',
                 ],
@@ -98,12 +94,15 @@ class PayloadController extends Controller
         }
 
         // get request input
-        $input     = $request->all();
-        $entities  = data_get($input, 'entities', []);
-        $waypoints = data_get($input, 'waypoints', []);
-        $pickup    = data_get($input, 'pickup');
-        $dropoff   = data_get($input, 'dropoff');
-        $return    = data_get($input, 'return');
+        $input                  = $request->all();
+        $routeShape             = $this->payloadRouteShapeFromInput($input);
+        $entities               = $routeShape['entities'];
+        $waypoints              = $routeShape['waypoints'];
+        $pickup                 = $routeShape['pickup'];
+        $dropoff                = $routeShape['dropoff'];
+        $return                 = $routeShape['return'];
+        $hasWaypointsField      = $routeShape['has_waypoints_field'];
+        $hasRouteEndpointFields = $routeShape['has_route_endpoint_fields'];
 
         // pickup assignment
         if ($pickup) {
@@ -133,7 +132,7 @@ class PayloadController extends Controller
         }
 
         // update the payload
-        $payload->fill(array_filter(Arr::only($input, ['type', 'provider', 'meta', 'cod_amount', 'cod_currency', 'cod_payment_method'])));
+        $payload->fill(array_filter($this->payloadFillInputFromInput($input)));
 
         // save the payload
         $payload->save();
@@ -148,7 +147,7 @@ class PayloadController extends Controller
         $payload->load(['entities', 'waypoints', 'pickup', 'dropoff', 'return']);
 
         // response the payload resource
-        return new PayloadResource($payload);
+        return $this->payloadResource($payload);
     }
 
     /**
@@ -158,9 +157,9 @@ class PayloadController extends Controller
      */
     public function query(Request $request)
     {
-        $results = Payload::queryWithRequest($request);
+        $results = $this->queryPayloads($request);
 
-        return PayloadResource::collection($results);
+        return $this->payloadResourceCollection($results);
     }
 
     /**
@@ -172,9 +171,9 @@ class PayloadController extends Controller
     {
         // find for the payload
         try {
-            $payload = Payload::findRecordOrFail($id);
+            $payload = $this->findPayloadOrFail($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Payload resource not found.',
                 ],
@@ -183,7 +182,7 @@ class PayloadController extends Controller
         }
 
         // response the payload resource
-        return new PayloadResource($payload);
+        return $this->payloadResource($payload);
     }
 
     /**
@@ -195,9 +194,9 @@ class PayloadController extends Controller
     {
         // find for the driver
         try {
-            $payload = Payload::findRecordOrFail($id);
+            $payload = $this->findPayloadOrFail($id);
         } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
-            return response()->json(
+            return $this->jsonResponse(
                 [
                     'error' => 'Payload resource not found.',
                 ],
@@ -209,6 +208,67 @@ class PayloadController extends Controller
         $payload->delete();
 
         // response the payload resource
+        return $this->deletedPayloadResource($payload);
+    }
+
+    protected function payloadRouteShapeFromInput(array $input): array
+    {
+        $hasPickupField    = array_key_exists('pickup', $input);
+        $hasDropoffField   = array_key_exists('dropoff', $input);
+        $hasReturnField    = array_key_exists('return', $input);
+        $hasWaypointsField = array_key_exists('waypoints', $input);
+
+        return [
+            'entities'                  => data_get($input, 'entities', []),
+            'waypoints'                 => data_get($input, 'waypoints', []),
+            'pickup'                    => data_get($input, 'pickup'),
+            'dropoff'                   => data_get($input, 'dropoff'),
+            'return'                    => data_get($input, 'return'),
+            'has_pickup_field'          => $hasPickupField,
+            'has_dropoff_field'         => $hasDropoffField,
+            'has_return_field'          => $hasReturnField,
+            'has_waypoints_field'       => $hasWaypointsField,
+            'has_route_endpoint_fields' => $hasPickupField || $hasDropoffField || $hasReturnField,
+        ];
+    }
+
+    protected function payloadFillInputFromInput(array $input): array
+    {
+        return Arr::only($input, ['type', 'provider', 'meta', 'cod_amount', 'cod_currency', 'cod_payment_method']);
+    }
+
+    protected function newPayload(array $input): Payload
+    {
+        return new Payload($input);
+    }
+
+    protected function findPayloadOrFail(string $id, array $with = []): Payload
+    {
+        return Payload::findRecordOrFail($id, $with);
+    }
+
+    protected function queryPayloads(Request $request): mixed
+    {
+        return Payload::queryWithRequest($request);
+    }
+
+    protected function payloadResource(Payload $payload)
+    {
+        return new PayloadResource($payload);
+    }
+
+    protected function payloadResourceCollection(mixed $results): mixed
+    {
+        return PayloadResource::collection($results);
+    }
+
+    protected function deletedPayloadResource(Payload $payload)
+    {
         return new DeletedResource($payload);
     }
+
+    protected function jsonResponse(array $payload, int $status)
+    {
+        return response()->json($payload, $status);
+    }
 }