Adds product/save to message queue

Api/ReclaimInterface.php

@@ -27,6 +27,14 @@ public function reclaim();
      */
     public function getWebhookSecret();
 
+    /**
+     * Returns the registered webhooks
+     *
+     * @return mixed[]
+     * @api
+     */
+    public function getWebhooks();
+
     /**
      * Returns the Klaviyo log file
      *

Cron/EventsTopic.php

@@ -2,6 +2,7 @@
 
 namespace Klaviyo\Reclaim\Cron;
 
+use Klaviyo\Reclaim\Helper\CategoryMapper;
 use Klaviyo\Reclaim\Helper\Logger;
 use Klaviyo\Reclaim\Model\SyncsFactory;
 use Klaviyo\Reclaim\Model\Quote\QuoteIdMask;
@@ -36,37 +37,31 @@ class EventsTopic
     protected $_klSyncFactory;
 
     /**
-     * Magento Category Factory
-     * @var CategoryFactory
+     * Klaviyo helper for mapping category ids to names
+     * @var CategoryMapper $categoryMapperactory
      */
-    protected $_categoryFactory;
-
-    /**
-     * Category Map of ids to names
-     * @var array
-     */
-    protected $categoryMap = [];
-
+    protected $_categoryMapper;
     /**
      * @param Logger $klaviyoLogger
      * @param CollectionFactory $eventsCollectionFactory
      * @param SyncsFactory $klSyncFactory
      * @param QuoteIdMask $quoteIdMaskResource
      * @param CategoryFactory $categoryFactory
+     * @param CategoryMapper $categoryMapper
      */
     public function __construct(
         Logger $klaviyoLogger,
         CollectionFactory $eventsCollectionFactory,
         SyncsFactory $klSyncFactory,
         QuoteIdMask $quoteIdMaskResource,
-        CategoryFactory $categoryFactory
+        CategoryMapper $categoryMapper
     )
     {
         $this->_klaviyoLogger = $klaviyoLogger;
         $this->_eventsCollectionFactory = $eventsCollectionFactory;
         $this->_klSyncFactory = $klSyncFactory;
         $this->_quoteIdMaskResource = $quoteIdMaskResource;
-        $this->_categoryFactory = $categoryFactory;
+        $this->_categoryMapper = $categoryMapper;
     }
 
     /**
@@ -89,7 +84,7 @@ public function moveRowsToSync()
         // Capture all events that have been moved and add data to Sync table
         foreach ($eventsData as $event){
             if ($event['event'] == 'Added To Cart') {
-                $event['payload'] = json_encode($this->replaceQuoteIdAndCategoryIds($event['payload']));
+                $event['payload'] = json_encode($this->_categoryMapper->replaceQuoteIdAndCategoryIds($event['payload']));
             }
 
             //TODO: This can probably be done as one bulk update instead of individual inserts
@@ -137,54 +132,8 @@ public function replaceQuoteIdAndCategoryIds(string $payload): array
         unset($decoded_payload['QuoteId']);
 
         // Replace CategoryIds for Added Item, Quote Items with resp. CategoryNames
-        $decoded_payload = $this->replaceCategoryIdsWithNames($decoded_payload);
+        $decoded_payload = $this->_categoryMapper->replaceCategoryIdsWithNames($decoded_payload);
 
         return $decoded_payload;
     }
-
-    /**
-     * Replace all CategoryIds in event payload with their respective names
-     * @param $payload
-     * @return array
-     */
-    public function replaceCategoryIdsWithNames(array $payload): array
-    {
-        $this->updateCategoryMap($payload['Categories']);
-
-        foreach ($payload['Items'] as &$item){
-            $item['Categories'] = $this->searchCategoryMapAndReturnNames($item['Categories']);
-        }
-
-        $payload['AddedItemCategories'] = $this->searchCategoryMapAndReturnNames($payload['AddedItemCategories']);
-        $payload['Categories'] = $this->searchCategoryMapAndReturnNames($payload['Categories']);
-
-        return $payload;
-    }
-
-    /**
-     * Retrieve categoryNames using categoryIds
-     * @param array $categoryIds
-     */
-    public function updateCategoryMap(array $categoryIds)
-    {
-        $categoryFactory = $this->_categoryFactory->create();
-
-        foreach($categoryIds as $categoryId){
-            if (!in_array($categoryId, $this->categoryMap)){
-                $this->categoryMap[$categoryId] = $categoryFactory->load($categoryId)->getName();
-            }
-        }
-    }
-
-    /**
-     * Return array of CategoryNames from CategoryMap using ids
-     * @param array $categoryIds
-     * @return array
-     */
-    public function searchCategoryMapAndReturnNames(array $categoryIds): array
-    {
-        return array_values(
-            array_intersect_key($this->categoryMap, array_flip($categoryIds))
-        );
-    }
 }

Cron/ProductsTopic.php

@@ -0,0 +1,104 @@
+<?php
+
+namespace Klaviyo\Reclaim\Cron;
+
+use Klaviyo\Reclaim\Helper\CategoryMapper;
+use Klaviyo\Reclaim\Helper\Logger;
+use Klaviyo\Reclaim\Model\SyncsFactory;
+use Klaviyo\Reclaim\Model\ResourceModel\Products;
+use Klaviyo\Reclaim\Model\ResourceModel\Products\CollectionFactory;
+
+class ProductsTopic
+{
+    /**
+     * Klaviyo Logger
+     * @var Logger
+     */
+    protected $_klaviyoLogger;
+
+    /**
+     * Klaviyo helper for mapping category ids to names
+     * @var CategoryMapper $categoryMapperactory
+     */
+    protected $_categoryMapper;
+
+    /**
+     * Klaviyo Products Resource Model
+     * @var Products
+     */
+    protected $_klProduct;
+
+    /**
+     * Klaviyo Products Collection
+     * @var CollectionFactory
+     */
+    protected $_klProductCollectionFactory;
+
+    /**
+     * Klaviyo Syncs Model
+     * @var SyncsFactory
+     */
+    protected $_klSyncFactory;
+
+    /**
+     * @param Logger $klaviyoLogger
+     * @param Products $klProduct
+     * @param SyncsFactory $klSyncFactory
+     * @param CollectionFactory $klProductCollectionFactory
+     * @param CategoryMapper $categoryMapper
+     */
+    public function __construct(
+        Logger $klaviyoLogger,
+        Products $klProduct,
+        CategoryMapper $categoryMapper,
+        SyncsFactory $klSyncFactory,
+        CollectionFactory $klProductCollectionFactory
+    )
+    {
+        $this->_klaviyoLogger = $klaviyoLogger;
+        $this->_klProduct = $klProduct;
+        $this->_categoryMapper = $categoryMapper;
+        $this->_klSyncFactory = $klSyncFactory;
+        $this->_klProductCollectionFactory = $klProductCollectionFactory;
+    }
+
+    public function queueKlProductsForSync()
+    {
+        $klProductsCollection = $this->_klProductCollectionFactory->create();
+        $klProductsToSync = $klProductsCollection->getRowsForSync('NEW')
+            ->addFieldToSelect(['id','payload','status','topic', 'klaviyo_id'])
+            ->getData();
+
+        if (empty($klProductsToSync)) {return;}
+
+        $idsToUpdate = [];
+
+        foreach ($klProductsToSync as $klProductToSync)
+        {
+            $klProductToSync['payload'] = json_encode($this->_categoryMapper->addCategoryNames($klProductToSync['payload']));
+            $klSync = $this->_klSyncFactory->create();
+            $klSync->setData([
+                'payload'=> $klProductToSync['payload'],
+                'topic'=> $klProductToSync['topic'],
+                'klaviyo_id'=>$klProductToSync['klaviyo_id'],
+                'status'=> 'NEW'
+            ]);
+            try {
+                $klSync->save();
+                array_push($idsToUpdate, $klProductToSync['id']);
+            } catch (\Exception $e) {
+                $this->_klaviyoLogger->log(sprintf('Unable to move row: %s', $e->getMessage()));
+            }
+        }
+
+        $klProductsCollection->updateRowStatus($idsToUpdate, 'MOVED');
+    }
+
+    public function clean()
+    {
+        $klProductsCollection = $this->_klProductCollectionFactory->create();
+        $idsToDelete = $klProductsCollection->getIdsToDelete('MOVED');
+
+        $klProductsCollection->deleteRows($idsToDelete);
+    }
+}

Helper/CategoryMapper.php

@@ -0,0 +1,107 @@
+<?php
+
+namespace Klaviyo\Reclaim\Helper;
+
+use Magento\Catalog\Model\CategoryFactory;
+
+class CategoryMapper extends \Magento\Framework\App\Helper\AbstractHelper
+{
+    /**
+     * Magento Category Factory
+     * @var CategoryFactory
+     */
+    protected $_categoryFactory;
+
+    /**
+     * Category Map of ids to names
+     * @var array
+     */
+    protected $categoryMap = [];
+
+    /**
+     * @param CategoryFactory $categoryFactory
+     */
+    public function __construct(
+        CategoryFactory $categoryFactory
+    ){
+        $this->_categoryFactory = $categoryFactory;
+    }
+
+    /**
+     * Replace all CategoryIds in payload with their respective names
+     * @param $payload
+     * @return array
+     */
+    public function replaceCategoryIdsWithNames(array $payload): array
+    {
+        $this->updateCategoryMap($payload['Categories']);
+
+        foreach ($payload['Items'] as &$item){
+            $item['Categories'] = $this->searchCategoryMapAndReturnNames($item['Categories']);
+        }
+
+        $payload['AddedItemCategories'] = $this->searchCategoryMapAndReturnNames($payload['AddedItemCategories']);
+        $payload['Categories'] = $this->searchCategoryMapAndReturnNames($payload['Categories']);
+
+        return $payload;
+    }
+
+    /**
+     * Adds all category names in payload to their respective ids
+     * @param $payload json encoded string of the payload
+     * @return array
+     */
+    public function addCategoryNames(string $payload): array
+    {
+        $decoded_payload = json_decode($payload, true);
+        $this->updateCategoryMap($decoded_payload['product']['Categories']);
+
+        $decoded_payload['product']['Categories'] = $this->
+          searchCategoryMapAndReturnIdsAndNames(
+            $decoded_payload['product']['Categories']
+          );
+
+        return $decoded_payload;
+    }
+
+    /**
+     * Retrieve categoryNames using categoryIds
+     * @param array $categoryIds
+     */
+    public function updateCategoryMap(array $categoryIds)
+    {
+        $categoryFactory = $this->_categoryFactory->create();
+
+        foreach($categoryIds as $categoryId){
+            if (!in_array($categoryId, $this->categoryMap)){
+                $this->categoryMap[$categoryId] = $categoryFactory->load($categoryId)->getName();
+            }
+        }
+    }
+
+    /**
+     * Return array of CategoryNames from CategoryMap using ids
+     * @param array $categoryIds
+     * @return array
+     */
+    public function searchCategoryMapAndReturnNames(array $categoryIds): array
+    {
+        return array_values(
+            array_intersect_key($this->categoryMap, array_flip($categoryIds))
+        );
+    }
+
+    /**
+     * Return array of arrays mapping category ids to their names
+     * @param array $categoryIds
+     * @return array
+     */
+    public function searchCategoryMapAndReturnIdsAndNames(array $categoryIds): array
+    {
+        $categoryIdsAndNames = [];
+        foreach ($categoryIds as $categoryId){
+          $categoryIdsAndNames[$categoryId] = $this->categoryMap[$categoryId];
+        }
+        return $categoryIdsAndNames;
+    }
+}

Helper/ScopeSetting.php

@@ -29,8 +29,9 @@ class ScopeSetting extends \Magento\Framework\App\Helper\AbstractHelper
     const KLAVIYO_NAME_DEFAULT = 'klaviyo';
 
     const WEBHOOK_SECRET = 'klaviyo_reclaim_webhook/klaviyo_webhooks/webhook_secret';
-    const PRODUCT_DELETE_BEFORE = 'klaviyo_reclaim_webhook/klaviyo_webhooks/using_product_delete_before_webhook';
-
+    const PRODUCT_DELETE_WEBHOOK = 'klaviyo_reclaim_webhook/klaviyo_webhooks/using_product_delete_webhook';
+    const PRODUCT_SAVE_WEBHOOK = 'klaviyo_reclaim_webhook/klaviyo_webhooks/using_product_save_webhook';
+
     const KLAVIYO_OAUTH_NAME = 'klaviyo_reclaim_oauth/klaviyo_oauth/integration_name';
 
     protected $_scopeConfig;
@@ -143,6 +144,14 @@ public function getWebhookSecret($storeId = null)
         return $this->getScopeSetting(self::WEBHOOK_SECRET, $storeId);
     }
 
+    public function getWebhooks()
+    {
+        return $registeredWebhooks = [
+          ['product/delete', $this->getProductDeleteWebhookSetting()],
+          ['product/save', $this->getProductSaveWebhookSetting()],
+        ];
+    }
+
     public function isEnabled($storeId = null)
     {
         return $this->getScopeSetting(self::ENABLE, $storeId);
@@ -221,7 +230,7 @@ public function getConsentAtCheckoutSMSListId($storeId = null)
     {
         return $this->getScopeSetting(self::CONSENT_AT_CHECKOUT_SMS_LIST_ID, $storeId);
     }
-    
+
     public function getConsentAtCheckoutSMSConsentText($storeId = null)
     {
         return $this->getScopeSetting(self::CONSENT_AT_CHECKOUT_SMS_CONSENT_TEXT, $storeId);
@@ -259,10 +268,14 @@ public function getStoreIdKlaviyoAccountSetMap($storeIds)
         return $storeMap;
     }
 
-    public function getProductDeleteBeforeSetting($storeId = null)
+    public function getProductDeleteWebhookSetting($storeId = null)
     {
-        return $this->getScopeSetting(self::PRODUCT_DELETE_BEFORE, $storeId);
+        return $this->getScopeSetting(self::PRODUCT_DELETE_WEBHOOK, $storeId);
     }
 
-}
+    public function getProductSaveWebhookSetting($storeId = null)
+    {
+        return $this->getScopeSetting(self::PRODUCT_SAVE_WEBHOOK, $storeId);
+    }
 
+}