Add animations when uploading Swagger

Author: gkoberger

api.js

@@ -78,7 +78,15 @@ exports.api = function(args, opts) {
       utils.removeMetadata(swagger);
 
       info.swagger = swagger;
-      actionObj.run(config, info);
+
+      if(actionObj.swaggerUrl) {
+        utils.getSwaggerUrl(config, info, function(url) {
+          info.swaggerUrl = url;
+          actionObj.run(config, info);
+        });
+      } else {
+        actionObj.run(config, info);
+      }
     });
   } else {
     actionObj.run(config, info);

lib/docs.js

@@ -1,18 +1,13 @@
-var request = require('request');
-
 exports.swagger = true;
+exports.swaggerUrl = true;
 exports.login = true;
 exports.desc = "Upload your docs to ReadMe.io";
 
 exports.run = function(config, info) {
   console.log('Uploading Swagger file...');
 
-  request.post(config.host.url + '/', {
-    'form': {
-      'swagger': JSON.stringify(info.swagger),
-      'cli': 1,
-    }
-  }, function(err, res, url) {
-    console.log("https://swagger.readme.io/preview/" + new Buffer(url).toString('base64'));
-  });
+  console.log("You can view your new docs here:");
+  console.log("");
+  console.log("  https://swagger.readme.io/preview/" + new Buffer(info.swaggerUrl).toString('base64'));
+  console.log("");
 };

lib/host.js

@@ -1,23 +1,13 @@
-var request = require('request');
-
 exports.swagger = true;
+exports.swaggerUrl = true;
 exports.login = true;
 exports.desc = "Get a public URL for your API";
 
 exports.run = function(config, info) {
-  console.log('Uploading Swagger file...');
-
-  request.post(config.host.url + '/', {
-    'form': {
-      'swagger': JSON.stringify(info.swagger),
-      'cli': 1,
-    }
-  }, function(err, res, url) {
-    console.log("");
-    console.log("You can now access your Swagger from the following public URL:");
-    console.log("");
-    console.log("  " + url);
-    console.log("");
-    console.log("(You can also use .yaml to get the YAML representation.)");
-  });
+  console.log("");
+  console.log("Success! ".green + "You can now access your Swagger from the following public URL:");
+  console.log("");
+  console.log("  " + info.swaggerUrl);
+  console.log("");
+  console.log("You can also use .yaml to get the YAML representation.".grey);
 };

lib/mock.js

@@ -1,19 +1,22 @@
 var _ = require('lodash');
+var utils = require('../utils');
 var request = require('request');
 
 exports.swagger = true;
 exports.login = true;
 exports.desc = "Run a mock server based on your API";
 
 exports.run = function(config, info) {
-  console.log('Uploading Swagger file...');
+  var status = utils.uploadAnimation();
 
   request.post(config.mock.url + '/upload', {
     'form': {
       'swagger': JSON.stringify(info.swagger),
     },
     json: true
   }, function(err, res, data) {
+    status(true);
+
     var samples = [];
     _.each(info.swagger.paths, function(types, path) {
       _.each(types, function(endpoint, type) {
@@ -25,9 +28,9 @@ exports.run = function(config, info) {
 
     console.log("Success!".green.bold + " You now have an API you can test against:");
     console.log("");
-    console.log(config.mock.url + '/upload', err, data);
     console.log("  " + data.url);
     console.log("");
+
     if(samples.length) {
       console.log("Here's some example URLs you can try:");
       console.log("");
@@ -36,5 +39,6 @@ exports.run = function(config, info) {
         console.log(type(s[0]) + data.url + (info.swagger.basePath || "") + s[1]);
       });
     }
+
   });
 };

package.json

@@ -29,6 +29,7 @@
     "jsonfile": "^2.3.1",
     "lodash": "^4.13.1",
     "minimist": "^1.2.0",
+    "node-status": "^1.0.0",
     "open": "0.0.5",
     "readline-sync": "^1.4.4",
     "request": "^2.73.0",

utils.js

@@ -5,8 +5,10 @@ var glob = require("glob")
 
 var _ = require('lodash');
 var git = require('git-utils');
+var status = require('node-status')
 var swagger = require('swagger-parser');
 var yaml = require('yamljs');
+var request = require('request');
 var swaggerInline = require('swagger-inline');
 
 exports.config = function(env) {
@@ -94,6 +96,47 @@ exports.fileExists = function(file) {
   }
 };
 
+exports.getSwaggerUrl = function(config, info, cb) {
+  var status = exports.uploadAnimation();
+
+  request.post(config.host.url + '/', {
+    'form': {
+      'swagger': JSON.stringify(info.swagger),
+      'cli': 1,
+    }
+  }, function(err, res, url) {
+    status(!!url);
+
+    if(!url) {
+      console.log("");
+      console.log("There was an issue uploading your swagger file".red);
+      return;
+    }
+
+    cb(url);
+
+  });
+};
+
+exports.uploadAnimation = function() {
+  console.log("");
+  var job = status.addItem('job', {
+    steps: [
+      'Swagger uploaded!',
+    ]
+  });
+
+  status.start({
+      interval: 200,
+      pattern: '{spinner.green} Uploading your Swagger file...',
+  });
+
+  return function(success) {
+    job.doneStep(success);
+    status.stop();
+  };
+};
+
 exports.guessLanguage = function(cb) {
   // Really simple way at guessing the language.
   // If we're wrong, it's not a big deal... and