adding log level option (#1)

Reviewed-on: #1
Co-authored-by: jake <jake.young.dev@gmail.com>
Co-committed-by: jake <jake.young.dev@gmail.com>

README.md

@@ -1,20 +1,34 @@
 # bolt
 
-Base Discord bot framework
+The nuts and bolts of a Discord bots. Bolt is a wrapper for [discordgo](https://github.com/bwmarrin/discordgo) that provides very quick bootstrapping for simple Discord bots. 
 
-## Introduction
+## Usage
-bolt is a wrapper for Discordgo to provide very quick and easy setup for simple Discord bots. The only code required to run bolt are the command handler functions, this provides developers with the ability to have text-based commands on a Discord server without all the bootstrapping and setup usually required. Any strings returned from the Payload function will be sent back to the Discord server as a reply to the command message.
+### Token
+Bolt requires a Discord bot token to run, the token must be set as an environment variable labeled "DISCORD_TOKEN"
 
-## Basic Usage
+### Commands
-bolt allows developers to create a Discord bot with a discord bot token and a few lines of Go code, discord tokens must be set as an environment variable labeled DISCORD_TOKEN. The below example creates a Discord bot and registers three commands: ".ping", ".time", and ".role" the "." character is the default command indicator but that can be changed using the WithIndicator option.
+Commands are represented by the Command struct. Any roles in the Command struct can run the command, if the Roles field is empty anyone can run the command.
+```go
+type Command struct {
+	Trigger string        //command that triggers payload NOT including the indicator
+	Payload Payload       //payload function to run when a command is detected
+	Timeout time.Duration //the amount of time before command can be run again
+	lastRun time.Time     //timestamp of last command run
+	Roles   []string      //roles that can use command, if none are set anyone can run the command
+}
+```
+
+### Payload
+Payload functions are executed when a command is detected, if no errors are returned and the returned string is not empty, then the returned string is sent in reply to the command message.
+```go
+type Payload func(msg Message) (string, error)
+```
+
+### Example
 ```go
 package main
 
 import (
-	"log"
-	"os"
-	"os/signal"
-	"syscall"
 	"time"
 
 	"code.jakeyoungdev.com/jake/bolt"
@@ -24,7 +38,7 @@ import (
 func main() {
 	//bolt defaults the command indicator to '.' however that can be changed with the options
 	//Example: bolt.New(bolt.WithIndicator('!')) would support commands like !ping
-	b := bolt.New()
+	b := bolt.New(bolt.WithLogLevel(bolt.LogLevelCmd))
 
 	b.AddCommands(
         // .ping can be run at any time by anyone and will respond with 'pong'

bolt.go

@@ -26,8 +26,9 @@ const (
 // basic bot structure containing discordgo connection as well as the command map
 type bolt struct {
 	*dg.Session                    //holds discordgo internals
-	Commands    map[string]Command //maps trigger phrase to command struct for fast lookup
+	commands    map[string]Command //maps trigger phrase to command struct for fast lookup
 	indicator   string             //the indicator used to detect whether a message is a command
+	logLvl      LogLevel           //determines how much the bot logs
 }
 
 type Bolt interface {
@@ -62,13 +63,15 @@ func New(opts ...Option) Bolt {
 
 	b := &bolt{
 		Session:  bot,
-		Commands: make(map[string]Command, 0),
+		commands: make(map[string]Command, 0),
+		logLvl:   LogLevelAll,
 	}
 	//set default command indicator
 	b.indicator = "."
 
-	for _, o := range opts {
+	//apply options to bolt
-		o(b)
+	for _, opt := range opts {
+		opt(b)
 	}
 
 	return b
@@ -85,6 +88,7 @@ func (b *bolt) Start() error {
 		return err
 	}
 
+	//safe shutdown handler
 	sigChannel := make(chan os.Signal, 1)
 	signal.Notify(sigChannel, syscall.SIGINT)
 	<-sigChannel
@@ -104,7 +108,7 @@ func (b *bolt) stop() error {
 // adds commands to bot command map for use
 func (b *bolt) AddCommands(cmd ...Command) {
 	for _, c := range cmd {
-		b.Commands[c.Trigger] = c
+		b.commands[c.Trigger] = c
 	}
 }
 
@@ -128,11 +132,17 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
 		msg.Content = "GIF/IMAGE"
 	}
 
-	//log message
+	if b.logLvl == LogLevelAll {
-	log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
+		//log message
+		log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
+	}
 
 	//the bot will ignore it's own messages to prevent command loops
 	if msg.Author.ID == s.State.User.ID {
+		if b.logLvl == LogLevelCmd {
+			//log commands
+			log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
+		}
 		return
 	}
 
@@ -149,8 +159,13 @@ func (b *bolt) messageHandler(s *dg.Session, msg *dg.MessageCreate) {
 
 // parses command from message and handles timeout checks, role checks, and command execution. All command responses are sent back to Discord
 func (b *bolt) handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Guild, channel *dg.Channel, lg int) error {
+	if b.logLvl == LogLevelCmd {
+		//log commands
+		log.Printf("< %s | %s | %s > %s\n", server.Name, channel.Name, msg.Author.Username, msg.Content)
+	}
+
 	words := strings.Split(msg.Content, " ")
-	run, ok := b.Commands[words[0][lg:]]
+	run, ok := b.commands[words[0][lg:]]
 	if !ok {
 		return nil //command doesn't exist, maybe log or respond to author
 	}
@@ -199,7 +214,7 @@ func (b *bolt) handleCommand(msg *dg.MessageCreate, s *dg.Session, server *dg.Gu
 
 	//update run time
 	run.lastRun = time.Now()
-	b.Commands[run.Trigger] = run
+	b.commands[run.Trigger] = run
 	return nil
 }
 
@@ -241,7 +256,8 @@ func (b *bolt) getRemainingTimeout(timeout time.Time) string {
 // checks if the author of msg has the correct role to run the requested command
 func (b *bolt) roleCheck(msg *dg.MessageCreate, s *dg.Session, run Command) (bool, error) {
 	var found bool
-	//loop thru author roles
+	//loop thru author roles, there may be a better way to check for this UNION
+	//TODO: improve role search performance to support bigger lists
 	for _, r := range msg.Member.Roles {
 		//get role name from ID
 		n, err := s.State.Role(msg.GuildID, r)

command.go

@@ -2,23 +2,23 @@ package bolt
 
 import "time"
 
+// custom Discord commands
 type Command struct {
 	Trigger string        //command that triggers payload NOT including the indicator
 	Payload Payload       //payload function to run when a command is detected
-	Timeout time.Duration //the amount of time before command can run again
+	Timeout time.Duration //the amount of time before command can be run again
 	lastRun time.Time     //timestamp of last command run
-	Roles   []string      //roles that can use command
+	Roles   []string      //roles that can use command, if none are set anyone can run the command
 }
 
-// payload function type handling commands. The returned error is parsed and, if no error,
+// command payload functions, any strings returned are sent as a response to the command
-// is detected then the response string (res) will be sent in response to the command message
 type Payload func(msg Message) (string, error)
 
-// contains the basic information needed for a message command
+// message information passed to payload function
 type Message struct {
 	Author  string   //username of message author
 	Words   []string //words from message split on whitespace
 	Content string   //entire message content
-	Channel string   //channel message was sent in
+	Channel string   //message channel
-	Server  string   //guild message was sent in
+	Server  string   //message guild
 }

option.go

@@ -2,9 +2,24 @@ package bolt
 
 type Option func(b *bolt)
 
+type LogLevel int
+
+const (
+	LogLevelAll LogLevel = iota //logs all messages, and errors
+	LogLevelCmd LogLevel = iota //log only commands and responses, and errors
+	LogLevelErr LogLevel = iota //logs only errors
+)
+
 // sets the substring that must be present at the beginning of the message to indicate a command
 func WithIndicator(i string) Option {
 	return func(b *bolt) {
 		b.indicator = i
 	}
 }
+
+// sets the log level to determine how much bolt logs
+func WithLogLevel(lvl LogLevel) Option {
+	return func(b *bolt) {
+		b.logLvl = lvl
+	}
+}