feat: added support for searching for folders

Author: cloudinary-pkoniu

lib-es5/api.js

@@ -384,6 +384,13 @@ exports.sub_folders = function sub_folders(path, callback) {
   return call_api("get", uri, params, callback, options);
 };
 
+exports.search_folders = function search_folders(params, callback) {
+  var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+
+  options.content_type = 'json';
+  return call_api("post", "folders/search", params, callback, options);
+};
+
 /**
  * Creates an empty folder
  *

lib-es5/v2/api.js

@@ -36,6 +36,7 @@ v1_adapters(exports, api, {
   create_upload_preset: 0,
   root_folders: 0,
   sub_folders: 1,
+  search_folders: 1,
   delete_folder: 1,
   create_folder: 1,
   upload_mappings: 0,

lib-es5/v2/index.js

@@ -6,10 +6,12 @@ var v1 = require('../cloudinary');
 var api = require('./api');
 var uploader = require('./uploader');
 var search = require('./search');
+var search_folders = require('./search_folders');
 
 var v2 = _extends({}, v1, {
   api,
   uploader,
-  search
+  search,
+  search_folders
 });
 module.exports = v2;

lib-es5/v2/search_folders.js

@@ -0,0 +1,42 @@
+'use strict';
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
+
+var Search = require('./search');
+var api = require('./api');
+
+var SearchFolders = function (_Search) {
+  _inherits(SearchFolders, _Search);
+
+  function SearchFolders() {
+    _classCallCheck(this, SearchFolders);
+
+    return _possibleConstructorReturn(this, (SearchFolders.__proto__ || Object.getPrototypeOf(SearchFolders)).call(this));
+  }
+
+  _createClass(SearchFolders, [{
+    key: 'execute',
+    value: function execute(options, callback) {
+      if (callback === null) {
+        callback = options;
+      }
+      options = options || {};
+      return api.search_folders(this.to_query(), options, callback);
+    }
+  }], [{
+    key: 'instance',
+    value: function instance() {
+      return new SearchFolders();
+    }
+  }]);
+
+  return SearchFolders;
+}(Search);
+
+module.exports = SearchFolders;

lib/api.js

@@ -284,6 +284,11 @@ exports.sub_folders = function sub_folders(path, callback, options = {}) {
   return call_api("get", uri, params, callback, options);
 };
 
+exports.search_folders = function search_folders(params, callback, options = {}) {
+  options.content_type = 'json';
+  return call_api("post", "folders/search", params, callback, options);
+}
+
 /**
  * Creates an empty folder
  *

lib/v2/api.js

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

lib/v2/index.js

@@ -2,11 +2,13 @@ const v1 = require('../cloudinary');
 const api = require('./api');
 const uploader = require('./uploader');
 const search = require('./search');
+const search_folders = require('./search_folders');
 
 const v2 = {
   ...v1,
   api,
   uploader,
-  search
+  search,
+  search_folders
 };
 module.exports = v2;

lib/v2/search_folders.js

@@ -0,0 +1,22 @@
+const Search = require('./search');
+const api = require('./api');
+
+const SearchFolders = class SearchFolders extends Search {
+  constructor() {
+    super();
+  }
+
+  static instance() {
+    return new SearchFolders();
+  }
+
+  execute(options, callback) {
+    if (callback === null) {
+      callback = options;
+    }
+    options = options || {};
+    return api.search_folders(this.to_query(), options, callback);
+  }
+};
+
+module.exports = SearchFolders;

test/integration/api/admin/api_spec.js

@@ -1165,7 +1165,7 @@ describe("api", function () {
       let preset_details = await cloudinary.v2.api.upload_preset(preset.name);
       expect(preset_details.settings).to.eql({ use_asset_folder_as_public_id_prefix: true })
     });
-    
+
     it('should update asset_folder', async function () {
       if (!shouldTestFeature(DYNAMIC_FOLDERS)) {
         this.skip();

test/integration/api/search/search_folders_spec.js

@@ -0,0 +1,79 @@
+const cloudinary = require('../../../../cloudinary');
+const {TIMEOUT} = require('../../../testUtils/testConstants');
+const describe = require('../../../testUtils/suite');
+
+const folderNames = ['testFolder1', 'testFolder2'];
+
+describe('search_folders_api', function () {
+  describe('unit', function () {
+    it('should create empty json', function () {
+      const query = cloudinary.v2.search_folders.instance().to_query();
+      expect(query).to.eql({});
+    });
+
+    it('should always return same object in fluent interface', function () {
+      const instance = cloudinary.v2.search_folders.instance();
+      const searchOptions = [
+        'expression',
+        'sort_by',
+        'max_results',
+        'next_cursor',
+        'aggregate',
+        'with_field'
+      ];
+      searchOptions.forEach(method => expect(instance).to.eql(instance[method]('emptyarg')));
+    });
+
+    it('should correctly transform whole query into search payload', function () {
+      const query = cloudinary.v2.search_folders
+        .expression('expression-key:expression-value')
+        .sort_by('sort_by_field', 'asc')
+        .max_results(1)
+        .next_cursor('next_cursor')
+        .aggregate('aggregate1').aggregate('aggregate2')
+        .with_field('field1').with_field('field2')
+        .to_query();
+
+      expect(query).to.eql({
+        expression: 'expression-key:expression-value',
+        sort_by: [{sort_by_field: 'asc'}],
+        max_results: 1,
+        next_cursor: 'next_cursor',
+        aggregate: ['aggregate1', 'aggregate2'],
+        with_field: ['field1', 'field2']
+      })
+    });
+  });
+
+  describe('integration', function () {
+    this.timeout(TIMEOUT.LONG);
+
+    before(function () {
+      return Promise.all(folderNames.map(folderName => {
+        return cloudinary.v2.api.create_folder(folderName);
+      }));
+    });
+
+    after(function () {
+      return Promise.all(folderNames.map(folderName => {
+        return cloudinary.v2.api.delete_folder(folderName);
+      }));
+    });
+
+    it('should return all folders prefixed with testFolder', function () {
+      return cloudinary.v2.search_folders.expression('name=testFolder*')
+        .execute()
+        .then(function (results) {
+          expect(results.folders.length).to.eql(2);
+        });
+    });
+
+    it('should allow search by exact folder name', function () {
+      return cloudinary.v2.search_folders.expression('name=testFolder1')
+        .execute()
+        .then(function (results) {
+          expect(results.folders.length).to.eql(1);
+        });
+    });
+  });
+});