feat: AppUserAdapter

Author: trakhimenok

botsfwmodels/app_user_adapter.go

@@ -0,0 +1,12 @@
+package botsfwmodels
+
+type AppUserAdapter interface {
+	// SetBotUserID associates bot user ID with an app user record
+	SetBotUserID(platform, botID, botUserID string)
+
+	// UserNamesHolder is an interface to set and get user's names.
+	UserNamesHolder
+
+	// PreferredLocaleHolder is an interface to set and get preferred locale
+	PreferredLocaleHolder
+}

botsfwmodels/app_user_data.go

@@ -4,27 +4,21 @@ package botsfwmodels
 // Bots can use it to  store information about a user like names, preferred locale.
 type AppUserData interface {
 
-	// SetBotUserID associates bot user ID with an app user record
-	SetBotUserID(platform, botID, botUserID string)
-
-	// UserNamesHolder is an interface to set and get user's names.
-	UserNamesHolder
-
-	// PreferredLocaleHolder is an interface to set and get preferred locale
-	PreferredLocaleHolder
+	// BotsFwAdapter returns to bots framework an adapter to app user data record.
+	// Using an adapter ensures there is no clashes between bots framework interfaces and app user struct.
+	BotsFwAdapter() AppUserAdapter
 }
 
 type UserNamesHolder interface {
-	// SetName sets a name of a user. It is used to store first name, last name, etc.
-	// Parameters:
-	// - field: name of a field to set: "firstName", "lastName", "nickName", "fullName"
-	SetName(field, value string) error
 
-	// GetName returns a name of a user. It is used to store first name, last name, etc.
-	// Parameters:
-	// - field: name of a field to set: "firstName", "lastName", "nickName", "fullName"
-	GetName(field string) string
+	// SetNames sets names of a user.
+	SetNames(firstName, lastName, fullName string) error
 
-	// GetFullName returns full name of a user
-	GetFullName() string
+	//// GetName returns a name of a user. It is used to store first name, last name, etc.
+	//// Parameters:
+	//// - field: name of a field to set: "firstName", "lastName", "nickName", "fullName"
+	//GetName(field string) string
+	//
+	//// GetFullName returns full name of a user
+	//GetFullName() string
 }

botsfwmodels/chat_state.go

@@ -60,7 +60,7 @@ func (e *chatState) PopStepsFromAwaitingReplyUpToSpecificParent(step string) {
 			//steps = steps[:i]
 			break
 			// } else {
-			// log.Infof(c, "steps[%v]: %v != %v:", i, steps[i], step)
+			// logMessage.Infof(c, "steps[%v]: %v != %v:", i, steps[i], step)
 		}
 	}
 }