Merge pull request #10 from go-playground/add-handler-support

Add handler support

.travis.yml

@@ -0,0 +1,39 @@
+language: go
+go:
+    - 1.7.5
+    - 1.8.1
+    - tip
+matrix:
+  allow_failures:
+    - go: tip
+
+notifications:
+    email:
+        recipients: dean.karn@gmail.com
+        on_success: change
+        on_failure: always
+
+before_install:
+  - go get -u github.com/go-playground/overalls
+  - go get -u github.com/mattn/goveralls
+  - go get -u golang.org/x/tools/cmd/cover
+  - go get -u github.com/golang/lint/golint
+  - go get -u github.com/gordonklaus/ineffassign
+  - 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
+
+before_script:
+  - go vet ./...
+
+script:
+ - gofmt -d -s .
+ - golint ./...
+ - ineffassign ./
+ - go test -v ./...
+ - go test -race
+
+after_success: |
+  [ $TRAVIS_GO_VERSION = 1.8.1 ] &&
+  overalls -project="github.com/go-playground/webhooks" -covermode=count -ignore=.git,examples -debug &&
+  goveralls -coverprofile=overalls.coverprofile -service travis-ci -repotoken $COVERALLS_TOKEN

README.md

@@ -1,7 +1,7 @@
 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.0.0-green.svg)
-[![Build Status](https://semaphoreci.com/api/v1/joeybloggs/webhooks/branches/v3/badge.svg)](https://semaphoreci.com/joeybloggs/webhooks)
+<img align="right" src="https://raw.githubusercontent.com/go-playground/webhooks/v3/logo.png">![Project status](https://img.shields.io/badge/version-3.1.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)
 [![GoDoc](https://godoc.org/gopkg.in/go-playground/webhooks.v3?status.svg)](https://godoc.org/gopkg.in/go-playground/webhooks.v3)

github/github.go

@@ -6,7 +6,6 @@ import (
 	"encoding/hex"
 	"encoding/json"
 	"io/ioutil"
-	"log"
 	"net/http"
 
 	"gopkg.in/go-playground/webhooks.v3"
@@ -98,7 +97,6 @@ func (hook Webhook) RegisterEvents(fn webhooks.ProcessPayloadFunc, events ...Eve
 // 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) {
 
-	log.Println("Gettting X-GitHub-Event")
 	event := r.Header.Get("X-GitHub-Event")
 	if len(event) == 0 {
 		http.Error(w, "400 Bad Request - Missing X-GitHub-Event Header", http.StatusBadRequest)
@@ -107,27 +105,21 @@ func (hook Webhook) ParsePayload(w http.ResponseWriter, r *http.Request) {
 
 	gitHubEvent := Event(event)
 
-	log.Println("Looking for Hook:", gitHubEvent)
 	fn, ok := hook.eventFuncs[gitHubEvent]
 	// if no event registered
 	if !ok {
 		return
 	}
 
-	log.Println("READING PAYLOAD FROM BODY")
-
 	payload, err := ioutil.ReadAll(r.Body)
 	if err != nil || len(payload) == 0 {
 		http.Error(w, "Error reading Body", http.StatusInternalServerError)
 		return
 	}
 
-	log.Println("Checking GitHub secret")
-
 	// If we have a Secret set, we should check the MAC
 	if len(hook.secret) > 0 {
 
-		log.Println("Get GitHub signature")
 		signature := r.Header.Get("X-Hub-Signature")
 
 		if len(signature) == 0 {
@@ -140,245 +132,141 @@ func (hook Webhook) ParsePayload(w http.ResponseWriter, r *http.Request) {
 
 		expectedMAC := hex.EncodeToString(mac.Sum(nil))
 
-		log.Println("Checking HMAC Equality")
-
 		if !hmac.Equal([]byte(signature[5:]), []byte(expectedMAC)) {
 			http.Error(w, "403 Forbidden - HMAC verification failed", http.StatusForbidden)
 			return
 		}
-
-		log.Println("HMAC Equal")
 	}
 
 	// Make headers available to ProcessPayloadFunc as a webhooks type
 	hd := webhooks.Header(r.Header)
-	var pl interface{}
-
-	log.Println("Unmarshal based on GitHub event:", gitHubEvent)
 
 	switch gitHubEvent {
 	case CommitCommentEvent:
-
 		var cc CommitCommentPayload
-
-		err = json.Unmarshal([]byte(payload), &cc)
-		pl = cc
-
+		json.Unmarshal([]byte(payload), &cc)
+		hook.runProcessPayloadFunc(fn, cc, hd)
 	case CreateEvent:
-
 		var c CreatePayload
-
-		err = json.Unmarshal([]byte(payload), &c)
-		pl = c
-
+		json.Unmarshal([]byte(payload), &c)
+		hook.runProcessPayloadFunc(fn, c, hd)
 	case DeleteEvent:
 		var d DeletePayload
 		json.Unmarshal([]byte(payload), &d)
 		hook.runProcessPayloadFunc(fn, d, hd)
-
 	case DeploymentEvent:
-
 		var d DeploymentPayload
-
-		err = json.Unmarshal([]byte(payload), &d)
-		pl = d
-
+		json.Unmarshal([]byte(payload), &d)
+		hook.runProcessPayloadFunc(fn, d, hd)
 	case DeploymentStatusEvent:
-
 		var d DeploymentStatusPayload
-
-		err = json.Unmarshal([]byte(payload), &d)
-		pl = d
-
+		json.Unmarshal([]byte(payload), &d)
+		hook.runProcessPayloadFunc(fn, d, hd)
 	case ForkEvent:
-
 		var f ForkPayload
-
-		err = json.Unmarshal([]byte(payload), &f)
-		pl = f
-
+		json.Unmarshal([]byte(payload), &f)
+		hook.runProcessPayloadFunc(fn, f, hd)
 	case GollumEvent:
-
 		var g GollumPayload
-
-		err = json.Unmarshal([]byte(payload), &g)
-		pl = g
-
+		json.Unmarshal([]byte(payload), &g)
+		hook.runProcessPayloadFunc(fn, g, hd)
 	case IssueCommentEvent:
-
 		var i IssueCommentPayload
-
-		err = json.Unmarshal([]byte(payload), &i)
-		pl = i
-
+		json.Unmarshal([]byte(payload), &i)
+		hook.runProcessPayloadFunc(fn, i, hd)
 	case IssuesEvent:
-
 		var i IssuesPayload
-
-		err = json.Unmarshal([]byte(payload), &i)
-		pl = i
-
+		json.Unmarshal([]byte(payload), &i)
+		hook.runProcessPayloadFunc(fn, i, hd)
 	case LabelEvent:
-
 		var l LabelPayload
-
-		err = json.Unmarshal([]byte(payload), &l)
-		pl = l
-
+		json.Unmarshal([]byte(payload), &l)
+		hook.runProcessPayloadFunc(fn, l, hd)
 	case MemberEvent:
-
 		var m MemberPayload
-
-		err = json.Unmarshal([]byte(payload), &m)
-		pl = m
-
+		json.Unmarshal([]byte(payload), &m)
+		hook.runProcessPayloadFunc(fn, m, hd)
 	case MembershipEvent:
-
 		var m MembershipPayload
-
-		err = json.Unmarshal([]byte(payload), &m)
-		pl = m
-
+		json.Unmarshal([]byte(payload), &m)
+		hook.runProcessPayloadFunc(fn, m, hd)
 	case MilestoneEvent:
-
 		var m MilestonePayload
-
-		err = json.Unmarshal([]byte(payload), &m)
-		pl = m
-
+		json.Unmarshal([]byte(payload), &m)
+		hook.runProcessPayloadFunc(fn, m, hd)
 	case OrganizationEvent:
-
 		var o OrganizationPayload
-
-		err = json.Unmarshal([]byte(payload), &o)
-		pl = o
-
+		json.Unmarshal([]byte(payload), &o)
+		hook.runProcessPayloadFunc(fn, o, hd)
 	case OrgBlockEvent:
-
 		var o OrgBlockPayload
-
-		err = json.Unmarshal([]byte(payload), &o)
-		pl = o
-
+		json.Unmarshal([]byte(payload), &o)
+		hook.runProcessPayloadFunc(fn, o, hd)
 	case PageBuildEvent:
-
 		var p PageBuildPayload
-
-		err = json.Unmarshal([]byte(payload), &p)
-		pl = p
-
+		json.Unmarshal([]byte(payload), &p)
+		hook.runProcessPayloadFunc(fn, p, hd)
 	case ProjectCardEvent:
-
 		var p ProjectCardPayload
-
-		err = json.Unmarshal([]byte(payload), &p)
-		pl = p
-
+		json.Unmarshal([]byte(payload), &p)
+		hook.runProcessPayloadFunc(fn, p, hd)
 	case ProjectColumnEvent:
-
 		var p ProjectColumnPayload
-
-		err = json.Unmarshal([]byte(payload), &p)
-		pl = p
-
+		json.Unmarshal([]byte(payload), &p)
+		hook.runProcessPayloadFunc(fn, p, hd)
 	case ProjectEvent:
-
 		var p ProjectPayload
-
-		err = json.Unmarshal([]byte(payload), &p)
-		pl = p
-
+		json.Unmarshal([]byte(payload), &p)
+		hook.runProcessPayloadFunc(fn, p, hd)
 	case PublicEvent:
-
 		var p PublicPayload
-
-		err = json.Unmarshal([]byte(payload), &p)
-		pl = p
-
+		json.Unmarshal([]byte(payload), &p)
+		hook.runProcessPayloadFunc(fn, p, hd)
 	case PullRequestEvent:
-
 		var p PullRequestPayload
-
-		err = json.Unmarshal([]byte(payload), &p)
-		pl = p
-
+		json.Unmarshal([]byte(payload), &p)
+		hook.runProcessPayloadFunc(fn, p, hd)
 	case PullRequestReviewEvent:
-
 		var p PullRequestReviewPayload
-
-		err = json.Unmarshal([]byte(payload), &p)
-		pl = p
-
+		json.Unmarshal([]byte(payload), &p)
+		hook.runProcessPayloadFunc(fn, p, hd)
 	case PullRequestReviewCommentEvent:
-
 		var p PullRequestReviewCommentPayload
-
-		err = json.Unmarshal([]byte(payload), &p)
-		pl = p
-
+		json.Unmarshal([]byte(payload), &p)
+		hook.runProcessPayloadFunc(fn, p, hd)
 	case PushEvent:
-
 		var p PushPayload
-
-		err = json.Unmarshal([]byte(payload), &p)
-		pl = p
-
+		json.Unmarshal([]byte(payload), &p)
+		hook.runProcessPayloadFunc(fn, p, hd)
 	case ReleaseEvent:
-
 		var r ReleasePayload
-
-		err = json.Unmarshal([]byte(payload), &r)
-		pl = r
-
+		json.Unmarshal([]byte(payload), &r)
+		hook.runProcessPayloadFunc(fn, r, hd)
 	case RepositoryEvent:
-
 		var r RepositoryPayload
-
-		err = json.Unmarshal([]byte(payload), &r)
-		pl = r
-
+		json.Unmarshal([]byte(payload), &r)
+		hook.runProcessPayloadFunc(fn, r, hd)
 	case StatusEvent:
-
 		var s StatusPayload
-
-		err = json.Unmarshal([]byte(payload), &s)
-		pl = s
-
+		json.Unmarshal([]byte(payload), &s)
+		hook.runProcessPayloadFunc(fn, s, hd)
 	case TeamEvent:
-
 		var t TeamPayload
-
-		err = json.Unmarshal([]byte(payload), &t)
-		pl = t
-
+		json.Unmarshal([]byte(payload), &t)
+		hook.runProcessPayloadFunc(fn, t, hd)
 	case TeamAddEvent:
-
 		var t TeamAddPayload
-
-		err = json.Unmarshal([]byte(payload), &t)
-		pl = t
-
+		json.Unmarshal([]byte(payload), &t)
+		hook.runProcessPayloadFunc(fn, t, hd)
 	case WatchEvent:
-
 		var w WatchPayload
-
-		err = json.Unmarshal([]byte(payload), &w)
-		pl = w
+		json.Unmarshal([]byte(payload), &w)
+		hook.runProcessPayloadFunc(fn, w, hd)
 	}
-
-	if err != nil {
-		log.Println("There was an erro parsing JSON:", err)
-		http.Error(w, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError)
-		return
-	}
-
-	log.Println("Running runProcessPayloadFunc")
-	hook.runProcessPayloadFunc(fn, pl, hd)
 }
 
 func (hook Webhook) runProcessPayloadFunc(fn webhooks.ProcessPayloadFunc, results interface{}, header webhooks.Header) {
 	go func(fn webhooks.ProcessPayloadFunc, results interface{}, header webhooks.Header) {
-		log.Println("Calling hook function")
 		fn(results, header)
 	}(fn, results, header)
 }

webhooks.go

@@ -1,9 +1,6 @@
 package webhooks
 
-import (
-	"log"
-	"net/http"
-)
+import "net/http"
 
 // Header provides http.Header to minimize imports
 type Header http.Header
@@ -38,18 +35,27 @@ type Webhook interface {
 }
 
 type server struct {
-	hook Webhook
-	path string
+	hook             Webhook
+	path             string
+	includePathCheck bool
 }
 
 // ProcessPayloadFunc is a common function for payload return values
 type ProcessPayloadFunc func(payload interface{}, header Header)
 
+// Handler returns the webhook http.Handler for use in your own Mux implementation
+func Handler(hook Webhook) http.Handler {
+	return &server{
+		hook: hook,
+	}
+}
+
 // Run runs a server
 func Run(hook Webhook, addr string, path string) error {
 	srv := &server{
-		hook: hook,
-		path: path,
+		hook:             hook,
+		path:             path,
+		includePathCheck: true,
 	}
 
 	s := &http.Server{Addr: addr, Handler: srv}
@@ -61,8 +67,9 @@ func Run(hook Webhook, addr string, path string) error {
 func RunServer(s *http.Server, hook Webhook, path string) error {
 
 	srv := &server{
-		hook: hook,
-		path: path,
+		hook:             hook,
+		path:             path,
+		includePathCheck: true,
 	}
 
 	s.Handler = srv
@@ -77,8 +84,9 @@ func RunServer(s *http.Server, hook Webhook, path string) error {
 func RunTLSServer(s *http.Server, hook Webhook, path string) error {
 
 	srv := &server{
-		hook: hook,
-		path: path,
+		hook:             hook,
+		path:             path,
+		includePathCheck: true,
 	}
 
 	s.Handler = srv
@@ -88,23 +96,19 @@ func RunTLSServer(s *http.Server, hook Webhook, path string) error {
 
 // ServeHTTP is the Handler for every posted WebHook Event
 func (s *server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
-	defer func() {
-		log.Println("Closing Request Body")
-		r.Body.Close()
-	}()
+	defer r.Body.Close()
 
-	log.Println("HTTP METHOD:", r.Method)
 	if r.Method != "POST" {
 		http.Error(w, "405 Method not allowed", http.StatusMethodNotAllowed)
 		return
 	}
 
-	log.Println("Chking that paths match:", r.URL.Path == s.path)
-	if r.URL.Path != s.path {
-		http.Error(w, "404 Not found", http.StatusNotFound)
-		return
+	if s.includePathCheck {
+		if r.URL.Path != s.path {
+			http.Error(w, "404 Not found", http.StatusNotFound)
+			return
+		}
 	}
 
-	log.Println("Parsing Payload")
 	s.hook.ParsePayload(w, r)
 }

webhooks_test.go

@@ -8,6 +8,8 @@ import (
 	"testing"
 	"time"
 
+	"net/http/httptest"
+
 	. "gopkg.in/go-playground/assert.v1"
 )
 
@@ -47,6 +49,43 @@ func TestMain(m *testing.M) {
 	// teardown
 }
 
+func TestHandler(t *testing.T) {
+
+	mux := http.NewServeMux()
+	mux.Handle("/webhooks", Handler(fakeHook))
+
+	s := httptest.NewServer(Handler(fakeHook))
+	defer s.Close()
+
+	payload := "{}"
+
+	req, err := http.NewRequest("POST", s.URL+"/webhooks", bytes.NewBuffer([]byte(payload)))
+	req.Header.Set("Content-Type", "application/json")
+
+	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)
+
+	// Test BAD METHOD
+	req, err = http.NewRequest("GET", s.URL+"/webhooks", bytes.NewBuffer([]byte(payload)))
+	req.Header.Set("Content-Type", "application/json")
+
+	Equal(t, err, nil)
+
+	resp, err = client.Do(req)
+	Equal(t, err, nil)
+
+	defer resp.Body.Close()
+
+	Equal(t, resp.StatusCode, http.StatusMethodNotAllowed)
+}
+
 func TestRun(t *testing.T) {
 
 	go Run(fakeHook, "127.0.0.1:3006", "/webhooks")