@fleetbase/fleetops-engine 0.3.7 → 0.3.9

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

@@ -80,9 +80,14 @@ class DriverController extends Controller
             ]);
         }
 
-        // default location
-        if ($request->missing('location')) {
-            $input['location'] = new Point(0, 0);
+        // set default online
+        if (!isset($input['online'])) {
+            $input['online'] = 0;
+        }
+
+        // latitude / longitude
+        if ($request->has(['latitude', 'longitude'])) {
+            $input['location'] = Utils::getPointFromCoordinates($request->only(['latitude', 'longitude']));
         }
 
         // create the driver
@@ -150,6 +155,16 @@ class DriverController extends Controller
             ]);
         }
 
+        // set default online
+        if (!isset($input['online'])) {
+            $input['online'] = 0;
+        }
+
+        // latitude / longitude
+        if ($request->has(['latitude', 'longitude'])) {
+            $input['location'] = Utils::getPointFromCoordinates($request->only(['latitude', 'longitude']));
+        }
+
         // create the driver
         $driver->update($input);
         $driver->flushAttributesCache();
@@ -311,11 +326,11 @@ class DriverController extends Controller
         $platform = $request->or(['platform', 'os']);
 
         if (!$token) {
-            return response()->error('Token is required to register device.');
+            return response()->apiError('Token is required to register device.');
         }
 
         if (!$platform) {
-            return response()->error('Platform is required to register device.');
+            return response()->apiError('Platform is required to register device.');
         }
 
         $device = UserDevice::firstOrCreate(
@@ -350,7 +365,7 @@ class DriverController extends Controller
         $user = User::where('email', $identity)->orWhere('phone', static::phone($identity))->first();
 
         if (!Hash::check($password, $user->password)) {
-            return response()->error('Authentication failed using password provided.', 401);
+            return response()->apiError('Authentication failed using password provided.', 401);
         }
 
         // Get the company session for the user
@@ -376,7 +391,7 @@ class DriverController extends Controller
         try {
             $token = $user->createToken($driver->uuid);
         } catch (\Exception $e) {
-            return response()->error($e->getMessage());
+            return response()->apiError($e->getMessage());
         }
 
         $driver->token = $token->plainTextToken;
@@ -397,7 +412,7 @@ class DriverController extends Controller
         $user = User::where('phone', $phone)->whereNull('deleted_at')->withoutGlobalScopes()->first();
 
         if (!$user) {
-            return response()->error('No driver with this phone # found.');
+            return response()->apiError('No driver with this phone # found.');
         }
 
         // get the current company session
@@ -409,7 +424,7 @@ class DriverController extends Controller
                 return "Your {$company->name} verification code is {$verification->code}";
             });
         } catch (\Throwable $e) {
-            return response()->error($e->getMessage());
+            return response()->apiError($e->getMessage());
         }
 
         return response()->json(['status' => 'OK']);
@@ -432,20 +447,20 @@ class DriverController extends Controller
         }
 
         // check if user exists
-        $user = User::where('type', 'driver')->where(function ($query) use ($identity) {
+        $user = User::whereHas('driver')->where(function ($query) use ($identity) {
             $query->where('phone', $identity);
-            $query->orWhere('phone', $identity);
+            $query->orWhere('email', $identity);
         })->first();
 
         if (!$user) {
-            return response()->error('Unable to verify code.');
+            return response()->apiError('Unable to verify code.');
         }
 
         // find and verify code
         $verificationCode = VerificationCode::where(['subject_uuid' => $user->uuid, 'code' => $code, 'for' => $for])->exists();
 
         if (!$verificationCode && $code !== config('fleetops.navigator.bypass_verification_code')) {
-            return response()->error('Invalid verification code!');
+            return response()->apiError('Invalid verification code!');
         }
 
         // get the current company session
@@ -471,7 +486,7 @@ class DriverController extends Controller
         try {
             $token = $user->createToken($driver->uuid);
         } catch (\Exception $e) {
-            return response()->error($e->getMessage());
+            return response()->apiError($e->getMessage());
         }
 
         // $driver->update(['auth_token' => $token->plainTextToken]);

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

@@ -7,6 +7,8 @@ use Fleetbase\FleetOps\Http\Requests\UpdateEntityRequest;
 use Fleetbase\FleetOps\Http\Resources\v1\DeletedResource;
 use Fleetbase\FleetOps\Http\Resources\v1\Entity as EntityResource;
 use Fleetbase\FleetOps\Models\Entity;
+use Fleetbase\FleetOps\Models\Payload;
+use Fleetbase\FleetOps\Models\Place;
 use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Http\Controllers\Controller;
 use Illuminate\Http\Request;
@@ -76,6 +78,23 @@ class EntityController extends Controller
             ]);
         }
 
+        // if destination is set
+        if ($request->has('destination') || $request->has('waypoint')) {
+            $destinationKey = $request->or(['destination', 'waypoint']);
+
+            if ($request->has('payload')) {
+                $payload = Payload::where('public_id', $request->input('payload'))->first();
+
+                if ($payload) {
+                    // if a destination or waypoint is explicitly set
+                    $destination = $payload->findDestinationFromKey($destinationKey);
+                    if ($destination instanceof Place) {
+                        $input['destination_uuid'] = $destination->uuid;
+                    }
+                }
+            }
+        }
+
         // make sure company is set
         $input['company_uuid'] = session('company');
 
@@ -161,9 +180,25 @@ class EntityController extends Controller
             ]);
         }
 
+        // if destination is set
+        if ($request->has('destination') || $request->has('waypoint')) {
+            $destinationKey = $request->or(['destination', 'waypoint']);
+
+            if ($request->has('payload')) {
+                $payload = Payload::where('public_id', $request->input('payload'))->first();
+
+                if ($payload) {
+                    // if a destination or waypoint is explicitly set
+                    $destination = $payload->findDestinationFromKey($destinationKey);
+                    if ($destination instanceof Place) {
+                        $attributes['destination_uuid'] = $destination->uuid;
+                    }
+                }
+            }
+        }
+
         // update the entity
         $entity->update($input);
-        // $entity->flushAttributesCache();
 
         // response the entity resource
         return new EntityResource($entity);

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

@@ -36,7 +36,7 @@ class LabelController extends Controller
         }
 
         if (!$subject) {
-            return response()->error('Unable to render label.');
+            return response()->apiError('Unable to render label.');
         }
 
         switch ($format) {
@@ -58,6 +58,6 @@ class LabelController extends Controller
                 return response()->json(['data' => mb_convert_encoding($base64, 'UTF-8', 'UTF-8')]);
         }
 
-        return response()->error('Unable to render label.');
+        return response()->apiError('Unable to render label.');
     }
 }

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

@@ -6,6 +6,7 @@ use Fleetbase\FleetOps\Events\OrderDispatchFailed;
 use Fleetbase\FleetOps\Events\OrderReady;
 use Fleetbase\FleetOps\Events\OrderStarted;
 use Fleetbase\FleetOps\Http\Requests\CreateOrderRequest;
+use Fleetbase\FleetOps\Http\Requests\ScheduleOrderRequest;
 use Fleetbase\FleetOps\Http\Requests\UpdateOrderRequest;
 use Fleetbase\FleetOps\Http\Resources\v1\DeletedResource;
 use Fleetbase\FleetOps\Http\Resources\v1\Order as OrderResource;
@@ -23,6 +24,7 @@ use Fleetbase\FleetOps\Support\Utils;
 use Fleetbase\Http\Controllers\Controller;
 use Fleetbase\Models\Company;
 use Fleetbase\Models\File;
+use Fleetbase\Support\Auth;
 use Illuminate\Http\Request;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\Storage;
@@ -55,7 +57,7 @@ class OrderController extends Controller
             try {
                 $integratedVendorOrder = $serviceQuote->integratedVendor->api()->createOrderFromServiceQuote($serviceQuote, $request);
             } catch (\Exception $e) {
-                return response()->error($e->getMessage());
+                return response()->apiError($e->getMessage());
             }
         }
 
@@ -69,18 +71,18 @@ class OrderController extends Controller
             $dropoff      = data_get($payloadInput, 'dropoff');
             $return       = data_get($payloadInput, 'return');
 
-            // if no pickup and dropoff extract from waypoints
-            if (empty($pickup) && empty($dropoff) && count($waypoints)) {
-                $pickup  = array_shift($waypoints);
-                $dropoff = array_pop($waypoints);
+            if ($pickup) {
+                $payload->setPickup($pickup, [
+                    'callback' => function ($pickup, $payload) {
+                        $payload->setCurrentWaypoint($pickup);
+                    },
+                ]);
+            }
+
+            if ($dropoff) {
+                $payload->setDropoff($dropoff);
             }
 
-            $payload->setPickup($pickup, [
-                'callback' => function ($pickup, $payload) {
-                    $payload->setCurrentWaypoint($pickup);
-                },
-            ]);
-            $payload->setDropoff($dropoff);
             if ($return) {
                 $payload->setReturn($return);
             }
@@ -91,6 +93,12 @@ class OrderController extends Controller
             $payload->setWaypoints($waypoints);
             $payload->setEntities($entities);
 
+            // set the first / current waypoint
+            $firstWaypoint = $payload->getPickupOrFirstWaypoint();
+            if ($firstWaypoint instanceof Place) {
+                $payload->setCurrentWaypoint($firstWaypoint);
+            }
+
             $input['payload_uuid'] = $payload->uuid;
         } elseif ($request->isString('payload')) {
             $input['payload_uuid'] = Utils::getUuid('payloads', [
@@ -110,18 +118,18 @@ class OrderController extends Controller
             $dropoff      = data_get($payloadInput, 'dropoff');
             $return       = data_get($payloadInput, 'return');
 
-            // if no pickup and dropoff extract from waypoints
-            if (empty($pickup) && empty($dropoff) && count($waypoints)) {
-                $pickup  = array_shift($waypoints);
-                $dropoff = array_pop($waypoints);
+            if ($pickup) {
+                $payload->setPickup($pickup, [
+                    'callback' => function ($pickup, $payload) {
+                        $payload->setCurrentWaypoint($pickup);
+                    },
+                ]);
+            }
+
+            if ($dropoff) {
+                $payload->setDropoff($dropoff);
             }
 
-            $payload->setPickup($pickup, [
-                'callback' => function ($pickup, $payload) {
-                    $payload->setCurrentWaypoint($pickup);
-                },
-            ]);
-            $payload->setDropoff($dropoff);
             if ($return) {
                 $payload->setReturn($return);
             }
@@ -135,7 +143,10 @@ class OrderController extends Controller
             $input['payload_uuid'] = $payload->uuid;
 
             // set the first / current waypoint
-            $payload->setCurrentWaypoint($payload->pickup);
+            $firstWaypoint = $payload->getPickupOrFirstWaypoint();
+            if ($firstWaypoint instanceof Place) {
+                $payload->setCurrentWaypoint($firstWaypoint);
+            }
         }
 
         // driver assignment
@@ -186,13 +197,18 @@ class OrderController extends Controller
             $input['type'] = 'default';
         }
 
+        // if no status is set its default to `created`
+        if (!isset($input['status'])) {
+            $input['status'] = 'created';
+        }
+
         // if adhoc set convert to sql ready boolean value 1 or 0
         if (isset($input['adhoc']) && $integratedVendorOrder === null) {
             $input['adhoc'] = Utils::isTrue($input['adhoc']) ? 1 : 0;
         }
 
         if (!isset($input['payload_uuid'])) {
-            return response()->error('Attempted to attach invalid payload to order.');
+            return response()->apiError('Attempted to attach invalid payload to order.');
         }
 
         // create the order
@@ -217,7 +233,7 @@ class OrderController extends Controller
 
         // dispatch if flagged true
         if ($request->boolean('dispatch') && $integratedVendorOrder === null) {
-            $order->dispatch();
+            $order->dispatchWithActivity();
         }
 
         // load required relations
@@ -657,14 +673,61 @@ class OrderController extends Controller
         }
 
         if (!$order->hasDriverAssigned && !$order->adhoc) {
-            return response()->error('No driver assigned to dispatch!');
+            return response()->apiError('No driver assigned to dispatch!');
         }
 
         if ($order->dispatched) {
-            return response()->error('Order has already been dispatched!');
+            return response()->apiError('Order has already been dispatched!');
         }
 
         $order->dispatch();
+        $order->insertDispatchActivity();
+
+        return new OrderResource($order);
+    }
+
+    /**
+     * Schedules an order using date and time.
+     *
+     * @param \Fleetbase\FleetOps\Http\Requests\ScheduleOrderRequest
+     *
+     * @return \Fleetbase\Http\Resources\v1\Order
+     */
+    public function scheduleOrder(string $id, ScheduleOrderRequest $request)
+    {
+        $dateInput = $request->input('date');
+        $timeInput = $request->input('time');
+
+        // get the default tz
+        $company       = Auth::getCompany();
+        $defaultTz     = data_get($company, 'timezone', config('app.timezone'));
+        $timezoneInput = $request->input('timezone', $defaultTz);
+
+        try {
+            $order = Order::findRecordOrFail($id);
+        } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
+            return response()->json(
+                [
+                    'error' => 'Order resource not found.',
+                ],
+                404
+            );
+        }
+
+        // Parse date and time
+        $date = Carbon::parse($dateInput);
+        if ($timeInput) {
+            $time = Carbon::parse($timeInput);
+            // Combine date and time
+            $date->setTime($time->hour, $time->minute, $time->second);
+        }
+
+        // Set the timezone
+        $date->shiftTimezone($timezoneInput);
+
+        // Update order with new date and time
+        $order->scheduled_at = $date;
+        $order->save();
 
         return new OrderResource($order);
     }
@@ -692,7 +755,7 @@ class OrderController extends Controller
         }
 
         if ($order->started) {
-            return response()->error('Order has already started.');
+            return response()->apiError('Order has already started.');
         }
 
         // if the order is adhoc and the parameter of `assign` is set with a valid driver id, assign the driver and continue
@@ -707,11 +770,11 @@ class OrderController extends Controller
         $payload = Payload::where('uuid', $order->payload_uuid)->withoutGlobalScopes()->with(['waypoints', 'waypointMarkers', 'entities'])->first();
 
         if ($order->adhoc && !$driver) {
-            return response()->error('You must send driver to accept adhoc order.');
+            return response()->apiError('You must send driver to accept adhoc order.');
         }
 
         if (!$driver) {
-            return response()->error('No driver assigned to order.');
+            return response()->apiError('No driver assigned to order.');
         }
 
         // get the next order activity
@@ -723,7 +786,7 @@ class OrderController extends Controller
         // if order is not dispatched yet $activity['code'] === 'dispatched' || $order->dispatched === true
         // and not skipping throw order not dispatched error
         if ($isNotDispatched && !$skipDispatch) {
-            return response()->error('Order has not been dispatched yet and cannot be started.');
+            return response()->apiError('Order has not been dispatched yet and cannot be started.');
         }
 
         // if we're going to skip the dispatch get the next activity status and flow and continue
@@ -760,32 +823,50 @@ class OrderController extends Controller
     /**
      * Update an order activity.
      *
-     * @param \Fleetbase\Models\Order|string $order
-     *
      * @return \Fleetbase\Http\Resources\v1\Order
      */
-    public function updateActivity($order, Request $request)
+    public function updateActivity($id, Request $request)
     {
         $skipDispatch = $request->or(['skip_dispatch', 'skipDispatch'], false);
         $proof        = $request->input('proof', null);
+        $order        = null;
+
+        // if instance of order is passed directly to this method
+        if ($id instanceof Order) {
+            /** @var \Fleetbase\FleetOps\Models\Order $order */
+            $order = $id;
+        }
 
-        /** @var \Fleetbase\FleetOps\Models\Order $order */
-        $order = ($order instanceof Order) ? $order : Order::withoutGlobalScopes()
-            ->where('public_id', $order)
-            ->whereNull('deleted_at')
-            ->with(['driverAssigned', 'payload.entities', 'payload.currentWaypoint', 'payload.waypoints'])
-            ->first();
+        // if string $id
+        if (!$order) {
+            try {
+                $order = Order::findRecordOrFail($id, ['driverAssigned', 'payload.entities', 'payload.currentWaypoint', 'payload.waypoints']);
+            } catch (\Illuminate\Database\Eloquent\ModelNotFoundException $exception) {
+                return response()->json(
+                    [
+                        'error' => 'Order resource not found.',
+                    ],
+                    404
+                );
+            }
+        }
 
+        // if no order found
         if (!$order) {
-            return response()->error('No resource not found.');
+            return response()->apiError('No resource not found.');
         }
 
-        // if orser is created trigger started flag
+        // if order is still status of `created` trigger started flag
         if ($order->status === 'created') {
             $order->started    = true;
             $order->started_at = now();
         }
 
+        // if order is already completed
+        if ($order->status === 'completed') {
+            return response()->apiError('Order is already completed.');
+        }
+
         $activity = $request->input('activity', Flow::getNextActivity($order));
 
         // if we're going to skip the dispatch get the next activity status and flow and continue
@@ -799,7 +880,7 @@ class OrderController extends Controller
             if (!$order->hasDriverAssigned && !$order->adhoc) {
                 event(new OrderDispatchFailed($order, 'No driver assigned for order to dispatch to.'));
 
-                return response()->error('No driver assigned for order to dispatch to.');
+                return response()->apiError('No driver assigned for order to dispatch to.');
             }
 
             $order->dispatch();
@@ -844,8 +925,7 @@ class OrderController extends Controller
             $order->notifyCompleted();
         }
 
-        $order->setStatus($activity['code']);
-        $order->insertActivity($activity['status'], $activity['details'] ?? '', $location, $activity['code'], $proof);
+        $order->updateActivity($activity, $proof);
 
         // also update for each order entities if not multiple drop order
         // all entities will share the same activity status as is one drop order
@@ -925,7 +1005,7 @@ class OrderController extends Controller
 
         // if not completed respond with error
         if (!$isCompleted) {
-            return response()->error('Not all waypoints completed for order.');
+            return response()->apiError('Not all waypoints completed for order.');
         }
 
         $activity = [
@@ -994,11 +1074,10 @@ class OrderController extends Controller
         $place = $order->payload->waypoints->firstWhere('public_id', $placeId);
 
         if (!$place) {
-            return response()->error('Place resource is not a valid destination.');
+            return response()->apiError('Place resource is not a valid destination.');
         }
 
-        $order->payload->update(['current_waypoint_uuid' => $place->uuid]);
-        $order->payload->refresh();
+        $order->payload->setCurrentWaypoint($place);
 
         return new OrderResource($order);
     }
@@ -1050,7 +1129,7 @@ class OrderController extends Controller
         }
 
         if (!$code) {
-            return response()->error('No QR code data to capture.');
+            return response()->apiError('No QR code data to capture.');
         }
 
         $subject = $type === null ? $order : null;
@@ -1075,7 +1154,7 @@ class OrderController extends Controller
         }
 
         if (!$subject) {
-            return response()->error('Unable to capture QR code data.');
+            return response()->apiError('Unable to capture QR code data.');
         }
 
         // validate
@@ -1094,7 +1173,7 @@ class OrderController extends Controller
             return new ProofResource($proof);
         }
 
-        return response()->error('Unable to validate QR code data.');
+        return response()->apiError('Unable to validate QR code data.');
     }
 
     /**
@@ -1104,11 +1183,12 @@ class OrderController extends Controller
      */
     public function captureSignature(string $id, string $subjectId = null, Request $request)
     {
-        $disk      = $request->input('disk', config('filesystems.default'));
-        $bucket    = $request->input('bucket', config('filesystems.disks.' . $disk . '.bucket', config('filesystems.disks.s3.bucket')));
-        $signature = $request->input('signature');
-        $data      = $request->input('data', []);
-        $type      = $subjectId ? strtok($subjectId, '_') : null;
+        $disk         = $request->input('disk', config('filesystems.default'));
+        $bucket       = $request->input('bucket', config('filesystems.disks.' . $disk . '.bucket', config('filesystems.disks.s3.bucket')));
+        $signature    = $request->input('signature');
+        $data         = $request->input('data', []);
+        $remarks      = $request->input('remarks', 'Verified by Signature');
+        $type         = $subjectId ? strtok($subjectId, '_') : null;
 
         try {
             $order = Order::findRecordOrFail($id);
@@ -1122,7 +1202,7 @@ class OrderController extends Controller
         }
 
         if (!$signature) {
-            return response()->error('No signature data to capture.');
+            return response()->apiError('No signature data to capture.');
         }
 
         $subject = $type === null ? $order : null;
@@ -1147,7 +1227,7 @@ class OrderController extends Controller
         }
 
         if (!$subject) {
-            return response()->error('Unable to capture signature data.');
+            return response()->apiError('Unable to capture signature data.');
         }
 
         // create proof instance
@@ -1156,7 +1236,7 @@ class OrderController extends Controller
             'order_uuid'   => $order->uuid,
             'subject_uuid' => $subject->uuid,
             'subject_type' => Utils::getModelClassName($subject),
-            'remarks'      => 'Verified by Signature',
+            'remarks'      => $remarks,
             'raw_data'     => $signature,
             'data'         => $data,
         ]);

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

@@ -7,6 +7,7 @@ use Fleetbase\FleetOps\Http\Requests\UpdatePayloadRequest;
 use Fleetbase\FleetOps\Http\Resources\v1\DeletedResource;
 use Fleetbase\FleetOps\Http\Resources\v1\Payload as PayloadResource;
 use Fleetbase\FleetOps\Models\Payload;
+use Fleetbase\FleetOps\Models\Place;
 use Fleetbase\Http\Controllers\Controller;
 use Illuminate\Http\Request;
 use Illuminate\Support\Arr;
@@ -37,30 +38,34 @@ class PayloadController extends Controller
         // create the payload
         $payload = new Payload(Arr::only($input, ['type', 'provider', 'meta', 'cod_amount', 'cod_currency', 'cod_payment_method']));
 
-        // if no pickup and dropoff extract from waypoints
-        if (empty($pickup) && empty($dropoff) && count($waypoints)) {
-            $pickup  = array_shift($waypoints);
-            $dropoff = array_pop($waypoints);
-        }
-
         // set pickup point
-        $payload->setPickup($pickup);
+        if ($pickup) {
+            $payload->setPickup($pickup);
+        }
 
         // set dropoff point
-        $payload->setDropoff($dropoff);
+        if ($dropoff) {
+            $payload->setDropoff($dropoff);
+        }
 
         // set return point
-        $payload->setReturn($return);
+        if ($return) {
+            $payload->setReturn($return);
+        }
 
         // save payload
         $payload->save();
 
-        // set waypoints
+        // set waypoints and entities after payload is saved
         $payload->setWaypoints($waypoints);
-
-        // set entities
         $payload->setEntities($entities);
 
+        // set the first / current waypoint
+        $firstWaypoint = $payload->getPickupOrFirstWaypoint();
+        if ($firstWaypoint instanceof Place) {
+            $payload->setCurrentWaypoint($firstWaypoint);
+        }
+
         // response the driver resource
         return new PayloadResource($payload);
     }
@@ -126,6 +131,9 @@ class PayloadController extends Controller
         // save the payload
         $payload->save();
 
+        // make sure entities and waypoints is loaded
+        $payload->load(['entities', 'waypoints', 'pickup', 'dropoff', 'return']);
+
         // response the payload resource
         return new PayloadResource($payload);
     }