@heroku/skynet 1.6.11 → 1.6.13

package/README.md

@@ -37,7 +37,7 @@ heroku skynet:<cmd>
 ```
 
 ### Unit test
-```
+```bash
 # $SKYNET_CLI_HOME points to the home dir of heroku-skynet-cli 
 cd $SKYNET_CLI_HOME
 unset SKYNET_HOST
@@ -45,7 +45,7 @@ npm test
 ```
 
 ### Integration test
-```
+```bash
 #
 # Start local skynet
 #
@@ -55,6 +55,7 @@ $ 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.
+$ cd $SKYNET_HOME
 $ 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
 
@@ -70,6 +71,10 @@ $ heroku local web,worker
 $ cd $HEROKU_SKYNET_CLI_HOME
 $ cloud production
 
+# Link to the local plugin implementation
+$ cd $HEROKU_SKYNET_CLI_HOME
+$ heroku plugins:link
+
 # Pointing to the local Skynet instance
 $ export SKYNET_HOST=http://localhost:5000
 
@@ -78,18 +83,41 @@ $ export SKYNET_HOST=http://localhost:5000
 #
 
 # This unsuspend request will be sent to the local Skynet instance
-$ heroku skynet::unsuspend::user -u dzhuo@heroku.com 
+$ heroku sudo skynet::unsuspend::user -u xyz@heroku.com 
 
+# Verify that you can see the unsuspend record in suspension_activities table 
 ```
 
 ### Publishing to `npm`
-1. Request access to NPM using [this form](https://securityorg.force.com/IntakeApp/s/?entityCode=HerokuAccess&si=a1i3A0000007euiQAA)
+* Request access to the NPM Heroku Organization using [this form](https://securityorg.force.com/IntakeApp/s/?entityCode=HerokuAccess&si=a1i3A0000007euiQAA).
+* Request write access to @keroku/skynet package by sending email to dzhuo@salesforce.com.
+* Publish the package:
 
-1. Publish the package:
+```
+# Check out the latest master
+$ cd $HEROKU_SKYNET_CLI_HOME
+$ git checkout -b master origin/master
 
-  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
+# Run npm release. In case `npm run release` asks you whether 
+# or not you want to publish the repo publicly, answer "No".
+$ npm login
+$ npm test
+$ npm run release
+```
+
+* Command 'npm run release' will change the version number in package.json file and commit. but the pull request will fail due to the enabled git pull process. A follow-up manual pull request is needed to check in the new version number in Git repository.    
+* Verify that new package version is created on [npm website](https://www.npmjs.com/package/@heroku/skynet), or directly run command "npm view @heroku/skynet"
+* Note: You will get an error at the end of `npm run release`. Np attempts to commit to master branch the updated package version in the package.json. But the commit will fail because our master branch is protected. You can ignore the error message. 
+* Submit a new PR to update the version in `package.json` and `package-lock.json`. Here is one [PR example](https://github.com/heroku/heroku-skynet-cli/pull/74).
+* Test the newly released @heroku/skynet package
+
+```bash
+# install the latest @heroku/skynet package
+$ cd $HEROKU_SKYNET_CLI_HOME
+$ heroku plugins:unlink
+$ heroku plugins:install @heroku/skynet
+$ heroku plugins  # verify that the latest version is installed
+
+# run tests
+$ heroku sudo skynet::unsuspend::user -u xyz@heroku.com 
+```

package/commands/deprovision.js

@@ -10,12 +10,13 @@ async function run (context) {
   let notes = context.flags.notes
   let category = context.flags.category
   let force = context.flags.bypass
+  let notify = !context.flags['no-notify']
 
   if (!user) {
     throw new Error('Required flag: --user USER')
   }
 
-  let response = await 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, notify, force))
   response = JSON.parse(response)
   cli.log(`${response.status}. ${response.message}`)
 }
@@ -30,7 +31,8 @@ module.exports = {
     { name: 'user', char: 'u', description: 'user 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: 'bypass', description: 'bypass the whitelist', hasValue: false, required: false },
+    { name: 'no-notify', description: 'skip user suspension email notification', hasValue: false, required: false }
   ],
   run: command(run)
 }

package/commands/unsuspend/apps.js

@@ -26,8 +26,8 @@ module.exports = {
     $ 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: 'category', char: 'c', description: 'unsuspension category', hasValue: true, required: false },
-    { name: 'notes', char: 'n', description: 'unsuspend notes', hasValue: true, required: false }
+    { name: 'category', char: 'c', description: 'unsuspension category', hasValue: true, required: true },
+    { name: 'notes', char: 'n', description: 'unsuspend notes', hasValue: true, required: true }
   ],
   run: command(run)
 }

package/commands/unsuspend/user.js

@@ -26,8 +26,8 @@ module.exports = {
     $ 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: 'category', char: 'c', description: 'unsuspension category', hasValue: true, required: false },
-    { name: 'notes', char: 'n', description: 'unsuspend notes', hasValue: true, required: false }
+    { name: 'category', char: 'c', description: 'unsuspension category', hasValue: true, required: true },
+    { name: 'notes', char: 'n', description: 'unsuspend notes', hasValue: true, required: true }
   ],
   run: command(run)
 }

package/lib/skynet.js

@@ -175,13 +175,14 @@ module.exports = class SkynetAPI {
     })
   }
 
-  deprovision (user, notes, category, force = false) {
+  deprovision (user, notes, category, notify = true, force = false) {
     var body = {
       value: user,
       reason: notes,
       method: 'skynet-cli',
       category: category,
-      force: force
+      force: force,
+      notify: notify
     }
 
     return this.request(`/deprovision`, {

package/package.json

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