Add better error checking to swagger command

Make it so that you can either provide:

--token={key}-{id}

OR

--key={key} --id={id}

With a deprecation notice for the former

Author: Dom Harrington

README.md

@@ -16,12 +16,12 @@ npm install rdme
 ### Uploading a new Swagger file to ReadMe
 
 ```sh
-rdme swagger {path-to-swagger.json} --token={api-key}
+rdme swagger {path-to-swagger.json} --key={api-key}
 ```
 
 ### Editing an existing Swagger file
 ```sh
-rdme swagger {path-to-swagger.json} --token={api-key}-{existing-id}
+rdme swagger {path-to-swagger.json} --key={api-key} --id={existing-id}
 ```
 
 ## Future

lib/swagger.js

@@ -16,7 +16,20 @@ function defaultCallback(err) {
 }
 
 exports.run = function({ args, opts }, cb = defaultCallback) {
-  const [apiKey, id] = opts.token.split('-');
+  let {key, id} = opts;
+
+  if (!key && opts.token) {
+    console.warn('Using `rdme` with --token has been deprecated. Please use --key and --id instead');
+    [key, id] = opts.token.split('-')
+  }
+
+  if (!key) {
+    return cb(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>`'));
+  }
 
   function callback(err, response, data) {
     if (err) return cb(err);
@@ -36,12 +49,12 @@ exports.run = function({ args, opts }, cb = defaultCallback) {
     formData: {
       swagger: fs.createReadStream(path.resolve(process.cwd(), args[0])),
     },
-    auth: { user: apiKey },
+    auth: { user: key },
   };
 
   if (!id) {
-    request.post(`${config.host}/api/v1/swagger`, options, callback);
+    return request.post(`${config.host}/api/v1/swagger`, options, callback);
   } else {
-    request.put(`${config.host}/api/v1/swagger/${id}`, options, callback);
+    return request.put(`${config.host}/api/v1/swagger/${id}`, options, callback);
   }
 };

test/swagger.test.js

@@ -1,21 +1,42 @@
 const nock = require('nock');
 const config = require('config');
+const assert = require('assert');
 
 const swagger = require('../lib/swagger');
 
-const apiKey = 'Xmw4bGctRVIQz7R7dQXqH9nQe5d0SPQs';
+const key = 'Xmw4bGctRVIQz7R7dQXqH9nQe5d0SPQs';
 
 describe('swagger command', () => {
   afterAll(() => nock.cleanAll());
 
+  it('should error if no api key provided', (done) => {
+    swagger.run({
+      args: ['./test/fixtures/swagger.json'],
+      opts: {},
+    }, (err) => {
+      assert.equal(err.message, 'No api key provided. Please use --key');
+      return done();
+    });
+  });
+
+  it('should error if no file provided', (done) => {
+    swagger.run({
+      args: [],
+      opts: { key },
+    }, (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 => {
     const mock = nock(config.host)
       .post('/api/v1/swagger', body => body.match('form-data; name="swagger"'))
-      .basicAuth({ user: apiKey })
+      .basicAuth({ user: key })
       .reply(201);
 
     swagger.run(
-      { args: ['./test/fixtures/swagger.json'], opts: { token: apiKey } },
+      { args: ['./test/fixtures/swagger.json'], opts: { key } },
       err => {
         if (err) return done(err);
         mock.done();
@@ -29,13 +50,34 @@ describe('swagger command', () => {
     const id = '5aa0409b7cf527a93bfb44df';
     const mock = nock(config.host)
       .put(`/api/v1/swagger/${id}`, body => body.match('form-data; name="swagger"'))
-      .basicAuth({ user: apiKey })
+      .basicAuth({ user: key })
+      .reply(201);
+
+    swagger.run(
+      {
+        args: ['./test/fixtures/swagger.json'],
+        opts: { key, id },
+      },
+      err => {
+        if (err) return done(err);
+        mock.done();
+
+        return done();
+      },
+    );
+  });
+
+  it('should still work with `token`', done => {
+    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.run(
       {
         args: ['./test/fixtures/swagger.json'],
-        opts: { token: `${apiKey}-${id}` },
+        opts: { token: `${key}-${id}` },
       },
       err => {
         if (err) return done(err);