Merge pull request #123 from renderforest/delete-videos-and-watermark-feature

delete-videos-and-watermark-feature

Author: narekhovhannisyan

README.md

@@ -37,6 +37,7 @@ Welcome to the Renderforest API! You can use our API to:
   - [Get a Specific Project](#get-a-specific-project)
   - [Update the Project - partial update](#update-the-project---partial-update)
   - [Delete a Specific Project](#delete-a-specific-project)
+  - [Delete Specific Project Videos](#delete-specific-project-videos)
   - [Apply Template Preset on the Project](#apply-template-preset-on-the-project)
   - [Duplicate the Project](#duplicate-the-project)
   - [Render the Project](#render-the-project)
@@ -272,6 +273,35 @@ var_dump($deleteProject); // handle the success
 [See example](https://github.com/renderforest/renderforest-sdk-php/blob/master/examples/projects/delete-project.php)
 
 
+### Delete Specific Project Videos
+
+Deletes specific project videos. The quality parameter is optional.
+
+**IMPORTANT**: If you want to delete only a single quality video, you have to specify quality parameter, 
+otherwise all quality videos of the project will be deleted.
+
+```php
+<?php
+
+require 'vendor/autoload.php';
+
+$renderforest = new \Renderforest\Client(['signKey' => '<signKey>', 'clientId' => -1]);
+
+$payload = [
+    'projectId' => 5000658,
+    'quality' => 360 // optional argument
+];
+try {
+    $deleteProject = $renderforest->deleteProjectVideos($payload);
+} catch (\GuzzleHttp\Exception\GuzzleException $e) {
+    var_dump($e); // handle the error
+}
+
+var_dump($deleteProject); // handle the success
+```
+
+[See example](https://github.com/renderforest/renderforest-sdk-php/blob/master/examples/projects/delete-project-videos.php)
+
 ### Apply Template Preset on the Project
 
 Applies template preset on the project.
@@ -327,7 +357,9 @@ var_dump($duplicateProject); // handle the success
 
 ### Render the Project
 
-Renders the project.
+Renders the project with given quality. The possible values for the quality are: 0, 360, 720, and 1080. 
+The watermark parameter is optional, must be in '.png' file format and have canvas size of 1920 x 1080 pixels,
+url length must not exceed 250 characters and is not applicable to HD quality videos.
 
 ```php
 <?php
@@ -338,7 +370,8 @@ $renderforest = new \Renderforest\Client(['signKey' => '<signKey>', 'clientId' =
 
 $payload = [
     'projectId' => 5000658,
-    'quality' => 1080
+    'quality' => 360,
+    'watermark' => 'https://example.com/watermark.png' // optional parameter
 ];
 try {
     $renderProject = $renderforest->renderProject($payload);

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "renderforest/sdk-php",
   "description": "Renderforest SDK for PHP",
-  "version": "0.3.9",
+  "version": "0.3.10",
   "homepage": "https://github.com/renderforest/renderforest-sdk-php",
   "authors": [
     {

examples/projects/delete-project-videos.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * Copyright (c) 2018-present, Renderforest, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the license found in the
+ * LICENSE file in the root directory.
+ */
+
+require 'vendor/autoload.php';
+
+$renderforest = new \Renderforest\Client(['signKey' => '<signKey>', 'clientId' => -1]);
+
+$payload = [
+    'projectId' => 5000658,
+    'quality' => 360 // optional argument
+];
+try {
+    $deleteProject = $renderforest->deleteProjectVideos($payload);
+} catch (\GuzzleHttp\Exception\GuzzleException $e) {
+    var_dump($e); // handle the error
+}
+
+var_dump($deleteProject); // handle the success

examples/projects/render-project.php

@@ -13,7 +13,8 @@
 
 $payload = [
     'projectId' => 5000658,
-    'quality' => 1080
+    'quality' => 360,
+    'watermark' => 'https://example.com/watermark.png' // optional argument
 ];
 try {
     $renderProject = $renderforest->renderProject($payload);

src/Client.php

@@ -148,6 +148,17 @@ public function deleteProject($payload)
         return $this->Projects->deleteProject($payload);
     }
 
+    /**
+     * Deletes the rendered project videos based given on quality.
+     * @param array $payload
+     * @return array|null
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function deleteProjectVideos($payload)
+    {
+        return $this->Projects->deleteProjectVideos($payload);
+    }
+
     /**
      * Applies template preset on the project.
      * @param array $payload

src/Params.php

@@ -6,17 +6,18 @@
  * This source code is licensed under the license found in the
  * LICENSE file in the root directory.
  */
+
 namespace Renderforest;
 
 use Renderforest\Error\RenderforestError;
 
 class Params
 {
     /**
-     * @param array $payload
-     * @param array $props
+     * Destructs given properties from the payload.
+     * @param array $payload - The array to destruct.
+     * @param array $props - The prop to destruct from array.
      * @return array
-     * @description Destruct given properties from the payload.
      */
     public function destructParams($payload, $props)
     {
@@ -34,11 +35,11 @@ public function destructParams($payload, $props)
     }
 
     /**
-     * @param array $payload
-     * @param string $param
-     * @return mixed
+     * Destructs URL param from the payload.
+     * @param array $payload - The array to destruct.
+     * @param string $param - The param to destruct from array.
+     * @return string
      * @throws RenderforestError
-     * @description Destruct URL param from the payload.
      */
     public function destructURLParam($payload, $param)
     {
@@ -48,4 +49,24 @@ public function destructURLParam($payload, $param)
 
         return $payload[$param];
     }
+
+    /**
+     * Destructs optional URL param from the given payload.
+     * @param $payload - Thr array to destruct.
+     * @param $param - The param to destruct from array.
+     * @return string
+     * @throws RenderforestError
+     */
+    public function destructOptionalURLParam($payload, $param)
+    {
+        if (!isset($payload) || sizeof($payload)) {
+            throw new RenderforestError("Missing optional parameter: ${param}.");
+        }
+
+        if (!isset($payload[$param])) {
+            return '';
+        }
+
+        return $payload[$param];
+    }
 }

src/Resource/Projects.php

@@ -48,7 +48,6 @@ public function getProjects($payload)
             'endpoint' => "{$this->CONFIG['API_PREFIX']}/projects",
             'qs' => $qs
         ];
-
         return $this->ApiRequest->authorizedRequest($options);
     }
 
@@ -67,7 +66,6 @@ public function addProject($payload)
             'endpoint' => "{$this->CONFIG['API_PREFIX']}/projects",
             'json' => $body
         ];
-
         return $this->ApiRequest->authorizedRequest($options);
     }
 
@@ -85,7 +83,6 @@ public function getTrialProject($payload)
             'endpoint' => "{$this->CONFIG['API_PREFIX']}/projects/trial",
             'qs' => $qs
         ];
-
         return $this->ApiRequest->unauthorizedRequest($options);
     }
 
@@ -102,7 +99,6 @@ public function getProject($payload)
         $options = [
             'endpoint' => "{$this->CONFIG['API_PREFIX']}/projects/$projectId"
         ];
-
         return $this->ApiRequest->authorizedRequest($options);
     }
 
@@ -122,7 +118,6 @@ public function updateProjectPartial($payload)
             'endpoint' => "{$this->CONFIG['API_PREFIX']}/projects/$projectId",
             'json' => $body
         ];
-
         return $this->ApiRequest->authorizedRequest($options);
     }
 
@@ -140,7 +135,25 @@ public function deleteProject($payload)
             'method' => 'DELETE',
             'endpoint' => "{$this->CONFIG['API_PREFIX']}/projects/$projectId"
         ];
+        return $this->ApiRequest->authorizedRequest($options);
+    }
 
+    /**
+     * Deletes specific project videos. The quality parameter is optional.
+     * IMPORTANT: In case if quality is not specified, it will remove all rendered videos.
+     * @param $payload
+     * @return array|null
+     * @throws \GuzzleHttp\Exception\GuzzleException
+     */
+    public function deleteProjectVideos($payload)
+    {
+        $projectId = $this->Params->destructURLParam($payload, 'projectId');
+        $quality = $this->Params->destructOptionalURLParam($payload, 'quality');
+
+        $options = [
+            'method' => 'DELETE',
+            'endpoints' => "{$this->CONFIG['API_PREFIX']}/projects/$projectId/videos/$quality"
+        ];
         return $this->ApiRequest->authorizedRequest($options);
     }
 
@@ -160,7 +173,6 @@ public function applyTemplatePresetOnProject($payload)
             'endpoint' => "{$this->CONFIG['API_PREFIX']}/projects/$projectId/apply-template-preset",
             'json' => $body
         ];
-
         return $this->ApiRequest->authorizedRequest($options);
     }
 
@@ -178,7 +190,6 @@ public function duplicateProject($payload)
             'method' => 'POST',
             'endpoint' => "{$this->CONFIG['API_PREFIX']}/projects/$projectId/duplicate"
         ];
-
         return $this->ApiRequest->authorizedRequest($options);
     }
 
@@ -190,15 +201,14 @@ public function duplicateProject($payload)
      */
     public function renderProject($payload)
     {
-        $body = $this->Params->destructParams($payload, ['quality']);
+        $body = $this->Params->destructParams($payload, ['quality', 'watermark']);
         $projectId = $this->Params->destructURLParam($payload, 'projectId');
 
         $options = [
             'method' => 'POST',
             'endpoint' => "{$this->CONFIG['API_PREFIX']}/projects/$projectId/render",
             'json' => $body
         ];
-
         return $this->ApiRequest->authorizedRequest($options);
     }
 }