mcdowell

package module

v0.0.0-...-a854f13 Latest Latest Go to latest Published: Mar 4, 2018 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/willmadison/mcdowell

Links

Open Source Insights

README ¶

McDowell

Cleo McDowell

This is a Slack bot for the Atlanta Black Tech Slack.

You can get an invite from here

Building

This bot requires Go 1.7+ and can be built as follows:

    go build ./cmd/mcdowell

Running

To run this you need to set the the following environment variables:

ABT_SLACK_BOT_TOKEN - the Slack bot token
ABT_SLACK_BOT_DEV_MODE - boolean, set the bot in development mode

    ABT_SLACK_BOT_TOKEN=<TOKEN_HERE> ./mcdowell

Documentation ¶

Index ¶

func Versioned(version string) func(*Bot)
func WithDebug() func(*Bot)
func WithTesting() func(*Bot)
type Bot
- func NewBot(ctx context.Context, client SlackClient, options ...func(*Bot)) (*Bot, error)
- func (b *Bot) OnNewMessage(event *slack.MessageEvent) error
- func (b *Bot) OnTeamJoined(event *slack.TeamJoinEvent) error
type SlackClient

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Versioned ¶

func Versioned(version string) func(*Bot)

Versioned enables Version to be set on the bot.

func WithDebug ¶

func WithDebug() func(*Bot)

WithDebug enables debug mode on the bot.

func WithTesting ¶

func WithTesting() func(*Bot)

WithTesting enables test mode on the bot.

Types ¶

type Bot ¶

type Bot struct {
	Debug   bool
	Testing bool
	Version string
	// contains filtered or unexported fields
}

Bot represents a single bot instance.

func NewBot ¶

func NewBot(ctx context.Context, client SlackClient, options ...func(*Bot)) (*Bot, error)

NewBot returns a new McDowell Bot instance ready to handle any events from Slack.

func (*Bot) OnNewMessage ¶

func (b *Bot) OnNewMessage(event *slack.MessageEvent) error

OnNewMessage handles the appropriate behavior for when new interesting messages happen in any channel the bot is listening in.

func (*Bot) OnTeamJoined ¶

func (b *Bot) OnTeamJoined(event *slack.TeamJoinEvent) error

OnTeamJoined handles the appropriate behavior for when new team members join our slack.

type SlackClient ¶

type SlackClient interface {
	PostMessage(channel, message string, params slack.PostMessageParameters) (string, string, error)
	GetUsers() ([]slack.User, error)
}

SlackClient represents the interface of methods we rely on from the Slack client.

Source Files ¶

View all Source files

mcdowell.go

Directories ¶

Path	Synopsis
cmd
mcdowell

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL