Merge pull request #29 from signnow/move-document

Fix issue #18 implemented move document

Author: JiSoft

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [v2.2.5] - 2022-11-22
+### Added
+- Support move document  
+
 ## [v2.2.4] - 2022-10-19
 ### Added
 - Support filling smart fields of document  

README.md

@@ -383,6 +383,26 @@ $smartFields->addField('key', 'value');
 
 $prefill->fill($documentUniqueId, $smartFields);
 ```
+#### <a name="move-document"></a>Move document
+```php
+use SignNow\Api\Action\OAuth as SignNowOAuth;
+use SignNow\Api\Action\MoveDocumentAction;
+use SignNow\Api\Entity\Document\MoveDocument\MoveDocument;
+
+$auth = new SignNowOAuth(HOST);
+$entityManager = $auth->bearerByPassword(
+    BASIC_TOKEN,
+    USER,
+    PASSWORD
+);
+
+$moveDocumentEntity = new MoveDocument();
+$moveDocumentEntity->setFolderId($folderId);
+
+$moveDocumentAction = new MoveDocumentAction($entityManager);
+$moveDocumentAction->move($documentUniqueId, $moveDocumentEntity);
+```
+
 ### <a name="template"></a>Template
 #### <a name="create-template"></a>Create a template
 ```php

src/Action/MoveDocumentAction.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SignNow\Api\Action;
+
+use ReflectionException;
+use SignNow\Api\Entity\Document\MoveDocument\MoveDocument;
+use SignNow\Api\Entity\Document\MoveDocument\MoveDocumentResponse;
+use SignNow\Rest\EntityManager;
+use SignNow\Rest\EntityManager\Exception\EntityManagerException;
+use SignNow\Rest\Http\Request;
+
+/**
+ * Class MoveDocumentAction
+ *
+ * @package SignNow\Api\Action
+ */
+class MoveDocumentAction
+{
+    /**
+     * @var EntityManager
+     */
+    private $entityManager;
+
+    /**
+     * MoveDocument constructor.
+     *
+     * @param EntityManager $entityManager
+     */
+    public function __construct(EntityManager $entityManager)
+    {
+        $this->entityManager = $entityManager;
+    }
+
+    /**
+     * @param string       $documentUid
+     * @param MoveDocument $moveDocument
+     *
+     * @return MoveDocumentResponse|object
+     *
+     * @throws EntityManagerException
+     * @throws ReflectionException
+     */
+    public function move(string $documentUid, MoveDocument $moveDocument): MoveDocumentResponse
+    {
+        $this->entityManager->setUpdateHttpMethod(Request::METHOD_POST);
+
+        return $this->entityManager->create(
+            $moveDocument,
+            [
+                'documentUniqueId' => $documentUid,
+            ]
+        );
+    }
+}

src/Entity/Document/MoveDocument/MoveDocument.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SignNow\Api\Entity\Document\MoveDocument;
+
+use JMS\Serializer\Annotation as Serializer;
+use SignNow\Rest\Entity\Entity;
+use SignNow\Rest\EntityManager\Annotation\HttpEntity;
+use SignNow\Rest\EntityManager\Annotation\ResponseType;
+
+/**
+ * Class MoveDocument
+ *
+ * @HttpEntity("/document/{documentUniqueId}/move", idProperty="")
+ * @ResponseType("SignNow\Api\Entity\Document\MoveDocument\MoveDocumentResponse")
+ *
+ * @package SignNow\Api\Entity\Document
+ */
+class MoveDocument extends Entity
+{
+    /**
+     * @var string|null
+     * @Serializer\Type("string")
+     */
+    protected $folderId;
+
+    /**
+     * @return string|null
+     */
+    public function getFolderId(): ?string
+    {
+        return $this->folderId;
+    }
+
+    /**
+     * @param string $folderId
+     *
+     * @return $this
+     */
+    public function setFolderId(string $folderId): self
+    {
+        $this->folderId = $folderId;
+
+        return $this;
+    }
+}

src/Entity/Document/MoveDocument/MoveDocumentResponse.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SignNow\Api\Entity\Document\MoveDocument;
+
+use JMS\Serializer\Annotation as Serializer;
+
+/**
+ * Class MoveDocumentResponse
+ *
+ * @package SignNow\Api\Entity\Document\Move
+ */
+class MoveDocumentResponse
+{
+    /**
+     * @var string|null
+     * @Serializer\Type("string")
+     */
+    protected $result;
+
+    /**
+     * @return string|null
+     */
+    public function getResult(): ?string
+    {
+        return $this->result;
+    }
+
+    /**
+     * @param string $result
+     *
+     * @return MoveDocumentResponse
+     */
+    public function setResult(string $result): self
+    {
+        $this->result = $result;
+
+        return $this;
+    }
+}

tests/_support/Module/Mock/ApiDocumentMock.php

@@ -29,6 +29,7 @@ class ApiDocumentMock extends Module implements DependsOnModule
     private const DOWNLOAD_DOCUMENT_LINK_URL_PATTERN = '/document/{documentUniqueId}/download/link';
     private const PREFILL_TEXT_FIELDS_URL_PATTERN = '/v2/documents/{documentUniqueId}/prefill-texts';
     private const FILL_SMART_FIELDS_URL_PATTERN = '/document/{documentUniqueId}/integration/object/smartfields';
+    private const MOVE_DOCUMENT_URL_PATTERN = '/document/{documentUniqueId}/move';
 
     /**
      * @var PhiremockModule
@@ -366,6 +367,33 @@ public function mockFillDocumentSmartFieldsRequest(string $documentUniqueId): vo
             )
         );
     }
+
+    /**
+     * @param string $documentUniqueId
+     *
+     * @throws ClientExceptionInterface
+     * @throws Exception
+     */
+    public function mockMoveDocumentRequest(string $documentUniqueId): void
+    {
+        $this->phiremock->expectARequestToRemoteServiceWithAResponse(
+            Phiremock::on(
+                A::postRequest()
+                 ->andHeader('Content-Type', Is::equalTo('application/json'))
+                 ->andUrl(Is::equalTo($this->moveDocumentUrl($documentUniqueId)))
+            )->then(
+                Respond::withStatusCode(200)
+                    ->andHeader('Content-Type', 'application/json')
+                    ->andBody(
+                        json_encode(
+                            [
+                                'result' => 'success',
+                            ]
+                        )
+                    )
+            )
+        );
+    }
 
     /**
      * @return string
@@ -432,4 +460,14 @@ private function fillDocumentSmartFieldsUrl(string $documentUniqueId): string
     {
         return strtr(self::FILL_SMART_FIELDS_URL_PATTERN, ['{documentUniqueId}' => $documentUniqueId]);
     }
+
+    /**
+     * @param string $documentUniqueId
+     *
+     * @return string
+     */
+    private function moveDocumentUrl(string $documentUniqueId): string
+    {
+        return strtr(self::MOVE_DOCUMENT_URL_PATTERN, ['{documentUniqueId}' => $documentUniqueId]);
+    }
 }

tests/functional/Document/MoveDocumentCest.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SignNow\Tests\Functional\Document;
+
+use FunctionalTester;
+use ReflectionException;
+use SignNow\Api\Entity\Document\MoveDocument\MoveDocument;
+use SignNow\Api\Action\MoveDocumentAction as MoveDocumentAction;
+use SignNow\Rest\EntityManager;
+use SignNow\Rest\EntityManager\Exception\EntityManagerException;
+use SignNow\Tests\Functional\BaseCest;
+
+/**
+ * Class MoveDocumentCest
+ *
+ * @package SignNow\Tests\Functional\Document
+ */
+class MoveDocumentCest extends BaseCest
+{
+    /**
+     * @var EntityManager
+     */
+    private $auth;
+
+    /**
+     * @param FunctionalTester $I
+     */
+    public function _before(FunctionalTester $I): void
+    {
+        $this->auth = $this->createSignNowBearerTokenAuth($I);
+    }
+
+    /**
+     * @param FunctionalTester $I
+     *
+     * @throws EntityManagerException
+     * @throws ReflectionException
+     */
+    public function testMoveDocument(FunctionalTester $I): void
+    {
+        $documentUniqueId = $I->createUniqueId();
+
+        $moveDocumentEntity = new MoveDocument();
+        $moveDocumentEntity->setFolderId($I->createUniqueId());
+
+        $moveDocumentAction = new MoveDocumentAction($this->auth);
+
+        $I->mockMoveDocumentRequest($documentUniqueId);
+
+        $response = $moveDocumentAction->move($documentUniqueId, $moveDocumentEntity);
+
+        $I->assertSame('success', $response->getResult());
+    }
+}