Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gustavocstl/botstate
package to create and manage a conversation bot states & flow
https://github.com/gustavocstl/botstate
bot chatbot finite-state-machine fsm go golang states
Last synced: 14 days ago
JSON representation
package to create and manage a conversation bot states & flow
- Host: GitHub
- URL: https://github.com/gustavocstl/botstate
- Owner: gustavocstl
- License: bsd-2-clause
- Created: 2020-06-08T00:12:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-11T23:25:53.000Z (over 4 years ago)
- Last Synced: 2024-10-18T23:18:46.737Z (4 months ago)
- Topics: bot, chatbot, finite-state-machine, fsm, go, golang, states
- Language: Go
- Homepage:
- Size: 76.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Botstate
The easy way to manage bot states.
[](https://travis-ci.com/gucastiliao/botstate)
[](https://pkg.go.dev/github.com/gucastiliao/botstate?tab=doc)
## Simple Bot Flow with Botstate
## Examples
- [Chatbot API with botstate](https://github.com/gucastiliao/example-chatbot-botstate)
- [Chatbot - See botstate in action](https://web-chatbot-botstate.herokuapp.com/)
## Installation
botstate requires a Go version with [Modules](https://github.com/golang/go/wiki/Modules) support and uses import versioning. So please make sure to initialize a Go module before installing botstate:
```
go mod init
go get github.com/gucastiliao/botstate
```
Import:
```
import "github.com/gucastiliao/botstate"
```
## Manage state
To manage states, botstate have a default client that uses [go-redis](https://github.com/go-redis/redis), but you can make your own client to save state the way you prefer.
You need to initialize storage with your client.
This example is using [go-redis](https://github.com/go-redis/redis) with botstate.DefaultStorage:
```go
r := redis.NewClient(&redis.Options{
Addr: mr.Addr(),
})
botstate.SetStorageClient(botstate.DefaultStorage(r))
```
If you have your own client:
```go
var myClient botstate.Storager
...
botstate.SetStorageClient(myClient)
```
## Simple Example
```go
package main
import (
"fmt"
"github.com/go-redis/redis/v7"
"github.com/gucastiliao/botstate"
)
func main() {
redis := redis.NewClient(&redis.Options{
Addr: fmt.Sprintf("%s:%s", "127.0.0.1", "6379"),
Password: "",
})
botstate.SetStorageClient(
botstate.DefaultStorage(redis),
)
states := []botstate.State{
{
Name: "start",
Executes: Start,
Next: "add_product",
},
{
Name: "add_product",
Executes: AddProduct,
Callback: CallbackAddProduct,
Next: "confirmation",
},
{
Name: "confirmation",
Executes: Confirmation,
},
}
bot := botstate.New(states)
bot.Data.User(111)
bot.ExecuteState("start")
msg := bot.GetMessages()
fmt.Println(msg)
// This print [Hello! Starting...]
current, _ := bot.Data.GetCurrentState()
// Current state now is -> add_product
// Because value of State.Next
bot.ExecuteState(current)
msg = bot.GetMessages()
fmt.Println(msg)
// This print [Add Product...]
current, _ = bot.Data.GetCurrentState()
// Current state now is -> confirmation
bot.ExecuteState(current)
msg = bot.GetMessages()
fmt.Println(msg)
// This print I'm in callback now and [Confirmation ...]
// The callback is defined in the previous state
// And in this execution is called
// If the callback return true, the execution continue and call Confirmation method
}
// botstate.Bot have access to current user's data
// and can manipulate it
func Start(bot *botstate.Bot) bool {
bot.AddMessage([]string{
"Hello!",
"Starting...",
})
return true
}
func AddProduct(bot *botstate.Bot) bool {
bot.AddMessage([]string{
"Add Product...",
})
return true
}
func CallbackAddProduct(bot *botstate.Bot) bool {
fmt.Println("I'm in callback now!")
return true
}
func Confirmation(bot *botstate.Bot) bool {
bot.AddMessage([]string{
"Confirmation...",
})
bot.Data.ResetCurrentState()
return true
}
```
## See more
- [Docs](https://pkg.go.dev/github.com/gucastiliao/botstate?tab=doc)