From af6e2c29eb0a8610fe218e8ec85e739433eac729 Mon Sep 17 00:00:00 2001 From: JoramWilander Date: Thu, 1 Oct 2015 14:07:20 -0400 Subject: Implement outgoing webhooks. --- model/config.go | 1 + model/incoming_webhook.go | 106 ++++++++++++++++++++++++++++++++++++++++ model/outgoing_webhook.go | 121 ++++++++++++++++++++++++++++++++++++++++++++++ model/post.go | 4 ++ model/webhook.go | 106 ---------------------------------------- 5 files changed, 232 insertions(+), 106 deletions(-) create mode 100644 model/incoming_webhook.go create mode 100644 model/outgoing_webhook.go delete mode 100644 model/webhook.go (limited to 'model') diff --git a/model/config.go b/model/config.go index 8a11b7bb7..ef76877c2 100644 --- a/model/config.go +++ b/model/config.go @@ -29,6 +29,7 @@ type ServiceSettings struct { GoogleDeveloperKey string EnableOAuthServiceProvider bool EnableIncomingWebhooks bool + EnableOutgoingWebhooks bool EnablePostUsernameOverride bool EnablePostIconOverride bool EnableTesting bool diff --git a/model/incoming_webhook.go b/model/incoming_webhook.go new file mode 100644 index 000000000..9b9969b96 --- /dev/null +++ b/model/incoming_webhook.go @@ -0,0 +1,106 @@ +// Copyright (c) 2015 Mattermost, Inc. All Rights Reserved. +// See License.txt for license information. + +package model + +import ( + "encoding/json" + "io" +) + +const ( + DEFAULT_WEBHOOK_USERNAME = "webhook" + DEFAULT_WEBHOOK_ICON = "/static/images/webhook_icon.jpg" +) + +type IncomingWebhook struct { + Id string `json:"id"` + CreateAt int64 `json:"create_at"` + UpdateAt int64 `json:"update_at"` + DeleteAt int64 `json:"delete_at"` + UserId string `json:"user_id"` + ChannelId string `json:"channel_id"` + TeamId string `json:"team_id"` +} + +func (o *IncomingWebhook) ToJson() string { + b, err := json.Marshal(o) + if err != nil { + return "" + } else { + return string(b) + } +} + +func IncomingWebhookFromJson(data io.Reader) *IncomingWebhook { + decoder := json.NewDecoder(data) + var o IncomingWebhook + err := decoder.Decode(&o) + if err == nil { + return &o + } else { + return nil + } +} + +func IncomingWebhookListToJson(l []*IncomingWebhook) string { + b, err := json.Marshal(l) + if err != nil { + return "" + } else { + return string(b) + } +} + +func IncomingWebhookListFromJson(data io.Reader) []*IncomingWebhook { + decoder := json.NewDecoder(data) + var o []*IncomingWebhook + err := decoder.Decode(&o) + if err == nil { + return o + } else { + return nil + } +} + +func (o *IncomingWebhook) IsValid() *AppError { + + if len(o.Id) != 26 { + return NewAppError("IncomingWebhook.IsValid", "Invalid Id", "") + } + + if o.CreateAt == 0 { + return NewAppError("IncomingWebhook.IsValid", "Create at must be a valid time", "id="+o.Id) + } + + if o.UpdateAt == 0 { + return NewAppError("IncomingWebhook.IsValid", "Update at must be a valid time", "id="+o.Id) + } + + if len(o.UserId) != 26 { + return NewAppError("IncomingWebhook.IsValid", "Invalid user id", "") + } + + if len(o.ChannelId) != 26 { + return NewAppError("IncomingWebhook.IsValid", "Invalid channel id", "") + } + + if len(o.TeamId) != 26 { + return NewAppError("IncomingWebhook.IsValid", "Invalid channel id", "") + } + + return nil +} + +func (o *IncomingWebhook) PreSave() { + if o.Id == "" { + o.Id = NewId() + } + + o.CreateAt = GetMillis() + o.UpdateAt = o.CreateAt +} + +func (o *IncomingWebhook) PreUpdate() { + o.UpdateAt = GetMillis() +} diff --git a/model/outgoing_webhook.go b/model/outgoing_webhook.go new file mode 100644 index 000000000..64d58ac9d --- /dev/null +++ b/model/outgoing_webhook.go @@ -0,0 +1,121 @@ +// 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() +} diff --git a/model/post.go b/model/post.go index 11f3ad0d5..43839d6a6 100644 --- a/model/post.go +++ b/model/post.go @@ -32,6 +32,10 @@ type Post struct { PendingPostId string `json:"pending_post_id" db:"-"` } +func Something() bool { + return true +} + func (o *Post) ToJson() string { b, err := json.Marshal(o) if err != nil { diff --git a/model/webhook.go b/model/webhook.go deleted file mode 100644 index 9b9969b96..000000000 --- a/model/webhook.go +++ /dev/null @@ -1,106 +0,0 @@ -// Copyright (c) 2015 Mattermost, Inc. All Rights Reserved. -// See License.txt for license information. - -package model - -import ( - "encoding/json" - "io" -) - -const ( - DEFAULT_WEBHOOK_USERNAME = "webhook" - DEFAULT_WEBHOOK_ICON = "/static/images/webhook_icon.jpg" -) - -type IncomingWebhook struct { - Id string `json:"id"` - CreateAt int64 `json:"create_at"` - UpdateAt int64 `json:"update_at"` - DeleteAt int64 `json:"delete_at"` - UserId string `json:"user_id"` - ChannelId string `json:"channel_id"` - TeamId string `json:"team_id"` -} - -func (o *IncomingWebhook) ToJson() string { - b, err := json.Marshal(o) - if err != nil { - return "" - } else { - return string(b) - } -} - -func IncomingWebhookFromJson(data io.Reader) *IncomingWebhook { - decoder := json.NewDecoder(data) - var o IncomingWebhook - err := decoder.Decode(&o) - if err == nil { - return &o - } else { - return nil - } -} - -func IncomingWebhookListToJson(l []*IncomingWebhook) string { - b, err := json.Marshal(l) - if err != nil { - return "" - } else { - return string(b) - } -} - -func IncomingWebhookListFromJson(data io.Reader) []*IncomingWebhook { - decoder := json.NewDecoder(data) - var o []*IncomingWebhook - err := decoder.Decode(&o) - if err == nil { - return o - } else { - return nil - } -} - -func (o *IncomingWebhook) IsValid() *AppError { - - if len(o.Id) != 26 { - return NewAppError("IncomingWebhook.IsValid", "Invalid Id", "") - } - - if o.CreateAt == 0 { - return NewAppError("IncomingWebhook.IsValid", "Create at must be a valid time", "id="+o.Id) - } - - if o.UpdateAt == 0 { - return NewAppError("IncomingWebhook.IsValid", "Update at must be a valid time", "id="+o.Id) - } - - if len(o.UserId) != 26 { - return NewAppError("IncomingWebhook.IsValid", "Invalid user id", "") - } - - if len(o.ChannelId) != 26 { - return NewAppError("IncomingWebhook.IsValid", "Invalid channel id", "") - } - - if len(o.TeamId) != 26 { - return NewAppError("IncomingWebhook.IsValid", "Invalid channel id", "") - } - - return nil -} - -func (o *IncomingWebhook) PreSave() { - if o.Id == "" { - o.Id = NewId() - } - - o.CreateAt = GetMillis() - o.UpdateAt = o.CreateAt -} - -func (o *IncomingWebhook) PreUpdate() { - o.UpdateAt = GetMillis() -} -- cgit v1.2.3-1-g7c22 From 8c8f1bdd633f3afe158dd8c02130a36a5ca9be9d Mon Sep 17 00:00:00 2001 From: JoramWilander Date: Thu, 1 Oct 2015 14:10:52 -0400 Subject: Add model test for outgoing webhooks. --- model/incoming_webhook_test.go | 82 +++++++++++++++++++++++++++++++++++ model/outgoing_webhook_test.go | 97 ++++++++++++++++++++++++++++++++++++++++++ model/webhook_test.go | 82 ----------------------------------- 3 files changed, 179 insertions(+), 82 deletions(-) create mode 100644 model/incoming_webhook_test.go create mode 100644 model/outgoing_webhook_test.go delete mode 100644 model/webhook_test.go (limited to 'model') diff --git a/model/incoming_webhook_test.go b/model/incoming_webhook_test.go new file mode 100644 index 000000000..5297d7d90 --- /dev/null +++ b/model/incoming_webhook_test.go @@ -0,0 +1,82 @@ +// Copyright (c) 2015 Mattermost, Inc. All Rights Reserved. +// See License.txt for license information. + +package model + +import ( + "strings" + "testing" +) + +func TestIncomingWebhookJson(t *testing.T) { + o := IncomingWebhook{Id: NewId()} + json := o.ToJson() + ro := IncomingWebhookFromJson(strings.NewReader(json)) + + if o.Id != ro.Id { + t.Fatal("Ids do not match") + } +} + +func TestIncomingWebhookIsValid(t *testing.T) { + o := IncomingWebhook{} + + 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.UserId = "123" + if err := o.IsValid(); err == nil { + t.Fatal("should be invalid") + } + + o.UserId = 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(err) + } +} + +func TestIncomingWebhookPreSave(t *testing.T) { + o := IncomingWebhook{} + o.PreSave() +} + +func TestIncomingWebhookPreUpdate(t *testing.T) { + o := IncomingWebhook{} + o.PreUpdate() +} diff --git a/model/outgoing_webhook_test.go b/model/outgoing_webhook_test.go new file mode 100644 index 000000000..2ca48c291 --- /dev/null +++ b/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() +} diff --git a/model/webhook_test.go b/model/webhook_test.go deleted file mode 100644 index 5297d7d90..000000000 --- a/model/webhook_test.go +++ /dev/null @@ -1,82 +0,0 @@ -// Copyright (c) 2015 Mattermost, Inc. All Rights Reserved. -// See License.txt for license information. - -package model - -import ( - "strings" - "testing" -) - -func TestIncomingWebhookJson(t *testing.T) { - o := IncomingWebhook{Id: NewId()} - json := o.ToJson() - ro := IncomingWebhookFromJson(strings.NewReader(json)) - - if o.Id != ro.Id { - t.Fatal("Ids do not match") - } -} - -func TestIncomingWebhookIsValid(t *testing.T) { - o := IncomingWebhook{} - - 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.UserId = "123" - if err := o.IsValid(); err == nil { - t.Fatal("should be invalid") - } - - o.UserId = 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(err) - } -} - -func TestIncomingWebhookPreSave(t *testing.T) { - o := IncomingWebhook{} - o.PreSave() -} - -func TestIncomingWebhookPreUpdate(t *testing.T) { - o := IncomingWebhook{} - o.PreUpdate() -} -- cgit v1.2.3-1-g7c22 From a91956e18006fcf2b6ff7025ab9b6920ce45bf7a Mon Sep 17 00:00:00 2001 From: JoramWilander Date: Thu, 1 Oct 2015 15:26:22 -0400 Subject: Add api unit tests for outgoing webhooks. --- model/client.go | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) (limited to 'model') diff --git a/model/client.go b/model/client.go index eea65c50e..9183dcacb 100644 --- a/model/client.go +++ b/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 -- cgit v1.2.3-1-g7c22 From ba3cde024fecbc5c7cf3fee2348fb7db66da2160 Mon Sep 17 00:00:00 2001 From: JoramWilander Date: Thu, 1 Oct 2015 15:44:29 -0400 Subject: Remove temporary test code. --- model/post.go | 4 ---- 1 file changed, 4 deletions(-) (limited to 'model') diff --git a/model/post.go b/model/post.go index 43839d6a6..11f3ad0d5 100644 --- a/model/post.go +++ b/model/post.go @@ -32,10 +32,6 @@ type Post struct { PendingPostId string `json:"pending_post_id" db:"-"` } -func Something() bool { - return true -} - func (o *Post) ToJson() string { b, err := json.Marshal(o) if err != nil { -- cgit v1.2.3-1-g7c22 From f24ea30a75ad52b695f5f275139af1c0495624ac Mon Sep 17 00:00:00 2001 From: JoramWilander Date: Fri, 16 Oct 2015 11:17:24 -0400 Subject: Refactor to hit database less often. --- model/outgoing_webhook.go | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'model') diff --git a/model/outgoing_webhook.go b/model/outgoing_webhook.go index 64d58ac9d..8958dd5b0 100644 --- a/model/outgoing_webhook.go +++ b/model/outgoing_webhook.go @@ -119,3 +119,17 @@ func (o *OutgoingWebhook) PreSave() { 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 +} -- cgit v1.2.3-1-g7c22