config

Documentation

Index

• Variables
• func ContextForTimeout(timeout time.Duration) (context.Context, context.CancelFunc)
• type Config
  • func FromYAML(configBytes []byte) (*Config, error)
  • func FromYAMLFile(configFilePath string) (*Config, error)
• type FrogtipConfig
• type GISConfig
• type MkthemeConfig
• type MongoConfig
  • func (c MongoConfig) Check() error
  • func (c MongoConfig) URI() string
• type ReactjiKeysConfig
• type SlackConfig
  • func (c SlackConfig) Check() error
• type URLConfig
• type URLsConfig

Variables

var ErrNilConfig = errors.New("config was nil")

Functions

func ContextForTimeout

func ContextForTimeout(timeout time.Duration) (context.Context, context.CancelFunc)

ContextForTimeout returns a context with the given timeout applied to an empty background context.

Types

type Config

type Config struct {
	MongoConf       MongoConfig       `yaml:"MongoConf"`
	SlackConf       SlackConfig       `yaml:"SlackConf"`
	ReactjiKeysConf ReactjiKeysConfig `yaml:"ReactjiKeysConf"`
	FrogtipConf     FrogtipConfig     `yaml:"FrogtipConf"`
	GISConf         GISConfig         `yaml:"GISConf"`
	URLsConf        URLsConfig        `yaml:"URLsConf"`
	MkthemeConf     MkthemeConfig     `yaml:"MkthemeConf"`
}

Config is a structure describing the overall gorfbot configuration.

func FromYAML

func FromYAML(configBytes []byte) (*Config, error)

FromYAML constructs a Config instance from the given serialized Config YAML bytes or returns an error.

func FromYAMLFile

func FromYAMLFile(configFilePath string) (*Config, error)

FromYAMLFile constructs a Config instance from the path to a YAML serialized Config file or returns an error.

type FrogtipConfig

type FrogtipConfig struct {
	// UserAgent of the HTTP client for the Frogtips API.
	UserAgent string `yaml:"UserAgent"`
}

FrogtipConfig describes configuration used by the Frogtips botcmd.

type GISConfig

type GISConfig struct {
	// Timeout for searches.
	Timeout *time.Duration `yaml:"Timeout"`
	// Google CSEID for API access.
	CSEID string `yaml:"CSEID"`
	// Google APIKey for API access.
	APIKey string `yaml:"APIKey"`
	// RandomSeed for randomizing image results.
	RandomSeed int64 `yaml:"RandomSeed"`
}

GISConfig describes configuration used by the Google Image Search botcmd.

type MkthemeConfig

type MkthemeConfig struct {
	// RandomSeed for seeding the colour generator.
	RandomSeed int64 `yaml:"RandomSeed"`
}

Mkthemeconfig describes configuration used by the mktheme botcmd.

type MongoConfig

type MongoConfig struct {
	// Username - required
	Username string `yaml:"Username"`
	// Password - required
	Password string `yaml:"Password"`
	// Hostname - required
	Hostname string `yaml:"Hostname"`
	// Database - required
	Database string `yaml:"Database"`
	// Options  - may be omitted. Everything after the `?` in a connection URI.
	Options string `yaml:"Options"`
	// ConnectTimeout - may be omitted.
	ConnectTimeout *time.Duration `yaml:"ConnectTimeout"`
	// ReadTimeout - may be omitted.
	ReadTimeout *time.Duration `yaml:"ReadTimeout"`
	// WriteTimeout - may be omitted.
	WriteTimeout *time.Duration `yaml:"WriteTimeout"`
}

MongoConfig describes configuration required to connect to a MongoDB instance.

func (MongoConfig) Check

func (c MongoConfig) Check() error

Check verifies a MongoConfig is valid. It returns an error if there are missing field values.

func (MongoConfig) URI

func (c MongoConfig) URI() string

URI returns the Mongo connection URI for the given config.

type ReactjiKeysConfig

type ReactjiKeysConfig struct {
	// Keywords is a map of keyword to reaction list.
	Keywords map[string][]string `yaml:"Keywords"`
}

ReactjiKeysConfig describes a mapping of keywords to lists of reactions to apply when the keyword is seen.

type SlackConfig

type SlackConfig struct {
	// APIToken for authenticating to Slack - required.
	APIToken string `yaml:"APIToken"`
	// Debug enables/disables the Slack API client debug option - optional. Debug messages
	// will be sent to the `Info` level of the bot's logger.
	Debug bool `yaml:"Debug"`
	// How long to wait before refreshing slack state (channels, users, etc).
	StateMaxAge *time.Duration `yaml:"StateMaxAge"`
}

SlackConfig describes configuration required to connect to a Slack instance.

func (SlackConfig) Check

func (c SlackConfig) Check() error

Check verifies a SlackConfig is valid. It returns an error if there are missing field values.

type URLConfig

type URLConfig struct {
	// HostPattern is a regex that must match on the URL's host component.
	HostPattern string `yaml:"HostPattern"`
	// PathPattern is an optional regex that must match on the URL's path component.
	PathPattern string `yaml:"PathPattern"`
	// Collection is the name of a storage collection for the occurrences of this
	// URLConfig to be tracked in.
	Collection string `yaml:"Collection"`
	// FirstMsg is a message to post in response to matches of this URLConfig that
	// have never been seen before.
	FirstMsg string `yaml:"FirstMsg"`
	// Reactji is a list of reactions (no ":" delimiters) to post in response to
	// matches of this URLConfig.
	Reactji []string `yaml:"Reactji"`
}

URLConfig describes a host (and optional path) pattern for matching URLs and tracking occurrences with special logic for never before seen URLs.

type URLsConfig

type URLsConfig struct {
	// URLs is a list of URLConfig.
	URLs []URLConfig `yaml:"URLs"`
}

URLsConfig is a list of URLConfigs.