feat(DiscountCode): support custom fields for discount codes

Closes #352

Author: Jens Schulze

src/Core/Model/CustomField/CustomFieldObjectDraft.php

@@ -18,16 +18,8 @@
  * @method TypeReference getType()
  * @method CustomFieldObjectDraft setType(TypeReference $type = null)
  */
-class CustomFieldObjectDraft extends JsonObject
+class CustomFieldObjectDraft extends CustomFieldObject
 {
-    public function fieldDefinitions()
-    {
-        return [
-            'type' => [static::TYPE => TypeReference::class],
-            'fields' => [static::TYPE => FieldContainer::class]
-        ];
-    }
-
     /**
      * @param $typeKey
      * @param Context|callable $context

src/Core/Model/DiscountCode/DiscountCode.php

@@ -10,6 +10,7 @@
 use Commercetools\Core\Model\Common\LocalizedString;
 use Commercetools\Core\Model\Common\ReferenceCollection;
 use Commercetools\Core\Model\Common\DateTimeDecorator;
+use Commercetools\Core\Model\CustomField\CustomFieldObject;
 use DateTime;
 
 /**
@@ -41,6 +42,8 @@
  * @method DiscountCode setMaxApplications(int $maxApplications = null)
  * @method int getMaxApplicationsPerCustomer()
  * @method DiscountCode setMaxApplicationsPerCustomer(int $maxApplicationsPerCustomer = null)
+ * @method CustomFieldObject getCustom()
+ * @method DiscountCode setCustom(CustomFieldObject $custom = null)
  * @method DiscountCodeReference getReference()
  */
 class DiscountCode extends Resource
@@ -69,6 +72,7 @@ public function fieldDefinitions()
             'references' => [static::TYPE => ReferenceCollection::class],
             'maxApplications' => [static::TYPE => 'int'],
             'maxApplicationsPerCustomer' => [static::TYPE => 'int'],
+            'custom' => [static::TYPE => CustomFieldObject::class],
         ];
     }
 }

src/Core/Model/DiscountCode/DiscountCodeDraft.php

@@ -9,6 +9,7 @@
 use Commercetools\Core\Model\Common\Context;
 use Commercetools\Core\Model\Common\JsonObject;
 use Commercetools\Core\Model\Common\LocalizedString;
+use Commercetools\Core\Model\CustomField\CustomFieldObjectDraft;
 
 /**
  * @package Commercetools\Core\Model\DiscountCode
@@ -29,6 +30,8 @@
  * @method DiscountCodeDraft setMaxApplications(int $maxApplications = null)
  * @method int getMaxApplicationsPerCustomer()
  * @method DiscountCodeDraft setMaxApplicationsPerCustomer(int $maxApplicationsPerCustomer = null)
+ * @method CustomFieldObjectDraft getCustom()
+ * @method DiscountCodeDraft setCustom(CustomFieldObjectDraft $custom = null)
  */
 class DiscountCodeDraft extends JsonObject
 {
@@ -45,6 +48,7 @@ public function fieldDefinitions()
             'isActive' => [static::TYPE => 'bool'],
             'maxApplications' => [static::TYPE => 'int'],
             'maxApplicationsPerCustomer' => [static::TYPE => 'int'],
+            'custom' => [static::TYPE => CustomFieldObjectDraft::class],
         ];
     }
 

tests/fixtures/models.yaml

@@ -726,7 +726,7 @@ discountCode:
     - references
     - maxApplications
     - maxApplicationsPerCustomer
-
+    - custom
 productDiscount:
   domain: productDiscount
   model: ProductDiscount

tests/integration/DiscountCode/DiscountCodeUpdateRequestTest.php

@@ -13,11 +13,15 @@
 use Commercetools\Core\Model\CartDiscount\CartDiscountValue;
 use Commercetools\Core\Model\Common\Money;
 use Commercetools\Core\Model\Common\MoneyCollection;
+use Commercetools\Core\Model\CustomField\CustomFieldObjectDraft;
 use Commercetools\Core\Model\DiscountCode\DiscountCode;
 use Commercetools\Core\Model\DiscountCode\DiscountCodeDraft;
 use Commercetools\Core\Model\Common\LocalizedString;
+use Commercetools\Core\Model\Type\Type;
 use Commercetools\Core\Request\CartDiscounts\CartDiscountCreateRequest;
 use Commercetools\Core\Request\CartDiscounts\CartDiscountDeleteRequest;
+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\DiscountCodeChangeIsActiveAction;
 use Commercetools\Core\Request\DiscountCodes\Command\DiscountCodeSetCartPredicateAction;
@@ -62,7 +66,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()
         );
@@ -120,6 +124,51 @@ protected function createDiscountCode(DiscountCodeDraft $draft)
         return $discountCode;
     }
 
+    public function testCustomTypeCreate()
+    {
+        $type = $this->getType($this->getTestRun() . '-discount-type', 'discount-code');
+        $draft = $this->getDraft('discount-type');
+        $draft->setCustom(CustomFieldObjectDraft::ofTypeKey($type->getKey()));
+        $discountCode = $this->createDiscountCode($draft);
+
+        $this->assertSame($type->getId(), $discountCode->getCustom()->getType()->getId());
+    }
+
+    public function testCustomTypeUpdate()
+    {
+        $type = $this->getType($this->getTestRun() . '-discount-type', 'discount-code');
+        $draft = $this->getDraft('discount-type');
+        $discountCode = $this->createDiscountCode($draft);
+
+        $request = DiscountCodeUpdateRequest::ofIdAndVersion($discountCode->getId(), $discountCode->getVersion())
+            ->addAction(SetCustomTypeAction::ofTypeKey($type->getKey()))
+        ;
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+        $this->deleteRequest->setVersion($result->getVersion());
+
+        $this->assertSame($type->getId(), $result->getCustom()->getType()->getId());
+    }
+
+    public function testCustomFieldUpdate()
+    {
+        $type = $this->getType($this->getTestRun() . '-discount-type', 'discount-code');
+        $draft = $this->getDraft('discount-type');
+        $draft->setCustom(CustomFieldObjectDraft::ofTypeKey($type->getKey()));
+        $discountCode = $this->createDiscountCode($draft);
+
+        $newValue = $this->getTestRun() . '-value';
+        $request = DiscountCodeUpdateRequest::ofIdAndVersion($discountCode->getId(), $discountCode->getVersion())
+            ->addAction(SetCustomFieldAction::ofName('testField')->setValue($newValue))
+        ;
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+        $this->deleteRequest->setVersion($result->getVersion());
+
+        $this->assertSame($newValue, $result->getCustom()->getFields()->getTestField());
+    }
+
+
     public function testChangeCartDiscountAction()
     {
         $draft = $this->getDraft('change-cart-discount');