feat: BotUser => PlatformUser

Author: trakhimenok

botsfwmodels/bot_records_maker.go

@@ -10,7 +10,7 @@ type BotRecordsMaker interface {
 	MakeAppUserDto(botID string) (AppUserData, error)
 
 	// MakeBotUserDto makes bot user DTO for a given request sender
-	MakeBotUserDto(botID string) (BotUserData, error)
+	MakeBotUserDto(botID string) (PlatformUserData, error)
 
 	// MakeBotChatDto makes bot chat DTO for a given request
 	MakeBotChatDto(botID string) (BotChatData, error)
@@ -19,7 +19,7 @@ type BotRecordsMaker interface {
 func NewBotRecordsMaker(
 	platform string,
 	makeAppUserDto func(botID string) (appUser AppUserData, err error),
-	makeBotUserDto func(botID string) (botUser BotUserData, err error),
+	makeBotUserDto func(botID string) (botUser PlatformUserData, err error),
 	makeBotChatDto func(botID string) (botChat BotChatData, err error),
 ) BotRecordsMaker {
 	if makeAppUserDto == nil {
@@ -42,7 +42,7 @@ func NewBotRecordsMaker(
 type botRecordsMaker struct {
 	platform       string
 	makeAppUserDto func(botID string) (AppUserData, error)
-	makeBotUserDto func(botID string) (BotUserData, error)
+	makeBotUserDto func(botID string) (PlatformUserData, error)
 	makeBotChatDto func(botID string) (botChat BotChatData, err error)
 }
 
@@ -54,7 +54,7 @@ func (b botRecordsMaker) MakeAppUserDto(botID string) (AppUserData, error) {
 	return b.makeAppUserDto(botID)
 }
 
-func (b botRecordsMaker) MakeBotUserDto(botID string) (BotUserData, error) {
+func (b botRecordsMaker) MakeBotUserDto(botID string) (PlatformUserData, error) {
 	return b.makeBotUserDto(botID)
 }
 

botsfwmodels/bot_records_maker_test.go

@@ -8,15 +8,15 @@ func TestNewBotRecordsMaker(t *testing.T) {
 	type args struct {
 		platform       string
 		makeAppUserDto func(botID string) (appUser AppUserData, err error)
-		makeBotUserDto func(botID string) (botUser BotUserData, err error)
+		makeBotUserDto func(botID string) (botUser PlatformUserData, err error)
 		makeBotChatDto func(botID string) (botChat BotChatData, err error)
 	}
 
 	makeAppUserDto := func(botID string) (appUser AppUserData, err error) {
 		return nil, nil
 	}
 
-	makeBotUserDto := func(botID string) (botUser BotUserData, err error) {
+	makeBotUserDto := func(botID string) (botUser PlatformUserData, err error) {
 		return nil, nil
 	}
 

botsfwmodels/bot_user_data.go

@@ -0,0 +1,105 @@
+package botsfwmodels
+
+import (
+	"reflect"
+	"testing"
+)
+
+func TestChatKey_String(t *testing.T) {
+	type fields struct {
+		BotID  string
+		ChatID string
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		want   string
+	}{
+		{
+			name: "empty",
+			want: ":",
+		},
+		{
+			name: "botID",
+			fields: fields{
+				BotID:  "bot1",
+				ChatID: "chat1",
+			},
+			want: "bot1:chat1",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			k := ChatKey{
+				BotID:  tt.fields.BotID,
+				ChatID: tt.fields.ChatID,
+			}
+			if got := k.String(); got != tt.want {
+				t.Errorf("String() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestChatKey_Validate(t *testing.T) {
+	type fields struct {
+		BotID  string
+		ChatID string
+	}
+	tests := []struct {
+		name    string
+		fields  fields
+		wantErr bool
+	}{
+		{
+			name: "valid",
+			fields: fields{
+				BotID:  "bot1",
+				ChatID: "chat1",
+			},
+			wantErr: false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			k := ChatKey{
+				BotID:  tt.fields.BotID,
+				ChatID: tt.fields.ChatID,
+			}
+			if err := k.Validate(); (err != nil) != tt.wantErr {
+				t.Errorf("Validate() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}
+
+func TestNewChatKey(t *testing.T) {
+	type args struct {
+		botID  string
+		chatID string
+	}
+	tests := []struct {
+		name string
+		args args
+		want ChatKey
+	}{
+		{
+			name: "valid",
+			args: args{
+				botID:  "bot1",
+				chatID: "chat1",
+			},
+			want: ChatKey{
+				BotID:  "bot1",
+				ChatID: "chat1",
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := NewChatKey(tt.args.botID, tt.args.chatID); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("NewChatKey() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

botsfwmodels/chat_key_test.go

@@ -0,0 +1,24 @@
+package botsfwmodels
+
+var _ PlatformUserData = (*PlatformUserBaseDbo)(nil)
+
+// PlatformUserBaseDbo hold common properties for bot user entities
+type PlatformUserBaseDbo struct {
+	BotBaseData
+
+	BotIDs []string `json:"botIDs,omitempty" dalgo:"botIDs,omitempty,noindex" firestore:"botIDs,omitempty"`
+
+	// FirstName is the first name of a user
+	FirstName string `json:"firstName,omitempty" dalgo:"firstName,omitempty,noindex" firestore:"firstName,omitempty"`
+
+	// LastName is the last name of a user
+	LastName string `json:"lastName,omitempty"  dalgo:"lastName,omitempty,noindex" firestore:"lastName,omitempty"`
+
+	// UserName is login ID of a user
+	UserName string `json:"userName,omitempty"  dalgo:"userName,omitempty,noindex" firestore:"userName,omitempty"`
+}
+
+// BaseData returns base data of a user that should be included in all structs that implement PlatformUserData
+func (v *PlatformUserBaseDbo) BaseData() *PlatformUserBaseDbo {
+	return v
+}

botsfwmodels/platform_user_data.go

@@ -4,11 +4,11 @@ import (
 	"time"
 )
 
-// BotUserData interface provides information about bot user
+// PlatformUserData interface provides information about bot user
 // This should be implemented by bot user record struct.
-type BotUserData interface {
+type PlatformUserData interface {
 	// BaseData returns base data that should be implemented by all bot user structs
-	BaseData() *BotUserBaseData
+	BaseData() *PlatformUserBaseDbo
 
 	// GetAppUserID returns app user ID if available
 	GetAppUserID() string