hanu

Golang Framework for writing Slack bots

Description

The Go framework hanu is your best friend to create Slack bots! hanu uses platzhalter for easy command parsing (e.g. whisper ) and runs fine as a Heroku worker. All you need is a Slack API token and you can create your first bot within seconds! Just have a look at the hanu-example bot …

Programming language: Go

License: MIT License

Tags: Bot     Utility     Text Processing     Third-party APIs     Messaging     Slack     Chat     Instant Messaging    

Latest version: v0.1.0

README

hanu - Go for Slack Bots!

The Go framework hanu is your best friend to create Slack bots! hanu uses allot for easy command and request parsing (e.g. whisper <word>) and runs fine as a Heroku worker. All you need is a Slack API token and you can create your first bot within seconds! Just have a look at the hanu-example bot or read my tutorial …

Features

• Respond to mentions
• Respond to direct messages
• Auto-Generated command list for help
• Works fine as a worker on Heroku

Usage

Use the following example code or the hanu-example bot to get started.

package main

import (
    "log"
    "strings"

    "github.com/sbstjn/hanu"
)

func main() {
    slack, err := hanu.New("SLACK_BOT_API_TOKEN")

    if err != nil {
        log.Fatal(err)
    }

    Version := "0.0.1"

    slack.Command("shout <word>", func(conv hanu.ConversationInterface) {
        str, _ := conv.String("word")
        conv.Reply(strings.ToUpper(str))
    })

    slack.Command("whisper <word>", func(conv hanu.ConversationInterface) {
        str, _ := conv.String("word")
        conv.Reply(strings.ToLower(str))
    })

    slack.Command("version", func(conv hanu.ConversationInterface) {
        conv.Reply("Thanks for asking! I'm running `%s`", Version)
    })

    slack.Listen()
}

The example code above connects to Slack using SLACK_BOT_API_TOKEN as the bot's token and can respond to direct messages and mentions for the commands shout <word> , whisper <word> and version.

You don't have to care about help requests, hanu has it built in and will respond with a list of all defined commands on direct messages like this:

/msg @hanu help

Of course this works fine with mentioning you bot's username as well:

@hanu help

Slack

Use direct messages for communication:

/msg @hanu version

Or use the bot in a public channel:

@hanu version

Dependencies

• github.com/sbstjn/allot for parsing cmd <param1:string> <param2:integer> strings
• golang.org/x/net/websocket for websocket communication with Slack

Credits

• Host Go Slackbot on Heroku
• OpsDash article about Slack Bot