Merge pull request #1108 from mattermost/plt-235

PLT-235 Implement outgoing webhooks.

model/client.go

@@ -879,6 +879,42 @@ func (c *Client) GetPreferenceCategory(category string) (*Result, *AppError) {
 	}
 }
 
+func (c *Client) CreateOutgoingWebhook(hook *OutgoingWebhook) (*Result, *AppError) {
+	if r, err := c.DoApiPost("/hooks/outgoing/create", hook.ToJson()); err != nil {
+		return nil, err
+	} else {
+		return &Result{r.Header.Get(HEADER_REQUEST_ID),
+			r.Header.Get(HEADER_ETAG_SERVER), OutgoingWebhookFromJson(r.Body)}, nil
+	}
+}
+
+func (c *Client) DeleteOutgoingWebhook(data map[string]string) (*Result, *AppError) {
+	if r, err := c.DoApiPost("/hooks/outgoing/delete", MapToJson(data)); err != nil {
+		return nil, err
+	} else {
+		return &Result{r.Header.Get(HEADER_REQUEST_ID),
+			r.Header.Get(HEADER_ETAG_SERVER), MapFromJson(r.Body)}, nil
+	}
+}
+
+func (c *Client) ListOutgoingWebhooks() (*Result, *AppError) {
+	if r, err := c.DoApiGet("/hooks/outgoing/list", "", ""); err != nil {
+		return nil, err
+	} else {
+		return &Result{r.Header.Get(HEADER_REQUEST_ID),
+			r.Header.Get(HEADER_ETAG_SERVER), OutgoingWebhookListFromJson(r.Body)}, nil
+	}
+}
+
+func (c *Client) RegenOutgoingWebhookToken(data map[string]string) (*Result, *AppError) {
+	if r, err := c.DoApiPost("/hooks/outgoing/regen_token", MapToJson(data)); err != nil {
+		return nil, err
+	} else {
+		return &Result{r.Header.Get(HEADER_REQUEST_ID),
+			r.Header.Get(HEADER_ETAG_SERVER), OutgoingWebhookFromJson(r.Body)}, nil
+	}
+}
+
 func (c *Client) MockSession(sessionToken string) {
 	c.AuthToken = sessionToken
 	c.AuthType = HEADER_BEARER

model/config.go

@@ -29,6 +29,7 @@ type ServiceSettings struct {
 	GoogleDeveloperKey         string
 	EnableOAuthServiceProvider bool
 	EnableIncomingWebhooks     bool
+	EnableOutgoingWebhooks     bool
 	EnablePostUsernameOverride bool
 	EnablePostIconOverride     bool
 	EnableTesting              bool

model/outgoing_webhook.go

@@ -0,0 +1,135 @@
+// Copyright (c) 2015 Spinpunch, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package model
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+)
+
+type OutgoingWebhook struct {
+	Id           string      `json:"id"`
+	Token        string      `json:"token"`
+	CreateAt     int64       `json:"create_at"`
+	UpdateAt     int64       `json:"update_at"`
+	DeleteAt     int64       `json:"delete_at"`
+	CreatorId    string      `json:"creator_id"`
+	ChannelId    string      `json:"channel_id"`
+	TeamId       string      `json:"team_id"`
+	TriggerWords StringArray `json:"trigger_words"`
+	CallbackURLs StringArray `json:"callback_urls"`
+}
+
+func (o *OutgoingWebhook) ToJson() string {
+	b, err := json.Marshal(o)
+	if err != nil {
+		return ""
+	} else {
+		return string(b)
+	}
+}
+
+func OutgoingWebhookFromJson(data io.Reader) *OutgoingWebhook {
+	decoder := json.NewDecoder(data)
+	var o OutgoingWebhook
+	err := decoder.Decode(&o)
+	if err == nil {
+		return &o
+	} else {
+		return nil
+	}
+}
+
+func OutgoingWebhookListToJson(l []*OutgoingWebhook) string {
+	b, err := json.Marshal(l)
+	if err != nil {
+		return ""
+	} else {
+		return string(b)
+	}
+}
+
+func OutgoingWebhookListFromJson(data io.Reader) []*OutgoingWebhook {
+	decoder := json.NewDecoder(data)
+	var o []*OutgoingWebhook
+	err := decoder.Decode(&o)
+	if err == nil {
+		return o
+	} else {
+		return nil
+	}
+}
+
+func (o *OutgoingWebhook) IsValid() *AppError {
+
+	if len(o.Id) != 26 {
+		return NewAppError("OutgoingWebhook.IsValid", "Invalid Id", "")
+	}
+
+	if len(o.Token) != 26 {
+		return NewAppError("OutgoingWebhook.IsValid", "Invalid token", "")
+	}
+
+	if o.CreateAt == 0 {
+		return NewAppError("OutgoingWebhook.IsValid", "Create at must be a valid time", "id="+o.Id)
+	}
+
+	if o.UpdateAt == 0 {
+		return NewAppError("OutgoingWebhook.IsValid", "Update at must be a valid time", "id="+o.Id)
+	}
+
+	if len(o.CreatorId) != 26 {
+		return NewAppError("OutgoingWebhook.IsValid", "Invalid user id", "")
+	}
+
+	if len(o.ChannelId) != 0 && len(o.ChannelId) != 26 {
+		return NewAppError("OutgoingWebhook.IsValid", "Invalid channel id", "")
+	}
+
+	if len(o.TeamId) != 26 {
+		return NewAppError("OutgoingWebhook.IsValid", "Invalid team id", "")
+	}
+
+	if len(fmt.Sprintf("%s", o.TriggerWords)) > 1024 {
+		return NewAppError("OutgoingWebhook.IsValid", "Invalid trigger words", "")
+	}
+
+	if len(o.CallbackURLs) == 0 || len(fmt.Sprintf("%s", o.CallbackURLs)) > 1024 {
+		return NewAppError("OutgoingWebhook.IsValid", "Invalid callback urls", "")
+	}
+
+	return nil
+}
+
+func (o *OutgoingWebhook) PreSave() {
+	if o.Id == "" {
+		o.Id = NewId()
+	}
+
+	if o.Token == "" {
+		o.Token = NewId()
+	}
+
+	o.CreateAt = GetMillis()
+	o.UpdateAt = o.CreateAt
+}
+
+func (o *OutgoingWebhook) PreUpdate() {
+	o.UpdateAt = GetMillis()
+}
+
+func (o *OutgoingWebhook) HasTriggerWord(word string) bool {
+	if len(o.TriggerWords) == 0 || len(word) == 0 {
+		return false
+	}
+
+	for _, trigger := range o.TriggerWords {
+		if trigger == word {
+			return true
+		}
+	}
+
+	return false
+}

model/outgoing_webhook_test.go

@@ -0,0 +1,97 @@
+// Copyright (c) 2015 Spinpunch, Inc. All Rights Reserved.
+// See License.txt for license information.
+
+package model
+
+import (
+	"strings"
+	"testing"
+)
+
+func TestOutgoingWebhookJson(t *testing.T) {
+	o := OutgoingWebhook{Id: NewId()}
+	json := o.ToJson()
+	ro := OutgoingWebhookFromJson(strings.NewReader(json))
+
+	if o.Id != ro.Id {
+		t.Fatal("Ids do not match")
+	}
+}
+
+func TestOutgoingWebhookIsValid(t *testing.T) {
+	o := OutgoingWebhook{}
+
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.Id = NewId()
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.CreateAt = GetMillis()
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.UpdateAt = GetMillis()
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.CreatorId = "123"
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.CreatorId = NewId()
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.Token = "123"
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.Token = NewId()
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.ChannelId = "123"
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.ChannelId = NewId()
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.TeamId = "123"
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.TeamId = NewId()
+	if err := o.IsValid(); err == nil {
+		t.Fatal("should be invalid")
+	}
+
+	o.CallbackURLs = []string{"http://nowhere.com/"}
+	if err := o.IsValid(); err != nil {
+		t.Fatal(err)
+	}
+}
+
+func TestOutgoingWebhookPreSave(t *testing.T) {
+	o := OutgoingWebhook{}
+	o.PreSave()
+}
+
+func TestOutgoingWebhookPreUpdate(t *testing.T) {
+	o := OutgoingWebhook{}
+	o.PreUpdate()
+}