Merge pull request #25 from lukepatrick/v3

Update bitbucket uuid check to allow a non-specified uuid, similar to…

README.md

@@ -1,6 +1,6 @@
 Library webhooks
 ================
-<img align="right" src="https://raw.githubusercontent.com/go-playground/webhooks/v3/logo.png">![Project status](https://img.shields.io/badge/version-3.3.1-green.svg)
+<img align="right" src="https://raw.githubusercontent.com/go-playground/webhooks/v3/logo.png">![Project status](https://img.shields.io/badge/version-3.6.0-green.svg)
 [![Build Status](https://travis-ci.org/go-playground/webhooks.svg?branch=v3)](https://travis-ci.org/go-playground/webhooks)
 [![Coverage Status](https://coveralls.io/repos/go-playground/webhooks/badge.svg?branch=v3&service=github)](https://coveralls.io/github/go-playground/webhooks?branch=v3)
 [![Go Report Card](https://goreportcard.com/badge/go-playground/webhooks)](https://goreportcard.com/report/go-playground/webhooks)

bitbucket/bitbucket.go

@@ -80,11 +80,15 @@ func (hook Webhook) ParsePayload(w http.ResponseWriter, r *http.Request) {
 	}
 	webhooks.DefaultLog.Debug(fmt.Sprintf("X-Hook-UUID:%s", uuid))
 
+	if len(hook.uuid) > 0 {
 		if uuid != hook.uuid {
-		webhooks.DefaultLog.Error(fmt.Sprintf("X-Hook-UUID does not match configured uuid of %s", hook.uuid))
+			webhooks.DefaultLog.Error(fmt.Sprintf("X-Hook-UUID %s does not match configured uuid of %s", uuid, hook.uuid))
 			http.Error(w, "403 Forbidden - X-Hook-UUID does not match", http.StatusForbidden)
 			return
 		}
+	} else {
+		webhooks.DefaultLog.Debug("hook uuid not defined - recommend setting for improved security")
+	}
 
 	event := r.Header.Get("X-Event-Key")
 	if event == "" {

github/github.go

@@ -36,6 +36,8 @@ const (
 	DeploymentStatusEvent         Event = "deployment_status"
 	ForkEvent                     Event = "fork"
 	GollumEvent                   Event = "gollum"
+	InstallationEvent             Event = "installation"
+	IntegrationInstallationEvent  Event = "integration_installation"
 	IssueCommentEvent             Event = "issue_comment"
 	IssuesEvent                   Event = "issues"
 	LabelEvent                    Event = "label"
@@ -45,6 +47,7 @@ const (
 	OrganizationEvent             Event = "organization"
 	OrgBlockEvent                 Event = "org_block"
 	PageBuildEvent                Event = "page_build"
+	PingEvent                     Event = "ping"
 	ProjectCardEvent              Event = "project_card"
 	ProjectColumnEvent            Event = "project_column"
 	ProjectEvent                  Event = "project"
@@ -179,6 +182,10 @@ func (hook Webhook) ParsePayload(w http.ResponseWriter, r *http.Request) {
 		var g GollumPayload
 		json.Unmarshal([]byte(payload), &g)
 		hook.runProcessPayloadFunc(fn, g, hd)
+	case InstallationEvent, IntegrationInstallationEvent:
+		var i InstallationPayload
+		json.Unmarshal([]byte(payload), &i)
+		hook.runProcessPayloadFunc(fn, i, hd)
 	case IssueCommentEvent:
 		var i IssueCommentPayload
 		json.Unmarshal([]byte(payload), &i)
@@ -215,6 +222,10 @@ func (hook Webhook) ParsePayload(w http.ResponseWriter, r *http.Request) {
 		var p PageBuildPayload
 		json.Unmarshal([]byte(payload), &p)
 		hook.runProcessPayloadFunc(fn, p, hd)
+	case PingEvent:
+		var p PingPayload
+		json.Unmarshal([]byte(payload), &p)
+		hook.runProcessPayloadFunc(fn, p, hd)
 	case ProjectCardEvent:
 		var p ProjectCardPayload
 		json.Unmarshal([]byte(payload), &p)

github/github_test.go

@@ -48,6 +48,8 @@ func TestMain(m *testing.M) {
 		DeploymentStatusEvent,
 		ForkEvent,
 		GollumEvent,
+		InstallationEvent,
+		IntegrationInstallationEvent,
 		IssueCommentEvent,
 		IssuesEvent,
 		LabelEvent,
@@ -57,6 +59,7 @@ func TestMain(m *testing.M) {
 		OrganizationEvent,
 		OrgBlockEvent,
 		PageBuildEvent,
+		PingEvent,
 		ProjectCardEvent,
 		ProjectColumnEvent,
 		ProjectEvent,
@@ -1309,6 +1312,186 @@ func TestGollumEvent(t *testing.T) {
 	Equal(t, resp.StatusCode, http.StatusOK)
 }
 
+func TestInstallationEvent(t *testing.T) {
+
+	payload := `{
+    "action": "created",
+    "installation": {
+        "id": 80429,
+        "account": {
+            "login": "PombeirP",
+            "id": 138074,
+            "avatar_url": "https://avatars1.githubusercontent.com/u/138074?v=4",
+            "gravatar_id": "",
+            "url": "https://api.github.com/users/PombeirP",
+            "html_url": "https://github.com/PombeirP",
+            "followers_url": "https://api.github.com/users/PombeirP/followers",
+            "following_url": "https://api.github.com/users/PombeirP/following{/other_user}",
+            "gists_url": "https://api.github.com/users/PombeirP/gists{/gist_id}",
+            "starred_url": "https://api.github.com/users/PombeirP/starred{/owner}{/repo}",
+            "subscriptions_url": "https://api.github.com/users/PombeirP/subscriptions",
+            "organizations_url": "https://api.github.com/users/PombeirP/orgs",
+            "repos_url": "https://api.github.com/users/PombeirP/repos",
+            "events_url": "https://api.github.com/users/PombeirP/events{/privacy}",
+            "received_events_url": "https://api.github.com/users/PombeirP/received_events",
+            "type": "User",
+            "site_admin": false
+        },
+        "repository_selection": "selected",
+        "access_tokens_url": "https://api.github.com/installations/80429/access_tokens",
+        "repositories_url": "https://api.github.com/installation/repositories",
+        "html_url": "https://github.com/settings/installations/80429",
+        "app_id": 8157,
+        "target_id": 138074,
+        "target_type": "User",
+        "permissions": {
+            "repository_projects": "write",
+            "issues": "read",
+            "metadata": "read",
+            "pull_requests": "read"
+        },
+        "events": [
+            "pull_request"
+        ],
+        "created_at": 1516025475,
+        "updated_at": 1516025475,
+        "single_file_name": null
+    },
+    "repositories": [
+        {
+            "id": 117381220,
+            "name": "status-github-bot",
+            "full_name": "PombeirP/status-github-bot"
+        }
+    ],
+    "sender": {
+        "login": "PombeirP",
+        "id": 138074,
+        "avatar_url": "https://avatars1.githubusercontent.com/u/138074?v=4",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/PombeirP",
+        "html_url": "https://github.com/PombeirP",
+        "followers_url": "https://api.github.com/users/PombeirP/followers",
+        "following_url": "https://api.github.com/users/PombeirP/following{/other_user}",
+        "gists_url": "https://api.github.com/users/PombeirP/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/PombeirP/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/PombeirP/subscriptions",
+        "organizations_url": "https://api.github.com/users/PombeirP/orgs",
+        "repos_url": "https://api.github.com/users/PombeirP/repos",
+        "events_url": "https://api.github.com/users/PombeirP/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/PombeirP/received_events",
+        "type": "User",
+        "site_admin": false
+    }
+}
+`
+
+	req, err := http.NewRequest("POST", "http://127.0.0.1:3010/webhooks", bytes.NewBuffer([]byte(payload)))
+	req.Header.Set("Content-Type", "application/json")
+	req.Header.Set("X-Github-Event", "installation")
+	req.Header.Set("X-Hub-Signature", "sha1=987338c6e5c21794ab6c258abe51284f9b1df728")
+
+	Equal(t, err, nil)
+
+	client := &http.Client{}
+	resp, err := client.Do(req)
+	Equal(t, err, nil)
+
+	defer resp.Body.Close()
+
+	Equal(t, resp.StatusCode, http.StatusOK)
+}
+
+func TestIntegrationInstallationEvent(t *testing.T) {
+
+	payload := `{
+    "action": "created",
+    "installation": {
+        "id": 80429,
+        "account": {
+            "login": "PombeirP",
+            "id": 138074,
+            "avatar_url": "https://avatars1.githubusercontent.com/u/138074?v=4",
+            "gravatar_id": "",
+            "url": "https://api.github.com/users/PombeirP",
+            "html_url": "https://github.com/PombeirP",
+            "followers_url": "https://api.github.com/users/PombeirP/followers",
+            "following_url": "https://api.github.com/users/PombeirP/following{/other_user}",
+            "gists_url": "https://api.github.com/users/PombeirP/gists{/gist_id}",
+            "starred_url": "https://api.github.com/users/PombeirP/starred{/owner}{/repo}",
+            "subscriptions_url": "https://api.github.com/users/PombeirP/subscriptions",
+            "organizations_url": "https://api.github.com/users/PombeirP/orgs",
+            "repos_url": "https://api.github.com/users/PombeirP/repos",
+            "events_url": "https://api.github.com/users/PombeirP/events{/privacy}",
+            "received_events_url": "https://api.github.com/users/PombeirP/received_events",
+            "type": "User",
+            "site_admin": false
+        },
+        "repository_selection": "selected",
+        "access_tokens_url": "https://api.github.com/installations/80429/access_tokens",
+        "repositories_url": "https://api.github.com/installation/repositories",
+        "html_url": "https://github.com/settings/installations/80429",
+        "app_id": 8157,
+        "target_id": 138074,
+        "target_type": "User",
+        "permissions": {
+            "repository_projects": "write",
+            "issues": "read",
+            "metadata": "read",
+            "pull_requests": "read"
+        },
+        "events": [
+            "pull_request"
+        ],
+        "created_at": 1516025475,
+        "updated_at": 1516025475,
+        "single_file_name": null
+    },
+    "repositories": [
+        {
+            "id": 117381220,
+            "name": "status-github-bot",
+            "full_name": "PombeirP/status-github-bot"
+        }
+    ],
+    "sender": {
+        "login": "PombeirP",
+        "id": 138074,
+        "avatar_url": "https://avatars1.githubusercontent.com/u/138074?v=4",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/PombeirP",
+        "html_url": "https://github.com/PombeirP",
+        "followers_url": "https://api.github.com/users/PombeirP/followers",
+        "following_url": "https://api.github.com/users/PombeirP/following{/other_user}",
+        "gists_url": "https://api.github.com/users/PombeirP/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/PombeirP/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/PombeirP/subscriptions",
+        "organizations_url": "https://api.github.com/users/PombeirP/orgs",
+        "repos_url": "https://api.github.com/users/PombeirP/repos",
+        "events_url": "https://api.github.com/users/PombeirP/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/PombeirP/received_events",
+        "type": "User",
+        "site_admin": false
+    }
+}
+`
+
+	req, err := http.NewRequest("POST", "http://127.0.0.1:3010/webhooks", bytes.NewBuffer([]byte(payload)))
+	req.Header.Set("Content-Type", "application/json")
+	req.Header.Set("X-Github-Event", "integration_installation")
+	req.Header.Set("X-Hub-Signature", "sha1=987338c6e5c21794ab6c258abe51284f9b1df728")
+
+	Equal(t, err, nil)
+
+	client := &http.Client{}
+	resp, err := client.Do(req)
+	Equal(t, err, nil)
+
+	defer resp.Body.Close()
+
+	Equal(t, resp.StatusCode, http.StatusOK)
+}
+
 func TestIssueCommentEvent(t *testing.T) {
 
 	payload := `{
@@ -2560,6 +2743,48 @@ func TestPageBuildEvent(t *testing.T) {
 	Equal(t, resp.StatusCode, http.StatusOK)
 }
 
+func TestPingEvent(t *testing.T) {
+
+	payload := `{
+    "zen": "Keep it logically awesome.",
+    "hook_id": 20081052,
+    "hook": {
+        "type": "App",
+        "id": 20081052,
+        "name": "web",
+        "active": true,
+        "events": [
+            "pull_request"
+        ],
+        "config": {
+            "content_type": "json",
+            "insecure_ssl": "0",
+            "secret": "********",
+            "url": "https://ngrok.io/webhook"
+        },
+        "updated_at": "2018-01-15T10:48:54Z",
+        "created_at": "2018-01-15T10:48:54Z",
+        "app_id": 8157
+    }
+}
+`
+
+	req, err := http.NewRequest("POST", "http://127.0.0.1:3010/webhooks", bytes.NewBuffer([]byte(payload)))
+	req.Header.Set("Content-Type", "application/json")
+	req.Header.Set("X-Github-Event", "ping")
+	req.Header.Set("X-Hub-Signature", "sha1=f82267eb5c6408d5986209da906747f57c11b33b")
+
+	Equal(t, err, nil)
+
+	client := &http.Client{}
+	resp, err := client.Do(req)
+	Equal(t, err, nil)
+
+	defer resp.Body.Close()
+
+	Equal(t, resp.StatusCode, http.StatusOK)
+}
+
 func TestProjectCardEvent(t *testing.T) {
 
 	payload := `{

github/payload.go

@@ -1007,6 +1007,74 @@ type GollumPayload struct {
 	} `json:"sender"`
 }
 
+// InstallationPayload contains the information for GitHub's installation and integration_installation hook events
+type InstallationPayload struct {
+	Action       string `json:"action"`
+	Installation struct {
+		ID      int64 `json:"id"`
+		Account struct {
+			Login             string `json:"login"`
+			ID                int64  `json:"id"`
+			AvatarURL         string `json:"avatar_url"`
+			GravatarID        string `json:"gravatar_id"`
+			URL               string `json:"url"`
+			HTMLURL           string `json:"html_url"`
+			FollowersURL      string `json:"followers_url"`
+			FollowingURL      string `json:"following_url"`
+			GistsURL          string `json:"gists_url"`
+			StarredURL        string `json:"starred_url"`
+			SubscriptionsURL  string `json:"subscriptions_url"`
+			OrganizationsURL  string `json:"organizations_url"`
+			ReposURL          string `json:"repos_url"`
+			EventsURL         string `json:"events_url"`
+			ReceivedEventsURL string `json:"received_events_url"`
+			Type              string `json:"type"`
+			SiteAdmin         bool   `json:"site_admin"`
+		} `json:"account"`
+		RepositorySelection string `json:"repository_selection"`
+		AccessTokensURL     string `json:"access_tokens_url"`
+		RepositoriesURL     string `json:"repositories_url"`
+		HTMLURL             string `json:"html_url"`
+		AppID               int    `json:"app_id"`
+		TargetID            int    `json:"target_id"`
+		TargetType          string `json:"target_type"`
+		Permissions         struct {
+			Issues             string `json:"issues"`
+			Metadata           string `json:"metadata"`
+			PullRequests       string `json:"pull_requests"`
+			RepositoryProjects string `json:"repository_projects"`
+		} `json:"permissions"`
+		Events         []string `json:"events"`
+		CreatedAt      int64    `json:"created_at"`
+		UpdatedAt      int64    `json:"updated_at"`
+		SingleFileName *string  `json:"single_file_name"`
+	} `json:"installation"`
+	Repositories []struct {
+		ID       int64  `json:"id"`
+		Name     string `json:"name"`
+		FullName string `json:"full_name"`
+	} `json:"repositories"`
+	Sender struct {
+		Login             string `json:"login"`
+		ID                int64  `json:"id"`
+		AvatarURL         string `json:"avatar_url"`
+		GravatarID        string `json:"gravatar_id"`
+		URL               string `json:"url"`
+		HTMLURL           string `json:"html_url"`
+		FollowersURL      string `json:"followers_url"`
+		FollowingURL      string `json:"following_url"`
+		GistsURL          string `json:"gists_url"`
+		StarredURL        string `json:"starred_url"`
+		SubscriptionsURL  string `json:"subscriptions_url"`
+		OrganizationsURL  string `json:"organizations_url"`
+		ReposURL          string `json:"repos_url"`
+		EventsURL         string `json:"events_url"`
+		ReceivedEventsURL string `json:"received_events_url"`
+		Type              string `json:"type"`
+		SiteAdmin         bool   `json:"site_admin"`
+	} `json:"sender"`
+}
+
 // IssueCommentPayload contains the information for GitHub's issue_comment hook event
 type IssueCommentPayload struct {
 	Action string `json:"action"`
@@ -2094,6 +2162,27 @@ type PageBuildPayload struct {
 	} `json:"sender"`
 }
 
+// PingPayload contains the information for GitHub's ping hook event
+type PingPayload struct {
+	HookID int `json:"hook_id"`
+	Hook   struct {
+		Type   string   `json:"type"`
+		ID     int64    `json:"id"`
+		Name   string   `json:"name"`
+		Active bool     `json:"active"`
+		Events []string `json:"events"`
+		AppID  int      `json:"app_id"`
+		Config struct {
+			ContentType string `json:"content_type"`
+			InsecureSSL int    `json:"insecure_ssl"`
+			Secret      string `json:"secret"`
+			URL         string `json:"url"`
+		} `json:"config"`
+		CreatedAt time.Time `json:"created_at"`
+		UpdatedAt time.Time `json:"updated_at"`
+	} `json:"hook"`
+}
+
 // ProjectCardPayload contains the information for GitHub's project_payload hook event
 type ProjectCardPayload struct {
 	Action      string `json:"action"`

gitlab/gitlab_test.go

@@ -813,6 +813,29 @@ func TestMergeRequestEvent(t *testing.T) {
       "username": "root",
       "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40\u0026d=identicon"
     },
+    "project": {
+      "id": 1,
+      "name":"Gitlab Test",
+      "description":"Aut reprehenderit ut est.",
+      "web_url":"http://example.com/gitlabhq/gitlab-test",
+      "avatar_url":null,
+      "git_ssh_url":"git@example.com:gitlabhq/gitlab-test.git",
+      "git_http_url":"http://example.com/gitlabhq/gitlab-test.git",
+      "namespace":"GitlabHQ",
+      "visibility_level":20,
+      "path_with_namespace":"gitlabhq/gitlab-test",
+      "default_branch":"master",
+      "homepage":"http://example.com/gitlabhq/gitlab-test",
+      "url":"http://example.com/gitlabhq/gitlab-test.git",
+      "ssh_url":"git@example.com:gitlabhq/gitlab-test.git",
+      "http_url":"http://example.com/gitlabhq/gitlab-test.git"
+    },
+    "repository": {
+      "name": "Gitlab Test",
+      "url": "http://example.com/gitlabhq/gitlab-test.git",
+      "description": "Aut reprehenderit ut est.",
+      "homepage": "http://example.com/gitlabhq/gitlab-test"
+    },
     "object_attributes": {
       "id": 99,
       "target_branch": "master",
@@ -823,15 +846,13 @@ func TestMergeRequestEvent(t *testing.T) {
       "title": "MS-Viewport",
       "created_at": "2013-12-03T17:23:34Z",
       "updated_at": "2013-12-03T17:23:34Z",
-    "st_commits": null,
-    "st_diffs": null,
       "milestone_id": null,
       "state": "opened",
       "merge_status": "unchecked",
       "target_project_id": 14,
       "iid": 1,
       "description": "",
-    "source":{
+      "source": {
         "name":"Awesome Project",
         "description":"Aut reprehenderit ut est.",
         "web_url":"http://example.com/awesome_space/awesome_project",
@@ -881,8 +902,50 @@ func TestMergeRequestEvent(t *testing.T) {
         "username": "user1",
         "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=40\u0026d=identicon"
       }
+    },
+    "labels": [{
+      "id": 206,
+      "title": "API",
+      "color": "#ffffff",
+      "project_id": 14,
+      "created_at": "2013-12-03T17:15:43Z",
+      "updated_at": "2013-12-03T17:15:43Z",
+      "template": false,
+      "description": "API related issues",
+      "type": "ProjectLabel",
+      "group_id": 41
+    }],
+    "changes": {
+      "updated_by_id": [null, 1],
+      "updated_at": ["2017-09-15 16:50:55 UTC", "2017-09-15 16:52:00 UTC"],
+      "labels": {
+        "previous": [{
+          "id": 206,
+          "title": "API",
+          "color": "#ffffff",
+          "project_id": 14,
+          "created_at": "2013-12-03T17:15:43Z",
+          "updated_at": "2013-12-03T17:15:43Z",
+          "template": false,
+          "description": "API related issues",
+          "type": "ProjectLabel",
+          "group_id": 41
+        }],
+        "current": [{
+          "id": 205,
+          "title": "Platform",
+          "color": "#123123",
+          "project_id": 14,
+          "created_at": "2013-12-03T17:15:43Z",
+          "updated_at": "2013-12-03T17:15:43Z",
+          "template": false,
+          "description": "Platform related issues",
+          "type": "ProjectLabel",
+          "group_id": 41
+        }]
+      }
+    }
   }  
-}
 `
 
 	req, err := http.NewRequest("POST", "http://127.0.0.1:3011/webhooks", bytes.NewBuffer([]byte(payload)))

gitlab/payload.go

@@ -38,6 +38,7 @@ type IssueEventPayload struct {
 	Repository       Repository       `json:"repository"`
 	ObjectAttributes ObjectAttributes `json:"object_attributes"`
 	Assignee         Assignee         `json:"assignee"`
+	Changes          Changes          `json:"changes"`
 }
 
 // ConfidentialIssueEventPayload contains the information for GitLab's confidential issue event
@@ -52,6 +53,9 @@ type MergeRequestEventPayload struct {
 	ObjectKind       string           `json:"object_kind"`
 	User             User             `json:"user"`
 	ObjectAttributes ObjectAttributes `json:"object_attributes"`
+	Changes          Changes          `json:"changes"`
+	Project          Project          `json:"project"`
+	Repository       Repository       `json:"repository"`
 }
 
 // PushEventPayload contains the information for GitLab's push event
@@ -409,3 +413,28 @@ type Author struct {
 	Name  string `json:"name"`
 	Email string `json:"email"`
 }
+
+// Changes contains all changes associated with a GitLab issue or MR
+type Changes struct {
+	LabelChanges LabelChanges `json:"labels"`
+}
+
+// LabelChanges contains changes in labels assocatiated with a GitLab issue or MR
+type LabelChanges struct {
+	Previous []Label `json:"previous"`
+	Current  []Label `json:"current"`
+}
+
+// Label contains all of the GitLab label information
+type Label struct {
+	Id          int64      `json:"id"`
+	Title       string     `json:"title"`
+	Color       string     `json:"color"`
+	ProjectId   int64      `json:"project_id"`
+	CreatedAt   customTime `json:"created_at"`
+	UpdatedAt   customTime `json:"updated_at"`
+	Template    bool       `json:"template"`
+	Description string     `json:"description"`
+	Type        string     `json:"type"`
+	GroupId     int64      `json:"group_id"`
+}