feat(Cart): support automatic deletion of old carts

Closes #294

Author: Jens Schulze

src/Model/Cart/Cart.php

@@ -65,6 +65,8 @@
  * @method string getLocale()
  * @method string getTaxRoundingMode()
  * @method Cart setTaxRoundingMode(string $taxRoundingMode = null)
+ * @method int getDeleteDaysAfterLastModification()
+ * @method Cart setDeleteDaysAfterLastModification(int $deleteDaysAfterLastModification = null)
  * @method CartReference getReference()
  */
 class Cart extends Resource
@@ -111,6 +113,7 @@ public function fieldDefinitions()
             'anonymousId' => [static::TYPE => 'string'],
             'locale' => [static::TYPE => 'string'],
             'taxRoundingMode' => [static::TYPE => 'string'],
+            'deleteDaysAfterLastModification' => [static::TYPE => 'int']
         ];
     }
 

src/Model/Cart/CartDraft.php

@@ -44,6 +44,8 @@
  * @method string getLocale()
  * @method string getTaxRoundingMode()
  * @method CartDraft setTaxRoundingMode(string $taxRoundingMode = null)
+ * @method int getDeleteDaysAfterLastModification()
+ * @method CartDraft setDeleteDaysAfterLastModification(int $deleteDaysAfterLastModification = null)
  */
 class CartDraft extends JsonObject
 {
@@ -67,6 +69,7 @@ public function fieldDefinitions()
             'anonymousId' => [static::TYPE => 'string'],
             'locale' => [static::TYPE => 'string'],
             'taxRoundingMode' => [static::TYPE => 'string'],
+            'deleteDaysAfterLastModification' => [static::TYPE => 'int']
         ];
     }
 

src/Model/Cart/MyCartDraft.php

@@ -52,13 +52,14 @@ public function fieldDefinitions()
             'shippingMethod' => [static::TYPE => '\Commercetools\Core\Model\ShippingMethod\ShippingMethodReference'],
             'custom' => [static::TYPE => '\Commercetools\Core\Model\CustomField\CustomFieldObjectDraft'],
             'locale' => [static::TYPE => 'string'],
+            'deleteDaysAfterLastModification' => [static::TYPE => 'int']
         ];
     }
 
     /**
      * @param string $currency
      * @param Context|callable $context
-     * @return CartDraft
+     * @return MyCartDraft
      */
     public static function ofCurrency($currency, $context = null)
     {

src/Request/Carts/Command/CartSetDeleteDaysAfterLastModificationAction.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * @author @jayS-de <jens.schulze@commercetools.de>
+ */
+
+namespace Commercetools\Core\Request\Carts\Command;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\AbstractAction;
+
+/**
+ * @package Commercetools\Core\Request\Carts\Command
+ * @link http://dev.commercetools.com/http-api-projects-carts.html#set-deletedaysafterlastmodification-beta
+ * @method string getAction()
+ * @method CartSetDeleteDaysAfterLastModificationAction setAction(string $action = null)
+ * @method int getDeleteDaysAfterLastModification()
+ * @codingStandardsIgnoreStart
+ * @method CartSetDeleteDaysAfterLastModificationAction setDeleteDaysAfterLastModification(int $deleteDaysAfterLastModification = null)
+ * @codingStandardsIgnoreEnd
+ */
+class CartSetDeleteDaysAfterLastModificationAction extends AbstractAction
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'action' => [static::TYPE => 'string'],
+            'deleteDaysAfterLastModification' => [static::TYPE => 'int'],
+        ];
+    }
+
+    /**
+     * @param array $data
+     * @param Context|callable $context
+     */
+    public function __construct(array $data = [], $context = null)
+    {
+        parent::__construct($data, $context);
+        $this->setAction('setDeleteDaysAfterLastModification');
+    }
+
+    /**
+     * @param int $days
+     * @param Context|callable $context
+     * @return CartSetDeleteDaysAfterLastModificationAction
+     */
+    public static function ofDays($days, $context = null)
+    {
+        return static::of($context)->setDeleteDaysAfterLastModification($days);
+    }
+}

tests/fixtures/models.yaml

@@ -26,6 +26,7 @@ cart:
     - anonymousId
     - locale
     - taxRoundingMode
+    - deleteDaysAfterLastModification
 lineItem:
   domain: cart
   model: LineItem

tests/integration/Cart/CartUpdateRequestTest.php

@@ -53,6 +53,7 @@
 use Commercetools\Core\Request\Carts\Command\CartSetCustomLineItemCustomFieldAction;
 use Commercetools\Core\Request\Carts\Command\CartSetCustomLineItemCustomTypeAction;
 use Commercetools\Core\Request\Carts\Command\CartSetCustomShippingMethodAction;
+use Commercetools\Core\Request\Carts\Command\CartSetDeleteDaysAfterLastModificationAction;
 use Commercetools\Core\Request\Carts\Command\CartSetLineItemCustomFieldAction;
 use Commercetools\Core\Request\Carts\Command\CartSetLineItemCustomTypeAction;
 use Commercetools\Core\Request\Carts\Command\CartSetLineItemTotalPriceAction;
@@ -1141,6 +1142,25 @@ public function testCreateWithTaxRoundingMode()
         $this->assertSame(Cart::TAX_ROUNDING_MODE_HALF_DOWN, $cart->getTaxRoundingMode());
     }
 
+    public function testAutomaticDelete()
+    {
+        $draft = $this->getDraft();
+        $draft->setDeleteDaysAfterLastModification(1);
+        $cart = $this->createCart($draft);
+
+        $this->assertSame(1, $cart->getDeleteDaysAfterLastModification());
+
+        $request = CartUpdateRequest::ofIdAndVersion($cart->getId(), $cart->getVersion())
+            ->addAction(CartSetDeleteDaysAfterLastModificationAction::ofDays(2))
+        ;
+        $response = $request->executeWithClient($this->getClient());
+        $cart = $request->mapResponse($response);
+
+        $this->deleteRequest->setVersion($cart->getVersion());
+
+        $this->assertSame(2, $cart->getDeleteDaysAfterLastModification());
+    }
+
     /**
      * @return CartDraft
      */