@fleetbase/fleetops-engine 0.2.6 → 0.2.8

package/server/src/Traits/HasTrackingNumber.php

@@ -0,0 +1,185 @@
+<?php
+
+namespace Fleetbase\FleetOps\Traits;
+
+use Fleetbase\FleetOps\Models\Proof;
+use Fleetbase\FleetOps\Models\TrackingNumber;
+use Fleetbase\FleetOps\Models\TrackingStatus;
+use Fleetbase\FleetOps\Support\Utils;
+use Grimzy\LaravelMysqlSpatial\Types\Point;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Support\Facades\DB;
+
+trait HasTrackingNumber
+{
+    public static function bootHasTrackingNumber(): void
+    {
+        static::created(function (Model $model): void {
+            $trackingNumberId = TrackingNumber::insertGetUuid([
+                'company_uuid' => data_get($model, 'company_uuid', session('company')),
+                'owner_uuid'   => $model->uuid,
+                'owner_type'   => Utils::getModelClassName($model),
+                'region'       => $model->getPickupRegion(),
+                'location'     => $model->getPickupLocation(),
+            ], $model);
+
+            DB::table($model->getTable())->where('uuid', $model->uuid)->update(['tracking_number_uuid' => $trackingNumberId]);
+
+            if ($model->isFillable('tracking_number_uuid')) {
+                $model->tracking_number_uuid = $trackingNumberId;
+            }
+        });
+    }
+
+    public function setTrackingNumber(TrackingNumber $trackingNumber)
+    {
+        if (!$this->isFillable('tracking_number_uuid') || Utils::notEmpty($this->tracking_number_uuid)) {
+            return $this;
+        }
+
+        $this->tracking_number_uuid = $trackingNumber->uuid;
+        $this->setRelation('trackingNumber', $trackingNumber);
+        $this->save();
+
+        return $this;
+    }
+
+    /**
+     * Creates activity for this resource tracking number.
+     *
+     * @param string                              $status   the short status update
+     * @param string                              $details  the detailed update
+     * @param array|Point                         $location the location of the update, can be either [lat, lng] or a \Grimzy\LaravelMysqlSpatial\Types\Point instance
+     * @param string                              $code     the onew word status code
+     * @param \Fleetbase\Models\Proof|string|null $proof    resolvable proof of delivery/activity
+     *
+     * @return \Fleetbase\Models\TrackingStatus
+     */
+    public function createActivity(string $status, string $details = '', $location = [], string $code = '', $proof = null): TrackingStatus
+    {
+        $proof    = static::resolveProof($proof);
+        $activity = TrackingStatus::create([
+            'company_uuid'         => data_get($this, 'company_uuid', session('company')),
+            'tracking_number_uuid' => $this->tracking_number_uuid,
+            'proof_uuid'           => data_get($proof, 'uuid'),
+            'status'               => $status,
+            'details'              => $details,
+            'location'             => $this->getLocationAsPoint($location),
+            'code'                 => TrackingStatus::prepareCode($code),
+        ]);
+
+        if (isset($this->trackingNumber)) {
+            $this->trackingNumber->flushAttributesCache();
+        }
+
+        if (method_exists($this, 'flushAttributesCache')) {
+            $this->flushAttributesCache();
+        }
+
+        return $activity;
+    }
+
+    /**
+     * Inserts activity for this resource tracking number.
+     *
+     * @param string                              $status   the short status update
+     * @param string                              $details  the detailed update
+     * @param array|Point                         $location the location of the update, can be either [lat, lng] or a \Grimzy\LaravelMysqlSpatial\Types\Point instance
+     * @param \Fleetbase\Models\Proof|string|null $proof    resolvable proof of delivery/activity
+     * @param string                              $code     the onew word status code
+     */
+    public function insertActivity(string $status, string $details = '', $location = [], string $code = '', $proof = null): string
+    {
+        $proof      = static::resolveProof($proof);
+        $activityId = TrackingStatus::insertGetUuid([
+            'company_uuid'         => data_get($this, 'company_uuid', session('company')),
+            'tracking_number_uuid' => $this->tracking_number_uuid,
+            'proof_uuid'           => data_get($proof, 'uuid'),
+            'status'               => $status,
+            'details'              => $details,
+            'location'             => $this->getLocationAsPoint($location),
+            'code'                 => TrackingStatus::prepareCode($code),
+        ]);
+
+        if (isset($this->trackingNumber)) {
+            $this->trackingNumber->flushAttributesCache();
+        }
+
+        if (method_exists($this, 'flushAttributesCache')) {
+            $this->flushAttributesCache();
+        }
+
+        return $activityId;
+    }
+
+    public function getLocationAsPoint($location)
+    {
+        $point = null;
+
+        if ($location instanceof Point) {
+            $point = $location;
+        }
+
+        if (is_array($location)) {
+            $point =  new Point(...$location);
+        }
+
+        if ($location === null || empty($location) || !$location) {
+            $point = new Point(0, 0);
+        }
+
+        return Utils::parsePointToWkt($point);
+    }
+
+    public function getPickupRegion()
+    {
+        $this->load(['payload']);
+
+        if ($this->payload) {
+            return $this->payload->getPickupRegion();
+        }
+
+        return 'SG';
+    }
+
+    public function getPickupLocation()
+    {
+        $this->load(['payload']);
+
+        if ($this->payload) {
+            return $this->payload->getPickupLocation();
+        }
+
+        return new Point(0, 0);
+    }
+
+    public function setStatus(?string $status, $andSave = true)
+    {
+        $this->status = $status;
+
+        if ($andSave) {
+            // static::where('uuid', $this->uuid)->update(['status' => $status]);
+            $this->save();
+        }
+
+        return $this;
+    }
+
+    /**
+     * Resolves proof to model instance.
+     *
+     * @return \Fleetbase\Models\Proof|null
+     */
+    public static function resolveProof($proof)
+    {
+        if (is_string($proof)) {
+            return Proof::where('public_id', $proof)->orWhere('uuid', $proof)->first();
+        }
+
+        if ($proof instanceof Proof) {
+            return $proof;
+        }
+
+        return null;
+    }
+}

package/server/src/routes.php

@@ -0,0 +1,381 @@
+<?php
+
+use Illuminate\Support\Facades\Route;
+
+/*
+|--------------------------------------------------------------------------
+| API Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register API routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| is assigned the "api" middleware group. Enjoy building your API!
+|
+*/
+
+Route::prefix(config('fleetops.api.routing.prefix', null))->namespace('Fleetbase\FleetOps\Http\Controllers')->group(
+    function ($router) {
+        /*
+        |--------------------------------------------------------------------------
+        | Consumable FleetOps API Routes
+        |--------------------------------------------------------------------------
+        |
+        | End-user API routes, these are routes that the SDK and applications will interface with, and require API credentials.
+        */
+        Route::prefix('v1')
+            ->middleware('fleetbase.api')
+            ->namespace('Api\v1')
+            ->group(function ($router) {
+                // drivers routes
+                $router->group(['prefix' => 'drivers'], function () use ($router) {
+                    $router->post('register-device', 'DriverController@registerDevice');
+                    $router->post('login-with-sms', 'DriverController@loginWithPhone');
+                    $router->post('verify-code', 'DriverController@verifyCode');
+                    $router->post('login', 'DriverController@login');
+                    $router->post('{id}/simulate', 'DriverController@simulate');
+                    $router->post('{id}/track', 'DriverController@track');
+                    $router->post('{id}/register-device', 'DriverController@registerDevice');
+                    $router->post('{id}/switch-organization', 'DriverController@switchOrganization');
+                    $router->post('/', 'DriverController@create');
+                    $router->get('/', 'DriverController@query');
+                    $router->get('{id}', 'DriverController@find');
+                    $router->get('{id}/organizations', 'DriverController@listOrganizations');
+                    $router->put('{id}', 'DriverController@update');
+                    $router->delete('{id}', 'DriverController@delete');
+                });
+                // contacts routes
+                $router->group(['prefix' => 'contacts'], function () use ($router) {
+                    $router->post('/', 'ContactController@create');
+                    $router->get('/', 'ContactController@query');
+                    $router->get('{id}', 'ContactController@find');
+                    $router->put('{id}', 'ContactController@update');
+                    $router->delete('{id}', 'ContactController@delete');
+                });
+                // vendors routes
+                $router->group(['prefix' => 'vendors'], function () use ($router) {
+                    $router->post('/', 'VendorController@create');
+                    $router->get('/', 'VendorController@query');
+                    $router->get('{id}', 'VendorController@find');
+                    $router->put('{id}', 'VendorController@update');
+                    $router->delete('{id}', 'VendorController@delete');
+                });
+                // orders routes
+                $router->group(['prefix' => 'orders'], function () use ($router) {
+                    $router->post('/', 'OrderController@create');
+                    $router->get('/', 'OrderController@query');
+                    $router->get('{id}', 'OrderController@find');
+                    $router->get('{id}/distance-and-time', 'OrderController@getDistanceMatrix');
+                    $router->post('{id}/dispatch', 'OrderController@dispatchOrder');
+                    $router->post('{id}/start', 'OrderController@startOrder');
+                    $router->delete('{id}/cancel', 'OrderController@cancelOrder');
+                    $router->post('{id}/update-activity', 'OrderController@updateActivity');
+                    $router->post('{id}/complete', 'OrderController@completeOrder');
+                    $router->get('{id}/next-activity', 'OrderController@getNextActivity');
+                    $router->post('{id}/set-destination/{placeId}', 'OrderController@setDestination');
+                    $router->post('{id}/capture-signature/{subjectId?}', 'OrderController@captureSignature');
+                    $router->post('{id}/capture-qr/{subjectId?}', 'OrderController@captureQrScan');
+                    $router->put('{id}', 'OrderController@update');
+                    $router->delete('{id}', 'OrderController@delete');
+                });
+                // entities routes
+                $router->group(['prefix' => 'entities'], function () use ($router) {
+                    $router->post('/', 'EntityController@create');
+                    $router->get('/', 'EntityController@query');
+                    $router->get('{id}', 'EntityController@find');
+                    $router->put('{id}', 'EntityController@update');
+                    $router->delete('{id}', 'EntityController@delete');
+                });
+                // payloads routes
+                $router->group(['prefix' => 'payloads'], function () use ($router) {
+                    $router->post('/', 'PayloadController@create');
+                    $router->get('/', 'PayloadController@query');
+                    $router->get('{id}', 'PayloadController@find');
+                    $router->put('{id}', 'PayloadController@update');
+                    $router->delete('{id}', 'PayloadController@delete');
+                });
+                // purchase-rates routes
+                $router->group(['prefix' => 'purchase-rates'], function () use ($router) {
+                    $router->post('/', 'PurchaseRateController@create');
+                    $router->get('/', 'PurchaseRateController@query');
+                    $router->get('{id}', 'PurchaseRateController@find');
+                });
+                // places routes
+                $router->group(['prefix' => 'places'], function () use ($router) {
+                    $router->post('/', 'PlaceController@create');
+                    $router->get('/', 'PlaceController@query');
+                    $router->get('search', 'PlaceController@search');
+                    $router->get('{id}', 'PlaceController@find');
+                    $router->put('{id}', 'PlaceController@update');
+                    $router->delete('{id}', 'PlaceController@delete');
+                });
+                // zones routes
+                $router->group(['prefix' => 'zones'], function () use ($router) {
+                    $router->post('/', 'ZoneController@create');
+                    $router->get('/', 'ZoneController@query');
+                    $router->get('{id}', 'ZoneController@find');
+                    $router->put('{id}', 'ZoneController@update');
+                    $router->delete('{id}', 'ZoneController@delete');
+                });
+                // service-areas routes
+                $router->group(['prefix' => 'service-areas'], function () use ($router) {
+                    $router->post('/', 'ServiceAreaController@create');
+                    $router->get('/', 'ServiceAreaController@query');
+                    $router->get('{id}', 'ServiceAreaController@find');
+                    $router->put('{id}', 'ServiceAreaController@update');
+                    $router->delete('{id}', 'ServiceAreaController@delete');
+                });
+                // service-rates routes
+                $router->group(['prefix' => 'service-rates'], function () use ($router) {
+                    $router->post('/', 'ServiceRateController@create');
+                    $router->get('/', 'ServiceRateController@query');
+                    $router->get('{id}', 'ServiceRateController@find');
+                    $router->put('{id}', 'ServiceRateController@update');
+                    $router->delete('{id}', 'ServiceRateController@delete');
+                });
+                // service-quotes routes
+                $router->group(['prefix' => 'service-quotes'], function () use ($router) {
+                    $router->get('/', 'ServiceQuoteController@query');
+                    $router->get('{id}', 'ServiceQuoteController@find');
+                });
+                // tracking-numbers routes
+                $router->group(['prefix' => 'tracking-numbers'], function () use ($router) {
+                    $router->post('/', 'TrackingNumberController@create');
+                    $router->post('from-qr', 'TrackingNumberController@fromQR');
+                    $router->get('/', 'TrackingNumberController@query');
+                    $router->get('{id}', 'TrackingNumberController@find');
+                    $router->delete('{id}', 'TrackingNumberController@delete');
+                });
+                // tracking-statuses routes
+                $router->group(['prefix' => 'tracking-statuses'], function () use ($router) {
+                    $router->post('/', 'TrackingStatusController@create');
+                    $router->get('/', 'TrackingStatusController@query');
+                    $router->get('{id}', 'TrackingStatusController@find');
+                    $router->put('{id}', 'TrackingStatusController@update');
+                    $router->delete('{id}', 'TrackingStatusController@delete');
+                });
+                // vehicle routes
+                $router->group(['prefix' => 'vehicles'], function () use ($router) {
+                    $router->post('/', 'VehicleController@create');
+                    $router->get('/', 'VehicleController@query');
+                    $router->get('{id}', 'VehicleController@find');
+                    $router->put('{id}', 'VehicleController@update');
+                    $router->delete('{id}', 'VehicleController@delete');
+                });
+                // fleets routes
+                $router->group(['prefix' => 'fleets'], function () use ($router) {
+                    $router->post('/', 'FleetController@create');
+                    $router->get('/', 'FleetController@query');
+                    $router->get('{id}', 'FleetController@find');
+                    $router->put('{id}', 'FleetController@update');
+                    $router->delete('{id}', 'FleetController@delete');
+                });
+                // labels routes
+                $router->group(['prefix' => 'labels'], function () use ($router) {
+                    $router->get('{id}', 'LabelController@getLabel');
+                });
+            });
+
+        /*
+        |--------------------------------------------------------------------------
+        | Internal FleetOps API Routes
+        |--------------------------------------------------------------------------
+        |
+        | Primary internal routes for console.
+        */
+        $router->prefix(config('fleetops.api.routing.internal_prefix', 'int'))->namespace('Internal')->group(
+            function ($router) {
+                $router->group(
+                    ['prefix' => 'v1', 'namespace' => 'v1', 'middleware' => ['fleetbase.protected']],
+                    function ($router) {
+                        $router->fleetbaseRoutes(
+                            'contacts',
+                            function ($router, $controller) {
+                                $router->get('export', $controller('export'));
+                                $router->get('facilitators/{id}', $controller('getAsFacilitator'));
+                                $router->get('customers/{id}', $controller('getAsCustomer'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->fleetbaseRoutes(
+                            'drivers',
+                            function ($router, $controller) {
+                                $router->get('statuses', $controller('statuses'));
+                                $router->get('export', $controller('export'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->fleetbaseRoutes('entities');
+                        $router->fleetbaseRoutes(
+                            'fleets',
+                            function ($router, $controller) {
+                                $router->post('assign-driver', $controller('assignDriver'));
+                                $router->post('remove-driver', $controller('removeDriver'));
+                                $router->post('assign-vehicle', $controller('assignVehicle'));
+                                $router->post('remove-vehicle', $controller('removeVehicle'));
+                                $router->get('export', $controller('export'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->fleetbaseRoutes(
+                            'fuel-reports',
+                            function ($router, $controller) {
+                                $router->get('export', $controller('export'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->fleetbaseRoutes(
+                            'issues',
+                            function ($router, $controller) {
+                                $router->get('export', $controller('export'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->fleetbaseRoutes(
+                            'integrated-vendors',
+                            function ($router, $controller) {
+                                $router->get('supported', $controller('getSupported'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->fleetbaseRoutes(
+                            'orders',
+                            function ($router, $controller) {
+                                $router->get('search', $controller('search'));
+                                $router->get('statuses', $controller('statuses'));
+                                $router->get('types', $controller('types'));
+                                $router->get('label/{id}', $controller('label'));
+                                $router->get('next-activity/{id}', $controller('nextActivity'));
+                                $router->post('process-imports', $controller('importFromFiles'));
+                                $router->patch('update-activity/{id}', $controller('updateActivity'));
+                                $router->patch('bulk-cancel', $controller('bulkCancel'));
+                                $router->patch('cancel', $controller('cancel'));
+                                $router->patch('dispatch', $controller('dispatchOrder'));
+                                $router->patch('start', $controller('start'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->fleetbaseRoutes('payloads');
+                        $router->fleetbaseRoutes(
+                            'places',
+                            function ($router, $controller) {
+                                $router->get('search', $controller('search'))->middleware('cache.headers:private;max_age=3600');
+                                $router->get('lookup', $controller('geocode'))->middleware('cache.headers:private;max_age=3600');
+                                $router->get('export', $controller('export'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->fleetbaseRoutes('proofs');
+                        $router->fleetbaseRoutes('purchase-rates');
+                        $router->fleetbaseRoutes('routes');
+                        $router->fleetbaseRoutes(
+                            'service-areas',
+                            function ($router, $controller) {
+                                $router->get('export', $controller('export'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->fleetbaseRoutes('zones');
+                        $router->fleetbaseRoutes(
+                            'service-quotes',
+                            function ($router, $controller) {
+                                $router->post('preliminary', $controller('preliminaryQuery'));
+                            }
+                        );
+                        $router->fleetbaseRoutes(
+                            'service-rates',
+                            function ($router, $controller) {
+                                $router->get('for-route', $controller('getServicesForRoute'));
+                            }
+                        );
+                        $router->fleetbaseRoutes('tracking-numbers');
+                        $router->fleetbaseRoutes('tracking-statuses');
+                        $router->fleetbaseRoutes(
+                            'vehicles',
+                            function ($router, $controller) {
+                                $router->get('statuses', $controller('statuses'));
+                                $router->get('avatars', $controller('avatars'));
+                                $router->get('export', $controller('export'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->fleetbaseRoutes('vehicle-devices');
+                        $router->fleetbaseRoutes(
+                            'vendors',
+                            function ($router, $controller) {
+                                $router->get('statuses', $controller('statuses'));
+                                $router->get('export', $controller('export'));
+                                $router->get('facilitators/{id}', $controller('getAsFacilitator'));
+                                $router->get('customers/{id}', $controller('getAsCustomer'));
+                                $router->delete('bulk-delete', $controller('bulkDelete'));
+                            }
+                        );
+                        $router->group(
+                            ['prefix' => 'query'],
+                            function () use ($router) {
+                                $router->get('customers', 'MorphController@queryCustomersOrFacilitators');
+                                $router->get('facilitators', 'MorphController@queryCustomersOrFacilitators');
+                            }
+                        );
+                        $router->group(
+                            ['prefix' => 'geocoder'],
+                            function ($router) {
+                                $router->get('reverse', 'GeocoderController@reverse');
+                                $router->get('query', 'GeocoderController@geocode');
+                            }
+                        );
+                        $router->group(
+                            ['prefix' => 'fleet-ops'],
+                            function ($router) {
+                                /* Dashboard Build */
+                                $router->get('dashboard', 'MetricsController@dashboard');
+
+                                $router->group(
+                                    ['prefix' => 'order-configs'],
+                                    function () use ($router) {
+                                        $router->get('get-installed', 'OrderConfigController@getInstalled');
+                                        $router->get('dynamic-meta-fields', 'OrderConfigController@getDynamicMetaFields');
+                                        $router->post('save', 'OrderConfigController@save');
+                                        $router->post('new', 'OrderConfigController@new');
+                                        $router->post('clone', 'OrderConfigController@clone');
+                                        $router->delete('{id}', 'OrderConfigController@delete');
+                                    }
+                                );
+                                $router->group(
+                                    ['prefix' => 'lookup'],
+                                    function ($router) {
+                                        $router->get('customers', 'FleetOpsLookupController@polymorphs');
+                                        $router->get('facilitators', 'FleetOpsLookupController@polymorphs');
+                                    }
+                                );
+                                $router->group(
+                                    ['prefix' => 'live'],
+                                    function ($router) {
+                                        $router->get('coordinates', 'LiveController@coordinates');
+                                        $router->get('routes', 'LiveController@routes');
+                                        $router->get('orders', 'LiveController@orders');
+                                        $router->get('drivers', 'LiveController@drivers');
+                                        $router->get('vehicles', 'LiveController@vehicles');
+                                        $router->get('places', 'LiveController@places');
+                                    }
+                                );
+                                $router->group(
+                                    ['prefix' => 'settings'],
+                                    function ($router) {
+                                        $router->get('visibility', 'SettingController@getVisibilitySettings');
+                                        $router->post('visibility', 'SettingController@saveVisibilitySettings');
+                                    }
+                                );
+                                $router->group(
+                                    ['prefix' => 'metrics'],
+                                    function ($router) {
+                                        $router->get('all', 'MetricsController@all');
+                                    }
+                                );
+                            }
+                        );
+                    }
+                );
+            }
+        );
+    }
+);

package/server/tests/Feature.php

@@ -0,0 +1,5 @@
+<?php
+
+test('example', function () {
+    expect(true)->toBeTrue();
+});