common

Documentation

Index

• Constants
• func GetStringKeys(arr map[string]interface{}) []string
• func IfDef(cond bool, v1, v2 interface{}) interface{}
• func LoadTemplate(name, tmpl string) (*template.Template, error)
• func LoadYaml(config string, obj interface{}) (bool, error)
• func MergeInterfaceMaps(maps ...map[string]interface{}) map[string]interface{}
• func RemoveEmptyStrings(items []string) []string
• func Render(def string, obj interface{}, observability *Observability) string
• func RenderTemplate(tpl *toolsRender.TextTemplate, def string, obj interface{}) (string, error)
• type Attachment
• type AttachmentType
• type Bot
• type Bots
  • func NewBots() *Bots
  • func (bs *Bots) Add(b Bot)
  • func (bs *Bots) Start(wg *sync.WaitGroup)
• type Channel
• type Command
• type ExecuteParams
• type Executor
• type Field
• type FieldType
• type Message
• type Observability
  • func NewObservability(logs *sre.Logs, metrics *sre.Metrics) *Observability
  • func (o *Observability) Debug(obj interface{}, args ...interface{})
  • func (o *Observability) Error(obj interface{}, args ...interface{})
  • func (o *Observability) Info(obj interface{}, args ...interface{})
  • func (o *Observability) Logs() *sre.Logs
  • func (o *Observability) Metrics() *sre.Metrics
  • func (o *Observability) Warn(obj interface{}, args ...interface{})
• type Processor
• type Processors
  • func NewProcessors() *Processors
  • func (ps *Processors) Add(p Processor)
  • func (ps *Processors) AddList(list []Processor)
  • func (ps *Processors) Exists(processor string) bool
  • func (ps *Processors) FindCommand(processor, command string) Command
  • func (ps *Processors) FindCommandByAlias(alias string) (string, Command)
  • func (ps *Processors) Items() []Processor
• type Response
• type User

Constants

const (
	AttachmentTypeUnknown = ""
	AttachmentTypeText    = "text"
	AttachmentTypeImage   = "image"
	AttachmentTypeFile    = "file"
)

const (
	FileTypeUnknown = ""
	FileTypeText    = "text"
	FileTypeImage   = "image"
)

const (
	FieldTypeUnknown            = ""
	FieldTypeEdit               = "edit"
	FieldTypeMultiEdit          = "multiedit"
	FieldTypeInteger            = "integer"
	FieldTypeFloat              = "float"
	FieldTypeURL                = "url"
	FieldTypeDate               = "date"
	FieldTypeTime               = "time"
	FieldTypeSelect             = "select"
	FieldTypeMultiSelect        = "multiselect"
	FieldTypeDynamicSelect      = "dynamicselect"
	FieldTypeDynamicMultiSelect = "dynamicmultiselect"
	FieldTypeBool               = "bool"
)

Functions

func GetStringKeys

func GetStringKeys(arr map[string]interface{}) []string

func IfDef

func IfDef(cond bool, v1, v2 interface{}) interface{}

func LoadTemplate

func LoadTemplate(name, tmpl string) (*template.Template, error)

func LoadYaml

func LoadYaml(config string, obj interface{}) (bool, error)

func MergeInterfaceMaps

func MergeInterfaceMaps(maps ...map[string]interface{}) map[string]interface{}

func RemoveEmptyStrings

func RemoveEmptyStrings(items []string) []string

func Render

func Render(def string, obj interface{}, observability *Observability) string

func RenderTemplate

func RenderTemplate(tpl *toolsRender.TextTemplate, def string, obj interface{}) (string, error)

Types

type Attachment

type Attachment struct {
	Title string
	Text  string
	Data  []byte
	Type  AttachmentType
}

type AttachmentType

type AttachmentType string

type Bot

type Bot interface {
	Start(wg *sync.WaitGroup)
	Name() string
	Command(channel, text string, user User, parent Message, response Response) error
	Post(channel string, message string, attachments []*Attachment, user User, parent Message, response Response) error
	Delete(channel, message string) error
	AddReaction(channel, message, name string) error
}

type Bots

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

func NewBots

func NewBots() *Bots

func (*Bots) Add

func (bs *Bots) Add(b Bot)

func (*Bots) Start

func (bs *Bots) Start(wg *sync.WaitGroup)

type Channel

type Channel interface {
	ID() string
}

type Command

type Command interface {
	Name() string
	Description() string
	Params() []string
	Aliases() []string
	Confirmation() string
	Fields(bot Bot, message Message, only []string) []Field
	Priority() int
	Wrapper() bool
	Schedule() string
	Channel() string
	Execute(bot Bot, message Message, params ExecuteParams) (Executor, string, []*Attachment, error)
}

type ExecuteParams

type ExecuteParams = map[string]interface{}

type Executor

type Executor interface {
	Response() Response
	After(message Message) error
}

type Field

type Field struct {
	Name     string
	Type     FieldType
	Label    string
	Default  string
	Hint     string
	Required bool
	Values   []string
	Template string
}

type FieldType

type FieldType string

type Message

type Message interface {
	ID() string
	Visible() bool
	User() User
	Channel() Channel
	ParentID() string
}

type Observability

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

func NewObservability

func NewObservability(logs *sre.Logs, metrics *sre.Metrics) *Observability

func (*Observability) Debug

func (o *Observability) Debug(obj interface{}, args ...interface{})

func (*Observability) Error

func (o *Observability) Error(obj interface{}, args ...interface{})

func (*Observability) Info

func (o *Observability) Info(obj interface{}, args ...interface{})

func (*Observability) Logs

func (o *Observability) Logs() *sre.Logs

func (*Observability) Metrics

func (o *Observability) Metrics() *sre.Metrics

func (*Observability) Warn

func (o *Observability) Warn(obj interface{}, args ...interface{})

type Processor

type Processor interface {
	Name() string
	Commands() []Command
}

type Processors

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

func NewProcessors

func NewProcessors() *Processors

func (*Processors) Add

func (ps *Processors) Add(p Processor)

func (*Processors) AddList

func (ps *Processors) AddList(list []Processor)

func (*Processors) Exists

func (ps *Processors) Exists(processor string) bool

func (*Processors) FindCommand

func (ps *Processors) FindCommand(processor, command string) Command

func (*Processors) FindCommandByAlias

func (ps *Processors) FindCommandByAlias(alias string) (string, Command)

func (*Processors) Items

func (ps *Processors) Items() []Processor

type Response

type Response interface {
	Visible() bool  // visible for others, not only you
	Duration() bool // show duration in replay
	Original() bool // show orignal as quote
	Error() bool    // show as error
}

type User

type User interface {
	ID() string
	Name() string
	TimeZone() string
}