botsframework

🏋️ Strongo Bots Go Framework

A Go language framework to develop bots for messengers.

Developed & shared by Sneat-co & Strongo teams.

Reasons to use:

• Same code can work across different messenger (Telegram, Facebook Messenger, Viber, Skype, Line, Kik, WeChat, etc.)
• You can tune your code to a specific messenger's UX.
• i18n & l10n support (multilingual)
• Can be hosted in cloud or just as a standard Go HTTP server. Supports AppEngine standard environment.
• It's fast

Our approach to development

We build with our own tooling:

• SpecScore — specify requirements as SpecScore.md artifacts
• SpecStudio — author & manage specs across their lifecycle
• inGitDB — store structured data in Git where applicable
• cover100.dev — drive toward 100% test coverage
• DataTug — query & explore data

♺ Continuous Integration

- help with code coverage needed.

🍿 Usage

func InitBot(httpRouter HttpRouter, botHost bots.BotHost, appContext common.DebtsTrackerAppContext) {

	driver := bots.NewBotDriver( // Orchestrate requests to appropriate handlers
		bots.AnalyticsSettings{GaTrackingID: common.GA_TRACKING_ID}, // TODO: Refactor to list of analytics providers
		appContext,                                       // Holds User entity kind name, translator, etc.
		botHost,                                          // Defines how to create context.Context, HttpClient, DB, etc...
		"Please report any issues to @DebtsTrackerGroup", // Is it wrong place? Router has similar.
	)

	driver.RegisterWebhookHandlers(httpRouter, "/bot",
		telegram.NewTelegramWebhookHandler(
			telegramBotsWithRouter, // Maps of bots by code, language, token, etc...
			newTranslator, // Creates translator that gets a context.Context (for logging purpose)
		),
		viber.NewViberWebhookHandler(
			viber.Bots,
			newTranslator,
		),
		fbm.NewFbmWebhookHandler(
			fbm.Bots,
			newTranslator,
		),
	)
}

Published command ordering

Bot profiles can preserve their declared command order, sort all commands alphabetically, or pin important commands above an alphabetical remainder:

translations := botsfw.BotTranslations{
	Commands: []botsfw.BotCommand{
		{Command: "find", Description: "Find something"},
		{Command: "sports", Description: "Open sports"},
		{Command: "main", Description: "Open the main menu"},
	},
}
profile := botsfw.NewBotProfile(
	"profile_id",
	router,
	newBotChatData,
	newBotUserData,
	defaultLocale,
	supportedLocales,
	translations,
	botsfw.WithPublishedCommandOrder(
		botsfw.BotCommandOrderPinnedThenAlphabetical,
		"main",
		"sports",
	),
)

Pinned command codes are required configuration: every pinned code must occur exactly once in Commands. Invalid profile configuration fails fast instead of silently publishing a missing or duplicated command.

🤖 Sample bots built with Strongo Bots Framework

The best way to learn is to see examples of usage. Here is few:

• ⚫⚪ Reversi game - open source game. ( Telegram: @ReversiGameBot)
• ✖️⭕ Bidding Tic-Tac-Toe - open source game. ( Telegram: @BiddingTicTacToeBot)
• 📃✂️ Rock-Paper-Scissors - open source game. ( Telegram: @playRockPaperScissorsBot)
• 💸📝 Debtus.app — a bot & a reminder service that helps to track your debts & credits. Sends automated reminders to you & your debtors (in messenger, email, SMS).

We would be happy to place a link to your example / bot that is implemented using this framework.

📦 Go API libraries used by the framework to talk to messengers

You can use any Bot API library by implementing couple of simple interface but the framework comes with few buildins:

• bots-go-framework/bots-api-telegram - Go library for * Telegram* Bot API
• bots-go-framework/bots-api-fbm - Go library for Facebook Messenger Bot API
• bots-go-framework/bots-api-viber - Go library for **Viber ** Bot API

📦 Other Go libraries used by the bot framework

• strongo/gamp - Golang buffered client for Google Analytics (GA) Measurement Protocol

Can I use — features cross-table for bot messenger APIs

We are building a cross-table of features supported by different bot APIs.

Persistence

bots-fw is persistence-neutral. Inject a botsfwstore.StateStore into each BotSettings; DALgo applications should use the optional bots-fw-store-dalgo adapter. The full architecture and code migration guide are in PERSISTENCE.md.

🫂 Contributors

• Alexander Trakhimenok

📰 Press

There are no articles about the Strongo Bots Framework just yet. Send us a link if you find such.

📜 License

Licensed under Apache 2.0 license