feat(Zone): support Key on shipping Zones

nikossvnk · nikossvnk · commit d331cff55337 · 2019-02-21T12:42:31.000+02:00
closes #448
diff --git a/src/Core/Builder/Request/ZoneRequestBuilder.php b/src/Core/Builder/Request/ZoneRequestBuilder.php
@@ -3,11 +3,14 @@
 namespace Commercetools\Core\Builder\Request;
 
 use Commercetools\Core\Request\Zones\ZoneByIdGetRequest;
+use Commercetools\Core\Request\Zones\ZoneByKeyGetRequest;
 use Commercetools\Core\Request\Zones\ZoneCreateRequest;
 use Commercetools\Core\Model\Zone\ZoneDraft;
-use Commercetools\Core\Request\Zones\ZoneDeleteRequest;
+use Commercetools\Core\Request\Zones\ZoneDeleteByKeyRequest;
 use Commercetools\Core\Model\Zone\Zone;
+use Commercetools\Core\Request\Zones\ZoneDeleteRequest;
 use Commercetools\Core\Request\Zones\ZoneQueryRequest;
+use Commercetools\Core\Request\Zones\ZoneUpdateByKeyRequest;
 use Commercetools\Core\Request\Zones\ZoneUpdateRequest;
 
 class ZoneRequestBuilder
@@ -24,6 +27,17 @@ public function getById($id)
         return $request;
     }
 
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-zones.html#get-zone-by-key
+     * @param string $key
+     * @return ZoneByKeyGetRequest
+     */
+    public function getByKey($key)
+    {
+        $request = ZoneByKeyGetRequest::ofKey($key);
+        return $request;
+    }
+
     /**
      * @link https://docs.commercetools.com/http-api-projects-zones.html#create-zone
      * @param ZoneDraft $zone
@@ -35,6 +49,17 @@ public function create(ZoneDraft $zone)
         return $request;
     }
 
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-zones.html#delete-zone-by-key
+     * @param Zone $zone
+     * @return ZoneDeleteByKeyRequest
+     */
+    public function deleteByKey(Zone $zone)
+    {
+        $request = ZoneDeleteByKeyRequest::ofKeyAndVersion($zone->getKey(), $zone->getVersion());
+        return $request;
+    }
+
     /**
      * @link https://docs.commercetools.com/http-api-projects-zones.html#delete-zone
      * @param Zone $zone
@@ -57,6 +82,17 @@ public function query()
         return $request;
     }
 
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-zones.html#update-zone-by-key
+     * @param Zone $zone
+     * @return ZoneUpdateByKeyRequest
+     */
+    public function updateByKey(Zone $zone)
+    {
+        $request = ZoneUpdateByKeyRequest::ofKeyAndVersion($zone->getKey(), $zone->getVersion());
+        return $request;
+    }
+
     /**
      * @link https://docs.commercetools.com/http-api-projects-zones.html#update-zone
      * @param Zone $zone
diff --git a/src/Core/Builder/Update/ZonesActionBuilder.php b/src/Core/Builder/Update/ZonesActionBuilder.php
@@ -8,6 +8,7 @@
 use Commercetools\Core\Request\Zones\Command\ZoneChangeNameAction;
 use Commercetools\Core\Request\Zones\Command\ZoneRemoveLocationAction;
 use Commercetools\Core\Request\Zones\Command\ZoneSetDescriptionAction;
+use Commercetools\Core\Request\Zones\Command\ZoneSetKeyAction;
 
 class ZonesActionBuilder
 {
@@ -57,6 +58,17 @@ public function setDescription($action = null)
         return $this;
     }
 
+    /**
+     * @link https://docs.commercetools.com/http-api-projects-zones.html#set-key
+     * @param ZoneSetKeyAction|callable $action
+     * @return $this
+     */
+    public function setKey($action = null)
+    {
+        $this->addAction($this->resolveAction(ZoneSetKeyAction::class, $action));
+        return $this;
+    }
+
     /**
      * @return ZonesActionBuilder
      */
diff --git a/src/Core/Model/Zone/Zone.php b/src/Core/Model/Zone/Zone.php
@@ -26,6 +26,8 @@
  * @method Zone setDescription(string $description = null)
  * @method LocationCollection getLocations()
  * @method Zone setLocations(LocationCollection $locations = null)
+ * @method string getKey()
+ * @method Zone setKey(string $key = null)
  * @method ZoneReference getReference()
  */
 class Zone extends Resource
@@ -35,6 +37,7 @@ public function fieldDefinitions()
         return [
             'id' => [static::TYPE => 'string'],
             'version' => [static::TYPE => 'int'],
+            'key' => [static::TYPE => 'string'],
             'createdAt' => [
                 static::TYPE => DateTime::class,
                 static::DECORATOR => DateTimeDecorator::class
diff --git a/src/Core/Model/Zone/ZoneDraft.php b/src/Core/Model/Zone/ZoneDraft.php
@@ -17,12 +17,15 @@
  * @method ZoneDraft setDescription(string $description = null)
  * @method LocationCollection getLocations()
  * @method ZoneDraft setLocations(LocationCollection $locations = null)
+ * @method string getKey()
+ * @method ZoneDraft setKey(string $key = null)
  */
 class ZoneDraft extends JsonObject
 {
     public function fieldDefinitions()
     {
         return [
+            'key' => [static::TYPE => 'string'],
             'name' => [static::TYPE => 'string'],
             'description' => [static::TYPE => 'string'],
             'locations' => [static::TYPE => LocationCollection::class],
diff --git a/src/Core/Model/Zone/ZoneReference.php b/src/Core/Model/Zone/ZoneReference.php
@@ -35,4 +35,14 @@ public static function ofId($id, $context = null)
     {
         return static::ofTypeAndId(static::TYPE_ZONE, $id, $context);
     }
+
+    /**
+     * @param $key
+     * @param Context|callable $context
+     * @return ZoneReference
+     */
+    public static function ofKey($key, $context = null)
+    {
+        return static::ofTypeAndKey(static::TYPE_ZONE, $key, $context);
+    }
 }
diff --git a/src/Core/Request/Zones/Command/ZoneSetKeyAction.php b/src/Core/Request/Zones/Command/ZoneSetKeyAction.php
@@ -0,0 +1,48 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Request\Zones\Command;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\AbstractAction;
+
+/**
+ * @package Commercetools\Core\Request\Zones\Command
+ * @link https://docs.commercetools.com/http-api-projects-zones.html#set-key
+ * @method string getAction()
+ * @method ZoneSetKeyAction setAction(string $action = null)
+ * @method string getKey()
+ * @method ZoneSetKeyAction setKey(string $key = null)
+ */
+class ZoneSetKeyAction extends AbstractAction
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'action' => [static::TYPE => 'string'],
+            'key' => [static::TYPE => 'string'],
+        ];
+    }
+
+    /**
+     * @param array $data
+     * @param Context|callable $context
+     */
+    public function __construct(array $data = [], $context = null)
+    {
+        parent::__construct($data, $context);
+        $this->setAction('setKey');
+    }
+
+
+    /**
+     * @param string $key
+     * @param Context|callable $context
+     * @return ZoneSetKeyAction
+     */
+    public static function ofKey($key, $context = null)
+    {
+        return static::of($context)->setKey($key);
+    }
+}
diff --git a/src/Core/Request/Zones/ZoneByKeyGetRequest.php b/src/Core/Request/Zones/ZoneByKeyGetRequest.php
@@ -0,0 +1,41 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Request\Zones;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Model\Zone\Zone;
+use Commercetools\Core\Request\AbstractByKeyGetRequest;
+use Commercetools\Core\Model\MapperInterface;
+use Commercetools\Core\Response\ApiResponseInterface;
+
+/**
+ * @package Commercetools\Core\Request\Zones
+ * @link https://docs.commercetools.com/http-api-projects-zones.html#get-zone-by-key
+ * @method Zone mapResponse(ApiResponseInterface $response)
+ * @method Zone mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
+ */
+class ZoneByKeyGetRequest extends AbstractByKeyGetRequest
+{
+    protected $resultClass = Zone::class;
+
+    /**
+     * @param string $key
+     * @param Context $context
+     */
+    public function __construct($key, Context $context = null)
+    {
+        parent::__construct(ZonesEndpoint::endpoint(), $key, $context);
+    }
+
+    /**
+     * @param string $key
+     * @param Context $context
+     * @return static
+     */
+    public static function ofKey($key, Context $context = null)
+    {
+        return new static($key, $context);
+    }
+}
diff --git a/src/Core/Request/Zones/ZoneDeleteByKeyRequest.php b/src/Core/Request/Zones/ZoneDeleteByKeyRequest.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Request\Zones;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Model\Zone\Zone;
+use Commercetools\Core\Request\AbstractDeleteByKeyRequest;
+use Commercetools\Core\Response\ApiResponseInterface;
+use Commercetools\Core\Model\MapperInterface;
+
+/**
+ * @package Commercetools\Core\Request\Zones
+ * @link https://docs.commercetools.com/http-api-projects-zones.html#delete-zone-by-key
+ * @method Zone mapResponse(ApiResponseInterface $response)
+ * @method Zone mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
+ */
+class ZoneDeleteByKeyRequest extends AbstractDeleteByKeyRequest
+{
+    protected $resultClass = Zone::class;
+
+    /**
+     * @param string $key
+     * @param int $version
+     * @param Context $context
+     */
+    public function __construct($key, $version, Context $context = null)
+    {
+        parent::__construct(ZonesEndpoint::endpoint(), $key, $version, $context);
+    }
+
+    /**
+     * @param string $key
+     * @param int $version
+     * @param Context $context
+     * @return static
+     */
+    public static function ofKeyAndVersion($key, $version, Context $context = null)
+    {
+        return new static($key, $version, $context);
+    }
+}
diff --git a/src/Core/Request/Zones/ZoneUpdateByKeyRequest.php b/src/Core/Request/Zones/ZoneUpdateByKeyRequest.php
@@ -0,0 +1,44 @@
+<?php
+/**
+ */
+
+namespace Commercetools\Core\Request\Zones;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Model\Zone\Zone;
+use Commercetools\Core\Request\AbstractUpdateByKeyRequest;
+use Commercetools\Core\Response\ApiResponseInterface;
+use Commercetools\Core\Model\MapperInterface;
+
+/**
+ * @package Commercetools\Core\Request\Zones
+ * @link https://docs.commercetools.com/http-api-projects-zones.html#update-zone-by-key
+ * @method Zone mapResponse(ApiResponseInterface $response)
+ * @method Zone mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
+ */
+class ZoneUpdateByKeyRequest extends AbstractUpdateByKeyRequest
+{
+    protected $resultClass = Zone::class;
+
+    /**
+     * @param string $key
+     * @param int $version
+     * @param array $actions
+     * @param Context $context
+     */
+    public function __construct($key, $version, array $actions = [], Context $context = null)
+    {
+        parent::__construct(ZonesEndpoint::endpoint(), $key, $version, $actions, $context);
+    }
+
+    /**
+     * @param string $key
+     * @param int $version
+     * @param Context $context
+     * @return static
+     */
+    public static function ofKeyAndVersion($key, $version, Context $context = null)
+    {
+        return new static($key, $version, [], $context);
+    }
+}
diff --git a/tests/integration/Zone/ZoneQueryRequestTest.php b/tests/integration/Zone/ZoneQueryRequestTest.php
@@ -12,7 +12,9 @@
 use Commercetools\Core\Model\Zone\Location;
 use Commercetools\Core\Model\Zone\LocationCollection;
 use Commercetools\Core\Request\Zones\ZoneByIdGetRequest;
+use Commercetools\Core\Request\Zones\ZoneByKeyGetRequest;
 use Commercetools\Core\Request\Zones\ZoneCreateRequest;
+use Commercetools\Core\Request\Zones\ZoneDeleteByKeyRequest;
 use Commercetools\Core\Request\Zones\ZoneDeleteRequest;
 use Commercetools\Core\Request\Zones\ZoneQueryRequest;
 
@@ -72,6 +74,33 @@ public function testGetById()
 
         $this->assertInstanceOf(Zone::class, $zone);
         $this->assertSame($zone->getId(), $result->getId());
+    }
+
+    public function testGetByKey()
+    {
+        $draft = $this->getDraft()->setKey('key-' . $this->getTestRun());
+        $zone = $this->createZone($draft);
+
+        $request = ZoneByKeyGetRequest::ofKey($zone->getKey());
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+
+        $this->assertInstanceOf(Zone::class, $zone);
+        $this->assertSame($zone->getKey(), $result->getKey());
+    }
+
+    public function testDeleteByKey()
+    {
+        $draft = $this->getDraft()->setKey('key-' . $this->getTestRun());
+        $zone = $this->createZone($draft);
+
+        $request = ZoneDeleteByKeyRequest::ofKeyAndVersion(
+            $zone->getKey(),
+            $zone->getVersion()
+        );
+        $result = $this->getClient()->execute($request);
+        $response = $request->mapFromResponse($result);
 
+        $this->assertSame($zone->getId(), $response->getId());
     }
 }
diff --git a/tests/integration/Zone/ZoneUpdateRequestTest.php b/tests/integration/Zone/ZoneUpdateRequestTest.php

Original file line number	Diff line number	Diff line change
`@@ -35,4 +35,14 @@ public static function ofId($id, $context = null)`
`35`	`35`	`{`
`36`	`36`	`return static::ofTypeAndId(static::TYPE_ZONE, $id, $context);`
`37`	`37`	`}`
	`38`	`+`
	`39`	`+ /**`
	`40`	`+ * @param $key`
	`41`	`+ * @param Context\|callable $context`
	`42`	`+ * @return ZoneReference`
	`43`	`+ */`
	`44`	`+ public static function ofKey($key, $context = null)`
	`45`	`+ {`
	`46`	`+ return static::ofTypeAndKey(static::TYPE_ZONE, $key, $context);`
	`47`	`+ }`
`38`	`48`	`}`