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

• type Dispatch
  • func NewDispatch(bot *Robot) *Dispatch
  • func (d *Dispatch) Handle(exp string, h Handler)
  • func (d *Dispatch) HandleFunc(exp string, f func(*State))
  • func (d *Dispatch) Process(m chat.Message)
• type Handler
• type HandlerFunc
  • func (f HandlerFunc) Handle(s *State)
• type Robot
  • func New(adapterName, robotName, httpAddr string) *Robot
  • func (r *Robot) Chat() chat.Adapter
  • func (r *Robot) Direct(exp string) string
  • func (r *Robot) HTTP() *mux.Router
  • func (r *Robot) Name() string
  • func (r *Robot) Receive(m chat.Message)
  • func (r *Robot) Run() error
  • func (r *Robot) SetChat(name string) error
  • func (r *Robot) SetHTTP(router *mux.Router)
  • func (r *Robot) SetName(n string)
  • func (r *Robot) SetStore(s store.Store)
  • func (r *Robot) Stop()
  • func (r *Robot) Store() store.Store
• type State
  • func (s *State) Chat() chat.Adapter
  • func (s *State) Message() chat.Message
  • func (s *State) Params() []string
  • func (s *State) Robot() *Robot

Types

type Dispatch

type Dispatch struct {
	// contains filtered or unexported fields
}

func NewDispatch

func NewDispatch(bot *Robot) *Dispatch

func (*Dispatch) Handle

func (d *Dispatch) Handle(exp string, h Handler)

func (*Dispatch) HandleFunc

func (d *Dispatch) HandleFunc(exp string, f func(*State))

func (*Dispatch) Process

func (d *Dispatch) Process(m chat.Message)

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 struct {
	*Dispatch
	// contains filtered or unexported fields
}

func New

func New(adapterName, robotName, httpAddr string) *Robot

New returns a Robot

func (*Robot) Chat

func (r *Robot) Chat() chat.Adapter

func (*Robot) Direct

func (r *Robot) Direct(exp string) string

Direct wraps a regexp pattern in the necessary pattern for a direct command to the bot.

func (*Robot) HTTP

func (r *Robot) HTTP() *mux.Router

func (*Robot) Name

func (r *Robot) Name() string

func (*Robot) Receive

func (r *Robot) Receive(m chat.Message)

func (*Robot) Run

func (r *Robot) Run() error

Run starts the robot.

func (*Robot) SetChat

func (r *Robot) SetChat(name string) error

func (*Robot) SetHTTP

func (r *Robot) SetHTTP(router *mux.Router)

func (*Robot) SetName

func (r *Robot) SetName(n string)

func (*Robot) SetStore

func (r *Robot) SetStore(s store.Store)

func (*Robot) Stop

func (r *Robot) Stop()

func (*Robot) Store

func (r *Robot) Store() store.Store

type State

type State struct {
	// contains filtered or unexported fields
}

func (*State) Chat

func (s *State) Chat() chat.Adapter

func (*State) Message

func (s *State) Message() chat.Message

func (*State) Params

func (s *State) Params() []string

func (*State) Robot

func (s *State) Robot() *Robot