@heroku/skynet 1.5.0 → 1.6.2

package/README.md

@@ -13,64 +13,37 @@ heroku plugins:install heroku-skynet-cli
 - Change directories into the cloned repository 
 - Link the plugin with `heroku plugins:link .`
 
-### Publishing to `npm`
-1. Contact `heroku-cli@salesforce.com` to get credentials to Heroku's private NPM registry
-
-2. Make sure you have `np` installed. Install by running `npm install np`
-
-3. When you are ready to publish what you have locally, run `np` and you will see an output like this:
-```
-  λ bargenbright[heroku-skynet-cli/] (git:master)~$ np
+### Manual testing
 
-Publish a new version of heroku-skynet-cli (current: 1.3.5)
+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.
+1. Make sure you have the latest ion-client installed:
 
-? Select semver increment or specify new version minor  1.4.0
+    ```
+    gem install ion-client
+    ```
 
-Commits:
-- Merge pull request #28 from heroku/refactor+appowner  f2c5655
-- add app-owner command  b07940b
-- adds app-owner command and refactors  e914b09
+    If you get permissions errors against packagecloud, visit https://gemgate-heroku-internal-gems.herokuapp.com/setup-instructions
 
-? Will bump from 1.3.5 to 1.4.0. Continue? Yes
- ✔ Prerequisite check
- ✔ Git
- ✔ Cleanup
- ✔ Installing dependencies using Yarn
- ✔ Running tests
- ✔ Bumping version using Yarn
- ✖ Publishing package using Yarn
-   → info Visit https://yarnpkg.com/en/docs/cli/publish for documentation about this command.
-   Pushing tags
 
-✖ Error: Command failed: yarn publish --new-version 1.4.0
-warning package.json: No license field
-warning package.json: No license field
-error An unexpected error occurred: "No token found and can't prompt for login when running with --non-interactive.".
-```
+In skynet-cli directory, use the following:
 
-4. After you get the `np` error, run `npm publish` to finish pushing the new release.
 ```
-λ bargenbright[heroku-skynet-cli/] (git:master)~$ npm publish
-+ heroku-skynet-cli@1.4.0
+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>
 ```
 
-5. Then, push the tags to the git repository
-```
-λ bargenbright[heroku-skynet-cli/] (git:master)~$ git push origin --tags
-Counting objects: 4, done.
-Delta compression using up to 8 threads.
-Compressing objects: 100% (4/4), done.
-Writing objects: 100% (4/4), 416 bytes | 416.00 KiB/s, done.
-Total 4 (delta 2), reused 0 (delta 0)
-remote: Resolving deltas: 100% (2/2), completed with 2 local objects.
-To github.com:heroku/heroku-skynet-cli.git
- * [new tag]         v1.4.0 -> v1.4.0
-```
+### 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/)
 
-6. Finally, push the version change commit done by the `np` tool
-```
-λ bargenbright[heroku-skynet-cli/] (git:master)~$ git push origin master
-Total 0 (delta 0), reused 0 (delta 0)
-To github.com:heroku/heroku-skynet-cli.git
-   f2c5655..e8ad793  master -> master
-```
+1. Publish the package:
+
+  1. cd into the root of the plugin
+  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
+  1. Merge the pr once approved

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,14 +1,21 @@
 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(context.flags.app, context.flags.notes)
+  let response = await skynet.suspendApp(
+    context.flags.app,
+    context.flags.notes,
+    context.flags.category,
+    context.flags.bypass
+  )
   response = JSON.parse(response)
-  cli.log(`suspending...${cli.color.cyan(response.status)}.\n${response.message}`)
+  cli.log(
+    `suspending...${cli.color.cyan(response.status)}.\n${response.message}`
+  )
 }
 
 module.exports = {
@@ -16,10 +23,35 @@ module.exports = {
   command: 'suspend:app',
   description: '(requires sudo) suspends an app',
   help: `Examples:
-    $ heroku skynet:suspend:app -a test-app -n "helpful suspend message"`,
+    $ heroku skynet:suspend:app -a test-app -c "category" -n "helpful suspend message"`,
   flags: [
-    { name: 'app', char: 'a', description: 'app to suspend', hasValue: true, required: true },
-    { name: 'notes', char: 'n', description: 'suspend notes', hasValue: true, required: true }
+    {
+      name: 'app',
+      char: 'a',
+      description: 'app to suspend',
+      hasValue: true,
+      required: true
+    },
+    {
+      name: 'notes',
+      char: 'n',
+      description: 'suspend notes',
+      hasValue: true,
+      required: true
+    },
+    {
+      name: 'category',
+      char: 'c',
+      description: 'suspension category',
+      hasValue: true,
+      required: true
+    },
+    {
+      name: 'bypass',
+      description: 'force suspension',
+      hasValue: false,
+      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/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

@@ -1,6 +1,12 @@
 const cli = require('heroku-cli-util')
 const qs = require('querystring')
-const SKYNET_BASE_URL = 'https://skynet.herokai.com/api-h'
+let skynetHost = 'https://skynet.herokai.com'
+
+if (process.env.SKYNET_HOST) {
+  skynetHost = process.env.SKYNET_HOST
+}
+
+const SKYNET_BASE_URL = `${skynetHost}/api-h`
 
 module.exports = class SkynetAPI {
   constructor (token) {
@@ -87,12 +93,13 @@ module.exports = class SkynetAPI {
     })
   }
 
-  suspendApp (app, notes, category) {
+  suspendApp (app, notes, category, force = false) {
     var body = {
       value: app,
       reason: notes,
-      method: 'skynet-cli',
-      category: category
+      category: category,
+      force: force,
+      method: 'skynet-cli'
     }
 
     return this.request('/suspend/app', {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heroku/skynet",
-  "version": "1.5.0",
+  "version": "1.6.2",
   "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"
   }
 }