Support for creating folders using Admin API (#370)

* Add `create_folder` to Admin API

Author: RTLcoil

lib-es5/api.js

@@ -338,6 +338,22 @@ exports.sub_folders = function sub_folders(path, callback) {
   return call_api("get", uri, {}, callback, options);
 };
 
+/**
+ * Creates an empty folder
+ *
+ * @param {string}    path      The folder path to create
+ * @param {function}  callback  Callback function
+ * @param {object}    options   Configuration options
+ * @returns {*}
+ */
+exports.create_folder = function create_folder(path, callback) {
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+
+  var uri = void 0;
+  uri = ["folders", path];
+  return call_api("post", uri, {}, callback, options);
+};
+
 exports.delete_folder = function delete_folder(path, callback) {
   var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
 

lib-es5/v2/api.js

@@ -34,6 +34,7 @@ v1_adapters(exports, api, {
   root_folders: 0,
   sub_folders: 1,
   delete_folder: 1,
+  create_folder: 1,
   upload_mappings: 0,
   upload_mapping: 1,
   delete_upload_mapping: 1,

lib/api.js

@@ -248,6 +248,20 @@ exports.sub_folders = function sub_folders(path, callback, options = {}) {
   return call_api("get", uri, {}, callback, options);
 };
 
+/**
+ * Creates an empty folder
+ *
+ * @param {string}    path      The folder path to create
+ * @param {function}  callback  Callback function
+ * @param {object}    options   Configuration options
+ * @returns {*}
+ */
+exports.create_folder = function create_folder(path, callback, options = {}) {
+  let uri;
+  uri = ["folders", path];
+  return call_api("post", uri, {}, callback, options);
+};
+
 exports.delete_folder = function delete_folder(path, callback, options = {}) {
   let uri;
   uri = ["folders", path];

lib/v2/api.js

@@ -32,6 +32,7 @@ v1_adapters(exports, api, {
   root_folders: 0,
   sub_folders: 1,
   delete_folder: 1,
+  create_folder: 1,
   upload_mappings: 0,
   upload_mapping: 1,
   delete_upload_mapping: 1,

test/api_spec.js

@@ -24,7 +24,8 @@ const {
   UNIQUE_JOB_SUFFIX_ID,
   PRESETS,
   TRANSFORMATIONS,
-  PUBLIC_ID_PREFIX
+  PUBLIC_ID_PREFIX,
+  UNIQUE_TEST_FOLDER,
 } = testConstants;
 
 const {
@@ -905,83 +906,96 @@ describe("api", function () {
       ));
     }));
   });
-  // For this test to work, "Auto-create folders" should be enabled in the Upload Settings.
-  // Replace `it` with  `it.skip` below if you want to disable it.
-  it("should list folders in cloudinary", function () {
-    this.timeout(TIMEOUT.LONG);
-    return Q.all([
-      uploadImage({
-        public_id: 'test_folder1/item',
-        tags: UPLOAD_TAGS,
-      }),
-      uploadImage({
-        public_id: 'test_folder2/item',
-        tags: UPLOAD_TAGS,
-      }),
-      uploadImage({
-        public_id: 'test_folder2/item',
-        tags: UPLOAD_TAGS,
-      }),
-      uploadImage({
-        public_id: 'test_folder1/test_subfolder1/item',
-        tags: UPLOAD_TAGS,
-      }),
-      uploadImage({
-        public_id: 'test_folder1/test_subfolder2/item',
-        tags: UPLOAD_TAGS,
-      }),
-    ]).then(wait(3000)).then(function (results) {
-      return Q.all([cloudinary.v2.api.root_folders(), cloudinary.v2.api.sub_folders('test_folder1')]);
-    }).then(function (results) {
-      var folder, root, root_folders, sub_1;
-      root = results[0];
-      root_folders = (() => {
-        var j, len, ref, results1;
-        ref = root.folders;
-        results1 = [];
-        for (j = 0, len = ref.length; j < len; j++) {
-          folder = ref[j];
-          results1.push(folder.name);
-        }
-        return results1;
-      })();
-      sub_1 = results[1];
-      expect(root_folders).to.contain('test_folder1');
-      expect(root_folders).to.contain('test_folder2');
-      expect(sub_1.folders[0].path).to.eql('test_folder1/test_subfolder1');
-      expect(sub_1.folders[1].path).to.eql('test_folder1/test_subfolder2');
-      return cloudinary.v2.api.sub_folders('test_folder_not_exists');
-    }).then((result) => {
-      console.log('error test_folder_not_exists should not pass to "then" handler but "catch"');
-      expect().fail('error test_folder_not_exists should not pass to "then" handler but "catch"');
-    }).catch((err) => {
-      let error = err.error;
-      return expect(error.message).to.eql('Can\'t find folder with path test_folder_not_exists');
-    });
-  });
-  describe("delete folders", function() {
-    this.timeout(TIMEOUT.MEDIUM);
-    const folderPath= "test_folder/delete_folder/"+TEST_TAG;
-    before(function(){
-      return uploadImage({
-        folder: folderPath,
-        tags: UPLOAD_TAGS
-      }).delay(2 * 1000).then(function() {
-        return cloudinary.v2.api.delete_resources_by_prefix(folderPath)
-          .then(() => cloudinary.v2.api.sub_folders(folderPath).then(folder => {
-            expect(folder).not.to.be(null);
-            expect(folder["total_count"]).to.eql(0);
-            expect(folder["folders"]).to.be.empty;
-        }));
+  describe("folders", function () {
+    // For this test to work, "Auto-create folders" should be enabled in the Upload Settings.
+    // Replace `it` with  `it.skip` below if you want to disable it.
+    it("should list folders in cloudinary", function () {
+      this.timeout(TIMEOUT.LONG);
+      return Q.all([
+        uploadImage({
+          public_id: 'test_folder1/item',
+          tags: UPLOAD_TAGS,
+        }),
+        uploadImage({
+          public_id: 'test_folder2/item',
+          tags: UPLOAD_TAGS,
+        }),
+        uploadImage({
+          public_id: 'test_folder2/item',
+          tags: UPLOAD_TAGS,
+        }),
+        uploadImage({
+          public_id: 'test_folder1/test_subfolder1/item',
+          tags: UPLOAD_TAGS,
+        }),
+        uploadImage({
+          public_id: 'test_folder1/test_subfolder2/item',
+          tags: UPLOAD_TAGS,
+        }),
+      ]).then(wait(TIMEOUT.SHORT))
+        .then(function (results) {
+          return Q.all([cloudinary.v2.api.root_folders(), cloudinary.v2.api.sub_folders('test_folder1')]);
+        }).then(function (results) {
+          var folder, root, root_folders, sub_1;
+          root = results[0];
+          root_folders = (() => {
+            var j, len, ref, results1;
+            ref = root.folders;
+            results1 = [];
+            for (j = 0, len = ref.length; j < len; j++) {
+              folder = ref[j];
+              results1.push(folder.name);
+            }
+            return results1;
+          })();
+          sub_1 = results[1];
+          expect(root_folders).to.contain('test_folder1');
+          expect(root_folders).to.contain('test_folder2');
+          expect(sub_1.folders[0].path).to.eql('test_folder1/test_subfolder1');
+          expect(sub_1.folders[1].path).to.eql('test_folder1/test_subfolder2');
+          return cloudinary.v2.api.sub_folders('test_folder_not_exists');
+        }).then(wait(TIMEOUT.LONG)).then((result) => {
+          console.log('error test_folder_not_exists should not pass to "then" handler but "catch"');
+          expect().fail('error test_folder_not_exists should not pass to "then" handler but "catch"');
+        }).catch(({ error }) => expect(error.message).to.eql('Can\'t find folder with path test_folder_not_exists'));
+    });
+    describe("create_folder", function () {
+      it("should create a new folder", function () {
+        const folderPath = `${UNIQUE_TEST_FOLDER}`;
+        const expectedPath = `folders/${folderPath}`;
+        return helper.mockPromise(function (xhr, write, request) {
+          cloudinary.v2.api.create_folder(folderPath);
+          sinon.assert.calledWith(request, sinon.match({
+            pathname: sinon.match(expectedPath),
+            method: sinon.match("POST"),
+          }));
+        });
       });
     });
-    it('should delete an empty folder', function () {
+    describe("delete_folder", function () {
       this.timeout(TIMEOUT.MEDIUM);
-      return cloudinary.v2.api.delete_folder(
-        folderPath
-      ).delay(2 * 1000).then(() => cloudinary.v2.api.sub_folders(folderPath)
-      ).then(()=> expect().fail()
-      ).catch(({error}) => expect(error.message).to.contain("Can't find folder with path"));
+      const folderPath = "test_folder/delete_folder/" + TEST_TAG;
+      before(function () {
+        return uploadImage({
+          folder: folderPath,
+          tags: UPLOAD_TAGS,
+        }).delay(2 * 1000).then(function () {
+          return cloudinary.v2.api.delete_resources_by_prefix(folderPath)
+            .then(() => cloudinary.v2.api.sub_folders(folderPath).then(folder => {
+              expect(folder).not.to.be(null);
+              expect(folder["total_count"]).to.eql(0);
+              expect(folder["folders"]).to.be.empty;
+            }));
+        });
+      });
+      it('should delete an empty folder', function () {
+        this.timeout(TIMEOUT.MEDIUM);
+        return cloudinary.v2.api.delete_folder(
+          folderPath
+        ).delay(2 * 1000).then(() => cloudinary.v2.api.sub_folders(folderPath)
+        ).then(()=> expect().fail()
+        ).catch(({error}) => expect(error.message).to.contain("Can't find folder with path"));
+      });
     });
   });
   describe('.restore', function () {

test/testUtils/testConstants.js

@@ -9,10 +9,12 @@ const SDK_TAG = "SDK_TEST"; // identifies resources created by all SDKs tests
 const TEST_TAG_PREFIX = "cloudinary_npm_test"; // identifies resources created by this SDKs tests
 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`;
 
 module.exports = {
   TEST_TAG_PREFIX,
   PUBLIC_ID_PREFIX,
+  UNIQUE_TEST_FOLDER,
   TIMEOUT: {
     SHORT: 5000,
     MEDIUM: 20000,