feat: support groups for discount codes

Closes #362

Author: Jens Schulze

src/Core/Model/DiscountCode/DiscountCode.php

@@ -44,6 +44,8 @@
  * @method DiscountCode setMaxApplicationsPerCustomer(int $maxApplicationsPerCustomer = null)
  * @method CustomFieldObject getCustom()
  * @method DiscountCode setCustom(CustomFieldObject $custom = null)
+ * @method array getGroups()
+ * @method DiscountCode setGroups(array $groups = null)
  * @method DiscountCodeReference getReference()
  */
 class DiscountCode extends Resource
@@ -73,6 +75,7 @@ public function fieldDefinitions()
             'maxApplications' => [static::TYPE => 'int'],
             'maxApplicationsPerCustomer' => [static::TYPE => 'int'],
             'custom' => [static::TYPE => CustomFieldObject::class],
+            'groups' => [static::TYPE => 'array'],
         ];
     }
 }

src/Core/Model/DiscountCode/DiscountCodeDraft.php

@@ -32,6 +32,8 @@
  * @method DiscountCodeDraft setMaxApplicationsPerCustomer(int $maxApplicationsPerCustomer = null)
  * @method CustomFieldObjectDraft getCustom()
  * @method DiscountCodeDraft setCustom(CustomFieldObjectDraft $custom = null)
+ * @method array getGroups()
+ * @method DiscountCodeDraft setGroups(array $groups = null)
  */
 class DiscountCodeDraft extends JsonObject
 {
@@ -49,6 +51,7 @@ public function fieldDefinitions()
             'maxApplications' => [static::TYPE => 'int'],
             'maxApplicationsPerCustomer' => [static::TYPE => 'int'],
             'custom' => [static::TYPE => CustomFieldObjectDraft::class],
+            'groups' => [static::TYPE => 'array'],
         ];
     }
 

src/Core/Request/DiscountCodes/Command/DiscountCodeChangeGroupsAction.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * @author @jayS-de <jens.schulze@commercetools.de>
+ */
+
+namespace Commercetools\Core\Request\DiscountCodes\Command;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\AbstractAction;
+
+/**
+ * @package Commercetools\Core\Request\DiscountCodes\Command
+ * @link https://dev.commercetools.com/http-api-projects-discountCodes.html#change-groups
+ * @method string getAction()
+ * @method DiscountCodeChangeGroupsAction setAction(string $action = null)
+ * @method array getGroups()
+ * @method DiscountCodeChangeGroupsAction setGroups(array $groups = null)
+ */
+class DiscountCodeChangeGroupsAction extends AbstractAction
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'action' => [static::TYPE => 'string'],
+            'groups' => [static::TYPE => 'array'],
+        ];
+    }
+
+    /**
+     * @param array $data
+     * @param Context|callable $context
+     */
+    public function __construct(array $data = [], $context = null)
+    {
+        parent::__construct($data, $context);
+        $this->setAction('changeGroups');
+    }
+
+    /**
+     * @param bool $groups
+     * @param Context|callable $context
+     * @return DiscountCodeChangeGroupsAction
+     */
+    public static function ofGroups($groups, $context = null)
+    {
+        return static::of($context)->setGroups($groups);
+    }
+}

tests/fixtures/models.yaml

@@ -733,6 +733,7 @@ discountCode:
     - maxApplications
     - maxApplicationsPerCustomer
     - custom
+    - groups
 productDiscount:
   domain: productDiscount
   model: ProductDiscount

tests/integration/DiscountCode/DiscountCodeUpdateRequestTest.php

@@ -24,6 +24,7 @@
 use Commercetools\Core\Request\CustomField\Command\SetCustomFieldAction;
 use Commercetools\Core\Request\CustomField\Command\SetCustomTypeAction;
 use Commercetools\Core\Request\DiscountCodes\Command\DiscountCodeChangeCartDiscountsAction;
+use Commercetools\Core\Request\DiscountCodes\Command\DiscountCodeChangeGroupsAction;
 use Commercetools\Core\Request\DiscountCodes\Command\DiscountCodeChangeIsActiveAction;
 use Commercetools\Core\Request\DiscountCodes\Command\DiscountCodeSetCartPredicateAction;
 use Commercetools\Core\Request\DiscountCodes\Command\DiscountCodeSetDescriptionAction;
@@ -50,7 +51,7 @@ protected function createCartDiscount($draft)
         $response = $request->executeWithClient($this->getClient());
         $cartDiscount = $request->mapResponse($response);
 
-        $this->discountDeleteRequests[] = CartDiscountDeleteRequest::ofIdAndVersion(
+        $this->discountDeleteRequests[] = $this->deleteRequest = CartDiscountDeleteRequest::ofIdAndVersion(
             $cartDiscount->getId(),
             $cartDiscount->getVersion()
         );
@@ -155,11 +156,7 @@ public function testChangeCartDiscountAction()
         $this->assertSame($cartDiscount->getId(), $result->getCartDiscounts()->current()->getId());
         $this->assertNotSame($discountCode->getVersion(), $result->getVersion());
 
-        $deleteRequest = array_pop($this->cleanupRequests);
-        $deleteRequest->setVersion($result->getVersion());
-        $result = $this->getClient()->execute($deleteRequest)->toObject();
-
-        $this->assertInstanceOf(DiscountCode::class, $result);
+        $this->deleteRequest->setVersion($result->getVersion());
     }
 
     public function testChangeCartDiscountsAction()
@@ -190,11 +187,7 @@ public function testChangeCartDiscountsAction()
         $this->assertSame($expectedIds, $ids);
         $this->assertNotSame($discountCode->getVersion(), $result->getVersion());
 
-        $deleteRequest = array_pop($this->cleanupRequests);
-        $deleteRequest->setVersion($result->getVersion());
-        $result = $this->getClient()->execute($deleteRequest)->toObject();
-
-        $this->assertInstanceOf(DiscountCode::class, $result);
+        $this->deleteRequest->setVersion($result->getVersion());
     }
 
     public function testSetDescription()
@@ -218,11 +211,7 @@ public function testSetDescription()
         $this->assertSame($description, $result->getDescription()->en);
         $this->assertNotSame($discountCode->getVersion(), $result->getVersion());
 
-        $deleteRequest = array_pop($this->cleanupRequests);
-        $deleteRequest->setVersion($result->getVersion());
-        $result = $this->getClient()->execute($deleteRequest)->toObject();
-
-        $this->assertInstanceOf(DiscountCode::class, $result);
+        $this->deleteRequest->setVersion($result->getVersion());
     }
 
     public function testChangeIsActive()
@@ -244,11 +233,29 @@ public function testChangeIsActive()
         $this->assertSame($isActive, $result->getIsActive());
         $this->assertNotSame($discountCode->getVersion(), $result->getVersion());
 
-        $deleteRequest = array_pop($this->cleanupRequests);
-        $deleteRequest->setVersion($result->getVersion());
-        $result = $this->getClient()->execute($deleteRequest)->toObject();
+        $this->deleteRequest->setVersion($result->getVersion());
+    }
+
+    public function testChangeGroups()
+    {
+        $draft = $this->getDraft('change-groups');
+        $draft->setGroups(['test']);
+        $discountCode = $this->createDiscountCode($draft);
+        $this->assertSame('test', current($discountCode->getGroups()));
+
+
+        $request = DiscountCodeUpdateRequest::ofIdAndVersion($discountCode->getId(), $discountCode->getVersion())
+            ->addAction(
+                DiscountCodeChangeGroupsAction::of()->setGroups(['test2'])
+            )
+        ;
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+        $this->deleteRequest->setVersion($result->getVersion());
 
         $this->assertInstanceOf(DiscountCode::class, $result);
+        $this->assertSame('test2', current($result->getGroups()));
+        $this->assertNotSame($discountCode->getVersion(), $result->getVersion());
     }
 
     public function testSetCartPredicate()
@@ -270,11 +277,7 @@ public function testSetCartPredicate()
         $this->assertSame($cartPredicate, $result->getCartPredicate());
         $this->assertNotSame($discountCode->getVersion(), $result->getVersion());
 
-        $deleteRequest = array_pop($this->cleanupRequests);
-        $deleteRequest->setVersion($result->getVersion());
-        $result = $this->getClient()->execute($deleteRequest)->toObject();
-
-        $this->assertInstanceOf(DiscountCode::class, $result);
+        $this->deleteRequest->setVersion($result->getVersion());
     }
 
     public function testSetMaxApplications()
@@ -296,11 +299,7 @@ public function testSetMaxApplications()
         $this->assertSame($maxApplications, $result->getMaxApplications());
         $this->assertNotSame($discountCode->getVersion(), $result->getVersion());
 
-        $deleteRequest = array_pop($this->cleanupRequests);
-        $deleteRequest->setVersion($result->getVersion());
-        $result = $this->getClient()->execute($deleteRequest)->toObject();
-
-        $this->assertInstanceOf(DiscountCode::class, $result);
+        $this->deleteRequest->setVersion($result->getVersion());
     }
 
     public function testSetMaxApplicationsPerCustomer()
@@ -323,11 +322,7 @@ public function testSetMaxApplicationsPerCustomer()
         $this->assertSame($maxApplicationsPerCustomer, $result->getMaxApplicationsPerCustomer());
         $this->assertNotSame($discountCode->getVersion(), $result->getVersion());
 
-        $deleteRequest = array_pop($this->cleanupRequests);
-        $deleteRequest->setVersion($result->getVersion());
-        $result = $this->getClient()->execute($deleteRequest)->toObject();
-
-        $this->assertInstanceOf(DiscountCode::class, $result);
+        $this->deleteRequest->setVersion($result->getVersion());
     }
 
     public function testSetName()
@@ -350,10 +345,6 @@ public function testSetName()
         $this->assertSame($name->en, $result->getName()->en);
         $this->assertNotSame($discountCode->getVersion(), $result->getVersion());
 
-        $deleteRequest = array_pop($this->cleanupRequests);
-        $deleteRequest->setVersion($result->getVersion());
-        $result = $this->getClient()->execute($deleteRequest)->toObject();
-
-        $this->assertInstanceOf(DiscountCode::class, $result);
+        $this->deleteRequest->setVersion($result->getVersion());
     }
 }