Update README.md

Make Logger interface more flexible

.gitignore

@@ -6,6 +6,7 @@
 # Folders
 _obj
 _test
+.idea
 
 # Architecture specific extensions/prefixes
 *.[568vq]

.travis.yml

@@ -1,7 +1,6 @@
 language: go
 go:
-    - 1.7.6
-    - 1.8.3
+    - 1.10.2
     - tip
 matrix:
   allow_failures:
@@ -22,6 +21,7 @@ before_install:
   - mkdir -p $GOPATH/src/gopkg.in
   - ln -s $GOPATH/src/github.com/$TRAVIS_REPO_SLUG $GOPATH/src/gopkg.in/webhooks.v2
   - ln -s $GOPATH/src/github.com/$TRAVIS_REPO_SLUG $GOPATH/src/gopkg.in/webhooks.v3
+  - ln -s $GOPATH/src/github.com/$TRAVIS_REPO_SLUG $GOPATH/src/gopkg.in/webhooks.v4
 
 before_script:
   - go vet ./...
@@ -34,6 +34,6 @@ script:
  - go test -race
 
 after_success: |
-  [ $TRAVIS_GO_VERSION = 1.8.3 ] &&
+  [ $TRAVIS_GO_VERSION = 1.10.2 ] &&
   overalls -project="github.com/go-playground/webhooks" -covermode=count -ignore=.git,examples -debug &&
-  goveralls -coverprofile=overalls.coverprofile -service travis-ci -repotoken $COVERALLS_TOKEN
+  goveralls -coverprofile=overalls.coverprofile -service travis-ci -repotoken $COVERALLS_TOKEN

README.md

@@ -1,10 +1,10 @@
 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.11.0-green.svg)
+<img align="right" src="https://raw.githubusercontent.com/go-playground/webhooks/v3/logo.png">![Project status](https://img.shields.io/badge/version-4.0.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)
+[![Coverage Status](https://coveralls.io/repos/go-playground/webhooks/badge.svg?branch=v4&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)
-[![GoDoc](https://godoc.org/gopkg.in/go-playground/webhooks.v3?status.svg)](https://godoc.org/gopkg.in/go-playground/webhooks.v3)
+[![GoDoc](https://godoc.org/gopkg.in/go-playground/webhooks.v4?status.svg)](https://godoc.org/gopkg.in/go-playground/webhooks.v4)
 ![License](https://img.shields.io/dub/l/vibe-d.svg)
 
 Library webhooks allows for easy receiving and parsing of GitHub, Bitbucket and GitLab Webhook Events
@@ -24,17 +24,17 @@ Installation
 Use go get.
 
 ```shell
-	go get -u gopkg.in/go-playground/webhooks.v3
+go get -u gopkg.in/go-playground/webhooks.v4
 ```
 
 Then import the package into your own code.
 
-	import "gopkg.in/go-playground/webhooks.v3"
+	import "gopkg.in/go-playground/webhooks.v4"
 
 Usage and Documentation
 ------
 
-Please see http://godoc.org/gopkg.in/go-playground/webhooks.v3 for detailed usage docs.
+Please see http://godoc.org/gopkg.in/go-playground/webhooks.v4 for detailed usage docs.
 
 ##### Examples:
 
@@ -46,8 +46,8 @@ import (
 	"fmt"
 	"strconv"
 
-	"gopkg.in/go-playground/webhooks.v3"
-	"gopkg.in/go-playground/webhooks.v3/github"
+	"gopkg.in/go-playground/webhooks.v4"
+	"gopkg.in/go-playground/webhooks.v4/github"
 )
 
 const (
@@ -103,8 +103,8 @@ import (
 	"fmt"
 	"strconv"
 
-	"gopkg.in/go-playground/webhooks.v3"
-	"gopkg.in/go-playground/webhooks.v3/github"
+	"gopkg.in/go-playground/webhooks.v4"
+	"gopkg.in/go-playground/webhooks.v4/github"
 )
 
 const (

bitbucket/bitbucket.go

@@ -6,7 +6,7 @@ import (
 	"io/ioutil"
 	"net/http"
 
-	"gopkg.in/go-playground/webhooks.v3"
+	"gopkg.in/go-playground/webhooks.v4"
 )
 
 // Webhook instance contains all methods needed to process events

bitbucket/bitbucket_test.go

@@ -9,7 +9,7 @@ import (
 	"time"
 
 	. "gopkg.in/go-playground/assert.v1"
-	"gopkg.in/go-playground/webhooks.v3"
+	"gopkg.in/go-playground/webhooks.v4"
 )
 
 // NOTES:

examples/custom-logger/main.go

@@ -5,8 +5,8 @@ import (
 	"log"
 	"strconv"
 
-	"gopkg.in/go-playground/webhooks.v3"
-	"gopkg.in/go-playground/webhooks.v3/github"
+	"gopkg.in/go-playground/webhooks.v4"
+	"gopkg.in/go-playground/webhooks.v4/github"
 )
 
 const (
@@ -18,15 +18,15 @@ type myLogger struct {
 	PrintDebugs bool
 }
 
-func (l *myLogger) Info(msg string) {
+func (l *myLogger) Info(msg ...interface{}) {
 	log.Println(msg)
 }
 
-func (l *myLogger) Error(msg string) {
+func (l *myLogger) Error(msg ...interface{}) {
 	log.Println(msg)
 }
 
-func (l *myLogger) Debug(msg string) {
+func (l *myLogger) Debug(msg ...interface{}) {
 	if !l.PrintDebugs {
 		return
 	}

examples/multiple-handlers/main.go

@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"strconv"
 
-	"gopkg.in/go-playground/webhooks.v3"
-	"gopkg.in/go-playground/webhooks.v3/github"
+	"gopkg.in/go-playground/webhooks.v4"
+	"gopkg.in/go-playground/webhooks.v4/github"
 )
 
 const (

examples/single-handler/main.go

@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"strconv"
 
-	"gopkg.in/go-playground/webhooks.v3"
-	"gopkg.in/go-playground/webhooks.v3/github"
+	"gopkg.in/go-playground/webhooks.v4"
+	"gopkg.in/go-playground/webhooks.v4/github"
 )
 
 const (

github/github.go

@@ -9,7 +9,7 @@ import (
 	"io/ioutil"
 	"net/http"
 
-	"gopkg.in/go-playground/webhooks.v3"
+	"gopkg.in/go-playground/webhooks.v4"
 )
 
 // Webhook instance contains all methods needed to process events

github/github_test.go

@@ -9,7 +9,7 @@ import (
 	"time"
 
 	. "gopkg.in/go-playground/assert.v1"
-	"gopkg.in/go-playground/webhooks.v3"
+	"gopkg.in/go-playground/webhooks.v4"
 )
 
 // NOTES:

github/payload.go

@@ -381,8 +381,7 @@ type DeploymentPayload struct {
 		Sha     string `json:"sha"`
 		Ref     string `json:"ref"`
 		Task    string `json:"task"`
-		Payload struct {
-		} `json:"payload"`
+		Payload string `json:"payload"`
 		Environment string  `json:"environment"`
 		Description *string `json:"description"`
 		Creator     struct {
@@ -555,8 +554,7 @@ type DeploymentStatusPayload struct {
 		Sha     string `json:"sha"`
 		Ref     string `json:"ref"`
 		Task    string `json:"task"`
-		Payload struct {
-		} `json:"payload"`
+		Payload string `json:"payload"`
 		Environment string  `json:"environment"`
 		Description *string `json:"description"`
 		Creator     struct {

gitlab/gitlab.go

@@ -6,7 +6,7 @@ import (
 	"io/ioutil"
 	"net/http"
 
-	"gopkg.in/go-playground/webhooks.v3"
+	"gopkg.in/go-playground/webhooks.v4"
 )
 
 // Webhook instance contains all methods needed to process events

gitlab/gitlab_test.go

@@ -9,7 +9,7 @@ import (
 	"time"
 
 	. "gopkg.in/go-playground/assert.v1"
-	"gopkg.in/go-playground/webhooks.v3"
+	"gopkg.in/go-playground/webhooks.v4"
 )
 
 // NOTES:
@@ -945,7 +945,7 @@ func TestMergeRequestEvent(t *testing.T) {
         }]
       }
     }
-  }  
+  }
 `
 
 	req, err := http.NewRequest("POST", "http://127.0.0.1:3011/webhooks", bytes.NewBuffer([]byte(payload)))

gogs/gogs.go

@@ -0,0 +1,167 @@
+package gogs
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+
+	"crypto/hmac"
+	"crypto/sha256"
+	"encoding/hex"
+	client "github.com/gogits/go-gogs-client"
+	"gopkg.in/go-playground/webhooks.v4"
+)
+
+// 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 Gogs Webhook instance
+type Config struct {
+	Secret string
+}
+
+// Event defines a Gogs hook event type
+type Event string
+
+// Gogs hook types
+const (
+	CreateEvent       Event = "create"
+	DeleteEvent       Event = "delete"
+	ForkEvent         Event = "fork"
+	PushEvent         Event = "push"
+	IssuesEvent       Event = "issues"
+	IssueCommentEvent Event = "issue_comment"
+	PullRequestEvent  Event = "pull_request"
+	ReleaseEvent      Event = "release"
+)
+
+// New creates and returns a WebHook instance denoted by the Provider type
+func New(config *Config) *Webhook {
+	return &Webhook{
+		provider:   webhooks.Gogs,
+		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) {
+	webhooks.DefaultLog.Info("Parsing Payload...")
+
+	event := r.Header.Get("X-Gogs-Event")
+	if len(event) == 0 {
+		webhooks.DefaultLog.Error("Missing X-Gogs-Event Header")
+		http.Error(w, "400 Bad Request - Missing X-Gogs-Event Header", http.StatusBadRequest)
+		return
+	}
+	webhooks.DefaultLog.Debug(fmt.Sprintf("X-Gogs-Event:%s", event))
+
+	gogsEvent := Event(event)
+
+	fn, ok := hook.eventFuncs[gogsEvent]
+	// if no event registered
+	if !ok {
+		webhooks.DefaultLog.Info(fmt.Sprintf("Webhook Event %s not registered, it is recommended to setup only events in gogs that will be registered in the webhook to avoid unnecessary traffic and reduce potential attack vectors.", event))
+		return
+	}
+
+	payload, err := ioutil.ReadAll(r.Body)
+	if err != nil || len(payload) == 0 {
+		webhooks.DefaultLog.Error("Issue reading Payload")
+		http.Error(w, "Issue reading Payload", http.StatusInternalServerError)
+		return
+	}
+	webhooks.DefaultLog.Debug(fmt.Sprintf("Payload:%s", string(payload)))
+
+	// If we have a Secret set, we should check the MAC
+	if len(hook.secret) > 0 {
+		webhooks.DefaultLog.Info("Checking secret")
+		signature := r.Header.Get("X-Gogs-Signature")
+		if len(signature) == 0 {
+			webhooks.DefaultLog.Error("Missing X-Gogs-Signature required for HMAC verification")
+			http.Error(w, "403 Forbidden - Missing X-Gogs-Signature required for HMAC verification", http.StatusForbidden)
+			return
+		}
+		webhooks.DefaultLog.Debug(fmt.Sprintf("X-Gogs-Signature:%s", signature))
+
+		mac := hmac.New(sha256.New, []byte(hook.secret))
+		mac.Write(payload)
+
+		expectedMAC := hex.EncodeToString(mac.Sum(nil))
+
+		if !hmac.Equal([]byte(signature), []byte(expectedMAC)) {
+			webhooks.DefaultLog.Debug(string(payload))
+			http.Error(w, "403 Forbidden - HMAC verification failed", http.StatusForbidden)
+			return
+		}
+	}
+
+	// Make headers available to ProcessPayloadFunc as a webhooks type
+	hd := webhooks.Header(r.Header)
+
+	switch gogsEvent {
+	case CreateEvent:
+		var pe client.CreatePayload
+		json.Unmarshal([]byte(payload), &pe)
+		hook.runProcessPayloadFunc(fn, pe, hd)
+
+	case ReleaseEvent:
+		var re client.ReleasePayload
+		json.Unmarshal([]byte(payload), &re)
+		hook.runProcessPayloadFunc(fn, re, hd)
+
+	case PushEvent:
+		var pe client.PushPayload
+		json.Unmarshal([]byte(payload), &pe)
+		hook.runProcessPayloadFunc(fn, pe, hd)
+
+	case DeleteEvent:
+		var de client.DeletePayload
+		json.Unmarshal([]byte(payload), &de)
+		hook.runProcessPayloadFunc(fn, de, hd)
+
+	case ForkEvent:
+		var fe client.ForkPayload
+		json.Unmarshal([]byte(payload), &fe)
+		hook.runProcessPayloadFunc(fn, fe, hd)
+
+	case IssuesEvent:
+		var ie client.IssuesPayload
+		json.Unmarshal([]byte(payload), &ie)
+		hook.runProcessPayloadFunc(fn, ie, hd)
+
+	case IssueCommentEvent:
+		var ice client.IssueCommentPayload
+		json.Unmarshal([]byte(payload), &ice)
+		hook.runProcessPayloadFunc(fn, ice, hd)
+
+	case PullRequestEvent:
+		var pre client.PullRequestPayload
+		json.Unmarshal([]byte(payload), &pre)
+		hook.runProcessPayloadFunc(fn, pre, 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)
+}

logger.go

@@ -9,11 +9,11 @@ var DefaultLog Logger = new(logger)
 // Logger allows for customizable logging
 type Logger interface {
 	// Info prints basic information.
-	Info(string)
+	Info(...interface{})
 	// Error prints error information.
-	Error(string)
+	Error(...interface{})
 	// Debug prints information usefull for debugging.
-	Debug(string)
+	Debug(...interface{})
 }
 
 // NewLogger returns a new logger for use.
@@ -26,17 +26,17 @@ type logger struct {
 }
 
 // Info prints basic information.
-func (l *logger) Info(msg string) {
+func (l *logger) Info(msg ...interface{}) {
 	log.Println("INFO:", msg)
 }
 
 // v prints error information.
-func (l *logger) Error(msg string) {
+func (l *logger) Error(msg ...interface{}) {
 	log.Println("ERROR:", msg)
 }
 
 // Debug prints information usefull for debugging.
-func (l *logger) Debug(msg string) {
+func (l *logger) Debug(msg ...interface{}) {
 	if !l.PrintDebugs {
 		return
 	}

webhooks.go

@@ -19,6 +19,8 @@ func (p Provider) String() string {
 		return "Bitbucket"
 	case GitLab:
 		return "GitLab"
+	case Gogs:
+		return "Gogs"
 	default:
 		return "Unknown"
 	}
@@ -29,6 +31,7 @@ const (
 	GitHub Provider = iota
 	Bitbucket
 	GitLab
+	Gogs
 )
 
 // Webhook interface defines a webhook to receive events