Merge pull request #6 from RO-29/feature_linter

linter changes + makefile + vendored

Author: alash3al

Gopkg.lock

@@ -0,0 +1,46 @@
+# Gopkg.toml example
+#
+# Refer to https://golang.github.io/dep/docs/Gopkg.toml.html
+# for detailed Gopkg.toml documentation.
+#
+# required = ["github.com/user/thing/cmd/thing"]
+# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
+#
+# [[constraint]]
+#   name = "github.com/user/project"
+#   version = "1.0.0"
+#
+# [[constraint]]
+#   name = "github.com/user/project2"
+#   branch = "dev"
+#   source = "github.com/myfork/project2"
+#
+# [[override]]
+#   name = "github.com/x/y"
+#   version = "2.4.0"
+#
+# [prune]
+#   non-go = false
+#   go-tests = true
+#   unused-packages = true
+
+
+[[constraint]]
+  branch = "master"
+  name = "github.com/alash3al/go-pubsub"
+
+[[constraint]]
+  branch = "master"
+  name = "github.com/bclicn/color"
+
+[[constraint]]
+  name = "github.com/gorilla/websocket"
+  version = "1.2.0"
+
+[[constraint]]
+  name = "github.com/labstack/echo"
+  version = "3.2.6"
+
+[prune]
+  go-tests = true
+  unused-packages = true

Gopkg.toml

@@ -0,0 +1,30 @@
+test:
+	go test -v ./...
+
+install-gometalinter:
+	go get -v -u github.com/alecthomas/gometalinter
+	gometalinter --install
+
+LINT=$(eval export GOGC=400)\
+gometalinter --enable-all -D dupl -D lll -D gas -D goconst -D interfacer -D safesql -D test -D testify -D vetshadow\
+ --tests --vendor --warn-unmatched-nolint --deadline=10m --concurrency=2 --enable-gc ./...
+lint: install-gometalinter
+	$(LINT)
+
+install-dep:
+	go get -v -u github.com/golang/dep/cmd/dep
+
+dep-init: install-dep
+	dep init
+
+dep-ensure: install-dep
+	dep ensure
+
+dep-update: install-dep
+	dep ensure -update
+
+.PHONY:: \
+	test \
+	lint \
+	dep-ensure \
+	dep-update \

Makefile

@@ -6,21 +6,26 @@ import (
 )
 
 var (
-	FLAG_HTTP_ADDR        = flag.String("listen", ":4040", "the http address to listen on")
-	FLAG_ALLOWED_ORIGIN   = flag.String("origin", "*", "the allowed websocket origin(s), it accepts a comma separated list of domains, * means anything")
-	FLAG_WEBHOOK_URL      = flag.String("webhook", "http://localhost:8000", "the webhook")
-	FLAG_WEBHOOK_EVENTS   = flag.String("events", "connect,disconnect,subscribe,unsubscribe", "the events to be sent to the webhook")
-	FLAG_PUBLISH_ENDPOINT = flag.String("publish", "/publish", "the publish endpoint, just make it as secure as you can")
-)
-
-var (
-	VERSION        = "2.0"
-	WEBHOOK_EVENTS = map[string]bool{}
+	//FlagHTTPAddr ...
+	FlagHTTPAddr = flag.String("listen", ":4040", "the http address to listen on")
+	//FlagAllowedOrigin ...
+	FlagAllowedOrigin = flag.String("origin", "*", "the allowed websocket origin(s), it accepts a comma separated list of domains, * means anything")
+	//FlagWebhookURL ...
+	FlagWebhookURL = flag.String("webhook", "http://localhost:8000", "the webhook")
+	//FlagWebhookEvents ...
+	FlagWebhookEvents = flag.String("events", "connect,disconnect,subscribe,unsubscribe", "the events to be sent to the webhook")
+	//FlagPublishEndpoint ...
+	FlagPublishEndpoint = flag.String("publish", "/publish", "the publish endpoint, just make it as secure as you can")
+	//Version ...
+	Version = "2.0"
+	//WebhookEvents ..
+	WebhookEvents = map[string]bool{}
 )
 
+//InitFlags ...
 func InitFlags() {
 	flag.Parse()
-	for _, e := range strings.Split(strings.ToLower(*FLAG_WEBHOOK_EVENTS), ",") {
-		WEBHOOK_EVENTS[strings.TrimSpace(e)] = true
+	for _, e := range strings.Split(strings.ToLower(*FlagWebhookEvents), ",") {
+		WebhookEvents[strings.TrimSpace(e)] = true
 	}
 }

flags.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+
 	"github.com/bclicn/color"
 )
 
@@ -14,12 +15,12 @@ func main() {
 	}()
 
 	// parsing the command line flags
-	fmt.Println(color.BGreen("[*] Welcome to WSIFY"), color.BCyan(VERSION))
+	fmt.Println(color.BGreen("[*] Welcome to WSIFY"), color.BCyan(Version))
 	InitFlags()
 
 	// start the pub/sub server
-	fmt.Println(color.BGreen("[*] Listening for connections on address"), color.BCyan(*FLAG_HTTP_ADDR), color.BGreen(" ..."))
-	if err := InitWsServer(*FLAG_HTTP_ADDR); err != nil {
+	fmt.Println(color.BGreen("[*] Listening for connections on address"), color.BCyan(*FlagHTTPAddr), color.BGreen(" ..."))
+	if err := InitWsServer(*FlagHTTPAddr); err != nil {
 		fmt.Println(color.BRed("[!] Error: ") + color.BLightYellow(err.Error()))
 		return
 	}

main.go

@@ -1,15 +1,15 @@
 package main
 
-// the message that will be polled from redis
+// Message that will be polled from redis
 type Message struct {
 	Payload interface{} `json:"payload,omitempty"`
 	To      []string    `json:"to,omitempty"`
 	Topic   string      `json:"channel,omitempty"`
 	Time    int64       `json:"time,omitempty"`
 }
 
-// checks whether the specified user is allowed
-// to recieve this message or not
+// IsUserAllowed checks whether the specified user is allowed
+// to receive this message or not
 func (m *Message) IsUserAllowed(u string) bool {
 	if len(m.To) < 1 {
 		return true

message.go

@@ -14,12 +14,12 @@ import (
 )
 
 var (
-	// Default websocket upgrader
+	// WSUpgrader is Default websocket upgrader
 	WSUpgrader = websocket.Upgrader{
 		ReadBufferSize:  1024,
 		WriteBufferSize: 1024,
 		CheckOrigin: func(r *http.Request) bool {
-			for _, origin := range strings.Split(*FLAG_ALLOWED_ORIGIN, ",") {
+			for _, origin := range strings.Split(*FlagAllowedOrigin, ",") {
 				origin = strings.TrimSpace(origin)
 				if origin == "*" || origin == r.Host {
 					return true
@@ -30,11 +30,11 @@ var (
 		EnableCompression: true,
 	}
 
-	// Default broker
+	//Broker default
 	Broker = pubsub.NewBroker()
 )
 
-// the websocket request handler
+// WSHandler is the websocket request handler
 func WSHandler(c echo.Context) error {
 	defer (func() {
 		if err := recover(); err != nil {
@@ -53,10 +53,10 @@ func WSHandler(c echo.Context) error {
 	if err != nil {
 		return nil
 	}
-	defer conn.Close()
+	defer conn.Close() // nolint: errcheck
 	subscriber, err := Broker.Attach()
 	if err != nil {
-		conn.WriteJSON(map[string]string{
+		conn.WriteJSON(map[string]string{ // nolint: errcheck
 			"error": "Sorry, couldn't allocate resources for you",
 		})
 		return nil
@@ -67,30 +67,7 @@ func WSHandler(c echo.Context) error {
 		closeCh <- true
 		return nil
 	})
-	go (func() {
-		var action Event
-		stop := false
-		for !stop {
-			if conn.ReadJSON(&action) != nil {
-				stop = true
-				break
-			}
-			if action.Action == "subscribe" || action.Action == "unsubscribe" {
-				if !TriggerWebhook(Event{Action: action.Action, Key: key, Value: action.Value}) {
-					conn.WriteJSON(map[string]string{
-						"error": "You aren't allowed to access the requested resource",
-					})
-					continue
-				}
-			}
-			if action.Action == "subscribe" {
-				Broker.Subscribe(subscriber, action.Value)
-			} else if action.Action == "unsubscribe" {
-				Broker.Unsubscribe(subscriber, action.Value)
-			}
-		}
-		closeCh <- true
-	})()
+	goRoutineAction(conn, closeCh, subscriber, key)
 	for !closed {
 		select {
 		case <-closeCh:
@@ -114,31 +91,48 @@ func WSHandler(c echo.Context) error {
 	return nil
 }
 
-// publish handler
+func goRoutineAction(conn *websocket.Conn, closeCh chan bool, subscriber *pubsub.Subscriber, key string) {
+	go (func() {
+		var action Event
+		for {
+			if conn.ReadJSON(&action) != nil {
+				break
+			}
+			if action.Action == "subscribe" || action.Action == "unsubscribe" {
+				if !TriggerWebhook(Event{Action: action.Action, Key: key, Value: action.Value}) {
+					conn.WriteJSON(map[string]string{ // nolint: errcheck
+						"error": "You aren't allowed to access the requested resource",
+					})
+					continue
+				}
+			}
+			if action.Action == "subscribe" {
+				Broker.Subscribe(subscriber, action.Value)
+			} else if action.Action == "unsubscribe" {
+				Broker.Unsubscribe(subscriber, action.Value)
+			}
+		}
+		closeCh <- true
+	})()
+}
+
+// PublishHandler ...
 func PublishHandler(c echo.Context) error {
 	var msg Message
 	if err := c.Bind(&msg); err != nil {
 		return c.JSON(422, map[string]interface{}{
-			"sucess": false,
-			"error":  err.Error(),
+			"success": false,
+			"error":   err.Error(),
 		})
 	}
 	Broker.Broadcast(msg, msg.Topic)
-	return c.JSON(200, map[string]interface{}{
-		"sucess": true,
-		"data":   msg,
-	})
-}
-
-// welcome handler
-func WelcomeHandler(c echo.Context) error {
 	return c.JSON(200, map[string]interface{}{
 		"success": true,
-		"message": "let's go ?",
+		"data":    msg,
 	})
 }
 
-// start the websocket server
+// InitWsServer start the websocket server
 func InitWsServer(addr string) error {
 	e := echo.New()
 
@@ -151,7 +145,7 @@ func InitWsServer(addr string) error {
 	e.Use(middleware.GzipWithConfig(middleware.GzipConfig{Level: 9}))
 
 	e.GET("/subscribe", WSHandler)
-	e.POST(*FLAG_PUBLISH_ENDPOINT, PublishHandler)
+	e.POST(*FlagPublishEndpoint, PublishHandler)
 
 	return e.Start(addr)
 }