fix(CustomObject): add version to custom object draft

Closes #249

Author: Jens Schulze

src/Model/CustomObject/CustomObjectDraft.php

@@ -7,8 +7,6 @@
 
 use Commercetools\Core\Model\Common\Context;
 use Commercetools\Core\Model\Common\JsonObject;
-use Commercetools\Core\Model\Common\Resource;
-use Commercetools\Core\Model\Common\DateTimeDecorator;
 
 /**
  * @package Commercetools\Core\Model\CustomObject
@@ -19,12 +17,15 @@
  * @method CustomObjectDraft setKey(string $key = null)
  * @method mixed getValue()
  * @method CustomObjectDraft setValue($value = null)
+ * @method int getVersion()
+ * @method CustomObjectDraft setVersion(int $version = null)
  */
 class CustomObjectDraft extends JsonObject
 {
     public function fieldDefinitions()
     {
         return [
+            'version' => [static::TYPE => 'int'],
             'container' => [static::TYPE => 'string'],
             'key' => [static::TYPE => 'string'],
             'value' => [],

src/Request/CustomObjects/CustomObjectCreateRequest.php

@@ -5,6 +5,7 @@
 
 namespace Commercetools\Core\Request\CustomObjects;
 
+use Commercetools\Core\Error\InvalidArgumentException;
 use Commercetools\Core\Model\Common\Context;
 use Commercetools\Core\Model\CustomObject\CustomObject;
 use Commercetools\Core\Model\CustomObject\CustomObjectDraft;
@@ -21,20 +22,23 @@ class CustomObjectCreateRequest extends AbstractCreateRequest
     protected $resultClass = '\Commercetools\Core\Model\CustomObject\CustomObject';
 
     /**
-     * @param CustomObjectDraft $customObject
+     * @param CustomObjectDraft|CustomObject $customObject
      * @param Context $context
      */
-    public function __construct(CustomObjectDraft $customObject, Context $context = null)
+    public function __construct($customObject, Context $context = null)
     {
+        if (!($customObject instanceof CustomObject || $customObject instanceof CustomObjectDraft)) {
+            throw new InvalidArgumentException();
+        }
         parent::__construct(CustomObjectsEndpoint::endpoint(), $customObject, $context);
     }
 
     /**
-     * @param CustomObjectDraft $customObject
+     * @param CustomObjectDraft|CustomObject $customObject
      * @param Context $context
      * @return static
      */
-    public static function ofObject(CustomObjectDraft $customObject, Context $context = null)
+    public static function ofObject($customObject, Context $context = null)
     {
         return new static($customObject, $context);
     }

tests/integration/CustomObject/CustomObjectQueryRequestTest.php

@@ -7,6 +7,8 @@
 namespace Commercetools\Core\CustomObject;
 
 use Commercetools\Core\ApiTestCase;
+use Commercetools\Core\Error\ConcurrentModificationError;
+use Commercetools\Core\Model\CustomObject\CustomObject;
 use Commercetools\Core\Model\CustomObject\CustomObjectDraft;
 use Commercetools\Core\Request\CustomObjects\CustomObjectByKeyGetRequest;
 use Commercetools\Core\Request\CustomObjects\CustomObjectCreateRequest;
@@ -36,14 +38,92 @@ protected function createCustomObject(CustomObjectDraft $draft)
         $response = $request->executeWithClient($this->getClient());
         $customObject = $request->mapResponse($response);
 
-        $this->cleanupRequests[] = CustomObjectDeleteRequest::ofIdAndVersion(
+        $this->cleanupRequests[] = $this->deleteRequest = CustomObjectDeleteRequest::ofIdAndVersion(
             $customObject->getId(),
             $customObject->getVersion()
         );
 
         return $customObject;
     }
 
+    public function testCustomObjectWithVersion()
+    {
+        $draft = $this->getDraft();
+        $customObject = $this->createCustomObject($draft);
+
+        $request = CustomObjectCreateRequest::ofObject($customObject);
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+        $this->deleteRequest->setVersion($result->getVersion());
+
+        $this->assertNotSame($customObject->getVersion(), $result->getVersion());
+    }
+
+    public function testCustomObjectWithVersionConflict()
+    {
+        $draft = $this->getDraft();
+        $customObject = $this->createCustomObject($draft);
+
+        $request = CustomObjectCreateRequest::ofObject($customObject);
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+        $this->deleteRequest->setVersion($result->getVersion());
+
+        $this->assertNotSame($customObject->getVersion(), $result->getVersion());
+
+        $request = CustomObjectCreateRequest::ofObject($customObject);
+        $response = $request->executeWithClient($this->getClient());
+
+        $this->assertTrue($response->isError());
+        $this->assertInstanceOf(
+            '\Commercetools\Core\Error\ConcurrentModificationError',
+            $response->getErrors()->getByCode(ConcurrentModificationError::CODE)
+        );
+    }
+
+    public function testCustomObjectDraftWithVersionConflict()
+    {
+        $draft = $this->getDraft();
+        $customObject = $this->createCustomObject($draft);
+
+        $request = CustomObjectCreateRequest::ofObject($draft);
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+        $this->deleteRequest->setVersion($result->getVersion());
+
+        $this->assertNotSame($customObject->getVersion(), $result->getVersion());
+
+        $draft->setVersion($customObject->getVersion());
+        $request = CustomObjectCreateRequest::ofObject($draft);
+        $response = $request->executeWithClient($this->getClient());
+
+        $this->assertTrue($response->isError());
+        $this->assertInstanceOf(
+            '\Commercetools\Core\Error\ConcurrentModificationError',
+            $response->getErrors()->getByCode(ConcurrentModificationError::CODE)
+        );
+    }
+
+    public function testValidTypes()
+    {
+        $this->assertInstanceOf(
+            '\Commercetools\Core\Request\CustomObjects\CustomObjectCreateRequest',
+            CustomObjectCreateRequest::ofObject(CustomObject::of())
+        );
+        $this->assertInstanceOf(
+            '\Commercetools\Core\Request\CustomObjects\CustomObjectCreateRequest',
+            CustomObjectCreateRequest::ofObject(CustomObjectDraft::of())
+        );
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     */
+    public function testInvalidType()
+    {
+        CustomObjectCreateRequest::ofObject(new \stdClass());
+    }
+
     public function testQuery()
     {
         $draft = $this->getDraft();