@fleetbase/fleetops-engine 0.2.5 → 0.2.7

package/server/src/Observers/PlaceObserver.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Models\Place;
+
+class PlaceObserver
+{
+    /**
+     * Handle the Place "creating" event.
+     *
+     * @return void
+     */
+    public function creating(Place $place)
+    {
+        // uppercase all address attributes
+        $toUppercase = ['name', 'street1', 'street2', 'city', 'province', 'postal_code', 'neighborhood', 'district', 'building', 'country'];
+
+        // uppercase all attributes above
+        foreach ($toUppercase as $attribute) {
+            if (isset($place->{$attribute}) && is_string($place->{$attribute})) {
+                $place->{$attribute} = strtoupper($place->{$attribute});
+            }
+        }
+    }
+}

package/server/src/Observers/PurchaseRateObserver.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Models\PurchaseRate;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Models\Company;
+use Fleetbase\Models\Transaction;
+use Fleetbase\Models\TransactionItem;
+
+class PurchaseRateObserver
+{
+    /**
+     * Handle the PurchaseRate "creating" event.
+     * Create transactions accordingly.
+     *
+     * @return void
+     */
+    public function creating(PurchaseRate $purchaseRate)
+    {
+        $purchaseRate->load(['serviceQuote.items', 'serviceQuote.serviceRate']);
+
+        // get company
+        $company = Company::where('uuid', session('company', $purchaseRate->company_uuid))->first();
+
+        // get currency to use
+        $currency = data_get($purchaseRate, 'serviceQuote.currency', $company->country ? Utils::getCurrenyFromCountryCode($company->country) : 'SGD');
+
+        // create transaction and transaction items
+        $transaction = Transaction::create([
+            'company_uuid'           => session('company', $purchaseRate->company_uuid),
+            'customer_uuid'          => $purchaseRate->customer_uuid,
+            'customer_type'          => $purchaseRate->customer_type,
+            'gateway_transaction_id' => $purchaseRate->getMeta('transaction_id', Transaction::generateNumber()),
+            'gateway'                => 'internal',
+            'amount'                 => data_get($purchaseRate, 'serviceQuote.amount', 0),
+            'currency'               => $currency,
+            'description'            => 'Dispatch order',
+            'type'                   => 'dispatch',
+            'status'                 => 'success',
+        ]);
+
+        // Update order with transaction id
+        Order::where('payload_uuid', $purchaseRate->payload_uuid)->update(['transaction_uuid' => $transaction->uuid]);
+
+        if (isset($purchaseRate->serviceQuote)) {
+            $purchaseRate->serviceQuote->items->each(function ($serviceQuoteItem) use ($transaction, $currency) {
+                TransactionItem::create([
+                    'transaction_uuid' => $transaction->uuid,
+                    'amount'           => $serviceQuoteItem->amount ?? 0,
+                    'currency'         => $currency,
+                    'details'          => data_get($serviceQuoteItem, 'details', 'Internal dispatch'),
+                    'code'             => data_get($serviceQuoteItem, 'code', 'internal'),
+                ]);
+            });
+        }
+
+        $purchaseRate->transaction_uuid = $transaction->uuid;
+    }
+}

package/server/src/Observers/ServiceAreaObserver.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Models\ServiceArea;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\FleetOps\Support\Utils as FleetOpsUtils;
+
+class ServiceAreaObserver
+{
+    /**
+     * Handle the ServiceArea "creating" event.
+     *
+     * @return void
+     */
+    public function creating(ServiceArea $serviceArea)
+    {
+        // if no border is set but country is, create the border from the country
+        if (empty($serviceArea->border) && isset($serviceArea->country)) {
+            $serviceArea->border = FleetOpsUtils::createPolygonFromCountry($serviceArea->country);
+        }
+    }
+
+    /**
+     * Handle the ServiceArea "deleted" event.
+     *
+     * @return void
+     */
+    public function deleted(ServiceArea $serviceArea)
+    {
+        $serviceArea->load(['zones']);
+
+        Utils::deleteModels($serviceArea->zones);
+    }
+}

package/server/src/Observers/ServiceRateObserver.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Models\ServiceRate;
+use Fleetbase\FleetOps\Support\Utils;
+
+class ServiceRateObserver
+{
+    /**
+     * Handle the ServiceRate "creating" event.
+     *
+     * @return void
+     */
+    public function creating(ServiceRate $serviceRate)
+    {
+        // convert these attributes to numbers only
+        $toNumbers = ['base_fee', 'per_km_flat_rate_fee', 'peak_hours_flat_fee', 'peak_hours_percent', 'cod_flat_fee', 'cod_percent'];
+
+        // convert to numbers for all attributes above
+        foreach ($toNumbers as $attribute) {
+            if (isset($serviceRate->{$attribute})) {
+                $serviceRate->{$attribute} = Utils::numbersOnly($serviceRate->{$attribute});
+            }
+        }
+    }
+
+    /**
+     * Handle the ServiceRate "created" event.
+     *
+     * @return void
+     */
+    public function created(ServiceRate $serviceRate)
+    {
+        $serviceRateFees       = request()->input('serviceRate.rate_fees');
+        $serviceRateParcelFees = request()->input('serviceRate.parcel_fees');
+
+        if ($serviceRate->isFixedMeter() || $serviceRate->isPerDrop()) {
+            $serviceRate->setServiceRateFees($serviceRateFees);
+        }
+
+        if ($serviceRate->isParcelService()) {
+            $serviceRate->setServiceRateParcelFees($serviceRateParcelFees);
+        }
+    }
+
+    /**
+     * Handle the ServiceRate "updated" event.
+     *
+     * @return void
+     */
+    public function updated(ServiceRate $serviceRate)
+    {
+        $serviceRateFees       = request()->input('serviceRate.rate_fees');
+        $serviceRateParcelFees = request()->input('serviceRate.parcel_fees');
+
+        if ($serviceRate->isFixedMeter() || $serviceRate->isPerDrop()) {
+            $serviceRate->setServiceRateFees($serviceRateFees);
+        }
+
+        if ($serviceRate->isParcelService()) {
+            $serviceRate->setServiceRateParcelFees($serviceRateParcelFees);
+        }
+    }
+
+    /**
+     * Handle the ServiceRate "creating" event.
+     *
+     * @return void
+     */
+    public function deleted(ServiceRate $serviceRate)
+    {
+        $serviceRate->load(['parcelFees', 'rateFees']);
+
+        Utils::deleteModels($serviceRate->parcelFees);
+        Utils::deleteModels($serviceRate->rateFees);
+    }
+}

package/server/src/Observers/TrackingNumberObserver.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Models\TrackingNumber;
+use Fleetbase\FleetOps\Models\TrackingStatus;
+use Grimzy\LaravelMysqlSpatial\Types\Point;
+use Illuminate\Support\Str;
+use Milon\Barcode\Facades\DNS2DFacade as DNS2D;
+
+class TrackingNumberObserver
+{
+    /**
+     * Listen to the TrackingNumber creating event.
+     *
+     * @return void
+     */
+    public function creating(TrackingNumber $trackingNumber)
+    {
+        // generate a barcode annd qr code
+        $trackingNumber->tracking_number = TrackingNumber::generateNumber($trackingNumber->region);
+        $trackingNumber->qr_code         = DNS2D::getBarcodePNG($trackingNumber->owner_uuid, 'QRCODE');
+        $trackingNumber->barcode         = DNS2D::getBarcodePNG($trackingNumber->owner_uuid, 'PDF417');
+    }
+
+    /**
+     * Listen to the TrackingNumber created event.
+     *
+     * @return void
+     */
+    public function created(TrackingNumber $trackingNumber)
+    {
+        $trackingStatus = TrackingStatus::create([
+            'company_uuid'         => session('company'),
+            'tracking_number_uuid' => $trackingNumber->uuid,
+            'status'               => Str::title($trackingNumber->type . ' created'),
+            'details'              => 'New ' . Str::lower($trackingNumber->type) . ' created.',
+            'location'             => new Point(0.0, 0.0, 4326),
+            'code'                 => 'CREATED',
+        ]);
+
+        $trackingNumber->updateOwnerStatus($trackingStatus);
+    }
+}

package/server/src/Observers/UserObserver.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Models\Driver;
+use Fleetbase\Models\User;
+
+class UserObserver
+{
+    /**
+     * Handle the User "deleted" event.
+     *
+     * @return void
+     */
+    public function deleted(User $user)
+    {
+        // if the user deleted is a driver, delete their driver record to
+        Driver::where('user_uuid', $user->uuid)->delete();
+    }
+}

package/server/src/Observers/VehicleObserver.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Models\Driver;
+use Fleetbase\FleetOps\Models\Vehicle;
+
+class VehicleObserver
+{
+    /**
+     * Handle the Vehicle "created" event.
+     *
+     * @return void
+     */
+    public function created(Vehicle $vehicle)
+    {
+        // assign this vehicle to a driver if the driver has been set
+        $identifier = request()->or(['driver_uuid', 'vehicle.driver_uuid', 'vehicle.driver.uuid']);
+
+        if ($identifier) {
+            $driver = Driver::where('uuid', $identifier)->whereNull('deleted_at')->withoutGlobalScopes()->first();
+
+            if ($driver) {
+                // assign this vehicle to driver
+                $driver->assignVehicle($vehicle);
+
+                // set driver to vehicle
+                $vehicle->setRelation('driver', $driver);
+            }
+        }
+    }
+
+    /**
+     * Handle the Vehicle "updated" event.
+     *
+     * @return void
+     */
+    public function updated(Vehicle $vehicle)
+    {
+        // assign this vehicle to a driver if the driver has been set
+        $identifier = request()->or(['driver_uuid', 'vehicle.driver_uuid', 'vehicle.driver.uuid']);
+
+        if ($identifier) {
+            $driver = Driver::where('uuid', $identifier)->whereNull('deleted_at')->withoutGlobalScopes()->first();
+
+            if ($driver) {
+                // assign this vehicle to driver
+                $driver->assignVehicle($vehicle);
+
+                // set driver to vehicle
+                $vehicle->setRelation('driver', $driver);
+            }
+        }
+    }
+
+    /**
+     * Handle the Vehicle "deleted" event.
+     *
+     * @return void
+     */
+    public function deleted(Vehicle $vehicle)
+    {
+        // Unassign the deleted vehicle from matching driver/(s)
+        Driver::where(['vehicle_uuid' => $vehicle->uuid])->delete();
+    }
+}

package/server/src/Providers/EventServiceProvider.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Fleetbase\FleetOps\Providers;
+
+use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
+
+class EventServiceProvider extends ServiceProvider
+{
+    /**
+     * The event listener mappings for the application.
+     *
+     * @var array
+     */
+    protected $listen = [
+        /*
+         * Order Events
+         */
+        \Fleetbase\FleetOps\Events\OrderCanceled::class       => [\Fleetbase\FleetOps\Listeners\HandleOrderCanceled::class, \Fleetbase\Listeners\SendResourceLifecycleWebhook::class],
+        \Fleetbase\FleetOps\Events\OrderDispatched::class     => [\Fleetbase\FleetOps\Listeners\HandleOrderDispatched::class, \Fleetbase\Listeners\SendResourceLifecycleWebhook::class],
+        \Fleetbase\FleetOps\Events\OrderDispatchFailed::class => [\Fleetbase\FleetOps\Listeners\HandleOrderDispatchFailed::class, \Fleetbase\Listeners\SendResourceLifecycleWebhook::class],
+        \Fleetbase\FleetOps\Events\OrderDriverAssigned::class => [\Fleetbase\FleetOps\Listeners\HandleOrderDriverAssigned::class, \Fleetbase\Listeners\SendResourceLifecycleWebhook::class],
+        \Fleetbase\FleetOps\Events\OrderCompleted::class      => [\Fleetbase\Listeners\SendResourceLifecycleWebhook::class],
+        \Fleetbase\FleetOps\Events\OrderReady::class          => [\Fleetbase\FleetOps\Listeners\HandleOrderReady::class],
+
+        /*
+         * Core Events
+         */
+        \Fleetbase\Events\UserRemovedFromCompany::class => [\Fleetbase\FleetOps\Listeners\HandleUserRemovedFromCompany::class],
+    ];
+}

package/server/src/Providers/FleetOpsServiceProvider.php

@@ -0,0 +1,94 @@
+<?php
+
+namespace Fleetbase\FleetOps\Providers;
+
+use Brick\Geo\Engine\GeometryEngineRegistry;
+use Brick\Geo\Engine\GEOSEngine;
+use Fleetbase\Providers\CoreServiceProvider;
+
+if (!class_exists(CoreServiceProvider::class)) {
+    throw new \Exception('FleetOps cannot be loaded without `fleetbase/core-api` installed!');
+}
+
+/**
+ * FleetOps service provider.
+ */
+class FleetOpsServiceProvider extends CoreServiceProvider
+{
+    /**
+     * The observers registered with the service provider.
+     *
+     * @var array
+     */
+    public $observers = [
+        \Fleetbase\FleetOps\Models\Order::class          => \Fleetbase\FleetOps\Observers\OrderObserver::class,
+        \Fleetbase\FleetOps\Models\Payload::class        => \Fleetbase\FleetOps\Observers\PayloadObserver::class,
+        \Fleetbase\FleetOps\Models\Place::class          => \Fleetbase\FleetOps\Observers\PlaceObserver::class,
+        \Fleetbase\FleetOps\Models\ServiceRate::class    => \Fleetbase\FleetOps\Observers\ServiceRateObserver::class,
+        \Fleetbase\FleetOps\Models\PurchaseRate::class   => \Fleetbase\FleetOps\Observers\PurchaseRateObserver::class,
+        \Fleetbase\FleetOps\Models\ServiceArea::class    => \Fleetbase\FleetOps\Observers\ServiceAreaObserver::class,
+        \Fleetbase\FleetOps\Models\TrackingNumber::class => \Fleetbase\FleetOps\Observers\TrackingNumberObserver::class,
+        \Fleetbase\FleetOps\Models\Driver::class         => \Fleetbase\FleetOps\Observers\DriverObserver::class,
+        \Fleetbase\FleetOps\Models\Vehicle::class        => \Fleetbase\FleetOps\Observers\VehicleObserver::class,
+        \Fleetbase\Models\User::class                    => \Fleetbase\FleetOps\Observers\UserObserver::class,
+    ];
+
+    /**
+     * The console commands registered with the service provider.
+     *
+     * @var array
+     */
+    public $commands = [
+        \Fleetbase\FleetOps\Console\Commands\DispatchAdhocOrders::class,
+        \Fleetbase\FleetOps\Console\Commands\DispatchOrders::class,
+        \Fleetbase\FleetOps\Console\Commands\TrackOrderDistanceAndTime::class,
+    ];
+
+    /**
+     * Register any application services.
+     *
+     * Within the register method, you should only bind things into the
+     * service container. You should never attempt to register any event
+     * listeners, routes, or any other piece of functionality within the
+     * register method.
+     *
+     * More information on this can be found in the Laravel documentation:
+     * https://laravel.com/docs/8.x/providers
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->register(CoreServiceProvider::class);
+    }
+
+    /**
+     * Bootstrap any package services.
+     *
+     * @return void
+     *
+     * @throws \Exception if the `fleetbase/core-api` package is not installed
+     */
+    public function boot()
+    {
+        $this->registerObservers();
+        $this->registerCommands();
+        $this->scheduleCommands(function ($schedule) {
+            $schedule->command('fleetops:dispatch-orders')->everyMinute();
+            $schedule->command('fleetops:dispatch-adhoc')->everyMinute();
+            $schedule->command('fleetops:update-estimations')->everyFifteenMinutes();
+        });
+        $this->registerExpansionsFrom(__DIR__ . '/../Expansions');
+        $this->loadRoutesFrom(__DIR__ . '/../routes.php');
+        $this->loadMigrationsFrom(__DIR__ . '/../../migrations');
+        $this->loadViewsFrom(__DIR__ . '/../../resources/views', 'fleetops');
+        $this->mergeConfigFrom(__DIR__ . '/../../config/fleetops.php', 'fleetops');
+        $this->mergeConfigFrom(__DIR__ . '/../../config/api.php', 'api');
+        $this->mergeConfigFrom(__DIR__ . '/../../config/cache.stores.php', 'cache.stores');
+        $this->mergeConfigFrom(__DIR__ . '/../../config/geocoder.php', 'geocoder');
+        $this->mergeConfigFrom(__DIR__ . '/../../config/dompdf.php', 'dompdf');
+
+        // Register the GeometryEngine for GEOSEngine
+        GeometryEngineRegistry::set(new GEOSEngine());
+    }
+}

package/server/src/Rules/ResolvablePoint.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Fleetbase\FleetOps\Rules;
+
+use Fleetbase\FleetOps\Support\Utils;
+use Illuminate\Contracts\Validation\Rule;
+
+class ResolvablePoint implements Rule
+{
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param string $attribute
+     *
+     * @return bool
+     */
+    public function passes($attribute, $value)
+    {
+        try {
+            $point = Utils::getPointFromMixed($value);
+
+            return $point instanceof \Grimzy\LaravelMysqlSpatial\Types\Point;
+        } catch (\Exception $e) {
+            return false;
+        }
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message()
+    {
+        return 'The :attribute must be a valid GeoJSON Point or a type (Place ID) that can be resolved to a Point.';
+    }
+}

package/server/src/Scopes/DriverScope.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Fleetbase\FleetOps\Scopes;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Scope;
+
+class DriverScope implements Scope
+{
+    /**
+     * Apply the scope to a given Eloquent query builder.
+     *
+     * @return void
+     */
+    public function apply(Builder $builder, Model $model)
+    {
+        // make sure the user of the driver isn't deleted
+        $builder->whereHas('user');
+    }
+}

package/server/src/Support/Algo.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support;
+
+use Webit\Util\EvalMath\EvalMath;
+
+class Algo
+{
+    /**
+     * Execute an algorithm strig.
+     *
+     * @return int
+     */
+    public static function exec($algorithm, $variables = [], $round = false)
+    {
+        $m                  = new EvalMath();
+        $m->suppress_errors = true;
+
+        foreach ($variables as $key => $value) {
+            $algorithm = str_replace('{' . $key . '}', $value, $algorithm);
+        }
+
+        $result = $m->evaluate($algorithm);
+
+        if ($round) {
+            return round($result, 2); // precision 2 cuz most likely dealing with $
+        }
+
+        return $result;
+    }
+
+    /**
+     * Calculates driving distance and time using Google distance matric.
+     *
+     * @return array
+     */
+    public static function calculateDrivingDistanceAndTime($lat1, $long1, $lat2, $long2)
+    {
+        $url =
+            'https://maps.googleapis.com/maps/api/distancematrix/json?origins=' . $lat1 . ',' . $long1 . '&destinations=' . $lat2 . ',' . $long2 . '&mode=driving&key=' . config('services.google.key');
+        $ch = curl_init();
+        curl_setopt($ch, CURLOPT_URL, $url);
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
+        curl_setopt($ch, CURLOPT_PROXYPORT, 3128);
+        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
+        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
+        $response = curl_exec($ch);
+        curl_close($ch);
+        $response_a = json_decode($response, true);
+        $dist       = $response_a['rows'][0]['elements'][0]['distance']['value'];
+        $time       = $response_a['rows'][0]['elements'][0]['duration']['value'];
+
+        return ['distance' => $dist, 'time' => $time];
+    }
+}

package/server/src/Support/DistanceMatrix.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Fleetbase\FleetOps\Support;
+
+/**
+ * A utility class for calculating driving distances and times using the Google Distance Matrix API.
+ *
+ * This class provides methods for calculating the driving distance and time between two points, as well
+ * as between multiple points using the Google Distance Matrix API. The results are returned in meters
+ * for distance and seconds for time.
+ *
+ * @category Utility
+ *
+ * @license  https://opensource.org/licenses/MIT MIT License
+ * @author   Ronald A. Richardson
+ */
+class DistanceMatrix
+{
+    public ?float $distance;
+    public ?int $time;
+
+    public function __construct(?float $distance, ?int $time)
+    {
+        $this->distance = $distance;
+        $this->time     = $time;
+    }
+}