Implement global CactusBot packet specification

command/schema.go

@@ -7,44 +7,27 @@ import (
 
 // ResponseSchema is the schema for the data that will be sent out to the client
 type ResponseSchema struct {
-	ID        string                  `jsonapi:"id,primary"`
-	Arguments []schemas.MessagePacket `jsonapi:"arguments,attr"`
-	Count     int                     `jsonapi:"count,attr"`
-	CreatedAt string                  `jsonapi:"createdAt,meta"`
-	Enabled   bool                    `jsonapi:"enabled,attr"`
-	Name      string                  `jsonapi:"name,attr"`
-	Response  EmbeddedResponseSchema  `jsonapi:"response,attr"`
-	Token     string                  `jsonapi:"token,meta"`
+	ID        string          `jsonapi:"primary,id"`
+	Name      string          `jsonapi:"attr,name"`
+	Response  schemas.Message `jsonapi:"attr,response"`
+	Count     int             `jsonapi:"attr,count"`
+	Enabled   bool            `jsonapi:"attr,enabled"`
+	CreatedAt string          `jsonapi:"meta,createdAt"`
+	Token     string          `jsonapi:"meta,token"`
 }
 
 // ClientSchema is the schema the data from the client will be marshalled into
 type ClientSchema struct {
-	Arguments []schemas.MessagePacket `json:"arguments" validate:"required"`
-	Enabled   bool                    `json:"enabled" validate:"required"`
-	Response  EmbeddedResponseSchema  `json:"response" validate:"required"`
+	Context schemas.Context `json:"context" validate:"required"`
+	Enabled bool            `json:"enabled" validate:"required"`
 	// Ignore these fields in user input, they will be filled automatically by the API
-	ID        string `json:"id" validate:"-"`
-	Count     int    `json:"count" validate:"-"`
-	CreatedAt string `json:"createdAt" validate:"-"`
-	Token     string `json:"token" validate:"-"`
-	Name      string `json:"name" validate:"-"`
-}
-
-// EmbeddedResponseSchema is the schema that is stored under the response key in ResponseSchema
-type EmbeddedResponseSchema struct {
-	Action  bool                    `jsonapi:"action,attr" validate:"required"`
-	Message []schemas.MessagePacket `jsonapi:"message,attr" validate:"required,gt=0"`
-	Role    int                     `jsonapi:"role,attr" validate:"gte=0,lte=256"`
-	Target  string                  `jsonapi:"target,attr"`
-	User    string                  `jsonapi:"user,attr"`
+	ID    string `json:"id" validate:"-"`
+	Count int    `json:"count" validate:"-"`
+	Token string `json:"token" validate:"-"`
+	Name  string `json:"name" validate:"-"`
 }
 
 // GetAPITag allows each of these types to implement the JSONAPISchema interface
 func (r ResponseSchema) GetAPITag(lookup string) string {
 	return util.FieldTag(r, lookup, "jsonapi")
 }
-
-// GetAPITag allows each of these types to implement the JSONAPISchema interface
-func (r EmbeddedResponseSchema) GetAPITag(lookup string) string {
-	return util.FieldTag(r, lookup, "jsonapi")
-}

schemas/schemas.go

@@ -1,8 +1,99 @@
 package schemas
 
-// MessagePacket is the low-level format for storing contents of a message and arguments
-type MessagePacket struct {
-	Data string `json:"data" validate:"required"`
-	Text string `json:"text" validate:"required"`
-	Type string `json:"type" validate:"required"`
+import (
+	"strings"
+)
+
+type Message struct {
+	Text   []Component `json:"text"` // FIXME: Anything besides [] breaks this. It is assumed that this is due to the interface being used for Component.
+	Action bool        `json:"action"`
+}
+
+type Component interface {
+	Text() string
+}
+
+func (t Text) Text() string {
+	return t.Data
+}
+
+func (e Emoji) Text() string {
+	return e.Data
+}
+
+func (t Tag) Text() string {
+	return t.Data
+}
+
+func (u URL) Text() string {
+	return u.Data
+}
+
+func (v Variable) Text() string {
+	return v.Data
+}
+
+type Text struct {
+	Data string `json:"data"`
+}
+type Emoji struct {
+	Data string `json:"data"`
+}
+type Tag struct {
+	Data string `json:"data"`
+}
+type URL struct {
+	Data string `json:"data"`
+}
+type Variable struct {
+	Data string `json:"data"`
+}
+
+type Channel string
+type User string
+type Service string
+
+type Context struct {
+	Packet  Message `json:"packet"`
+	Channel Channel `json:"channel"`
+	User    User    `json:"user,omitempty"`
+	Role    Role    `json:"role,omitempty"`
+	Target  User    `json:"target,omitempty"`
+	Service Service `json:"service"`
+}
+
+type Role int
+
+const (
+	banned Role = iota
+	user
+	subscriber
+	moderator
+	owner
+)
+
+func (r *Role) UnmarshalJSON(b []byte) error {
+	str := strings.Trim(string(b), `"`)
+
+	switch {
+	case str == "banned":
+		*r = banned
+
+	case str == "user":
+		*r = user
+
+	case str == "subscriber":
+		*r = subscriber
+
+	case str == "moderator":
+		*r = moderator
+
+	case str == "owner":
+		*r = owner
+
+	default:
+		*r = user
+	}
+
+	return nil
 }

util/jsonapi.go

@@ -55,21 +55,18 @@ func pullVals(ift reflect.Type, ifv reflect.Value) (map[string]interface{}, map[
 				id = subID
 			}
 		}
-		// Anything after the first element is tags, figure out which we want
-		for _, tag := range split[1:] {
-			// Need to set the keys w/ their names here if it's a struct
-			switch tag {
-			case "attr":
-				// Attribute
-				attr[split[0]] = value
-			case "meta":
-				// Meta information about the request
-				meta[split[0]] = value
-			case "primary":
-				// It's the primary key/record ID
-				id = ifv.Field(i).String()
-			default: // Ignore any other tags
-			}
+		// Need to set the keys w/ their names here if it's a struct
+		switch split[0] {
+		case "attr":
+			// Attribute
+			attr[split[1]] = value
+		case "meta":
+			// Meta information about the request
+			meta[split[1]] = value
+		case "primary":
+			// It's the primary key/record ID
+			id = ifv.Field(i).String()
+		default: // Ignore any other tags
 		}
 	}