terminalizer/commands/share.js

/**
 * Share
 * Upload a recording file and get a link for an online player
 * 
 * @author Mohammad Fares <faressoft.com@gmail.com>
 */

/**
 * Executed after the command completes its task
 *
 * @param {String} url the url of the uploaded recording
 */
function done(url) {

  console.log(di.chalk.green('Successfully Uploaded'));
  console.log('The recording is available on the link:');
  console.log(di.chalk.magenta(url));
  process.exit();

}

/**
 * Check if the value is not an empty value
 *
 * - Throw `Required field` if empty
 * 
 * @param  {String} input
 * @return {Boolean}
 */
function isSet(input) {

  if (!input) {
    return new Error('Required field');
  }

  return true;

}

/**
 * Get a token for uploading recordings
 *
 * - Check if already registered
 *   - Yes: use the token
 *   - No: Generate a new one and ask the user to register it
 *
 * @param  {Object}  context
 * @return {Promise}
 */
function getToken(context) {

  var token = di.utility.getToken();

  // Already registered
  if (token) {
    return Promise.resolve(token);
  }

  token = di.utility.generateToken();

  console.log('Open the following link in your browser and login into your account');
  console.log(di.chalk.dim(BASEURL + '/token?token=' + token) + '\n');

  // Continue action
  return new Promise(function(resolve, reject) {

    console.log('When you do it, press any key to continue');
    process.stdin.setRawMode(true);
    process.stdin.resume();

    process.stdin.once('data', function handler() {

      console.log(di.chalk.dim('Enjoy !') + '\n');
      process.stdin.pause();
      process.stdin.setRawMode(false);

      resolve(token);

    });
    
  });

}

/**
 * Ask the user to enter meta data about the recording
 *
 * - Skip the task if already executed before
 *   and resolve with the last result
 *
 * @param  {Object}  context
 * @return {Promise}
 */
function getMeta(context) {

  var platform = di.utility.getOS();

  // Already executed
  if (typeof context.getMeta != 'undefined') {
    return Promise.resolve(context.getMeta);
  }

  console.log('Please enter some details about your recording');

  return di.inquirer.prompt([
    {
      type: 'input',
      name: 'title',
      message: 'Title',
      validate: isSet
    },
    {
      type: 'input',
      name: 'description',
      message: 'Description',
      validate: isSet
    },
    {
      type: 'input',
      name: 'tags',
      message: 'Tags ' + di.chalk.dim('such as git,bash,game'),
      validate: isSet,
      default: platform
    }
  ]).then(function(answers) {

    var params = Object.assign({}, answers);

    // Add the platform
    params.platform = platform;

    // Print a new line
    console.log();

    return params;

  });

}

/**
 * The command's main function
 * 
 * @param {Object} argv
 */
function command(argv) {

  // No global config
  if (!di.utility.isGlobalDirectoryCreated()) {
    require('./init.js').handler();
  }

  di.Flowa.run({

    // Get a token for uploading recordings
    getToken: getToken,

    // Ask the user to enter meta data about the recording
    getMeta: getMeta,

    // Upload the recording
    shareRecording: shareRecording

  }, argv).then(function(context) {
  
    done(context.shareRecording);
  
  }).catch(di.errorHandler);

}

////////////////////////////////////////////////////
// Command Definition //////////////////////////////
////////////////////////////////////////////////////

/**
 * Command's usage
 * @type {String}
 */
module.exports.command = 'share <recordingFile>';

/**
 * Command's description
 * @type {String}
 */
module.exports.describe = 'Upload a recording file and get a link for an online player';

/**
 * Command's handler function
 * @type {Function}
 */
module.exports.handler = command;

/**
 * Builder
 * 
 * @param {Object} yargs
 */
module.exports.builder = function(yargs) {

  // Define the recordingFile argument
  yargs.positional('recordingFile', {
    describe: 'the recording file',
    type: 'string',
    coerce: di._.partial(di.utility.resolveFilePath, di._, 'yml')
  });

};