hubot 3.3.1 → 3.4.0

package/.env.example

@@ -0,0 +1,2 @@
+export NPM_TOKEN=npm_whatever
+export GITHUB_TOKEN=ghp_whatever

package/.envrc

@@ -0,0 +1,5 @@
+# TODO change to op://Personal/npmjs.org/NPM Publish
+export NPM_TOKEN=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
+
+# TODO change to op://Personal/te/NPM Publish
+export GITHUB_TOKEN=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

package/.github/workflows/nodejs-macos.yml

@@ -0,0 +1,26 @@
+name: Node.js (macOS) CI
+
+on:
+  push:
+    branches: [ "master" ]
+  schedule:
+    - cron:  '5 4 * * 0'
+
+jobs:
+  npm-test:
+
+    runs-on: macos-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test

package/.github/workflows/nodejs-ubuntu.yml

@@ -0,0 +1,28 @@
+name: Node.js (Ubuntu) CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron:  '5 4 * * 0'
+
+jobs:
+  npm-test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x, latest]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test

package/.github/workflows/nodejs-windows.yml

@@ -0,0 +1,26 @@
+name: Node.js (Windows) CI
+
+on:
+  push:
+    branches: [ "master" ]
+  schedule:
+    - cron:  '5 4 * * 0'
+
+jobs:
+  npm-test:
+
+    runs-on: windows-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test

package/README.md

@@ -13,8 +13,6 @@ for details on getting up and running with your very own robot friend.
 In most cases, you'll probably never have to hack on this repo directly if you
 are building your own bot. But if you do, check out [CONTRIBUTING.md](CONTRIBUTING.md)
 
-If you'd like to chat with Hubot users and developers, [join us on Slack](https://hubot-slackin.herokuapp.com/).
-
 ## License
 
 See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).

package/bin/hubot.js

@@ -23,7 +23,7 @@ const options = {
   adapter: process.env.HUBOT_ADAPTER || 'shell',
   alias: process.env.HUBOT_ALIAS || false,
   create: process.env.HUBOT_CREATE || false,
-  enableHttpd: process.env.HUBOT_HTTPD || true,
+  enableHttpd: process.env.HUBOT_HTTPD !== 'false',
   scripts: process.env.HUBOT_SCRIPTS || [],
   name: process.env.HUBOT_NAME || 'Hubot',
   path: process.env.HUBOT_PATH || '.',
@@ -80,10 +80,6 @@ Parser.on((opt, value) => {
 
 Parser.parse(process.argv)
 
-if (process.platform !== 'win32') {
-  process.on('SIGTERM', () => process.exit(0))
-}
-
 if (options.create) {
   console.error("'hubot --create' is deprecated. Use the yeoman generator instead:")
   console.error('    npm install -g yo generator-hubot')

package/docs/deploying/windows.md

@@ -8,16 +8,16 @@ Hasn't been fully tested - YMMV
 
 There are 4 primary steps to deploying and running hubot on a Windows machine:
 
-  * node and npm
-  * a way to get source code updated on the server
-  * setting up environment variables for hubot
-  * a way to start hubot, start it up if it crashes, and restart it when code updates
+* node and npm
+* a way to get source code updated on the server
+* setting up environment variables for hubot
+* a way to start hubot, start it up if it crashes, and restart it when code updates
 
 ## node and npm
 
 To start, your windows server will need node and npm.
 The best way to do this is with [chocolatey](http://chocolatey.org) using the [nodejs.install](http://chocolatey.org/packages/nodejs.install) package.
-I've found that sometimes the system path variable is not correctly set; ensure you can run node/npm from the command line. If needed set the PATH variable with "setx PATH \"%PATH%;C:\Program Files\nodejs\" "
+I've found that sometimes the system path variable is not correctly set; ensure you can run node/npm from the command line. If needed set the PATH variable with `set PATH=%PATH%;\"C:\Program Files\nodejs\"`
 
 Your other option is to install directly from [NodeJS](https://nodejs.org/) and run the current download (v0.12.4 as of this documentation). This should set your PATH variables for you.
 

package/docs/patterns.md

@@ -218,3 +218,17 @@ Organizations that have a number of chat rooms that serve different purposes oft
 
 Work on generalized blacklist solution is [ongoing](https://github.com/kristenmills/hubot-command-blacklist). A whitelist soultion could take a similar approach.
 
+## Use scoped npm packages as adapter
+
+It is possible to [install](https://docs.npmjs.com/cli/v7/commands/npm-install) package under a custom alias:
+
+```bash
+npm install <alias>@npm:<name>
+```
+
+So for example to use `@foo/hubot-adapter` package as the adapter, you can:
+```bash
+npm install hubot-foo@npm:@foo/hubot-adapter
+
+bin/hubot --adapter foo
+```

package/es2015.js

@@ -13,7 +13,7 @@ module.exports = {
   User,
   Brain,
   Robot,
-  Adapter: Adapter,
+  Adapter,
   Response,
   Listener: Listener.Listener,
   TextListener: Listener.TextListener,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hubot",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "author": "hubot",
   "keywords": [
     "github",
@@ -21,21 +21,21 @@
     "coffeescript": "1.6.3",
     "connect-multiparty": "^2.1.1",
     "express": "^4.16.3",
+    "express-basic-auth": "1.1.7",
     "log": "1.4.0",
-    "optparse": "1.0.4",
-    "scoped-http-client": "0.11.0"
+    "optparse": "1.0.4"
   },
   "devDependencies": {
     "chai": "~2.1.0",
     "coveralls": "^3.0.2",
     "is-circular": "^1.0.2",
-    "mocha": "^5.2.0",
+    "mocha": "^10.2.0",
     "mockery": "^1.4.0",
-    "nyc": "^13.0.0",
-    "semantic-release": "^15.9.3",
+    "nyc": "^15.1.0",
+    "semantic-release": "^21.0.1",
     "sinon": "~1.17.0",
     "sinon-chai": "^2.8.0",
-    "standard": "^10.0.2"
+    "standard": "^17.0.0"
   },
   "engines": {
     "node": "> 4.0.0",

package/src/adapters/campfire.js

@@ -229,30 +229,30 @@ class CampfireStreaming extends EventEmitter {
       },
 
       speak (text, callback) {
-        const body = { message: { 'body': text } }
+        const body = { message: { body: text } }
         return self.post(`/room/${id}/speak`, body, callback)
       },
 
       message (text, type, callback) {
-        const body = { message: { 'body': text, 'type': type } }
+        const body = { message: { body: text, type } }
         return self.post(`/room/${id}/speak`, body, callback)
       },
 
       // listen for activity in channels
       listen () {
         const headers = {
-          'Host': 'streaming.campfirenow.com',
-          'Authorization': self.authorization,
+          Host: 'streaming.campfirenow.com',
+          Authorization: self.authorization,
           'User-Agent': `Hubot/${this.robot != null ? this.robot.version : undefined} (${this.robot != null ? this.robot.name : undefined})`
         }
 
         const options = {
-          'agent': false,
-          'host': 'streaming.campfirenow.com',
-          'port': 443,
-          'path': `/room/${id}/live.json`,
-          'method': 'GET',
-          'headers': headers
+          agent: false,
+          host: 'streaming.campfirenow.com',
+          port: 443,
+          path: `/room/${id}/live.json`,
+          method: 'GET',
+          headers
         }
 
         const request = HTTPS.request(options, function (response) {
@@ -326,19 +326,19 @@ class CampfireStreaming extends EventEmitter {
     const logger = this.robot.logger
 
     const headers = {
-      'Authorization': this.authorization,
-      'Host': this.host,
+      Authorization: this.authorization,
+      Host: this.host,
       'Content-Type': 'application/json',
       'User-Agent': `Hubot/${this.robot != null ? this.robot.version : undefined} (${this.robot != null ? this.robot.name : undefined})`
     }
 
     const options = {
-      'agent': false,
-      'host': this.host,
-      'port': 443,
-      'path': path,
-      'method': method,
-      'headers': headers
+      agent: false,
+      host: this.host,
+      port: 443,
+      path,
+      method,
+      headers
     }
 
     if (method === 'POST' || method === 'PUT') {

package/src/adapters/shell.js

@@ -8,7 +8,7 @@ const chalk = require('chalk')
 
 const Adapter = require('../adapter')
 
-var _require = require('../message')
+const _require = require('../message')
 
 const TextMessage = _require.TextMessage
 
@@ -82,7 +82,7 @@ class Shell extends Adapter {
     })
 
     this.cli.on('close', () => {
-      let fileOpts, history, i, item, len, outstream, startIndex
+      let history, i, item, len
 
       history = this.cli.history()
 
@@ -90,13 +90,13 @@ class Shell extends Adapter {
         return this.shutdown()
       }
 
-      startIndex = history.length - historySize
+      const startIndex = history.length - historySize
       history = history.reverse().splice(startIndex, historySize)
-      fileOpts = {
+      const fileOpts = {
         mode: 0x180
       }
 
-      outstream = fs.createWriteStream(historyPath, fileOpts)
+      const outstream = fs.createWriteStream(historyPath, fileOpts)
       outstream.on('finish', this.shutdown.bind(this))
 
       for (i = 0, len = history.length; i < len; i++) {
@@ -109,6 +109,8 @@ class Shell extends Adapter {
   }
 }
 
+// Prevent output buffer "swallowing" every other character on OSX / Node version > 16.19.0.
+process.stdout._handle.setBlocking(false)
 exports.use = robot => new Shell(robot)
 
 // load history from .hubot_history.

package/src/brain.js

@@ -10,19 +10,19 @@ const User = require('./user')
 // 2. If the original object was a User object, the original object
 // 3. If the original object was a plain JavaScript object, return
 //    a User object with all of the original object's properties.
-let reconstructUserIfNecessary = function (user, robot) {
+const reconstructUserIfNecessary = function (user, robot) {
   if (!user) {
     return null
   }
 
   if (!user.constructor || (user.constructor && user.constructor.name !== 'User')) {
-    let id = user.id
+    const id = user.id
     delete user.id
     // Use the old user as the "options" object,
     // populating the new user with its values.
     // Also add the `robot` field so it gets a reference.
     user.robot = robot
-    let newUser = new User(id, user)
+    const newUser = new User(id, user)
     delete user.robot
 
     return newUser
@@ -142,14 +142,14 @@ class Brain extends EventEmitter {
   //
   // Caveats: Deeply nested structures don't merge well.
   mergeData (data) {
-    for (let k in data || {}) {
+    for (const k in data || {}) {
       this.data[k] = data[k]
     }
 
     // Ensure users in the brain are still User objects.
     if (data && data.users) {
-      for (let k in data.users) {
-        let user = this.data.users[k]
+      for (const k in data.users) {
+        const user = this.data.users[k]
         this.data.users[k] = reconstructUserIfNecessary(user, this.getRobot())
       }
     }
@@ -195,8 +195,8 @@ class Brain extends EventEmitter {
     let result = null
     const lowerName = name.toLowerCase()
 
-    for (let k in this.data.users || {}) {
-      const userName = this.data.users[k]['name']
+    for (const k in this.data.users || {}) {
+      const userName = this.data.users[k].name
       if (userName != null && userName.toString().toLowerCase() === lowerName) {
         result = this.data.users[k]
       }

package/src/datastore.js

@@ -22,7 +22,7 @@ class DataStore {
   // present, it's instantiated as an empty object.
   setObject (key, objectKey, value) {
     return this.get(key).then((object) => {
-      let target = object || {}
+      const target = object || {}
       target[objectKey] = value
       return this.set(key, target)
     })
@@ -33,7 +33,7 @@ class DataStore {
   // present, it's instantiated as an empty array.
   setArray (key, value) {
     return this.get(key).then((object) => {
-      let target = object || []
+      const target = object || []
       // Extend the array if the value is also an array, otherwise
       // push the single value on the end.
       if (Array.isArray(value)) {
@@ -56,7 +56,7 @@ class DataStore {
   // contain an `objectKey`, returns `undefined`.
   getObject (key, objectKey) {
     return this.get(key).then((object) => {
-      let target = object || {}
+      const target = object || {}
       return target[objectKey]
     })
   }