go-chat-bot

IRC, Slack, Telegram and RocketChat bot written in go

Programming language: Go

License: MIT License

Tags: Miscellaneous    

README

go-bot

IRC, Slack & Telegram bot written in Go using go-ircevent for IRC connectivity, nlopes/slack for Slack and Syfaro/telegram-bot-api for Telegram.

Plugins

Please see the plugins repository for a complete list of plugins.

You can also write your own, it's really simple.

Compiling and testing the bot and plugins (Debug)

This project uses the new Go 1.11 modules if you have Go 1.11 installed, just clone the project and follow the instructions bellow, when you build Go will automatically download all dependencies.

To test the bot, use the debug console app.

• Clone this repository or use go get github.com/go-chat-bot/bot
• Build everything: go build ./...
• Build and execute the debug app:
  • cd debug
  • go build
  • ./debug
• This will open a console where you can type commands
• Type !help to see the list of available commands

Testing your plugin

• Add your plugin to debug/main.go import list
• Build the debug app
• Execute it and test with the interactive console

Protocols

Slack

To deploy your go-bot to Slack, you need to:

• Create a new bot user integration on Slack and get your token
• Import the package github.com/go-chat-bot/bot/slack
• Import the commands you would like to use
• Call slack.Run(token)

Here is a full example reading the Slack token from the SLACK_TOKEN env var:

package main

import (
    "os"

    "github.com/go-chat-bot/bot/slack"
    _ "github.com/go-chat-bot/plugins/catfacts"
    _ "github.com/go-chat-bot/plugins/catgif"
    _ "github.com/go-chat-bot/plugins/chucknorris"
    // Import all the commands you wish to use
)

func main() {
    slack.Run(os.Getenv("SLACK_TOKEN"))
}

IRC

To deploy your own go-bot to IRC, you need to:

• Import the package github.com/go-chat-bot/bot/irc
• Import the commands you would like to use
• Fill the Config struct
• Call irc.Run(config)

Here is a full example:

package main

import (
    "github.com/go-chat-bot/bot/irc"
    _ "github.com/go-chat-bot/plugins/catfacts"
    _ "github.com/go-chat-bot/plugins/catgif"
    _ "github.com/go-chat-bot/plugins/chucknorris"
    // Import all the commands you wish to use
    "os"
    "strings"
)

func main() {
    irc.Run(&irc.Config{
        Server:   os.Getenv("IRC_SERVER"),
        Channels: strings.Split(os.Getenv("IRC_CHANNELS"), ","),
        User:     os.Getenv("IRC_USER"),
        Nick:     os.Getenv("IRC_NICK"),
        Password: os.Getenv("IRC_PASSWORD"),
        UseTLS:   true,
        Debug:    os.Getenv("DEBUG") != "",})
}

To join channels with passwords just put the password after the channel name separated by a space:

Channels: []string{"#mychannel mypassword", "#go-bot"}

Telegram

To deploy your go-bot to Telegram, you need to:

• Follow Telegram instructions to create a new bot user and get your token
• Import the package github.com/go-chat-bot/bot/telegram
• Import the commands you would like to use
• Call telegram.Run(token, debug)

Here is a full example reading the telegram token from the TELEGRAM_TOKEN env var:

package main

import (
    "os"

    "github.com/go-chat-bot/bot/telegram"
    _ "github.com/go-chat-bot/plugins/catfacts"
    _ "github.com/go-chat-bot/plugins/catgif"
    _ "github.com/go-chat-bot/plugins/chucknorris"
    // Import all the commands you wish to use
)

func main() {
    telegram.Run(os.Getenv("TELEGRAM_TOKEN"), os.Getenv("DEBUG") != "")
}

Rocket.chat

To deploy your go-bot to Rocket.chat, you need to:

• Import the package github.com/go-chat-bot/bot/rocket
• Import the commands you would like to use
• Call rocket.Run(config)

Here is a full example:

package main

import (
    "os"

    "github.com/go-chat-bot/bot/rocket"
    _ "github.com/go-chat-bot/plugins/godoc"
    _ "github.com/go-chat-bot/plugins/catfacts"
    _ "github.com/go-chat-bot/plugins/catgif"
    _ "github.com/go-chat-bot/plugins/chucknorris"
)

func main() {
    config := &rocket.Config{
        Server:   os.Getenv("ROCKET_SERVER"),
        Port:     os.Getenv("ROCKET_PORT"),
        User:     os.Getenv("ROCKET_USER"),
        Email:    os.Getenv("ROCKET_EMAIL"),
        Password: os.Getenv("ROCKET_PASSWORD"),
        UseTLS:   false,
        Debug:    os.Getenv("DEBUG") != "",
    }
    rocket.Run(config)
}

Google Chat

To deploy your go-bot to Google Chat (also known as Hangouts Chat, not plain Hangouts) you will first need to follow documentation to setup pub/sub project in Google Cloud. This will enable your bot to receive messages even when it is behind a firewall.

Condensed, the steps you will need to take are as follows:

• Create new project in google cloud console
  • ID of the project will be used in Config.PubSubProject
• Create service credentials for this project
  • Path to downloaded credentials file should be in env variable GOOGLE_APPLICATION_CREDENTIALS
  • Choose "Pub/Sub Editor" role for the credential
• Enable Pub/Sub API in cloud console
• Create new topic in the Pub/Sub (say "google-chat")
  • Use the value of "Topic Name" (not "Topic ID") for Config.TopicName (e.g. /project//topics/)
• Modify permissions on created topic so that "[email protected]" has Pub/Sub Publisher permissions
• Enable hangouts chat api in Cloud Console
• Go to hangouts chat API config in the Cloud Console and fill in info
  • Connection settings - use Pub/Sub and fill in topic string you created above

Config.SubscriptionName should be unique for each environment or you'll not process messages correctly. If you encounter issues make sure your credentials are correct and permissions for topics/queues are set up correctly.

Config.WelcomeMessage is sent each time the bot joins a new room or private chat.

Full example is here:

package main

import (
    "os"

    "github.com/go-chat-bot/bot/google-chat"
    _ "github.com/go-chat-bot/plugins/godoc"
    _ "github.com/go-chat-bot/plugins/catfacts"
    _ "github.com/go-chat-bot/plugins/catgif"
    _ "github.com/go-chat-bot/plugins/chucknorris"
)

func main() {
    googlechat.Run(&googlechat.Config{
        PubSubProject:    os.Getenv("HANGOUTS_PROJECT"),
        TopicName:        os.Getenv("HANGOUTS_TOPIC"),
        SubscriptionName: os.Getenv("HANGOUTS_SUB"),
        WelcomeMessage:   os.Getenv("HANGOUTS_WELCOME"),
}

Deploying your own bot

To see an example project on how to deploy your bot, please see my own configuration:

• IRC: https://github.com/fabioxgn/go-bot-heroku
• Slack: https://github.com/fabioxgn/go-bot-slack