@fleetbase/fleetops-engine 0.2.6 → 0.2.7

package/server/src/Models/Entity.php

@@ -0,0 +1,416 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Barryvdh\DomPDF\Facade\Pdf;
+use Fleetbase\Casts\Json;
+use Fleetbase\Casts\PolymorphicType;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\FleetOps\Traits\HasTrackingNumber;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasInternalId;
+use Fleetbase\Traits\HasMetaAttributes;
+use Fleetbase\Traits\HasPublicId;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\SendsWebhooks;
+use Fleetbase\Traits\TracksApiCredential;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Str;
+use Milon\Barcode\Facades\DNS2DFacade as DNS2D;
+use PhpUnitsOfMeasure\PhysicalQuantity\Length;
+use PhpUnitsOfMeasure\PhysicalQuantity\Mass;
+
+class Entity extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use HasInternalId;
+    use TracksApiCredential;
+    use SendsWebhooks;
+    use HasTrackingNumber;
+    use HasApiModelBehavior;
+    use HasMetaAttributes;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'entities';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'entity';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        '_key',
+        'public_id',
+        'payload_uuid',
+        'company_uuid',
+        'driver_assigned_uuid',
+        'customer_uuid',
+        'customer_type',
+        'tracking_number_uuid',
+        'destination_uuid',
+        'photo_uuid',
+        '_import_id',
+        'internal_id',
+        'name',
+        'type',
+        'description',
+        'currency',
+        'barcode',
+        'qr_code',
+        'weight',
+        'weight_unit',
+        'length',
+        'width',
+        'height',
+        'dimensions_unit',
+        'declared_value',
+        'sku',
+        'price',
+        'sale_price',
+        'meta',
+        'slug',
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = ['customer_is_vendor', 'customer_is_contact', 'tracking', 'status', 'photo_url'];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = ['trackingNumber'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'meta'          => Json::class,
+        'customer_type' => PolymorphicType::class,
+    ];
+
+    /**
+     * Generates QR Code & Barcode on creation.
+     *
+     * @return void
+     */
+    public static function boot()
+    {
+        parent::boot();
+        static::creating(function ($model) {
+            $model->qr_code = DNS2D::getBarcodePNG($model->uuid, 'QRCODE');
+            $model->barcode = DNS2D::getBarcodePNG($model->uuid, 'PDF417');
+        });
+    }
+
+    /**
+     * 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', 'destination']);
+
+        return view('labels/default', [
+            'dropoff'        => $this->destination,
+            'trackingNumber' => $this->trackingNumber,
+            'company'        => $this->company,
+        ])->render();
+    }
+
+    /**
+     * Photo of entity belongs to.
+     *
+     * @var Model
+     */
+    public function photo()
+    {
+        return $this->belongsTo(\Fleetbase\Models\File::class);
+    }
+
+    /**
+     * Files assosciated with entity.
+     *
+     * @var Model
+     */
+    public function files()
+    {
+        return $this->hasMany(\Fleetbase\Models\File::class);
+    }
+
+    /**
+     * The proofs for this order.
+     */
+    public function proofs()
+    {
+        return $this->hasMany(Proof::class, 'subject_uuid');
+    }
+
+    /**
+     * The entity destination.
+     *
+     * @var Model
+     */
+    public function destination()
+    {
+        return $this->belongsTo(Place::class);
+    }
+
+    /**
+     * Payload entity belongs to.
+     *
+     * @var Model
+     */
+    public function payload()
+    {
+        return $this->belongsTo(Payload::class);
+    }
+
+    /**
+     * Driver assigned to order.
+     *
+     * @var Model
+     */
+    public function driver()
+    {
+        return $this->belongsTo(Driver::class, 'driver_assigned_uuid');
+    }
+
+    /**
+     * The company who manages this order.
+     *
+     * @var Model
+     */
+    public function company()
+    {
+        return $this->belongsTo(\Fleetbase\Models\Company::class);
+    }
+
+    /**
+     * The tracking number assosicated to the entity.
+     */
+    public function trackingNumber()
+    {
+        return $this->belongsTo(TrackingNumber::class);
+    }
+
+    /**
+     * The customer of this order.
+     *
+     * @var Model
+     */
+    public function customer()
+    {
+        return $this->morphTo(__FUNCTION__, 'customer_type', 'customer_uuid')->withoutGlobalScopes();
+    }
+
+    /**
+     * Get avatar URL attribute.
+     *
+     * @return string
+     */
+    public function getPhotoUrlAttribute()
+    {
+        return data_get($this, 'photo.s3url', 'https://s3.ap-southeast-1.amazonaws.com/flb-assets/static/parcels/medium.png');
+    }
+
+    /**
+     * True of the customer is a vendor `customer_is_vendor`.
+     *
+     * @var bool
+     */
+    public function getCustomerIsVendorAttribute()
+    {
+        return Str::contains(strtolower($this->customer_type), 'vendor');
+    }
+
+    /**
+     * True of the customer is a contact `customer_is_contact`.
+     *
+     * @var bool
+     */
+    public function getCustomerIsContactAttribute()
+    {
+        return Str::contains(strtolower($this->customer_type), 'contact');
+    }
+
+    /**
+     * The length the entity belongs to.
+     *
+     * @var PhpUnitsOfMeasure\PhysicalQuantity\Length
+     */
+    public function getLengthUnitAttribute()
+    {
+        return new Length($this->length, $this->dimensions_unit);
+    }
+
+    /**
+     * The width the entity belongs to.
+     *
+     * @var PhpUnitsOfMeasure\PhysicalQuantity\Length
+     */
+    public function getWidthUnitAttribute()
+    {
+        return new Length($this->width, $this->dimensions_unit);
+    }
+
+    /**
+     * The height the entity belongs to.
+     *
+     * @var PhpUnitsOfMeasure\PhysicalQuantity\Length
+     */
+    public function getHeightUnitAttribute()
+    {
+        return new Length($this->height, $this->dimensions_unit);
+    }
+
+    /**
+     * The weight the entity belongs to.
+     *
+     * @var PhpUnitsOfMeasure\PhysicalQuantity\Mass
+     */
+    public function getMassUnitAttribute()
+    {
+        return new Mass($this->weight, $this->weight_unit);
+    }
+
+    /**
+     * Always convert price to integer.
+     */
+    public function setPriceAttribute($value)
+    {
+        $this->attributes['price'] = Utils::numbersOnly($value);
+    }
+
+    /**
+     * Always convert sale price to integer.
+     */
+    public function setSalePriceAttribute($value)
+    {
+        $this->attributes['sale_price'] = Utils::numbersOnly($value);
+    }
+
+    /**
+     * Always convert declared value to integer.
+     */
+    public function setDeclaredValueAttribute($value)
+    {
+        $this->attributes['declared_value'] = Utils::numbersOnly($value);
+    }
+
+    /**
+     * The tracking number for the entity.
+     */
+    public function getTrackingAttribute()
+    {
+        return data_get($this, 'trackingNumber.tracking_number');
+    }
+
+    /**
+     * The latest tracking status for entity.
+     */
+    public function getStatusAttribute()
+    {
+        return data_get($this, 'trackingNumber.last_status');
+    }
+
+    public static function insertGetUuid($values = [], Payload $payload = null)
+    {
+        if (is_array($values) && isset($values['uuid'])) {
+            Entity::where('uuid', $values['uuid'])->update([
+                'payload_uuid' => $payload->uuid,
+            ]);
+
+            return $values['uuid'];
+        }
+
+        $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('entity');
+        $values['internal_id']  = static::generateInternalId();
+        $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('entity'),
+                'region'     => $payload->getPickupRegion(),
+                'location'   => Utils::parsePointToWkt($payload->getPickupLocation()),
+            ]);
+
+            // set tracking number
+            static::where('uuid', $uuid)->update(['tracking_number_uuid' => $trackingNumberId]);
+        }
+
+        return $result ? $uuid : false;
+    }
+
+    public function setCustomer($model)
+    {
+        $this->customer_uuid = $model->uuid;
+        $this->customer_type = Utils::getMutationType($model);
+    }
+}

package/server/src/Models/Fleet.php

@@ -0,0 +1,203 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasPublicId;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\Searchable;
+use Fleetbase\Traits\SendsWebhooks;
+use Fleetbase\Traits\TracksApiCredential;
+use Spatie\Activitylog\Traits\LogsActivity;
+use Spatie\Sluggable\HasSlug;
+use Spatie\Sluggable\SlugOptions;
+
+class Fleet extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use HasApiModelBehavior;
+    use TracksApiCredential;
+    use SendsWebhooks;
+    use Searchable;
+    use HasSlug;
+    use LogsActivity;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'fleets';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'fleet';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = ['name'];
+
+    /**
+     * Properties which activity needs to be logged.
+     *
+     * @var array
+     */
+    protected static $logAttributes = ['name', 'task', 'service_area_uuid', 'zone_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 = 'fleet';
+
+    public function getSlugOptions(): SlugOptions
+    {
+        return SlugOptions::create()
+            ->generateSlugsFrom('name')
+            ->saveSlugsTo('slug');
+    }
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        '_key',
+        'public_id',
+        'company_uuid',
+        'service_area_uuid',
+        'zone_uuid',
+        'vendor_uuid',
+        'parent_fleet_uuid',
+        'image_uuid',
+        'name',
+        'color',
+        'task',
+        'status',
+        'slug',
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = ['photo_url', 'drivers_count', 'drivers_online_count'];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = [];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function photo()
+    {
+        return $this->belongsTo(\Fleetbase\Models\File::class, 'image_uuid', 'uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function serviceArea()
+    {
+        return $this->belongsTo(ServiceArea::class)->select(['uuid', 'public_id', 'name', 'type', 'border']);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function zone()
+    {
+        return $this->belongsTo(Zone::class)->select(['uuid', 'public_id', 'name', 'border']);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function vendor()
+    {
+        return $this->belongsTo(Vendor::class)->select(['uuid', 'public_id', 'name']);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function parentFleet()
+    {
+        return $this->belongsTo(Fleet::class)->select(['uuid', 'public_id', 'name']);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasManyThrough
+     */
+    public function drivers()
+    {
+        return $this->hasManyThrough(Driver::class, FleetDriver::class, 'fleet_uuid', 'uuid', 'uuid', 'driver_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasManyThrough
+     */
+    public function vehicles()
+    {
+        return $this->hasManyThrough(Vehicle::class, FleetVehicle::class, 'fleet_uuid', 'uuid', 'uuid', 'vehicle_uuid');
+    }
+
+    /**
+     * Get avatar URL attribute.
+     *
+     * @return string
+     */
+    public function getPhotoUrlAttribute()
+    {
+        return data_get($this, 'photo.s3url', 'https://s3.ap-northeast-2.amazonaws.com/fleetbase/public/default-fleet.png');
+    }
+
+    /**
+     * Get the number of drivers in fleet.
+     *
+     * @return int
+     */
+    public function getDriversCountAttribute()
+    {
+        return $this->drivers()->count();
+    }
+
+    /**
+     * Get the number of drivers in fleet.
+     *
+     * @return int
+     */
+    public function getDriversOnlineCountAttribute()
+    {
+        return $this->drivers()->where('online', 1)->count();
+    }
+}

package/server/src/Models/FleetDriver.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasUuid;
+
+class FleetDriver extends Model
+{
+    use HasUuid;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'fleet_drivers';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['fleet_uuid', 'driver_uuid'];
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * also search joined properties.
+     *
+     * @var array
+     */
+    protected $alsoSearch = [['driver' => ['user' => 'name']]];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = [];
+
+    /**
+     * The group of the membership.
+     *
+     * @var Model
+     */
+    public function fleet()
+    {
+        return $this->belongsTo(Fleet::class);
+    }
+
+    /**
+     * The driver.
+     *
+     * @var Model
+     */
+    public function driver()
+    {
+        return $this->belongsTo(Driver::class);
+    }
+}