add custom message type

.gitignore

@@ -2,6 +2,7 @@
 *.o
 *.a
 *.so
+*.env
 
 # Folders
 _obj

enums.go

@@ -120,7 +120,7 @@ func (s PNChannelMembersInclude) String() string {
 	return [...]string{"custom", "uuid", "uuid.custom"}[s-1]
 }
 
-// PNMessageType is used as an enum to catgorize the Subscribe response.
+// PNMessageType is used as an enum to categorize the Subscribe response.
 type PNMessageType int
 
 const (
@@ -136,8 +136,9 @@ const (
 )
 
 const (
+	PNMessageTypeMessage PNMessageType = iota
 	// PNMessageTypeSignal is to identify Signal the Subscribe response
-	PNMessageTypeSignal PNMessageType = 1 + iota
+	PNMessageTypeSignal
 	// PNMessageTypeObjects is to identify Objects the Subscribe response
 	PNMessageTypeObjects
 	// PNMessageTypeMessageActions is to identify Actions the Subscribe response

fetch_request.go

@@ -96,6 +96,18 @@ func (b *fetchBuilder) IncludeMessageType(withMessageType bool) *fetchBuilder {
 	return b
 }
 
+// IncludeType fetches the Message Type associated with the message
+func (b *fetchBuilder) IncludeType(withType bool) *fetchBuilder {
+	b.opts.WithType = withType
+	return b
+}
+
+// IncludeSpaceId fetches the Space Id associated with the message
+func (b *fetchBuilder) IncludeSpaceId(withSpaceId bool) *fetchBuilder {
+	b.opts.WithSpaceId = withSpaceId
+	return b
+}
+
 // QueryParam accepts a map, the keys and values of the map are passed as the query string parameters of the URL called by the API.
 func (b *fetchBuilder) QueryParam(queryParam map[string]string) *fetchBuilder {
 	b.opts.QueryParam = queryParam
@@ -126,6 +138,7 @@ func newFetchOpts(pubnub *PubNub, ctx Context, opts fetchOpts) *fetchOpts {
 	}
 	opts.WithUUID = true
 	opts.WithMessageType = true
+	opts.WithType = true
 	return &opts
 }
 
@@ -139,6 +152,8 @@ type fetchOpts struct {
 	WithMeta           bool
 	WithUUID           bool
 	WithMessageType    bool
+	WithType           bool
+	WithSpaceId        bool
 
 	// default: 100
 	Count int
@@ -214,6 +229,8 @@ func (o *fetchOpts) buildQuery() (*url.Values, error) {
 	q.Set("reverse", strconv.FormatBool(o.Reverse))
 	q.Set("include_meta", strconv.FormatBool(o.WithMeta))
 	q.Set("include_message_type", strconv.FormatBool(o.WithMessageType))
+	q.Set("include_type", strconv.FormatBool(o.WithType))
+	q.Set("include_space_id", strconv.FormatBool(o.WithSpaceId))
 	q.Set("include_uuid", strconv.FormatBool(o.WithUUID))
 
 	SetQueryParam(q, o.QueryParam)
@@ -318,6 +335,12 @@ func (o *fetchOpts) fetchMessages(channels map[string]interface{}) map[string][]
 							}
 						}
 					}
+					if t, ok := histResponse["type"]; ok {
+						histItem.Type = t.(string)
+					}
+					if sid, ok := histResponse["space_id"]; ok {
+						histItem.SpaceId = SpaceId(sid.(string))
+					}
 					if d, ok := histResponse["uuid"]; ok {
 						histItem.UUID = d.(string)
 					}
@@ -395,16 +418,18 @@ type FetchResponseItem struct {
 	Timetoken      string                                    `json:"timetoken"`
 	UUID           string                                    `json:"uuid"`
 	MessageType    int                                       `json:"message_type"`
+  Type           string                                    `json:"custom_message_type"`
+  SpaceId        SpaceId                                   `TODO: remove`
     Error          error
 }
 
 // PNHistoryMessageActionsTypeMap is the struct used in the Fetch request that includes Message Actions
 type PNHistoryMessageActionsTypeMap struct {
-	ActionsTypeValues map[string][]PNHistoryMessageActionTypeVal `json:"-"`
+	ActionsTypeValues map[string][]PNHistoryMessageActionTypeVal
 }
 
 // PNHistoryMessageActionTypeVal is the struct used in the Fetch request that includes Message Actions
 type PNHistoryMessageActionTypeVal struct {
-	UUID            string `json:"uuid"`
-	ActionTimetoken string `json:"actionTimetoken"`
+	UUID            string
+	ActionTimetoken string
 }

files_send_file.go

@@ -48,6 +48,18 @@ func (b *sendFileBuilder) Meta(meta interface{}) *sendFileBuilder {
 	return b
 }
 
+func (b *sendFileBuilder) SpaceId(id SpaceId) *sendFileBuilder {
+	b.opts.SpaceId = id
+
+	return b
+}
+
+func (b *sendFileBuilder) Type(typ string) *sendFileBuilder {
+	b.opts.Type = typ
+
+	return b
+}
+
 // ShouldStore if true the messages are stored in History
 func (b *sendFileBuilder) ShouldStore(store bool) *sendFileBuilder {
 	b.opts.ShouldStore = store
@@ -117,6 +129,8 @@ type sendFileOpts struct {
 	CipherKey   string
 	TTL         int
 	Meta        interface{}
+	SpaceId     SpaceId
+	Type        string
 	ShouldStore bool
 	QueryParam  map[string]string
 
@@ -236,7 +250,15 @@ func newPNSendFileResponse(jsonBytes []byte, o *sendFileOpts,
 	maxCount := o.config().FileMessagePublishRetryLimit
 	for !sent && tryCount < maxCount {
 		tryCount++
-		pubFileMessageResponse, pubFileResponseStatus, errPubFileResponse := o.pubnub.PublishFileMessage().TTL(o.TTL).Meta(o.Meta).ShouldStore(o.ShouldStore).Channel(o.Channel).Message(message).Execute()
+		pubFileMessageResponse, pubFileResponseStatus, errPubFileResponse := o.pubnub.PublishFileMessage().
+			TTL(o.TTL).
+			Meta(o.Meta).
+			ShouldStore(o.ShouldStore).
+			Channel(o.Channel).
+			Message(message).
+			Type(o.Type).
+			SpaceId(o.SpaceId).
+			Execute()
 		if errPubFileResponse != nil {
 			if tryCount >= maxCount {
 				pubFileResponseStatus.AdditionalData = file

listener_manager.go

@@ -270,6 +270,8 @@ type PNMessage struct {
 	Subscription      string
 	Publisher         string
 	Timetoken         int64
+	Type              string
+  SpaceId           SpaceId // TODO: remove
     Error             error
 }
 
@@ -361,5 +363,7 @@ type PNFilesEvent struct {
 	Subscription      string
 	Publisher         string
 	Timetoken         int64
+	Type              string
+  SpaceId           SpaceId // TODO: remove
     Error             error
 }

publish_file_message.go

@@ -51,6 +51,18 @@ func (b *publishFileMessageBuilder) Meta(meta interface{}) *publishFileMessageBu
 	return b
 }
 
+func (b *publishFileMessageBuilder) SpaceId(id SpaceId) *publishFileMessageBuilder {
+	b.opts.SpaceId = id
+
+	return b
+}
+
+func (b *publishFileMessageBuilder) Type(typ string) *publishFileMessageBuilder {
+	b.opts.Type = typ
+
+	return b
+}
+
 // ShouldStore if true the messages are stored in History
 func (b *publishFileMessageBuilder) ShouldStore(store bool) *publishFileMessageBuilder {
 	b.opts.ShouldStore = store
@@ -129,6 +141,8 @@ type publishFileMessageOpts struct {
 	UsePost        bool
 	TTL            int
 	Meta           interface{}
+	SpaceId        SpaceId
+	Type           string
 	ShouldStore    bool
 	setTTL         bool
 	setShouldStore bool
@@ -244,6 +258,14 @@ func (o *publishFileMessageOpts) buildPath() (string, error) {
 func (o *publishFileMessageOpts) buildQuery() (*url.Values, error) {
 	q := defaultQuery(o.pubnub.Config.UUID, o.pubnub.telemetryManager)
 
+	if o.Type != "" {
+		q.Set(publishTypeQueryParam, o.Type)
+	}
+
+	if o.SpaceId != "" {
+		q.Set(publishSpaceIdQueryParam, string(o.SpaceId))
+	}
+
 	SetQueryParam(q, o.QueryParam)
 
 	return q, nil

publish_file_message_test.go

@@ -298,3 +298,37 @@ func TestPublishFileMessageResponseValuePass(t *testing.T) {
 
 	assert.Nil(err)
 }
+
+func TestPublishFileMessageSpaceIdQueryParamIsPassed(t *testing.T) {
+	a := assert.New(t)
+	pn := NewPubNub(NewDemoConfig())
+	expectedSpaceId := SpaceId("spaceId")
+	queryValues, _ := pn.PublishFileMessage().SpaceId(expectedSpaceId).opts.buildQuery()
+
+	a.Equal(expectedSpaceId, SpaceId(queryValues.Get(publishSpaceIdQueryParam)))
+}
+
+func TestPublishFileMessageMissingSpaceIdQueryParamIsNotSet(t *testing.T) {
+	a := assert.New(t)
+	pn := NewPubNub(NewDemoConfig())
+	queryValues, _ := pn.PublishFileMessage().opts.buildQuery()
+
+	a.Equal("", queryValues.Get(publishSpaceIdQueryParam))
+}
+
+func TestPublishFileMessageTypeQueryParamIsPassed(t *testing.T) {
+	a := assert.New(t)
+	pn := NewPubNub(NewDemoConfig())
+	expectedType := "customMessageType"
+	queryValues, _ := pn.PublishFileMessage().Type(expectedType).opts.buildQuery()
+
+	a.Equal(expectedType, queryValues.Get(publishTypeQueryParam))
+}
+
+func TestPublishFileMessageMissingMessageTypeQueryParamIsNotSet(t *testing.T) {
+	a := assert.New(t)
+	pn := NewPubNub(NewDemoConfig())
+	queryValues, _ := pn.PublishFileMessage().opts.buildQuery()
+
+	a.Equal("", queryValues.Get(publishTypeQueryParam))
+}

publish_request.go

@@ -20,13 +20,18 @@ const publishPostPath = "/publish/%s/%s/0/%s/%s"
 
 var emptyPublishResponse *PublishResponse
 
+const publishSpaceIdQueryParam = "space-id"
+const publishTypeQueryParam = "type"
+
 type publishOpts struct {
 	endpointOpts
 
 	TTL     int
 	Channel string
 	Message interface{}
 	Meta    interface{}
+	SpaceId SpaceId
+	Type    string
 
 	UsePost        bool
 	ShouldStore    bool
@@ -125,6 +130,17 @@ func (b *publishBuilder) Meta(meta interface{}) *publishBuilder {
 	return b
 }
 
+func (b *publishBuilder) SpaceId(id SpaceId) *publishBuilder {
+	b.opts.SpaceId = id
+	return b
+}
+
+func (b *publishBuilder) Type(typ string) *publishBuilder {
+	b.opts.Type = typ
+
+	return b
+}
+
 // UsePost sends the Publish request using HTTP POST.
 func (b *publishBuilder) UsePost(post bool) *publishBuilder {
 	b.opts.UsePost = post
@@ -306,6 +322,14 @@ func (o *publishOpts) buildQuery() (*url.Values, error) {
 		q.Set("meta", string(meta))
 	}
 
+	if o.Type != "" {
+		q.Set(publishTypeQueryParam, o.Type)
+	}
+
+	if o.SpaceId != "" {
+		q.Set(publishSpaceIdQueryParam, string(o.SpaceId))
+	}
+
 	if o.setShouldStore {
 		if o.ShouldStore {
 			q.Set("store", "1")