hubot 5.0.5 → 5.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hubot",
-  "version": "5.0.5",
+  "version": "5.0.7",
   "author": "hubot",
   "keywords": [
     "github",
@@ -22,7 +22,8 @@
     "express": "^4.18.2",
     "express-basic-auth": "^1.2.1",
     "optparse": "^1.0.5",
-    "pino": "^8.11.0"
+    "pino": "^8.11.0",
+    "standard": "^17.1.0"
   },
   "devDependencies": {
     "chai": "^4.3.7",
@@ -31,8 +32,7 @@
     "mockery": "^2.1.0",
     "semantic-release": "^21.0.1",
     "sinon": "^15.0.4",
-    "sinon-chai": "^3.7.0",
-    "standard": "^17.0.0"
+    "sinon-chai": "^3.7.0"
   },
   "engines": {
     "node": "> 4.0.0",
@@ -46,7 +46,8 @@
     "start": "bin/hubot",
     "pretest": "standard",
     "test": "mocha --exit",
-    "test:smoke": "node src/**/*.js"
+    "test:smoke": "node src/**/*.js",
+    "test:e2e": "bin/e2e-test.sh"
   },
   "release": {
     "branches": [

package/.editorconfig

@@ -1,14 +0,0 @@
-# EditorConfig is awesome: http://EditorConfig.org
-
-# Top-most EditorConfig file
-root = true
-
-# Match and apply these rules for all file
-# types you open in your code editor
-[*]
-# Unix-style newlines
-end_of_line = lf
-insert_final_newline = true
-indent_style = space
-indent_size = 2
-trim_trailing_whitespace = true

package/.github/stale.yml

@@ -1,23 +0,0 @@
-# Configuration for probot-stale - https://github.com/probot/stale
-
-# Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 90
-# Number of days of inactivity before a stale Issue or Pull Request is closed
-daysUntilClose: 7
-# Issues or Pull Requests with these labels will never be considered stale
-exemptLabels:
-  - pinned
-  - security
-# Label to use when marking as stale
-staleLabel: stale
-# Comment to post when marking as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has [not had
-  recent activity](https://github.com/github/hubot/blob/main/CONTRIBUTING.md#stale-issue-and-pull-request-policy).
-  It will be closed if no further activity occurs. Thank you for your contributions.
-# Comment to post when removing the stale label. Set to `false` to disable
-unmarkComment: false
-# Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable
-closeComment: false
-# Limit to only `issues` or `pulls`
-# only: issues

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

@@ -1,26 +0,0 @@
-name: Node.js (macOS) CI
-
-on:
-  push:
-    branches: [ "main" ]
-  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

@@ -1,28 +0,0 @@
-name: Node.js (Ubuntu) CI
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-  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

@@ -1,26 +0,0 @@
-name: Node.js (Windows) CI
-
-on:
-  push:
-    branches: [ "main" ]
-  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/.github/workflows/release.yml

@@ -1,37 +0,0 @@
-name: Release
-on:
-  push:
-    branches:
-      - main
-      - next
-permissions:
-  contents: read
-jobs:
-  release:
-    name: Release
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      issues: write
-      pull-requests: write
-      id-token: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: "lts/*"
-      - name: Install Dependencies
-        run: npm clean-install
-      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
-        run: npm audit signatures
-      - name: Run Tests
-        run: npm test
-      - name: Release
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npx semantic-release

package/bin/e2e-test.sh

@@ -1,47 +0,0 @@
-#!/bin/bash
-HUBOT_FOLDER=$(pwd)
-TEMP_ROOT=$(mktemp -d)
-
-echo "$ pushd $TEMP_ROOT"
-pushd $TEMP_ROOT
-trap "{ CODE=$?; popd; rm -rf $TEMP_ROOT; exit $CODE; }" EXIT
-
-## https://hubot.github.com/docs/
-
-echo "$ npm install -g yo generator-hubot"
-npm install -g yo generator-hubot
-
-## simulate pressing enter for each generator question to accept defaults
-## https://stackoverflow.com/a/6264618/206879
-echo "$ yo hubot --defaults"
-yo hubot --defaults
-
-## use hubot from last commit
-echo "$ npm install $HUBOT_FOLDER"
-npm install $HUBOT_FOLDER
-
-# npm install /path/to/hubot will create a symlink in npm 5+ (http://blog.npmjs.org/post/161081169345/v500).
-# As the require calls for app-specific scripts happen inside hubot, we have to
-# set NODE_PATH to the app’s node_modules path so they can be found
-echo "$ NODE_PATH=$HUBOT_FOLDER/node_modules:$TEMP_ROOT/node_modules"
-export NODE_PATH=$NODE_PATH/$HUBOT_FOLDER/node_modules:$TEMP_ROOT/node_modules
-
-## start
-expect <<EOL
-  set timeout 30
-
-  spawn bin/hubot --name e2etest
-
-  # workaround for current hubot which does not show prompt until pressed enter
-  # so we simulate it once 'INFO hubot-redis-brain: Using default redis on localhost:6379' appears
-  expect "localhost:6379"
-  send "\r"
-
-  expect "e2etest> "
-
-  send "e2etest ping\r"
-  expect {
-    "PONG" {}
-    timeout {exit 1}
-  }
-EOL

package/docs/adapters/campfire.md

@@ -1,79 +0,0 @@
----
-permalink: /docs/adapters/campfire/
----
-
-# Campfire adapter
-
-[Campfire](http://campfirenow.com/) is a web based chat application built by
-[37signals](http://37signals.com). The Campfire adapter is one of the original
-adapters in Hubot.
-
-## Getting Started
-
-You will need a Campfire account to start, which you can
-[sign up for free](https://signup.37signals.com/campfire/free/signup/new).
-
-Next, you will need to create a user on your Campfire account for your Hubot,
-then give it access so it can join to your rooms. You will need to create a room
-if you haven't already.
-
-Hubot defaults to using its [shell](./shell.md), so to use Campfire instead, you
-can run hubot with `-a campfire`:
-
-    % bin/hubot -a campfire
-
-If you are deploying to Heroku or using foreman, you need to make
-sure the hubot is called with `-a campfire` in the `Procfile`:
-
-    web: bin/hubot -a campfire -n Hubot
-
-## Configuring
-
-The adapter requires the following environment variables.
-
-* `HUBOT_CAMPFIRE_ACCOUNT`
-* `HUBOT_CAMPFIRE_TOKEN`
-* `HUBOT_CAMPFIRE_ROOMS`
-
-### Campfire API Token
-
-This can be found by logging in with your hubot's account click the **My Info**
-link and make a note of the API token.
-
-### Campfire Room IDs
-
-If you join the rooms you want your hubot to join will see notice a numerical
-ID for the room in the URL. Make a note of each ID for the rooms you want your
-hubot to join.
-
-### Campfire Account
-
-This is simply the first part of the domain you visit for your Campfire
-account. For example if your Campfire was at `hubot.campfirenow.com` your
-subdomain is `hubot`. Make a note of the subdomain.
-
-### Configuring the variables on Heroku
-
-    % heroku config:set HUBOT_CAMPFIRE_TOKEN="..."
-
-    % heroku config:set HUBOT_CAMPFIRE_ROOMS="123,321"
-
-    % heroku config:set HUBOT_CAMPFIRE_ACCOUNT="..."
-
-### Configuring the variables on UNIX
-
-    % export HUBOT_CAMPFIRE_TOKEN="..."
-
-    % export HUBOT_CAMPFIRE_ROOMS="123,321"
-
-    % export HUBOT_CAMPFIRE_ACCOUNT="..."
-
-### Configuring the variables on Windows
-
-Using PowerShell:
-
-    setx HUBOT_CAMPFIRE_TOKEN "..." /m
-
-    setx HUBOT_CAMPFIRE_ROOMS "123,321" /m
-
-    setx HUBOT_CAMPFIRE_ACCOUNT "..." /m

package/docs/adapters/development.md

@@ -1,125 +0,0 @@
----
-permalink: /docs/adapters/development/
----
-
-# Development adapter
-
-## Adapter Basics
-
-All adapters inherit from the Adapter class in the `src/adapter.js` file.
-
-If you're writing your adapter in ES2015, you must require the ES2015 entrypoint instead:
-
-```javascript
-const Adapter = require('hubot/es2015').Adapter;
-```
-
-There are certain methods that you will want to override.  Here is a basic stub of what an extended Adapter class would look like:
-
-```javascript
-const Adapter = require('../adapter')
-const User = require('../user')
-const TextMessage = require('../message').TextMessage
-class Sample extends Adapter {
-    constructor(robot) {
-        super(robot)
-        this.robot.logger.info('Constructor')
-    }
-    send(envelope, ...strings) {
-        this.robot.logger.info('Send')
-    }
-    reply(envelope, ...strings) {
-        this.robot.logger.info('Reply')
-    }
-    run() {
-        this.robot.logger.info('Run')
-        this.emit('connected') // The 'connected' event is required to trigger loading of Hubot scripts.
-        const user = new User(1001, 'Sample User')
-        const message = new TextMessage(user, 'Some Sample Message', 'MSG-001')
-        this.robot.receive(message)
-    }
-}
-exports.use = (robot) => new Sample(robot)
-```
-
-## Option 1. Setting Up Your Development Environment
-
-1. Create a new folder for your adapter `hubot-sample`
-  - `mkdir hubot-sample`
-2. Change your working directory to `hubot-sample`
-  - `cd hubot-sample`
-3. Run `npm init` to create your package.json
-  - make sure the entry point is `src/sample.js`
-4. Add your `.gitignore` to include `node_modules`
-5. Edit the `src/sample.js` file to include the above stub for your adapter
-6. Edit the `package.json` to add a peer dependency on `hubot`
-
-  ```json
-  "dependencies": {
-  },
-  "peerDependencies": {
-    "hubot": ">=3.0"
-  },
-  "devDependencies": {
-    "coffeescript": ">=1.2.0"
-  }
-  ```
-
-7. Generate your Hubot using the `yo hubot` [command](https://hubot.github.com/docs/)
-8. Change working directories to the `hubot` you created in step 7.
-9. Now perform an `npm link` to add your adapter to `hubot`
-  - `npm link ../hubot-sample`
-10. Run `hubot -a sample`
-
-## Gotchas
-
-There is a an open issue in the node community around [npm linked peer dependencies not working](https://github.com/npm/npm/issues/5875). To get this working for our project you will need to do some minor changes to your code.
-
-1. For the import in your `hubot-sample` adapter, add the following code
-
-  ```javascript
-  let  {Robot,Adapter,TextMessage,User} = {}
-  try {
-    {Robot,Adapter,TextMessage,User} = require('hubot')
-  } catch {
-    const prequire = require('parent-require')
-    {Robot,Adapter,TextMessage,User} = prequire('hubot')
-  }
-  ```
-2. In your `hubot-sample` folder, modify the `package.json` to include the following dependency so this custom import mechanism will work
-
-  ```json
-  "dependencies": {
-    "parent-require": "^1.0.0"
-  }
-  ```
-3. Now try running `hubot -a sample` again and see that the imports are properly loaded.
-4. Once this is working properly, you can build out the functionality of your adapter as you see fit.  Take a look at some of the other adapters to get some ideas for your implementation.
-  - Once packaged and deployed via `npm`, you won't need the dependency in `hubot` anymore since the peer dependency should work as an official module.
-
-## Option 2. Setting Up Your Development Environment
-
-Another option is to load the file from local disk.
-
-1. Create a new folder for your adapter `hubot-sample`
-  - `mkdir hubot-sample`
-2. Change your working directory to `hubot-sample`
-  - `cd hubot-sample`
-3. Run `npm init` to create your package.json
-  - make sure the entry point is `src/sample.js`
-4. Add your `.gitignore` to include `node_modules`
-5. Edit the `src/sample.js` file to include the above stub for your adapter
-6. Edit the `package.json` to add a peer dependency on `hubot`
-
-  ```json
-  "dependencies": {
-  },
-  "peerDependencies": {
-    "hubot": ">=4.2.0"
-  },
-  "devDependencies": {
-    "coffeescript": ">=1.2.0"
-  }
-  ```
-
-7. Run `npx hubot -p ./src -a sample.js`

package/docs/adapters/shell.md

@@ -1,24 +0,0 @@
----
-permalink: /docs/adapters/shell/
----
-
-# Shell adapter
-
-The shell adapter provides a simple read-eval-print loop for interacting with a hubot locally.
-It can be useful for testing scripts before using them on a live hubot.
-
-## Getting Started
-
-To use the shell adapter you can simply omit the `-a` option when running
-hubot as it will use the shell adapter by default.
-
-    % bin/hubot
-
-## Configuring
-
-This adapter doesn't require any configuration.
-
-It supports two environment variables to make it possible to test scripts as different users:
-
-* HUBOT_SHELL_USER_ID: default is 1
-* HUBOT_SHELL_USER_NAME: default is Shell

package/docs/adapters.md

@@ -1,27 +0,0 @@
----
-permalink: /docs/adapters/
----
-
-# Adapters
-
-Adapters are the interface to the service you want your hubot to run on.
-
-Hubot includes two official adapters:
-
-* [Shell](./adapters/shell.md), i.e. for use with development
-* [Campfire](./adapters/campfire.md)
-
-There are Third-party adapters available for most chat services. Here are the most popular ones:
-
-* [Gitter](https://github.com/huafu/hubot-gitter2)
-* [HipChat](https://github.com/hipchat/hubot-hipchat)
-* [IRC](https://github.com/nandub/hubot-irc)
-* [Rocket.Chat](https://github.com/RocketChat/hubot-rocketchat)
-* [Slack](https://github.com/slackhq/hubot-slack)
-* [XMPP](https://github.com/markstory/hubot-xmpp)
-
-Browse all [repositories with the `hubot-adapter` topic on GitHub](https://github.com/search?q=topic%3Ahubot-adapter&type=Repositories) or [search for adapters on NPM](https://www.npmjs.com/search?q=hubot%20adapter&ranking=popularity). Add the `hubot-adapter` [topic](https://help.github.com/articles/classifying-your-repository-with-topics/) to your repository on GitHub to include it in this list.
-
-## Writing Your Own Adapter
-
-Interested in adding your own adapter? Check out our documentation for [developing adapters](./adapters/development.md)

package/docs/deploying/azure.md

@@ -1,97 +0,0 @@
----
-permalink: /docs/deploying/azure/
----
-
-# Deploying to Azure
-
-If you've been following along with [Getting Started](../index.md), it's time to deploy so you can use it beyond just your local machine.
-[Azure](http://azure.microsoft.com/) is a way to deploy hubot as an alternative to [Heroku](heroku.md).
-
-You will need to install the azure-cli via npm after you have follow the initial instructions for your hubot.
-
-    % npm install -g azure-cli
-
-Inside your new hubot directory, make sure you've created a git repository, and that your work is committed:
-
-    % git init
-    % git add .
-    % git commit -m "Initial commit"
-
-Then [create a GitHub repository](https://help.github.com/articles/create-a-repo/) for your hubot. This is where Azure will pull your code from instead of needing to deploy directly from your dev machine to Azure.
-
-    % git remote add origin _your GitHub repo_
-    % git push -u origin main
-
-Once you have your GitHub repo, create an Azure website linked to your repo. In Azure, create a website and select integrated source control. When it asks "where is your source control" select GitHub and link this website to your git repo that you created in the previous step. If you have downloaded the Azure PowerShell modules, you can also do this via PowerShell.
-
-    % $creds = Get-Credential
-    % New-AzureWebsite mynewhubot -github -githubrepository yourgithubaccount/yourhubotreponame -githubcredentials $creds
-
-Once you have done this, Azure will deploy your site any time you commit and push to GitHub. Your hubot won't run quite right yet, though. Next, you need to configure the deployment to tell Azure how to run hubot.
-
-First, run the follow command to add `deploy.cmd` to your hubot directory. This is the file that Azure uses to know how to deploy your node application.
-
-    % azure site deploymentscript --node
-
-Then, edit this file and look for the sections that give you steps 1, 2 and 3. You're going to add a 4th step:
-
-    :: 4. Create Hubot file with a coffee extension
-    copy /Y "%DEPLOYMENT_TARGET%\node_modules\hubot\bin\hubot" "%DEPLOYMENT_TARGET%\node_modules\hubot\bin\hubot.coffee"
-
-Now, create a new file in the base directory of hubot called `server.js` and put these two lines into it:
-
-    require('coffeescript/register');
-    module.exports = require('hubot/bin/hubot.coffee');
-
-Finally you will need to add the environment variables to the website to make sure it runs properly. You can either do it through the GUI (under configuration) or you can use the Azure PowerShell command line, as follows (example is showing slack as an adapter and mynewhubot as the website name).
-
-    % $settings = New-Object Hashtable
-    % $settings["HUBOT_ADAPTER"] = "Slack"
-    % $settings["HUBOT_SLACK_TOKEN"] = "yourslackapikey"
-    % Set-AzureWebsite -AppSettings $settings mynewhubot
-
-Commit your changes in git and push to GitHub and Azure will automatically pick up the changes and deploy them to your website.
-
-    % git commit -m "Add Azure settings for hubot"
-    % git push
-
-Azure offers a marketplace where you can use the default heroku-redis-brain using Redis Cloud provided by Redis Labs. Alternatively, to add an [Azure blob storage brain](https://github.com/coryallegory/hubot-azure-brain), you will need to create an Azure storage account. Then you can do the following in your base hubot directory.
-
-    % npm install hubot-azure-brain --save
-
-Then add the following line in `external-scripts.json` in the list with the other external scripts
-
-    "hubot-azure-brain"
-
-Finally, add one more environment variables to your website. You can do this either via the GUI or the following PowerShell commands.
-
-    % $settings = New-Object Hashtable
-    % $settings["HUBOT_BRAIN_AZURE_CONNSTRING"] = "your Azure blob storage connection string"
-    % Set-AzureWebsite -AppSettings $settings mynewhubot
-
-Now any scripts that require a brain will function. You should look up other scripts or write your own by looking at the [documentation](../scripting.md). All of the normal scripts for hubot are compatible with hosting hubot on Azure.
-
-### Troubleshooting tips and tricks
-
-Due to Azure being Windows-based, you may run into path length problems. To overcome this issue you can set the environment variable `IN_PLACE_DEPLOYMENT` to `1` and use [custom deployment scripts to take advantage of NPM3](https://github.com/felixrieseberg/azure-npm3) and flat module installation.
-
-If you have your instance of hubot deploying directly from source control to Azure, it will perform various bootstrapping tasks along with calling `npm install` via kudu. Now that Azure supports npm5, this process generates a package-lock.json file which may result in some of your packages failing to install remotely. You can edit `deploy.cmd` to include `--no-package-lock` as part of the "Step 3" install command.
-
-If using the free tier of Azure, you can also add a post-deployment step to ping the server on startup by setting the environment variable `POST_DEPLOYMENT_ACTION` with a script (relative to the src dir) such as `startup.sh`
-
-An example of a startup script:
-
-```
-let retrys=0
-while : ; do
-    STATUSCODE=$(curl --silent --output /dev/stderr --write-out "%{http_code}" https://${WEBSITE_SITE_NAME}.azurewebsites.net/heroku/keepalive)
-    echo $STATUSCODE
-    [[ $retrys -ne 5 ]] || break
-    echo $retrys
-    ((retrys++))
-    [[ $STATUSCODE -ne 200 ]] || break
-done
-```
-
-### Slack Integration
-Currently the Slack integration has trouble finding hubot when deployed to Azure. Adding a `NODE_PATH` application setting with the value `D:\home\site\wwwroot\node_modules` will allow the Slack module to find hubot.