Add ChannelData to Cmd (#41)

This stores a bit more info than just the channel name; in addition you get the protocol (irc, slack, telegram), server host, and whether the channel is a private chat or a public channel.

bot.go

@@ -59,18 +59,19 @@ func (b *Bot) startPeriodicCommands() {
 }
 
 // MessageReceived must be called by the protocol upon receiving a message
-func (b *Bot) MessageReceived(channel string, text string, sender *User) {
+func (b *Bot) MessageReceived(channel *ChannelData, text string, sender *User) {
 	command, err := parse(text, channel, sender)
 	if err != nil {
-		b.handlers.Response(channel, err.Error(), sender)
+		b.handlers.Response(channel.Channel, err.Error(), sender)
 		return
 	}
 
 	if command == nil {
 		b.executePassiveCommands(&PassiveCmd{
-			Raw:     text,
-			Channel: channel,
-			User:    sender,
+			Raw:         text,
+			Channel:     channel.Channel,
+			ChannelData: channel,
+			User:        sender,
 		})
 		return
 	}

cmd.go

@@ -8,20 +8,35 @@ import (
 
 // Cmd holds the parsed user's input for easier handling of commands
 type Cmd struct {
-	Raw     string   // Raw is full string passed to the command
-	Channel string   // Channel where the command was called
-	User    *User    // User who sent the message
-	Message string   // Full string without the prefix
-	Command string   // Command is the first argument passed to the bot
-	RawArgs string   // Raw arguments after the command
-	Args    []string // Arguments as array
+	Raw         string       // Raw is full string passed to the command
+	Channel     string       // Channel where the command was called
+	ChannelData *ChannelData // More info about the channel, including network
+	User        *User        // User who sent the message
+	Message     string       // Full string without the prefix
+	Command     string       // Command is the first argument passed to the bot
+	RawArgs     string       // Raw arguments after the command
+	Args        []string     // Arguments as array
+}
+
+// ChannelData holds the improved channel info, which includes protocol and server
+type ChannelData struct {
+	Protocol  string // What protocol the message was sent on (irc, slack, telegram)
+	Server    string // The server hostname the message was sent on
+	Channel   string // The channel name the message appeared in
+	IsPrivate bool   // Whether the channel is a group or private chat
+}
+
+// URI gives back an URI-fied string containing protocol, server and channel.
+func (c *ChannelData) URI() string {
+	return fmt.Sprintf("%s://%s/%s", c.Protocol, c.Server, c.Channel)
 }
 
 // PassiveCmd holds the information which will be passed to passive commands when receiving a message
 type PassiveCmd struct {
-	Raw     string // Raw message sent to the channel
-	Channel string // Channel which the message was sent to
-	User    *User  // User who sent this message
+	Raw         string       // Raw message sent to the channel
+	Channel     string       // Channel which the message was sent to
+	ChannelData *ChannelData // Channel and network info
+	User        *User        // User who sent this message
 }
 
 // PeriodicConfig holds a cron specification for periodically notifying the configured channels
@@ -47,13 +62,6 @@ type customCommand struct {
 	ExampleArgs string
 }
 
-type incomingMessage struct {
-	Channel        string
-	Text           string
-	User           *User
-	BotCurrentNick string
-}
-
 // CmdResult is the result message of V2 commands
 type CmdResult struct {
 	Channel string // The channel where the bot should send the message

cmd_test.go

@@ -101,13 +101,13 @@ func TestDisabledCommands(t *testing.T) {
 		})
 
 	b.Disable([]string{"cmd"})
-	b.MessageReceived("#go-bot", "!cmd", &User{Nick: "user"})
+	b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!cmd", &User{Nick: "user"})
 	if len(replies) != 0 {
 		t.Fatal("Should not execute disabled active commands")
 	}
 
 	b.Disable([]string{"passive"})
-	b.MessageReceived("#go-bot", "regular message", &User{Nick: "user"})
+	b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "regular message", &User{Nick: "user"})
 
 	if len(replies) != 0 {
 		t.Fatal("Should not execute disabled passive commands")
@@ -124,15 +124,15 @@ func TestMessageReceived(t *testing.T) {
 
 		Convey("When the command is not registered", func() {
 			Convey("It should not post to the channel", func() {
-				b.MessageReceived("#go-bot", "!not_a_cmd", &User{})
+				b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!not_a_cmd", &User{})
 
 				So(replies, ShouldBeEmpty)
 			})
 		})
 
 		Convey("When the command arguments are invalid", func() {
 			Convey("It should reply with an error message", func() {
-				b.MessageReceived("#go-bot", "!cmd \"invalid arg", &User{Nick: "user"})
+				b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!cmd \"invalid arg", &User{Nick: "user"})
 
 				So(channel, ShouldEqual, "#go-bot")
 				So(replies, ShouldHaveLength, 1)
@@ -148,7 +148,7 @@ func TestMessageReceived(t *testing.T) {
 						return "", cmdError
 					})
 
-				b.MessageReceived("#go-bot", "!cmd", &User{Nick: "user"})
+				b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!cmd", &User{Nick: "user"})
 
 				So(channel, ShouldEqual, "#go-bot")
 				So(replies, ShouldResemble,
@@ -169,21 +169,21 @@ func TestMessageReceived(t *testing.T) {
 				})
 
 			Convey("If it is called in the channel, reply on the channel", func() {
-				b.MessageReceived("#go-bot", "!cmd", &User{Nick: "user"})
+				b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!cmd", &User{Nick: "user"})
 
 				So(channel, ShouldEqual, "#go-bot")
 				So(replies, ShouldResemble, []string{expectedMsg})
 			})
 
 			Convey("If it is a private message, reply to the user", func() {
 				user = &User{Nick: "go-bot"}
-				b.MessageReceived("go-bot", "!cmd", &User{Nick: "sender-nick"})
+				b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!cmd", &User{Nick: "sender-nick"})
 				So(user.Nick, ShouldEqual, "sender-nick")
 			})
 
 			Convey("When the command is help", func() {
 				Convey("Display the available commands in the channel", func() {
-					b.MessageReceived("#go-bot", "!help", &User{Nick: "user"})
+					b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!help", &User{Nick: "user"})
 
 					So(channel, ShouldEqual, "#go-bot")
 					So(replies, ShouldResemble, []string{
@@ -193,7 +193,7 @@ func TestMessageReceived(t *testing.T) {
 				})
 
 				Convey("If the command exists send a message to the channel", func() {
-					b.MessageReceived("#go-bot", "!help cmd", &User{Nick: "user"})
+					b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!help cmd", &User{Nick: "user"})
 
 					So(channel, ShouldEqual, "#go-bot")
 					So(replies, ShouldResemble, []string{
@@ -203,7 +203,7 @@ func TestMessageReceived(t *testing.T) {
 				})
 
 				Convey("If the command does not exists, display the generic help", func() {
-					b.MessageReceived("#go-bot", "!help not_a_command", &User{Nick: "user"})
+					b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!help not_a_command", &User{Nick: "user"})
 
 					So(channel, ShouldEqual, "#go-bot")
 					So(replies, ShouldResemble, []string{
@@ -213,7 +213,7 @@ func TestMessageReceived(t *testing.T) {
 				})
 
 				Convey("if the help arguments are invalid, reply with an error", func() {
-					b.MessageReceived("#go-bot", "!help cmd \"invalid arg", &User{Nick: "user"})
+					b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!help cmd \"invalid arg", &User{Nick: "user"})
 
 					So(channel, ShouldEqual, "#go-bot")
 					So(replies, ShouldHaveLength, 1)
@@ -231,7 +231,7 @@ func TestMessageReceived(t *testing.T) {
 							Message: "message"}, nil
 					})
 
-				b.MessageReceived("#go-bot", "!cmd", &User{Nick: "user"})
+				b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!cmd", &User{Nick: "user"})
 
 				So(channel, ShouldEqual, "#channel")
 				So(replies, ShouldResemble, []string{"message"})
@@ -244,7 +244,7 @@ func TestMessageReceived(t *testing.T) {
 							Message: "message"}, nil
 					})
 
-				b.MessageReceived("#go-bot", "!cmd", &User{Nick: "user"})
+				b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "!cmd", &User{Nick: "user"})
 
 				So(channel, ShouldEqual, "#go-bot")
 				So(replies, ShouldResemble, []string{"message"})
@@ -269,7 +269,7 @@ func TestMessageReceived(t *testing.T) {
 			RegisterPassiveCommand("errored", errored)
 
 			Convey("If it is called in the channel, reply on the channel", func() {
-				b.MessageReceived("#go-bot", "test", &User{Nick: "user"})
+				b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "test", &User{Nick: "user"})
 
 				So(channel, ShouldEqual, "#go-bot")
 				So(len(replies), ShouldEqual, 2)
@@ -279,7 +279,7 @@ func TestMessageReceived(t *testing.T) {
 
 			Convey("If it is a private message, reply to the user", func() {
 				user = &User{Nick: "go-bot"}
-				b.MessageReceived("go-bot", "test", &User{Nick: "sender-nick"})
+				b.MessageReceived(&ChannelData{Channel: "#go-bot"}, "test", &User{Nick: "sender-nick"})
 
 				So(user.Nick, ShouldEqual, "sender-nick")
 				So(len(replies), ShouldEqual, 2)

help.go

@@ -14,7 +14,7 @@ const (
 )
 
 func (b *Bot) help(c *Cmd) {
-	cmd, _ := parse(CmdPrefix+c.RawArgs, c.Channel, c.User)
+	cmd, _ := parse(CmdPrefix+c.RawArgs, c.ChannelData, c.User)
 	if cmd == nil {
 		b.showAvailabeCommands(c.Channel, c.User)
 		return

irc/irc.go

@@ -37,10 +37,17 @@ func responseHandler(target string, message string, sender *bot.User) {
 }
 
 func onPRIVMSG(e *ircevent.Event) {
-	b.MessageReceived(e.Arguments[0], e.Message(), &bot.User{
-		ID:       e.Host,
-		Nick:     e.Nick,
-		RealName: e.User})
+	b.MessageReceived(
+		&bot.ChannelData{
+			Protocol:  "irc",
+			Server:    ircConn.Server,
+			Channel:   e.Arguments[0],
+			IsPrivate: e.Arguments[0] == ircConn.GetNick()},
+		e.Message(),
+		&bot.User{
+			ID:       e.Host,
+			Nick:     e.Nick,
+			RealName: e.User})
 }
 
 func getServerName(server string) string {

parser.go

@@ -12,15 +12,16 @@ var (
 	re = regexp.MustCompile("\\s+") // Matches one or more spaces
 )
 
-func parse(s string, channel string, user *User) (*Cmd, error) {
+func parse(s string, channel *ChannelData, user *User) (*Cmd, error) {
 	c := &Cmd{Raw: s}
 	s = strings.TrimSpace(s)
 
 	if !strings.HasPrefix(s, CmdPrefix) {
 		return nil, nil
 	}
 
-	c.Channel = strings.TrimSpace(channel)
+	c.Channel = strings.TrimSpace(channel.Channel)
+	c.ChannelData = channel
 	c.User = user
 
 	// Trim the prefix and extra spaces

parser_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 )
 
-func TestPaser(t *testing.T) {
-	channel := "#go-bot"
+func TestParser(t *testing.T) {
+	channel := &ChannelData{Channel: "#go-bot"}
 	user := &User{Nick: "user123"}
 	cmdWithoutArgs := CmdPrefix + "cmd"
 	cmdWithArgs := CmdPrefix + "cmd    arg1  arg2   "
@@ -20,29 +20,32 @@ func TestPaser(t *testing.T) {
 		{"!", nil},
 		{"regular message", nil},
 		{cmdWithoutArgs, &Cmd{
-			Raw:     cmdWithoutArgs,
-			Command: "cmd",
-			Channel: channel,
-			User:    user,
-			Message: "cmd",
+			Raw:         cmdWithoutArgs,
+			Command:     "cmd",
+			Channel:     channel.Channel,
+			ChannelData: channel,
+			User:        user,
+			Message:     "cmd",
 		}},
 		{cmdWithArgs, &Cmd{
-			Raw:     cmdWithArgs,
-			Command: "cmd",
-			Channel: channel,
-			User:    user,
-			Message: "cmd    arg1  arg2",
-			RawArgs: "arg1  arg2",
-			Args:    []string{"arg1", "arg2"},
+			Raw:         cmdWithArgs,
+			Command:     "cmd",
+			Channel:     channel.Channel,
+			ChannelData: channel,
+			User:        user,
+			Message:     "cmd    arg1  arg2",
+			RawArgs:     "arg1  arg2",
+			Args:        []string{"arg1", "arg2"},
 		}},
 		{cmdWithQuotes, &Cmd{
-			Raw:     cmdWithQuotes,
-			Command: "cmd",
-			Channel: channel,
-			User:    user,
-			Message: "cmd    \"arg1  arg2\"",
-			RawArgs: "\"arg1  arg2\"",
-			Args:    []string{"arg1  arg2"},
+			Raw:         cmdWithQuotes,
+			Command:     "cmd",
+			Channel:     channel.Channel,
+			ChannelData: channel,
+			User:        user,
+			Message:     "cmd    \"arg1  arg2\"",
+			RawArgs:     "\"arg1  arg2\"",
+			Args:        []string{"arg1  arg2"},
 		}},
 	}
 
@@ -55,7 +58,7 @@ func TestPaser(t *testing.T) {
 }
 
 func TestInvalidArguments(t *testing.T) {
-	cmd, err := parse("!cmd Invalid \"arg", "#go-bot", &User{Nick: "user123"})
+	cmd, err := parse("!cmd Invalid \"arg", &ChannelData{Channel: "#go-bot"}, &User{Nick: "user123"})
 	if err == nil {
 		t.Error("Expected error, got nil")
 	}