reservebot

A Slackbot for reserving shared resources.

Features

reservebot lets you and your team reserve shared resources and provides a queue for waiting for resources. Currently, reservebot stores reservations in memory so reservations will be lost on restart.

Running

Locally on host machine

You will need to set up an application in your Slack admin for reservebot.

To run locally, you will need to use a tool to open up your machine to incoming requests. I suggest ngrok.

In one window:

$ ngrok http 666

ngrok will give you a URL to use for incoming requests.

In a second window:

$ go build reservebot.go
$ ./reservebot -token "<YOUR_SLACK_TOKEN>" -challenge "<SLACK_VERIFICATION_TOKEN>"

Then in Slack, set up "event subscriptions" for <ngrok url from your terminal>/events.

Docker

The docker run uses environment variables. The following are supported - SLACK_TOKEN, SLACK_CHALLENGE, LISTEN_PORT, DEBUG, SLACK_ADMINS, REQUIRE_RESOURCE_ENV, PRUNE_ENABLED, PRUNE_INTERVAL, PRUNE_EXPIRE.

Run docker as follows:

$ docker build -t reservebot .
$ docker run [-d] -p 666:666 reservebot -e SLACK_TOKEN=<YOUR_SLACK_TOKEN> -e SLACK_CHALLENGE=<SLACK_VERIFICATION_TOKEN>

Setting up Slack

In Slack...

1. Set up "event subscriptions" for <url>/events. Subscribe to these bot events:
   • app_mention : app_mentions:read
   • message.im : im:history
2. Set up these "OAuth & Permissions":
   • Bot Token Scopes
     • app_mentions:read
     • channels:history
     • channels:read
     • chat:write
     • chat:write.customize
     • groups:history
     • groups:read
     • im:history
     • im:read
     • im:write
     • users.profile:read
     • usergroups:read
     • users:read

Usage

@reservebot can be used via any channel that it has been added to or via DM. Regardless of where you invoke a command, there is a single reservation system that will be shared.

@reservebot can handle multiple environments or namespaces. A resource is defined as env|name. If you omit the environment/namespace and it is not required, the global environment will be used.

When invoking via DM, the bot will alert other users via DM when necessary. E.g. Releasing a resource will notify the next user that has it.

By default, resources must be in the format of namespace|resource. However, if you do not have a need to use namespaces, you can disable this at runtime using the argument --require-resource-env=false

The default listen port is 666 but can be overridden with --listen-port=667

--admins=<slackuser1>,<slackuser2> can be specified to restrict the prune, nuke, and kick commands to people on this list. This is to prevent anyone from accidentally running these commands. Not specifying --admins allows all users to run these commands.

Pruning is enabled by default, it can be disabled by setting --prune-enabled=false. The prune interval can be changed from the default of 1 hour by using --prune-interval=6. The expiration time for resources can be changed from the default of 1 week by using --prune-expire=24.

Commands

When invoking within a channel, you must @-mention the bot by adding @reservebot to the beginning of your command.

create <resource>

This will create a resource with no reservations.

reserve <resource>

This will reserve a given resource for the user. If the resource is currently reserved, the user will be placed into the queue. The resource should be an alphanumeric string with no spaces. A comma-separted list can be used to reserve multiple resources.

release <resource>

This will release a given resource. This command must be executed by the person who holds the resource. Upon release, the next person waiting in line will be notified that they now have the resource. The resource should be an alphanumeric string with no spaces. A comma-separted list can be used to reserve multiple resources.

status

This will provide a status of all active resources.

my status

This will provide a status for all active and waiting resources for the user.

status <resource>

This will provide a status of a given resource.

remove resource <resource>

This will remove the resource if the queue is empty.

remove me from <resource>

This will remove the user from the queue for a resource.

clear <resource>

This will clear the queue for a given resource and release it.

prune

This will remove all resoures that are not reserved and have no active queue.

kick <@user>

This will kick the mentioned user from all resources they are holding. As the user is kicked from each resource, the queue will be advanced to the next user waiting.

nuke

This will clear all reservations and all queues for all resources. This can only be done from a public channel, not a DM. There is no confirmation, so be careful.