Merge pull request #34 from dlubitz/feature/interest-categories

Feature: Add datasource for interest categories and interests

Author: bwaidelich

Classes/Wwwision/Neos/MailChimp/DataSource/InterestCategoryDataSource.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Wwwision\Neos\MailChimp\DataSource;
+
+use Neos\ContentRepository\Domain\Model\NodeInterface;
+use Neos\Neos\Service\DataSource\AbstractDataSource;
+use Wwwision\Neos\MailChimp\Domain\Service\MailChimpService;
+
+class InterestCategoryDataSource extends AbstractDataSource
+{
+    /**
+     * @var string
+     */
+    static protected $identifier = 'mailchimp-interest-category';
+
+    /**
+     * @var MailChimpService
+     */
+    protected $mailChimpService;
+
+    public function __construct(MailChimpService $mailChimpService)
+    {
+        $this->mailChimpService = $mailChimpService;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getData(NodeInterface $node = null, array $arguments = [])
+    {
+        $listId = $arguments['listId'];
+
+        $response = $this->mailChimpService->getInterestCategoriesByList($listId);
+        $interestCategories = $response['categories'] ?? [];
+
+        $data = [];
+        foreach ($interestCategories as $interestCategory) {
+            $data[] = [
+                'value' => $interestCategory['id'],
+                'label' => $interestCategory['title']
+            ];
+        }
+        return $data;
+    }
+}

Classes/Wwwision/Neos/MailChimp/DataSource/InterestDataSource.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Wwwision\Neos\MailChimp\DataSource;
+
+use Neos\ContentRepository\Domain\Model\NodeInterface;
+use Neos\Neos\Service\DataSource\AbstractDataSource;
+use Wwwision\Neos\MailChimp\Domain\Service\MailChimpService;
+use Wwwision\Neos\MailChimp\Exception\MailChimpException;
+
+class InterestDataSource extends AbstractDataSource
+{
+    /**
+     * @var string
+     */
+    static protected $identifier = 'mailchimp-interest';
+
+    /**
+     * @var MailChimpService
+     */
+    protected $mailChimpService;
+
+    public function __construct(MailChimpService $mailChimpService)
+    {
+        $this->mailChimpService = $mailChimpService;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getData(NodeInterface $node = null, array $arguments = [])
+    {
+        $listId = $arguments['listId'];
+        $categoryId = $arguments['categoryId'];
+
+        $response = $this->mailChimpService->getInterestByListAndCategory($listId, $categoryId);
+        $interests = $response['interests'] ?? [];
+
+        $data = [];
+        foreach ($interests as $interest) {
+            $data[] = [
+                'value' => $interest['id'],
+                'label' => $interest['name']
+            ];
+        }
+        return $data;
+    }
+}

Classes/Wwwision/Neos/MailChimp/Domain/Service/MailChimpService.php

@@ -234,4 +234,24 @@ private function makeRequest(string $method, string $resource, array $arguments
         throw new MailChimpException($errorMessage, 1483533997);
     }
 
+    /**
+     * @param string $listId
+     * @return array
+     * @throws HttpException | MailChimpException | ResourceNotFoundException
+     */
+    public function getInterestCategoriesByList(string $listId): array
+    {
+        return $this->get("lists/$listId/interest-categories/");
+    }
+
+    /**
+     * @param string $listId
+     * @param string $categoryId
+     * @return array
+     * @throws HttpException | MailChimpException | ResourceNotFoundException
+     */
+    public function getInterestByListAndCategory(string $listId, string $categoryId): array
+    {
+        return $this->get("lists/$listId/interest-categories/$categoryId/interests");
+    }
 }

README.md

@@ -142,6 +142,69 @@ finishers:
 
 The Form finisher can of course be used without Neos (i.e. for Newsletter-subscriptions within plain Flow applications).
 
+DataSources
+-----------
+
+### Interest Categories
+
+Returns a list of all interest categories with ids and label in the subscription list.
+
+DataSourceIdentifier: `mailchimp-interest-category`
+
+dataSourceAdditionalData: 
+* `listId` - (string) Id of subscription list
+
+### Interests
+
+Returns a list of all interests with ids and label of the given category in the subscription list. 
+
+DataSourceIdentifier: `mailchimp-interest`
+
+dataSourceAdditionalData:
+* `listId` - (string) Id of subscription list
+* `categoryId` - (string) Id of interest category
+
+### Example NodeType configuration
+```yaml
+  ...
+  properties:
+    subscriptionList:
+      type: string
+      defaultValue: ''
+      ui:
+        label: Subscription list id
+    category:
+      type: string
+      defaultValue: ''
+      ui:
+        label: Category
+        inspector:
+          hidden: 'ClientEval:node.properties.subscriptionList != "" ? false : true'
+          editor: Neos.Neos/Inspector/Editors/SelectBoxEditor
+          editorOptions:
+            allowEmpty: true
+            dataSourceIdentifier: mailchimp-interest-category
+            dataSourceAdditionalData:
+              listId: ClientEval:node.properties.subscriptionList
+    interestId:
+      type: string
+      defaultValue: ''
+      ui:
+        label: Interest
+        inspector:
+          group: categories
+          hidden: 'ClientEval:node.properties.category != "" ? false : true'
+          editor: Neos.Neos/Inspector/Editors/SelectBoxEditor
+          editorOptions:
+            allowEmpty: true
+            dataSourceIdentifier: mailchimp-interest
+            dataSourceAdditionalData:
+              listId: ClientEval:node.properties.subscriptionList
+              categoryId: ClientEval:node.properties.category
+```
+
+
+
 Trivia
 ------