@fleetbase/storefront-engine 0.1.7 → 0.1.8

package/server/src/Support/Metrics.php

@@ -0,0 +1,193 @@
+<?php
+
+namespace Fleetbase\Storefront\Support;
+
+use Fleetbase\Models\Company;
+use Fleetbase\Storefront\Models\Network;
+use Fleetbase\Storefront\Models\Store;
+use Fleetbase\Storefront\Models\Product;
+use Fleetbase\FleetOps\Models\Order;
+use Illuminate\Support\Carbon;
+use Illuminate\Support\Str;
+
+/**
+ * Metrics service to pull analyitcs and metrics from Storefront.
+ * 
+ * Ex:
+ * $metrics = Metrics::new($company)->withTotalStores()->withOrdersCanceled()->get();
+ */
+class Metrics
+{
+    protected \DateTime $start;
+    protected \DateTime $end;
+    protected Company $company;
+    protected array $metrics = [];
+
+    public static function new(Company $company, ?\DateTime $start = null, ?\DateTime $end = null): Metrics
+    {
+        $start = $start === null ? Carbon::create(1900)->toDateTime() : $start;
+        $end = $end === null ? Carbon::tomorrow()->toDateTime() : $end;
+
+        return (new static())->setCompany($company)->between($start, $end);
+    }
+
+    public static function forCompany(Company $company, ?\DateTime $start = null, ?\DateTime $end = null): Metrics
+    {
+        return static::new($company, $start, $end);
+    }
+
+    public function start(\DateTime $start): Metrics
+    {
+        $this->start = $start;
+
+        return $this;
+    }
+
+    public function end(\DateTime $end): Metrics
+    {
+        $this->end = $end;
+
+        return $this;
+    }
+
+    public function between(\DateTime $start, \DateTime $end): Metrics
+    {
+        return $this->start($start)->end($end);
+    }
+
+    private function setCompany(Company $company): Metrics
+    {
+        $this->company = $company;
+
+        return $this;
+    }
+
+    private function set($key, $value = null): Metrics
+    {
+        if (is_array($key)) {
+            foreach ($key as $k => $v) {
+                $this->set($k, $v);
+            }
+
+            return $this;
+        }
+
+        $this->metrics = data_set($this->metrics, $key, $value);
+
+        return $this;
+    }
+
+    public function get()
+    {
+        return $this->metrics;
+    }
+
+    public function with(?array $metrics = [])
+    {
+        if (empty($metrics)) {
+            $metrics = array_slice(get_class_methods($this), 9);
+        }
+
+        $metrics = array_map(
+            function ($metric) {
+                return Str::camel($metric);
+            },
+            $metrics
+        );
+
+        foreach ($metrics as $metric) {
+            if (method_exists($this, $metric)) {
+                $this->{$metric}();
+            }
+        }
+
+        return $this;
+    }
+
+    public function totalProducts(?callable $callback = null): Metrics
+    {
+        $query = Product::where('company_uuid', $this->company->uuid);
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('total_products', $data);
+    }
+
+    public function totalStores(?callable $callback = null): Metrics
+    {
+        $query = Store::where('company_uuid', $this->company->uuid);
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('total_stores', $data);
+    }
+
+    public function totalNetworks(?callable $callback = null): Metrics
+    {
+        $query = Network::where('company_uuid', $this->company->uuid);
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('total_networks', $data);
+    }
+
+    public function ordersInProgress(?callable $callback = null): Metrics
+    {
+        $query = Order::where('company_uuid', $this->company->uuid)
+            ->whereBetween('created_at', [$this->start, $this->end])
+            ->where('type', 'storefront')
+            ->whereNotIn('status', ['completed', 'created', 'pending', 'canceled']);
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('orders_in_progress', $data);
+    }
+
+    public function ordersCompleted(?callable $callback = null): Metrics
+    {
+        $query = Order::where('company_uuid', $this->company->uuid)
+            ->whereBetween('created_at', [$this->start, $this->end])
+            ->where('type', 'storefront')
+            ->where('status', 'completed');
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('orders_completed', $data);
+    }
+
+    public function ordersCanceled(?callable $callback = null): Metrics
+    {
+        $query = Order::where('company_uuid', $this->company->uuid)
+            ->whereBetween('created_at', [$this->start, $this->end])
+            ->where('type', 'storefront')
+            ->where('status', 'canceled');
+
+        if (is_callable($callback)) {
+            $callback($query);
+        }
+
+        $data = $query->count();
+
+        return $this->set('orders_canceled', $data);
+    }
+}

package/server/src/Support/OrderConfig.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Fleetbase\Storefront\Support;
+
+class OrderConfig {
+    /**
+     * Provides default order configs for Storefront.
+     */
+    public function get(): ?array
+    {
+        return config('storefront.api.types.order', []);
+    }
+}

package/server/src/Support/QPay.php

@@ -0,0 +1,208 @@
+<?php
+
+namespace Fleetbase\Storefront\Support;
+
+use GuzzleHttp\Client;
+
+class QPay
+{
+    private string $host = 'https://merchant.qpay.mn/';
+    private string $namespace = 'v2';
+    private ?string $callbackUrl;
+    private array $requestOptions = [];
+    private Client $client;
+
+    public function __construct(?string $username = null, ?string $password = null, ?string $callbackUrl = null)
+    {
+        $this->callbackUrl = $callbackUrl;
+        $this->requestOptions = [
+            'base_uri' => $this->buildRequestUrl(),
+            'auth' => [$username, $password],
+            'headers' => [
+                'Content-Type' => 'application/json',
+                'Accept' => 'application/json'
+            ]
+        ];
+        $this->client = new Client($this->requestOptions);
+    }
+
+    public function updateRequestOption($key, $value)
+    {
+        $this->requestOptions[$key] = $value;
+        $this->client = new Client($this->requestOptions);
+    }
+
+    public function getClient()
+    {
+        return $this->client;
+    }
+
+    public function setNamespace(string $namespace): ?QPay
+    {
+        $this->namespace = $namespace;
+        $this->updateRequestOption('base_uri', $this->buildRequestUrl());
+
+        return $this;
+    }
+
+    private function buildRequestUrl(string $path = ''): string
+    {
+        $url = trim($this->host . $this->namespace . '/' . $path);
+        return $url;
+    }
+
+    public function useSandbox()
+    {
+        $this->host = 'https://merchant-sandbox.qpay.mn/';
+        $this->updateRequestOption('base_uri', $this->buildRequestUrl());
+
+        return $this;
+    }
+
+    public static function instance(?string $username = null, ?string $password = null, ?string $callbackUrl = null): QPay
+    {
+        return new static($username, $password, $callbackUrl);
+    }
+
+    private function hasCallbackUrl()
+    {
+        return isset($this->callbackUrl);
+    }
+
+    private function request(string $method, string $path, array $options = [])
+    {
+        $options['http_errors'] = false;
+
+        $response = $this->client->request($method, $path, $options);
+        $body = $response->getBody();
+        $contents = $body->getContents();
+        $json = json_decode($contents);
+
+        return $json;
+    }
+
+    public function post(string $path, array $params = [], array $options = [])
+    {
+        $options = ['json' => $params];
+
+        return $this->request('POST', $path, $options);
+    }
+
+    public function delete(string $path, array $params = [], array $options = [])
+    {
+        $options = ['json' => $params];
+
+        return $this->request('DELETE', $path, $options);
+    }
+
+    public function get(string $path, array $options = [])
+    {
+        return $this->request('GET', $path, $options);
+    }
+
+    public function getAuthToken()
+    {
+        return $this->post('auth/token');
+    }
+
+    public function refreshAuthToken()
+    {
+        return $this->post('auth/refresh');
+    }
+
+    private function useBearerToken(string $token): QPay
+    {
+        unset($this->requestOptions['auth']);
+        $headers = array_merge($this->requestOptions['headers'] ?? [], ['Authorization' => "Bearer $token"]);
+        $this->updateRequestOption('headers', $headers);
+
+        return $this;
+    }
+
+    public function setAuthToken(?string $accessToken = null): QPay
+    {
+        if ($accessToken) {
+            $this->useBearerToken($accessToken);
+        } else {
+            $response = $this->getAuthToken();
+            $token = $response->access_token;
+
+            if (isset($token)) {
+                $this->useBearerToken($token);
+            }
+        }
+
+        return $this;
+    }
+
+    public function createSimpleInvoice(int $amount, ?string $invoiceCode = '', ?string $invoiceDescription = '', ?string $invoiceReceiverCode = '', ?string $senderInvoiceNo = '', ?string $callbackUrl = null)
+    {
+        if (!$callbackUrl && $this->hasCallbackUrl()) {
+            $callbackUrl = $this->callbackUrl;
+        }
+
+        $params = array_filter([
+            'invoice_code' => $invoiceCode,
+            'amount' => $amount,
+            'callback_url' => $callbackUrl,
+            'invoice_description' => $invoiceDescription,
+            'invoice_receiver_code' => $invoiceReceiverCode,
+            'sender_invoice_no' => $senderInvoiceNo,
+        ]);
+
+        return $this->createQPayInvoice($params);
+    }
+
+    public function createQPayInvoice(array $params = [], $options = [])
+    {
+        if (!isset($params['callback_url']) && $this->hasCallbackUrl()) {
+            $params['callback_url'] = $this->callbackUrl;
+        }
+
+        return $this->post('invoice', $params, $options);
+    }
+
+    public function paymentCheck(string $invoiceId, $options = [])
+    {
+        $params = [
+            'object_type' => 'INVOICE',
+            'object_id' => $invoiceId
+        ];
+
+        return $this->post('payment/check', $params, $options);
+    }
+
+    public function paymentCancel(string $invoiceId, $options = [])
+    {
+        $params = [
+            'callback_url' => '"https://qpay.mn/payment/result?payment_id=' . $invoiceId,
+        ];
+
+        return $this->delete('payment/cancel', $params, $options);
+    }
+
+    public function paymentRefund(string $invoiceId, $options = [])
+    {
+        $params = [
+            'callback_url' => '"https://qpay.mn/payment/result?payment_id=' . $invoiceId,
+        ];
+
+        return $this->delete('payment/refund', $params, $options);
+    }
+
+    public static function createInvoice(string $username, string $password, array $invoiceParams = [])
+    {
+        return static::instance($username, $password)->setAuthToken()->createQPayInvoice($invoiceParams);
+    }
+
+    public static function generateCode(string $id)
+    {
+        return date('Ymd') . $id;
+    }
+
+    public static function cleanCode(string $code)
+    {
+        $code = str_replace(' ', '-', $code);
+        return preg_replace('/[^A-Za-z0-9\-]/', '', $code);
+    }
+}

package/server/src/Support/Storefront.php

@@ -0,0 +1,201 @@
+<?php
+
+namespace Fleetbase\Storefront\Support;
+
+use Fleetbase\Storefront\Models\Gateway;
+use Fleetbase\Storefront\Models\Network;
+use Fleetbase\Storefront\Models\Product;
+use Fleetbase\Storefront\Models\Store;
+use Fleetbase\FleetOps\Models\Contact;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\Models\User;
+use Fleetbase\Storefront\Notifications\StorefrontOrderCreated;
+use Illuminate\Support\Facades\Notification;
+use Illuminate\Support\Facades\Redis;
+use Illuminate\Support\Str;
+use Laravel\Sanctum\PersonalAccessToken;
+
+class Storefront
+{
+    /**
+     * Returns current store or network based on session `storefront_key`
+     * with bare minimum columns, but can optionally pass in more columns to receive.
+     *
+     * @param array $columns
+     * @return \Fleetbase\Models\Storefront\Network|\Fleetbase\Models\Storefront\Store
+     */
+    public static function about($columns = [], $with = [])
+    {
+        $key = session('storefront_key');
+
+        if (!$key) {
+            return null;
+        }
+
+        if (is_array($columns)) {
+            $columns = array_merge(['uuid', 'public_id', 'company_uuid', 'backdrop_uuid', 'logo_uuid', 'name', 'description', 'translations', 'website', 'facebook', 'instagram', 'twitter', 'email', 'phone', 'tags', 'currency', 'timezone', 'pod_method', 'options'], $columns);
+        }
+
+        if (Str::startsWith($key, 'store')) {
+            $about = Store::select($columns)->where('key', $key)->with($with)->first();
+        } else {
+            $about = Network::select($columns)->where('key', $key)->with($with)->first();
+        }
+
+        $about->is_store = Str::startsWith($key, 'store');
+        $about->is_network = Str::startsWith($key, 'network');
+
+        return $about;
+    }
+
+    public static function findAbout($id, $columns = [], $with = [])
+    {
+        if (is_array($columns)) {
+            $columns = array_merge(['uuid', 'public_id', 'company_uuid', 'backdrop_uuid', 'logo_uuid', 'name', 'description', 'translations', 'website', 'facebook', 'instagram', 'twitter', 'email', 'phone', 'tags', 'currency', 'timezone', 'pod_method', 'options'], $columns);
+        }
+
+        if (Str::startsWith($id, 'store')) {
+            $about = Store::select($columns)->where('public_id', $id)->with($with)->first();
+        } else {
+            $about = Network::select($columns)->where('public_id', $id)->with($with)->first();
+        }
+
+        if (!$about) {
+            return $about;
+        }
+
+        $about->is_store = Str::startsWith($id, 'store');
+        $about->is_network = Str::startsWith($id, 'network');
+
+        return $about;
+    }
+
+    public static function getStoreFromLocation(string $id, $columns = [], $with = [])
+    {
+        if (is_array($columns)) {
+            $columns = array_merge(['uuid', 'public_id', 'company_uuid', 'backdrop_uuid', 'logo_uuid', 'name', 'description', 'translations', 'website', 'facebook', 'instagram', 'twitter', 'email', 'phone', 'tags', 'currency', 'timezone', 'pod_method', 'options'], $columns);
+        }
+
+        return Store::select($columns)->with($with)->whereHas('locations', function ($q) use ($id) {
+            $q->where('place_uuid', $id);
+            $q->orWhereHas('place', function ($q) use ($id) {
+                $q->where('public_id', $id);
+            });
+        })->first();
+    }
+
+    public static function getCustomerFromToken()
+    {
+        $token = request()->header('Customer-Token');
+
+        if ($token) {
+            $accessToken = PersonalAccessToken::findToken($token);
+
+            if ($accessToken && Utils::isUuid($accessToken->name)) {
+                $customer = Contact::where('uuid', $accessToken->name)->first();
+
+                if ($customer) {
+                    return $customer;
+                }
+            }
+
+            if ($accessToken) {
+                return Contact::where('user_uuid', $accessToken->tokenable->uuid)->first();
+            }
+        }
+
+        return null;
+    }
+
+    public static function findGateway(string $code): ?Gateway
+    {
+        if ($code === 'cash') {
+            return Gateway::cash();
+        }
+
+        return Gateway::where([
+            'code' => $code,
+            'owner_uuid' => session('storefront_store') ?? session('storefront_network'),
+        ])->first();
+    }
+
+    public static function getFullDescriptionFromCartItem($cartItem)
+    {
+        $fullDescription = $cartItem->name;
+
+        if (is_array($cartItem->variants) && count($cartItem->variants)) {
+            $fullDescription .= ' with Variation: ';
+            $fullDescription .= collect($cartItem->variants)->pluck('name')->join(',');
+        }
+
+        if (is_array($cartItem->addons) && count($cartItem->addons)) {
+            $fullDescription .= ' with Addons: ';
+            $fullDescription .= collect($cartItem->addons)->pluck('name')->join(',');
+        }
+
+        return $fullDescription;
+    }
+
+    public static function destroyCart($cartId)
+    {
+        $prefix = 'cart:' . session('storefront_store') . ':';
+
+        return Redis::del($prefix . $cartId);
+    }
+
+    public static function getProduct($publicId)
+    {
+        return Product::select(['uuid', 'public_id', 'name', 'description', 'price', 'sale_price', 'is_on_sale'])->where(['public_id' => $publicId])->with([])->first();
+    }
+
+    public static function alertNewOrder(Order $order, $sendNow = false)
+    {
+        $about = static::about(['alertable']);
+        $alertables = [];
+
+        if ($about->is_network) {
+            $store = static::findAbout($order->getMeta('storefront_id'), ['alertable']);
+
+            if ($store && $store->public_id !== $about->public_id) {
+                $merge = Utils::get($store, 'alertable.for_new_order', []);
+                $alertables = array_merge($alertables, $merge);
+            }
+        }
+
+        $merge = Utils::get($about, 'alertable.for_new_order', []);
+        $alertables = array_merge($alertables, $merge);
+        $users = collect($alertables)->map(function ($id) {
+            return User::where('public_id', $id)->first();
+        });
+
+        if ($users->isEmpty()) {
+            return;
+        }
+
+        if ($sendNow) {
+            return Notification::sendNow($users, new StorefrontOrderCreated($order));
+        }
+
+        return Notification::send($users, new StorefrontOrderCreated($order));
+    }
+
+    public static function createStripeCustomerForContact(Contact &$customer)
+    {
+        $stripeCustomer = \Stripe\Customer::create([
+            'description' => 'Customer created in Fleetbase Storefront',
+            'email' => $customer->email,
+            'name' => $customer->name,
+            'phone' => $customer->phone,
+            'metadata' => [
+                'contact_id' => $customer->public_id,
+                'storefront_id' => session('storefront_store') ?? session('storefront_network'),
+                'company_id' => session('company')
+            ]
+        ]);
+
+        // set the stripe customer to customer meta
+        $customer->updateMeta('stripe_id', $stripeCustomer->id);
+
+        return $stripeCustomer;
+    }
+}