@fleetbase/fleetops-engine 0.2.5 → 0.2.7

package/server/src/Models/ServiceRateFee.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\TracksApiCredential;
+
+class ServiceRateFee extends Model
+{
+    use HasUuid;
+    use TracksApiCredential;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'service_rate_fees';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['_key', 'service_rate_uuid', 'distance', 'distance_unit', 'min', 'max', 'unit', 'fee', 'currency'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'min'      => 'integer',
+        'max'      => 'integer',
+        'fee'      => 'integer',
+        'distance' => 'integer',
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = [];
+
+    public static function onRowInsert($row)
+    {
+        $row['fee']      = Utils::numbersOnly($row['fee'] ?? null);
+        $row['distance'] = Utils::numbersOnly($row['distance'] ?? null);
+        $row['min']      = Utils::numbersOnly($row['min'] ?? null);
+        $row['max']      = Utils::numbersOnly($row['max'] ?? null);
+
+        return $row;
+    }
+
+    /**
+     * Set the fee as only numbers.
+     *
+     * @void
+     */
+    public function setFeeAttribute($value)
+    {
+        $this->attributes['fee'] = Utils::numbersOnly($value);
+    }
+
+    /**
+     * Set the distance as numbers only.
+     *
+     * @void
+     */
+    public function setDistanceAttribute($value)
+    {
+        $this->attributes['distance'] = Utils::numbersOnly($value);
+    }
+
+    public function isWithinMinMax(int $number = 0): bool
+    {
+        return $number >= $this->min && $number <= $this->max;
+    }
+}

package/server/src/Models/ServiceRateParcelFee.php

@@ -0,0 +1,116 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\Casts\Money;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasUuid;
+use PhpUnitsOfMeasure\PhysicalQuantity\Length;
+use PhpUnitsOfMeasure\PhysicalQuantity\Mass;
+
+class ServiceRateParcelFee extends Model
+{
+    use HasUuid;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'service_rate_parcel_fees';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['_key', 'service_rate_uuid', 'size', 'length', 'width', 'height', 'dimensions_unit', 'weight', 'weight_unit', 'fee', 'currency'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'fee' => Money::class,
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = [];
+
+    public static function onRowInsert($row)
+    {
+        $row['fee'] = Utils::numbersOnly($row['fee']);
+
+        return $row;
+    }
+
+    /**
+     * Set the fee as only numbers.
+     *
+     * @void
+     */
+    public function setFeeAttribute($value)
+    {
+        $this->attributes['fee'] = Utils::numbersOnly($value);
+    }
+
+    /**
+     * 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);
+    }
+}

package/server/src/Models/TrackingNumber.php

@@ -0,0 +1,310 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\FleetOps\Casts\Point;
+use Fleetbase\FleetOps\Support\Utils;
+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;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Str;
+use Milon\Barcode\Facades\DNS2DFacade as DNS2D;
+
+class TrackingNumber extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use HasApiModelBehavior;
+    use SendsWebhooks;
+    use TracksApiCredential;
+    use SpatialTrait;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'tracking_numbers';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'track';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['_key', 'company_uuid', 'tracking_number', 'owner_uuid', 'owner_type', 'region', 'qr_code', 'barcode', 'status_uuid'];
+
+    /**
+     * The attributes that are spatial columns.
+     *
+     * @var array
+     */
+    protected $spatialFields = ['location'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'location' => Point::class,
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = ['last_status', 'last_status_code', 'last_status_updated_at', 'type'];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = ['status'];
+
+    /**
+     * Tracking number status.
+     */
+    public function getLastStatusAttribute()
+    {
+        return $this->status->status;
+    }
+
+    /**
+     * Tracking number status code.
+     */
+    public function getLastStatusCodeAttribute()
+    {
+        return $this->status->code;
+    }
+
+    /**
+     * Datetime of last status update.
+     */
+    public function getLastStatusUpdatedAtAttribute()
+    {
+        return $this->status->created_at;
+    }
+
+    /**
+     * Get the service details.
+     *
+     * @var Model
+     */
+    public function status()
+    {
+        return $this->hasOne(TrackingStatus::class)->latest()->without(['trackingNumber']);
+    }
+
+    /**
+     * Tracking statuses by this tracking number.
+     *
+     * @var Model
+     */
+    public function statuses()
+    {
+        return $this->hasMany(TrackingStatus::class)->without(['trackingNumber']);
+    }
+
+    /**
+     * Get the order status belongss to.
+     *
+     * @var Model
+     */
+    public function order()
+    {
+        return $this->belongsTo(Order::class, 'owner_uuid');
+    }
+
+    /**
+     * Get the entity tracking number belongss to.
+     *
+     * @var Model
+     */
+    public function entity()
+    {
+        return $this->belongsTo(Entity::class, 'owner_uuid');
+    }
+
+    /**
+     * Get the tracking number owner, could be order or entity.
+     *
+     * @var Model
+     */
+    public function owner()
+    {
+        return $this->morphTo(__FUNCTION__, 'owner_type', 'owner_uuid')->withoutGlobalScopes();
+    }
+
+    /**
+     * Get the tracking number type.
+     *
+     * @var Model
+     */
+    public function getTypeAttribute()
+    {
+        return Utils::getTypeFromClassName($this->owner_type);
+    }
+
+    /**
+     * Generates a fleetbase tracking number.
+     *
+     * @var array
+     */
+    public static function generateTrackingNumber($region = 'SG', $length = 10)
+    {
+        $company     = \Fleetbase\Models\Company::where('uuid', session('company'))->withoutGlobalScopes()->first();
+        $companyName = $company ? strtoupper(substr($company->name, 0, 3)) : null;
+        $number      = $companyName ?? 'FLB';
+
+        for ($i = 0; $i < $length; $i++) {
+            $number .= mt_rand(0, 9);
+        }
+
+        return $number . strtoupper($region);
+    }
+
+    /**
+     * Generates a unique fleetbase tracking number.
+     *
+     * @var array
+     */
+    public static function generateNumber($region = 'SG', $length = 10)
+    {
+        $n  = static::generateTrackingNumber($region, $length);
+        $tr = static::where('tracking_number', $n)
+            ->withTrashed()
+            ->first();
+        while (is_object($tr) && $n == $tr->tracking_number) {
+            $n = static::generateTrackingNumber($region, $length);
+        }
+
+        return $n;
+    }
+
+    /**
+     * Find a model by its public_id key or throw an exception.
+     *
+     * @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection|static|static[]
+     *
+     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
+     */
+    public static function findTrackingOrFail($id)
+    {
+        $result = static::query()
+            ->select(['*'])
+            ->with(['status'])
+            ->where(function ($q) use ($id) {
+                $q->where('public_id', $id);
+                $q->orWhere('tracking_number', $id);
+                $q->orWhere('uuid', $id);
+            })
+            ->first();
+
+        if (!is_null($result)) {
+            return $result;
+        }
+
+        throw (new \Illuminate\Database\Eloquent\ModelNotFoundException())->setModel(static::class, $id);
+    }
+
+    public function updateOwnerStatus(TrackingStatus $trackingStatus = null)
+    {
+        $trackingStatus = $trackingStatus ?? $this->load(['status'])->getRelationValue('status');
+        // update status on owner
+        $status = strtolower($trackingStatus->code);
+        $owner  = $this->load(['owner'])->getRelationValue('owner');
+
+        if ($owner && $owner->isFillable('status') && $owner->status !== $status) {
+            $this->owner->status = $status;
+
+            $this->owner->save();
+        }
+
+        return $this;
+    }
+
+    public static function insertGetUuid($values = [], Model $owner = 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('track');
+        $values['_key']         = session('api_key') ?? 'console';
+        $values['created_at']   = Carbon::now()->toDateTimeString();
+        $values['company_uuid'] = session('company');
+
+        if ($owner) {
+            $values['owner_uuid'] = $owner->uuid;
+            $values['owner_type'] = Utils::getMutationType($owner);
+        }
+
+        $values['tracking_number'] = TrackingNumber::generateNumber($values['region'] ?? 'SG');
+        $values['qr_code']         = DNS2D::getBarcodePNG($values['owner_uuid'], 'QRCODE');
+        $values['barcode']         = DNS2D::getBarcodePNG($values['owner_uuid'], 'PDF417');
+
+        if (isset($values['meta']) && (is_object($values['meta']) || is_array($values['meta']))) {
+            $values['meta'] = json_encode($values['meta']);
+        }
+
+        $result = static::insert($values);
+
+        if (!$result) {
+            return false;
+        }
+
+        $ownerTypeName = class_basename($values['owner_type']);
+
+        // create initial status
+        $trackingStatusId = TrackingStatus::insertGetUuid([
+            'tracking_number_uuid' => $uuid,
+            'status'               => Str::title($ownerTypeName . ' created'),
+            'details'              => 'New ' . Str::lower($ownerTypeName) . ' created.',
+            'location'             => $values['location'] ?? Utils::parsePointToWkt(new Point(0, 0)),
+            'code'                 => 'CREATED',
+        ]);
+
+        // update status of tracking number
+        TrackingNumber::where('uuid', $uuid)->update(['status_uuid' => $trackingStatusId]);
+
+        // update owner status
+        if ($owner && $owner instanceof Model && $owner->isFillable('status')) {
+            // runs event cycles
+            // $model->update([ 'status' => 'created' ]);
+
+            // silent update
+            DB::table($owner->getTable())->where('uuid', $owner->uuid)->update(['status' => 'created']);
+        }
+
+        return $uuid;
+    }
+}

package/server/src/Models/TrackingStatus.php

@@ -0,0 +1,177 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasMetaAttributes;
+use Fleetbase\Traits\HasPublicId;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\SendsWebhooks;
+use Fleetbase\Traits\TracksApiCredential;
+use Grimzy\LaravelMysqlSpatial\Eloquent\SpatialTrait;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Str;
+
+class TrackingStatus extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use HasApiModelBehavior;
+    use HasMetaAttributes;
+    use SendsWebhooks;
+    use TracksApiCredential;
+    use SpatialTrait;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'tracking_statuses';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'status';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        '_key',
+        'company_uuid',
+        'tracking_number_uuid',
+        'proof_uuid',
+        'status',
+        'details',
+        'code',
+        'city',
+        'province',
+        'postal_code',
+        'country',
+        'location',
+    ];
+
+    /**
+     * The attributes that are spatial columns.
+     *
+     * @var array
+     */
+    protected $spatialFields = [
+        'location',
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'meta' => Json::class,
+        // 'location' => Point::class,
+    ];
+
+    /**
+     * Attributes that is filterable on this model.
+     *
+     * @var array
+     */
+    protected $filterParams = [
+        'order',
+        'entity',
+    ];
+
+    /**
+     * 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 tracking number.
+     *
+     * @var Model
+     */
+    public function trackingNumber()
+    {
+        return $this->belongsTo(TrackingNumber::class);
+    }
+
+    /**
+     * The proof if any.
+     *
+     * @var Model
+     */
+    public function proof()
+    {
+        return $this->belongsTo(Proof::class);
+    }
+
+    public function setCodeAttribute($code)
+    {
+        $this->attributes['code'] = static::prepareCode($code);
+    }
+
+    public static function prepareCode($string)
+    {
+        $string = str_replace(' ', '_', $string);
+        $string = preg_replace('/[^A-Za-z0-9\-]/', '', $string);
+        $string = strtoupper($string);
+
+        return $string;
+    }
+
+    public static function insertGetUuid($values = [], TrackingNumber $trackingNumber = 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 = (string) Str::uuid();
+        $values['public_id']    = static::generatePublicId('status');
+        $values['_key']         = session('api_key') ?? 'console';
+        $values['created_at']   = Carbon::now()->toDateTimeString();
+        $values['company_uuid'] = session('company');
+
+        if ($trackingNumber) {
+            $values['tracking_number_uuid'] = $trackingNumber->uuid;
+            $values['status']               = Str::title($trackingNumber->type . ' created');
+            $values['details']              = 'New ' . Str::lower($trackingNumber->type) . ' created.';
+        }
+
+        if (isset($values['meta']) && (is_object($values['meta']) || is_array($values['meta']))) {
+            $values['meta'] = json_encode($values['meta']);
+        }
+
+        $result = static::insert($values);
+
+        return $result ? $uuid : false;
+    }
+}