@fleetbase/storefront-engine 0.1.6 → 0.1.8

package/server/src/Models/Checkout.php

@@ -0,0 +1,166 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\Company;
+use Fleetbase\Models\ServiceQuote;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Traits\HasOptionsAttributes;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasPublicid;
+use Illuminate\Support\Str;
+
+class Checkout extends StorefrontModel
+{
+    use HasUuid, HasPublicid, HasOptionsAttributes;
+
+    /**
+     * The type of public Id to generate
+     *
+     * @var string
+     */
+    protected $publicIdType = 'chkt';
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'checkouts';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['company_uuid', 'order_uuid', 'network_uuid', 'store_uuid', 'cart_uuid', 'gateway_uuid', 'service_quote_uuid', 'owner_uuid', 'owner_type', 'amount', 'currency', 'is_cod', 'is_pickup', 'options', 'token', 'cart_state', 'captured'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'cart_state' => Json::class,
+        'options' => Json::class,
+        'captured' => 'boolean',
+        'is_cod' => 'boolean',
+        'is_pickup' => 'boolean'
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = [];
+
+    /** on boot generate token */
+    public static function boot()
+    {
+        parent::boot();
+        static::creating(function ($model) {
+            $model->token = 'checkout_' . md5(Str::random(14) . time());
+        });
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function company()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(Company::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function order()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(Order::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
+     */
+    public function owner()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->morphTo(__FUNCTION__, 'owner_type', 'owner_uuid')->withoutGlobalScopes();
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function serviceQuote()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(ServiceQuote::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function store()
+    {
+        return $this->belongsTo(Store::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function network()
+    {
+        return $this->belongsTo(Network::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function gateway()
+    {
+        return $this->belongsTo(Gateway::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function cart()
+    {
+        return $this->belongsTo(Cart::class);
+    }
+
+    /**
+     * Sets the owner type
+     * 
+     * @return void
+     */
+    public function setOwnerTypeAttribute($type)
+    {
+        $this->attributes['owner_type'] = Utils::getMutationType($type);
+    }
+
+    /**
+     * Update the cart as checkout.
+     *
+     * @return void
+     */
+    public function checkedout()
+    {
+        if (!isset($this->cart)) {
+            $this->load(['cart']);
+        }
+
+        $cart = $this->cart;
+
+        if ($cart) {
+            $this->cart->update(['checkout_uuid' => $this->uuid]);
+        }
+    }
+}

package/server/src/Models/Customer.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\FleetOps\Models\Contact;
+use Illuminate\Support\Str;
+
+class Customer extends Contact
+{
+    /**
+     * The key to use in the payload responses
+     *
+     * @var string
+     */
+    protected string $payloadKey = 'customer';
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function reviews()
+    {
+        return $this->hasMany(Review::class, 'customer_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function productReviews()
+    {
+        return $this->hasMany(Review::class, 'customer_uuid')->where('subject_type', 'Fleetbase\Storefront\Models\Product');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function storeReviews()
+    {
+        return $this->hasMany(Review::class, 'customer_uuid')->where('subject_type', 'Fleetbase\Storefront\Models\Store');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function reviewUploads()
+    {
+        return $this->hasMany(\Fleetbase\Models\File::class, 'uploader_uuid')->where('type', 'storefront_review_upload');
+    }
+
+    /**
+     * @return integer
+     */
+    public function getReviewsCountAttribute()
+    {
+        return $this->reviews()->count();
+    }
+
+    /**
+     * Count the number of orders for the storefront with the given ID
+     *
+     * @param int $id The ID of the storefront to count orders for
+     * @return int The number of storefront orders for the customer with this UUID
+     */
+    public function countStorefrontOrdersFrom($id)
+    {
+        return \Fleetbase\FleetOps\Models\Order::where(
+            [
+                'customer_uuid' => $this->uuid,
+                'type' => 'storefront',
+                'meta->storefront_id' => $id
+            ]
+        )->count();
+    }
+
+    /**
+     * Find a customer with the given public ID
+     *
+     * @param string $publicId The public ID of the customer to find
+     * @return static|null The customer with the given public ID, or null if none was found
+     */
+    public static function findFromCustomerId($publicId)
+    {
+        if (Str::startsWith($publicId, 'customer')) {
+            $publicId = Str::replaceFirst('customer', 'contact', $publicId);
+        }
+
+        return static::where('public_id', $publicId)->first();
+    }
+}

package/server/src/Models/Gateway.php

@@ -0,0 +1,165 @@
+<?php
+
+namespace Fleetbase\Storefront\Models;
+
+use Fleetbase\Casts\Json;
+use Fleetbase\Models\User;
+use Fleetbase\Models\Company;
+use Fleetbase\Models\File;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Traits\HasUuid;
+use Fleetbase\Traits\HasApiModelBehavior;
+use Fleetbase\Traits\HasPublicid;
+
+class Gateway extends StorefrontModel
+{
+    use HasUuid, HasPublicid, HasApiModelBehavior;
+
+    /**
+     * The type of public Id to generate
+     *
+     * @var string
+     */
+    protected $publicIdType = 'gateway';
+
+    /**
+     * The database table used by the model.
+     *
+     * @var string
+     */
+    protected $table = 'gateways';
+
+    /**
+     * These attributes that can be queried
+     *
+     * @var array
+     */
+    protected $searchableColumns = ['name'];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = ['public_id', 'company_uuid', 'created_by_uuid', 'logo_file_uuid', 'owner_uuid', 'owner_type', 'name', 'description', 'code', 'type', 'sandbox', 'meta', 'config', 'return_url', 'callback_url'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'sandbox' => 'boolean',
+        'meta' => Json::class,
+        'config' => Json::class
+    ];
+
+    /**
+     * Dynamic attributes that are appended to object
+     *
+     * @var array
+     */
+    protected $appends = ['is_stripe_gateway', 'logo_url'];
+
+    /**
+     * The attributes excluded from the model's JSON form.
+     *
+     * @var array
+     */
+    protected $hidden = ['logoFile'];
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function createdBy()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(User::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function company()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(Company::class);
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\MorphTo
+     */
+    public function owner()
+    {
+        return $this->morphTo(__FUNCTION__, 'owner_type', 'owner_uuid');
+    }
+
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function logoFile()
+    {
+        return $this->setConnection(config('fleetbase.connection.db'))->belongsTo(File::class);
+    }
+
+    /**
+     * @return string
+     */
+    public function getLogoUrlAttribute()
+    {
+        $default = $this->logoFile->url ?? null;
+        $backup = 'https://flb-assets.s3.ap-southeast-1.amazonaws.com/static/image-file-icon.png';
+
+        return $default ?? $backup;
+    }
+
+    /**
+     * Sets the owner type
+     */
+    public function setOwnerTypeAttribute($type)
+    {
+        $this->attributes['owner_type'] = Utils::getMutationType($type);
+    }
+
+    public function getConfigAttribute($config)
+    {
+        $config = Json::decode($config);
+        $sortedKeys = collect($config)->keys()->sort(function ($key) use ($config) {
+            return Utils::isBooleanValue($config[$key]) ? 1 : 0;
+        });
+        $sortedConfig = [];
+
+        foreach ($sortedKeys as $key) {
+            $sortedConfig[$key] = $config[$key];
+        }
+
+        return (object) $sortedConfig;
+    }
+
+    public function getIsStripeGatewayAttribute()
+    {
+        return $this->type === 'stripe';
+    }
+
+    public function getIsQpayGatewayAttribute()
+    {
+        return $this->type === 'qpay';
+    }
+
+    /**
+     * Generates a new cash/cash on delivery gateway
+     *
+     * @return Gateway
+     */
+    public static function cash($attributes = ['sandbox' => 0]): Gateway
+    {
+        return new static([
+            'public_id' => 'gateway_cash',
+            'name' => 'Cash',
+            'code' => 'cash',
+            'type' => 'cash',
+            'sandbox' => $attributes['sandbox'],
+            'return_url' => null,
+            'callback_url' => null,
+            ...$attributes
+        ]);
+    }
+}