@fleetbase/fleetops-engine 0.2.6 → 0.2.8

package/server/src/Models/Vendor.php

@@ -0,0 +1,244 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasInternalId;
+use Fleetbase\Traits\HasPublicId;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\Searchable;
+use Fleetbase\Traits\TracksApiCredential;
+use Illuminate\Notifications\Notifiable;
+use Spatie\Activitylog\Traits\LogsActivity;
+use Spatie\Sluggable\HasSlug;
+use Spatie\Sluggable\SlugOptions;
+
+class Vendor extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use HasApiModelBehavior;
+    use HasInternalId;
+    use TracksApiCredential;
+    use Searchable;
+    use HasSlug;
+    use LogsActivity;
+    use Notifiable;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'vendors';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'vendor';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        '_key',
+        'internal_id',
+        'company_uuid',
+        'logo_uuid',
+        'type_uuid',
+        'connect_company_uuid',
+        'business_id',
+        'name',
+        'email',
+        'website_url',
+        'meta',
+        'callbacks',
+        'phone',
+        'place_uuid',
+        'country',
+        'status',
+        'type',
+        'slug',
+    ];
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = ['name', 'email', 'business_id', 'company.name'];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = ['address', 'address_street', 'logo_url'];
+
+    /**
+     * Filterable params.
+     *
+     * @var array
+     */
+    protected $filterParams = ['customer_type', 'facilitator_type', 'photo_url'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'callbacks' => Json::class,
+        'meta'      => Json::class,
+    ];
+
+    /**
+     * Relationships to auto load with driver.
+     *
+     * @var array
+     */
+    protected $with = ['place'];
+
+    /**
+     * Properties which activity needs to be logged.
+     *
+     * @var array
+     */
+    protected static $logAttributes = ['name', 'email', 'website_url', 'phone', 'country', 'status', 'type', 'logo_uuid', 'company_uuid'];
+
+    /**
+     * Do not log empty changed.
+     *
+     * @var bool
+     */
+    protected static $submitEmptyLogs = false;
+
+    /**
+     * We only want to log changed attributes.
+     *
+     * @var bool
+     */
+    protected static $logOnlyDirty = true;
+
+    /**
+     * The name of the subject to log.
+     *
+     * @var string
+     */
+    protected static $logName = 'vendor';
+
+    /**
+     * Get the options for generating the slug.
+     */
+    public function getSlugOptions(): SlugOptions
+    {
+        return SlugOptions::create()
+            ->generateSlugsFrom('name')
+            ->saveSlugsTo('slug');
+    }
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = ['place'];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function place()
+    {
+        return $this->belongsTo(Place::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function connectCompany()
+    {
+        return $this->belongsTo(\Fleetbase\Models\Company::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function company()
+    {
+        return $this->belongsTo(\Fleetbase\Models\Company::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function logo()
+    {
+        return $this->belongsTo(\Fleetbase\Models\File::class);
+    }
+
+    /**
+     * Get the vendor logo url.
+     *
+     * @return string
+     */
+    public function getLogoUrlAttribute()
+    {
+        return data_get($this, 'logo.url', 'https://s3.ap-southeast-1.amazonaws.com/flb-assets/static/no-avatar.png');
+    }
+
+    /**
+     * Returns the vendors place address.
+     *
+     * @return string
+     */
+    public function getAddressAttribute()
+    {
+        return data_get($this, 'place.address_html');
+    }
+
+    /**
+     * Returns the vendors place address.
+     *
+     * @return string
+     */
+    public function getAddressStreetAttribute()
+    {
+        return data_get($this, 'place.street1');
+    }
+
+    /**
+     * Notify vendor using this column.
+     *
+     * @return mixed|string
+     */
+    public function routeNotificationForTwilio()
+    {
+        return $this->phone;
+    }
+
+    /**
+     * Set the vendor type or default to `vendor`.
+     *
+     * @return void
+     */
+    public function setTypeAttribute(?string $type)
+    {
+        $this->attributes['type'] = $type ?? 'vendor';
+    }
+
+    /**
+     * Set the vendor default status.
+     *
+     * @return void
+     */
+    public function setStatusAttribute(?string $status = 'active')
+    {
+        $this->attributes['status'] = $status ?? 'active';
+    }
+}

package/server/src/Models/Waypoint.php

@@ -0,0 +1,226 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Barryvdh\DomPDF\Facade\Pdf;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\FleetOps\Traits\HasTrackingNumber;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasPublicId;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\TracksApiCredential;
+use Illuminate\Support\Carbon;
+
+class Waypoint extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use TracksApiCredential;
+    use HasTrackingNumber;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'waypoints';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'waypoint';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['_key', 'company_uuid', 'place_uuid', 'tracking_number_uuid', '_import_id', 'payload_uuid', 'type', 'order'];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = ['status', 'status_code', 'tracking'];
+
+    /**
+     * Relationships to always append to model.
+     *
+     * @var array
+     */
+    protected $with = ['place'];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = [];
+
+    /**
+     * The pdf source stream for label.
+     */
+    public function pdfLabel()
+    {
+        return Pdf::loadHTML($this->label());
+    }
+
+    /**
+     * The pdf source stream for label.
+     */
+    public function pdfLabelStream()
+    {
+        return $this->pdfLabel()->stream();
+    }
+
+    /**
+     * The html for the shipment label.
+     */
+    public function label()
+    {
+        $this->load(['trackingNumber', 'company', 'place']);
+
+        return view('labels/default', [
+            'order'          => $this,
+            'dropoff'        => $this->place,
+            'trackingNumber' => $this->trackingNumber,
+            'company'        => $this->company,
+        ])->render();
+    }
+
+    /**
+     * Place assosciated to order.
+     *
+     * @var Model
+     */
+    public function place()
+    {
+        return $this->belongsTo(Place::class);
+    }
+
+    /**
+     * Tracking Number assosciated to waypoint.
+     *
+     * @var Model
+     */
+    public function trackingNumber()
+    {
+        return $this->belongsTo(TrackingNumber::class);
+    }
+
+    /**
+     * The proofs for this order.
+     */
+    public function proofs()
+    {
+        return $this->hasMany(Proof::class, 'subject_uuid');
+    }
+
+    /**
+     * Payload assosciated to waypoint.
+     *
+     * @var Model
+     */
+    public function payload()
+    {
+        return $this->belongsTo(Payload::class);
+    }
+
+    /**
+     * The company who manages this waypoint.
+     *
+     * @var Model
+     */
+    public function company()
+    {
+        return $this->belongsTo(\Fleetbase\Models\Company::class);
+    }
+
+    /**
+     * Waypoint has completed instance.
+     *
+     * @var Model
+     */
+    public function completed()
+    {
+        return $this->hasOne(WaypointCompleted::class, 'place_uuid', 'place_uuid')->where('payload_uuid', $this->payload_uuid);
+    }
+
+    /**
+     * The tracking number for waypoint.
+     */
+    public function getTrackingAttribute()
+    {
+        return data_get($this, 'trackingNumber.tracking_number');
+    }
+
+    /**
+     * The latest tracking status for waypoint.
+     */
+    public function getStatusAttribute()
+    {
+        return data_get($this, 'trackingNumber.last_status');
+    }
+
+    /**
+     * The latest tracking status code for waypoint.
+     */
+    public function getStatusCodeAttribute()
+    {
+        return data_get($this, 'trackingNumber.last_status_code');
+    }
+
+    public static function insertGetUuid($values = [], Payload $payload = null)
+    {
+        $instance   = new static();
+        $fillable   = $instance->getFillable();
+        $insertKeys = array_keys($values);
+        // clean insert data
+        foreach ($insertKeys as $key) {
+            if (!in_array($key, $fillable)) {
+                unset($values[$key]);
+            }
+        }
+
+        $values['uuid']         = $uuid = static::generateUuid();
+        $values['public_id']    = static::generatePublicId('waypoint');
+        $values['_key']         = session('api_key') ?? 'console';
+        $values['created_at']   = Carbon::now()->toDateTimeString();
+        $values['company_uuid'] = session('company');
+
+        if ($payload) {
+            $values['payload_uuid'] = $payload->uuid;
+        }
+
+        if (isset($values['meta']) && (is_object($values['meta']) || is_array($values['meta']))) {
+            $values['meta'] = json_encode($values['meta']);
+        }
+
+        $result = static::insert($values);
+
+        if ($result && $payload) {
+            // create tracking number for entity
+            $trackingNumberId = TrackingNumber::insertGetUuid([
+                'owner_uuid' => $uuid,
+                'owner_type' => Utils::getModelClassName('waypoint'),
+                'region'     => $payload->getPickupRegion(),
+                'location'   => Utils::parsePointToWkt($payload->getPickupLocation()),
+            ]);
+
+            // set tracking number
+            static::where('uuid', $uuid)->update(['tracking_number_uuid' => $trackingNumberId]);
+        }
+
+        return $result ? $uuid : false;
+    }
+}

package/server/src/Models/Zone.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\FleetOps\Casts\Polygon;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasPublicId;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\SendsWebhooks;
+use Fleetbase\Traits\TracksApiCredential;
+use Grimzy\LaravelMysqlSpatial\Eloquent\SpatialTrait;
+
+class Zone extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use SendsWebhooks;
+    use TracksApiCredential;
+    use SpatialTrait;
+    use HasApiModelBehavior;
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'zone';
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'zones';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are spatial columns.
+     *
+     * @var array
+     */
+    protected $spatialFields = ['border'];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['_key', 'company_uuid', 'service_area_uuid', 'name', 'description', 'border', 'color', 'stroke_color', 'status'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'border' => Polygon::class,
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = ['type'];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = [];
+
+    /**
+     * Service area for rate.
+     *
+     * @var Model
+     */
+    public function serviceArea()
+    {
+        return $this->belongsTo(ServiceArea::class);
+    }
+
+    public function getTypeAttribute()
+    {
+        return 'zone';
+    }
+}

package/server/src/Notifications/OrderAssigned.php

@@ -0,0 +1,140 @@
+<?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 OrderAssigned 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('New order ' . $this->order->public_id . ' assigned!')
+            ->line('New order ' . $this->order->public_id . ' has been assigned to you.');
+
+        if ($this->order->isScheduled) {
+            $message->line('Dispatch is scheduled for ' . $this->order->scheduled_at);
+        }
+
+        $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('New order ' . $this->order->public_id . ' assigned!')
+            ->setBody('You have a new order assigned, tap for details.');
+
+        if ($this->order->isScheduled) {
+            $notification->setBody('You have a new order scheduled for ' . $this->order->scheduled_at);
+        }
+
+        $message = FcmMessage::create()
+            ->setData(['id' => $this->order->public_id, 'type' => 'order_assigned'])
+            ->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 order ' . $this->order->public_id . ' assigned!')
+            ->body('You have a new order assigned, tap for details.')
+            ->custom('type', 'order_assigned')
+            ->custom('id', $this->order->public_id)
+            ->action('view_order', ['id' => $this->order->public_id]);
+
+        if ($this->order->isScheduled) {
+            $message->body('You have a new order scheduled for ' . $this->order->scheduled_at);
+        }
+
+        return $message;
+    }
+}