bopher

README

Bopher

Bot + Gopher = Bopher

Bopher is client application connecting Mattermost(3.3.0~) as Bot. You can call Gopher from chat!

Requirements

• Mattermost 3.3.0~
• mattn/gopher binary file (named gopher.exe)

Setup

1. Build gopher binary

• mattn/gopher

2. Write config.json

{
  // Your Mattermost settings
  "mattermost": {
    "host": "localhost",
    "port": "8065",
    "bot": {
      "email": "admin@example.com",
      "password": "admin",
      "name": "Bot",
      "first_name": "Go",
      "last_name": "Bot"
    },
    "team": "tttt",
    "channel": {
      "name":"botting",
      "display_name": "BotRoom",
      "purpose": "bot_test"
    }
  },
  // path to gopher.exe (Even if you use windows, this value is like `$GOPATH` not `%GOPATH%`)
  // details -> https://github.com/golang/go/issues/8469
  "gopher": "$GOPATH/bin/gopher.exe",

  // The maximum number of gophers on display
  // If you set a large number, gopher will eat all of your machine resource)
  "max_of_gophers": 10                 
}

3. Run bopher

go run main.go

4. Call gopher on mattermost

Commands

Message	Action
gopher	Call a gopher
bye gopher	kill all gophers 😱
jump gopher	jump all existing gophers
hello gopher	a gopher say hello
whats gopher?	r u sure?

License

This code is provided under the MIT license.

Documentation

Index

• Constants
• func CreateBotDebuggingChannelIfNeeded(ch Channel)
• func FindBotTeam(t string)
• func HandleMsgFromDebuggingChannel(event *model.WebSocketEvent)
• func HandleWebSocketResponse(event *model.WebSocketEvent)
• func InitialLoad()
• func LoginAsTheBotUser(bot Bot)
• func MakeSureServerIsRunning()
• func PrintError(err *model.AppError)
• func Run()
• func RunBot(config Config)
• func SendMsgToDebuggingChannel(msg string, replyToId string)
• func SetupGracefulShutdown()
• func UpdateTheBotUserIfNeeded(bot Bot)
• type Bot
• type Channel
• type Config
• type Mattermost
  • func (m *Mattermost) HttpURL() string
  • func (m *Mattermost) WsURL() string
• type Service

Constants

const ConfigFileName = "config.json"

Functions

func CreateBotDebuggingChannelIfNeeded

func CreateBotDebuggingChannelIfNeeded(ch Channel)

func FindBotTeam

func FindBotTeam(t string)

func HandleMsgFromDebuggingChannel

func HandleMsgFromDebuggingChannel(event *model.WebSocketEvent)

func HandleWebSocketResponse

func HandleWebSocketResponse(event *model.WebSocketEvent)

func InitialLoad

func InitialLoad()

func LoginAsTheBotUser

func LoginAsTheBotUser(bot Bot)

func MakeSureServerIsRunning

func MakeSureServerIsRunning()

func PrintError

func PrintError(err *model.AppError)

func Run

func Run()

func RunBot

func RunBot(config Config)

Documentation for the Go driver can be found at https://godoc.org/github.com/mattermost/platform/model#Client

func SendMsgToDebuggingChannel

func SendMsgToDebuggingChannel(msg string, replyToId string)

func SetupGracefulShutdown

func SetupGracefulShutdown()

func UpdateTheBotUserIfNeeded

func UpdateTheBotUserIfNeeded(bot Bot)

Types

type Bot

type Bot struct {
	Email    string `json:"email"`
	Password string `json:"password"`
	Name     string `json:"name"`
	First    string `json:"first_name"`
	Last     string `json:"last_name"`
}

type Channel

type Channel struct {
	Name        string `json:"name"`
	DisplayName string `json:"display_name"`
	Purpose     string `json:"purpose"`
}

type Config

type Config struct {
	Mattermost   Mattermost `json:"mattermost"`
	Gopher       string     `json:"gopher"`
	MaxOfGophers int        `json:"max_of_gophers"`
}

type Mattermost

type Mattermost struct {
	Host    string  `json:"host"`
	Port    string  `json:"port"`
	Bot     Bot     `json:"bot"`
	Team    string  `json:"team"`
	Channel Channel `json:"channel"`
}

func (*Mattermost) HttpURL

func (m *Mattermost) HttpURL() string

func (*Mattermost) WsURL

func (m *Mattermost) WsURL() string

type Service

type Service struct {
	Gopher       string
	MaxOfGophers int
}