Multipage conversion with the 'save in group' parameter

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based now on [Keep a
 Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to
 [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [4.1.2]
+- Possibility to store conversion details in a separate group.
+
 ## [4.1.1]
 - Retrieve the Metadata without additional requests when using `getMetadata`.
 - You can still get the fresh metadata for the file by calling `getMetadata` method from the `MetadataApiInterface`.

README.md

@@ -435,6 +435,14 @@ Result will contain one of two objects:
 
 The `ConvertedItemInterface` will contain a UUID of converted document and token with conversion job ID. You can request the conversion job status with this ID (or the `ConvertedItemInterface` object itself):
 
+You can also pass the `true` to the `setSaveInGroup` method to the Request object.
+
+```php
+$request = (new \Uploadcare\Conversion\DocumentConversionRequest('pdf'))->setSaveInGroup(true);
+```
+
+In this case, the result of the document conversion will be stored in a group. See further details [here](https://uploadcare.com/docs/transformations/document-conversion/#multipage-conversion).
+
 ```php
 $status = $convertor->documentJobStatus($result); // or $result->getToken()
 ```

src/Apis/ConversionApi.php

@@ -254,7 +254,7 @@ private function requestDocumentConversion(array $conversionParams): BatchRespon
     }
 
     /**
-     * @param array $ids File ID's
+     * @param string[] $ids File ID's
      */
     private function makeDocumentConversionUrl(array $ids, DocumentConversionRequestInterface $request): array
     {
@@ -268,9 +268,14 @@ private function makeDocumentConversionUrl(array $ids, DocumentConversionRequest
             }
         }
 
-        return [
+        $requestParameters = [
             'paths' => $patch,
             'store' => $request->store(),
         ];
+        if ($request->isSaveInGroup() === true) {
+            $requestParameters['save_in_group'] = true;
+        }
+
+        return $requestParameters;
     }
 }

src/Conversion/DocumentConversionRequest.php

@@ -16,6 +16,7 @@ class DocumentConversionRequest implements DocumentConversionRequestInterface
     private bool $throwError = false;
     private bool $store = true;
     private ?int $pageNumber = null;
+    private bool $saveToGroup = false;
 
     public function __construct(string $targetFormat = 'pdf', bool $throwError = false, bool $store = true, ?int $pageNumber = null)
     {
@@ -76,4 +77,16 @@ public function setPageNumber(?int $pageNumber): self
 
         return $this;
     }
+
+    public function setSaveInGroup(bool $saveInGroup): self
+    {
+        $this->saveToGroup = $saveInGroup;
+
+        return $this;
+    }
+
+    public function isSaveInGroup(): bool
+    {
+        return $this->pageNumber !== null ? false : $this->saveToGroup;
+    }
 }

src/Conversion/VideoEncodingRequest.php

@@ -208,4 +208,9 @@ private function checkTime(string $time): void
             throw new InvalidArgumentException(\sprintf('Time string \'%s\' not valid', $time));
         }
     }
+
+    public function isSaveInGroup(): bool
+    {
+        return false;
+    }
 }

src/Interfaces/Conversion/ConversionRequestInterface.php

@@ -12,4 +12,6 @@ public function getTargetFormat(): string;
     public function throwError(): bool;
 
     public function store(): bool;
+
+    public function isSaveInGroup(): bool;
 }

tests/Metadata/MetadataRealApiTest.php

@@ -33,7 +33,9 @@ public function testFileMetadataLoad(): void
         $value = \date_create()->format(\DateTimeInterface::ATOM);
 
         $api->metadata()->setKey($file, $key, $value);
+        $dateOne = \date_create($value)->format('Y-m-d');
+        $dateTwo = \date_create($file->getMetadata()->offsetGet($key))->format('Y-m-d');
 
-        self::assertSame($value, $file->getMetadata()->offsetGet($key));
+        self::assertSame($dateOne, $dateTwo);
     }
 }

tests/Metadata/MetadataTest.php

@@ -2,12 +2,18 @@
 
 namespace Tests\Metadata;
 
+use GuzzleHttp\ClientInterface;
+use GuzzleHttp\Exception\ConnectException;
+use GuzzleHttp\Psr7\Request;
 use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\ResponseInterface;
 use Symfony\Component\String\ByteString;
 use Uploadcare\Apis\MetadataApi;
 use Uploadcare\Configuration;
-use Uploadcare\Exception\MetadataException;
+use Uploadcare\Exception\{HttpException, MetadataException};
 use Uploadcare\File\Metadata;
+use Uploadcare\Security\Signature;
+use Uploadcare\Serializer\SerializerFactory;
 
 class MetadataTest extends TestCase
 {
@@ -55,4 +61,44 @@ public function testSetKeyMethodWithWrongValue(): void
 
         $api->setKey(\uuid_create(), $key, $value);
     }
+
+    public function testRemoveReyWithTheWrongKey(): void
+    {
+        $key = ByteString::fromRandom(128)->toString();
+
+        $api = new MetadataApi(Configuration::create('demo', 'demo'));
+        $this->expectException(MetadataException::class);
+        $this->expectExceptionMessageMatches('/Key should be string up to 64 characters length/');
+
+        $api->removeKey(\uuid_create(), $key);
+    }
+
+    public function testRemoveKeyWithAnErrorInTheResponse(): void
+    {
+        $client = $this->createMock(ClientInterface::class);
+        $client->expects(self::atLeastOnce())->method('request')->willThrowException(new ConnectException('Error string', new Request('DELETE', 'https://example.com')));
+        $configuration = new Configuration('demo', new Signature('demo'), $client, SerializerFactory::create());
+
+        $key = 'validString';
+        $api = new MetadataApi($configuration);
+        $this->expectException(HttpException::class);
+
+        $api->removeKey(\uuid_create(), $key);
+    }
+
+    public function testRemoveKeyWithTheWrongResponseStatus(): void
+    {
+        $response = $this->createMock(ResponseInterface::class);
+        $response->expects(self::atLeastOnce())->method('getStatusCode')->willReturn(401);
+        $client = $this->createMock(ClientInterface::class);
+        $client->expects(self::atLeastOnce())->method('request')->willReturn($response);
+        $configuration = new Configuration('demo', new Signature('demo'), $client, SerializerFactory::create());
+
+        $key = 'validString';
+        $api = new MetadataApi($configuration);
+        $this->expectException(HttpException::class);
+        $this->expectExceptionMessageMatches('/Wrong response. Call to support/');
+
+        $api->removeKey(\uuid_create(), $key);
+    }
 }