@fleetbase/fleetops-engine 0.2.6 → 0.2.8

package/server/src/Notifications/OrderCanceled.php

@@ -0,0 +1,129 @@
+<?php
+
+namespace Fleetbase\FleetOps\Notifications;
+
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Support\Utils;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Apn\ApnChannel;
+use NotificationChannels\Apn\ApnMessage;
+use NotificationChannels\Fcm\FcmChannel;
+use NotificationChannels\Fcm\FcmMessage;
+use NotificationChannels\Fcm\Resources\AndroidConfig;
+use NotificationChannels\Fcm\Resources\AndroidFcmOptions;
+use NotificationChannels\Fcm\Resources\AndroidNotification;
+use NotificationChannels\Fcm\Resources\ApnsConfig;
+use NotificationChannels\Fcm\Resources\ApnsFcmOptions;
+
+class OrderCanceled extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    /**
+     * The order instance this notification is for.
+     *
+     * @var \Fleetbase\Models\Order
+     */
+    public $order;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @return void
+     */
+    public function __construct(Order $order)
+    {
+        $this->order = $order->setRelations([]);
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        return ['broadcast', 'mail', FcmChannel::class, ApnChannel::class];
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return [
+            new Channel('company.' . session('company', data_get($this->order, 'company.uuid'))),
+            new Channel('company.' . data_get($this->order, 'company.public_id')),
+            new Channel('api.' . session('api_credential')),
+            new Channel('order.' . $this->order->uuid),
+            new Channel('order.' . $this->order->public_id),
+        ];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @return \Illuminate\Notifications\Messages\MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        $message = (new MailMessage())
+            ->subject('Order ' . $this->order->public_id . ' was canceled')
+            ->line('Order ' . $this->order->public_id . ' has been canceled.')
+            ->line('No further action is necessary.');
+
+        $message->action('View Details', Utils::consoleUrl('', ['shift' => 'fleet-ops/orders/view/' . $this->order->public_id]));
+
+        return $message;
+    }
+
+    /**
+     * Get the firebase cloud message representation of the notification.
+     *
+     * @return array
+     */
+    public function toFcm($notifiable)
+    {
+        $notification = \NotificationChannels\Fcm\Resources\Notification::create()
+            ->setTitle('Order ' . $this->order->public_id . ' was canceled')
+            ->setBody('No further action is necessary.');
+
+        $message = FcmMessage::create()
+            ->setData(['id' => $this->order->public_id, 'type' => 'order_canceled'])
+            ->setNotification($notification)
+            ->setAndroid(
+                AndroidConfig::create()
+                    ->setFcmOptions(AndroidFcmOptions::create()->setAnalyticsLabel('analytics'))
+                    ->setNotification(AndroidNotification::create()->setColor('#4391EA'))
+            )->setApns(
+                ApnsConfig::create()
+                    ->setFcmOptions(ApnsFcmOptions::create()->setAnalyticsLabel('analytics_ios'))
+            );
+
+        return $message;
+    }
+
+    /**
+     * Get the apns message representation of the notification.
+     *
+     * @return array
+     */
+    public function toApn($notifiable)
+    {
+        $message = ApnMessage::create()
+            ->badge(1)
+            ->title('Order ' . $this->order->public_id . ' was canceled')
+            ->body('No further action is necessary.')
+            ->custom('type', 'order_canceled')
+            ->custom('id', $this->order->public_id)
+            ->action('view_order', ['id' => $this->order->public_id]);
+
+        return $message;
+    }
+}

package/server/src/Notifications/OrderDispatchFailed.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Fleetbase\FleetOps\Notifications;
+
+use Fleetbase\FleetOps\Events\OrderDispatchFailed as OrderDispatchFailedEvent;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Support\Utils;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+
+class OrderDispatchFailed extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    /**
+     * The order instance this notification is for.
+     *
+     * @var \Fleetbase\Models\Order
+     */
+    public $order;
+
+    /**
+     * Reason order dispatch failed.
+     *
+     * @var string
+     */
+    public $reason;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @return void
+     */
+    public function __construct(Order $order, OrderDispatchFailedEvent $event)
+    {
+        $this->order  = $order->setRelations([]);
+        $this->reason = $event->getReason();
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return [
+            new Channel('company.' . session('company', data_get($this->order, 'company.uuid'))),
+            new Channel('company.' . data_get($this->order, 'company.public_id')),
+            new Channel('api.' . session('api_credential')),
+            new Channel('order.' . $this->order->uuid),
+            new Channel('order.' . $this->order->public_id),
+        ];
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        return ['mail'];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @return \Illuminate\Notifications\Messages\MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        return (new MailMessage())
+            ->subject('Order ' . $this->order->public_id . ' has dispatch has failed!')
+            ->line($this->reason)
+            ->action('View Details', Utils::consoleUrl('', ['shift' => 'fleet-ops/orders/view/' . $this->order->public_id]));
+    }
+}

package/server/src/Notifications/OrderDispatched.php

@@ -0,0 +1,173 @@
+<?php
+
+namespace Fleetbase\FleetOps\Notifications;
+
+use Fleetbase\Events\ResourceLifecycleEvent;
+use Fleetbase\FleetOps\Http\Resources\v1\Order as OrderResource;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Support\Utils;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\BroadcastMessage;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Apn\ApnChannel;
+use NotificationChannels\Apn\ApnMessage;
+use NotificationChannels\Fcm\FcmChannel;
+use NotificationChannels\Fcm\FcmMessage;
+use NotificationChannels\Fcm\Resources\AndroidConfig;
+use NotificationChannels\Fcm\Resources\AndroidFcmOptions;
+use NotificationChannels\Fcm\Resources\AndroidNotification;
+use NotificationChannels\Fcm\Resources\ApnsConfig;
+use NotificationChannels\Fcm\Resources\ApnsFcmOptions;
+
+class OrderDispatched extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    /**
+     * The order instance this notification is for.
+     *
+     * @var \Fleetbase\Models\Order
+     */
+    public $order;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @return void
+     */
+    public function __construct(Order $order)
+    {
+        $this->order = $order->setRelations([]);
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        return ['broadcast', 'mail', FcmChannel::class, ApnChannel::class];
+    }
+
+    /**
+     * Get the type of the notification being broadcast.
+     *
+     * @return string
+     */
+    public function broadcastType()
+    {
+        return 'order.dispatched';
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return [
+            new Channel('company.' . session('company', data_get($this->order, 'company.uuid'))),
+            new Channel('company.' . data_get($this->order, 'company.public_id')),
+            new Channel('api.' . session('api_credential')),
+            new Channel('order.' . $this->order->uuid),
+            new Channel('order.' . $this->order->public_id),
+        ];
+    }
+
+    /**
+     * Get the broadcastable representation of the notification.
+     *
+     * @return BroadcastMessage
+     */
+    public function toBroadcast($notifiable)
+    {
+        $model        = $this->order;
+        $resource     = new OrderResource($model);
+        $resourceData = [];
+
+        if ($resource) {
+            if (method_exists($resource, 'toWebhookPayload')) {
+                $resourceData = $resource->toWebhookPayload();
+            } elseif (method_exists($resource, 'toArray')) {
+                $resourceData = $resource->toArray(request());
+            }
+        }
+
+        $resourceData = ResourceLifecycleEvent::transformResourceChildrenToId($resourceData);
+
+        $data = [
+            'id'          => uniqid('event_'),
+            'api_version' => config('api.version'),
+            'event'       => 'order.dispatched',
+            'created_at'  => now()->toDateTimeString(),
+            'data'        => $resourceData,
+        ];
+
+        return new BroadcastMessage($data);
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @return \Illuminate\Notifications\Messages\MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        $message = (new MailMessage())
+            ->subject('Order ' . $this->order->public_id . ' has been dispatched!')
+            ->line('Order ' . $this->order->public_id . ' has been dispatched to you.');
+
+        $message->action('View Details', Utils::consoleUrl('', ['shift' => 'fleet-ops/orders/view/' . $this->order->public_id]));
+
+        return $message;
+    }
+
+    /**
+     * Get the firebase cloud message representation of the notification.
+     *
+     * @return array
+     */
+    public function toFcm($notifiable)
+    {
+        $notification = \NotificationChannels\Fcm\Resources\Notification::create()
+            ->setTitle('Order ' . $this->order->public_id . ' has been dispatched!')
+            ->setBody('An order has just been dispatched to you and is ready to be started.');
+
+        $message = FcmMessage::create()
+            ->setData(['id' => $this->order->public_id, 'type' => 'order_dispatched'])
+            ->setNotification($notification)
+            ->setAndroid(
+                AndroidConfig::create()
+                    ->setFcmOptions(AndroidFcmOptions::create()->setAnalyticsLabel('analytics'))
+                    ->setNotification(AndroidNotification::create()->setColor('#4391EA'))
+            )->setApns(
+                ApnsConfig::create()
+                    ->setFcmOptions(ApnsFcmOptions::create()->setAnalyticsLabel('analytics_ios'))
+            );
+
+        return $message;
+    }
+
+    /**
+     * Get the apns message representation of the notification.
+     *
+     * @return array
+     */
+    public function toApn($notifiable)
+    {
+        $message = ApnMessage::create()
+            ->badge(1)
+            ->title('Order ' . $this->order->public_id . ' has been dispatched!')
+            ->body('An order has just been dispatched to you and is ready to be started..')
+            ->custom('type', 'order_dispatched')
+            ->custom('id', $this->order->public_id)
+            ->action('view_order', ['id' => $this->order->public_id]);
+
+        return $message;
+    }
+}

package/server/src/Notifications/OrderPing.php

@@ -0,0 +1,162 @@
+<?php
+
+namespace Fleetbase\FleetOps\Notifications;
+
+use Fleetbase\Events\ResourceLifecycleEvent;
+use Fleetbase\FleetOps\Http\Resources\v1\Order as OrderResource;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\FleetOps\Support\Utils;
+use Illuminate\Broadcasting\Channel;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\BroadcastMessage;
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Apn\ApnChannel;
+use NotificationChannels\Apn\ApnMessage;
+use NotificationChannels\Fcm\FcmChannel;
+use NotificationChannels\Fcm\FcmMessage;
+use NotificationChannels\Fcm\Resources\AndroidConfig;
+use NotificationChannels\Fcm\Resources\AndroidFcmOptions;
+use NotificationChannels\Fcm\Resources\AndroidNotification;
+use NotificationChannels\Fcm\Resources\ApnsConfig;
+use NotificationChannels\Fcm\Resources\ApnsFcmOptions;
+
+class OrderPing extends Notification implements ShouldQueue
+{
+    use Queueable;
+
+    /**
+     * The order instance this notification is for.
+     */
+    public Order $order;
+
+    /**
+     * Distance of order pickup from driver.
+     *
+     * @var int
+     */
+    public $distance;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @return void
+     */
+    public function __construct(Order $order, $distance = null)
+    {
+        $this->order    = $order->setRelations([]);
+        $this->distance = $distance;
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        return ['broadcast', FcmChannel::class, ApnChannel::class];
+    }
+
+    /**
+     * Get the type of the notification being broadcast.
+     *
+     * @return string
+     */
+    public function broadcastType()
+    {
+        return 'order.ping';
+    }
+
+    /**
+     * Get the channels the event should broadcast on.
+     *
+     * @return \Illuminate\Broadcasting\Channel|array
+     */
+    public function broadcastOn()
+    {
+        return [
+            new Channel('company.' . session('company', data_get($this->order, 'company.uuid'))),
+            new Channel('company.' . data_get($this->order, 'company.public_id')),
+            new Channel('api.' . session('api_credential')),
+            new Channel('order.' . $this->order->uuid),
+            new Channel('order.' . $this->order->public_id),
+        ];
+    }
+
+    /**
+     * Get the broadcastable representation of the notification.
+     *
+     * @return BroadcastMessage
+     */
+    public function toBroadcast($notifiable)
+    {
+        $model        = $this->order;
+        $resource     = new OrderResource($model);
+        $resourceData = [];
+
+        if ($resource) {
+            if (method_exists($resource, 'toWebhookPayload')) {
+                $resourceData = $resource->toWebhookPayload();
+            } elseif (method_exists($resource, 'toArray')) {
+                $resourceData = $resource->toArray(request());
+            }
+        }
+
+        $resourceData = ResourceLifecycleEvent::transformResourceChildrenToId($resourceData);
+
+        $data = [
+            'id'          => uniqid('event_'),
+            'api_version' => config('api.version'),
+            'event'       => 'order.ping',
+            'created_at'  => now()->toDateTimeString(),
+            'data'        => $resourceData,
+        ];
+
+        return new BroadcastMessage($data);
+    }
+
+    /**
+     * Get the firebase cloud message representation of the notification.
+     *
+     * @return array
+     */
+    public function toFcm($notifiable)
+    {
+        $notification = \NotificationChannels\Fcm\Resources\Notification::create()
+            ->setTitle('New incoming order!')
+            ->setBody($this->distance ? 'New order available for pickup about ' . Utils::formatMeters($this->distance, false) . ' away' : 'New order is available for pickup.');
+
+        $message = FcmMessage::create()
+            ->setData(['id' => $this->order->public_id, 'type' => 'order_ping'])
+            ->setNotification($notification)
+            ->setAndroid(
+                AndroidConfig::create()
+                    ->setFcmOptions(AndroidFcmOptions::create()->setAnalyticsLabel('analytics'))
+                    ->setNotification(AndroidNotification::create()->setColor('#4391EA'))
+            )->setApns(
+                ApnsConfig::create()
+                    ->setFcmOptions(ApnsFcmOptions::create()->setAnalyticsLabel('analytics_ios'))
+            );
+
+        return $message;
+    }
+
+    /**
+     * Get the apns message representation of the notification.
+     *
+     * @return array
+     */
+    public function toApn($notifiable)
+    {
+        $message = ApnMessage::create()
+            ->badge(1)
+            ->title('New incoming order!')
+            ->body($this->distance ? 'New order available for pickup about ' . Utils::formatMeters($this->distance, false) . ' away' : 'New order is available for pickup.')
+            ->custom('type', 'order_ping')
+            ->custom('id', $this->order->public_id)
+            ->action('view_order', ['id' => $this->order->public_id]);
+
+        return $message;
+    }
+}

package/server/src/Notifications/OrderSplit.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Fleetbase\FleetOps\Notifications;
+
+use Illuminate\Bus\Queueable;
+// use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+
+class OrderSplit extends Notification
+{
+    use Queueable;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        return ['mail'];
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @return \Illuminate\Notifications\Messages\MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        return (new MailMessage())
+                    ->line('The introduction to the notification.')
+                    ->action('Notification Action', url('/'))
+                    ->line('Thank you for using our application!');
+    }
+
+    /**
+     * Get the array representation of the notification.
+     *
+     * @return array
+     */
+    public function toArray($notifiable)
+    {
+        return [
+        ];
+    }
+}

package/server/src/Observers/DriverObserver.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Models\Driver;
+use Fleetbase\Models\User;
+use Grimzy\LaravelMysqlSpatial\Types\Point;
+
+class DriverObserver
+{
+    /**
+     * Handle the Driver "creating" event.
+     *
+     * @return void
+     */
+    public function creating(Driver $driver)
+    {
+        // if the driver has no default location set one
+        if (empty($driver->location)) {
+            $driver->location = new Point(0, 0);
+        }
+    }
+
+    /**
+     * Handle the Driver "deleted" event.
+     *
+     * @return void
+     */
+    public function deleted(Driver $driver)
+    {
+        // if the driver is deleted, delete their user account assosciated as well
+        User::where(['uuid' => $driver->user_uuid, 'type' => 'driver'])->delete();
+    }
+}

package/server/src/Observers/OrderObserver.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Models\Order;
+
+class OrderObserver
+{
+    /**
+     * Handle the Order "updated" event.
+     *
+     * @return void
+     */
+    public function updated(Order $order)
+    {
+        $order->setDriverLocationAsPickup();
+
+        if ($order->wasChanged('driver_assigned_uuid')) {
+            $order->notifyDriverAssigned();
+        }
+    }
+
+    /**
+     * Handle the Order "deleted" event.
+     *
+     * @return void
+     */
+    public function deleted(Order $order)
+    {
+        if ($order->isIntegratedVendorOrder()) {
+            $order->facilitator->provider()->callback('onDeleted', $order);
+        }
+    }
+}

package/server/src/Observers/PayloadObserver.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Fleetbase\FleetOps\Observers;
+
+use Fleetbase\FleetOps\Models\Payload;
+
+class PayloadObserver
+{
+    /**
+     * Handle the Payload "creating" event.
+     *
+     * @return void
+     */
+    public function created(Payload $payload)
+    {
+        // load the order
+        $payload->updateOrderDistanceAndTime();
+    }
+
+    /**
+     * Handle the Payload "updating" event.
+     *
+     * @return void
+     */
+    public function updating(Payload $payload)
+    {
+        $waypoints = request()->array('payload.waypoints');
+        $payload->updateWaypoints($waypoints);
+    }
+}