Updated MediaGallery modules and marked as API

app/code/Magento/MediaGallery/Model/Asset/Command/GetById.php

@@ -16,7 +16,7 @@
 use Psr\Log\LoggerInterface;
 
 /**
- * Class GetById
+ * Get media asset by id
  */
 class GetById implements GetByIdInterface
 {
@@ -28,7 +28,7 @@ class GetById implements GetByIdInterface
     private $resourceConnection;
 
     /**
-     * @var AssetInterface
+     * @var AssetInterfaceFactory
      */
     private $assetFactory;
 

app/code/Magento/MediaGallery/Model/Asset/Command/GetByPath.php

@@ -30,7 +30,7 @@ class GetByPath implements GetByPathInterface
     private $resourceConnection;
 
     /**
-     * @var AssetInterface
+     * @var AssetInterfaceFactory
      */
     private $mediaAssetFactory;
 
@@ -78,9 +78,7 @@ public function execute(string $mediaFilePath): AssetInterface
                 throw new NoSuchEntityException($message);
             }
 
-            $mediaAssets = $this->mediaAssetFactory->create(['data' => $data]);
-
-            return $mediaAssets;
+            return $this->mediaAssetFactory->create(['data' => $data]);
         } catch (\Exception $exception) {
             $this->logger->critical($exception);
             $message = __('An error occurred during get media asset list: %1', $exception->getMessage());

app/code/Magento/MediaGallery/Model/Directory/Command/CreateByPath.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MediaGallery\Model\Directory\Command;
+
+use Magento\Cms\Model\Wysiwyg\Images\Storage;
+use Magento\Framework\Exception\CouldNotSaveException;
+use Magento\MediaGalleryApi\Model\Directory\Command\CreateByPathInterface;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Create folder by provided path
+ */
+class CreateByPath implements CreateByPathInterface
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @var Storage
+     */
+    private $storage;
+
+    /**
+     * @param LoggerInterface $logger
+     * @param Storage $storage
+     */
+    public function __construct(
+        LoggerInterface $logger,
+        Storage $storage
+    ) {
+        $this->logger = $logger;
+        $this->storage = $storage;
+    }
+
+    /**
+     * Create new directory by the provided path in the media storage
+     *
+     * @param string $path
+     * @param string $name
+     * @throws CouldNotSaveException
+     */
+    public function execute(string $path, string $name): void
+    {
+        try {
+            $this->storage->createDirectory($name, $this->storage->getCmsWysiwygImages()->getStorageRoot() . $path);
+        } catch (\Exception $exception) {
+            $this->logger->critical($exception);
+            throw new CouldNotSaveException(__('Failed to create the folder'), $exception);
+        }
+    }
+}

app/code/Magento/MediaGallery/Model/Directory/Command/DeleteByPath.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MediaGallery\Model\Directory\Command;
+
+use Magento\Cms\Model\Wysiwyg\Images\Storage;
+use Magento\Framework\Exception\CouldNotDeleteException;
+use Magento\MediaGalleryApi\Model\Directory\Command\DeleteByPathInterface;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Delete directory from media storage by path
+ */
+class DeleteByPath implements DeleteByPathInterface
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @var Storage
+     */
+    private $storage;
+
+    /**
+     * @param LoggerInterface $logger
+     * @param Storage $storage
+     */
+    public function __construct(
+        LoggerInterface $logger,
+        Storage $storage
+    ) {
+        $this->logger = $logger;
+        $this->storage = $storage;
+    }
+
+    /**
+     * Removes directory and corresponding thumbnails directory from media storage if not in blacklist
+     *
+     * @param string $path
+     * @throws CouldNotDeleteException
+     */
+    public function execute(string $path): void
+    {
+        try {
+            $this->storage->deleteDirectory($this->storage->getCmsWysiwygImages()->getStorageRoot() . $path);
+        } catch (\Exception $exception) {
+            $this->logger->critical($exception);
+            throw new CouldNotDeleteException(__('Failed to delete the folder'), $exception);
+        }
+    }
+}

app/code/Magento/MediaGallery/Model/File/Command/DeleteByAssetId.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MediaGallery\Model\File\Command;
+
+use Magento\Cms\Model\Wysiwyg\Images\Storage;
+use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Filesystem;
+use Magento\MediaGalleryApi\Model\File\Command\DeleteByAssetIdInterface;
+use Magento\MediaGalleryApi\Model\Asset\Command\GetByIdInterface;
+
+/**
+ * Load Media Asset path from database by id and delete the file
+ */
+class DeleteByAssetId implements DeleteByAssetIdInterface
+{
+    /**
+     * @var GetByIdInterface
+     */
+    private $getAssetById;
+
+    /**
+     * @var Storage
+     */
+    private $imagesStorage;
+
+    /**
+     * @var Filesystem
+     */
+    private $filesystem;
+
+    /**
+     * DeleteAssetById constructor.
+     *
+     * @param GetByIdInterface $getAssetById
+     * @param Storage $imagesStorage
+     * @param Filesystem $filesystem
+     */
+    public function __construct(
+        GetByIdInterface $getAssetById,
+        Storage $imagesStorage,
+        Filesystem $filesystem
+    ) {
+        $this->getAssetById = $getAssetById;
+        $this->imagesStorage = $imagesStorage;
+        $this->filesystem = $filesystem;
+    }
+
+    /**
+     * Delete image by asset ID
+     *
+     * @param int $assetId
+     * @return void
+     * @throws LocalizedException
+     */
+    public function execute(int $assetId): void
+    {
+        $mediaFilePath = $this->getAssetById->execute($assetId)->getPath();
+        $mediaDirectory = $this->filesystem->getDirectoryRead(DirectoryList::MEDIA);
+
+        if (!$mediaDirectory->isFile($mediaFilePath)) {
+            throw new LocalizedException(__('File "%1" does not exist in media directory.', $mediaFilePath));
+        }
+
+        $this->imagesStorage->deleteFile($mediaDirectory->getAbsolutePath() . $mediaFilePath);
+    }
+}

app/code/Magento/MediaGallery/Model/Keyword/Command/GetAssetKeywords.php

@@ -15,7 +15,7 @@
 use Psr\Log\LoggerInterface;
 
 /**
- * ClassGetAssetKeywords
+ * Retrieve keywords for the media asset
  */
 class GetAssetKeywords implements GetAssetKeywordsInterface
 {
@@ -59,7 +59,7 @@ public function __construct(
      *
      * @param int $assetId
      *
-     * @return KeywordInterface[]|[]
+     * @return KeywordInterface[]
      * @throws IntegrationException
      */
     public function execute(int $assetId): array

app/code/Magento/MediaGallery/Test/Unit/Model/File/Command/DeleteByAssetIdTest.php

@@ -0,0 +1,103 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MediaGallery\Test\Unit\Model\File\Command;
+
+use Magento\Cms\Model\Wysiwyg\Images\Storage;
+use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\Filesystem;
+use Magento\Framework\Filesystem\Directory\Read;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\MediaGalleryApi\Api\Data\AssetInterface;
+use Magento\MediaGalleryApi\Model\Asset\Command\GetByIdInterface;
+use Magento\MediaGallery\Model\File\Command\DeleteByAssetId;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Test the DeleteByAssetIdTest command model
+ */
+class DeleteByAssetIdTest extends TestCase
+{
+    /**
+     * @var MockObject|Filesystem
+     */
+    private $filesystem;
+
+    /**
+     * @var MockObject|Storage
+     */
+    private $storage;
+
+    /**
+     * @var MockObject|GetByIdInterface
+     */
+    private $getById;
+
+    /**
+     * @var DeleteByAssetId
+     */
+    private $object;
+
+    /**
+     * Initialize basic test class mocks
+     */
+    protected function setUp(): void
+    {
+        $this->filesystem = $this->createMock(Filesystem::class);
+        $this->storage = $this->createMock(Storage::class);
+        $this->getById = $this->createMock(GetByIdInterface::class);
+
+        $this->object = (new ObjectManager($this))->getObject(
+            DeleteByAssetId::class,
+            [
+                'filesystem' => $this->filesystem,
+                'imagesStorage' => $this->storage,
+                'getAssetById' => $this->getById
+            ]
+        );
+    }
+
+    /**
+     * Test delete file by asset id
+     */
+    public function testExecute(): void
+    {
+        $assetId = 42;
+        $path = '/file1.jpg';
+        $absoluteMediaPath = '/var/www/html/pub/media';
+
+        $asset = $this->createMock(AssetInterface::class);
+        $asset->expects($this->once())
+            ->method('getPath')
+            ->willReturn($path);
+
+        $this->getById->expects($this->once())
+            ->method('execute')
+            ->with($assetId)
+            ->willReturn($asset);
+
+        $directory = $this->createMock(Read::class);
+        $directory->expects($this->once())
+            ->method('isFile')
+            ->willReturn(true);
+        $directory->expects($this->once())
+            ->method('getAbsolutePath')
+            ->willReturn($absoluteMediaPath);
+
+        $this->filesystem->expects($this->once())
+            ->method('getDirectoryRead')
+            ->with(DirectoryList::MEDIA)
+            ->willReturn($directory);
+
+        $this->storage->expects($this->once())
+            ->method('deleteFile')
+            ->with($absoluteMediaPath . $path);
+
+        $this->object->execute($assetId);
+    }
+}

app/code/Magento/MediaGallery/etc/di.xml

@@ -21,6 +21,10 @@
 
     <preference for="Magento\MediaGalleryApi\Model\DataExtractorInterface" type="Magento\MediaGallery\Model\DataExtractor"/>
 
+    <preference for="Magento\MediaGalleryApi\Model\Directory\Command\CreateByPathInterface" type="Magento\MediaGallery\Model\Directory\Command\CreateByPath"/>
+    <preference for="Magento\MediaGalleryApi\Model\Directory\Command\DeleteByPathInterface" type="Magento\MediaGallery\Model\Directory\Command\DeleteByPath"/>
+    <preference for="Magento\MediaGalleryApi\Model\File\Command\DeleteByAssetIdInterface" type="Magento\MediaGallery\Model\File\Command\DeleteByAssetId"/>
+
     <type name="Magento\Catalog\Model\Product\Gallery\Processor">
         <plugin name="media_gallery_image_remove_metadata" type="Magento\MediaGallery\Plugin\Product\Gallery\Processor"
                 sortOrder="10" disabled="false"/>

app/code/Magento/MediaGalleryApi/Api/Data/AssetInterface.php

@@ -13,6 +13,7 @@
 /**
  * Represents a media gallery asset which contains information about a media asset entity such
  * as path to the media storage, media asset title and its content type, etc.
+ * @api
  */
 interface AssetInterface extends ExtensibleDataInterface
 {

app/code/Magento/MediaGalleryApi/Api/Data/KeywordInterface.php

@@ -12,6 +12,7 @@
 
 /**
  * Represents a media gallery keyword. This object contains information about a media asset keyword entity.
+ * @api
  */
 interface KeywordInterface extends ExtensibleDataInterface
 {

app/code/Magento/MediaGalleryApi/Model/Asset/Command/DeleteByDirectoryPathInterface.php

@@ -11,14 +11,14 @@
 /**
  * A command represents the media gallery assets delete action. A media gallery asset is filtered by directory
  * path value.
+ * @api
  */
 interface DeleteByDirectoryPathInterface
 {
     /**
      * Delete media assets by directory path
      *
      * @param string $directoryPath
-     *
      * @return void
      */
     public function execute(string $directoryPath): void;