@heroku/skynet 1.6.8 → 1.6.10

package/README.md

@@ -36,8 +36,54 @@ heroku login # login to the staging cloud via the cli
 heroku skynet:<cmd>
 ```
 
+### Unit test
+```
+# $SKYNET_CLI_HOME points to the home dir of heroku-skynet-cli 
+cd $SKYNET_CLI_HOME
+unset SKYNET_HOST
+npm test
+```
+
+### Integration test
+```
+#
+# Start local skynet
+#
+
+# start postgres DB and redis
+$ pg_ctl -D /usr/local/var/postgres start
+$ redis-server
+
+# Update URL and KEY in .env. $REAL_KEY_IN_PRODUCTION refers to the real key in production.
+$ sed -i -e 's/HEROKU_API_URL=.*/HEROKU_API_URL=https:\/\/api.heroku.com/g' .env  
+$ sed -i -e 's/HEROKU_API_KEY=.*/HEROKU_API_KEY=$REAL_KEY_IN_PRODUCTION/g'  .env
+
+# Start skynet instance
+$ cd $SKYNET_HOME
+$ heroku local web,worker
+
+# 
+# Config heroku-skynet-cli
+#
+
+# Pointing CLI to the Heroku Production
+$ cd $HEROKU_SKYNET_CLI_HOME
+$ cloud production
+
+# Pointing to the local Skynet instance
+$ export SKYNET_HOST=http://localhost:5000
+
+#
+# Run Tests
+#
+
+# This unsuspend request will be sent to the local Skynet instance
+$ heroku skynet::unsuspend::user -u dzhuo@heroku.com 
+
+```
+
 ### 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. Request access to NPM using [this form](https://securityorg.force.com/IntakeApp/s/?entityCode=HerokuAccess&si=a1i3A0000007euiQAA)
 
 1. Publish the package:
 

package/commands/unsuspend/apps.js

@@ -6,8 +6,15 @@ let SkynetAPI = require('../../lib/skynet')
 async function run (context) {
   sudo()
   const skynet = new SkynetAPI(context.auth.password)
-  let response = await skynet.unsuspendApp(context.flags.app, context.flags.notes)
-  response = JSON.parse(response)
+  let app = context.flags.app
+  let category = context.flags.category
+  let notes = context.flags.notes
+
+  if (!app) {
+    throw new Error('Required flag: --app APP')
+  }
+
+  const response = await skynet.unsuspendApp(app, category, notes)
   cli.log(`suspending...${cli.color.cyan(response.status)}.\n${response.message}`)
 }
 
@@ -16,9 +23,11 @@ module.exports = {
   command: 'unsuspend:app',
   description: '(requires sudo) unsuspends an app',
   help: `Examples:
-    $ heroku skynet:unsuspend:app -a test-app`,
+    $ heroku skynet:unsuspend:app -a test-app -n "helpful unsuspend message" -c "ddos"`,
   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 },
+    { name: 'category', char: 'c', description: 'unsuspension category', hasValue: true, required: false },
+    { name: 'notes', char: 'n', description: 'unsuspend notes', hasValue: true, required: false }
   ],
   run: command(run)
 }

package/commands/unsuspend/user.js

@@ -7,9 +7,14 @@ async function run (context) {
   sudo()
   const skynet = new SkynetAPI(context.auth.password)
   let user = context.flags.user || process.env.HEROKU_USER
+  let category = context.flags.category
+  let notes = context.flags.notes
 
-  let response = await cli.action(`unsuspending ${cli.color.cyan(user)}`, skynet.unsuspendUser(user))
-  response = JSON.parse(response)
+  if (!user) {
+    throw new Error('Required flag: --user USER')
+  }
+
+  const response = await cli.action(`unsuspending ${cli.color.cyan(user)}`, skynet.unsuspendUser(user, category, notes))
   cli.log(`${response.status}. ${response.message}`)
 }
 
@@ -18,9 +23,11 @@ module.exports = {
   command: 'unsuspend:user',
   description: '(requires sudo) unsuspends a user',
   help: `Examples:
-    $ heroku skynet:unsuspend:user -u foo@bar.com`,
+    $ heroku skynet:unsuspend:user -u foo@bar.com -n "helpful unsuspend message" -c "ddos"`,
   flags: [
-    { name: 'user', char: 'u', description: 'user to unsuspend', hasValue: true }
+    { name: 'user', char: 'u', description: 'user to unsuspend', hasValue: true },
+    { name: 'category', char: 'c', description: 'unsuspension category', hasValue: true, required: false },
+    { name: 'notes', char: 'n', description: 'unsuspend notes', hasValue: true, required: false }
   ],
   run: command(run)
 }

package/lib/skynet.js

@@ -9,7 +9,7 @@ const SKYNET_BASE_URL = `${skynetHost}/api-h`
 
 module.exports = class SkynetAPI {
   constructor (token) {
-    let packageJSON = require('../package.json')
+    const packageJSON = require('../package.json')
     this.version = `skynet-${packageJSON.version}`
     this.token = token
   }
@@ -44,7 +44,9 @@ module.exports = class SkynetAPI {
 
   removeWhitelist (appOrUserEmail) {
     return this.request(`/whitelist/${appOrUserEmail}`, {
-      method: 'DELETE'
+      method: 'DELETE',
+      body: {},
+      json: true
     })
   }
 
@@ -106,9 +108,11 @@ module.exports = class SkynetAPI {
     })
   }
 
-  unsuspendApp (app) {
-    return this.request(`/suspensions/app/${app}`, {
-      method: 'DELETE'
+  unsuspendApp (app, category, notes) {
+    return this.request(`/suspensions/app/${app}?category=${category}&reason=${notes}`, {
+      method: 'DELETE',
+      body: {},
+      json: true
     })
   }
 
@@ -129,9 +133,11 @@ module.exports = class SkynetAPI {
     })
   }
 
-  unsuspendUser (user) {
-    return this.request(`/suspensions/user/${user}`, {
-      method: 'DELETE'
+  unsuspendUser (user, category, notes) {
+    return this.request(`/suspensions/user/${user}?category=${category}&reason=${notes}`, {
+      method: 'DELETE',
+      body: {},
+      json: true
     })
   }
 
@@ -186,7 +192,7 @@ module.exports = class SkynetAPI {
   }
 
   addCategory (category, description) {
-    let body = {
+    const body = {
       category: category,
       description: description
     }
@@ -200,7 +206,9 @@ module.exports = class SkynetAPI {
 
   removeCategory (category) {
     return this.request(`/categories/${category}`, {
-      method: 'DELETE'
+      method: 'DELETE',
+      body: {},
+      json: true
     })
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heroku/skynet",
-  "version": "1.6.8",
+  "version": "1.6.10",
   "description": "use Skynet from Heroku CLI",
   "main": "index.js",
   "author": "Bob Argenbright @byt3smith",