grunt-ssh/tasks/lib/util.js

SSH and SFTP tasks for Grunt

/*
 * grunt-ssh
 * https://github.com/andrewrjones/grunt-ssh
 *
 * Copyright (c) 2013 Andrew Jones
 * Licensed under the MIT license.
 */
exports.init = function (grunt) {
  'use strict';

  var exports = {};

  exports.port = 22;

  // Ensures the string is set and valid
  exports.validateString = function (name, string) {
    if (!string) {
      grunt.warn('Missing ' + name + ' property.');
      return false;
    }
    if (grunt.util._.isFunction(string)) {
      string = string(grunt);
    }
    if (!grunt.util._(string).isString()) {
      grunt.warn('The ' + name + ' property must be a string.');
      return false;
    }
    return string;
  };

  // Ensures the string is set and valid then processes the template
  exports.validateStringAndProcess = function (name, string) {
    return grunt.template.process(exports.validateString(name, string));
  };

  exports.validateStringArrayAndProcess = function (name, strings) {
    if (!strings) {
      grunt.warn('Missing ' + name + ' property.');
      return false;
    }
    if (grunt.util._.isFunction(strings)) {
      strings = strings(grunt);
    }
    if (grunt.util._(strings).isString()) {
      return [grunt.template.process(strings)];
    } else if (grunt.util._(strings).isArray()) {
      var processed = [];
      for (var i = 0; i < strings.length; i++) {
        var string = strings[i];
        if (!grunt.util._(string).isString()) {
          grunt.warn('The ' + name + ' property must be a string or array of strings.');
          processed = false;
          break;
        } else {
          processed.push(grunt.template.process(string));
        }
      }
      return processed;
    } else {
      grunt.warn('The ' + name + ' property must be a string or array of strings.');
      return false;
    }
  };

  // Ensures the number is set and valid
  exports.validateNumber = function (name, number) {
    if (!number && number !== 0) {
      grunt.warn('Missing ' + name + ' property.');
      return false;
    }
    if (!grunt.util._(number).isNumber()) {
      grunt.warn('The ' + name + ' property must be a number.');
      return false;
    }
    return number;
  };

  exports.parseConnectionOptions = function (options) {
    var connectionOptions = {
      host: options.host,
      port: options.port,
      username: options.username,
      readyTimeout: options.readyTimeout,
      agentForward: options.agentForward
    };

    if (options.privateKey) {
      connectionOptions.privateKey = options.privateKey.trim();

      if (options.passphrase) {
        connectionOptions.passphrase = options.passphrase.trim();
      }
    }
    else if (options.password) {
      connectionOptions.password = options.password;
      if (options.agent) {
        connectionOptions.agent = options.agent;
      }
    } else {
      connectionOptions.agent = options.agent;
    }

    return connectionOptions;
  };

  // Converts a file size in bytes into a human-readable file size string.
  exports.fileSizeReadable = function (bytes) {
    var KB = 1024,
        MB = KB * 1024,
        GB = MB * 1024,
        result;

    if (bytes < KB) {
      result = bytes + 'B';
    }
    else if (bytes < MB) {
      result = Math.floor(bytes / KB) + 'KB';
    }
    else if (bytes < GB) {
      result = Math.floor(bytes / MB) + 'MB';
    }
    else {
      result = Math.floor(bytes / GB) + 'GB';
    }

    return result;
  };

  return exports;
};