@heroku/skynet 1.6.1 → 1.6.3

package/README.md

@@ -13,15 +13,36 @@ heroku plugins:install heroku-skynet-cli
 - Change directories into the cloned repository 
 - Link the plugin with `heroku plugins:link .`
 
+### Manual testing
+
+1. Make sure your staging account is setup: https://github.com/heroku/engineering-docs/blob/master/guides/staging-account-setup.md
+1. Get someone to add you to the `heroku-security` team/org in [staging](https://dashboard-api-staging.herokuapp.com/teams/heroku-security/access)
+1. Make sure you have the latest ion-client installed:
+
+    ```
+    gem install ion-client
+    ```
+
+    If you get permissions errors against packagecloud, visit https://gemgate-heroku-internal-gems.herokuapp.com/setup-instructions
+
+
+In skynet-cli directory, use the following:
+
+```
+heroku plugins:link .
+export SKYNET_HOST=https://heroku-skynet-staging.herokuapp.com
+cloud staging
+heroku login # login to the staging cloud via the cli
+heroku skynet:<cmd>
+```
+
 ### Publishing to `npm`
 1. Send an email to `heroku-help@salesforce.com` requesting access to @heroku on npm. Include your npm username (https://www.npmjs.com/)
 
-1. Install by running `npm install np`
-
 1. Publish the package:
 
   1. cd into the root of the plugin
-  1. Run `np`
+  1. Run `npm run release`
       Note: You will get an error because np attempts to commit to master the
             updated version in the package.json
       Open a pr manually on a separate branch to resolve

package/commands/categories/add.js

@@ -0,0 +1,21 @@
+let cli = require('heroku-cli-util')
+let command = require('../../lib/command')
+let SkynetAPI = require('../../lib/skynet')
+
+async function run (context) {
+  const skynet = new SkynetAPI(context.auth.password)
+  await cli.action(`adding new category: ${cli.color.cyan(context.flags.category)}`, skynet.addCategory(context.flags.category, context.flags.description))
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'categories:add',
+  description: 'adds a value to suspension categories',
+  help: `Examples:
+    $ heroku sudo skynet:categories:add -c new-category -d "this is a new category"`,
+  flags: [
+    { name: 'category', char: 'c', description: 'new category value', hasValue: true, required: true },
+    { name: 'description', char: 'd', description: 'new category description', hasValue: true, required: true }
+  ],
+  run: command(run)
+}

package/commands/categories/remove.js

@@ -0,0 +1,20 @@
+let cli = require('heroku-cli-util')
+let command = require('../../lib/command')
+let SkynetAPI = require('../../lib/skynet')
+
+async function run (context) {
+  const skynet = new SkynetAPI(context.auth.password)
+  await cli.action(`removing ${cli.color.cyan(context.flags.category)} from suspension categories`, skynet.removeCategory(context.flags.category))
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'categories:remove',
+  description: 'removes a value from suspension categories',
+  help: `Examples:
+    $ heroku sudo skynet:categories:remove -c test-category`,
+  flags: [
+    { name: 'category', char: 'c', description: 'category to remove', hasValue: true, required: true }
+  ],
+  run: command(run)
+}

package/commands/categories.js

@@ -1,12 +1,12 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../lib/command')
 let sudo = require('../lib/sudo')
 let SkynetAPI = require('../lib/skynet')
 
-function * run (context) {
+async function run (context) {
   sudo()
   const skynet = new SkynetAPI(context.auth.password)
-  let response = yield skynet.categories()
+  let response = await skynet.categories()
   response = JSON.parse(response)
   cli.table(response, {
     columns: [
@@ -23,5 +23,5 @@ module.exports = {
   help: `Examples:
     $ heroku skynet:categories`,
   flags: [],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/commands/deprovision.js

@@ -1,5 +1,5 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../lib/command')
 let sudo = require('../lib/sudo')
 let SkynetAPI = require('../lib/skynet')
 
@@ -26,7 +26,7 @@ function readlines (file) {
   })
 }
 
-function * run (context) {
+async function run (context) {
   sudo()
   const skynet = new SkynetAPI(context.auth.password)
   let user = context.flags.user || process.env.HEROKU_USER
@@ -40,14 +40,14 @@ function * run (context) {
   }
 
   if (file) {
-    let users = yield readlines(file)
-    yield cli.action(`bulk deprovisioning for ${cli.color.cyan(users.length)} users`, skynet.bulkDeprovision(users.join(), notes, category))
+    let users = await readlines(file)
+    await cli.action(`bulk deprovisioning for ${cli.color.cyan(users.length)} users`, skynet.bulkDeprovision(users.join(), notes, category))
   } else {
     if (!user) {
       throw new Error('Required flag: --user USER or --infile FILE')
     }
 
-    let response = yield cli.action(`deprovisioning ${cli.color.cyan(user)}`, skynet.deprovision(user, notes, category, force))
+    let response = await cli.action(`deprovisioning ${cli.color.cyan(user)}`, skynet.deprovision(user, notes, category, force))
     response = JSON.parse(response)
     cli.log(`${response.status}. ${response.message}`)
   }
@@ -66,5 +66,5 @@ module.exports = {
     { name: 'notes', char: 'n', description: 'suspend notes', hasValue: true, required: true },
     { name: 'bypass', description: 'bypass the whitelist', hasValue: false, required: false }
   ],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/commands/suspend/app-owner.js

@@ -1,5 +1,5 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../../lib/command')
 let sudo = require('../../lib/sudo')
 let SkynetAPI = require('../../lib/skynet')
 
@@ -26,7 +26,7 @@ function readlines (file) {
   })
 }
 
-function * run (context) {
+async function run (context) {
   sudo()
   const skynet = new SkynetAPI(context.auth.password)
   let app = context.flags.app
@@ -40,14 +40,14 @@ function * run (context) {
   }
 
   if (file) {
-    let apps = yield readlines(file)
-    yield cli.action(`bulk app-owner suspension for ${cli.color.cyan(apps.length)} apps.`, skynet.bulkSuspendAppOwner(apps.join(), notes, category))
+    let apps = await readlines(file)
+    await cli.action(`bulk app-owner suspension for ${cli.color.cyan(apps.length)} apps.`, skynet.bulkSuspendAppOwner(apps.join(), notes, category))
   } else {
     if (!app) {
       throw new Error('Required flag: --owner OWNER or --infile FILE')
     }
 
-    let response = yield cli.action(`suspending the owner of ${cli.color.cyan(app)}`, skynet.suspendAppOwner(app, notes, category, force))
+    let response = await cli.action(`suspending the owner of ${cli.color.cyan(app)}`, skynet.suspendAppOwner(app, notes, category, force))
     response = JSON.parse(response)
     cli.log(`${response.status}. ${response.message}`)
   }
@@ -66,5 +66,5 @@ module.exports = {
     { name: 'notes', char: 'n', description: 'suspend notes', hasValue: true, required: true },
     { name: 'bypass', description: 'bypass the whitelist', hasValue: false, required: false }
   ],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/commands/suspend/apps.js

@@ -1,12 +1,12 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../../lib/command')
 let sudo = require('../../lib/sudo')
 let SkynetAPI = require('../../lib/skynet')
 
-function * run (context) {
+async function run (context) {
   sudo()
   const skynet = new SkynetAPI(context.auth.password)
-  let response = yield skynet.suspendApp(
+  let response = await skynet.suspendApp(
     context.flags.app,
     context.flags.notes,
     context.flags.category,
@@ -53,5 +53,5 @@ module.exports = {
       required: false
     }
   ],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/commands/suspend/user.js

@@ -1,5 +1,5 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../../lib/command')
 let sudo = require('../../lib/sudo')
 let SkynetAPI = require('../../lib/skynet')
 
@@ -26,7 +26,7 @@ function readlines (file) {
   })
 }
 
-function * run (context) {
+async function run (context) {
   sudo()
   const skynet = new SkynetAPI(context.auth.password)
   let user = context.flags.user || process.env.HEROKU_USER
@@ -41,14 +41,14 @@ function * run (context) {
   }
 
   if (file) {
-    let users = yield readlines(file)
-    yield cli.action(`bulk user suspension for ${cli.color.cyan(users.length)} users.`, skynet.bulkSuspendUsers(users.join(), notes, category))
+    let users = await readlines(file)
+    await cli.action(`bulk user suspension for ${cli.color.cyan(users.length)} users.`, skynet.bulkSuspendUsers(users.join(), notes, category))
   } else {
     if (!user) {
       throw new Error('Required flag: --user USER or --infile FILE')
     }
 
-    let response = yield cli.action(`suspending ${cli.color.cyan(user)}`, skynet.suspendUser(user, notes, category, notify, force))
+    let response = await cli.action(`suspending ${cli.color.cyan(user)}`, skynet.suspendUser(user, notes, category, notify, force))
     response = JSON.parse(response)
     cli.log(`${response.status}. ${response.message}`)
   }
@@ -68,5 +68,5 @@ module.exports = {
     { name: 'bypass', description: 'bypass the whitelist', hasValue: false, required: false },
     { name: 'no-notify', description: 'skip user suspension email notification', hasValue: false, required: false }
   ],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/commands/unsuspend/apps.js

@@ -1,12 +1,12 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../../lib/command')
 let sudo = require('../../lib/sudo')
 let SkynetAPI = require('../../lib/skynet')
 
-function * run (context) {
+async function run (context) {
   sudo()
   const skynet = new SkynetAPI(context.auth.password)
-  let response = yield skynet.unsuspendApp(context.flags.app, context.flags.notes)
+  let response = await skynet.unsuspendApp(context.flags.app, context.flags.notes)
   response = JSON.parse(response)
   cli.log(`suspending...${cli.color.cyan(response.status)}.\n${response.message}`)
 }
@@ -20,5 +20,5 @@ module.exports = {
   flags: [
     { name: 'app', char: 'a', description: 'app to unsuspend', hasValue: true, required: true }
   ],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/commands/unsuspend/user.js

@@ -1,14 +1,14 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../../lib/command')
 let sudo = require('../../lib/sudo')
 let SkynetAPI = require('../../lib/skynet')
 
-function * run (context) {
+async function run (context) {
   sudo()
   const skynet = new SkynetAPI(context.auth.password)
   let user = context.flags.user || process.env.HEROKU_USER
 
-  let response = yield cli.action(`unsuspending ${cli.color.cyan(user)}`, skynet.unsuspendUser(user))
+  let response = await cli.action(`unsuspending ${cli.color.cyan(user)}`, skynet.unsuspendUser(user))
   response = JSON.parse(response)
   cli.log(`${response.status}. ${response.message}`)
 }
@@ -22,5 +22,5 @@ module.exports = {
   flags: [
     { name: 'user', char: 'u', description: 'user to unsuspend', hasValue: true }
   ],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/commands/userpass/add.js

@@ -1,10 +1,10 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../../lib/command')
 let SkynetAPI = require('../../lib/skynet')
 
-function * run (context) {
+async function run (context) {
   const skynet = new SkynetAPI(context.auth.password)
-  yield cli.action(`adding ${cli.color.cyan(context.flags.userpass)} to ${cli.color.cyan(context.flags.user)}`, skynet.addUserpass(context.flags.user, context.flags.flag))
+  await cli.action(`adding ${cli.color.cyan(context.flags.userpass)} to ${cli.color.cyan(context.flags.user)}`, skynet.addUserpass(context.flags.user, context.flags.flag))
 }
 
 module.exports = {
@@ -17,5 +17,5 @@ module.exports = {
     { name: 'user', char: 'u', description: 'user to apply userpass flag to', hasValue: true, required: true },
     { name: 'flag', char: 'f', description: 'flag to add to the given user', hasValue: true, required: true }
   ],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/commands/userpass/remove.js

@@ -1,10 +1,10 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../../lib/command')
 let SkynetAPI = require('../../lib/skynet')
 
-function * run (context) {
+async function run (context) {
   const skynet = new SkynetAPI(context.auth.password)
-  yield cli.action(`removing ${cli.color.cyan(context.flags.userpass)} from ${cli.color.cyan(context.flags.user)}`, skynet.removeUserpass(context.flags.user, context.flags.flag))
+  await cli.action(`removing ${cli.color.cyan(context.flags.userpass)} from ${cli.color.cyan(context.flags.user)}`, skynet.removeUserpass(context.flags.user, context.flags.flag))
 }
 
 module.exports = {
@@ -17,5 +17,5 @@ module.exports = {
     { name: 'user', char: 'u', description: 'user to remove user_pass from', hasValue: true, required: true },
     { name: 'flag', char: 'f', description: 'flag to remove from given user', hasValue: true, required: true }
   ],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/commands/whitelist/add.js

@@ -1,10 +1,10 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../../lib/command')
 let SkynetAPI = require('../../lib/skynet')
 
-function * run (context) {
+async function run (context) {
   const skynet = new SkynetAPI(context.auth.password)
-  yield cli.action(
+  await cli.action(
     `adding ${cli.color.cyan(
       context.flags.value
     )} to whitelist with ${cli.color.cyan(context.flags.notes)}`,
@@ -34,5 +34,5 @@ module.exports = {
       required: false
     }
   ],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/commands/whitelist/remove.js

@@ -1,10 +1,10 @@
 let cli = require('heroku-cli-util')
-let co = require('co')
+let command = require('../../lib/command')
 let SkynetAPI = require('../../lib/skynet')
 
-function * run (context) {
+async function run (context) {
   const skynet = new SkynetAPI(context.auth.password)
-  yield cli.action(
+  await cli.action(
     `removing ${cli.color.cyan(context.flags.value)} from whitelist`,
     skynet.removeWhitelist(context.flags.value)
   )
@@ -25,5 +25,5 @@ module.exports = {
       required: true
     }
   ],
-  run: cli.command(co.wrap(run))
+  run: command(run)
 }

package/index.js

@@ -14,6 +14,8 @@ exports.commands = [
   require('./commands/unsuspend/user.js'),
   require('./commands/deprovision.js'),
   require('./commands/categories.js'),
+  require('./commands/categories/add.js'),
+  require('./commands/categories/remove.js'),
   require('./commands/whitelist/add.js'),
   require('./commands/whitelist/remove.js')
 ]

package/lib/command.js

@@ -0,0 +1,13 @@
+let cli = require('heroku-cli-util')
+
+module.exports = fn =>
+  cli.command((context, client) =>
+    fn(context, client).catch(err => {
+      if (err.body) {
+        console.log(JSON.stringify(err.body))
+      } else {
+        console.log(err)
+      }
+      throw err
+    })
+  )

package/lib/skynet.js

@@ -21,12 +21,10 @@ module.exports = class SkynetAPI {
       'User-Agent': this.version
     })
 
-    if (['POST', 'PATCH', 'DELETE'].includes(options.method)) {
-      options.headers['Content-type'] = 'application/x-www-form-urlencoded'
+    if (options.form) {
+      options.headers['Content-Type'] = 'application/x-www-form-urlencoded'
     }
 
-    options.json = false
-
     return cli.got(SKYNET_BASE_URL + url, options).then(res => res.body)
   }
 
@@ -44,7 +42,8 @@ module.exports = class SkynetAPI {
 
     return this.request(`/whitelist`, {
       method: 'POST',
-      body: qs.stringify(body)
+      body: qs.stringify(body),
+      form: true
     })
   }
 
@@ -62,7 +61,8 @@ module.exports = class SkynetAPI {
 
     return this.request(`/userpass/remove`, {
       method: 'POST',
-      body: qs.stringify(body)
+      body: qs.stringify(body),
+      form: true
     })
   }
 
@@ -74,7 +74,8 @@ module.exports = class SkynetAPI {
 
     return this.request(`/userpass/add`, {
       method: 'POST',
-      body: qs.stringify(body)
+      body: qs.stringify(body),
+      form: true
     })
   }
 
@@ -89,7 +90,8 @@ module.exports = class SkynetAPI {
 
     return this.request('/suspend/app-owner', {
       method: 'POST',
-      body: qs.stringify(body)
+      body: qs.stringify(body),
+      form: true
     })
   }
 
@@ -104,7 +106,8 @@ module.exports = class SkynetAPI {
 
     return this.request('/suspend/app', {
       method: 'POST',
-      body: qs.stringify(body)
+      body: qs.stringify(body),
+      form: true
     })
   }
 
@@ -126,7 +129,8 @@ module.exports = class SkynetAPI {
 
     return this.request(`/suspend/user`, {
       method: 'POST',
-      body: qs.stringify(body)
+      body: qs.stringify(body),
+      form: true
     })
   }
 
@@ -147,7 +151,8 @@ module.exports = class SkynetAPI {
 
     return this.request(`/suspend/user`, {
       method: 'POST',
-      body: qs.stringify(body)
+      body: qs.stringify(body),
+      form: true
     })
   }
 
@@ -162,7 +167,8 @@ module.exports = class SkynetAPI {
 
     return this.request(`/suspend/app-owner`, {
       method: 'POST',
-      body: qs.stringify(body)
+      body: qs.stringify(body),
+      form: true
     })
   }
 
@@ -177,7 +183,8 @@ module.exports = class SkynetAPI {
 
     return this.request(`/deprovision`, {
       method: 'POST',
-      body: qs.stringify(body)
+      body: qs.stringify(body),
+      form: true
     })
   }
 
@@ -192,7 +199,27 @@ module.exports = class SkynetAPI {
 
     return this.request(`/deprovision`, {
       method: 'POST',
-      body: qs.stringify(body)
+      body: qs.stringify(body),
+      form: true
+    })
+  }
+
+  addCategory (category, description) {
+    let body = {
+      category: category,
+      description: description
+    }
+
+    return this.request(`/categories`, {
+      method: 'POST',
+      body: JSON.stringify(body),
+      json: true
+    })
+  }
+
+  removeCategory (category) {
+    return this.request(`/categories/${category}`, {
+      method: 'DELETE'
     })
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heroku/skynet",
-  "version": "1.6.1",
+  "version": "1.6.3",
   "description": "use Skynet from Heroku CLI",
   "main": "index.js",
   "author": "Bob Argenbright @byt3smith",
@@ -17,18 +17,19 @@
     "/commands"
   ],
   "dependencies": {
-    "co": "^4.6.0",
     "heroku-cli-util": "~6.2.12",
     "split": "^1.0.0"
   },
   "devDependencies": {
     "mocha": "^3.4.2",
     "mockdate": "^2.0.1",
-    "nock": "^9.0.13",
+    "nock": "~9.0.13",
+    "np": "^3.1.0",
     "standard": "^12.0.1",
     "unexpected": "^10.29.0"
   },
   "scripts": {
-    "test": "mocha && standard"
+    "test": "mocha && standard",
+    "release": "np --no-yarn"
   }
 }