victor

README

Victor

Victor is a library for creating your own chat bot.

We use Victor as the backbone of our bot, Virbot, within our team Slack chat at Virb (http://virb.com). We use him for all sorts things like:

• Deploying code
• Preparing/initiating builds of our projects
• Viewing information about our infrastructure
• CDN operations
• Jokes and laughs

Supported Services

I currently have adapters written for Slack and Campfire, however more are to come. Writing an adapter for your favorite service is a good way to contribute to the project 😉.

Making Him Your Own

Victor is more of a framework for constructing your own bot so he doesn't do a whole lot out-of-the-box. I'll be adding more default behavior to him as time progresses. You can use the programs located in examples/ as starting points to create your own executable.

Documentation

Index

• func New(config Config) *robot
• func OnlyAllow(userNames []string, action func(s State)) func(State)
• type Config
• type Handler
• type HandlerFunc
  • func (f HandlerFunc) Handle(s State)
• type Robot
• type State

Functions

func New

func New(config Config) *robot

New returns a robot

func OnlyAllow

func OnlyAllow(userNames []string, action func(s State)) func(State)

OnlyAllow provides a way of permitting specific users to execute a handler registered with the bot

Types

type Config

type Config struct {
	Name,
	ChatAdapter,
	StoreAdapter,
	HTTPAddr string
}

type Handler

type Handler interface {
	Handle(State)
}

type HandlerFunc

type HandlerFunc func(State)

func (HandlerFunc) Handle

func (f HandlerFunc) Handle(s State)

type Robot

type Robot interface {
	Run()
	Stop()
	Name() string
	HandleFunc(string, HandlerFunc)
	Handle(string, Handler)
	Direct(string) string
	Receive(chat.Message)
	Chat() chat.Adapter
	Store() store.Adapter
	HTTP() *mux.Router
}

type State

type State interface {
	Robot() Robot
	Chat() chat.Adapter
	Message() chat.Message
	Params() []string
}