Merge pull request #53 from linksmart/notification_api_changes

Pass type in path instead of query. Change full to diff

main.go

@@ -250,6 +250,7 @@ func setupHTTPRouter(config *HTTPConfig, api *catalog.HTTPAPI, notifAPI *notific
 
 	//TD notification
 	r.get("/events", commonHandlers.ThenFunc(notifAPI.SubscribeEvent))
+	r.get("/events/{type}", commonHandlers.ThenFunc(notifAPI.SubscribeEvent))
 
 	logger := negroni.NewLogger()
 	logFlags := log.LstdFlags

notification/controller.go

@@ -31,7 +31,7 @@ type Controller struct {
 type subscriber struct {
 	client      chan Event
 	eventTypes  []wot.EventType
-	full        bool
+	diff        bool
 	lastEventID string
 }
 
@@ -48,10 +48,10 @@ func NewController(s EventQueue) *Controller {
 	return c
 }
 
-func (c *Controller) subscribe(client chan Event, eventTypes []wot.EventType, full bool, lastEventID string) error {
+func (c *Controller) subscribe(client chan Event, eventTypes []wot.EventType, diff bool, lastEventID string) error {
 	s := subscriber{client: client,
 		eventTypes:  eventTypes,
-		full:        full,
+		diff:        diff,
 		lastEventID: lastEventID,
 	}
 	c.subscribingClients <- s
@@ -174,7 +174,7 @@ func sendToSubscriber(s subscriber, event Event) {
 		// Send the notification if the type matches
 		if eventType == event.Type {
 			toSend := event
-			if !s.full {
+			if !s.diff {
 				toSend.Data = catalog.ThingDescription{wot.KeyThingID: toSend.Data[wot.KeyThingID]}
 			}
 			s.client <- toSend

notification/notification.go

@@ -14,7 +14,7 @@ type Event struct {
 // NotificationController interface
 type NotificationController interface {
 	// subscribe to the events. the caller will get events through the channel 'client' starting from 'lastEventID'
-	subscribe(client chan Event, eventTypes []wot.EventType, full bool, lastEventID string) error
+	subscribe(client chan Event, eventTypes []wot.EventType, diff bool, lastEventID string) error
 
 	// unsubscribe and close the channel 'client'
 	unsubscribe(client chan Event) error

notification/sse.go

@@ -7,13 +7,14 @@ import (
 	"net/http"
 	"strings"
 
+	"github.com/gorilla/mux"
 	"github.com/linksmart/thing-directory/catalog"
 	"github.com/linksmart/thing-directory/wot"
 )
 
 const (
 	QueryParamType    = "type"
-	QueryParamFull    = "full"
+	QueryParamFull    = "diff"
 	HeaderLastEventID = "Last-Event-ID"
 )
 
@@ -35,7 +36,11 @@ func NewSSEAPI(controller NotificationController, version string) *SSEAPI {
 }
 
 func (a *SSEAPI) SubscribeEvent(w http.ResponseWriter, req *http.Request) {
-	eventTypes, full, err := parseQueryParameters(req)
+	diff, err := parseQueryParameters(req)
+	if err != nil {
+		catalog.ErrorResponse(w, http.StatusBadRequest, err)
+	}
+	eventTypes, err := parsePath(req)
 	if err != nil {
 		catalog.ErrorResponse(w, http.StatusBadRequest, err)
 	}
@@ -49,7 +54,7 @@ func (a *SSEAPI) SubscribeEvent(w http.ResponseWriter, req *http.Request) {
 	messageChan := make(chan Event)
 
 	lastEventID := req.Header.Get(HeaderLastEventID)
-	a.controller.subscribe(messageChan, eventTypes, full, lastEventID)
+	a.controller.subscribe(messageChan, eventTypes, diff, lastEventID)
 
 	go func() {
 		<-req.Context().Done()
@@ -71,36 +76,29 @@ func (a *SSEAPI) SubscribeEvent(w http.ResponseWriter, req *http.Request) {
 	}
 }
 
-func parseQueryParameters(req *http.Request) ([]wot.EventType, bool, error) {
-
-	full := false
+func parseQueryParameters(req *http.Request) (bool, error) {
+	diff := false
 	req.ParseForm()
-
-	// Parse full or partial events
+	// Parse diff or just ID
 	if strings.EqualFold(req.Form.Get(QueryParamFull), "true") {
-		full = true
+		diff = true
 	}
+	return diff, nil
+}
 
+func parsePath(req *http.Request) ([]wot.EventType, error) {
 	// Parse event type to be subscribed to
-	queriedTypes := req.Form[QueryParamType]
-	if queriedTypes == nil {
-		return []wot.EventType{wot.EventTypeCreate, wot.EventTypeUpdate, wot.EventTypeDelete}, full, nil
+	params := mux.Vars(req)
+	event := params[QueryParamType]
+	if event == "" {
+		return []wot.EventType{wot.EventTypeCreate, wot.EventTypeUpdate, wot.EventTypeDelete}, nil
 	}
 
-	var eventTypes []wot.EventType
-loopQueriedTypes:
-	for _, v := range queriedTypes {
-		eventType := wot.EventType(v)
-		if !eventType.IsValid() {
-			return nil, false, fmt.Errorf("invalid type parameter")
-		}
-		for _, existing := range eventTypes {
-			if existing == eventType {
-				continue loopQueriedTypes
-			}
-		}
-		eventTypes = append(eventTypes, eventType)
+	eventType := wot.EventType(event)
+	if !eventType.IsValid() {
+		return nil, fmt.Errorf("invalid type in path")
 	}
 
-	return eventTypes, full, nil
+	return []wot.EventType{eventType}, nil
+
 }