Add eval parameter to upload params (#438)

* Add eval parameter support to upload

Author: RTLcoil

lib-es5/utils/index.js

@@ -308,6 +308,7 @@ function build_upload_params(options) {
     eager: utils.build_eager(options.eager),
     eager_async: utils.as_safe_bool(options.eager_async),
     eager_notification_url: options.eager_notification_url,
+    eval: options.eval,
     exif: utils.as_safe_bool(options.exif),
     faces: utils.as_safe_bool(options.faces),
     folder: options.folder,

lib/utils/index.js

@@ -289,6 +289,7 @@ function build_upload_params(options) {
     eager: utils.build_eager(options.eager),
     eager_async: utils.as_safe_bool(options.eager_async),
     eager_notification_url: options.eager_notification_url,
+    eval: options.eval,
     exif: utils.as_safe_bool(options.exif),
     faces: utils.as_safe_bool(options.faces),
     folder: options.folder,

test/integration/api/admin/api_spec.js

@@ -18,7 +18,8 @@ const {
   PRESETS,
   TRANSFORMATIONS,
   PUBLIC_ID_PREFIX,
-  UNIQUE_TEST_FOLDER
+  UNIQUE_TEST_FOLDER,
+  TEST_EVAL_STR
 } = testConstants;
 
 const {
@@ -656,7 +657,8 @@ describe("api", function () {
             colors: true,
             unsigned: true,
             disallow_public_id: true,
-            live: true
+            live: true,
+            eval: TEST_EVAL_STR
           });
         var expectedPath="/.*\/upload_presets/"+API_TEST_UPLOAD_PRESET3+"$";
         sinon.assert.calledWith(requestSpy, sinon.match({
@@ -667,6 +669,7 @@ describe("api", function () {
         sinon.assert.calledWith(writeSpy, sinon.match(helper.apiParamMatcher('unsigned', true, "unsigned=true")));
         sinon.assert.calledWith(writeSpy, sinon.match(helper.apiParamMatcher('disallow_public_id', true, "disallow_public_id=true")));
         sinon.assert.calledWith(writeSpy, sinon.match(helper.apiParamMatcher('live', true, "live=true")));
+        sinon.assert.calledWith(writeSpy, sinon.match(helper.apiParamMatcher('eval', TEST_EVAL_STR, `eval=${TEST_EVAL_STR}`)));
       });
     });
     it("should allow creating upload_presets", function () {
@@ -675,7 +678,8 @@ describe("api", function () {
           folder: "upload_folder",
           unsigned: true,
           tags: UPLOAD_TAGS,
-          live: true
+          live: true,
+          eval: TEST_EVAL_STR
         }).then((preset) => {
           cloudinary.v2.api.delete_upload_preset(preset.name).catch((err) => {
             console.log(err);
@@ -685,6 +689,7 @@ describe("api", function () {
 
         sinon.assert.calledWith(writeSpy, sinon.match(helper.apiParamMatcher('unsigned', true, "unsigned=true")));
         sinon.assert.calledWith(writeSpy, sinon.match(helper.apiParamMatcher('live', true, "live=true")));
+        sinon.assert.calledWith(writeSpy, sinon.match(helper.apiParamMatcher('eval', TEST_EVAL_STR, `eval=${TEST_EVAL_STR}`)));
       });
     });
   });

test/integration/api/uploader/uploader_spec.js

@@ -30,7 +30,9 @@ const UPLOADER_V2 = cloudinary.v2.uploader;
 
 const {
   TIMEOUT,
-  TAGS
+  TAGS,
+  TEST_EVAL_STR,
+  TEST_IMG_WIDTH
 } = testConstants;
 
 const {
@@ -1133,6 +1135,21 @@ describe("uploader", function () {
     });
   });
 
+  it('should add the eval parameter to an uploaded asset', async () => {
+    const testEvalTagsResult = ['a', 'b'];
+    const result = await UPLOADER_V2.upload(IMAGE_FILE, {
+      tags: [TEST_TAG],
+      eval: TEST_EVAL_STR
+    });
+
+    expect(result).not.to.be.empty();
+    expect(result.tags).to.be.an("array");
+    expect(result.tags).to.eql(testEvalTagsResult);
+    expect(result.context).to.be.an("object");
+    expect(result.context.custom).to.be.an("object");
+    expect(result.context.custom.width).to.eql(TEST_IMG_WIDTH);
+  });
+
   describe("sign requests", function () {
     var configBck2 = void 0;
     var writeSpy;

test/spechelper.js

@@ -119,6 +119,7 @@ exports.apiParamMatcher = function (name, value) {
   params = {};
   params[name] = value;
   expected = querystring.stringify(params);
+  expected = exports.escapeRegexp(expected);
   return function (arg) {
     return new RegExp(expected).test(arg);
   };

test/testUtils/testConstants.js

@@ -13,13 +13,18 @@ const TEST_TAG_PREFIX = "cloudinary_npm_test"; // identifies resources created b
 const TEST_TAG = `${TEST_TAG_PREFIX}_${UNIQUE_JOB_SUFFIX_ID}`;
 const UPLOAD_TAGS = [TEST_TAG, TEST_TAG_PREFIX, SDK_TAG];
 const UNIQUE_TEST_FOLDER = `${TEST_TAG}_${UNIQUE_JOB_SUFFIX_ID}_folder`;
+const TEST_IMG_WIDTH = 241;
 const TEST_CLOUD_NAME = process.env.CLOUDINARY_URL.split('@')[1];
 
+const TEST_EVAL_STR = 'if (resource_info["width"] < 450) { upload_options["tags"] = "a,b" }; ' +
+    'upload_options["context"] = "width=" + resource_info["width"]';
 module.exports = {
   TEST_TAG_PREFIX,
+  TEST_IMG_WIDTH,
   TEST_CLOUD_NAME,
   PUBLIC_ID_PREFIX,
   UNIQUE_TEST_FOLDER,
+  TEST_EVAL_STR,
   TIMEOUT: {
     SHORT: 5000,
     MEDIUM: 20000,

types/index.d.ts

@@ -491,6 +491,7 @@ declare module 'cloudinary' {
         eager?: TransformationOptions;
         eager_async?: boolean;
         eager_notification_url?: string;
+        eval?: string;
         exif?: boolean;
         faces?: boolean;
         folder?: string;