Merge pull request #42 from msheheryar1/dev

Dev

Author: imagekitio

README.md

@@ -19,7 +19,7 @@ ImageKit is complete media storage, optimization, and transformation solution th
     * [File Upload](#file-upload)
 - [Demo Application](#demo-application)
 - [URL Generation](#url-generation-1)
-- [Signed URL & Image Transformations](#applying-chained-transformations-common-image-manipulations-signed-url--conditional-transformation)
+- [Signed URL & Image Transformations](#applying-chained-transformations-common-image-manipulations--signed-url)
 - [Server-side File Upload](#server-side-file-upload)
 - [File Management](#file-management)
 - [Custom Metadata Fields API](#custom-metadata-fields-api)
@@ -787,20 +787,20 @@ $deleteFiles = $imageKit->bulkFileDeleteByIds($fileIds);
 
 This will copy a file from one folder to another.
 
->  If any file at the destination has the same name as the source file, then the source file and its versions (if `includeVersions` is set to true) will be appended to the destination file version history.
+>  If any file at the destination has the same name as the source file, then the source file and its versions (if `includeFileVersions` is set to true) will be appended to the destination file version history.
 
 Refer to the [copy file API](https://docs.imagekit.io/api-reference/media-api/copy-file) for a better understanding of the **request & response structure**.
 
 #### Basic Usage
 ```php
 $sourceFilePath = '/sample-folder1/sample-file.jpg';
 $destinationPath = '/sample-folder2/';
-$includeVersions = false;
+$includeFileVersions = false;
 
 $copyFile = $imageKit->copy([
     'sourceFilePath' => $sourceFilePath,
     'destinationPath' => $destinationPath,
-    'includeVersions' => $includeVersions
+    'includeFileVersions' => $includeFileVersions
 ]);
 ```
 
@@ -906,11 +906,11 @@ Refer to the [copy folder API](https://docs.imagekit.io/api-reference/media-api/
 ```php
 $sourceFolderPath = '/source-folder/';
 $destinationPath = '/destination-folder/';
-$includeVersions = false;
+$includeFileVersions = false;
 $copyFolder = $imageKit->copyFolder([
     'sourceFolderPath' => $sourceFolderPath,
     'destinationPath' => $destinationPath,
-    'includeVersions' => $includeVersions
+    'includeFileVersions' => $includeFileVersions
 ]);
 ```
 

sample/file_management/index.php

@@ -28,6 +28,7 @@
     "fileType" => "all",
     "limit" => 10,
     "skip" => 0,
+    "tags" => implode(",",["tag3","tag4"]),
 ]);
 
 echo "\n\n";
@@ -127,7 +128,7 @@
 $copyFile = $imageKit->copy([
     'sourceFilePath' => $sourceFilePath,
     'destinationPath' => $destinationPath,
-    'includeVersions' => false
+    'includeFileVersions' => false
 ]);
 
 echo "\n\n";
@@ -205,11 +206,11 @@
 
 $sourceFolderPath = $folderName;
 $destinationPath = '/sample-folder';
-$includeVersions = false;
+$includeFileVersions = false;
 $copyFolder = $imageKit->copyFolder([
     'sourceFolderPath' => $sourceFolderPath,
     'destinationPath' => $destinationPath,
-    'includeVersions' => $includeVersions
+    'includeFileVersions' => $includeFileVersions
 ]);
 
 echo "\n\n";

src/ImageKit/Constants/ErrorMessages.php

@@ -77,7 +77,7 @@ class ErrorMessages
         'For support kindly contact us at [email protected] .'];
     public static $COPY_FILE_PARAMETER_NON_ARRAY = ['message' => 'Copy File API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at [email protected] .'];
     public static $COPY_FILE_PARAMETER_EMPTY_ARRAY = ['message' => 'Copy File API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at [email protected] .'];
-    public static $COPY_FILE_DATA_INVALID = ['message' => 'Missing parameter sourceFilePath and/or destinationPath and/or includeVersions for Copy File API', 'help' =>
+    public static $COPY_FILE_DATA_INVALID = ['message' => 'Missing parameter sourceFilePath and/or destinationPath for Copy File API', 'help' =>
         'For support kindly contact us at [email protected] .'];
     public static $MOVE_FILE_PARAMETER_MISSING = ['message' => 'Move File API accepts an array, null passed', 'help' =>
         'For support kindly contact us at [email protected] .'];
@@ -109,7 +109,7 @@ class ErrorMessages
         'For support kindly contact us at [email protected] .'];
     public static $COPY_FOLDER_PARAMETER_NON_ARRAY = ['message' => 'Copy Folder API accepts an array of parameters, non array value passed', 'help' => 'For support kindly contact us at [email protected] .'];
     public static $COPY_FOLDER_PARAMETER_EMPTY_ARRAY = ['message' => 'Copy Folder API accepts an array of parameters, empty array passed', 'help' => 'For support kindly contact us at [email protected] .'];
-    public static $COPY_FOLDER_DATA_INVALID = ['message' => 'Missing parameter sourceFolderPath and/or destinationPath and/or includeVersions for Copy Folder API', 'help' =>
+    public static $COPY_FOLDER_DATA_INVALID = ['message' => 'Missing parameter sourceFolderPath and/or destinationPath for Copy Folder API', 'help' =>
         'For support kindly contact us at [email protected] .'];
     public static $MOVE_FOLDER_PARAMETER_MISSING = ['message' => 'Move Folder API accepts an array, null passed', 'help' =>
         'For support kindly contact us at [email protected] .'];

src/ImageKit/ImageKit.php

@@ -59,7 +59,7 @@ class ImageKit
      * @return void
      */
     public function __construct($publicKey, $privateKey, $urlEndpoint, $transformationPosition =
-    Transformation::DEFAULT_TRANSFORMATION_POSITION)
+    Transformation::DEFAULT_TRANSFORMATION_POSITION, $handlerStack=null)
     {
         $this->configuration = new Configuration();
         if ($publicKey == null || empty($publicKey)) {
@@ -90,8 +90,7 @@ public function __construct($publicKey, $privateKey, $urlEndpoint, $transformati
         }
         $this->configuration->transformationPosition = $transformationPosition;
 
-
-        $client = new Client(Authorization::addAuthorization($this->configuration));
+        $client = new Client(Authorization::addAuthorization($this->configuration,$handlerStack));
         $this->httpClient = new GuzzleHttpWrapper($client);
     }
 
@@ -687,7 +686,7 @@ public function bulkDeleteFiles($fileIds=null)
      *
      * @link https://docs.imagekit.io/api-reference/media-api/copy-file
      *
-     * @param $parameter['sourceFilePath','destinationPath','includeVersions']
+     * @param $parameter['sourceFilePath','destinationPath','includeFileVersions']
      * @return Response
      * 
      */
@@ -702,12 +701,12 @@ public function copy($parameter=null)
         if(sizeof($parameter)==0){
             return Response::respond(true, ((object)ErrorMessages::$COPY_FILE_PARAMETER_EMPTY_ARRAY));
         }
-        if (empty($parameter['sourceFilePath']) || empty($parameter['destinationPath']) || !isset($parameter['includeVersions'])) {
+        if (empty($parameter['sourceFilePath']) || empty($parameter['destinationPath'])) {
             return Response::respond(true, ((object)ErrorMessages::$COPY_FILE_DATA_INVALID));
         }
 
         $this->httpClient->setUri(Endpoints::getCopyFileEndpoint());
-        return Manage\File::copy($parameter['sourceFilePath'], $parameter['destinationPath'], $parameter['includeVersions'], $this->httpClient);
+        return Manage\File::copy($parameter['sourceFilePath'], $parameter['destinationPath'], $parameter['includeFileVersions']??false, $this->httpClient);
     }
 
 
@@ -719,21 +718,21 @@ public function copy($parameter=null)
      *
      * @param $sourceFilePath
      * @param $destinationPath
-     * @param $includeVersions
+     * @param $includeFileVersions
      * @return Response
      * 
      * @deprecated since 3.0.0, use <code>copy</code>
      *
      */
-    public function copyFile($sourceFilePath=null, $destinationPath=null, $includeVersions=null)
+    public function copyFile($sourceFilePath=null, $destinationPath=null, $includeFileVersions=null)
     {
 
         if (empty($sourceFilePath) || empty($destinationPath)) {
             return Response::respond(true, ((object)ErrorMessages::$COPY_FILE_DATA_INVALID));
         }
 
         $this->httpClient->setUri(Endpoints::getCopyFileEndpoint());
-        return Manage\File::copy($sourceFilePath, $destinationPath, $includeVersions, $this->httpClient);
+        return Manage\File::copy($sourceFilePath, $destinationPath, $includeFileVersions, $this->httpClient);
     }
 
     /**
@@ -928,7 +927,7 @@ public function deleteFolder($folderPath=null)
      *
      * @link https://docs.imagekit.io/api-reference/media-api/copy-folder
      *
-     * @param $parameter[$sourceFolderPath, $destinationPath, includeVersions]
+     * @param $parameter[$sourceFolderPath, $destinationPath, includeFileVersions]
      *
      * @return Response
      */
@@ -943,12 +942,12 @@ public function copyFolder($parameter=null)
         if(sizeof($parameter)==0){
             return Response::respond(true, ((object)ErrorMessages::$COPY_FOLDER_PARAMETER_EMPTY_ARRAY));
         }
-        if (empty($parameter['sourceFolderPath']) || empty($parameter['destinationPath']) || !isset($parameter['includeVersions'])) {
+        if (empty($parameter['sourceFolderPath']) || empty($parameter['destinationPath'])) {
             return Response::respond(true, ((object)ErrorMessages::$COPY_FOLDER_DATA_INVALID));
         }
 
         $this->httpClient->setUri(Endpoints::getCopyFolderEndpoint());
-        return Manage\Folder::copy($parameter['sourceFolderPath'], $parameter['destinationPath'], $parameter['includeVersions'], $this->httpClient);
+        return Manage\Folder::copy($parameter['sourceFolderPath'], $parameter['destinationPath'], $parameter['includeFileVersions']??false, $this->httpClient);
     }
 
     /**

src/ImageKit/Manage/File.php

@@ -23,6 +23,9 @@ class File
     public static function listFile(GuzzleHttpWrapper $resource,$parameters=null)
     {
         if($parameters){
+            if (isset($parameters['tags']) && is_array($parameters['tags'])) {
+                $parameters['tags'] = implode(',', $parameters['tags']);
+            }
             $resource->setDatas($parameters);
         }
         try {
@@ -273,9 +276,9 @@ public static function bulkDeleteByFileIds($fileIds, GuzzleHttpWrapper $resource
      *
      * @return Response
      */
-    public static function copy($sourceFilePath, $destinationPath, $includeVersions, GuzzleHttpWrapper $resource)
+    public static function copy($sourceFilePath, $destinationPath, $includeFileVersions, GuzzleHttpWrapper $resource)
     {
-        $resource->setDatas(['sourceFilePath' => $sourceFilePath, 'destinationPath' => $destinationPath, 'includeVersions' => $includeVersions]);
+        $resource->setDatas(['sourceFilePath' => $sourceFilePath, 'destinationPath' => $destinationPath, 'includeFileVersions' => $includeFileVersions]);
         try {
             $res = $resource->post();
         } catch (\Throwable $th) {
@@ -539,12 +542,12 @@ public static function updateDetails($fileId, $updateData, GuzzleHttpWrapper $re
     {
         $obj = (object)$updateData;
 
-        if (isset($obj->tags) && ($obj->tags !== null) && ($obj->tags !== 'undefined') && !is_array($obj->tags)) {
-            return Response::respond(true, ((object)ErrorMessages::$UPDATE_DATA_TAGS_INVALID));
+        if (isset($obj->tags) && is_string($obj->tags)) {
+            $updateData['tags'] = explode(',', $obj->tags);
         }
 
-        if (isset($obj->customCoordinates) && ($obj->customCoordinates !== 'undefined') && is_array($obj->customCoordinates)) {
-            return Response::respond(true, ((object)ErrorMessages::$UPDATE_DATA_COORDS_INVALID));
+        if (isset($obj->customCoordinates) && is_array($obj->customCoordinates)) {
+            $updateData['customCoordinates'] = implode(',', $obj->customCoordinates);
         }
 
         $resource->setDatas($updateData);

src/ImageKit/Manage/Folder.php

@@ -90,9 +90,9 @@ public static function delete($folderPath, GuzzleHttpWrapper $httpClient)
      *
      * @return Response
      */
-    public static function copy($sourceFolderPath, $destinationPath, $includeVersions, GuzzleHttpWrapper $httpClient)
+    public static function copy($sourceFolderPath, $destinationPath, $includeFileVersions, GuzzleHttpWrapper $httpClient)
     {
-        $httpClient->setDatas(['sourceFolderPath' => $sourceFolderPath, 'destinationPath' => $destinationPath, 'includeVersions' => $includeVersions]);
+        $httpClient->setDatas(['sourceFolderPath' => $sourceFolderPath, 'destinationPath' => $destinationPath, 'includeFileVersions' => $includeFileVersions]);
         try {
             $res = $httpClient->post();
         } catch (\Throwable $th) {

src/ImageKit/Utils/Authorization.php

@@ -13,12 +13,13 @@ class Authorization
      * @param Configuration $configuration
      * @return array[]
      */
-    public static function addAuthorization(Configuration $configuration)
+    public static function addAuthorization(Configuration $configuration,$handlerStack=null)
     {
         return [
             'auth' => [
                 $configuration->privateKey, ''
-            ]
+            ],
+            'handler'=>$handlerStack
         ];
     }
 }

tests/ImageKit/Manage/CacheTest.php

@@ -5,9 +5,14 @@
 use GuzzleHttp\Psr7\Response;
 use GuzzleHttp\Psr7\Utils;
 use ImageKit\ImageKit;
+use ImageKit\Utils\Transformation;
 use ImageKit\Manage\Cache;
 use ImageKit\Resource\GuzzleHttpWrapper;
+use GuzzleHttp\Handler\MockHandler;
 use PHPUnit\Framework\TestCase;
+use GuzzleHttp\Client;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Middleware;
 
 class CacheTest extends TestCase
 {
@@ -28,10 +33,31 @@ public function testPurgeCache()
         ];
         $mockBodyResponse = Utils::streamFor(json_encode($responseBody));
 
-        $this->stubHttpClient('post', new Response(201, ['X-Foo' => 'Bar'], $mockBodyResponse));
+        $mock = new MockHandler([
+            new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse)
+        ]);
 
-        $response = $this->client->purgeCache($image_url);
+        $handlerStack = HandlerStack::create($mock);
+
+        $container = [];
+        $history = Middleware::history($container);
+
+        $handlerStack->push($history);
+        
+        $this->createMockClient($handlerStack);
+
+        $response = $this->mockClient->purgeCache($image_url);
+        
+        $request = $container[0]['request'];
+        $requestPath = $request->getUri()->getPath();
+        $stream = Utils::streamFor($request->getBody())->getContents();
+        $stream = json_decode($stream,true);
 
+        // Request Check
+        CacheTest::assertEquals("/v1/files/purge",$requestPath);
+        CacheTest::assertEquals($stream['url'],$image_url);
+
+        // Response Check
         CacheTest::assertEquals(json_encode($responseBody), json_encode($response->result));
     }
 
@@ -72,10 +98,32 @@ public function testPurgeCacheStatus()
 
         $mockBodyResponse = Utils::streamFor(json_encode($responseBody));
 
-        $this->stubHttpClient('get', new Response(201, ['X-Foo' => 'Bar'], $mockBodyResponse));
+        $mock = new MockHandler([
+            new Response(200, ['X-Foo' => 'Bar'], $mockBodyResponse)
+        ]);
 
-        $response = $this->client->purgeCacheStatus($cacheRequestId);
+        $handlerStack = HandlerStack::create($mock);
+
+        $container = [];
+        $history = Middleware::history($container);
+
+        $handlerStack->push($history);
+        
+        $this->createMockClient($handlerStack);
+        
+        $response = $this->mockClient->purgeCacheStatus($cacheRequestId);
 
+        $request = $container[0]['request'];
+        $requestPath = $request->getUri()->getPath();
+        $stream = Utils::streamFor($request->getBody())->getContents();
+        $stream = json_decode($stream,true);
+        
+        // Request Check
+        CacheTest::assertEquals("/v1/files/purge/{$cacheRequestId}",$requestPath);
+        CacheTest::assertEmpty($stream);
+
+
+        // Response Check
         CacheTest::assertEquals(json_encode($responseBody), json_encode($response->result));
     }
 
@@ -116,6 +164,20 @@ protected function setUp(): void
 
     }
 
+    /**
+     * 
+     */
+    private function createMockClient($handler){
+        $this->mockClient = new ImageKit(
+            'testing_public_key',
+            'testing_private_key',
+            'https://ik.imagekit.io/demo',
+            Transformation::DEFAULT_TRANSFORMATION_POSITION,
+            $handler
+        );
+    }
+
+
     protected function tearDown(): void
     {
         $this->client = null;