@fleetbase/storefront-engine 0.1.6 → 0.1.8

package/server/src/Notifications/StorefrontOrderPreparing.php

@@ -0,0 +1,202 @@
+<?php
+
+namespace Fleetbase\Storefront\Notifications;
+
+use Exception;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\Storefront\Models\NotificationChannel;
+use Fleetbase\Storefront\Support\Storefront;
+use Fleetbase\FleetOps\Support\Utils;
+// use Fleetbase\FleetOps\Support\Utils;
+use Illuminate\Bus\Queueable;
+// use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Fcm\FcmChannel;
+use NotificationChannels\Fcm\FcmMessage;
+use NotificationChannels\Apn\ApnChannel;
+use NotificationChannels\Apn\ApnMessage;
+use NotificationChannels\Fcm\Resources\AndroidConfig;
+use NotificationChannels\Fcm\Resources\AndroidFcmOptions;
+use NotificationChannels\Fcm\Resources\AndroidNotification;
+use NotificationChannels\Fcm\Resources\ApnsConfig;
+use NotificationChannels\Fcm\Resources\ApnsFcmOptions;
+use Pushok\Client as PushOkClient;
+use Pushok\AuthProvider\Token as PuskOkToken;
+
+class StorefrontOrderPreparing extends Notification
+{
+    use Queueable;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @return void
+     */
+    public function __construct(Order $order)
+    {
+        $this->order = $order->setRelations([]);
+        $this->storefront = Storefront::findAbout($this->order->getMeta('storefront_id'));
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        // $channels = ['mail'];
+        $channels = [];
+
+        if (!$this->storefront) {
+            return $channels;
+        }
+
+        $hasApnNotificationChannels = NotificationChannel::where(['owner_uuid' => $this->storefront->uuid, 'scheme' => 'apn'])->count();
+        $hasFcmNotificationChannels = NotificationChannel::where(['owner_uuid' => $this->storefront->uuid, 'scheme' => 'android'])->count();
+
+        if ($hasApnNotificationChannels) {
+            $channels[] = ApnChannel::class;
+        }
+        if ($hasFcmNotificationChannels) {
+            $channels[] = FcmChannel::class;
+        }
+
+        return $channels;
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return \Illuminate\Notifications\Messages\MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        $message = (new MailMessage)
+            ->subject('Your order from ' . $this->storefront->name . ' is being prepared')
+            ->line('Your order is getting started.');
+
+        // $message->action('View Details', Utils::consoleUrl('', ['shift' => 'fleet-ops/orders/view/' . $this->order->public_id]));
+
+        return $message;
+    }
+
+    /**
+     * Get the firebase cloud message representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function toFcm($notifiable)
+    {
+        $notification = \NotificationChannels\Fcm\Resources\Notification::create()
+            ->setTitle('Your order from ' . $this->storefront->name . ' is being prepared')
+            ->setBody('Your order is getting started.');
+
+        $message = FcmMessage::create()
+            ->setData(['order' => $this->order->uuid, 'id' => $this->order->public_id, 'type' => 'order_preparing'])
+            ->setNotification($notification)
+            ->setAndroid(
+                AndroidConfig::create()
+                    ->setFcmOptions(AndroidFcmOptions::create()->setAnalyticsLabel('analytics'))
+                    ->setNotification(AndroidNotification::create()->setColor('#4391EA'))
+            )->setApns(
+                ApnsConfig::create()
+                    ->setFcmOptions(ApnsFcmOptions::create()->setAnalyticsLabel('analytics_ios'))
+            );
+
+        return $message;
+    }
+
+    public function fcmProject($notifiable, $message)
+    {
+        $about = Storefront::findAbout($this->order->getMeta('storefront_id'));
+
+        if ($this->order->hasMeta('storefront_notification_channel')) {
+            $notificationChannel = NotificationChannel::where([
+                'owner_uuid' => $about->uuid,
+                'app_key' => $this->order->getMeta('storefront_notification_channel'),
+                'scheme' => 'fcm'
+            ])->first();
+        } else {
+            $notificationChannel = NotificationChannel::where([
+                'owner_uuid' => $about->uuid,
+                'scheme' => 'fcm'
+            ])->first();
+        }
+
+        if (!$notificationChannel) {
+            return 'app';
+        }
+
+        $this->configureFcm($notificationChannel);
+
+        return $notificationChannel->app_key;
+    }
+
+    public function configureFcm($notificationChannel)
+    {
+        $config = (array) $notificationChannel->config;
+        $fcmConfig = config('firebase.projects.app');
+
+        // set credentials
+        Utils::set($fcmConfig, 'credentials.file', $config['firebase_credentials_json']);
+
+        // set db url
+        Utils::set($fcmConfig, 'database.url', $config['firebase_database_url']);
+
+        config('firebase.projects.' . $notificationChannel->app_key, $fcmConfig);
+
+        return $fcmConfig;
+    }
+
+    /**
+     * Get the apns message representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function toApn($notifiable)
+    {
+        $about = Storefront::findAbout($this->order->getMeta('storefront_id'));
+
+        if ($this->order->hasMeta('storefront_notification_channel')) {
+            $notificationChannel = NotificationChannel::where([
+                'owner_uuid' => $about->uuid,
+                'app_key' => $this->order->getMeta('storefront_notification_channel'),
+                'scheme' => 'apn'
+            ])->first();
+        } else {
+            $notificationChannel = NotificationChannel::where([
+                'owner_uuid' => $about->uuid,
+                'scheme' => 'apn'
+            ])->first();
+        }
+
+        $config = (array) $notificationChannel->config;
+
+        $message = ApnMessage::create()
+            ->badge(1)
+            ->title('Your order from ' . $this->storefront->name . ' is being prepared')
+            ->body('Your order is getting started.')
+            ->custom('type', 'order_preparing')
+            ->custom('order', $this->order->uuid)
+            ->custom('id', $this->order->public_id);
+
+        try {
+            $channelClient = new PushOkClient(PuskOkToken::create($config));
+        } catch (Exception $e) {
+            // report to sentry the exception
+            app('sentry')->captureException($e);
+            // return the apn message to be sent by fleetbase defaults anyway -- backup
+            return;
+        }
+
+        $message = $message->via($channelClient);
+
+        return $message;
+    }
+}

package/server/src/Notifications/StorefrontOrderReadyForPickup.php

@@ -0,0 +1,202 @@
+<?php
+
+namespace Fleetbase\Storefront\Notifications;
+
+use Exception;
+use Fleetbase\FleetOps\Models\Order;
+use Fleetbase\Storefront\Models\NotificationChannel;
+use Fleetbase\Storefront\Support\Storefront;
+use Fleetbase\FleetOps\Support\Utils;
+// use Fleetbase\FleetOps\Support\Utils;
+use Illuminate\Bus\Queueable;
+// use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Notifications\Messages\MailMessage;
+use Illuminate\Notifications\Notification;
+use NotificationChannels\Fcm\FcmChannel;
+use NotificationChannels\Fcm\FcmMessage;
+use NotificationChannels\Apn\ApnChannel;
+use NotificationChannels\Apn\ApnMessage;
+use NotificationChannels\Fcm\Resources\AndroidConfig;
+use NotificationChannels\Fcm\Resources\AndroidFcmOptions;
+use NotificationChannels\Fcm\Resources\AndroidNotification;
+use NotificationChannels\Fcm\Resources\ApnsConfig;
+use NotificationChannels\Fcm\Resources\ApnsFcmOptions;
+use Pushok\Client as PushOkClient;
+use Pushok\AuthProvider\Token as PuskOkToken;
+
+class StorefrontOrderReadyForPickup extends Notification
+{
+    use Queueable;
+
+    /**
+     * Create a new notification instance.
+     *
+     * @return void
+     */
+    public function __construct(Order $order)
+    {
+        $this->order = $order->setRelations([]);
+        $this->storefront = Storefront::findAbout($this->order->getMeta('storefront_id'));
+    }
+
+    /**
+     * Get the notification's delivery channels.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function via($notifiable)
+    {
+        // $channels = ['mail'];
+        $channels = [];
+
+        if (!$this->storefront) {
+            return $channels;
+        }
+
+        $hasApnNotificationChannels = NotificationChannel::where(['owner_uuid' => $this->storefront->uuid, 'scheme' => 'apn'])->count();
+        $hasFcmNotificationChannels = NotificationChannel::where(['owner_uuid' => $this->storefront->uuid, 'scheme' => 'android'])->count();
+
+        if ($hasApnNotificationChannels) {
+            $channels[] = ApnChannel::class;
+        }
+        if ($hasFcmNotificationChannels) {
+            $channels[] = FcmChannel::class;
+        }
+
+        return $channels;
+    }
+
+    /**
+     * Get the mail representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return \Illuminate\Notifications\Messages\MailMessage
+     */
+    public function toMail($notifiable)
+    {
+        $message = (new MailMessage)
+            ->subject('Your order from ' . $this->storefront->name . ' is ready for pickup!')
+            ->line('You can proceed to pickup your order.');
+
+        // $message->action('View Details', Utils::consoleUrl('', ['shift' => 'fleet-ops/orders/view/' . $this->order->public_id]));
+
+        return $message;
+    }
+
+    /**
+     * Get the firebase cloud message representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function toFcm($notifiable)
+    {
+        $notification = \NotificationChannels\Fcm\Resources\Notification::create()
+            ->setTitle('Your order from ' . $this->storefront->name . ' is ready for pickup!')
+            ->setBody('You can proceed to pickup your order.');
+
+        $message = FcmMessage::create()
+            ->setData(['order' => $this->order->uuid, 'id' => $this->order->public_id, 'type' => 'order_ready'])
+            ->setNotification($notification)
+            ->setAndroid(
+                AndroidConfig::create()
+                    ->setFcmOptions(AndroidFcmOptions::create()->setAnalyticsLabel('analytics'))
+                    ->setNotification(AndroidNotification::create()->setColor('#4391EA'))
+            )->setApns(
+                ApnsConfig::create()
+                    ->setFcmOptions(ApnsFcmOptions::create()->setAnalyticsLabel('analytics_ios'))
+            );
+
+        return $message;
+    }
+
+    public function fcmProject($notifiable, $message)
+    {
+        $about = Storefront::findAbout($this->order->getMeta('storefront_id'));
+
+        if ($this->order->hasMeta('storefront_notification_channel')) {
+            $notificationChannel = NotificationChannel::where([
+                'owner_uuid' => $about->uuid,
+                'app_key' => $this->order->getMeta('storefront_notification_channel'),
+                'scheme' => 'fcm'
+            ])->first();
+        } else {
+            $notificationChannel = NotificationChannel::where([
+                'owner_uuid' => $about->uuid,
+                'scheme' => 'fcm'
+            ])->first();
+        }
+
+        if (!$notificationChannel) {
+            return 'app';
+        }
+
+        $this->configureFcm($notificationChannel);
+
+        return $notificationChannel->app_key;
+    }
+
+    public function configureFcm($notificationChannel)
+    {
+        $config = (array) $notificationChannel->config;
+        $fcmConfig = config('firebase.projects.app');
+
+        // set credentials
+        Utils::set($fcmConfig, 'credentials.file', $config['firebase_credentials_json']);
+
+        // set db url
+        Utils::set($fcmConfig, 'database.url', $config['firebase_database_url']);
+
+        config('firebase.projects.' . $notificationChannel->app_key, $fcmConfig);
+
+        return $fcmConfig;
+    }
+
+    /**
+     * Get the apns message representation of the notification.
+     *
+     * @param  mixed  $notifiable
+     * @return array
+     */
+    public function toApn($notifiable)
+    {
+        $about = Storefront::findAbout($this->order->getMeta('storefront_id'));
+
+        if ($this->order->hasMeta('storefront_notification_channel')) {
+            $notificationChannel = NotificationChannel::where([
+                'owner_uuid' => $about->uuid,
+                'app_key' => $this->order->getMeta('storefront_notification_channel'),
+                'scheme' => 'apn'
+            ])->first();
+        } else {
+            $notificationChannel = NotificationChannel::where([
+                'owner_uuid' => $about->uuid,
+                'scheme' => 'apn'
+            ])->first();
+        }
+
+        $config = (array) $notificationChannel->config;
+
+        $message = ApnMessage::create()
+            ->badge(1)
+            ->title('Your order from ' . $this->storefront->name . ' is ready for pickup!')
+            ->body('You can proceed to pickup your order.')
+            ->custom('type', 'order_ready')
+            ->custom('order', $this->order->uuid)
+            ->custom('id', $this->order->public_id);
+
+        try {
+            $channelClient = new PushOkClient(PuskOkToken::create($config));
+        } catch (Exception $e) {
+            // report to sentry the exception
+            app('sentry')->captureException($e);
+            // return the apn message to be sent by fleetbase defaults anyway -- backup
+            return;
+        }
+
+        $message = $message->via($channelClient);
+
+        return $message;
+    }
+}

package/server/src/Observers/NetworkObserver.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Fleetbase\Storefront\Observers;
+
+use Fleetbase\Storefront\Models\Network;
+use Illuminate\Support\Facades\Request;
+
+class NetworkObserver
+{
+    /**
+     * Handle the Network "updated" event.
+     *
+     * @param  \Fleetbase\Storefront\Models\Network  $network The Network that is updating.
+     * @return void
+     */
+    public function updating(Network $network): void
+    {
+        $network->flushAttributesCache();
+        $alertable = Request::array('network.alertable');
+
+        // set alertables to public_id
+        $network->alertable = collect($alertable)->mapWithKeys(
+            function ($alertables, $key) {
+                if (!is_array($alertables)) {
+                    return [];
+                }
+
+                return [
+                    $key => collect($alertables)->map(
+                        function ($user) {
+                            return data_get($user, 'public_id');
+                        }
+                    )
+                        ->values()
+                        ->toArray()
+                ];
+            }
+        )->toArray();
+    }
+}

package/server/src/Observers/ProductObserver.php

@@ -0,0 +1,118 @@
+<?php
+
+namespace Fleetbase\Storefront\Observers;
+
+use Fleetbase\Models\File;
+use Fleetbase\FleetOps\Support\Utils;
+use Fleetbase\Storefront\Models\Product;
+use Fleetbase\Storefront\Models\ProductAddonCategory;
+use Fleetbase\Storefront\Models\ProductVariant;
+use Fleetbase\Storefront\Models\ProductVariantOption;
+use Illuminate\Support\Facades\Request;
+use Illuminate\Support\Arr;
+
+class ProductObserver
+{
+    /**
+     * Handle the Product "created" event.
+     *
+     * @param  \Fleetbase\Storefront\Models\Product  $product The Product that was created.
+     * @return void
+     */
+    public function created(Product $product): void
+    {
+        $addonCategories = Request::input('product.addon_categories');
+        $variants = Request::input('product.variants');
+        $files = Request::input('product.files');
+
+        // save addon categories
+        foreach ($addonCategories as $addonCategory) {
+            $addonCategory['product_uuid'] = $product->uuid;
+
+            ProductAddonCategory::create(Arr::except($addonCategory, ['category']));
+        }
+
+        // save product variants
+        foreach ($variants as $variant) {
+            $variant['created_by_uuid'] = Request::session()->get('user');
+            $variant['company_uuid'] = Request::session()->get('company');
+            $variant['product_uuid'] = $product->uuid;
+
+            $productVariant = ProductVariant::create(Arr::except($variant, ['options']));
+
+            foreach ($variant['options'] as $option) {
+                $option['product_variant_uuid'] = $productVariant->uuid;
+                ProductVariantOption::create($option);
+            }
+        }
+
+        // set keys on files
+        foreach ($files as $file) {
+            $fileRecord = File::where('uuid', $file['uuid'])->first();
+            $fileRecord->setKey($product);
+        }
+    }
+
+    /**
+     * Handle the Product "updated" event.
+     *
+     * @param  \Fleetbase\Storefront\Models\Product  $product The Product that was created.
+     * @return void
+     */
+    public function updated(Product $product): void
+    {
+        $productAddonCategories = Request::input('product.addon_categories');
+        $variants = Request::input('product.variants');
+
+        // update addon categories
+        foreach ($productAddonCategories as $productAddonCategory) {
+            if (!empty($productAddonCategory['uuid'])) {
+                ProductAddonCategory::where('uuid', $productAddonCategory['uuid'])->update(Arr::except($productAddonCategory, ['uuid', 'name', 'category']));
+                continue;
+            }
+
+            // add new addon category
+            $productAddonCategory['product_uuid'] = $product->uuid;
+            ProductAddonCategory::create(Arr::except($productAddonCategory, ['category']));
+        }
+
+        // update product variants
+        foreach ($variants as $variant) {
+            if (!empty($variant['uuid'])) {
+                // update product variante
+                ProductVariant::where('uuid', $variant['uuid'])->update(Arr::except($variant, ['uuid', 'options']));
+
+                // update product variant options
+                foreach ($variant['options'] as $option) {
+                    if (!empty($option['uuid'])) {
+                        // make sure additional cost is always numbers only
+                        if (isset($option['additional_cost'])) {
+                            $option['additional_cost'] = Utils::numbersOnly($option['additional_cost']);
+                        }
+
+                        $updateAttrs = Arr::except($option, ['uuid']);
+
+                        ProductVariantOption::where('uuid', $option['uuid'])->update($updateAttrs);
+                        continue;
+                    }
+
+                    $option['product_variant_uuid'] = $variant['uuid'];
+                    ProductVariantOption::create($option);
+                }
+                continue;
+            }
+
+            // create new variant
+            $variant['created_by_uuid'] = Request::session()->get('user');
+            $variant['company_uuid'] = Request::session()->get('company');
+            $variant['product_uuid'] = $product->uuid;
+
+            $productVariant = ProductVariant::create(Arr::except($variant, ['options']));
+
+            foreach ($variant['options'] as $option) {
+                $option['product_variant_uuid'] = $productVariant->uuid;
+                ProductVariantOption::create($option);
+            }
+        }
+    }
+}

package/server/src/Providers/EventServiceProvider.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Fleetbase\Storefront\Providers;
+
+use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
+
+class EventServiceProvider extends ServiceProvider
+{
+    /**
+     * The event listener mappings for the application.
+     *
+     * @var array
+     */
+    protected $listen = [
+        /**
+         * Order Events
+         */
+        \Fleetbase\FleetOps\Events\OrderStarted::class => [\Fleetbase\Storefront\Listeners\HandleOrderStarted::class],
+        \Fleetbase\FleetOps\Events\OrderDispatched::class => [\Fleetbase\Storefront\Listeners\HandleOrderDispatched::class],
+        \Fleetbase\FleetOps\Events\OrderCompleted::class => [\Fleetbase\Storefront\Listeners\HandleOrderCompleted::class],
+        \Fleetbase\FleetOps\Events\OrderDriverAssigned::class => [\Fleetbase\Storefront\Listeners\HandleOrderDriverAssigned::class],
+    ];
+}

package/server/src/Providers/StorefrontServiceProvider.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Fleetbase\Storefront\Providers;
+
+use Fleetbase\Providers\CoreServiceProvider;
+use Fleetbase\FleetOps\Providers\FleetOpsServiceProvider;
+
+if (!class_exists(CoreServiceProvider::class)) {
+    throw new \Exception('Storefront cannot be loaded without `fleetbase/core-api` installed!');
+}
+
+if (!class_exists(FleetOpsServiceProvider::class)) {
+    throw new \Exception('Storefront cannot be loaded without `fleetbase/fleetops-api` installed!');
+}
+
+/**
+ * Storefront service provider.
+ *
+ * @package \Fleetbase\Storefront\Providers
+ */
+class StorefrontServiceProvider extends CoreServiceProvider
+{
+    /**
+     * The observers registered with the service provider.
+     *
+     * @var array
+     */
+    public $observers = [
+        \Fleetbase\Storefront\Models\Product::class => \Fleetbase\Storefront\Observers\ProductObserver::class,
+        \Fleetbase\Storefront\Models\Network::class => \Fleetbase\Storefront\Observers\NetworkObserver::class,
+    ];
+
+    /**
+     * The middleware groups registered with the service provider.
+     *
+     * @var array
+     */
+    public $middleware = [
+        'storefront.api' => [
+            'throttle:60,1',
+            \Illuminate\Session\Middleware\StartSession::class,
+            \Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
+            \Fleetbase\Storefront\Http\Middleware\SetStorefrontSession::class,
+            \Fleetbase\Http\Middleware\ConvertStringBooleans::class,
+            \Fleetbase\Http\Middleware\SetGlobalHeaders::class,
+            \Illuminate\Routing\Middleware\SubstituteBindings::class,
+            \Fleetbase\Http\Middleware\LogApiRequests::class,
+        ],
+    ];
+
+    /**
+     * The console commands registered with the service provider.
+     *
+     * @var array
+     */
+    public $commands = [
+        \Fleetbase\Storefront\Console\Commands\NotifyStorefrontOrderNearby::class
+    ];
+
+    /**
+     * Register any application services.
+     *
+     * Within the register method, you should only bind things into the 
+     * service container. You should never attempt to register any event 
+     * listeners, routes, or any other piece of functionality within the 
+     * register method.
+     *
+     * More information on this can be found in the Laravel documentation:
+     * https://laravel.com/docs/8.x/providers
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->register(CoreServiceProvider::class);
+        $this->app->register(FleetOpsServiceProvider::class);
+    }
+
+    /**
+     * Bootstrap any package services.
+     *
+     * @return void
+     *
+     * @throws \Exception If the `fleetbase/core-api` package is not installed.
+     * @throws \Exception If the `fleetbase/fleetops-api` package is not installed.
+     */
+    public function boot()
+    {
+        $this->registerCommands();
+        $this->scheduleCommands(function ($schedule) {
+            $schedule->command('storefront:notify-order-nearby')->everyMinute();
+        });
+        $this->registerObservers();
+        $this->registerMiddleware();
+        $this->registerExpansionsFrom(__DIR__ . '/../Expansions');
+        $this->loadRoutesFrom(__DIR__ . '/../routes.php');
+        $this->loadMigrationsFrom(__DIR__ . '/../../migrations');
+        $this->mergeConfigFrom(__DIR__ . '/../../config/database.connections.php', 'database.connections');
+        $this->mergeConfigFrom(__DIR__ . '/../../config/storefront.php', 'storefront');
+        $this->mergeConfigFrom(__DIR__ . '/../../config/api.php', 'storefront.api');
+        $this->mergeConfigFrom(__DIR__ . '/../../config/twilio-notification-channel.php', 'twilio-notification-channel');
+    }
+}