hubot 5.0.4 → 5.0.6

package/examples/hubot-start.ps1

@@ -1,12 +0,0 @@
-#Hubot PowerShell Start Script
-#Invoke from the PowerShell prompt or start via automated tools 
-
-$HubotPath = "drive:\path\to\hubot"
-$HubotAdapter = "Hubot adapter"
-
-Write-Host "Starting Hubot Watcher"
-While (1)
-{
-    Write-Host "Starting Hubot"
-    Start-Process powershell -ArgumentList "$HubotPath\bin\hubot –adapter $HubotAdapter" -wait
-}

package/examples/hubot.service

@@ -1,27 +0,0 @@
-; Hubot systemd service unit file
-; Place in e.g. `/etc/systemd/system/hubot.service`, then `systemctl daemon-reload` and `service hubot start`.
-
-[Unit]
-Description=Hubot
-Requires=network.target
-After=network.target
-
-[Service]
-Type=simple
-WorkingDirectory=/path/to/hubot
-User=change-to-hubot-user
-
-Restart=always
-RestartSec=10
-
-; Configure Hubot environment variables, use quotes around vars with whitespace as shown below.
-Environment="HUBOT_aaa=xxx"
-Environment="HUBOT_bbb='yyy yyy'"
-
-; Alternatively multiple environment variables can loaded from an external file
-;EnvironmentFile=/etc/hubot-environment
-
-ExecStart=/path/to/hubot/bin/hubot --adapter zzz
-
-[Install]
-WantedBy=multi-user.target

package/script/bootstrap

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-
-npm install

package/script/release

@@ -1,44 +0,0 @@
-#!/usr/bin/env bash
-# Tag and push a release.
-
-set -e
-
-# Make sure we're in the project root.
-
-cd $(dirname "$0")/..
-
-# Make sure the darn thing works
-
-npm update && script/smoke-test
-
-# Make sure we're on the main branch.
-
-(git branch | grep -q '* main') || {
-  echo "Only release from the main branch."
-  exit 1
-}
-
-# Figure out what version we're releasing.
-
-tag=v`node -e 'console.log(require("./package.json").version)'`
-
-# Ensure there's a line in the CHANGELOG
-
-grep "$tag" CHANGELOG.md || {
-  echo "No entry for '$tag' found in the CHANGELOG."
-  exit 1
-}
-
-# Make sure we haven't released this version before.
-
-git fetch -t origin
-
-(git tag -l | grep -q "$tag") && {
-  echo "Whoops, there's already a '${tag}' tag."
-  exit 1
-}
-
-# Tag it and bag it.
-
-npm publish && git tag "$tag" &&
-  git push origin main --tags

package/script/server

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-
-npm start -- "$@"

package/script/smoke-test

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-
-npm run test:smoke

package/script/test

@@ -1,3 +0,0 @@
-#!/usr/bin/env bash
-
-npm test -- "$@"

package/test/adapter_test.js

@@ -1,97 +0,0 @@
-'use strict'
-
-/* global describe, beforeEach, it */
-
-const chai = require('chai')
-const sinon = require('sinon')
-chai.use(require('sinon-chai'))
-
-const expect = chai.expect
-
-const Adapter = require('../src/adapter')
-
-describe('Adapter', function () {
-  beforeEach(function () {
-    this.robot = { receive: sinon.spy() }
-  })
-
-  describe('Public API', function () {
-    beforeEach(function () {
-      this.adapter = new Adapter(this.robot)
-    })
-
-    it('assigns robot', function () {
-      expect(this.adapter.robot).to.equal(this.robot)
-    })
-
-    describe('send', function () {
-      it('is a function', function () {
-        expect(this.adapter.send).to.be.a('function')
-      })
-
-      it('does nothing', function () {
-        this.adapter.send({}, 'nothing')
-      })
-    })
-
-    describe('reply', function () {
-      it('is a function', function () {
-        expect(this.adapter.reply).to.be.a('function')
-      })
-
-      it('does nothing', function () {
-        this.adapter.reply({}, 'nothing')
-      })
-    })
-
-    describe('topic', function () {
-      it('is a function', function () {
-        expect(this.adapter.topic).to.be.a('function')
-      })
-
-      it('does nothing', function () {
-        this.adapter.topic({}, 'nothing')
-      })
-    })
-
-    describe('play', function () {
-      it('is a function', function () {
-        expect(this.adapter.play).to.be.a('function')
-      })
-
-      it('does nothing', function () {
-        this.adapter.play({}, 'nothing')
-      })
-    })
-
-    describe('run', function () {
-      it('is a function', function () {
-        expect(this.adapter.run).to.be.a('function')
-      })
-
-      it('does nothing', function () {
-        this.adapter.run()
-      })
-    })
-
-    describe('close', function () {
-      it('is a function', function () {
-        expect(this.adapter.close).to.be.a('function')
-      })
-
-      it('does nothing', function () {
-        this.adapter.close()
-      })
-    })
-  })
-
-  it('dispatches received messages to the robot', function () {
-    this.robot.receive = sinon.spy()
-    this.adapter = new Adapter(this.robot)
-    this.message = sinon.spy()
-
-    this.adapter.receive(this.message)
-
-    expect(this.robot.receive).to.have.been.calledWith(this.message)
-  })
-})

package/test/brain_test.js

@@ -1,336 +0,0 @@
-'use strict'
-
-/* global describe, beforeEach, afterEach, it */
-/* eslint-disable no-unused-expressions */
-
-// Assertions and Stubbing
-const chai = require('chai')
-const sinon = require('sinon')
-chai.use(require('sinon-chai'))
-
-const expect = chai.expect
-
-const isCircular = require('is-circular')
-
-// Hubot classes
-const Brain = require('../src/brain')
-const User = require('../src/user')
-
-describe('Brain', function () {
-  beforeEach(function () {
-    this.clock = sinon.useFakeTimers()
-    this.mockRobot = {
-      emit () {},
-      on () {}
-    }
-
-    // This *should* be callsArgAsync to match the 'on' API, but that makes
-    // the tests more complicated and seems irrelevant.
-    sinon.stub(this.mockRobot, 'on').withArgs('running').callsArg(1)
-
-    this.brain = new Brain(this.mockRobot)
-
-    this.user1 = this.brain.userForId('1', { name: 'Guy One' })
-    this.user2 = this.brain.userForId('2', { name: 'Guy One Two' })
-    this.user3 = this.brain.userForId('3', { name: 'Girl Three' })
-  })
-
-  afterEach(function () {
-    this.clock.restore()
-  })
-
-  describe('Unit Tests', function () {
-    describe('#mergeData', function () {
-      it('performs a proper merge with the new data taking precedent', function () {
-        this.brain.data = {
-          1: 'old',
-          2: 'old'
-        }
-
-        this.brain.mergeData({ 2: 'new' })
-
-        expect(this.brain.data).to.deep.equal({
-          1: 'old',
-          2: 'new'
-        })
-      })
-
-      it('emits a loaded event with the new data', function () {
-        sinon.spy(this.brain, 'emit')
-        this.brain.mergeData({})
-        expect(this.brain.emit).to.have.been.calledWith('loaded', this.brain.data)
-      })
-
-      it('coerces loaded data into User objects', function () {
-        this.brain.mergeData({ users: { 4: { name: 'new', id: '4' } } })
-        const user = this.brain.userForId('4')
-        expect(user.constructor.name).to.equal('User')
-        expect(user.id).to.equal('4')
-        expect(user.name).to.equal('new')
-        expect(isCircular(this.brain)).to.be.false
-      })
-    })
-
-    describe('#save', () => it('emits a save event', function () {
-      sinon.spy(this.brain, 'emit')
-      this.brain.save()
-      expect(this.brain.emit).to.have.been.calledWith('save', this.brain.data)
-    }))
-
-    describe('#resetSaveInterval', () => it('updates the auto-save interval', function () {
-      sinon.spy(this.brain, 'save')
-      // default is 5s
-      this.brain.resetSaveInterval(10)
-      // make sure autosave is on
-      this.brain.setAutoSave(true)
-
-      this.clock.tick(5000)
-      // old interval has passed
-      expect(this.brain.save).to.not.have.been.called
-      this.clock.tick(5000)
-      // new interval has passed
-      expect(this.brain.save).to.have.been.calledOnce
-    }))
-
-    describe('#close', function () {
-      it('saves', function () {
-        sinon.spy(this.brain, 'save')
-        this.brain.close()
-        expect(this.brain.save).to.have.been.calledOnce
-      })
-
-      it('emits a close event', function () {
-        sinon.spy(this.brain, 'emit')
-        this.brain.close()
-        expect(this.brain.emit).to.have.been.calledWith('close')
-      })
-
-      it('saves before emitting the close event', function () {
-        sinon.spy(this.brain, 'save')
-        sinon.spy(this.brain, 'emit').withArgs('close')
-        this.brain.close()
-        expect(this.brain.save).to.have.been.calledBefore(this.brain.emit)
-      })
-
-      it('stops auto-saving', function () {
-        // make sure autosave is on
-        this.brain.setAutoSave(true)
-        this.brain.close()
-
-        // set up the spy after because 'close' calls 'save'
-        sinon.spy(this.brain, 'save')
-
-        this.clock.tick(2 * 5000)
-        expect(this.brain.save).to.not.have.been.called
-      })
-    })
-
-    describe('#get', function () {
-      it('returns the saved value', function () {
-        this.brain.data._private['test-key'] = 'value'
-        expect(this.brain.get('test-key')).to.equal('value')
-      })
-
-      it('returns null if object is not found', function () {
-        expect(this.brain.get('not a real key')).to.be.null
-      })
-    })
-
-    describe('#set', function () {
-      it('saves the value', function () {
-        this.brain.set('test-key', 'value')
-        expect(this.brain.data._private['test-key']).to.equal('value')
-      })
-
-      it('sets multiple keys at once if an object is provided', function () {
-        this.brain.data._private = {
-          key1: 'val1',
-          key2: 'val1'
-        }
-
-        this.brain.set({
-          key2: 'val2',
-          key3: 'val2'
-        })
-
-        expect(this.brain.data._private).to.deep.equal({
-          key1: 'val1',
-          key2: 'val2',
-          key3: 'val2'
-        })
-      })
-
-      // Unable to understand why this behavior is needed, but adding a test
-      // case to protect it
-      it('emits loaded', function () {
-        sinon.spy(this.brain, 'emit')
-        this.brain.set('test-key', 'value')
-        expect(this.brain.emit).to.have.been.calledWith('loaded', this.brain.data)
-      })
-
-      it('returns the brain', function () {
-        expect(this.brain.set('test-key', 'value')).to.equal(this.brain)
-      })
-    })
-
-    describe('#remove', () => it('removes the specified key', function () {
-      this.brain.data._private['test-key'] = 'value'
-      this.brain.remove('test-key')
-      expect(this.brain.data._private).to.not.include.keys('test-key')
-    }))
-
-    describe('#userForId', function () {
-      it('returns the user object', function () {
-        expect(this.brain.userForId(1)).to.equal(this.user1)
-      })
-
-      it('does an exact match', function () {
-        const user4 = this.brain.userForId('FOUR')
-        expect(this.brain.userForId('four')).to.not.equal(user4)
-      })
-
-      // Cannot understand why this behavior is needed, but adding a test case
-      // to protect it
-      it('recreates the user if the room option differs from the user object', function () {
-        expect(this.brain.userForId(1).room).to.be.undefined
-
-        // undefined -> having a room
-        const newUser1 = this.brain.userForId(1, { room: 'room1' })
-        expect(newUser1).to.not.equal(this.user1)
-
-        // changing the room
-        const newUser2 = this.brain.userForId(1, { room: 'room2' })
-        expect(newUser2).to.not.equal(newUser1)
-      })
-
-      describe('when there is no matching user ID', function () {
-        it('creates a new User', function () {
-          expect(this.brain.data.users).to.not.include.key('all-new-user')
-          const newUser = this.brain.userForId('all-new-user')
-          expect(newUser).to.be.instanceof(User)
-          expect(newUser.id).to.equal('all-new-user')
-          expect(this.brain.data.users).to.include.key('all-new-user')
-        })
-
-        it('passes the provided options to the new User', function () {
-          const newUser = this.brain.userForId('all-new-user', { name: 'All New User', prop: 'mine' })
-          expect(newUser.name).to.equal('All New User')
-          expect(newUser.prop).to.equal('mine')
-        })
-      })
-    })
-
-    describe('#userForName', function () {
-      it('returns the user with a matching name', function () {
-        expect(this.brain.userForName('Guy One')).to.equal(this.user1)
-      })
-
-      it('does a case-insensitive match', function () {
-        expect(this.brain.userForName('guy one')).to.equal(this.user1)
-      })
-
-      it('returns null if no user matches', function () {
-        expect(this.brain.userForName('not a real user')).to.be.null
-      })
-    })
-
-    describe('#usersForRawFuzzyName', function () {
-      it('does a case-insensitive match', function () {
-        expect(this.brain.usersForRawFuzzyName('guy')).to.have.members([this.user1, this.user2])
-      })
-
-      it('returns all matching users (prefix match) when there is not an exact match (case-insensitive)', function () {
-        expect(this.brain.usersForRawFuzzyName('Guy')).to.have.members([this.user1, this.user2])
-      })
-
-      it('returns all matching users (prefix match) when there is an exact match (case-insensitive)', function () {
-        // Matched case
-        expect(this.brain.usersForRawFuzzyName('Guy One')).to.deep.equal([this.user1, this.user2])
-        // Mismatched case
-        expect(this.brain.usersForRawFuzzyName('guy one')).to.deep.equal([this.user1, this.user2])
-      })
-
-      it('returns an empty array if no users match', function () {
-        const result = this.brain.usersForRawFuzzyName('not a real user')
-        expect(result).to.be.an('array')
-        expect(result).to.be.empty
-      })
-    })
-
-    describe('#usersForFuzzyName', function () {
-      it('does a case-insensitive match', function () {
-        expect(this.brain.usersForFuzzyName('guy')).to.have.members([this.user1, this.user2])
-      })
-
-      it('returns all matching users (prefix match) when there is not an exact match', function () {
-        expect(this.brain.usersForFuzzyName('Guy')).to.have.members([this.user1, this.user2])
-      })
-
-      it('returns just the user when there is an exact match (case-insensitive)', function () {
-        // Matched case
-        expect(this.brain.usersForFuzzyName('Guy One')).to.deep.equal([this.user1])
-        // Mismatched case
-        expect(this.brain.usersForFuzzyName('guy one')).to.deep.equal([this.user1])
-      })
-
-      it('returns an empty array if no users match', function () {
-        const result = this.brain.usersForFuzzyName('not a real user')
-        expect(result).to.be.an('array')
-        expect(result).to.be.empty
-      })
-    })
-  })
-
-  describe('Auto-Save', function () {
-    it('is on by default', function () {
-      expect(this.brain.autoSave).to.equal(true)
-    })
-
-    it('automatically saves every 5 seconds when turned on', function () {
-      sinon.spy(this.brain, 'save')
-
-      this.brain.setAutoSave(true)
-
-      this.clock.tick(5000)
-      expect(this.brain.save).to.have.been.called
-    })
-
-    it('does not auto-save when turned off', function () {
-      sinon.spy(this.brain, 'save')
-
-      this.brain.setAutoSave(false)
-
-      this.clock.tick(2 * 5000)
-      expect(this.brain.save).to.not.have.been.called
-    })
-  })
-
-  describe('User Searching', function () {
-    it('finds users by ID', function () {
-      expect(this.brain.userForId('1')).to.equal(this.user1)
-    })
-
-    it('finds users by exact name', function () {
-      expect(this.brain.userForName('Guy One')).to.equal(this.user1)
-    })
-
-    it('finds users by fuzzy name (prefix match)', function () {
-      const result = this.brain.usersForFuzzyName('Guy')
-      expect(result).to.have.members([this.user1, this.user2])
-      expect(result).to.not.have.members([this.user3])
-    })
-
-    it('returns User objects, not POJOs', function () {
-      expect(this.brain.userForId('1').constructor.name).to.equal('User')
-      for (const user of this.brain.usersForFuzzyName('Guy')) {
-        expect(user.constructor.name).to.equal('User')
-      }
-
-      for (const user of this.brain.usersForRawFuzzyName('Guy One')) {
-        expect(user.constructor.name).to.equal('User')
-      }
-
-      expect(isCircular(this.brain)).to.be.false
-    })
-  })
-})

package/test/datastore_test.js

@@ -1,154 +0,0 @@
-'use strict'
-
-/* global describe, beforeEach, it */
-
-const chai = require('chai')
-const sinon = require('sinon')
-chai.use(require('sinon-chai'))
-
-const expect = chai.expect
-
-const Brain = require('../src/brain')
-const InMemoryDataStore = require('../src/datastores/memory')
-
-describe('Datastore', function () {
-  beforeEach(function () {
-    this.clock = sinon.useFakeTimers()
-    this.robot = {
-      emit () {},
-      on () {},
-      receive: sinon.spy()
-    }
-
-    // This *should* be callsArgAsync to match the 'on' API, but that makes
-    // the tests more complicated and seems irrelevant.
-    sinon.stub(this.robot, 'on').withArgs('running').callsArg(1)
-
-    this.robot.brain = new Brain(this.robot)
-    this.robot.datastore = new InMemoryDataStore(this.robot)
-    this.robot.brain.userForId('1', { name: 'User One' })
-    this.robot.brain.userForId('2', { name: 'User Two' })
-  })
-
-  this.afterEach(function () {
-    this.clock.restore()
-  })
-
-  describe('global scope', function () {
-    it('returns undefined for values not in the datastore', function () {
-      return this.robot.datastore.get('blah').then(function (value) {
-        expect(value).to.be.an('undefined')
-      })
-    })
-
-    it('can store simple values', function () {
-      return this.robot.datastore.set('key', 'value').then(() => {
-        return this.robot.datastore.get('key').then((value) => {
-          expect(value).to.equal('value')
-        })
-      })
-    })
-
-    it('can store arbitrary JavaScript values', function () {
-      const object = {
-        name: 'test',
-        data: [1, 2, 3]
-      }
-      return this.robot.datastore.set('key', object).then(() => {
-        return this.robot.datastore.get('key').then((value) => {
-          expect(value.name).to.equal('test')
-          expect(value.data).to.deep.equal([1, 2, 3])
-        })
-      })
-    })
-
-    it('can dig inside objects for values', function () {
-      const object = {
-        a: 'one',
-        b: 'two'
-      }
-      return this.robot.datastore.set('key', object).then(() => {
-        return this.robot.datastore.getObject('key', 'a').then((value) => {
-          expect(value).to.equal('one')
-        })
-      })
-    })
-
-    it('can set individual keys inside objects', function () {
-      const object = {
-        a: 'one',
-        b: 'two'
-      }
-      return this.robot.datastore.set('object', object).then(() => {
-        return this.robot.datastore.setObject('object', 'c', 'three').then(() => {
-          return this.robot.datastore.get('object').then((value) => {
-            expect(value.a).to.equal('one')
-            expect(value.b).to.equal('two')
-            expect(value.c).to.equal('three')
-          })
-        })
-      })
-    })
-
-    it('creates an object from scratch when none exists', function () {
-      return this.robot.datastore.setObject('object', 'key', 'value').then(() => {
-        return this.robot.datastore.get('object').then((value) => {
-          const expected = { key: 'value' }
-          expect(value).to.deep.equal(expected)
-        })
-      })
-    })
-
-    it('can append to an existing array', function () {
-      return this.robot.datastore.set('array', [1, 2, 3]).then(() => {
-        return this.robot.datastore.setArray('array', 4).then(() => {
-          return this.robot.datastore.get('array').then((value) => {
-            expect(value).to.deep.equal([1, 2, 3, 4])
-          })
-        })
-      })
-    })
-
-    it('creates an array from scratch when none exists', function () {
-      return this.robot.datastore.setArray('array', 4).then(() => {
-        return this.robot.datastore.get('array').then((value) => {
-          expect(value).to.deep.equal([4])
-        })
-      })
-    })
-  })
-
-  describe('User scope', function () {
-    it('has access to the robot object', function () {
-      const user = this.robot.brain.userForId('1')
-      expect(user._getRobot()).to.equal(this.robot)
-    })
-
-    it('can store user data which is separate from global data', function () {
-      const user = this.robot.brain.userForId('1')
-      return user.set('blah', 'blah').then(() => {
-        return user.get('blah').then((userBlah) => {
-          return this.robot.datastore.get('blah').then((datastoreBlah) => {
-            expect(userBlah).to.not.equal(datastoreBlah)
-            expect(userBlah).to.equal('blah')
-            expect(datastoreBlah).to.be.an('undefined')
-          })
-        })
-      })
-    })
-
-    it('stores user data separate per-user', function () {
-      const userOne = this.robot.brain.userForId('1')
-      const userTwo = this.robot.brain.userForId('2')
-      return userOne.set('blah', 'blah').then(() => {
-        return userOne.get('blah').then((valueOne) => {
-          return userTwo.get('blah').then((valueTwo) => {
-            expect(valueOne).to.not.equal(valueTwo)
-            expect(valueOne).to.equal('blah')
-            expect(valueTwo).to.be.an('undefined')
-          })
-        })
-      })
-    })
-  })
-})