KO
|
EN
gitlite — search
Search
#javascript
#css
#html
#typescript
#ai
#webdevelopment
#rust
#open-source
#react
#vue
#swift
#library
go-keybase-chat-bot
★ 116
Open GitHub ↗
Official Go Keybase chat bot SDK
Download README (.md)
Explore Similar Repositories
AnyPicker
:
jQuery Picker Library for Android, iOS & Windows Phone. eg Date Picker, Time Picker, DateTime Picker, Custom Select etc
ngx_brotli_module
:
Brotli module for NGINX, including the encoder
scansploit
:
Exploit using barcodes, QRcodes, earn13, datamatrix
fastlane-plugin-cordova
:
Integrate your Cordova build into your Fastlane setup
rebirth-ng
:
rebirth-ng is a ui framework for Angular & bootstrap.
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
go-keybase-chat-bot
?
Download (.md)
# go-keybase-chat-bot [](https://github.com/keybase/go-keybase-chat-bot/actions) Write rich bots for Keybase chat in Go. ## Installation Make sure to [install Keybase](https://keybase.io/download). ```bash go get -u github.com/keybase/go-keybase-chat-bot/... ``` ### Hello world ```go package main import ( "flag" "fmt" "os" "github.com/keybase/go-keybase-chat-bot/kbchat" ) func fail(msg string, args ...interface{}) { fmt.Fprintf(os.Stderr, msg+"\n", args...) os.Exit(3) } func main() { var kbLoc string var kbc *kbchat.API var err error flag.StringVar(&kbLoc, "keybase", "keybase", "the location of the Keybase app") flag.Parse() if kbc, err = kbchat.Start(kbchat.RunOptions{KeybaseLocation: kbLoc}); err != nil { fail("Error creating API: %s", err.Error()) } tlfName := fmt.Sprintf("%s,%s", kbc.GetUsername(), "kb_monbot") fmt.Printf("saying hello on conversation: %s\n", tlfName) if _, err = kbc.SendMessageByTlfName(tlfName, "hello!"); err != nil { fail("Error sending message; %s", err.Error()) } } ``` ### Commands #### `Start(runOpts RunOptions) (*API, error)` This must be run first in order to start the Keybase JSON API stdin/stdout interactive mode. #### `API.SendMessage(channel chat1.ChatChannel, body string) (SendResponse, error)` send a new message by specifying a channel #### `API.SendMessageByConvID(convID chat1.ConvIDStr, body string) (SendResponse, error)` send a new message by specifying a conversation ID #### `API.SendMessageByTlfName(tlfName string, body string) (SendResponse, error)` send a new message by specifying a TLF name #### `API.GetConversations(unreadOnly bool) ([]chat1.ConvSummary, error)` get all conversations, optionally filtering for unread status #### `API.GetTextMessages(channel chat1.ChatChannel, unreadOnly bool) ([]chat1.MsgSummary, error)` get all text messages, optionally filtering for unread status Reads the messages in a channel. You can read with or without marking as read. #### `API.ListenForNextTextMessages() NewSubscription` Returns an object that allows for a bot to enter into a loop calling `NewSubscription.Read` to receive any new message across all conversations (except the bots own messages). See the following example: #### `API.InChatSend(channel chat1.ChatChannel, body string) (SendResponse, error)` send a new message which can contain in-chat-send payments (i.e. `+5XLM@joshblum`) by specifying a channel #### `API.InChatSendByConvID(convID chat1.ConvIDStr, body string) (SendResponse, error)` send a new message which can contain in-chat-send payments (i.e. `+5XLM@joshblum`) by specifying a conversation ID #### `API.InChatSendByTlfName(tlfName string, body string) (SendResponse, error)` send a new message which can contain in-chat-send payments (i.e. `+5XLM@joshblum`) by specifying a TLF name ```go sub, err := kbc.ListenForNewTextMessages() if err != nil { fail("Error listening: %s", err.Error()) } for { msg, err := sub.Read() if err != nil { fail("failed to read message: %s", err.Error()) } if msg.Message.Content.TypeName != "text" { continue } if msg.Message.Sender.Username == kbc.GetUsername() { continue } if _, err = kbc.SendMessage(msg.Message.Channel, msg.Message.Content.Text.Body); err != nil { fail("error echo'ing message: %s", err.Error()) } } ``` #### `API.Listen(kbchat.ListenOptions{Wallet: true}) NewSubscription` Returns the same object as above, but this one will have another channel on it that also gets wallet events. You can get those just like chat messages: `NewSubscription.ReadWallet`. So if you care about both of these types of events, you might run two loops like this: ```go sub, err := kbc.Listen(kbchat.ListenOptions{Wallet: true}) if err != nil { fail("Error listening: %s", err.Error()) } go func() { for { payment, err := sub.ReadWallet() if err != nil { fail("failed to read payment event: %s", err.Error()) } tlfName := fmt.Sprintf("%s,%s", payment.Payment.FromUsername, "kb_monbot") msg := fmt.Sprintf("thanks for the %s!", payment.Payment.AmountDescription) if _, err = kbc.SendMessageByTlfName(tlfName, msg); err != nil { fail("error thanking for payment: %s", err.Error()) } } }() for { msg, err := sub.Read() if err != nil { fail("failed to read message: %s", err.Error()) } if msg.Message.Content.TypeName != "text" { continue } if msg.Message.Sender.Username == kbc.GetUsername() { continue } if _, err = kbc.SendMessage(msg.Message.Channel, msg.Message.Content.Text.Body); err != nil { fail("error echo'ing message: %s", err.Error()) } } ``` ## TODO: - attachment handling (posting/getting) - edit/delete - many other things! ## Contributions - welcomed! ### Precommit hooks We check all git commits with pre-commit hooks generated via [pre-commit.com](http://pre-commit.com) pre-commit hooks. To enable use of these pre-commit hooks: - [Install](http://pre-commit.com/#install) the `pre-commit` utility. For some common cases: - `pip install pre-commit` - `brew install pre-commit` - Remove any existing pre-commit hooks via `rm .git/hooks/pre-commit` - Configure via `pre-commit install` ### Types Most of the types the bot uses are generated from definitions defined in the [`protocol/`](https://github.com/keybase/client/tree/master/protocol) directory inside the Keybase client repo. This ensures that the types that the bot uses are consistent across bots and always up to date with the output of the API. To build the types for the Go bot, you'll need to clone the `client` repo in the same parent directory that contains `go-keybase-chat-bot/`. ```shell git clone https://github.com/keybase/client ``` and install the necessary dependencies for compiling the protocol files. This requires [node.js](https://nodejs.org) and [Yarn](https://yarnpkg.com). ```shell cd client/protocol yarn install ``` Then you can generate the types by using the provided Makefile in this Go bot repo. Note that [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports) is required to generate the types. ```shell go get golang.org/x/tools/cmd/goimports # if you don't have goimports installed cd ../../go-keybase-chat-bot make ``` You can optionally specify a directory to the client protocol when making the types if `client` and `go-keybase-chat-bot` are not in the same directory. ```shell make PROTOCOL_PATH=path/to/client/protocol ``` Should you need to remove all the types for some reason, you can run `make clean`. ### Testing You'll need to have a few demo bot accounts and teams to run the suite of tests. Make a copy of `kbchat/test_config.example.yaml`, rename it to `kbchat/test_config.yaml`, and replace the example data with your own. Tests can then be run inside of `kbchat/` with `go test`.
