interfaces.go

package bots

import (
	"net/http"
	"time"

	"context"
	"github.com/strongo/db"
)

// BotPlatform describes current bot platform
type BotPlatform interface {
	ID() string
	Version() string
}

// BotHost describes current bot app host environment
type BotHost interface {
	Context(r *http.Request) context.Context
	GetHTTPClient(c context.Context) *http.Client
	GetBotCoreStores(platform string, appContext BotAppContext, r *http.Request) BotCoreStores
	DB() db.Database
}

// botContext describes current bot app host & settings
type BotContext struct {
	// TODO: Rename to BotWebhookContext or just WebhookContext (replace old one)
	BotHost     BotHost
	BotSettings BotSettings
}

// NewBotContext creates current bot host & settings
func NewBotContext(host BotHost, settings BotSettings) *BotContext {
	if settings.Code == "" {
		panic("ReferredTo settings.Code is empty string")
	}
	return &BotContext{
		BotHost:     host,
		BotSettings: settings,
	}
}

// WebhookEntry represents a single message from a messenger user
type WebhookEntry interface {
	GetID() interface{}
	GetTime() time.Time
}

// WebhookInputType is enum of input type
type WebhookInputType int

const (
	// WebhookInputUnknown is unknown input type
	WebhookInputUnknown WebhookInputType = iota
	// WebhookInputNotImplemented is not implemented input type
	WebhookInputNotImplemented
	// WebhookInputText is text input type
	WebhookInputText // Facebook, Telegram, Viber
	// WebhookInputVoice is voice input type
	WebhookInputVoice
	// WebhookInputPhoto is photo input type
	WebhookInputPhoto
	// WebhookInputAudio is audio input type
	WebhookInputAudio
	// WebhookInputContact is contact input type
	WebhookInputContact // Facebook, Telegram, Viber
	// WebhookInputPostback is unknown input type
	WebhookInputPostback
	// WebhookInputDelivery is postback input type
	WebhookInputDelivery
	// WebhookInputAttachment is delivery report input type
	WebhookInputAttachment
	// WebhookInputInlineQuery is attachment input type
	WebhookInputInlineQuery // Telegram
	// WebhookInputCallbackQuery is inline input type
	WebhookInputCallbackQuery
	// WebhookInputReferral is callback input type
	WebhookInputReferral // FBM
	// WebhookInputChosenInlineResult is chosen inline result input type
	WebhookInputChosenInlineResult // Telegram
	// WebhookInputSubscribed is subscribed input type
	WebhookInputSubscribed // Viber
	// WebhookInputUnsubscribed is unsubscribed input type
	WebhookInputUnsubscribed // Viber
	// WebhookInputConversationStarted is converstation started input type
	WebhookInputConversationStarted // Viber
	// WebhookInputNewChatMembers is new chat memebers input type
	WebhookInputNewChatMembers // Telegram groups
	// WebhookInputLeftChatMembers is left chat members input type
	WebhookInputLeftChatMembers
	// WebhookInputSticker is sticker input type
	WebhookInputSticker // Telegram
)

// WebhookInputTypeNames names for input type
var WebhookInputTypeNames = map[WebhookInputType]string{
	//WebhookInputContact:				  "Contact",
	WebhookInputUnknown:             "unknown",
	WebhookInputNotImplemented:      "not implemented",
	WebhookInputReferral:            "Referral",
	WebhookInputText:                "Text",
	WebhookInputContact:             "Contact",
	WebhookInputPostback:            "Postback",
	WebhookInputDelivery:            "Delivery",
	WebhookInputAttachment:          "Attachment",
	WebhookInputInlineQuery:         "InlineQuery",
	WebhookInputCallbackQuery:       "CallbackQuery",
	WebhookInputChosenInlineResult:  "ChosenInlineResult",
	WebhookInputSubscribed:          "Subscribed",          // Viber
	WebhookInputUnsubscribed:        "Unsubscribed",        // Viber
	WebhookInputConversationStarted: "ConversationStarted", // Telegram
	WebhookInputNewChatMembers:      "NewChatMembers",      // Telegram
}

// WebhookInput represent a single message
type WebhookInput interface {
	// '/entry/messaging' for Facebook
	GetSender() WebhookSender
	GetRecipient() WebhookRecipient
	GetTime() time.Time
	InputType() WebhookInputType
	BotChatID() (string, error)
	Chat() WebhookChat
	LogRequest()
}

// WebhookActor represents sender
type WebhookActor interface {
	Platform() string
	GetID() interface{}
	IsBotUser() bool
	GetFirstName() string
	GetLastName() string
	GetUserName() string
	GetLanguage() string
}

// WebhookSender represents sender with avatar
type WebhookSender interface {
	GetAvatar() string // Extension to support avatar (Viber)
	WebhookActor
}

// WebhookUser represents sender with country
type WebhookUser interface {
	// Extension to support language & country (Viber)
	GetCountry() string
	WebhookSender
}

// WebhookRecipient represents receiver
type WebhookRecipient interface {
	WebhookActor
}

// WebhookMessage represents single message
type WebhookMessage interface {
	IntID() int64
	StringID() string
	Chat() WebhookChat
	//Sequence() int // 'seq' for Facebook, '???' for Telegram
}

// WebhookTextMessage represents single text message
type WebhookTextMessage interface {
	WebhookMessage
	Text() string
	IsEdited() bool
}

// WebhookStickerMessage represents single sticker message
type WebhookStickerMessage interface {
	WebhookMessage
	// TODO: Define sticker message interface
}

// WebhookVoiceMessage represents single voice message
type WebhookVoiceMessage interface {
	WebhookMessage
	// TODO: Define voice message interface
}

// WebhookPhotoMessage represents single photo message
type WebhookPhotoMessage interface {
	WebhookMessage
	// TODO: Define voice message interface
}

// WebhookAudioMessage represents single audio message
type WebhookAudioMessage interface {
	WebhookMessage
	// TODO: Define voice message interface
}

// WebhookReferralMessage represents single referral message
type WebhookReferralMessage interface {
	// https://developers.facebook.com/docs/messenger-platform/webhook-reference/referral
	Type() string
	Source() string
	RefData() string
}

// WebhookContactMessage represents single contact message
type WebhookContactMessage interface {
	PhoneNumber() string
	FirstName() string
	LastName() string
	UserID() interface{}
}

// WebhookNewChatMembersMessage represents single message about a new member of a chat
type WebhookNewChatMembersMessage interface {
	BotChatID() (string, error)
	NewChatMembers() []WebhookActor
}

// WebhookLeftChatMembersMessage represents single message about a member leaving a chat
type WebhookLeftChatMembersMessage interface {
	BotChatID() (string, error)
	LeftChatMembers() []WebhookActor
}

// WebhookChat represents chat of a messenger
type WebhookChat interface {
	GetID() string
	GetType() string
	IsGroupChat() bool
}

// WebhookPostback represents single postback message
type WebhookPostback interface {
	PostbackMessage() interface{}
	Payload() string
}

// WebhookSubscribed represents a subscription message
type WebhookSubscribed interface {
	SubscribedMessage() interface{}
}

// WebhookUnsubscribed represents a message when user unsubscribe
type WebhookUnsubscribed interface {
	UnsubscribedMessage() interface{}
}

// WebhookConversationStarted represents a single message about new conversation
type WebhookConversationStarted interface {
	ConversationStartedMessage() interface{}
}

// WebhookInlineQuery represents a single inline message
type WebhookInlineQuery interface {
	GetID() interface{}
	GetInlineQueryID() string
	GetFrom() WebhookSender
	GetQuery() string
	GetOffset() string
	//GetLocation() - TODO: Not implemented yet
}

// WebhookDelivery represents a single delivery report message
type WebhookDelivery interface {
	Payload() string
}

// WebhookChosenInlineResult represents a single report message on chosen inline result
type WebhookChosenInlineResult interface {
	GetResultID() string
	GetInlineMessageID() string // Telegram only?
	GetFrom() WebhookSender
	GetQuery() string
	//GetLocation() - TODO: Not implemented yet
}

// WebhookCallbackQuery represents a single callback query message
type WebhookCallbackQuery interface {
	GetID() string
	GetInlineMessageID() string // Telegram only?
	GetFrom() WebhookSender
	GetMessage() WebhookMessage
	GetData() string
	Chat() WebhookChat
}

// WebhookAttachment represents attachment to a message
type WebhookAttachment interface {
	Type() string       // Enum(image, video, audio) for Facebook
	PayloadUrl() string // 'payload.url' for Facebook
}

// MessengerResponse represents response from a messenger
type MessengerResponse interface {
}

// OnMessageSentResponse represents response on message sent event
type OnMessageSentResponse struct {
	StatusCode      int
	TelegramMessage MessengerResponse // TODO: change to some interface
}

// WebhookResponder is an API provider to send messages through a messenger
type WebhookResponder interface {
	SendMessage(c context.Context, m MessageFromBot, channel BotAPISendMessageChannel) (OnMessageSentResponse, error)
}

// InputMessage represents single input message
type InputMessage interface {
	Text() string
}

// BotCoreStores provides DI DAL for updating app persistent store
type BotCoreStores struct {
	BotChatStore
	BotUserStore
	BotAppUserStore
}

// BotAPISendMessageChannel specifies messenger channel
type BotAPISendMessageChannel string

const (
	// BotAPISendMessageOverHTTPS indicates message should be sent over HTTPS
	BotAPISendMessageOverHTTPS = BotAPISendMessageChannel("https")

	// BotAPISendMessageOverResponse indicates message should be sent in HTTP response
	BotAPISendMessageOverResponse = BotAPISendMessageChannel("response")
)