small tweaks

botsfw/bot_chat.go

@@ -3,7 +3,6 @@ package botsfw
 import (
 	"time"
 
-	"context"
 	"github.com/satori/go.uuid"
 	"github.com/strongo/app/user"
 )
@@ -46,14 +45,6 @@ type BotChat interface {
 	GetGaClientID() uuid.UUID
 }
 
-// BotChatStore is interface for DAL to store bot chat data
-type BotChatStore interface {
-	GetBotChatEntityByID(c context.Context, botID, botChatID string) (BotChat, error)
-	SaveBotChat(c context.Context, botID, botChatID string, chatEntity BotChat) error
-	NewBotChatEntity(c context.Context, botID string, botChat WebhookChat, appUserID int64, botUserID string, isAccessGranted bool) BotChat
-	Close(c context.Context) error // TODO: Was io.Closer, should it?
-}
-
 // NewChatID create a new bot chat ID, returns string
 func NewChatID(botID, botChatID string) string {
 	return botID + ":" + botChatID

botsfw/bot_chat_store.go

@@ -0,0 +1,11 @@
+package botsfw
+
+import "context"
+
+// BotChatStore is interface for DAL to store bot chat data
+type BotChatStore interface {
+	GetBotChatEntityByID(c context.Context, botID, botChatID string) (BotChat, error)
+	SaveBotChat(c context.Context, botID, botChatID string, chatEntity BotChat) error
+	NewBotChatEntity(c context.Context, botID string, botChat WebhookChat, appUserID, botUserID string, isAccessGranted bool) BotChat
+	Close(c context.Context) error // TODO: Was io.Closer, should it?
+}

botsfw/bot_user.go

@@ -1,23 +1,17 @@
 package botsfw
 
 import (
-	"context"
 	"github.com/strongo/app/user"
 )
 
 // BotUser interface provides information about bot user
 type BotUser interface {
-	GetAppUserIntID() int64
+	// GetAppUserIntID returns app user ID
+	// Deprecated: use GetAppUserStrID instead
+	GetAppUserIntID() int64 // TODO: decommission?
+	GetAppUserStrID() string
 	IsAccessGranted() bool
 	SetAccessGranted(value bool) bool
 	SetAppUserIntID(appUserID int64)
-	user.UpdatedTimeSetter
-}
-
-// BotUserStore provider to store information about bot user
-type BotUserStore interface {
-	GetBotUserByID(c context.Context, botUserID interface{}) (BotUser, error)
-	SaveBotUser(c context.Context, botUserID interface{}, botUserEntity BotUser) error
-	CreateBotUser(c context.Context, botID string, apiUser WebhookActor) (BotUser, error)
-	//io.Closer
+	user.UpdatedTimeSetter // SetUpdatedTime(time.Time) // to satisfy github.com/strongo/app/user.UpdatedTimeSetter
 }

botsfw/bot_user_store.go

@@ -0,0 +1,22 @@
+package botsfw
+
+import "context"
+
+//type UserID interface {
+//	int | string
+//}
+
+// BotUserStore provider to store information about bot user
+type BotUserStore interface {
+
+	// GetBotUserByID returns bot user data
+	GetBotUserByID(c context.Context, botUserID any) (BotUser, error)
+
+	// SaveBotUser saves bot user data
+	SaveBotUser(c context.Context, botUserID any, botUserData BotUser) error
+
+	// CreateBotUser creates new bot user in DB
+	// Deprecated: should be moved to bots-fw-* package
+	CreateBotUser(c context.Context, botID string, apiUser WebhookActor) (BotUser, error)
+	//io.Closer
+}

botsfw/context.go

@@ -57,11 +57,15 @@ type WebhookContext interface { // TODO: Make interface much smaller?
 
 	ChatEntity() BotChat
 
+	// IsInGroup indicates if message was received in a group chat
 	IsInGroup() bool
 
+	// CommandText TODO: needs to be documented
 	CommandText(title, icon string) string
 
 	//Locale() strongo.ByLocale
+
+	// SetLocale sets locale for current session
 	SetLocale(code5 string) error
 
 	NewMessage(text string) MessageFromBot
@@ -78,8 +82,8 @@ type WebhookContext interface { // TODO: Make interface much smaller?
 	//SaveAppUser(appUserID int64, appUserEntity BotAppUser) error
 
 	BotState
-	BotChatStore // TODO: Migrate to strongo/db
-	BotUserStore // TODO: Migrate to strongo/db
+	BotChatStore
+	BotUserStore
 	WebhookInput // TODO: Should be removed!!!
 	strongo.SingleLocaleTranslator
 
@@ -93,13 +97,19 @@ type BotState interface {
 
 // BotInputProvider provides an input from a specific bot interface (Telegram, FB Messenger, Viber, etc.)
 type BotInputProvider interface {
+	// Input returns a webhook input from a specific bot interface (Telegram, FB Messenger, Viber, etc.)
 	Input() WebhookInput
 }
 
 // BotAPIUser provides info about current bot user
 type BotAPIUser interface {
-	//IdAsString() string
-	//IdAsInt64() int64
+	// FirstName returns user's first name
 	FirstName() string
+
+	// LastName returns user's last name
 	LastName() string
+
+	//IdAsString() string
+	//IdAsInt64() int64
+
 }

botsfw/context_base.go

@@ -471,7 +471,7 @@ func (whcb *WebhookContextBase) loadChatEntityBase() error {
 		if err != nil {
 			return err
 		}
-		botChatEntity = whcb.BotChatStore.NewBotChatEntity(c, whcb.GetBotCode(), whcb.input.Chat(), botUser.GetAppUserIntID(), botChatID, botUser.IsAccessGranted())
+		botChatEntity = whcb.BotChatStore.NewBotChatEntity(c, whcb.GetBotCode(), whcb.input.Chat(), botUser.GetAppUserStrID(), botChatID, botUser.IsAccessGranted())
 
 		if whcb.GetBotSettings().Env == strongo.EnvProduction {
 			ga := whcb.gaContext

package.go

@@ -1,3 +1,3 @@
-package botsfwframework
+package botsframework
 
 // Main code for the package is in the `botsfw` directory.

package_test.go

@@ -0,0 +1,7 @@
+package botsframework
+
+import "testing"
+
+func TestPackage(t *testing.T) {
+	t.Log("Package test")
+}