added checks parameter

Author: ANKUR DWIVEDI

README.md

@@ -122,6 +122,7 @@ echo $imageURL;
 $uploadFile = $imageKit->uploadFile([
     'file' => 'file-url', # required, "binary","base64" or "file url"
     'fileName' => 'new-file' # required
+    'checks' => '"file.size" < "1mb"' //  optional `checks` parameters can be used to run server-side checks before files are uploaded to the Media Library.
 ]);
 ```  
 
@@ -562,6 +563,7 @@ The SDK provides a simple interface using the `$imageKit->uploadFile()` method t
 $uploadFile = $imageKit->uploadFile([
     'file' => 'your_file',              //  required, "binary","base64" or "file url"
     'fileName' => 'your_file_name.jpg', //  required
+    'checks' => '"file.size" < "1mb"',  //  optional `checks` parameters can be used to run server-side checks before files are uploaded to the Media Library.
 ]);
 ```
 #### Response
@@ -657,6 +659,7 @@ $uploadFile = $imageKit->uploadFile([
             ]
         ]
     ],
+    'checks' => '"file.size" < "1mb"',  //  optional `checks` parameters can be used to run server-side checks before files are uploaded to the Media Library.
     // "customMetadata" => [
     //         "SKU" => "VS882HJ2JD",
     //         "price" => 599.99,

src/ImageKit/Constants/ErrorMessages.php

@@ -49,6 +49,7 @@ class ErrorMessages
     public static $UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_TRANSFORMATION  = [ "message" => "Invalid transformation parameter. Please include at least pre, post, or both.", "help" => "For support kindly contact us at [email protected] ."];
     public static $UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_PRE_TRANSFORMATION = [ "message" => "Invalid pre transformation parameter.", "help" => "For support kindly contact us at [email protected] ."];
     public static $UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_POST_TRANSFORMATION = [ "message" => "Invalid post transformation parameter.", "help" => "For support kindly contact us at [email protected] ."];
+    public static $UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_CHECKS = [ "message" => "The value provided for the checks parameter is invalid.", "help" => "For support kindly contact us at [email protected] ."];
     public static $MISSING_UPLOAD_DATA = ['message' => 'Missing data for upload', 'help' => 'For support kindly contact us at [email protected] .'];
     public static $MISSING_UPLOAD_FILE_PARAMETER = ['message' => 'Missing file parameter for upload', 'help' => 'For support kindly contact us at [email protected] .'];
     public static $MISSING_UPLOAD_FILENAME_PARAMETER = ['message' => 'Missing fileName parameter for upload', 'help' => 'For support kindly contact us at [email protected] .'];

src/ImageKit/ImageKit.php

@@ -216,6 +216,9 @@ public function uploadFile($options=null)
                     return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_POST_TRANSFORMATION));
                 }
             }
+            if(isset($options['checks']) && !is_string($options['checks'])){
+                return Response::respond(true, ((object)ErrorMessages::$UPLOAD_FILE_PARAMETER_OPTIONS_INVALID_CHECKS));
+            }
         }
 
 

tests/ImageKit/Upload/UploadTest.php

@@ -172,6 +172,7 @@ public function testFileUploadIfSuccessful()
                     ]
                 ]
             ],
+            'checks' => "'request.folder' : '/sample-folder'"
         ];
 
         $mockBodyResponse = Utils::streamFor(json_encode($this->uploadSuccessResponseObj));
@@ -215,6 +216,7 @@ public function testFileUploadIfSuccessful()
         $this->checkFormData($stream,$boundary,"overwriteCustomMetadata","true");
         $this->checkFormData($stream,$boundary,"customMetadata",json_encode($fileOptions['customMetadata']));
         $this->checkFormData($stream,$boundary,"transformation",json_encode($fileOptions['transformation']));
+        $this->checkFormData($stream,$boundary,"checks",$fileOptions['checks']);
 
         // Assert Method
         $requestMethod = $container[0]['request']->getMethod();
@@ -785,6 +787,32 @@ public function testFileUploadWithInvalidTransformationTypePostTransformation()
         UploadTest::assertEquals(json_encode($error),json_encode($response->error));
     }
 
+
+    /**
+     *
+    */
+    public function testFileUploadWithInvalidChecks()
+    {
+        $fileOptions = [
+            'file'  =>  'http://lorempixel.com/640/480/',
+            'fileName'  =>  'test_file_name',
+            "useUniqueFileName" => true,                                        // true|false
+            "responseFields" => implode(",", ["tags", "customMetadata"]),       // Comma Separated, check docs for more responseFields
+            'checks' => true
+        ];
+
+        $error = [
+            "message" => "The value provided for the checks parameter is invalid.",
+            "help" => "For support kindly contact us at [email protected] ."
+        ];
+
+        $this->stubHttpClient(new Response(403, ['X-Foo' => 'Bar'], json_encode($error)));
+
+        $response = $this->client->uploadFile($fileOptions);
+
+        // Request Body Check
+        UploadTest::assertEquals(json_encode($error),json_encode($response->error));
+    }
 
     protected function setUp()
     {