Improved responses to work with Mattermost

The responses of Plan-b-ot were not 100% according to the documentation
of slack. As a result, compatibility with Mattermost was limited.

Plan-b-ot is now 100% compatible to Mattermost as well as slack.

Author: schemar

README.md

@@ -1,11 +1,14 @@
 # Plan-B-ot
-Plan-B-ot is an integration for [slack](https://slack.com/) which allows
-for Scrum Planning Poker inside the slack chat.
+Plan-B-ot is an integration for
+[Mattermost](http://www.mattermost.org/) and
+[slack](https://slack.com/) which allows for Scrum Planning Poker
+inside the Mattermost or slack chat.
 
 Plan-B-ot is written in [go](https://golang.org/).
+Mattermost is an open source project: [Mattermost on GitHub](https://github.com/mattermost).
 
 ## Usage
-In a slack channel, use the slash command (see setup) to interact with
+In a channel, use the slash command (see setup) to interact with
 the bot. If your slash command is called `/planbot`, you can issue the
 following commands:
 ```
@@ -26,12 +29,12 @@ Orders plan-b-ot to print all the voting results in the specified
 channel (see setup).
 
 ## Setup
-### Slack
-You need to setup two integrations in slack: a slach command and a
+### Mattermost/Slack
+You need to setup two integrations: a slach command and an
 incoming web hook
 
 Setup a slash command so users can interact with plan-b-ot:
-- Create a new slash command integration for your slack team.
+- Create a new slash command integration for your team.
 - Pick the command you want to use, e.g. `planbot`.
 - Specify the URL where your plan-b-ot will be running.
 If your server is reachable at `example.com`, your port is `8786`, and
@@ -41,7 +44,7 @@ See also bot setup.
 - Token: you need the token for the bot setup.
 
 Setup an incoming web hook so plan-b-ot can post to your channel:
-- Create a new incoming web hook for your slack team.
+- Create a new incoming web hook for your team.
 - Set the `channel` that you want plan-b-ot to post to.
 - Webhook URL: you need the webhook URL for the bot setup.
 
@@ -50,9 +53,15 @@ Copy `config.json.example` to `config.json`.
 Edit the contents of `config.json` to setup your plan-b-ot:
 - `Port`: The port on which plan-b-ot listens.
 - `Route`: The URL route for plan-b-ot.
-- `Token`: the token from the slack setup (slash command).
-- `Webhook URL`: The webhook URL from the slack setup
-(incoming web hook on slack's side).
+- `Token`: the token from the Mattermost/slack setup (slash command).
+- `Webhook URL`: The webhook URL from the Mattermost/slack setup
+(incoming web hook on Mattermost's/'slack's side).
 
 Run plan-b-ot.
-Now the server is running and waiting for input from slack.
+Now the server is running and waiting for input from Mattermost/slack.
+
+## Contributions
+Contributions are always welcome and do not have to be in a specific
+format.
+
+Simply create a pull request on GitHub.

bot/bot.go

@@ -12,27 +12,39 @@ import (
 	"strconv"
 )
 
+type CommandResponse struct {
+	ResponseType string      `json:"response_type"`
+	Text         string      `json:"text"`
+	GotoLocation string      `json:"goto_location"`
+	Attachments  interface{} `json:"attachments"`
+}
+
 // HandleRequest handles slash commands coming from slack
-func HandleRequest(userName string, args []string) (response string, status int) {
+func HandleRequest(userName string, args []string) (response CommandResponse, status int) {
 	if len(args) < 1 {
-		return "Please define something to do afte the slash command. E.g. `/planbot task T54`", http.StatusBadRequest
+		return CommandResponse{Text: "Please define something to do afte the slash command. E.g. `/planbot task T54`"}, http.StatusBadRequest
 	}
 	action := args[0]
 
-	response = "Unknown Error"
+	responseText := "Unknown Error"
 	status = http.StatusInternalServerError
 
 	if action == "task" {
-		response, status = setTask(userName, args)
+		responseText, status = setTask(userName, args)
 	} else if action == "vote" {
-		response, status = setVote(userName, args)
+		responseText, status = setVote(userName, args)
 	} else if action == "results" {
-		response, status = getResults()
+		responseText, status = getResults()
 	} else {
-		response = fmt.Sprintf("Invalid item after the slash command: `%s`.", action)
+		responseText = fmt.Sprintf("Invalid item after the slash command: `%s`.", action)
 		status = http.StatusBadRequest
 	}
 
+	response = CommandResponse{
+		ResponseType: "ephemeral",
+		Text:         responseText,
+	}
+
 	return response, status
 }
 
@@ -131,5 +143,5 @@ func getResults() (response string, status int) {
 	if err != nil {
 		return err.Error(), http.StatusInternalServerError
 	}
-	return "Results were printed in slack channel", http.StatusOK
+	return "Results were printed in channel", http.StatusOK
 }

bot/slack.go

@@ -11,16 +11,20 @@ import (
 	"net/http"
 )
 
-// sendToSlack sends a message to slack using a incoming web hook
+// sendToSlack sends a message to slack using an incoming web hook
 func sendToSlack(title, message, color string) error {
 	attachment := `{
-		"fallback": "` + title + `: ` + message + `",
-		"color": "` + color + `",
-		"fields": [
+		"attachments": [
 			{
-				"title": "` + title + `",
-				"value": "` + message + `",
-				"short": false
+				"fallback": "` + title + `: ` + message + `",
+				"color": "` + color + `",
+				"fields": [
+					{
+						"title": "` + title + `",
+						"value": "` + message + `",
+						"short": false
+					}
+				]
 			}
 		]
 	}`

planbot.go

@@ -6,10 +6,11 @@
 package main
 
 import (
-	"fmt"
-	"github.com/apheleia/plan-b-ot/bot"
+	"encoding/json"
 	"net/http"
 	"strings"
+
+	"github.com/apheleia/plan-b-ot/bot"
 )
 
 // Runs the server listening for the requests
@@ -36,11 +37,17 @@ func planbotHandler(w http.ResponseWriter, r *http.Request) {
 	words := strings.Fields(text)
 
 	response, status := bot.HandleRequest(userName, words)
+	responseJson, err := json.Marshal(response)
+	if err != nil {
+		http.Error(w, "Cannot marshal JSON in plan-b-ot", http.StatusInternalServerError)
+		return
+	}
 
 	if status != http.StatusOK {
-		http.Error(w, response, status)
+		http.Error(w, response.Text, status)
 		return
 	}
 
-	fmt.Fprintf(w, response)
+	w.WriteHeader(status)
+	w.Write(responseJson)
 }