Framework for making bots with go

• Modes
  • Debug -> debug your bot from the terminal
  • Telegram -> based on tucnak/telebot.v2
• Plugins
  • Reactor -> Send something after a message
  • Conversational -> It helps you to create conversational commands without loosing the current user state

Bot

b, err := got.NewBot( got.BotSettings{
    Token: myTelegramToken,
    Mode: got.ModeDebug,
    Plugins: []got.Plugin{ yourplugin },
})

Reactor Plugin

Plugin creation

sayhello, _ := got.NewPlugin( got.ReactorSettings{
    Name: "sayhello",
    Trigger: "/hello", // can be a regex with regexp prefix -> "regexp (hi|hello)"
    Events: SayHelloEvents{},
})

Events

type SayHelloEvents struct {}

func ( actions SayHelloEvents ) OnBotInit( ctx *got.ReactorCtx ) {
    // Things to do when your bot starts for the first time
}

func ( actions SayHelloEvents ) OnText( ctx *got.ReactorCtx ) {
    t := fmt.Sprintf("Hello %s!", msg.Sender.Name)
    ctx.Bot.SendMessage(t, msg.Sender)
}

Conversational Plugin

Plugin creation

Colors, _ := got.NewPlugin( got.ConversationalSettings{
    Name: "colors",
    Trigger: "/colors",
    States: ColorsStates,
    Events: ColorsEvents{},
    RemindEvery: 2 * 60 * 1000, // reminds every to 2 minutes -> Milliseconds
    ExpireAfter: 10 * 60 * 1000, // 10 minutes -> Milliseconds
    // Storage: YourCustomStorage that follow got.PluginStorage interface
})

Events

type ColorsEvents struct {}

func ( actions ColorsEvents ) OnBotInit( ctx *ConversationalCtx ) {
}

func ( actions ColorsEvents ) OnSessionStart( ctx *ConversationalCtx ) {
}

func ( actions ColorsEvents ) OnSessionExpired( ctx *ConversationalCtx ) {
}

func ( actions ColorsEvents ) OnSessionRemind( ctx *ConversationalCtx ) {
}

func ( actions ColorsEvents ) OnSessionEnd( ctx *ConversationalCtx ) {
    
}

func ( actions ColorsEvents ) OnAnswer( ctx *ConversationalCtx ) {
}

States

type StateFn func( ctx *ConversationalCtx )
type States []StateFn

State example

var ColorsStates got.States = got.States{

    func( ctx *got.ConversationalCtx ) {
        ctx.Bot.SendMessage( "What color do you like?", ctx.User )
        ctx.Session.WaitForAnswer(ctx)
    },

    func( ctx *got.ConversationalCtx ) {
        ctx.Bot.SendMessage( "Are you sure? (yes, no)", ctx.User )
        ctx.Session.WaitForAnswer(ctx)
    },

    func( ctx *got.ConversationalCtx ) {
        
        switch ctx.Answer.Text {
            case "yes":
                ctx.Bot.SendMessage('Thank you!', ctx.User)
                ctx.Session.End(ctx)
            
            case "no":
                ctx.Bot.SendMessage('Ok, what color do you like?', ctx.User)
                ctx.Session.StayHere(ctx)
            
            default: 
                ctx.Bot.SendMessage('Permitted answers (yes, no)', ctx.User)
                ctx.Session.Error(ctx)
        }
    }
}

Storage Interface

type PluginStorage interface {
    GetSessionByUserId(id string) (*UserState, bool)
    SetSessionForUserId(id string, state *UserState)
    DeleteSessionForUserId(id string)
}

In memory storage example

type MapPluginStorage struct {
    sessions map[string]*UserState
}

func (storage *MapPluginStorage) GetSessionByUserId(id string) (*UserState, bool) {
    state, ok := storage.sessions[id]
    return state, ok
}

func (storage *MapPluginStorage) SetSessionForUserId(id string, state *UserState) {
    storage.sessions[id] = state
}

func (storage *MapPluginStorage) DeleteSessionForUserId(id string) {
    delete(storage.sessions, id)
}

Keyboard Markup

markup := &got.ReplyMarkup{
    ReplyKeyboard: [][]got.ReplyButton{
        []got.ReplyButton{
            got.ReplyButton{Text: "yes"},
            got.ReplyButton{Text: "no"},
        },
    },
})

bot.SendMessage("Are you sure", sender, markup)