Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abourget/slick
Slick, a Slack bot in Go
https://github.com/abourget/slick
bot bot-framework conversational-ui golang slack slack-bot
Last synced: 4 days ago
JSON representation
Slick, a Slack bot in Go
- Host: GitHub
- URL: https://github.com/abourget/slick
- Owner: abourget
- Created: 2015-05-18T12:27:09.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-20T10:08:40.000Z (about 6 years ago)
- Last Synced: 2024-04-15T02:44:08.576Z (7 months ago)
- Topics: bot, bot-framework, conversational-ui, golang, slack, slack-bot
- Language: Go
- Homepage:
- Size: 3.71 MB
- Stars: 150
- Watchers: 6
- Forks: 32
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Slick - A Slack bot in Go
[](https://drone.io/github.com/abourget/slick/latest)
Slick is a Slack bot to do ChatOps and other cool things.
## Features
Supported features:
* Plugin interface for chat messages
* Plugin-based HTTP handlers
* Simple API to reply to users
* Keeps an internal state of channels, users and their state.
* Listen for Reactions; take actions based on them (like buttons).
* Simple API to message users privately
* Simple API to update a previously sent message
* Simple API to delete bot messages after a given time duration.
* Easy plugin interface, listeners with criterias like:
* Messages directed to the bot only
* Private or public messages
* Listens for a duration or until a given `time.Time`
* Selectively on a channel, or from a user
* Expire listeners and unregister them dynamically
* Supports listening for edits or not
* Regexp match messages, or Contains checks
* Built-in KV store for data persistence (backed by BoltDB and JSON serialization)
* The bot has a mood (_happy_ and _hyper_) which changes randomly.. you can base some decisions on it, to spice up conversations.
* Supports listening for any Slack events (ChannelCreated, ChannelJoined, EmojiChanged, FileShared, GroupArchived, etc..)
* A PubSub system to facilitate inter-plugins (or chat-to-web) communications.
## Stock plugins
1. Recognition: a plugin to recognize your peers (!recognize @user1 for doing an awesome job)
2. Faceoff: a game to learn the names and faces of your colleagues. The code for this one is interesting to learn to build interactive features with `slick`.
3. Vote: a simple voting plugin to decide where to lunch
4. Funny: a bunch of jokes and memes in reply to some strings in channels.. (inspired by Hubot's jokes)
5. Healthy: a very simple plugin that pokes URLs and reports on their health
6. Deployer: an example plugin to do deployments wth ansible (you'll probably want to roll out your own though).
7. Todo: todo list manager, one per channel
## Local build and install
Try it with:
```
go get github.com/abourget/slick
cd $GOPATH/src/github.com/abourget/slick/example-bot
go install -v && $GOPATH/bin/example-bot
```
Copy the `slick.sample.conf` file to `$HOME/.slick` and tweak at will.
You might need `mercurial` installed to get some dependencies.
## Writing your own plugin
Example code to handle deployments:
```
// listenDeploy was hooked into a plugin elsewhere..
func listenDeploy() {
keywords := []string{"project1", "project2", "project3"}
bot.Listen(&slick.Listener{
Matches: regexp.MustCompile("(can you|could you|please|plz|c'mon|icanhaz) deploy (" + strings.Join(keywords, "|") + ") (with|using)( revision| commit)? `?([a-z0-9]{4,42})`?"),
MentionsMeOnly: true,
MessageHandlerFunc: func(listen *slick.Listener, msg *slick.Message) {
projectName := msg.Match[2]
revision := msg.Match[5]
go func() {
go msg.AddReaction("work_hard")
defer msg.RemoveReaction("work_hard")
// Do the deployment with projectName and revision...
}()
},
})
}
```
Take inspiration by looking at the different plugins, like `Funny`,
`Healthy`, `Storm`, `Deployer`, etc.. Don't forget to update your
bot's plugins list, like in `example-bot/main.go`