@heroku/skynet 1.4.3 → 1.6.1

package/README.md

@@ -14,63 +14,15 @@ heroku plugins:install heroku-skynet-cli
 - 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
+1. Send an email to `heroku-help@salesforce.com` requesting access to @heroku on npm. Include your npm username (https://www.npmjs.com/)
 
-2. Make sure you have `np` installed. Install by running `npm install np`
+1. 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
-
-Publish a new version of heroku-skynet-cli (current: 1.3.5)
-
-? Select semver increment or specify new version minor  1.4.0
-
-Commits:
-- Merge pull request #28 from heroku/refactor+appowner  f2c5655
-- add app-owner command  b07940b
-- adds app-owner command and refactors  e914b09
+1. Publish the package:
 
-? 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.".
-```
-
-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
-```
-
-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
-```
-
-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. cd into the root of the plugin
+  1. Run `np`
+      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

@@ -10,8 +10,8 @@ function * run (context) {
   response = JSON.parse(response)
   cli.table(response, {
     columns: [
-      {key: 'Category'},
-      {key: 'Description'}
+      { key: 'Category' },
+      { key: 'Description' }
     ]
   })
 }

package/commands/deprovision.js

@@ -11,18 +11,18 @@ function readlines (file) {
     let users = []
 
     fs.createReadStream(file).pipe(split())
-    .on('data', function (line) {
-      line = line.trim()
-      if (line) {
-        users.push(line)
-      }
-    })
-    .on('end', function () {
-      resolve(users)
-    })
-    .on('error', function (err) {
-      reject(err)
-    })
+      .on('data', function (line) {
+        line = line.trim()
+        if (line) {
+          users.push(line)
+        }
+      })
+      .on('end', function () {
+        resolve(users)
+      })
+      .on('error', function (err) {
+        reject(err)
+      })
   })
 }
 
@@ -60,11 +60,11 @@ module.exports = {
   help: `Examples:
     $ heroku skynet:deprovision -u foo@bar.com -n "helpful suspend message" -c "spam"`,
   flags: [
-    {name: 'user', char: 'u', description: 'user to deprovision', hasValue: true},
-    {name: 'infile', char: 'i', description: 'file list of users to deprovision', hasValue: true},
-    {name: 'category', char: 'c', description: 'suspension category', hasValue: true, required: true},
-    {name: 'notes', char: 'n', description: 'suspend notes', hasValue: true, required: true},
-    {name: 'bypass', description: 'bypass the whitelist', hasValue: false, required: false}
+    { name: 'user', char: 'u', description: 'user to deprovision', hasValue: true },
+    { name: 'infile', char: 'i', description: 'file list of users to deprovision', hasValue: true },
+    { name: 'category', char: 'c', description: 'suspension category', hasValue: true, required: true },
+    { 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))
 }

package/commands/suspend/app-owner.js

@@ -11,18 +11,18 @@ function readlines (file) {
     let users = []
 
     fs.createReadStream(file).pipe(split())
-    .on('data', function (line) {
-      line = line.trim()
-      if (line) {
-        users.push(line)
-      }
-    })
-    .on('end', function () {
-      resolve(users)
-    })
-    .on('error', function (err) {
-      reject(err)
-    })
+      .on('data', function (line) {
+        line = line.trim()
+        if (line) {
+          users.push(line)
+        }
+      })
+      .on('end', function () {
+        resolve(users)
+      })
+      .on('error', function (err) {
+        reject(err)
+      })
   })
 }
 
@@ -60,11 +60,11 @@ module.exports = {
   help: `Examples:
     $ heroku skynet:suspend:app-owner -a foobar -n "helpful suspend message" -c "ddos"`,
   flags: [
-    {name: 'app', char: 'a', description: 'app that requires owner suspension', hasValue: true},
-    {name: 'infile', char: 'i', description: 'file of apps that require owner suspension', hasValue: true},
-    {name: 'category', char: 'c', description: 'suspension category', hasValue: true, required: true},
-    {name: 'notes', char: 'n', description: 'suspend notes', hasValue: true, required: true},
-    {name: 'bypass', description: 'bypass the whitelist', hasValue: false, required: false}
+    { name: 'app', char: 'a', description: 'app that requires owner suspension', hasValue: true },
+    { name: 'infile', char: 'i', description: 'file of apps that require owner suspension', hasValue: true },
+    { name: 'category', char: 'c', description: 'suspension category', hasValue: true, required: true },
+    { 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))
 }

package/commands/suspend/apps.js

@@ -6,9 +6,16 @@ let SkynetAPI = require('../../lib/skynet')
 function * run (context) {
   sudo()
   const skynet = new SkynetAPI(context.auth.password)
-  let response = yield skynet.suspendApp(context.flags.app, context.flags.notes)
+  let response = yield 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))
 }

package/commands/suspend/user.js

@@ -11,18 +11,18 @@ function readlines (file) {
     let users = []
 
     fs.createReadStream(file).pipe(split())
-    .on('data', function (line) {
-      line = line.trim()
-      if (line) {
-        users.push(line)
-      }
-    })
-    .on('end', function () {
-      resolve(users)
-    })
-    .on('error', function (err) {
-      reject(err)
-    })
+      .on('data', function (line) {
+        line = line.trim()
+        if (line) {
+          users.push(line)
+        }
+      })
+      .on('end', function () {
+        resolve(users)
+      })
+      .on('error', function (err) {
+        reject(err)
+      })
   })
 }
 
@@ -61,12 +61,12 @@ module.exports = {
   help: `Examples:
     $ heroku sudo skynet:suspend:user -u foo@bar.com -n "helpful suspend message" -c "ddos"`,
   flags: [
-    {name: 'user', char: 'u', description: 'user to suspend', hasValue: true},
-    {name: 'infile', char: 'i', description: 'file of users to suspend', hasValue: true},
-    {name: 'category', char: 'c', description: 'suspension category', hasValue: true, required: true},
-    {name: 'notes', char: 'n', description: 'suspend notes', hasValue: true, required: true},
-    {name: 'bypass', description: 'bypass the whitelist', hasValue: false, required: false},
-    {name: 'no-notify', description: 'skip user suspension email notification', hasValue: false, required: false}
+    { name: 'user', char: 'u', description: 'user to suspend', hasValue: true },
+    { name: 'infile', char: 'i', description: 'file of users to suspend', hasValue: true },
+    { name: 'category', char: 'c', description: 'suspension category', hasValue: true, required: true },
+    { name: 'notes', char: 'n', description: 'suspend notes', hasValue: true, required: true },
+    { 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))
 }

package/commands/unsuspend/apps.js

@@ -18,7 +18,7 @@ module.exports = {
   help: `Examples:
     $ heroku skynet:unsuspend:app -a test-app`,
   flags: [
-    {name: 'app', char: 'a', description: 'app to unsuspend', hasValue: true, required: true}
+    { name: 'app', char: 'a', description: 'app to unsuspend', hasValue: true, required: true }
   ],
   run: cli.command(co.wrap(run))
 }

package/commands/unsuspend/user.js

@@ -20,7 +20,7 @@ module.exports = {
   help: `Examples:
     $ heroku skynet:unsuspend:user -u foo@bar.com`,
   flags: [
-    {name: 'user', char: 'u', description: 'user to unsuspend', hasValue: true}
+    { name: 'user', char: 'u', description: 'user to unsuspend', hasValue: true }
   ],
   run: cli.command(co.wrap(run))
 }

package/commands/userpass/add.js

@@ -14,8 +14,8 @@ module.exports = {
   help: `Examples:
     $ heroku skynet:userpass:add -u foo@bar.com -f cant-install-abused-addons`,
   flags: [
-    {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}
+    { 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))
 }

package/commands/userpass/remove.js

@@ -14,8 +14,8 @@ module.exports = {
   help: `Examples:
     $ heroku skynet:userpass:remove -u foo@bar.com -f cant-install-abused-addons`,
   flags: [
-    {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}
+    { 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))
 }

package/commands/whitelist/add.js

@@ -0,0 +1,38 @@
+let cli = require('heroku-cli-util')
+let co = require('co')
+let SkynetAPI = require('../../lib/skynet')
+
+function * run (context) {
+  const skynet = new SkynetAPI(context.auth.password)
+  yield cli.action(
+    `adding ${cli.color.cyan(
+      context.flags.value
+    )} to whitelist with ${cli.color.cyan(context.flags.notes)}`,
+    skynet.addWhitelist(context.flags.value, context.flags.notes)
+  )
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'whitelist:add',
+  description: 'adds an app or user to the whitelist',
+  help: `Examples:
+    $ heroku skynet:whitelist:add -v foo@bar.com -n Additional info`,
+  flags: [
+    {
+      name: 'value',
+      char: 'v',
+      description: 'app name or user email to whitelist',
+      hasValue: true,
+      required: true
+    },
+    {
+      name: 'notes',
+      char: 'n',
+      description: 'additional information for the whitelist entry',
+      hasValue: true,
+      required: false
+    }
+  ],
+  run: cli.command(co.wrap(run))
+}

package/commands/whitelist/remove.js

@@ -0,0 +1,29 @@
+let cli = require('heroku-cli-util')
+let co = require('co')
+let SkynetAPI = require('../../lib/skynet')
+
+function * run (context) {
+  const skynet = new SkynetAPI(context.auth.password)
+  yield cli.action(
+    `removing ${cli.color.cyan(context.flags.value)} from whitelist`,
+    skynet.removeWhitelist(context.flags.value)
+  )
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'whitelist:remove',
+  description: 'Remove user or app from the whitelist',
+  help: `Examples:
+    $ heroku skynet:whitelist:remove -v foo@bar.com`,
+  flags: [
+    {
+      name: 'value',
+      char: 'v',
+      description: 'app name or user email to remove from whitelist',
+      hasValue: true,
+      required: true
+    }
+  ],
+  run: cli.command(co.wrap(run))
+}

package/index.js

@@ -13,5 +13,7 @@ exports.commands = [
   require('./commands/unsuspend/apps.js'),
   require('./commands/unsuspend/user.js'),
   require('./commands/deprovision.js'),
-  require('./commands/categories.js')
+  require('./commands/categories.js'),
+  require('./commands/whitelist/add.js'),
+  require('./commands/whitelist/remove.js')
 ]

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) {
@@ -21,7 +27,7 @@ module.exports = class SkynetAPI {
 
     options.json = false
 
-    return cli.got(SKYNET_BASE_URL + url, options).then((res) => res.body)
+    return cli.got(SKYNET_BASE_URL + url, options).then(res => res.body)
   }
 
   categories () {
@@ -30,6 +36,24 @@ module.exports = class SkynetAPI {
     })
   }
 
+  addWhitelist (appOrUserEmail, notes) {
+    var body = {
+      value: appOrUserEmail,
+      notes: notes
+    }
+
+    return this.request(`/whitelist`, {
+      method: 'POST',
+      body: qs.stringify(body)
+    })
+  }
+
+  removeWhitelist (appOrUserEmail) {
+    return this.request(`/whitelist/${appOrUserEmail}`, {
+      method: 'DELETE'
+    })
+  }
+
   removeUserpass (user, flag) {
     var body = {
       user: user,
@@ -69,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.4.3",
+  "version": "1.6.1",
   "description": "use Skynet from Heroku CLI",
   "main": "index.js",
   "author": "Bob Argenbright @byt3smith",
@@ -25,7 +25,7 @@
     "mocha": "^3.4.2",
     "mockdate": "^2.0.1",
     "nock": "^9.0.13",
-    "standard": "^10.0.2",
+    "standard": "^12.0.1",
     "unexpected": "^10.29.0"
   },
   "scripts": {