Handle lists in multiple Mailchimp accounts (#172)

* Add the possibility to handle lists in multiple mailchimp accounts.

* fix missing namespace in import

* Fix several bugs related to multiple mailchimp accounts

Author: markus-moser

doc/24_NewsletterSync/MultipleMailchimpAccounts.md

@@ -0,0 +1,60 @@
+# Multiple Mailchimp Accounts
+
+Optionally it's possible to configure the service container to be able to handle multiple mailchimp accounts. Principally it's handled the same way like newsletter lists via mailchimp provider handler services (see [Configuration](../03_Configuration.md) for an example definition)*[]: 
+
+But additionally to the standard constructor arguments of the mailchimp provider handler class it's needed to setup a specialized export service which holds the Mailchimp client with the alternative API key.
+
+An example config might look like this:
+
+```yaml
+  appbundle.cmf.mailchimp.client:
+    class: DrewM\MailChimp
+    arguments:
+      - 'my-example-api-key'
+  
+  appbundle.cmf.mailchimp.export-service:
+    class: CustomerManagementFrameworkBundle\Newsletter\ProviderHandler\Mailchimp\MailChimpExportService
+    arguments:
+      - '@appbundle.cmf.mailchimp.client'
+
+  appbundle.cmf.mailchimp.handler.list1:
+    class: CustomerManagementFrameworkBundle\Newsletter\ProviderHandler\Mailchimp
+    autowire: true
+    arguments:
+        # Shortcut of the handler/list for internal use
+        $shortcut: list1
+        
+        # List ID within Mailchimp
+        $listId: ls938393f
+        
+        # Mapping of Pimcore status field => Mailchimp status
+        $statusMapping:
+          manuallySubscribed: subscribed
+          singleOptIn: subscribed
+          doubleOptIn: subscribed
+          unsubscribed: unsubscribed
+          pending: pending
+          
+        # Reverse mapping of Mailchimp status => Pimcore status field
+        $reverseStatusMapping:
+          subscribed: doubleOptIn
+          unsubscribed: unsubscribed
+          pending: pending
+
+        # Mapping of Pimcore data object attributes => Mailchimp merge fields
+        $mergeFieldMapping:
+          firstname: FNAME
+          lastname: LNAME
+          street: STREET
+          birthDate: BIRTHDATE
+
+        # Special data transfromer for the birthDate field. 
+        # This ensures that the correct data format will be used.
+        $fieldTransformers:
+          birthDate: '@appbundle.cmf.mailchimp.birthdate-transformer'
+          
+        $exportService: '@appbundle.cmf.mailchimp.export-service'
+
+    tags: [cmf.newsletter_provider_handler]
+        
+```

doc/24_NewsletterSync/README.md

@@ -17,6 +17,8 @@ Further than that, the CMF can handle multiple MailChimp lists. Each list is one
 See [Configuration](../03_Configuration.md) for an example configuration of such a service and for a list of general 
 newsletter related settings.
 
+See [Multiple Mailchimp Accounts](./MultipleMailchimpAccounts.md) if you need to handle lists within different Mailchimp accounts.
+
 
 ## Prepare Data Objects for MailChimp Sync
 

src/Event/Newsletter/Mailchimp/TemplateExportResolveProviderHandlerEvent.php

@@ -0,0 +1,72 @@
+<?php
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Enterprise License (PEL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PEL
+ */
+
+namespace CustomerManagementFrameworkBundle\Event\Newsletter\Mailchimp;
+
+use CustomerManagementFrameworkBundle\Newsletter\ProviderHandler\Mailchimp;
+use Symfony\Component\EventDispatcher\Event;
+use Pimcore\Model\Document;
+
+class TemplateExportResolveProviderHandlerEvent extends Event
+{
+    const NAME = 'plugin.cmf.newsletter.mailchimp.template-export-resolve-provider-handler';
+
+    /**
+     * @var Mailchimp|null
+     */
+    private $providerHandler;
+
+    /**
+     * @var Document\PageSnippet $document
+     */
+    private $document;
+
+    /**
+     * @param Document\PageSnippet $document
+     */
+    public function __construct(Document\PageSnippet $document)
+    {
+        $this->document = $document;
+    }
+
+    public function getName()
+    {
+        return self::NAME;
+    }
+
+    /**
+     * @return Mailchimp|null
+     */
+    public function getProviderHandler(): Mailchimp
+    {
+        return $this->providerHandler;
+    }
+
+    /**
+     * @return Document\PageSnippet
+     */
+    public function getDocument(): Document\PageSnippet
+    {
+        return $this->document;
+    }
+
+    /**
+     * @param Mailchimp|null $providerHandler
+     */
+    public function setProviderHandler(Mailchimp $providerHandler)
+    {
+        $this->providerHandler = $providerHandler;
+    }
+}

src/Newsletter/ProviderHandler/Mailchimp.php

@@ -438,7 +438,7 @@ public function updateSegmentGroups($forceUpdate = false)
 
         $groupIds = [];
         foreach ($groups as $group) {
-            $remoteGroupId = $this->segmentExporter->exportGroup($group, $this->listId, false, $forceUpdate);
+            $remoteGroupId = $this->segmentExporter->exportGroup($group, $this, false, $forceUpdate);
 
             $groupIds[] = $remoteGroupId;
 
@@ -454,13 +454,13 @@ public function updateSegmentGroups($forceUpdate = false)
                 /**
                  * @var CustomerSegment $segment
                  */
-                $segmentIds[] = $this->segmentExporter->exportSegment($segment, $this->listId, $remoteGroupId, $forceCreate, $forceUpdate);
+                $segmentIds[] = $this->segmentExporter->exportSegment($segment, $this, $remoteGroupId, $forceCreate, $forceUpdate);
             }
 
-            $this->segmentExporter->deleteNonExistingSegmentsFromGroup($segmentIds, $this->listId, $remoteGroupId);
+            $this->segmentExporter->deleteNonExistingSegmentsFromGroup($segmentIds, $this, $remoteGroupId);
         }
 
-        $this->segmentExporter->deleteNonExistingGroups($groupIds, $this->listId);
+        $this->segmentExporter->deleteNonExistingGroups($groupIds, $this);
     }
 
     protected function getExportableSegmentGroups()
@@ -856,6 +856,14 @@ public function getActiveCustomerByEmail($email)
         return $customer;
     }
 
+    /**
+     * @return MailChimpExportService
+     */
+    public function getExportService(): MailChimpExportService
+    {
+        return $this->exportService;
+    }
+
     protected function getCustomerProvider(): CustomerProviderInterface
     {
         /**

src/Newsletter/ProviderHandler/Mailchimp/CliSyncProcessor.php

@@ -33,11 +33,6 @@ class CliSyncProcessor
      */
     protected $pimcoreUserName;
 
-    /**
-     * @var MailChimpExportService
-     */
-    protected $exportService;
-
     /**
      * @var CustomerProviderInterface
      */
@@ -53,7 +48,7 @@ class CliSyncProcessor
      */
     protected $newsletterManager;
 
-    public function __construct($pimcoreUserName = null, MailChimpExportService $exportService, CustomerProviderInterface $customerProvider, UpdateFromMailchimpProcessor $updateFromMailchimpProcessor, NewsletterManagerInterface $newsletterManager)
+    public function __construct($pimcoreUserName = null, CustomerProviderInterface $customerProvider, UpdateFromMailchimpProcessor $updateFromMailchimpProcessor, NewsletterManagerInterface $newsletterManager)
     {
         $this->setLoggerComponent('NewsletterSync');
 
@@ -65,19 +60,19 @@ public function __construct($pimcoreUserName = null, MailChimpExportService $exp
             }
         }
 
-        $this->exportService = $exportService;
         $this->customerProvider = $customerProvider;
         $this->updateFromMailchimpProcessor = $updateFromMailchimpProcessor;
         $this->newsletterManager = $newsletterManager;
     }
 
     public function syncStatusChanges()
     {
-        $client = $this->exportService->getApiClient();
-
         foreach ($this->newsletterManager->getNewsletterProviderHandlers() as $newsletterProviderHandler) {
             if ($newsletterProviderHandler instanceof Mailchimp) {
 
+                $exportService = $newsletterProviderHandler->getExportService();
+                $client = $exportService->getApiClient();
+
                 // get updates from the last 30 days
                 $date = Carbon::createFromTimestamp(time() - (60 * 60 * 24 * 30));
                 $date = $date->toIso8601String();
@@ -86,7 +81,7 @@ public function syncStatusChanges()
                 $page = 0;
                 while(true) {
                     $result = $client->get(
-                        $this->exportService->getListResourceUrl(
+                        $exportService->getListResourceUrl(
                             $newsletterProviderHandler->getListId(),
                             'members/?since_last_changed='.urlencode($date) . '&count=' . $count . '&offset=' . ($page * $count)
                         )
@@ -161,15 +156,17 @@ public function syncStatusChanges()
 
     public function deleteNonExistingItems()
     {
-        $client = $this->exportService->getApiClient();
 
         foreach ($this->newsletterManager->getNewsletterProviderHandlers() as $newsletterProviderHandler) {
             if ($newsletterProviderHandler instanceof Mailchimp) {
 
+                $exportService = $newsletterProviderHandler->getExportService();
+                $client = $exportService->getApiClient();
+
                 $count = 20;
                 $page = 0;
                 while(true) {
-                    $url = $this->exportService->getListResourceUrl($newsletterProviderHandler->getListId(), 'members/?count=' . $count . '&offset=' . ($page * $count) );
+                    $url = $exportService->getListResourceUrl($newsletterProviderHandler->getListId(), 'members/?count=' . $count . '&offset=' . ($page * $count) );
                     $result = $client->get(
                         $url
                     );
@@ -201,7 +198,7 @@ public function deleteNonExistingItems()
                             );
 
                             $client->delete(
-                                $this->exportService->getListResourceUrl($newsletterProviderHandler->getListId(), sprintf('members/%s', $remoteId))
+                                $exportService->getListResourceUrl($newsletterProviderHandler->getListId(), sprintf('members/%s', $remoteId))
                             );
 
                             if ($client->success()) {

src/Newsletter/ProviderHandler/Mailchimp/CustomerExporter/AbstractExporter.php

@@ -32,7 +32,7 @@ abstract class AbstractExporter
     protected $exportService;
 
     /**
-     * @var MailChimp
+     * @var MailChimp|null
      */
     protected $apiClient;
 
@@ -42,26 +42,22 @@ abstract class AbstractExporter
     protected $newsletterQueue;
 
     /**
-     * AbstractExporter constructor.
-     *
-     * @param MailChimpExportService $interpreter
+     * @param NewsletterQueueInterface $newsletterQueue
      */
-    public function __construct(MailChimpExportService $exportService, NewsletterQueueInterface $newsletterQueue)
+    public function __construct(NewsletterQueueInterface $newsletterQueue)
     {
-        $this->exportService = $exportService;
-        $this->apiClient = $exportService->getApiClient();
         $this->newsletterQueue = $newsletterQueue;
         $this->setLoggerComponent('NewsletterSync');
     }
-    
+
     /**
      * Get an array containing the HTTP headers and the body of the API response.
      *
      * @return array  Assoc array with keys 'headers' and 'body'
      */
     public function getLastResponse()
     {
-        return $this->apiClient->getLastResponse();
+        return $this->apiClient ? $this->apiClient->getLastResponse() : [];
     }
 
     /**
@@ -75,4 +71,16 @@ protected function getCustomer($id)
             ->get('cmf.customer_provider')
             ->getById($id);
     }
+
+    /**
+     * used to be able to track the last response independently of the concrete mailchimp account
+     *
+     * @param MailChimpExportService $exportService
+     * @return MailChimp
+     */
+    protected function getApiClientFromExportService(MailChimpExportService $exportService): MailChimp
+    {
+        $this->apiClient = $exportService->getApiClient();
+        return $exportService->getApiClient();
+    }
 }