Skip to content

Commit

Permalink
Add support for context and metadata in rename Upload API
Browse files Browse the repository at this point in the history
  • Loading branch information
@cloudinaraz
cloudinaraz authored May 12, 2021
1 parent b2e5076 commit 5964d54
Show file tree
Hide file tree
Showing 2 changed files with 103 additions and 20 deletions.
9 changes: 8 additions & 1 deletion src/Api/Upload/EditTrait.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,14 @@ public function destroy($publicId, $options = [])
*/
public function renameAsync($fromPublicId, $toPublicId, $options = [])
{
$params = ArrayUtils::whitelist($options, ['type', 'to_type', 'invalidate', 'overwrite']);
$params = ArrayUtils::whitelist($options, [
'type',
'to_type',
'invalidate',
'overwrite',
'context',
'metadata'
]);
$params['from_public_id'] = $fromPublicId;
$params['to_public_id'] = $toPublicId;

Expand Down
114 changes: 95 additions & 19 deletions tests/Integration/Upload/EditTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use Cloudinary\Api\Exception\ApiError;
use Cloudinary\Api\Exception\BadRequest;
use Cloudinary\Api\Exception\NotFound;
use Cloudinary\Api\Metadata\StringMetadataField;
use Cloudinary\Asset\AssetTransformation;
use Cloudinary\Asset\AssetType;
use Cloudinary\Test\Helpers\MockUploadApi;
Expand All @@ -37,13 +38,22 @@ final class EditTest extends IntegrationTestCase
const RENAME_TO_EXISTING_TARGET = 'rename_to_existing_target';
const RENAME_TO_EXISTING_SOURCE_OVERWRITE = 'rename_to_existing_overwrite_source';
const RENAME_TO_EXISTING_TARGET_OVERWRITE = 'rename_to_existing_overwrite_target';
const RENAME_TARGET_FOR_CONTEXT_TEST = 'rename_target_for_context_test';
const RENAME_SOURCE_FOR_CONTEXT_TEST = 'rename_source_for_context_test';
const RENAME_TARGET_FOR_METADATA_TEST = 'rename_target_for_metadata_test';
const RENAME_SOURCE_FOR_METADATA_TEST = 'rename_source_for_metadata_test';
const CHANGE_TYPE = 'change_type';
const DESTROY = 'destroy';
const EXPLICIT = 'explicit';
const EXCEPTION_IMAGE = 'exception_image';
const EXCEPTION_RAW = 'exception_raw';

private static $TRANSFORMATION_OBJECT;
private static $RENAME_RETURN_CONTEXT_KEY;
private static $RENAME_RETURN_CONTEXT_VALUE;
private static $RENAME_RETURN_METADATA;
private static $RENAME_RETURN_METADATA_EXTERNAL_ID;
private static $RENAME_RETURN_METADATA_DEFAULT_VALUE;

/**
* @throws ApiError
Expand All @@ -52,33 +62,57 @@ public static function setUpBeforeClass()
{
parent::setUpBeforeClass();

self::$TRANSFORMATION_OBJECT = (new AssetTransformation())->resize(
self::$TRANSFORMATION_OBJECT = (new AssetTransformation())->resize(
Resize::crop(400, 400, Gravity::face())
);
self::$RENAME_RETURN_CONTEXT_KEY = 'rename_return_context_key_' . self::$UNIQUE_TEST_ID;
self::$RENAME_RETURN_CONTEXT_VALUE = 'rename_return_context_value_' . self::$UNIQUE_TEST_ID;
self::$RENAME_RETURN_METADATA_EXTERNAL_ID = 'rename_metadata_external_id_' . self::$UNIQUE_TEST_ID;
self::$RENAME_RETURN_METADATA_DEFAULT_VALUE = 'rename_metadata_default_value_' . self::$UNIQUE_TEST_ID;

self::$RENAME_RETURN_METADATA = new StringMetadataField(self::$RENAME_RETURN_METADATA_EXTERNAL_ID);
self::$RENAME_RETURN_METADATA->setExternalId(self::$RENAME_RETURN_METADATA_EXTERNAL_ID);
self::$RENAME_RETURN_METADATA->setDefaultValue(self::$RENAME_RETURN_METADATA_DEFAULT_VALUE);
self::$RENAME_RETURN_METADATA->setMandatory(true);
self::$adminApi->addMetadataField(self::$RENAME_RETURN_METADATA);

self::createTestAssets(
[
self::RENAME_TARGET => ['upload' => false],
self::RENAME_TARGET => ['upload' => false],
self::RENAME_SOURCE,
self::RENAME_TO_EXISTING_SOURCE,
self::RENAME_TO_EXISTING_TARGET,
self::RENAME_TO_EXISTING_SOURCE_OVERWRITE,
self::RENAME_TO_EXISTING_TARGET_OVERWRITE,
self::CHANGE_TYPE => ['upload' => false],
self::RENAME_TARGET_FOR_CONTEXT_TEST => ['upload' => false],
self::RENAME_SOURCE_FOR_CONTEXT_TEST => [
'options' => [
'context' => [
self::$RENAME_RETURN_CONTEXT_KEY => self::$RENAME_RETURN_CONTEXT_VALUE,
],
],
],
self::RENAME_TARGET_FOR_METADATA_TEST => ['upload' => false],
self::RENAME_SOURCE_FOR_METADATA_TEST,
self::CHANGE_TYPE => ['upload' => false],
self::DESTROY,
self::EXPLICIT,
self::EXCEPTION_IMAGE,
self::EXCEPTION_RAW => [
self::EXCEPTION_RAW => [
'options' => [AssetType::KEY => AssetType::RAW],
'cleanup' => true
'cleanup' => true,
],
]
);
}

/**
* @throws ApiError
*/
public static function tearDownAfterClass()
{
self::cleanupTestAssets();
self::$adminApi->deleteMetadataField(self::$RENAME_RETURN_METADATA_EXTERNAL_ID);

parent::tearDownAfterClass();
}
Expand Down Expand Up @@ -167,13 +201,55 @@ public function testChangeImageType()
self::assertRequestBodySubset(
$lastRequest,
[
'to_type' => 'private',
'to_type' => 'private',
'from_public_id' => self::getTestAssetPublicId(self::CHANGE_TYPE),
'to_public_id' => self::getTestAssetPublicId(self::CHANGE_TYPE)
'to_public_id' => self::getTestAssetPublicId(self::CHANGE_TYPE),
]
);
}

/**
* Test context in the rename API response
*/
public function testRenameReturnsContext()
{
$result = self::$uploadApi->rename(
self::getTestAssetPublicId(self::RENAME_SOURCE_FOR_CONTEXT_TEST),
self::getTestAssetPublicId(self::RENAME_TARGET_FOR_CONTEXT_TEST),
['context' => true]
);

self::assertArrayHasKey('context', $result);

$result = self::$uploadApi->rename(
self::getTestAssetPublicId(self::RENAME_TARGET_FOR_CONTEXT_TEST),
self::getTestAssetPublicId(self::RENAME_SOURCE_FOR_CONTEXT_TEST)
);

self::assertArrayNotHasKey('context', $result);
}

/**
* Test structured metadata in the rename API response
*/
public function testMetadataInRename()
{
$result = self::$uploadApi->rename(
self::getTestAssetPublicId(self::RENAME_SOURCE_FOR_METADATA_TEST),
self::getTestAssetPublicId(self::RENAME_TARGET_FOR_METADATA_TEST),
['metadata' => true]
);

self::assertArrayHasKey('metadata', $result);

$result = self::$uploadApi->rename(
self::getTestAssetPublicId(self::RENAME_TARGET_FOR_METADATA_TEST),
self::getTestAssetPublicId(self::RENAME_SOURCE_FOR_METADATA_TEST)
);

self::assertArrayNotHasKey('metadata', $result);
}

/**
* Performs an eager transformation on a previously uploaded image
*/
Expand Down Expand Up @@ -224,30 +300,30 @@ public function expectUpdateExceptionDataProvider()
{
return [
'Illegal value for `raw_convert`' => [
'publicId' => self::EXCEPTION_RAW,
'options' => ['raw_convert' => 'illegal', 'resource_type' => 'raw'],
'exception' => BadRequest::class,
'publicId' => self::EXCEPTION_RAW,
'options' => ['raw_convert' => 'illegal', 'resource_type' => 'raw'],
'exception' => BadRequest::class,
'exceptionMessage' => 'Illegal value',
],

'Illegal value for `categorization`' => [
'publicId' => self::EXCEPTION_IMAGE,
'options' => ['categorization' => 'illegal'],
'exception' => BadRequest::class,
'publicId' => self::EXCEPTION_IMAGE,
'options' => ['categorization' => 'illegal'],
'exception' => BadRequest::class,
'exceptionMessage' => 'Illegal value',
],

'Illegal value for `detection`' => [
'publicId' => self::EXCEPTION_IMAGE,
'options' => ['detection' => 'illegal'],
'exception' => BadRequest::class,
'publicId' => self::EXCEPTION_IMAGE,
'options' => ['detection' => 'illegal'],
'exception' => BadRequest::class,
'exceptionMessage' => "Illegal value",
],

'Illegal value for `background_removal`' => [
'publicId' => self::EXCEPTION_IMAGE,
'options' => ['background_removal' => 'illegal'],
'exception' => BadRequest::class,
'publicId' => self::EXCEPTION_IMAGE,
'options' => ['background_removal' => 'illegal'],
'exception' => BadRequest::class,
'exceptionMessage' => 'Illegal value',
],
];
Expand Down

0 comments on commit 5964d54

Please sign in to comment.