@heroku/skynet 1.4.1

package/README.md

@@ -0,0 +1,76 @@
+# Skynet CLI Plugin 
+[![Build Status](https://travis-ci.com/heroku/heroku-skynet-cli.svg?token=Tja9HVA663wD1FA6ZNZn&branch=master)](https://travis-ci.com/heroku/heroku-skynet-cli)
+
+Use Skynet from Heroku CLI
+
+### Installation
+```
+heroku plugins:install heroku-skynet-cli
+```
+
+### Development
+- `git clone https://github.com/heroku/heroku-skynet-cli.git`
+- 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
+
+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
+
+? 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
+```

package/commands/categories.js

@@ -0,0 +1,27 @@
+let cli = require('heroku-cli-util')
+let co = require('co')
+let sudo = require('../lib/sudo')
+let SkynetAPI = require('../lib/skynet')
+
+function * run (context) {
+  sudo()
+  const skynet = new SkynetAPI(context.version, context.auth.password)
+  let response = yield skynet.categories()
+  response = JSON.parse(response)
+  cli.table(response, {
+    columns: [
+      {key: 'Category'},
+      {key: 'Description'}
+    ]
+  })
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'categories',
+  description: 'categories to use for suspension and deprovisions',
+  help: `Examples:
+    $ heroku skynet:categories`,
+  flags: [],
+  run: cli.command(co.wrap(run))
+}

package/commands/deprovision.js

@@ -0,0 +1,70 @@
+let cli = require('heroku-cli-util')
+let co = require('co')
+let sudo = require('../lib/sudo')
+let SkynetAPI = require('../lib/skynet')
+
+function readlines (file) {
+  return new Promise(function (resolve, reject) {
+    let split = require('split')
+    let fs = require('fs')
+
+    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)
+    })
+  })
+}
+
+function * run (context) {
+  sudo()
+  const skynet = new SkynetAPI(context.version, context.auth.password)
+  let user = context.flags.user || process.env.HEROKU_USER
+  let file = context.flags.infile
+  let notes = context.flags.notes
+  let category = context.flags.category
+  let force = context.flags.bypass
+
+  if (user && file) {
+    throw new Error('Either --user USER or --infile must be passed, but not both')
+  }
+
+  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))
+  } 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))
+    response = JSON.parse(response)
+    cli.log(`${response.status}. ${response.message}`)
+  }
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'deprovision',
+  description: 'suspends a user and deprovisions all addons',
+  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}
+  ],
+  run: cli.command(co.wrap(run))
+}

package/commands/suspend/app-owner.js

@@ -0,0 +1,70 @@
+let cli = require('heroku-cli-util')
+let co = require('co')
+let sudo = require('../../lib/sudo')
+let SkynetAPI = require('../../lib/skynet')
+
+function readlines (file) {
+  return new Promise(function (resolve, reject) {
+    let split = require('split')
+    let fs = require('fs')
+
+    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)
+    })
+  })
+}
+
+function * run (context) {
+  sudo()
+  const skynet = new SkynetAPI(context.version, context.auth.password)
+  let app = context.flags.app
+  let file = context.flags.infile
+  let notes = context.flags.notes
+  let category = context.flags.category
+  let force = context.flags.bypass
+
+  if (app && file) {
+    throw new Error('Either --app or --infile must be passed, but not both')
+  }
+
+  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))
+  } 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))
+    response = JSON.parse(response)
+    cli.log(`${response.status}. ${response.message}`)
+  }
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'suspend:app-owner',
+  description: 'suspends the owner of a given app',
+  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}
+  ],
+  run: cli.command(co.wrap(run))
+}

package/commands/suspend/apps.js

@@ -0,0 +1,25 @@
+let cli = require('heroku-cli-util')
+let co = require('co')
+let sudo = require('../../lib/sudo')
+let SkynetAPI = require('../../lib/skynet')
+
+function * run (context) {
+  sudo()
+  const skynet = new SkynetAPI(context.version, context.auth.password)
+  let response = yield skynet.suspendApp(context.flags.app, context.flags.notes)
+  response = JSON.parse(response)
+  cli.log(`suspending...${cli.color.cyan(response.status)}.\n${response.message}`)
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'suspend:app',
+  description: 'suspends an app',
+  help: `Examples:
+    $ heroku skynet:suspend:app -a test-app -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}
+  ],
+  run: cli.command(co.wrap(run))
+}

package/commands/suspend/user.js

@@ -0,0 +1,70 @@
+let cli = require('heroku-cli-util')
+let co = require('co')
+let sudo = require('../../lib/sudo')
+let SkynetAPI = require('../../lib/skynet')
+
+function readlines (file) {
+  return new Promise(function (resolve, reject) {
+    let split = require('split')
+    let fs = require('fs')
+
+    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)
+    })
+  })
+}
+
+function * run (context) {
+  sudo()
+  const skynet = new SkynetAPI(context.version, context.auth.password)
+  let user = context.flags.user || process.env.HEROKU_USER
+  let file = context.flags.infile
+  let notes = context.flags.notes
+  let category = context.flags.category
+  let force = context.flags.bypass
+
+  if (user && file) {
+    throw new Error('Either --user USER or --infile must be passed, but not both')
+  }
+
+  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))
+  } 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, force))
+    response = JSON.parse(response)
+    cli.log(`${response.status}. ${response.message}`)
+  }
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'suspend:user',
+  description: 'suspends a user',
+  help: `Examples:
+    $ heroku 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}
+  ],
+  run: cli.command(co.wrap(run))
+}

package/commands/unsuspend/apps.js

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

package/commands/unsuspend/user.js

@@ -0,0 +1,26 @@
+let cli = require('heroku-cli-util')
+let co = require('co')
+let sudo = require('../../lib/sudo')
+let SkynetAPI = require('../../lib/skynet')
+
+function * run (context) {
+  sudo()
+  const skynet = new SkynetAPI(context.version, 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))
+  response = JSON.parse(response)
+  cli.log(`${response.status}. ${response.message}`)
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'unsuspend:user',
+  description: 'unsuspends a user',
+  help: `Examples:
+    $ heroku skynet:unsuspend:user -u foo@bar.com`,
+  flags: [
+    {name: 'user', char: 'u', description: 'user to unsuspend', hasValue: true}
+  ],
+  run: cli.command(co.wrap(run))
+}

package/commands/userpass/add.js

@@ -0,0 +1,21 @@
+let cli = require('heroku-cli-util')
+let co = require('co')
+let SkynetAPI = require('../../lib/skynet')
+
+function * run (context) {
+  const skynet = new SkynetAPI(context.version, 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.userpass))
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'userpass:add',
+  description: 'adds a userpass flag to a given user',
+  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: 'userpass', 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

@@ -0,0 +1,21 @@
+let cli = require('heroku-cli-util')
+let co = require('co')
+let SkynetAPI = require('../../lib/skynet')
+
+function * run (context) {
+  const skynet = new SkynetAPI(context.version, 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.userpass))
+}
+
+module.exports = {
+  topic: 'skynet',
+  command: 'userpass:remove',
+  description: 'removes given flag from a given user',
+  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: 'userpass', char: 'f', description: 'flag to remove from given user', hasValue: true, required: true}
+  ],
+  run: cli.command(co.wrap(run))
+}

package/index.js

@@ -0,0 +1,17 @@
+exports.topic = {
+  name: 'skynet',
+  // this is the help text that shows up under `heroku help`
+  description: 'use Skynet from Heroku CLI'
+}
+
+exports.commands = [
+  require('./commands/userpass/add.js'),
+  require('./commands/userpass/remove.js'),
+  require('./commands/suspend/app-owner.js'),
+  require('./commands/suspend/apps.js'),
+  require('./commands/suspend/user.js'),
+  require('./commands/unsuspend/apps.js'),
+  require('./commands/unsuspend/user.js'),
+  require('./commands/deprovision.js'),
+  require('./commands/categories.js')
+]

package/lib/skynet.js

@@ -0,0 +1,169 @@
+const cli = require('heroku-cli-util')
+const qs = require('querystring')
+const SKYNET_BASE_URL = 'https://skynet.herokai.com/api-h'
+
+module.exports = class SkynetAPI {
+  constructor (version, token) {
+    this.version = version
+    this.token = token
+  }
+
+  request (url, options = {}) {
+    options.headers = Object.assign({
+      Authorization: `Bearer ${this.token}`,
+      'User-Agent': this.version
+    })
+
+    if (['POST', 'PATCH', 'DELETE'].includes(options.method)) {
+      options.headers['Content-type'] = 'application/x-www-form-urlencoded'
+    }
+
+    options.json = false
+
+    return cli.got(SKYNET_BASE_URL + url, options).then((res) => res.body)
+  }
+
+  categories () {
+    return this.request(`/categories`, {
+      method: 'GET'
+    })
+  }
+
+  removeUserpass (user, flag) {
+    var body = {
+      user: user,
+      flag: flag
+    }
+
+    return this.request(`/userpass/remove`, {
+      method: 'POST',
+      body: qs.stringify(body)
+    })
+  }
+
+  addUserpass (user, flag) {
+    var body = {
+      user: user,
+      flag: flag
+    }
+
+    return this.request(`/userpass/add`, {
+      method: 'POST',
+      body: qs.stringify(body)
+    })
+  }
+
+  suspendAppOwner (app, notes, category) {
+    var body = {
+      value: app,
+      reason: notes,
+      method: 'skynet-cli',
+      category: category
+    }
+
+    return this.request('/suspend/app-owner', {
+      method: 'POST',
+      body: qs.stringify(body)
+    })
+  }
+
+  suspendApp (app, notes, category) {
+    var body = {
+      value: app,
+      reason: notes,
+      method: 'skynet-cli',
+      category: category
+    }
+
+    return this.request('/suspend/app', {
+      method: 'POST',
+      body: qs.stringify(body)
+    })
+  }
+
+  unsuspendApp (app) {
+    return this.request(`/suspensions/app/${app}`, {
+      method: 'DELETE'
+    })
+  }
+  suspendUser (user, notes, category, force = false) {
+    var body = {
+      value: user,
+      reason: notes,
+      method: 'skynet-cli',
+      category: category,
+      force: force
+    }
+
+    return this.request(`/suspend/user`, {
+      method: 'POST',
+      body: qs.stringify(body)
+    })
+  }
+
+  unsuspendUser (user) {
+    return this.request(`/suspensions/user/${user}`, {
+      method: 'DELETE'
+    })
+  }
+
+  bulkSuspendUsers (users, notes, category) {
+    var body = {
+      value: users,
+      reason: notes,
+      method: 'skynet-cli',
+      category: category,
+      bulk: 'true'
+    }
+
+    return this.request(`/suspend/user`, {
+      method: 'POST',
+      body: qs.stringify(body)
+    })
+  }
+
+  bulkSuspendAppOwner (apps, notes, category) {
+    var body = {
+      value: apps,
+      reason: notes,
+      method: 'skynet-cli',
+      category: category,
+      bulk: 'true'
+    }
+
+    return this.request(`/suspend/app-owner`, {
+      method: 'POST',
+      body: qs.stringify(body)
+    })
+  }
+
+  deprovision (user, notes, category, force = false) {
+    var body = {
+      value: user,
+      reason: notes,
+      method: 'skynet-cli',
+      category: category,
+      force: force
+    }
+
+    return this.request(`/deprovision`, {
+      method: 'POST',
+      body: qs.stringify(body)
+    })
+  }
+
+  bulkDeprovision (users, notes, category) {
+    var body = {
+      value: users,
+      reason: notes,
+      method: 'skynet-cli',
+      category: category,
+      bulk: 'true'
+    }
+
+    return this.request(`/deprovision`, {
+      method: 'POST',
+      body: qs.stringify(body)
+    })
+  }
+}

package/lib/sudo.js

@@ -0,0 +1,5 @@
+'use strict'
+
+module.exports = function requireSudo () {
+  if (process.env.HEROKU_SUDO !== '1') throw new Error('sudo is required for this command')
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@heroku/skynet",
+  "version": "1.4.1",
+  "description": "use Skynet from Heroku CLI",
+  "main": "index.js",
+  "author": "Bob Argenbright @byt3smith",
+  "repository": "heroku/heroku-skynet-cli",
+  "bugs": {
+    "url": "https://github.com/heroku/heroku-skynet/issues"
+  },
+  "keywords": [
+    "heroku-plugin"
+  ],
+  "files": [
+    "/index.js",
+    "/lib",
+    "/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",
+    "standard": "^10.0.2",
+    "unexpected": "^10.29.0"
+  },
+  "scripts": {
+    "test": "mocha && standard"
+  }
+}