zenbot

README

zenbot is a Slack bot that enforces "zen periods" for users, during which they are reprimanded for using Slack. Currently, the only available action is giving negative karmabot karma points.

Syntax

• add a zen: ./zen <duration e.g. 1h30m> [reason - optional]
• cancel a zen: ./zen cancel [reason]
• cancel all zens: ./zen cancel

Installation

Build from Source

1. clone the repo:
   1. git clone -b v1.1.1 https://github.com/kamaln7/zenbot.git
2. run go get and then go build inside cmd/zenbot
   1. cd zenbot
   2. go get
   3. cd cmd/zenbot
   4. go build

Download a Pre-built Release

1. head to the repo's releases page and download the appropriate latest release's binary for your system

Usage

1. add a Slack Bot integration: https://team.slack.com/apps/A0F7YS25R-bots. an avatar is available here.
2. invite zenbot to any existing channels and all future channels (this is a limitation of Slack's bot API, unfortunately)
3. run zenbot. the following options are supported:

option	required?	description	default
-token string	yes	slack RTM token
-debug=bool	no	set debug mode	false
-timeout string	no	timeout between actions (karma downvotes)	10s
-whitelist.chan string	no	may be specified multiple times set a list of channel that zenbot may be used in.	[]

example: ./zenbot -token xoxb-abcdefg -whitelist.chan zen -whitelist.chan zenbot-test

It is recommended to pass zenbot's logs through humanlog. humanlog will format and color the JSON output as nice easy-to-read text.

Other

A systemd service unit file is available here. Edit the service file and replace xoxb-abcdefg with your Slack RTM token. Install it as usual.

License

see ./LICENSE

Documentation

Index

• Constants
• type Bot
  • func New(config *Config) *Bot
  • func (b *Bot) ExpireZens()
  • func (b *Bot) SendMessage(message, channel string)
  • func (b *Bot) Zen()
• type Config
• type Slack
• type StringList
  • func (sl *StringList) Set(value string) error
  • func (sl *StringList) String() string
• type Zen

Constants

const Version = "v1.1.1"

Version

Types

type Bot

type Bot struct {
	Config *Config
	// contains filtered or unexported fields
}

A Bot is an instance of zenbot.

func New

func New(config *Config) *Bot

func (*Bot) ExpireZens

func (b *Bot) ExpireZens()

ExpireZens removes zens that have ended

func (*Bot) SendMessage

func (b *Bot) SendMessage(message, channel string)

SendMessage sends a message to a Slack channel.

func (*Bot) Zen

func (b *Bot) Zen()

Zen starts listening for Slack messages.

type Config

type Config struct {
	Slack            *Slack
	Debug            bool
	Log              *log.Log
	TimeoutDuration  time.Duration
	ChannelWhitelist StringList
}

Config contains all the necessary configs for a zenbot instance.

type Slack

type Slack struct {
	Bot *slack.Client
	RTM *slack.RTM
}

Slack contains the Slack client and RTM object.

type StringList

type StringList map[string]struct{}

func (*StringList) Set

func (sl *StringList) Set(value string) error

func (*StringList) String

func (sl *StringList) String() string

type Zen

type Zen struct {
	User, Name, Channel, Reason string
	EndsAt, Timeout             time.Time
}

A Zen is a zen time period for a user