@fleetbase/fleetops-engine 0.2.5 → 0.2.7

package/server/src/Models/Position.php

@@ -0,0 +1,119 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\TracksApiCredential;
+use Grimzy\LaravelMysqlSpatial\Eloquent\SpatialTrait;
+
+class Position extends Model
+{
+    use HasUuid;
+    use TracksApiCredential;
+    use HasApiModelBehavior;
+    use SpatialTrait;
+
+    /**
+     * The database connection to use.
+     *
+     * @var string
+     */
+    protected $connection = 'mysql';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['uuid', 'company_uuid', 'order_uuid', 'destination_uuid', 'subject_uuid', 'subject_type', 'coordinates', 'heading', 'bearing', 'speed', 'altitude'];
+
+    /**
+     * The attributes that are spatial fields.
+     *
+     * @var array
+     */
+    protected $spatialFields = ['coordinates'];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $with = [];
+
+    /**
+     * Dynamic attributes.
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /**
+     * Get filter parameters for this model.
+     *
+     * @var array
+     */
+    protected $filterParams = [];
+
+    /**
+     * Properties which activity needs to be logged.
+     *
+     * @var array
+     */
+    protected static $logAttributes = ['coordinates', 'heading', 'bearing', 'speed', 'altitude'];
+
+    /**
+     * We only want to log changed attributes.
+     *
+     * @var bool
+     */
+    protected static $logOnlyDirty = true;
+
+    /**
+     * Do not log empty changed.
+     *
+     * @var bool
+     */
+    protected static $submitEmptyLogs = false;
+
+    /**
+     * The name of the subject to log.
+     *
+     * @var string
+     */
+    protected static $logName = 'position';
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function company()
+    {
+        return $this->belongsTo(\Fleetbase\Models\Company::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function order()
+    {
+        return $this->belongsTo(Order::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function destination()
+    {
+        return $this->belongsTo(Place::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
+     */
+    public function subject()
+    {
+        return $this->morphTo(__FUNCTION__, 'subject_type', 'subject_uuid')->withoutGlobalScopes();
+    }
+}

package/server/src/Models/Proof.php

@@ -0,0 +1,94 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasPublicId;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\TracksApiCredential;
+
+class Proof extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use HasApiModelBehavior;
+    use TracksApiCredential;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'proofs';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'proof';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['company_uuid', 'file_uuid', 'order_uuid', 'subject_uuid', 'subject_type', 'remarks', 'raw_data', 'data'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'data' => Json::class,
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = ['file_url'];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = [];
+
+    /**
+     * The image file assosciated with the proof.
+     */
+    public function file()
+    {
+        return $this->belongsTo(\Fleetbase\Models\File::class);
+    }
+
+    /**
+     * The order proof was added to.
+     */
+    public function order()
+    {
+        return $this->belongsTo(Order::class);
+    }
+
+    /**
+     * Get avatar URL attribute.
+     */
+    public function getFileUrlAttribute()
+    {
+        return $this->fromCache('file.s3url', null);
+    }
+
+    /**
+     * Subject proof is for.
+     */
+    public function subject()
+    {
+        return $this->morphTo(__FUNCTION__, 'subject_type', 'subject_uuid')->withoutGlobalScopes();
+    }
+}

package/server/src/Models/PurchaseRate.php

@@ -0,0 +1,208 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\FleetOps\Support\Utils;
+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 Illuminate\Http\Request;
+use Illuminate\Support\Str;
+
+class PurchaseRate extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use SendsWebhooks;
+    use TracksApiCredential;
+    use HasMetaAttributes;
+    use HasApiModelBehavior;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'purchase_rates';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'rate';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['_key', 'customer_uuid', 'customer_type', 'company_uuid', 'service_quote_uuid', 'transaction_uuid', 'payload_uuid', 'status', 'meta'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'meta' => Json::class,
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = ['customer_is_vendor', 'customer_is_contact', 'amount', 'currency', 'service_quote_id', 'order_id', 'transaction_id', 'customer_id'];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = [];
+
+    /**
+     * Order rate was purchased for.
+     *
+     * @var Model
+     */
+    public function order()
+    {
+        return $this->hasOne(Order::class);
+    }
+
+    /**
+     * Service quote for purchased rate.
+     *
+     * @var Model
+     */
+    public function serviceQuote()
+    {
+        return $this->belongsTo(ServiceQuote::class);
+    }
+
+    /**
+     * Transaction for purchased rate.
+     *
+     * @var Model
+     */
+    public function transaction()
+    {
+        return $this->belongsTo(\Fleetbase\Models\Transaction::class);
+    }
+
+    /**
+     * Payload for the order.
+     *
+     * @var Model
+     */
+    public function payload()
+    {
+        return $this->belongsTo(Payload::class);
+    }
+
+    /**
+     * Company who owns the order.
+     *
+     * @var Model
+     */
+    public function company()
+    {
+        return $this->belongsTo(\Fleetbase\Models\Company::class);
+    }
+
+    /**
+     * The customer if any for this place.
+     *
+     * @var Model
+     */
+    public function customer()
+    {
+        return $this->morphTo(__FUNCTION__, 'customer_type', 'customer_uuid');
+    }
+
+    /**
+     * 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');
+    }
+
+    public function getAmountAttribute()
+    {
+        return data_get($this, 'serviceQuote.amount');
+    }
+
+    public function getCurrencyAttribute()
+    {
+        return data_get($this, 'serviceQuote.currency');
+    }
+
+    public function getServiceQuoteIdAttribute()
+    {
+        return data_get($this, 'serviceQuote.public_id');
+    }
+
+    public function getOrderIdAttribute()
+    {
+        return data_get($this, 'order.public_id');
+    }
+
+    public function getCustomerIdAttribute()
+    {
+        return data_get($this, 'customer.public_id');
+    }
+
+    public function getTransactionIdAttribute()
+    {
+        return data_get($this, 'transaction.public_id');
+    }
+
+    /**
+     * @return \Fleetbase\Models\PurchaseRate|null
+     */
+    public static function resolveFromRequest(Request $request): ?PurchaseRate
+    {
+        $purchaseRate = $request->or(['order.purchase_rate_uuid', 'purchase_rate', 'purchase_rate_id', 'order.purchase_rate']);
+
+        if (empty($purchaseRate)) {
+            return null;
+        }
+
+        if (Utils::isUuid($purchaseRate)) {
+            $purchaseRate = static::where('uuid', $purchaseRate)->first();
+        }
+
+        if (Utils::isPublicId($purchaseRate)) {
+            $purchaseRate = static::where('public_id', $purchaseRate)->first();
+        }
+
+        return $purchaseRate;
+    }
+}

package/server/src/Models/Route.php

@@ -0,0 +1,128 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\Model;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\TracksApiCredential;
+
+class Route extends Model
+{
+    use HasUuid;
+    use TracksApiCredential;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'routes';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['_key', 'company_uuid', 'order_uuid', 'details', 'total_time', 'total_distance'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'details' => Json::class,
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object.
+     *
+     * @var array
+     */
+    protected $appends = ['payload', 'driver', 'order_status', 'order_public_id', 'order_internal_id', 'order_dispatched_at'];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = ['order'];
+
+    /**
+     * Order for this Route.
+     *
+     * @var Model
+     */
+    public function order()
+    {
+        return $this->belongsTo(Order::class);
+    }
+
+    /**
+     * Payload for this routes order.
+     *
+     * @var Model
+     */
+    public function getPayloadAttribute()
+    {
+        return data_get($this, 'order.payload');
+    }
+
+    /**
+     * Driver for this routes order.
+     *
+     * @var Model
+     */
+    public function getDriverAttribute()
+    {
+        return data_get($this, 'order.driverAssigned');
+    }
+
+    /**
+     * Order status for this route.
+     *
+     * @var string
+     */
+    public function getOrderStatusAttribute()
+    {
+        return data_get($this, 'order.status');
+    }
+
+    /**
+     * Order id for this route.
+     *
+     * @var string
+     */
+    public function getOrderPublicIdAttribute()
+    {
+        return data_get($this, 'order.public_id');
+    }
+
+    /**
+     * Order internal id for this route.
+     *
+     * @var string
+     */
+    public function getOrderInternalIdAttribute()
+    {
+        return data_get($this, 'order.internal_id');
+    }
+
+    /**
+     * Order internal id for this route.
+     *
+     * @var string
+     */
+    public function getOrderDispatchedAtAttribute()
+    {
+        return data_get($this, 'order.dispatched_at');
+    }
+}

package/server/src/Models/ServiceArea.php

@@ -0,0 +1,161 @@
+<?php
+
+namespace Fleetbase\FleetOps\Models;
+
+use Fleetbase\FleetOps\Casts\MultiPolygon;
+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;
+
+class ServiceArea extends Model
+{
+    use HasUuid;
+    use HasPublicId;
+    use SendsWebhooks;
+    use TracksApiCredential;
+    use SpatialTrait;
+    use HasApiModelBehavior;
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'service_areas';
+
+    /**
+     * The type of public Id to generate.
+     *
+     * @var string
+     */
+    protected $publicIdType = 'sa';
+
+    /**
+     * These attributes that can be queried.
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['_key', 'company_uuid', 'name', 'type', 'parent_uuid', 'border', 'color', 'stroke_color', 'status'];
+
+    /**
+     * The attributes that are spatial columns.
+     *
+     * @var array
+     */
+    protected $spatialFields = ['border'];
+
+    /**
+     * Relationships to load with model.
+     *
+     * @var array
+     */
+    protected $with = ['zones'];
+
+    /**
+     * 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 attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'border' => MultiPolygon::class,
+    ];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function zones()
+    {
+        return $this->hasMany(Zone::class)->without(['serviceArea']);
+    }
+
+    /**
+     * Sets the status attribute for the model.
+     *
+     * @param string|null $status the status value, defaults to 'active' if not provided
+     *
+     * @return void
+     */
+    public function setStatusAttribute(?string $status = 'active')
+    {
+        $this->attributes['status'] = $status;
+    }
+
+    /**
+     * Sets the type attribute for the model.
+     *
+     * @param string|null $type the type value, defaults to 'country' if not provided
+     *
+     * @return void
+     */
+    public function setTypeAttribute(?string $type = 'country')
+    {
+        $this->attributes['type'] = $type;
+    }
+
+    /**
+     * Creates a 100m polygon from the coorddinates.
+     *
+     * @var Polygon
+     */
+    public function polygon($meters = 100)
+    {
+        return new \League\Geotools\Polygon\Polygon(Utils::coordsToCircle($this->latitude, $this->longitude, $meters));
+    }
+
+    /**
+     * Determines if coordinates fall within zone.
+     *
+     * @param int $latitude
+     * @param int $longitude
+     *
+     * @return bool
+     */
+    public function inZone($latitude, $longitude)
+    {
+        return $this->polygon()->pointInPolygon(new \League\Geotools\Coordinate\Coordinate([$latitude, $longitude]));
+    }
+
+    /**
+     * Determines if multiple coordinates fall within zone.
+     *
+     * @param array $coords
+     *
+     * @return bool
+     */
+    public function pointsInZone($coords)
+    {
+        foreach ($coords as $coord) {
+            if (!$this->polygon()->pointInPolygon(new \League\Geotools\Coordinate\Coordinate([$coord[0], $coord[1]]))) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}