@fleetbase/fleetops-engine 0.2.6 → 0.2.7

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

@@ -0,0 +1,564 @@
+<?php
+
+namespace Fleetbase\FleetOps\Http\Controllers\Internal\v1;
+
+use Fleetbase\Exceptions\FleetbaseRequestValidationException;
+use Fleetbase\FleetOps\Events\OrderDispatchFailed;
+use Fleetbase\FleetOps\Events\OrderReady;
+use Fleetbase\FleetOps\Events\OrderStarted;
+use Fleetbase\FleetOps\Http\Controllers\FleetOpsController;
+use Fleetbase\FleetOps\Http\Requests\CancelOrderRequest;
+use Fleetbase\FleetOps\Imports\OrdersImport;
+use Fleetbase\FleetOps\Models\Driver;
+use Fleetbase\FleetOps\Models\Entity;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\Payload;
+use Fleetbase\FleetOps\Models\Place;
+use Fleetbase\FleetOps\Models\ServiceQuote;
+use Fleetbase\FleetOps\Models\TrackingStatus;
+use Fleetbase\FleetOps\Models\Waypoint;
+use Fleetbase\FleetOps\Support\Flow;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Http\Requests\Internal\BulkDeleteRequest;
+use Fleetbase\Models\File;
+use Fleetbase\Models\Type;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Str;
+use Maatwebsite\Excel\Facades\Excel;
+
+class OrderController extends FleetOpsController
+{
+    /**
+     * The resource to query.
+     *
+     * @var string
+     */
+    public $resource = 'order';
+
+    /**
+     * Creates a record with request payload.
+     *
+     * @param Illuminate\Http\Request $request
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function createRecord(Request $request)
+    {
+        try {
+            $this->validateRequest($request);
+
+            $record = $this->model->createRecordFromRequest(
+                $request,
+                function ($request, &$input) {
+                    $serviceQuote = ServiceQuote::resolveFromRequest($request);
+
+                    // if service quote is applied, resolve it
+                    if ($serviceQuote instanceof ServiceQuote && $serviceQuote->fromIntegratedVendor()) {
+                        // create order with integrated vendor, then resume fleetbase order creation
+                        try {
+                            $integratedVendorOrder = $serviceQuote->integratedVendor->api()->createOrderFromServiceQuote($serviceQuote, $request);
+                        } catch (\Exception $e) {
+                            return response()->error($e->getMessage());
+                        }
+
+                        $input['integrated_vendor_order'] = $integratedVendorOrder;
+                    }
+                },
+                function (&$request, Order &$order, &$requestInput) {
+                    $input                   = $request->input('order');
+                    $isIntegratedVendorOrder = isset($requestInput['integrated_vendor_order']);
+                    $serviceQuote            = ServiceQuote::resolveFromRequest($request);
+
+                    $route     = Utils::get($input, 'route');
+                    $payload   = Utils::get($input, 'payload');
+                    $waypoints = Utils::get($input, 'payload.waypoints');
+                    $entities  = Utils::get($input, 'payload.entities');
+
+                    // save order route & payload with request input
+                    $order
+                        ->setRoute($route)
+                        ->setStatus('created', false)
+                        ->insertPayload($payload)
+                        ->insertWaypoints($waypoints)
+                        ->insertEntities($entities);
+
+                    // if it's integrated vendor order apply to meta
+                    if ($isIntegratedVendorOrder) {
+                        $order->updateMeta(
+                            [
+                                'integrated_vendor'       => Utils::get($requestInput['integrated_vendor_order'], 'metadata.integrated_vendor'),
+                                'integrated_vendor_order' => $requestInput['integrated_vendor_order'],
+                            ]
+                        );
+                    }
+
+                    // notify driver if assigned
+                    $order->notifyDriverAssigned();
+
+                    // set driving distance and time
+                    $order->setPreliminaryDistanceAndTime();
+
+                    // if service quote attached purchase
+                    $order->purchaseServiceQuote($serviceQuote);
+
+                    // dispatch if flagged true
+                    $order->firstDispatch();
+
+                    // load tracking number
+                    $order->load(['trackingNumber']);
+                }
+            );
+
+            // Trigger order created event
+            event(new OrderReady($record));
+
+            return ['order' => new $this->resource($record)];
+        } catch (\Exception $e) {
+            return response()->error($e->getMessage());
+        } catch (\Illuminate\Database\QueryException $e) {
+            return response()->error($e->getMessage());
+        } catch (FleetbaseRequestValidationException $e) {
+            return response()->error($e->getErrors());
+        }
+    }
+
+    /**
+     * Process import files (excel,csv) into Fleetbase order data.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function importFromFiles(Request $request)
+    {
+        $info    = Utils::lookupIp();
+        $files   = $request->input('files');
+        $files   = File::whereIn('uuid', $files)->get();
+        $country = $request->input('country', Utils::or($info, ['country_name', 'region'], 'Singapore'));
+
+        $validFileTypes = ['csv', 'tsv', 'xls', 'xlsx'];
+        $imports        = collect();
+
+        foreach ($files as $file) {
+            // validate file type
+            if (!Str::endsWith($file->path, $validFileTypes)) {
+                return response()->error('Invalid file uploaded, must be one of the following: ' . implode(', ', $validFileTypes));
+            }
+
+            try {
+                $data = Excel::toArray(new OrdersImport(), $file->path, 's3');
+            } catch (\Exception $e) {
+                return response()->error('Invalid file, unable to proccess.');
+            }
+
+            $imports = $imports->concat($data);
+        }
+
+        $places   = collect();
+        $entities = collect();
+
+        foreach ($imports as $rows) {
+            foreach ($rows as $row) {
+                if (empty($row) || empty(array_values($row))) {
+                    continue;
+                }
+
+                $importId = (string) Str::uuid();
+                $place    = Place::createFromImportRow($row, $importId, $country);
+
+                if (!$place) {
+                    continue;
+                }
+
+                $places[] = $place;
+
+                $items          = Utils::or($row, ['items', 'entities', 'packages', 'passengers', 'products', 'services']);
+                $itemsDelimiter = Utils::findDelimiterFromString($items, '|');
+                $items          = is_string($items) ? explode($itemsDelimiter, $items) : [];
+
+                foreach ($items as $itemName) {
+                    $entity = new Entity(['name' => $itemName]);
+                    $entity->setAttribute('destination_uuid', $place->uuid);
+                    $entity->setAttribute('_import_id', $importId);
+                    $entity->setMetas($place->getMeta());
+                    $entities[] = $entity;
+                }
+            }
+        }
+
+        return response()->json(
+            [
+                'entities' => $entities,
+                'places'   => $places,
+            ]
+        );
+    }
+
+    /**
+     * Updates a order to canceled and updates order activity.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function bulkDelete(BulkDeleteRequest $request)
+    {
+        $ids = $request->input('ids', []);
+
+        if (!$ids) {
+            return response()->error('Nothing to delete.');
+        }
+
+        /** @var \Fleetbase\Models\Order */
+        $count   = Order::whereIn('uuid', $ids)->count();
+        $deleted = Order::whereIn('uuid', $ids)->delete();
+
+        if (!$deleted) {
+            return response()->error('Failed to bulk delete orders.');
+        }
+
+        return response()->json(
+            [
+                'status'  => 'OK',
+                'message' => 'Deleted ' . $count . ' orders',
+            ],
+            200
+        );
+    }
+
+    /**
+     * Updates a order to canceled and updates order activity.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function bulkCancel(BulkDeleteRequest $request)
+    {
+        /** @var \Fleetbase\Models\Order */
+        $orders = Order::whereIn('uuid', $request->input('ids'))->get();
+
+        $count = $orders->count();
+
+        foreach ($orders as $order) {
+            if ($order->status === 'canceled') {
+                continue;
+            }
+
+            $trackingStatusExists = TrackingStatus::where(['tracking_number_uuid' => $order->tracking_number_uuid, 'code' => 'CANCELED'])->exists();
+
+            if ($trackingStatusExists) {
+                continue;
+            }
+
+            $order->cancel();
+        }
+
+        return response()->json(
+            [
+                'status'  => 'OK',
+                'message' => 'Canceled ' . $count . ' orders',
+            ]
+        );
+    }
+
+    /**
+     * Updates a order to canceled and updates order activity.
+     *
+     * @param \Fleetbase\Http\Requests\CancelOrderRequest $request
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function cancel(CancelOrderRequest $request)
+    {
+        /** @var \Fleetbase\Models\Order */
+        $order = Order::where('uuid', $request->input('order'))->first();
+
+        $order->cancel();
+
+        return response()->json(
+            [
+                'status'  => 'OK',
+                'message' => 'Order was canceled',
+                'order'   => $order->uuid,
+            ]
+        );
+    }
+
+    /**
+     * Dispatches an order.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function dispatchOrder(Request $request)
+    {
+        /**
+         * @var \Fleetbase\Models\Order
+         */
+        $order = Order::select(['uuid', 'driver_assigned_uuid', 'adhoc', 'dispatched', 'dispatched_at'])->where('uuid', $request->input('order'))->withoutGlobalScopes()->first();
+
+        if (!$order->hasDriverAssigned && !$order->adhoc) {
+            return response()->error('No driver assigned to dispatch!');
+        }
+
+        if ($order->dispatched) {
+            return response()->error('Order has already been dispatched!');
+        }
+
+        $order->dispatch();
+
+        return response()->json(
+            [
+                'status'  => 'OK',
+                'message' => 'Order was dispatched',
+                'order'   => $order->uuid,
+            ]
+        );
+    }
+
+    /**
+     * Internal request for driver to start order.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function start(Request $request)
+    {
+        /**
+         * @var \Fleetbase\Models\Order
+         */
+        $order = Order::where('uuid', $request->input('order'))->withoutGlobalScopes()->first();
+
+        if (!$order) {
+            return response()->error('Unable to find order to start.');
+        }
+
+        if ($order->started) {
+            return response()->error('Order has already been started.');
+        }
+
+        /**
+         * @var \Fleetbase\FleetOps\Models\Driver
+         */
+        $driver = Driver::where('uuid', $order->driver_assigned_uuid)->withoutGlobalScopes()->first();
+
+        /**
+         * @var \Fleetbase\FleetOps\Models\Payload
+         */
+        $payload = Payload::where('uuid', $order->payload_uuid)->withoutGlobalScopes()->with(['waypoints', 'waypointMarkers', 'entities'])->first();
+
+        if (!$driver) {
+            return response()->error('No driver assigned to order.');
+        }
+
+        // set order to started
+        $order->started    = true;
+        $order->started_at = now();
+        $order->save();
+
+        // trigger start event
+        event(new OrderStarted($order));
+
+        // set order as drivers current order
+        $driver->current_job_uuid = $order->uuid;
+        $driver->save();
+
+        // get the next order activity
+        $flow = $activity = Flow::getNextActivity($order);
+
+        /**
+         * @var \Grimzy\LaravelMysqlSpatial\Types\Point
+         */
+        $location = $order->getLastLocation();
+
+        // if multi drop order set first destination
+        if ($payload->isMultipleDropOrder) {
+            $firstDestination = $payload->waypoints->first();
+
+            if ($firstDestination) {
+                $payload->current_waypoint_uuid = $firstDestination->uuid;
+                $payload->save();
+            }
+
+            // update activity for each waypoint and entity
+            foreach ($payload->waypointMarkers as $waypointMarker) {
+                $waypointMarker->insertActivity($activity['status'], $activity['details'], $location, $activity['code']);
+            }
+
+            foreach ($payload->entities as $entity) {
+                $entity->insertActivity($activity['status'], $activity['details'], $location, $activity['code']);
+            }
+        }
+
+        // update order activity
+        $updateActivityRequest = new Request(['activity' => $flow]);
+
+        // update activity
+        return $this->updateActivity($order->uuid, $updateActivityRequest);
+    }
+
+    /**
+     * Update an order activity.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function updateActivity(string $id, Request $request)
+    {
+        $order = Order::withoutGlobalScopes()
+            ->where('uuid', $id)
+            ->with(['driverAssigned'])
+            ->whereNull('deleted_at')
+            ->orWhere('public_id', $id)
+            ->with(['payload.entities'])
+            ->first();
+
+        if (!$order) {
+            return response()->error('No order found.');
+        }
+
+        $activity = $request->input('activity');
+
+        // handle pickup/dropoff order activity update as normal
+        if (is_array($activity) && $activity['code'] === 'dispatched') {
+            // make sure driver is assigned if not trigger failed dispatch
+            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.');
+            }
+
+            $order->dispatch();
+
+            return response()->json(['status' => 'dispatched']);
+        }
+
+        if (is_array($activity) && $activity['code'] === 'completed' && $order->driverAssigned) {
+            // unset from driver current job
+            $order->driverAssigned->unassignCurrentOrder();
+            $order->notifyCompleted();
+        }
+
+        /**
+         * @var \Grimzy\LaravelMysqlSpatial\Types\Point
+         */
+        $location = $order->getLastLocation();
+
+        $order->setStatus($activity['code']);
+        $order->insertActivity($activity['status'], $activity['details'], $location, $activity['code']);
+
+        // also update for each order entities if not multiple drop order
+        // all entities will share the same activity status as is one drop order
+        if (!$order->payload->isMultipleDropOrder) {
+            foreach ($order->payload->entities as $entity) {
+                $entity->insertActivity($activity['status'], $activity['details'], $location, $activity['code']);
+            }
+        }
+
+        return response()->json(['status' => 'ok']);
+    }
+
+    /**
+     * Finds and responds with the orders next activity update based on the orders configuration.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function nextActivity(string $id, Request $request)
+    {
+        $order = Order::withoutGlobalScopes()
+            ->where('uuid', $id)
+            ->orWhere('public_id', $id)
+            ->first();
+
+        if (!$order) {
+            return response()->error('No order found.');
+        }
+
+        $flow = Flow::getOrderFlow($order);
+
+        return response()->json($flow);
+    }
+
+    /**
+     * Get all status options for an order.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function statuses()
+    {
+        $statuses = DB::table('orders')
+            ->select('status')
+            ->where('company_uuid', session('company'))
+            ->distinct()
+            ->get()
+            ->pluck('status')
+            ->filter();
+
+        return response()->json($statuses);
+    }
+
+    /**
+     * Get all order type options.
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function types()
+    {
+        $defaultTypes = collect(config('api.types.order', []))->map(
+            function ($attributes) {
+                return new Type($attributes);
+            }
+        );
+        $customTypes = Type::where('for', 'order')->get();
+
+        $results = collect([...$customTypes, ...$defaultTypes])
+            ->unique('key')
+            ->values();
+
+        return response()->json($results);
+    }
+
+    /**
+     * Sends back the PDF stream for an order label file.
+     *
+     * @return void
+     */
+    public function label(string $publicId, Request $request)
+    {
+        $format  = $request->input('format', 'stream');
+        $type    = $request->input('type', strtok($publicId, '_'));
+        $subject = null;
+
+        switch ($type) {
+            case 'order':
+                $subject = Order::where('public_id', $publicId)->orWhere('uuid', $publicId)->withoutGlobalScopes()->first();
+                break;
+
+            case 'waypoint':
+                $subject = Waypoint::where('public_id', $publicId)->orWhere('uuid', $publicId)->withoutGlobalScopes()->first();
+                break;
+
+            case 'entity':
+                $subject = Entity::where('public_id', $publicId)->orWhere('uuid', $publicId)->withoutGlobalScopes()->first();
+                break;
+        }
+
+        if (!$subject) {
+            return response()->error('Unable to render label.');
+        }
+
+        switch ($format) {
+            case 'pdf':
+            case 'stream':
+            default:
+                $stream = $subject->pdfLabelStream();
+
+                return $stream;
+
+            case 'text':
+                $text = $subject->pdfLabel()->output();
+
+                return response()->make($text);
+
+            case 'base64':
+                $base64 = base64_encode($subject->pdfLabel()->output());
+
+                return response()->json(['data' => mb_convert_encoding($base64, 'UTF-8', 'UTF-8')]);
+        }
+
+        return response()->error('Unable to render label.');
+    }
+}

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

@@ -0,0 +1,15 @@
+<?php
+
+namespace Fleetbase\FleetOps\Http\Controllers\Internal\v1;
+
+use Fleetbase\FleetOps\Http\Controllers\FleetOpsController;
+
+class PayloadController extends FleetOpsController
+{
+    /**
+     * The resource to query.
+     *
+     * @var string
+     */
+    public $resource = 'payload';
+}