Add GitLab support

README.md

@@ -7,7 +7,7 @@ Library webhooks
 [![GoDoc](https://godoc.org/gopkg.in/go-playground/webhooks.v2?status.svg)](https://godoc.org/gopkg.in/go-playground/webhooks.v2)
 ![License](https://img.shields.io/dub/l/vibe-d.svg)
 
-Library webhooks allows for easy recieving and parsing of GitHub & Bitbucket Webhook Events
+Library webhooks allows for easy recieving and parsing of GitHub, Bitbucket and GitLab Webhook Events
 
 Features:
 
@@ -16,7 +16,7 @@ Features:
 
 Notes:
 
-* Github - Currently only accepting json payloads.
+* Currently only accepting json payloads.
 
 Installation
 ------------
@@ -27,11 +27,11 @@ Use go get.
 	go get -u gopkg.in/go-playground/webhooks.v2
 ```
 
-Then import the validator package into your own code.
+Then import the package into your own code.
 
 	import "gopkg.in/go-playground/webhooks.v2"
 
-Usage and documentation
+Usage and Documentation
 ------
 
 Please see http://godoc.org/gopkg.in/go-playground/webhooks.v2 for detailed usage docs.
@@ -147,14 +147,9 @@ func HandleMultiple(payload interface{}, header webhooks.Header) {
 Contributing
 ------
 
-Pull requests for other service like BitBucket are welcome!
+Pull requests for other services are welcome!
 
-There will always be a development branch for each version i.e. `v1-development`. In order to contribute, 
+If the changes being proposed or requested are breaking changes, please create an issue for discussion.
-please make your pull requests against those branches.
-
-If the changes being proposed or requested are breaking changes, please create an issue, for discussion
-or create a pull request against the highest development branch for example this package has a
-v1 and v1-development branch however, there will also be a v2-development branch even though v2 doesn't exist yet.
 
 License
 ------

gitlab/gitlab.go

@@ -0,0 +1,144 @@
+package gitlab
+
+import (
+	"encoding/json"
+	"io/ioutil"
+	"net/http"
+
+	"gopkg.in/go-playground/webhooks.v2"
+)
+
+// Webhook instance contains all methods needed to process events
+type Webhook struct {
+	provider   webhooks.Provider
+	secret     string
+	eventFuncs map[Event]webhooks.ProcessPayloadFunc
+}
+
+// Config defines the configuration to create a new GitHub Webhook instance
+type Config struct {
+	Secret string
+}
+
+// Event defines a GitHub hook event type
+type Event string
+
+// GitLab hook types
+const (
+	PushEvents          Event = "Push Hook"
+	TagEvents           Event = "Tag Push Hook"
+	IssuesEvents        Event = "Issue Hook"
+	CommentEvents       Event = "Note Hook"
+	MergerRequestEvents Event = "Merge Request Hook"
+	WikiPageEvents      Event = "Wiki Page Hook"
+	PipelineEvents      Event = "Pipeline Hook"
+	BuildEvents         Event = "Build Hook"
+)
+
+// New creates and returns a WebHook instance denoted by the Provider type
+func New(config *Config) *Webhook {
+	return &Webhook{
+		provider:   webhooks.GitLab,
+		secret:     config.Secret,
+		eventFuncs: map[Event]webhooks.ProcessPayloadFunc{},
+	}
+}
+
+// Provider returns the current hooks provider ID
+func (hook Webhook) Provider() webhooks.Provider {
+	return hook.provider
+}
+
+// RegisterEvents registers the function to call when the specified event(s) are encountered
+func (hook Webhook) RegisterEvents(fn webhooks.ProcessPayloadFunc, events ...Event) {
+
+	for _, event := range events {
+		hook.eventFuncs[event] = fn
+	}
+}
+
+// ParsePayload parses and verifies the payload and fires off the mapped function, if it exists.
+func (hook Webhook) ParsePayload(w http.ResponseWriter, r *http.Request) {
+
+	event := r.Header.Get("X-Gitlab-Event")
+	if len(event) == 0 {
+		http.Error(w, "400 Bad Request - Missing X-Gitlab-Event Header", http.StatusBadRequest)
+		return
+	}
+
+	gitLabEvent := Event(event)
+
+	fn, ok := hook.eventFuncs[gitLabEvent]
+	// if no event registered
+	if !ok {
+		return
+	}
+
+	payload, err := ioutil.ReadAll(r.Body)
+	if err != nil || len(payload) == 0 {
+		http.Error(w, "Error reading Body", http.StatusInternalServerError)
+		return
+	}
+
+	// If we have a Secret set, we should check the MAC
+	if len(hook.secret) > 0 {
+
+		signature := r.Header.Get("X-Gitlab-Token")
+
+		if signature != hook.secret {
+			http.Error(w, "403 Forbidden - Token missmatch", http.StatusForbidden)
+			return
+		}
+	}
+
+	// Make headers available to ProcessPayloadFunc as a webhooks type
+	hd := webhooks.Header(r.Header)
+
+	switch gitLabEvent {
+	case PushEvents:
+		var pe PushEventPayload
+		json.Unmarshal([]byte(payload), &pe)
+		hook.runProcessPayloadFunc(fn, pe, hd)
+
+	case TagEvents:
+		var te TagEventPayload
+		json.Unmarshal([]byte(payload), &te)
+		hook.runProcessPayloadFunc(fn, te, hd)
+
+	case IssuesEvents:
+		var ie IssueEventPayload
+		json.Unmarshal([]byte(payload), &ie)
+		hook.runProcessPayloadFunc(fn, ie, hd)
+
+	case CommentEvents:
+		var ce CommentEventPayload
+		json.Unmarshal([]byte(payload), &ce)
+		hook.runProcessPayloadFunc(fn, ce, hd)
+
+	case MergerRequestEvents:
+		var mre MergeRequestEventPayload
+		json.Unmarshal([]byte(payload), &mre)
+		hook.runProcessPayloadFunc(fn, mre, hd)
+
+	case WikiPageEvents:
+		var wpe WikiPageEventPayload
+		json.Unmarshal([]byte(payload), &wpe)
+		hook.runProcessPayloadFunc(fn, wpe, hd)
+
+	case PipelineEvents:
+		var pe PipelineEventPayload
+		json.Unmarshal([]byte(payload), &pe)
+		hook.runProcessPayloadFunc(fn, pe, hd)
+
+	case BuildEvents:
+		var be BuildEventPayload
+		json.Unmarshal([]byte(payload), &be)
+		hook.runProcessPayloadFunc(fn, be, hd)
+	}
+}
+
+func (hook Webhook) runProcessPayloadFunc(fn webhooks.ProcessPayloadFunc, results interface{}, header webhooks.Header) {
+	go func(fn webhooks.ProcessPayloadFunc, results interface{}, header webhooks.Header) {
+		fn(results, header)
+	}(fn, results, header)
+}

gitlab/payload.go

@@ -0,0 +1,404 @@
+package gitlab
+
+import (
+	"strings"
+	"time"
+)
+
+type customTime struct {
+	time.Time
+}
+
+func (t *customTime) UnmarshalJSON(b []byte) (err error) {
+	layout := []string{
+		"2006-01-02 15:04:05 MST",
+		"2006-01-02 15:04:05 Z07:00",
+		"2006-01-02 15:04:05 Z0700",
+		time.RFC3339,
+	}
+	s := strings.Trim(string(b), "\"")
+	if s == "null" {
+		t.Time = time.Time{}
+		return
+	}
+	for _, l := range layout {
+		t.Time, err = time.Parse(l, s)
+		if err == nil {
+			break
+		}
+	}
+	return
+}
+
+// IssueEventPayload contains the information for GitLab's issue event
+type IssueEventPayload struct {
+	ObjectKind       string           `json:"object_kind"`
+	User             User             `json:"user"`
+	Project          Project          `json:"project"`
+	Repository       Repository       `json:"repository"`
+	ObjectAttributes ObjectAttributes `json:"object_attributes"`
+	Assignee         Assignee         `json:"assignee"`
+}
+
+// MergeRequestEventPayload contains the information for GitLab's merge request event
+type MergeRequestEventPayload struct {
+	ObjectKind       string           `json:"object_kind"`
+	User             User             `json:"user"`
+	ObjectAttributes ObjectAttributes `json:"object_attributes"`
+}
+
+// PushEventPayload contains the information for GitLab's push event
+type PushEventPayload struct {
+	ObjectKind        string     `json:"object_kind"`
+	Before            string     `json:"before"`
+	After             string     `json:"after"`
+	Ref               string     `json:"ref"`
+	CheckoutSHA       string     `json:"checkout_sha"`
+	UserID            int        `json:"user_id"`
+	UserName          string     `json:"user_name"`
+	UserEmail         string     `json:"user_email"`
+	UserAvatar        string     `json:"user_avatar"`
+	ProjectID         int        `json:"project_id"`
+	Project           Project    `json:"Project"`
+	Repository        Repository `json:"repository"`
+	Commits           []Commit   `json:"commits"`
+	TotalCommitsCount int        `json:"total_commits_count"`
+}
+
+// TagEventPayload contains the information for GitLab's tag push event
+type TagEventPayload struct {
+	ObjectKind        string     `json:"object_kind"`
+	Before            string     `json:"before"`
+	After             string     `json:"after"`
+	Ref               string     `json:"ref"`
+	CheckoutSHA       string     `json:"checkout_sha"`
+	UserID            int        `json:"user_id"`
+	UserName          string     `json:"user_name"`
+	UserAvatar        string     `json:"user_avatar"`
+	ProjectID         int        `json:"project_id"`
+	Project           Project    `json:"Project"`
+	Repository        Repository `json:"repository"`
+	Commits           []Commit   `json:"commits"`
+	TotalCommitsCount int        `json:"total_commits_count"`
+}
+
+// WikiPageEventPayload contains the information for GitLab's wiki created/updated event
+type WikiPageEventPayload struct {
+	ObjectKind       string           `json:"object_kind"`
+	User             User             `json:"user"`
+	Project          Project          `json:"project"`
+	Wiki             Wiki             `json:"wiki"`
+	ObjectAttributes ObjectAttributes `json:"object_attributes"`
+}
+
+// PipelineEventPayload contains the information for GitLab's pipeline status change event
+type PipelineEventPayload struct {
+	ObjectKind       string           `json:"object_kind"`
+	User             User             `json:"user"`
+	Project          Project          `json:"project"`
+	Commit           Commit           `json:"commit"`
+	ObjectAttributes ObjectAttributes `json:"object_attributes"`
+	Builds           []Build          `json:"builds"`
+}
+
+// CommentEventPayload contains the information for GitLab's comment event
+type CommentEventPayload struct {
+	ObjectKind       string           `json:"object_kind"`
+	User             User             `json:"user"`
+	ProjectID        int              `json:"project_id"`
+	Project          Project          `json:"project"`
+	Repository       Repository       `json:"repository"`
+	ObjectAttributes ObjectAttributes `json:"object_attributes"`
+	MergeRequest     MergeRequest     `json:"merge_request"`
+	Commit           Commit           `json:"commit"`
+	Issue            Issue            `json:"issue"`
+	Snippet          Snippet          `json:"snippet"`
+}
+
+// BuildEventPayload contains the information for GitLab's build status change event
+type BuildEventPayload struct {
+	ObjectKind        string      `json:"object_kind"`
+	Ref               string      `json:"ref"`
+	Tag               bool        `json:"tag"`
+	BeforeSHA         string      `json:"before_sha"`
+	SHA               string      `json:"sha"`
+	BuildID           int         `json:"build_id"`
+	BuildName         string      `json:"build_name"`
+	BuildStage        string      `json:"build_stage"`
+	BuildStatus       string      `json:"build_status"`
+	BuildStartedAt    customTime  `json:"build_started_at"`
+	BuildFinishedAt   customTime  `json:"build_finished_at"`
+	BuildDuration     int         `json:"build_duration"`
+	BuildAllowFailure bool        `json:"build_allow_failure"`
+	ProjectID         int         `json:"project_id"`
+	ProjectName       string      `json:"project_name"`
+	User              User        `json:"user"`
+	Commit            BuildCommit `json:"commit"`
+	Repository        Repository  `json:"repository"`
+}
+
+// Issue contais all of the GitLab issue information
+type Issue struct {
+	ID          int        `json:"id"`
+	Title       string     `json:"title"`
+	AssigneeID  int        `json:"assignee_id"`
+	AuthorID    int        `json:"author_id"`
+	ProjectID   int        `json:"project_id"`
+	CreatedAt   customTime `json:"created_at"`
+	UpdatedAt   customTime `json:"updated_at"`
+	Position    int        `json:"position"`
+	BranchName  string     `json:"branch_name"`
+	Description string     `json:"description"`
+	MilestoneID int        `json:"milestone_id"`
+	State       string     `json:"state"`
+	IID         int        `json:"iid"`
+}
+
+// Build contais all of the GitLab build information
+type Build struct {
+	ID            int           `json:"id"`
+	Stage         string        `json:"stage"`
+	Name          string        `json:"name"`
+	Status        string        `json:"status"`
+	CreatedAt     customTime    `json:"created_at"`
+	StartedAt     customTime    `json:"started_at"`
+	FinishedAt    customTime    `json:"finished_at"`
+	When          string        `json:"when"`
+	Manual        bool          `json:"manual"`
+	User          User          `json:"user"`
+	Runner        string        `json:"runner"`
+	ArtifactsFile ArtifactsFile `json:"artifactsfile"`
+}
+
+// ArtifactsFile contais all of the GitLab artifact information
+type ArtifactsFile struct {
+	Filename string `json:"filename"`
+	Size     string `json:"size"`
+}
+
+// Wiki contais all of the GitLab wiki information
+type Wiki struct {
+	WebURL            string `json:"web_url"`
+	GitSSHURL         string `json:"git_ssh_url"`
+	GitHTTPURL        string `json:"git_http_url"`
+	PathWithNamespace string `json:"path_with_namespace"`
+	DefaultBranch     string `json:"default_branch"`
+}
+
+// Commit contais all of the GitLab commit information
+type Commit struct {
+	ID        string     `json:"id"`
+	Message   string     `json:"message"`
+	Timestamp customTime `json:"timestamp"`
+	URL       string     `json:"url"`
+	Author    Author     `json:"author"`
+	Added     []string   `json:"added"`
+	Modified  []string   `json:"modified"`
+	Removed   []string   `json:"removed"`
+}
+
+// BuildCommit contais all of the GitLab build commit information
+type BuildCommit struct {
+	ID          int        `json:"id"`
+	SHA         string     `json:"sha"`
+	Message     string     `json:"message"`
+	AuthorName  string     `json:"auuthor_name"`
+	AuthorEmail string     `json:"author_email"`
+	Status      string     `json:"status"`
+	Duration    int        `json:"duration"`
+	StartedAt   customTime `json:"started_at"`
+	FinishedAt  customTime `json:"finished_at"`
+}
+
+// Snippet contais all of the GitLab snippet information
+type Snippet struct {
+	ID              int        `json:"id"`
+	Title           string     `json:"title"`
+	Content         string     `json:"content"`
+	AuthorID        int        `json:"author_id"`
+	ProjectID       int        `json:"project_id"`
+	CreatedAt       customTime `json:"created_at"`
+	UpdatedAt       customTime `json:"updated_at"`
+	FileName        string     `json:"file_name"`
+	ExpiresAt       customTime `json:"expires_at"`
+	Type            string     `json:"type"`
+	VisibilityLevel int        `json:"visibility_level"`
+}
+
+// User contais all of the GitLab user information
+type User struct {
+	Name      string `json:"name"`
+	UserName  string `json:"username"`
+	AvatarURL string `json:"avatar_url"`
+}
+
+// Project contais all of the GitLab project information
+type Project struct {
+	Name              string `json:"name"`
+	Description       string `json:"description"`
+	WebURL            string `json:"web_url"`
+	AvatarURL         string `json:"avatar_url"`
+	GitSSSHURL        string `json:"git_ssh_url"`
+	GitHTTPURL        string `json:"git_http_url"`
+	Namespace         string `json:"namespace"`
+	VisibilityLevel   int    `json:"visibility_level"`
+	PathWithNamespace string `json:"path_with_namespace"`
+	DefaultBranch     string `json:"default_branch"`
+	Homepage          string `json:"homepage"`
+	URL               string `json:"url"`
+	SSHURL            string `json:"ssh_url"`
+	HTTPURL           string `json:"http_url"`
+}
+
+// Repository contais all of the GitLab repository information
+type Repository struct {
+	Name        string `json:"name"`
+	URL         string `json:"url"`
+	Description string `json:"description"`
+	Homepage    string `json:"homepage"`
+}
+
+// ObjectAttributes contais all of the GitLab object attributes information
+type ObjectAttributes struct {
+	ID              int        `json:"id"`
+	Title           string     `json:"title"`
+	AssigneeID      int        `json:"assignee_id"`
+	AuthorID        int        `json:"author_id"`
+	ProjectID       int        `json:"project_id"`
+	CreatedAt       customTime `json:"created_at"`
+	UpdatedAt       customTime `json:"updated_at"`
+	Position        int        `json:"position"`
+	BranchName      string     `json:"branch_name"`
+	Description     string     `json:"description"`
+	MilestoneID     int        `json:"milestone_id"`
+	State           string     `json:"state"`
+	IID             int        `json:"iid"`
+	URL             string     `json:"url"`
+	Action          string     `json:"action"`
+	TargetBranch    string     `json:"target_branch"`
+	SourceBranch    string     `json:"source_branch"`
+	SourceProjectID int        `json:"source_project_id"`
+	TargetProjectID int        `json:"target_project_id"`
+	StCommits       string     `json:"st_commits"`
+	MergeStatus     string     `json:"merge_status"`
+	Content         string     `json:"content"`
+	Format          string     `json:"format"`
+	Message         string     `json:"message"`
+	Slug            string     `json:"slug"`
+	Ref             string     `json:"ref"`
+	Tag             bool       `json:"tag"`
+	SHA             string     `json:"sha"`
+	BeforeSHA       string     `json:"before_sha"`
+	Status          string     `json:"status"`
+	Stages          []string   `json:"stages"`
+	Duration        int        `json:"duration"`
+	Note            string     `json:"note"`
+	NotebookType    string     `json:"noteable_type"`
+	At              customTime `json:"attachment"`
+	LineCode        string     `json:"line_code"`
+	CommitID        string     `json:"commit_id"`
+	NoteableID      int        `json:"noteable_id"`
+	System          bool       `json:"system"`
+	WorkInProgress  bool       `json:"work_in_progress"`
+	StDiffs         []StDiff   `json:"st_diffs"`
+	Source          Source     `json:"source"`
+	Target          Target     `json:"target"`
+	LastCommit      LastCommit `json:"last_commit"`
+	Assignee        Assignee   `json:"assignee"`
+}
+
+// MergeRequest contais all of the GitLab merge request information
+type MergeRequest struct {
+	ID              int        `json:"id"`
+	TargetBranch    string     `json:"target_branch"`
+	SourceBranch    string     `json:"source_branch"`
+	SourceProjectID string     `json:"source_project_id"`
+	AssigneeID      int        `json:"assignee_id"`
+	AuthorID        int        `json:"author_id"`
+	Title           string     `json:"title"`
+	CreatedAt       customTime `json:"created_at"`
+	UpdatedAt       customTime `json:"updated_at"`
+	MilestoneID     int        `json:"milestone_id"`
+	State           string     `json:"state"`
+	MergeStatus     string     `json:"merge_status"`
+	TargetProjectID int        `json:"target_project_id"`
+	IID             int        `json:"iid"`
+	Description     string     `json:"description"`
+	Position        int        `json:"position"`
+	LockedAt        customTime `json:"locked_at"`
+	Source          Source     `json:"source"`
+	Target          Target     `json:"target"`
+	LastCommit      LastCommit `json:"last_commit"`
+	WorkInProgress  bool       `json:"work_in_progress"`
+	Assignee        Assignee   `json:"assignee"`
+}
+
+// Assignee contais all of the GitLab assignee information
+type Assignee struct {
+	Name      string `json:"name"`
+	Username  string `json:"username"`
+	AvatarURL string `json:"avatar_url"`
+}
+
+// StDiff contais all of the GitLab diff information
+type StDiff struct {
+	Diff        string `json:"diff"`
+	NewPath     string `json:"new_path"`
+	OldPath     string `json:"old_path"`
+	AMode       string `json:"a_mode"`
+	BMode       string `json:"b_mode"`
+	NewFile     bool   `json:"new_file"`
+	RenamedFile bool   `json:"renamed_file"`
+	DeletedFile bool   `json:"deleted_file"`
+}
+
+// Source contais all of the GitLab source information
+type Source struct {
+	Name              string `json:"name"`
+	Description       string `json:"description"`
+	WebURL            string `json:"web_url"`
+	AvatarURL         string `json:"avatar_url"`
+	GitSSHURL         string `json:"git_ssh_url"`
+	GitHTTPURL        string `json:"git_http_url"`
+	Namespace         string `json:"namespace"`
+	VisibilityLevel   int    `json:"visibility_level"`
+	PathWithNamespace string `json:"path_with_namespace"`
+	DefaultBranch     string `json:"default_branch"`
+	Homepage          string `json:"homepage"`
+	URL               string `json:"url"`
+	SSHURL            string `json:"ssh_url"`
+	HTTPURL           string `json:"http_url"`
+}
+
+// Target contais all of the GitLab target information
+type Target struct {
+	Name              string `json:"name"`
+	Description       string `json:"description"`
+	WebURL            string `json:"web_url"`
+	AvatarURL         string `json:"avatar_url"`
+	GitSSHURL         string `json:"git_ssh_url"`
+	GitHTTPURL        string `json:"git_http_url"`
+	Namespace         string `json:"namespace"`
+	VisibilityLevel   int    `json:"visibility_level"`
+	PathWithNamespace string `json:"path_with_namespace"`
+	DefaultBranch     string `json:"default_branch"`
+	Homepage          string `json:"homepage"`
+	URL               string `json:"url"`
+	SSHURL            string `json:"ssh_url"`
+	HTTPURL           string `json:"http_url"`
+}
+
+// LastCommit contais all of the GitLab last commit information
+type LastCommit struct {
+	ID        string     `json:"id"`
+	Message   string     `json:"message"`
+	Timestamp customTime `json:"timestamp"`
+	URL       string     `json:"url"`
+	Author    Author     `json:"author"`
+}
+
+// Author contais all of the GitLab author information
+type Author struct {
+	Name  string `json:"name"`
+	Email string `json:"email"`
+}

webhooks.go

@@ -2,7 +2,7 @@ package webhooks
 
 import "net/http"
 
-// Webhook provides http.Header to minimize imports
+// Header provides http.Header to minimize imports
 type Header http.Header
 
 // Provider defines the type of webhook
@@ -14,6 +14,8 @@ func (p Provider) String() string {
 		return "GitHub"
 	case Bitbucket:
 		return "Bitbucket"
+	case GitLab:
+		return "GitLab"
 	default:
 		return "Unknown"
 	}
@@ -23,6 +25,7 @@ func (p Provider) String() string {
 const (
 	GitHub Provider = iota
 	Bitbucket
+	GitLab
 )
 
 // Webhook interface defines a webhook to recieve events
@@ -67,7 +70,7 @@ func RunServer(s *http.Server, hook Webhook, path string) error {
 // RunTLSServer runs a custom server with TLS configuration.
 // NOTE: http.Server Handler will be overridden by this library, just set it to nil.
 // Setting the Certificates can be done in the http.Server.TLSConfig.Certificates
-// see example here: https://gopkg.in/go-playground/webhooks.v1/blob/master/webhooks_test.go#L178
+// see example here: https://github.com/go-playground/webhooks/blob/v2/webhooks_test.go#L178
 func RunTLSServer(s *http.Server, hook Webhook, path string) error {
 
 	srv := &server{

webhooks_test.go

@@ -236,5 +236,6 @@ func TestProviderString(t *testing.T) {
 
 	Equal(t, GitHub.String(), "GitHub")
 	Equal(t, Bitbucket.String(), "Bitbucket")
+	Equal(t, GitLab.String(), "GitLab")
 	Equal(t, Provider(999999).String(), "Unknown")
 }