Switch swagger command to use promises

Author: Dom Harrington

cli.js

@@ -16,19 +16,10 @@ function load(command = 'help') {
   }
 }
 
-function defaultCallback(err) {
-  if (err) {
-    console.error(err);
-    return process.exit(1);
-  }
-
-  return process.exit();
-}
-
-module.exports = function(cmd, args, opts = {}, cb = defaultCallback) {
+module.exports = function(cmd, args, opts = {}) {
   const command = load(cmd);
 
-  if (!command) return;
+  if (!command) return undefined;
 
-  command.run({ args, opts }, cb);
+  return command.run({ args, opts });
 };

lib/help.js

@@ -55,4 +55,6 @@ exports.run = function() {
   console.log('');
 
   process.exitCode = 0;
+
+  return Promise.resolve();
 };

lib/swagger.js

@@ -1,12 +1,13 @@
-const request = require('request');
+const request = require('request-promise-native');
 const fs = require('fs');
 const path = require('path');
 const config = require('config');
 
 exports.desc = 'Upload your swagger file to ReadMe';
 exports.category = 'services';
+exports.weight = 1;
 
-exports.run = function({ args, opts }, cb) {
+exports.run = function({ args, opts }) {
   let { key, id } = opts;
 
   if (!key && opts.token) {
@@ -17,24 +18,21 @@ exports.run = function({ args, opts }, cb) {
   }
 
   if (!key) {
-    return cb(new Error('No api key provided. Please use --key'));
+    return Promise.reject(new Error('No api key provided. Please use --key'));
   }
 
   if (!args[0]) {
-    return cb(new Error('No swagger file provided. Usage `rdme swagger <swagger-file>`'));
+    return Promise.reject(new Error('No swagger file provided. Usage `rdme swagger <swagger-file>`'));
   }
 
-  function callback(err, response, data) {
-    if (err) return cb(err);
-    if (response.statusCode === 201 || response.statusCode === 200) {
-      console.log(data);
-      console.log('Success! '.green);
-    } else {
-      console.log(data);
-      console.error('There was an error uploading!'.red);
-    }
-
-    return cb();
+  function success(data) {
+    console.log(data);
+    console.log('Success! '.green);
+  }
+
+  function error(err) {
+    console.log(err.error);
+    console.error('There was an error uploading!'.red);
   }
 
   const options = {
@@ -46,9 +44,9 @@ exports.run = function({ args, opts }, cb) {
 
   // Create
   if (!id) {
-    return request.post(`${config.host}/api/v1/swagger`, options, callback);
+    return request.post(`${config.host}/api/v1/swagger`, options).then(success, error);
   }
 
   // Update
-  return request.put(`${config.host}/api/v1/swagger/${id}`, options, callback);
+  return request.put(`${config.host}/api/v1/swagger/${id}`, options).then(success, error);
 };

package-lock.json

@@ -30,7 +30,8 @@
     "colors": "^1.1.2",
     "config": "^1.30.0",
     "minimist": "^1.2.0",
-    "request": "^2.81.0"
+    "request": "^2.81.0",
+    "request-promise-native": "^1.0.5"
   },
   "devDependencies": {
     "eslint": "^4.19.1",

package.json

@@ -1,4 +1,9 @@
 #! /usr/bin/env node
 const parseArgs = require('minimist')(process.argv.slice(2));
 
-require('./cli')(parseArgs._[0], parseArgs._.slice(1), parseArgs);
+require('./cli')(parseArgs._[0], parseArgs._.slice(1), parseArgs)
+  .then(() => process.exit())
+  .catch(err => {
+    console.error(err);
+    return process.exit(1);
+  });

rdme.js

@@ -9,61 +9,47 @@ const key = 'Xmw4bGctRVIQz7R7dQXqH9nQe5d0SPQs';
 describe('swagger command', () => {
   afterAll(() => nock.cleanAll());
 
-  it('should error if no api key provided', done => {
-    swagger(['./test/fixtures/swagger.json'], {}, err => {
+  it('should error if no api key provided', () =>
+    swagger(['./test/fixtures/swagger.json'], {}).catch(err => {
       assert.equal(err.message, 'No api key provided. Please use --key');
-      return done();
-    });
-  });
+    })
+  );
 
-  it('should error if no file provided', done => {
-    swagger([], { key }, err => {
+  it('should error if no file provided', () =>
+    swagger([], { key }).catch(err => {
       assert.equal(err.message, 'No swagger file provided. Usage `rdme swagger <swagger-file>`');
-      return done();
-    });
-  });
+    })
+  );
 
-  it('should POST to the swagger api if no id provided', done => {
+  it('should POST to the swagger api if no id provided', () => {
     const mock = nock(config.host)
       .post('/api/v1/swagger', body => body.match('form-data; name="swagger"'))
       .basicAuth({ user: key })
       .reply(201);
 
-    swagger(['./test/fixtures/swagger.json'], { key }, err => {
-      if (err) return done(err);
-      mock.done();
-
-      return done();
-    });
+    return swagger(['./test/fixtures/swagger.json'], { key })
+      .then(() => mock.done());
   });
 
-  it('should PUT to the swagger api if id is provided', done => {
+  it('should PUT to the swagger api if id is provided', () => {
     const id = '5aa0409b7cf527a93bfb44df';
     const mock = nock(config.host)
       .put(`/api/v1/swagger/${id}`, body => body.match('form-data; name="swagger"'))
       .basicAuth({ user: key })
       .reply(201);
 
-    swagger(['./test/fixtures/swagger.json'], { key, id }, err => {
-      if (err) return done(err);
-      mock.done();
-
-      return done();
-    });
+    return swagger(['./test/fixtures/swagger.json'], { key, id })
+      .then(() => mock.done());
   });
 
-  it('should still work with `token`', done => {
+  it('should still work with `token`', () => {
     const id = '5aa0409b7cf527a93bfb44df';
     const mock = nock(config.host)
       .put(`/api/v1/swagger/${id}`, body => body.match('form-data; name="swagger"'))
       .basicAuth({ user: key })
       .reply(201);
 
-    swagger(['./test/fixtures/swagger.json'], { token: `${key}-${id}` }, err => {
-      if (err) return done(err);
-      mock.done();
-
-      return done();
-    });
+    return swagger(['./test/fixtures/swagger.json'], { token: `${key}-${id}` })
+      .then(() => mock.done());
   });
 });