bot: Invert RegisterWeb

bot/bot.go

@@ -116,9 +116,6 @@ func (b *bot) AddPlugin(h Plugin) {
 	name := reflect.TypeOf(h).String()
 	b.plugins[name] = h
 	b.pluginOrdering = append(b.pluginOrdering, name)
-	if entry := h.RegisterWeb(); entry != nil {
-		b.httpEndPoints[name] = *entry
-	}
 }
 
 func (b *bot) Who(channel string) []user.User {
@@ -260,3 +257,7 @@ func (b *bot) Register(p Plugin, kind Kind, cb Callback) {
 	}
 	b.callbacks[t][kind] = append(b.callbacks[t][kind], cb)
 }
+
+func (b *bot) RegisterWeb(root, name string) {
+	b.httpEndPoints[name] = root
+}

bot/interfaces.go

@@ -59,6 +59,7 @@ type Bot interface {
 	CheckAdmin(string) bool
 	GetEmojiList() map[string]string
 	RegisterFilter(string, func(string) string)
+	RegisterWeb(string, string)
 }
 
 // Connector represents a server connection to a chat service
@@ -74,7 +75,6 @@ type Connector interface {
 }
 
 // Plugin interface used for compatibility with the Plugin interface
-// Probably can disappear once RegisterWeb gets inverted
+// Uhh it turned empty, but we're still using it to ID plugins
 type Plugin interface {
-	RegisterWeb() *string
 }

bot/mock.go

@@ -5,6 +5,7 @@ package bot
 import (
 	"fmt"
 	"log"
+	"net/http"
 	"strconv"
 	"strings"
 
@@ -48,6 +49,7 @@ func (mb *MockBot) Send(kind Kind, args ...interface{}) (string, error) {
 }
 func (mb *MockBot) AddPlugin(f Plugin)                                           {}
 func (mb *MockBot) Register(p Plugin, kind Kind, cb Callback)                    {}
+func (mb *MockBot) RegisterWeb(_, _ string)                                      {}
 func (mb *MockBot) Receive(kind Kind, msg msg.Message, args ...interface{}) bool { return false }
 func (mb *MockBot) Filter(msg msg.Message, s string) string                      { return s }
 func (mb *MockBot) LastMessage(ch string) (msg.Message, error)                   { return msg.Message{}, nil }
@@ -99,5 +101,7 @@ func NewMockBot() *MockBot {
 		Messages: make([]string, 0),
 		Actions:  make([]string, 0),
 	}
+	// If any plugin registered a route, we need to reset those before any new test
+	http.DefaultServeMux = new(http.ServeMux)
 	return &b
 }

plugins/admin/admin.go

@@ -149,8 +149,3 @@ func (p *AdminPlugin) help(kind bot.Kind, m msg.Message, args ...interface{}) bo
 	p.Bot.Send(bot.Message, m.Channel, "This does super secret things that you're not allowed to know about.")
 	return true
 }
-
-// Register any web URLs desired
-func (p *AdminPlugin) RegisterWeb() *string {
-	return nil
-}

plugins/babbler/babbler.go

@@ -162,10 +162,6 @@ func (p *BabblerPlugin) help(kind bot.Kind, msg msg.Message, args ...interface{}
 	return true
 }
 
-func (p *BabblerPlugin) RegisterWeb() *string {
-	return nil
-}
-
 func (p *BabblerPlugin) makeBabbler(name string) (*Babbler, error) {
 	res, err := p.db.Exec(`insert into babblers (babbler) values (?);`, name)
 	if err == nil {

plugins/babbler/babbler_test.go

@@ -312,10 +312,3 @@ func TestHelp(t *testing.T) {
 	bp.help(bot.Help, msg.Message{Channel: "channel"}, []string{})
 	assert.Len(t, mb.Messages, 1)
 }
-
-func TestRegisterWeb(t *testing.T) {
-	mb := bot.NewMockBot()
-	bp := newBabblerPlugin(mb)
-	assert.NotNil(t, bp)
-	assert.Nil(t, bp.RegisterWeb())
-}

plugins/beers/beers.go

@@ -434,8 +434,3 @@ func (p *BeersPlugin) untappdLoop(channel string) {
 		p.checkUntappd(channel)
 	}
 }
-
-// Register any web URLs desired
-func (p BeersPlugin) RegisterWeb() *string {
-	return nil
-}

plugins/beers/beers_test.go

@@ -124,8 +124,3 @@ func TestHelp(t *testing.T) {
 	b.help(bot.Help, msg.Message{Channel: "channel"}, []string{})
 	assert.Len(t, mb.Messages, 1)
 }
-
-func TestRegisterWeb(t *testing.T) {
-	b, _ := makeBeersPlugin(t)
-	assert.Nil(t, b.RegisterWeb())
-}

plugins/couldashouldawoulda/csw.go

@@ -71,7 +71,3 @@ func (p *CSWPlugin) message(kind bot.Kind, message msg.Message, args ...interfac
 
 	return false
 }
-
-func (p *CSWPlugin) RegisterWeb() *string {
-	return nil
-}

plugins/counter/counter.go

@@ -455,11 +455,6 @@ func (p *CounterPlugin) help(kind bot.Kind, message msg.Message, args ...interfa
 	return true
 }
 
-// Register any web URLs desired
-func (p *CounterPlugin) RegisterWeb() *string {
-	return nil
-}
-
 func (p *CounterPlugin) checkMatch(message msg.Message) bool {
 	nick := message.User.Name
 	channel := message.Channel

plugins/counter/counter_test.go

@@ -253,9 +253,3 @@ func TestHelp(t *testing.T) {
 	c.help(bot.Help, msg.Message{Channel: "channel"}, []string{})
 	assert.Len(t, mb.Messages, 1)
 }
-
-func TestRegisterWeb(t *testing.T) {
-	_, c := setup(t)
-	assert.NotNil(t, c)
-	assert.Nil(t, c.RegisterWeb())
-}

plugins/db/db.go

@@ -18,7 +18,9 @@ type DBPlugin struct {
 }
 
 func New(b bot.Bot) *DBPlugin {
-	return &DBPlugin{b, b.Config()}
+	p := &DBPlugin{b, b.Config()}
+	p.registerWeb()
+	return p
 }
 
 func (p *DBPlugin) Message(message msg.Message) bool            { return false }
@@ -27,10 +29,8 @@ func (p *DBPlugin) ReplyMessage(msg.Message, string) bool       { return false }
 func (p *DBPlugin) BotMessage(message msg.Message) bool         { return false }
 func (p *DBPlugin) Help(channel string, parts []string)         {}
 
-func (p *DBPlugin) RegisterWeb() *string {
+func (p *DBPlugin) registerWeb() {
 	http.HandleFunc("/db/catbase.db", p.serveQuery)
-	tmp := "/db/catbase.db"
-	return &tmp
 }
 
 func (p *DBPlugin) serveQuery(w http.ResponseWriter, r *http.Request) {

plugins/dice/dice.go

@@ -74,8 +74,3 @@ func (p *DicePlugin) help(kind bot.Kind, message msg.Message, args ...interface{
 	p.Bot.Send(bot.Message, message.Channel, "Roll dice using notation XdY. Try \"3d20\".")
 	return true
 }
-
-// Register any web URLs desired
-func (p *DicePlugin) RegisterWeb() *string {
-	return nil
-}

plugins/dice/dice_test.go

@@ -89,10 +89,3 @@ func TestHelp(t *testing.T) {
 	c.help(bot.Help, msg.Message{Channel: "channel"}, []string{})
 	assert.Len(t, mb.Messages, 1)
 }
-
-func TestRegisterWeb(t *testing.T) {
-	mb := bot.NewMockBot()
-	c := New(mb)
-	assert.NotNil(t, c)
-	assert.Nil(t, c.RegisterWeb())
-}

plugins/emojifyme/emojifyme.go

@@ -99,10 +99,6 @@ func (p *EmojifyMePlugin) message(kind bot.Kind, message msg.Message, args ...in
 	return false
 }
 
-func (p *EmojifyMePlugin) RegisterWeb() *string {
-	return nil
-}
-
 func stringsContain(haystack []string, needle string) bool {
 	for _, s := range haystack {
 		if s == needle {

plugins/fact/factoid.go

@@ -317,6 +317,8 @@ func New(botInst bot.Bot) *Factoid {
 	botInst.Register(p, bot.Message, p.message)
 	botInst.Register(p, bot.Help, p.help)
 
+	p.registerWeb()
+
 	return p
 }
 
@@ -737,11 +739,10 @@ func (p *Factoid) factTimer(channel string) {
 }
 
 // Register any web URLs desired
-func (p *Factoid) RegisterWeb() *string {
+func (p *Factoid) registerWeb() {
 	http.HandleFunc("/factoid/req", p.serveQuery)
 	http.HandleFunc("/factoid", p.serveQuery)
-	tmp := "/factoid"
-	return &tmp
+	p.Bot.RegisterWeb("/factoid", "Factoid")
 }
 
 func linkify(text string) template.HTML {

plugins/fact/remember.go

@@ -153,11 +153,6 @@ func (p *RememberPlugin) randQuote() string {
 	return f.Tidbit
 }
 
-// Register any web URLs desired
-func (p RememberPlugin) RegisterWeb() *string {
-	return nil
-}
-
 func (p *RememberPlugin) recordMsg(message msg.Message) {
 	log.Printf("Logging message: %s: %s", message.User.Name, message.Body)
 	p.Log[message.Channel] = append(p.Log[message.Channel], message)

plugins/first/first.go

@@ -215,8 +215,3 @@ func (p *FirstPlugin) help(kind bot.Kind, message msg.Message, args ...interface
 	p.Bot.Send(bot.Message, message.Channel, "Sorry, First does not do a goddamn thing.")
 	return true
 }
-
-// Register any web URLs desired
-func (p *FirstPlugin) RegisterWeb() *string {
-	return nil
-}

plugins/inventory/inventory.go

@@ -224,8 +224,3 @@ func checkerr(e error) {
 		log.Println(e)
 	}
 }
-
-func (p *InventoryPlugin) RegisterWeb() *string {
-	// nothing to register
-	return nil
-}

plugins/leftpad/leftpad.go

@@ -62,8 +62,3 @@ func (p *LeftpadPlugin) message(kind bot.Kind, message msg.Message, args ...inte
 
 	return false
 }
-
-func (p *LeftpadPlugin) RegisterWeb() *string {
-	// nothing to register
-	return nil
-}

plugins/leftpad/leftpad_test.go

@@ -85,8 +85,3 @@ func TestNotPadding(t *testing.T) {
 	p.message(makeMessage("!lololol"))
 	assert.Len(t, mb.Messages, 0)
 }
-
-func TestRegisterWeb(t *testing.T) {
-	p, _ := makePlugin(t)
-	assert.Nil(t, p.RegisterWeb())
-}

plugins/nerdepedia/nerdepedia.go

@@ -94,8 +94,3 @@ func (p *NerdepediaPlugin) help(kind bot.Kind, message msg.Message, args ...inte
 	p.bot.Send(bot.Message, message.Channel, "nerd stuff")
 	return true
 }
-
-// Register any web URLs desired
-func (p *NerdepediaPlugin) RegisterWeb() *string {
-	return nil
-}

plugins/picker/picker.go

@@ -115,10 +115,3 @@ func (p *PickerPlugin) help(kind bot.Kind, message msg.Message, args ...interfac
 	p.Bot.Send(bot.Message, message.Channel, "Choose from a list of options. Try \"pick {a,b,c}\".")
 	return true
 }
-
-// Register any web URLs desired
-func (p *PickerPlugin) RegisterWeb() *string {
-	return nil
-}
-
-func (p *PickerPlugin) ReplyMessage(message msg.Message, identifier string) bool { return false }

plugins/plugins.go

@@ -1,15 +1,3 @@
 // © 2013 the CatBase Authors under the WTFPL. See AUTHORS for the list of authors.
 
 package plugins
-
-import "github.com/velour/catbase/bot/msg"
-
-// Plugin interface defines the methods needed to accept a plugin
-type Plugin interface {
-	Message(message msg.Message) bool
-	Event(kind string, message msg.Message) bool
-	BotMessage(message msg.Message) bool
-	LoadData()
-	Help()
-	RegisterWeb()
-}

plugins/reaction/reaction.go

@@ -63,7 +63,3 @@ func (p *ReactionPlugin) message(kind bot.Kind, message msg.Message, args ...int
 
 	return false
 }
-
-func (p *ReactionPlugin) RegisterWeb() *string {
-	return nil
-}

plugins/reminder/reminder.go

@@ -200,10 +200,6 @@ func (p *ReminderPlugin) help(kind bot.Kind, message msg.Message, args ...interf
 	return true
 }
 
-func (p *ReminderPlugin) RegisterWeb() *string {
-	return nil
-}
-
 func (p *ReminderPlugin) getNextReminder() *Reminder {
 	p.mutex.Lock()
 	defer p.mutex.Unlock()

plugins/reminder/reminder_test.go

@@ -226,9 +226,3 @@ func TestHelp(t *testing.T) {
 	c.help(bot.Help, msg.Message{Channel: "channel"}, []string{})
 	assert.Len(t, mb.Messages, 1)
 }
-
-func TestRegisterWeb(t *testing.T) {
-	c, _ := setup(t)
-	assert.NotNil(t, c)
-	assert.Nil(t, c.RegisterWeb())
-}

plugins/rpgORdie/rpgORdie.go

@@ -124,10 +124,6 @@ func (p *RPGPlugin) help(kind bot.Kind, message msg.Message, args ...interface{}
 	return true
 }
 
-func (p *RPGPlugin) RegisterWeb() *string {
-	return nil
-}
-
 func (p *RPGPlugin) replyMessage(kind bot.Kind, message msg.Message, args ...interface{}) bool {
 	identifier := args[0].(string)
 	if strings.ToLower(message.User.Name) != strings.ToLower(p.Bot.Config().Get("Nick", "bot")) {

plugins/rss/rss.go

@@ -102,8 +102,3 @@ func (p *RSSPlugin) help(kind bot.Kind, message msg.Message, args ...interface{}
 	p.Bot.Send(bot.Message, message.Channel, "try '!rss http://rss.cnn.com/rss/edition.rss'")
 	return true
 }
-
-// Register any web URLs desired
-func (p *RSSPlugin) RegisterWeb() *string {
-	return nil
-}

plugins/sisyphus/sisyphus.go

@@ -187,10 +187,6 @@ func (p *SisyphusPlugin) help(kind bot.Kind, message msg.Message, args ...interf
 	return true
 }
 
-func (p *SisyphusPlugin) RegisterWeb() *string {
-	return nil
-}
-
 func (p *SisyphusPlugin) replyMessage(kind bot.Kind, message msg.Message, args ...interface{}) bool {
 	identifier := args[0].(string)
 	if strings.ToLower(message.User.Name) != strings.ToLower(p.Bot.Config().Get("Nick", "bot")) {

plugins/talker/talker.go

@@ -87,8 +87,3 @@ func (p *TalkerPlugin) help(kind bot.Kind, message msg.Message, args ...interfac
 	p.Bot.Send(bot.Message, message.Channel, "Hi, this is talker. I like to talk about FredFelps!")
 	return true
 }
-
-// Register any web URLs desired
-func (p *TalkerPlugin) RegisterWeb() *string {
-	return nil
-}

plugins/talker/talker_test.go

@@ -81,10 +81,3 @@ func TestHelp(t *testing.T) {
 	c.help(bot.Help, msg.Message{Channel: "channel"}, []string{})
 	assert.Len(t, mb.Messages, 1)
 }
-
-func TestRegisterWeb(t *testing.T) {
-	mb := bot.NewMockBot()
-	c := New(mb)
-	assert.NotNil(t, c)
-	assert.Nil(t, c.RegisterWeb())
-}

plugins/tell/tell.go

@@ -41,5 +41,3 @@ func (t *TellPlugin) message(kind bot.Kind, message msg.Message, args ...interfa
 	}
 	return false
 }
-
-func (t *TellPlugin) RegisterWeb() *string { return nil }

plugins/twitch/twitch.go

@@ -71,13 +71,13 @@ func New(b bot.Bot) *TwitchPlugin {
 	}
 
 	b.Register(p, bot.Message, p.message)
+	p.registerWeb()
+
 	return p
 }
 
-func (p *TwitchPlugin) RegisterWeb() *string {
+func (p *TwitchPlugin) registerWeb() {
 	http.HandleFunc("/isstreaming/", p.serveStreaming)
-	tmp := "/isstreaming"
-	return &tmp
 }
 
 func (p *TwitchPlugin) serveStreaming(w http.ResponseWriter, r *http.Request) {

plugins/your/your.go

@@ -57,8 +57,3 @@ func (p *YourPlugin) help(kind bot.Kind, message msg.Message, args ...interface{
 	p.bot.Send(bot.Message, message.Channel, "Your corrects people's grammar.")
 	return true
 }
-
-// Register any web URLs desired
-func (p *YourPlugin) RegisterWeb() *string {
-	return nil
-}

plugins/zork/zork.go

@@ -120,5 +120,3 @@ func (p *ZorkPlugin) help(kind bot.Kind, message msg.Message, args ...interface{
 	p.bot.Send(bot.Message, message.Channel, "Play zork using 'zork <zork command>'.")
 	return true
 }
-
-func (p *ZorkPlugin) RegisterWeb() *string { return nil }