feat(types): ChatAction enum (#36)

* feat(types): define ChatAction enum

* feat(types): ParseMode is implements fmt.Stringer

* feat(request): add stringer method

* feat(types): use ChatAction type and fix type issue

* fix(examples): new ChatAction type and ParseMode use String

* tests(types): add tests for ChatAction and Username

examples/echo-bot/main.go

@@ -89,7 +89,7 @@ func newBot() *tgb.Bot {
 		}, tgb.Command("start", tgb.WithCommandAlias("help"))).
 		// handles gopher image
 		Message(func(ctx context.Context, msg *tgb.MessageUpdate) error {
-			if err := msg.Update.Respond(ctx, msg.AnswerChatAction("upload_photo")); err != nil {
+			if err := msg.Update.Respond(ctx, msg.AnswerChatAction(tg.ChatActionUploadPhoto)); err != nil {
 				return fmt.Errorf("answer chat action: %w", err)
 			}
 

examples/quote-bot/main.go

@@ -104,7 +104,7 @@ func run(ctx context.Context) error {
 					Description: quoteText(quote.Text),
 					InputMessageContent: tg.InputTextMessageContent{
 						MessageText: messageText,
-						ParseMode:   tg.HTML.Name(),
+						ParseMode:   tg.HTML.String(),
 					},
 					ReplyMarkup: tg.NewInlineKeyboardMarkup(
 						tg.NewButtonRow(

parse_mode.go

@@ -7,7 +7,7 @@ import (
 )
 
 type ParseMode interface {
-	Name() string
+	String() string
 
 	// Change separator for next calls
 	Sep(v string) ParseMode
@@ -140,7 +140,7 @@ func (pm parseMode) Line(v ...string) string {
 	return strings.Join(v, " ")
 }
 
-func (pm parseMode) Name() string {
+func (pm parseMode) String() string {
 	return pm.name
 }
 

parse_mode_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 func TestParseModeHTML(t *testing.T) {
-	assert.Equal(t, "HTML", HTML.Name())
+	assert.Equal(t, "HTML", HTML.String())
 	assert.Equal(t, "Hello World", HTML.Line("Hello", "World"))
 	assert.Equal(t, "Hello\nWorld", HTML.Text("Hello", "World"))
 	assert.Equal(t, "<b>Hello World</b>", HTML.Bold("Hello", "World"))
@@ -23,7 +23,7 @@ func TestParseModeHTML(t *testing.T) {
 }
 
 func TestParseModeMarkdown(t *testing.T) {
-	assert.Equal(t, "Markdown", MD.Name())
+	assert.Equal(t, "Markdown", MD.String())
 	assert.Equal(t, "Hello World", MD.Line("Hello", "World"))
 	assert.Equal(t, "Hello\nWorld", MD.Text("Hello", "World"))
 	assert.Equal(t, "*Hello World*", MD.Bold("Hello", "World"))
@@ -39,7 +39,7 @@ func TestParseModeMarkdown(t *testing.T) {
 }
 
 func TestParseModeMarkdownV2(t *testing.T) {
-	assert.Equal(t, "MarkdownV2", MD2.Name())
+	assert.Equal(t, "MarkdownV2", MD2.String())
 	assert.Equal(t, "Hello World", MD2.Line("Hello", "World"))
 	assert.Equal(t, "Hello\nWorld", MD2.Text("Hello", "World"))
 

request.go

@@ -67,10 +67,6 @@ func (r *Request) ChatID(name string, v ChatID) *Request {
 	return r.Int64(name, int64(v))
 }
 
-func (r *Request) ParseMode(name string, v ParseMode) *Request {
-	return r.String(name, v.Name())
-}
-
 func (r *Request) File(name string, arg FileArg) *Request {
 	if arg.FileID != "" {
 		return r.String(name, string(arg.FileID))
@@ -79,6 +75,10 @@ func (r *Request) File(name string, arg FileArg) *Request {
 	}
 }
 
+func (r *Request) Stringer(name string, v fmt.Stringer) *Request {
+	return r.String(name, v.String())
+}
+
 // Encode request using encoder.
 func (r *Request) Encode(encoder Encoder) error {
 

request_test.go

@@ -26,7 +26,7 @@ func TestRequestSetters(t *testing.T) {
 	r.Int64("int64", 1)
 	r.Float64("float64", 1)
 	r.ChatID("chat", ChatID(1))
-	r.ParseMode("parse_mode", MD2)
+	r.Stringer("parse_mode", MD2)
 	r.File("file_by_id", FileArg{
 		FileID: "file_id",
 	})

tgb/update.go

@@ -117,7 +117,7 @@ func (msg *MessageUpdate) AnswerDice(emoji string) *tg.SendDiceCall {
 }
 
 // AnswerChatAction calls sendChatAction with pre-defined chatID to incoming message chat.
-func (msg *MessageUpdate) AnswerChatAction(action string) *tg.SendChatActionCall {
+func (msg *MessageUpdate) AnswerChatAction(action tg.ChatAction) *tg.SendChatActionCall {
 	return msg.Client.SendChatAction(msg.Chat, action)
 }
 

tgb/update_test.go

@@ -270,7 +270,7 @@ func TestMessageUpdateHelpers(t *testing.T) {
 		},
 		{
 			Name:           "AnswerChatAction",
-			Request:        msg.AnswerChatAction("upload_photo").Request(),
+			Request:        msg.AnswerChatAction(tg.ChatActionUploadPhoto).Request(),
 			ExceptedMethod: "sendChatAction",
 			ExpectedArgs: map[string]string{
 				"chat_id": "123",

types_gen_ext.go

@@ -66,6 +66,42 @@ func (chatType *ChatType) UnmarshalJSON(b []byte) error {
 	return nil
 }
 
+// ChatAction type of action to broadcast via sendChatAction.
+type ChatAction int8
+
+const (
+	ChatActionTyping ChatAction = iota + 1
+	ChatActionUploadPhoto
+	ChatActionRecordVideo
+	ChatActionUploadVideo
+	ChatActionRecordVoice
+	ChatActionUploadVoice
+	ChatActionUploadDocument
+	ChatActionChooseSticker
+	ChatActionFindLocation
+	ChatActionRecordVideoNote
+	ChatActionUploadVideoNote
+)
+
+func (action ChatAction) String() string {
+	if action < ChatActionTyping || action > ChatActionUploadVideoNote {
+		return "unknown"
+	}
+	return [...]string{
+		"typing",
+		"upload_photo",
+		"record_video",
+		"upload_video",
+		"record_voice",
+		"upload_voice",
+		"upload_document",
+		"choose_sticker",
+		"find_location",
+		"record_video_note",
+		"upload_video_note",
+	}[action-1]
+}
+
 // UserID it's unique identifier for Telegram user or bot.
 type UserID int64
 

types_gen_ext_test.go

@@ -20,6 +20,10 @@ func TestPeerIDImpl(t *testing.T) {
 	}
 }
 
+func TestUsername_PeerID(t *testing.T) {
+	assert.Equal(t, "@username", Username("username").PeerID())
+}
+
 func TestChatType_String(t *testing.T) {
 	for _, test := range []struct {
 		ChatType ChatType
@@ -36,6 +40,28 @@ func TestChatType_String(t *testing.T) {
 	}
 }
 
+func TestChatAction_String(t *testing.T) {
+	for _, test := range []struct {
+		ChatAction ChatAction
+		Want       string
+	}{
+		{ChatActionTyping, "typing"},
+		{ChatActionUploadPhoto, "upload_photo"},
+		{ChatActionUploadVideo, "upload_video"},
+		{ChatActionRecordVideo, "record_video"},
+		{ChatActionRecordVoice, "record_voice"},
+		{ChatActionUploadVoice, "upload_voice"},
+		{ChatActionUploadDocument, "upload_document"},
+		{ChatActionChooseSticker, "choose_sticker"},
+		{ChatActionFindLocation, "find_location"},
+		{ChatActionRecordVideoNote, "record_video_note"},
+		{ChatActionUploadVideoNote, "upload_video_note"},
+		{ChatAction(-1), "unknown"},
+	} {
+		assert.Equal(t, test.Want, test.ChatAction.String())
+	}
+}
+
 func TestChatType_MarshalJSON(t *testing.T) {
 	type sample struct {
 		Type ChatType `json:"type"`