Merge pull request #503 from CriGoT/add-migrations-manager

feat(migrations): adds migrations manager

src/management/MigrationsManager.js

@@ -0,0 +1,108 @@
+var ArgumentError = require('rest-facade').ArgumentError;
+var Auth0RestClient = require('../Auth0RestClient');
+var RetryRestClient = require('../RetryRestClient');
+
+/**
+ * @class
+ * Abstracts interaction with the migrations endpoint.
+ * @constructor
+ * @memberOf module:management
+ *
+ * @param {Object} options            The client options.
+ * @param {String} options.baseUrl    The URL of the API.
+ * @param {Object} [options.headers]  Headers to be included in all requests.
+ * @param {Object} [options.retry]    Retry Policy Config
+ */
+var MigrationsManager = function(options) {
+  if (options === null || typeof options !== 'object') {
+    throw new ArgumentError('Must provide manager options');
+  }
+
+  if (options.baseUrl === null || options.baseUrl === undefined) {
+    throw new ArgumentError('Must provide a base URL for the API');
+  }
+
+  if ('string' !== typeof options.baseUrl || options.baseUrl.length === 0) {
+    throw new ArgumentError('The provided base URL is invalid');
+  }
+
+  var clientOptions = {
+    errorFormatter: { message: 'message', name: 'error' },
+    headers: options.headers,
+    query: { repeatParams: false }
+  };
+
+  /**
+   * Provides an abstraction layer for consuming the migrations endpoint
+   *
+   * @type {external:RestClient}
+   */
+  var auth0RestClient = new Auth0RestClient(
+    options.baseUrl + '/migrations',
+    clientOptions,
+    options.tokenProvider
+  );
+  this.resource = new RetryRestClient(auth0RestClient, options.retry);
+};
+
+/**
+ * Update the tenant migrations.
+ *
+ * @method    updateMigrations
+ * @memberOf  module:management.MigrationsManager.prototype
+ *
+ * @example
+ * management.migrations.updateMigrations(data, function (err) {
+ *   if (err) {
+ *     // Handle error.
+ *   }
+ * });
+ *
+ * @param   {Object}    data  The tenant migrations to be updated
+ * @param   {Object}    data.flags  The tenant migrations flags to be updated
+ * @param   {Function}  [cb]  Callback function.
+ *
+ * @return  {Promise|undefined}
+ */
+MigrationsManager.prototype.updateMigrations = function(data, cb) {
+  if (cb && cb instanceof Function) {
+    return this.resource.patch({}, data, cb);
+  }
+
+  // Return a promise.
+  return this.resource.patch({}, data);
+};
+
+/**
+ * Get the tenant migrations.
+ *
+ * @method    getMigrations
+ * @memberOf  module:management.MigrationsManager.prototype
+ *
+ * @example
+ * management.migrations.getMigrations(function (err, migrations) {
+ *   if (err) {
+ *     // Handle error.
+ *   }
+ *
+ *   console.log(migrations.flags);
+ * });
+ *
+ * @param   {Function}  [cb]    Callback function.
+ *
+ * @return  {Promise|undefined}
+ */
+MigrationsManager.prototype.getMigrations = function(data, cb) {
+  if (data instanceof Function && !cb) {
+    cb = data;
+    data = {};
+  }
+  if (cb && cb instanceof Function) {
+    return this.resource.get(data, cb);
+  }
+
+  // Return a promise.
+  return this.resource.get(data);
+};
+
+module.exports = MigrationsManager;

src/management/index.js

@@ -32,6 +32,7 @@ var CustomDomainsManager = require('./CustomDomainsManager');
 var RolesManager = require('./RolesManager');
 var HooksManager = require('./HooksManager');
 var BrandingManager = require('./BrandingManager');
+var MigrationsManager = require('./MigrationsManager');
 
 var BASE_URL_FORMAT = 'https://%s/api/v2';
 var MANAGEMENT_API_AUD_FORMAT = 'https://%s/api/v2/';
@@ -327,6 +328,13 @@ var ManagementClient = function(options) {
    * @type {HooksManager}
    */
   this.branding = new BrandingManager(managerOptions);
+
+  /**
+   * ManagementClient migrations manager.
+   *
+   * @type {MigrationsManager}
+   */
+  this.migrations = new MigrationsManager(managerOptions);
 };
 
 /**
@@ -3344,4 +3352,50 @@ utils.wrapPropertyMethod(ManagementClient, 'updateBrandingSettings', 'branding.u
  */
 utils.wrapPropertyMethod(ManagementClient, 'getBrandingSettings', 'branding.getSettings');
 
+/**
+ * Update the tenant migrations.
+ *
+ * @method    updateMigrations
+ * @memberOf  module:management.ManagementClient.prototype
+ *
+ * @example
+ * data = { flags: { migration: true } };
+ * management.updateMigrations(data, function (err, migrations) {
+ *   if (err) {
+ *     // Handle error.
+ *   }
+ *
+ * // Updated migrations flags
+ *    console.log(migrations.flags);
+ * });
+ *
+ * @param   {Object}    data              Updated migrations data.
+ * @param   {Function}  [cb]              Callback function.
+ *
+ * @return    {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'updateMigrations', 'migrations.updateMigrations');
+
+/**
+ * Get migrations flags
+ *
+ * @method    getMigrations
+ * @memberOf  module:management.ManagementClient.prototype
+ *
+ * @example
+ * management.getMigrations(function (err, migrations) {
+ *   if (err) {
+ *     // Handle error.
+ *   }
+ *
+ * // Migration flags
+ *    console.log(migrations.flags);
+ * });
+ *
+ * @param   {Function}  [cb]              Callback function.
+ *
+ * @return    {Promise|undefined}
+ */
+utils.wrapPropertyMethod(ManagementClient, 'getMigrations', 'migrations.getMigrations');
+
 module.exports = ManagementClient;