Shopify integration

README.md

@@ -144,8 +144,10 @@ Example of importing a gzipped mysql dump:
 1. Install composer and run `composer install` on the root directory
 1. Run `php init` for development
 
-Frontend: localhost:30000 API: localhost:30001 MySQL: localhost:30002 PhpMyAdmin: localhost:30003 Shopify: localhost:
-30004
+Frontend: localhost:30000  
+API: localhost:30001  
+MySQL: localhost:30002   
+PhpMyAdmin: localhost:30003
 
 ### Running queue jobs locally
 

common/config/bootstrap.php

@@ -2,5 +2,4 @@
 Yii::setAlias('@common', dirname(__DIR__));
 Yii::setAlias('@api', dirname(dirname(__DIR__)) . '/api');
 Yii::setAlias('@frontend', dirname(dirname(__DIR__)) . '/frontend');
-Yii::setAlias('@shopify', dirname(dirname(__DIR__)) . '/shopify');
 Yii::setAlias('@console', dirname(dirname(__DIR__)) . '/console');

common/config/params.php

@@ -7,8 +7,6 @@
     'user.passwordResetTokenExpire' => 3600,
     'stripePublicKey'               => '1234',
     'stripePrivateKey'              => '1234',
-    'shopifyPublicKey'              => '5678',
-    'shopifyPrivateKey'             => '5678',
     'encryptionKey'                 => 'secret',
     'digitalOceanKey'               => 'key',
     'digitalOceanSecret'            => 'secret',
@@ -18,10 +16,6 @@
         'clientId' => 'lolno',
         'secret' => 'lulz',
     ],
-    /**
-     * Shopify App Parameters and App Credentials
-     */
-
 
     /**
      * Put here default values for when customers meta value does not exist
@@ -69,4 +63,20 @@
     'csvBoxS3Bucket' => '',
     'csvBoxS3Path' => '',
     'csvBoxImportKey' => '',
+
+    /**
+     * Shopify
+     */
+    'shopify' => [
+        /**
+         * Visit https://partners.shopify.com/ -> Apps -> Your App -> Overview -> Client credentials
+         */
+        'client_id' => '',
+        'client_secret' => '',
+        /**
+         * You can set `https://shipwise.ngrok.io` to test it locally.
+         * Otherwise, if leave the default value, the current server's domain name will be used automatically.
+         */
+        'override_redirect_domain' => false,
+    ],
 ];

common/models/EcommerceIntegration.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace common\models;
+
+use Yii;
+use yii\helpers\Html;
+use common\models\base\BaseEcommerceIntegration;
+use console\jobs\NotificationJob;
+use common\traits\MetaDataFieldTrait;
+use common\services\platforms\ShopifyService;
+
+/**
+ * Class EcommerceIntegration
+ * @package common\models
+ */
+class EcommerceIntegration extends BaseEcommerceIntegration
+{
+    use MetaDataFieldTrait;
+
+    public const STATUS_INTEGRATION_CONNECTED = 1;
+    public const STATUS_INTEGRATION_PAUSED = 0;
+    public const STATUS_INTEGRATION_UNINSTALLED = -1;
+
+    public function init(): void
+    {
+        parent::init();
+        $this->on(self::EVENT_AFTER_FIND, [$this, 'convertMetaData']);
+    }
+
+    public static function getStatuses(): array
+    {
+        return [
+            self::STATUS_INTEGRATION_CONNECTED => 'Connected',
+            self::STATUS_INTEGRATION_PAUSED => 'Paused',
+            self::STATUS_INTEGRATION_UNINSTALLED => 'Uninstalled',
+        ];
+    }
+
+    public function isConnected(): bool
+    {
+        return $this->status === self::STATUS_INTEGRATION_CONNECTED;
+    }
+
+    public function isPaused(): bool
+    {
+        return $this->status === self::STATUS_INTEGRATION_PAUSED;
+    }
+
+    public function isUninstalled(): bool
+    {
+        return $this->status === self::STATUS_INTEGRATION_UNINSTALLED;
+    }
+
+    /**
+     * @throws \yii\db\StaleObjectException
+     * @throws \Throwable
+     * @throws \yii\base\InvalidConfigException
+     */
+    public function disconnect(): bool|int
+    {
+        switch ($this->ecommercePlatform->name) {
+            case EcommercePlatform::SHOPIFY_PLATFORM_NAME:
+
+                $shopifyService = new ShopifyService($this->array_meta_data['shop_url'], $this);
+                $shopifyService->deleteWebhookListenersJob();
+
+                break;
+        }
+
+        return $this->delete();
+    }
+
+    public function uninstall(bool $withNotification = false): void
+    {
+        $this->status = self::STATUS_INTEGRATION_UNINSTALLED;
+        $this->save();
+
+        if ($withNotification) {
+            $shopUrl = Html::encode($this->array_meta_data['shop_url']);
+            $subject = '⚠️ Problem pulling data from ' . $shopUrl;
+            $message = 'We were not able to pull data from the Shopify shop ' . $shopUrl .'.';
+            $message .= ' The status of the shop is changed to `Uninstalled`.';
+            $message .= ' Please click the link below and try to reconnect the shop.';
+
+            Yii::$app->queue->push(
+                new NotificationJob([
+                    'customer_id' => $this->customer_id,
+                    'subject' => $subject,
+                    'message' => $message,
+                    'url' => ['/ecommerce-integration/index'],
+                    'urlText' => 'Reconnect the shop',
+                ])
+            );
+        }
+    }
+
+    public function pause(): bool
+    {
+        $this->status = self::STATUS_INTEGRATION_PAUSED;
+        return $this->save();
+    }
+
+    public function resume(): bool
+    {
+        $this->status = self::STATUS_INTEGRATION_CONNECTED;
+        return $this->save();
+    }
+}

common/models/EcommerceOrderLog.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace common\models;
+
+use yii\helpers\Json;
+use common\models\base\BaseEcommerceOrderLog;
+use common\traits\MetaDataFieldTrait;
+
+/**
+ * Class EcommerceOrderLog
+ * @package common\models
+ */
+class EcommerceOrderLog extends BaseEcommerceOrderLog
+{
+    use MetaDataFieldTrait;
+
+    public const STATUS_SUCCESS = 'success';
+    public const STATUS_FAILED = 'failed';
+
+    public static function getStatuses(): array
+    {
+        return [
+            self::STATUS_SUCCESS => 'Success',
+            self::STATUS_FAILED => 'Failed',
+        ];
+    }
+
+    public static function success(EcommerceIntegration $ecommerceIntegration, array $payload, Order $order): void
+    {
+        $ecommerceOrderLog = new EcommerceOrderLog();
+        $ecommerceOrderLog->platform_id = $ecommerceIntegration->ecommercePlatform->id;
+        $ecommerceOrderLog->integration_id = $ecommerceIntegration->id;
+        $ecommerceOrderLog->original_order_id = (string)$payload['id'];
+        $ecommerceOrderLog->internal_order_id = $order->id;
+        $ecommerceOrderLog->status = self::STATUS_SUCCESS;
+        $ecommerceOrderLog->payload = Json::encode($payload, JSON_PRETTY_PRINT);
+        $ecommerceOrderLog->save();
+    }
+
+    public static function failed(EcommerceIntegration $ecommerceIntegration, array $payload, ?array $meta = null): void
+    {
+        $ecommerceOrderLog = new EcommerceOrderLog();
+        $ecommerceOrderLog->platform_id = $ecommerceIntegration->ecommercePlatform->id;
+        $ecommerceOrderLog->integration_id = $ecommerceIntegration->id;
+        $ecommerceOrderLog->original_order_id = (string)$payload['id'];
+        $ecommerceOrderLog->status = self::STATUS_FAILED;
+        $ecommerceOrderLog->payload = Json::encode($payload, JSON_PRETTY_PRINT);
+        $ecommerceOrderLog->meta = ($meta) ? Json::encode($meta, JSON_PRETTY_PRINT) : null;
+        $ecommerceOrderLog->save();
+    }
+}

common/models/EcommercePlatform.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace common\models;
+
+use yii\db\ActiveQuery;
+use common\models\base\BaseEcommercePlatform;
+use common\traits\MetaDataFieldTrait;
+
+/**
+ * Class EcommercePlatform
+ * @package common\models
+ */
+class EcommercePlatform extends BaseEcommercePlatform
+{
+    use MetaDataFieldTrait;
+
+    public const STATUS_PLATFORM_ACTIVE = 1;
+    public const STATUS_PLATFORM_INACTIVE = 0;
+
+    public const SHOPIFY_PLATFORM_NAME = 'Shopify';
+
+    public static function getStatuses(): array
+    {
+        return [
+            self::STATUS_PLATFORM_ACTIVE => 'Active',
+            self::STATUS_PLATFORM_INACTIVE => 'Inactive',
+        ];
+    }
+
+    public function getEcommerceIntegration(): ActiveQuery
+    {
+        return $this->hasOne(EcommerceIntegration::class, ['platform_id' => 'id']);
+    }
+
+    public function isActive(): bool
+    {
+        return $this->status === self::STATUS_PLATFORM_ACTIVE;
+    }
+
+    public function switchStatus(): void
+    {
+        $this->status = ($this->isActive()) ? self::STATUS_PLATFORM_INACTIVE : self::STATUS_PLATFORM_ACTIVE;
+        $this->save();
+    }
+
+    public function getConnectedShopsCounter(): int
+    {
+        return EcommerceIntegration::find()
+            ->where(['platform_id' => $this->id])
+            ->count();
+    }
+
+    public static function getShopifyObject(): ?EcommercePlatform
+    {
+        return self::findOne(['name' => self::SHOPIFY_PLATFORM_NAME]);
+    }
+}