Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add reactions enum #144

Merged
merged 4 commits into from
Mar 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion examples/echo-bot/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ package main
import (
"context"
"fmt"
"math/rand"
"regexp"
"time"

Expand Down Expand Up @@ -52,14 +53,35 @@ func main() {
)).DoVoid(ctx)

}, tgb.Regexp(regexp.MustCompile(`(?mi)(go|golang|gopher)[$\s+]?`))).
Message(func(ctx context.Context, mu *tgb.MessageUpdate) error {
// react to replied message with random reaction

msg := mu.ReplyToMessage

if msg == nil {
return mu.Update.Reply(ctx, mu.Answer("Reply to a message to get a reaction."))
}

reaction := tg.ReactionTypeEmojiAll[rand.Int()%len(tg.ReactionTypeEmojiAll)]

return mu.Update.Reply(ctx, mu.React(reaction).IsBig(true))
}, tgb.Command("react")).
Message(func(ctx context.Context, msg *tgb.MessageUpdate) error {
// handle other messages
return msg.Update.Reply(ctx, msg.Copy(msg.Chat))
}).
MessageReaction(func(ctx context.Context, reaction *tgb.MessageReactionUpdate) error {
// sets same reaction to the message
answer := tg.NewSetMessageReactionCall(reaction.Chat, reaction.MessageID).Reaction(reaction.NewReaction)
answer := tg.NewSetMessageReactionCall(reaction.Chat, reaction.MessageID).
Reaction(reaction.NewReaction)
return reaction.Update.Reply(ctx, answer)
}),

tg.WithClientInterceptors(
tg.NewInterceptorMethodFilter(
tg.NewInterceptorDefaultParseMethod(tg.HTML),
"sendMessage",
),
),
)
}
2 changes: 1 addition & 1 deletion interceptors.go
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,6 @@ func NewInterceptorMethodFilter(interceptor Interceptor, methods ...string) Inte
return interceptor(ctx, req, dst, invoker)
}

return nil
return invoker(ctx, req, dst)
}
}
229 changes: 229 additions & 0 deletions reactions.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
package tg

import (
"encoding/json"
"fmt"
)

// ReactionType it's type for describe content of Reaction.
// It can be one of:
// - [ReactionTypeEmoji]
// - [ReactionTypeCustomEmoji]
type ReactionType struct {
Emoji *ReactionTypeEmoji
CustomEmoji *ReactionTypeCustomEmoji
}

// NewReactionTypeEmoji returns ReactionType with emoji subtype.
func NewReactionTypeEmoji(emoji string) ReactionType {
return ReactionType{Emoji: &ReactionTypeEmoji{Emoji: emoji}}
}

// NewReactionTypeCustomEmoji returns ReactionType with custom emoji subtype.
func NewReactionTypeCustomEmoji(id string) ReactionType {
return ReactionType{CustomEmoji: &ReactionTypeCustomEmoji{CustomEmojiID: id}}
}

func (reaction ReactionType) MarshalJSON() ([]byte, error) {
switch {
case reaction.Emoji != nil:
reaction.Emoji.Type = "emoji"
return json.Marshal(reaction.Emoji)
case reaction.CustomEmoji != nil:
reaction.CustomEmoji.Type = "custom_emoji"
return json.Marshal(reaction.CustomEmoji)
default:
return nil, fmt.Errorf("unknown ReactionType type")
}
}

func (reaction *ReactionType) UnmarshalJSON(v []byte) error {
var partial struct {
Type string `json:"type"`
}

if err := json.Unmarshal(v, &partial); err != nil {
return fmt.Errorf("unmarshal ReactionType partial: %w", err)
}

switch partial.Type {
case "emoji":
reaction.Emoji = &ReactionTypeEmoji{}
return json.Unmarshal(v, reaction.Emoji)
case "custom_emoji":
reaction.CustomEmoji = &ReactionTypeCustomEmoji{}
return json.Unmarshal(v, reaction.CustomEmoji)
default:
return fmt.Errorf("unknown ReactionType type: %s", partial.Type)
}
}

func (reaction *ReactionType) Type() string {
switch {
case reaction.Emoji != nil:
return "emoji"
case reaction.CustomEmoji != nil:
return "custom_emoji"
default:
return "unknown"
}
}

// Ported from https://github.com/grammyjs/emoji/blob/main/src/reactiondata.ts

// Define all available reactions that can be used in the bot.
var (
ReactionTypeEmojiThumbsUp = NewReactionTypeEmoji("👍")
ReactionTypeEmojiThumbsDown = NewReactionTypeEmoji("👎")
ReactionTypeEmojiRedHeart = NewReactionTypeEmoji("❤")
ReactionTypeEmojiFire = NewReactionTypeEmoji("🔥")
ReactionTypeEmojiSmilingFaceWithHearts = NewReactionTypeEmoji("🥰")
ReactionTypeEmojiClappingHands = NewReactionTypeEmoji("👏")
ReactionTypeEmojiBeamingFaceWithSmilingEyes = NewReactionTypeEmoji("😁")
ReactionTypeEmojiThinkingFace = NewReactionTypeEmoji("🤔")
ReactionTypeEmojiExplodingHead = NewReactionTypeEmoji("🤯")
ReactionTypeEmojiFaceScreamingInFear = NewReactionTypeEmoji("😱")
ReactionTypeEmojiFaceWithSymbolsOnMouth = NewReactionTypeEmoji("🤬")
ReactionTypeEmojiCryingFace = NewReactionTypeEmoji("😢")
ReactionTypeEmojiPartyPopper = NewReactionTypeEmoji("🎉")
ReactionTypeEmojiStarStruck = NewReactionTypeEmoji("🤩")
ReactionTypeEmojiFaceVomiting = NewReactionTypeEmoji("🤮")
ReactionTypeEmojiPileOfPoo = NewReactionTypeEmoji("💩")
ReactionTypeEmojiFoldedHands = NewReactionTypeEmoji("🙏")
ReactionTypeEmojiOkHand = NewReactionTypeEmoji("👌")
ReactionTypeEmojiDove = NewReactionTypeEmoji("🕊")
ReactionTypeEmojiClownFace = NewReactionTypeEmoji("🤡")
ReactionTypeEmojiYawningFace = NewReactionTypeEmoji("🥱")
ReactionTypeEmojiWoozyFace = NewReactionTypeEmoji("🥴")
ReactionTypeEmojiSmilingFaceWithHeartEyes = NewReactionTypeEmoji("😍")
ReactionTypeEmojiSpoutingWhale = NewReactionTypeEmoji("🐳")
ReactionTypeEmojiHeartOnFire = NewReactionTypeEmoji("❤‍🔥")
ReactionTypeEmojiNewMoonFace = NewReactionTypeEmoji("🌚")
ReactionTypeEmojiHotDog = NewReactionTypeEmoji("🌭")
ReactionTypeEmojiHundredPoints = NewReactionTypeEmoji("💯")
ReactionTypeEmojiRollingOnTheFloorLaughing = NewReactionTypeEmoji("🤣")
ReactionTypeEmojiHighVoltage = NewReactionTypeEmoji("⚡")
ReactionTypeEmojiBanana = NewReactionTypeEmoji("🍌")
ReactionTypeEmojiTrophy = NewReactionTypeEmoji("🏆")
ReactionTypeEmojiBrokenHeart = NewReactionTypeEmoji("💔")
ReactionTypeEmojiFaceWithRaisedEyebrow = NewReactionTypeEmoji("🤨")
ReactionTypeEmojiNeutralFace = NewReactionTypeEmoji("😐")
ReactionTypeEmojiStrawberry = NewReactionTypeEmoji("🍓")
ReactionTypeEmojiBottleWithPoppingCork = NewReactionTypeEmoji("🍾")
ReactionTypeEmojiKissMark = NewReactionTypeEmoji("💋")
ReactionTypeEmojiMiddleFinger = NewReactionTypeEmoji("🖕")
ReactionTypeEmojiSmilingFaceWithHorns = NewReactionTypeEmoji("😈")
ReactionTypeEmojiSleepingFace = NewReactionTypeEmoji("😴")
ReactionTypeEmojiLoudlyCryingFace = NewReactionTypeEmoji("😭")
ReactionTypeEmojiNerdFace = NewReactionTypeEmoji("🤓")
ReactionTypeEmojiGhost = NewReactionTypeEmoji("👻")
ReactionTypeEmojiManTechnologist = NewReactionTypeEmoji("👨‍💻")
ReactionTypeEmojiEyes = NewReactionTypeEmoji("👀")
ReactionTypeEmojiJackOLantern = NewReactionTypeEmoji("🎃")
ReactionTypeEmojiSeeNoEvilMonkey = NewReactionTypeEmoji("🙈")
ReactionTypeEmojiSmilingFaceWithHalo = NewReactionTypeEmoji("😇")
ReactionTypeEmojiFearfulFace = NewReactionTypeEmoji("😨")
ReactionTypeEmojiHandshake = NewReactionTypeEmoji("🤝")
ReactionTypeEmojiWritingHand = NewReactionTypeEmoji("✍")
ReactionTypeEmojiSmilingFaceWithOpenHands = NewReactionTypeEmoji("🤗")
ReactionTypeEmojiSalutingFace = NewReactionTypeEmoji("🫡")
ReactionTypeEmojiSantaClaus = NewReactionTypeEmoji("🎅")
ReactionTypeEmojiChristmasTree = NewReactionTypeEmoji("🎄")
ReactionTypeEmojiSnowman = NewReactionTypeEmoji("☃")
ReactionTypeEmojiNailPolish = NewReactionTypeEmoji("💅")
ReactionTypeEmojiZanyFace = NewReactionTypeEmoji("🤪")
ReactionTypeEmojiMoai = NewReactionTypeEmoji("🗿")
ReactionTypeEmojiCoolButton = NewReactionTypeEmoji("🆒")
ReactionTypeEmojiHeartWithArrow = NewReactionTypeEmoji("💘")
ReactionTypeEmojiHearNoEvilMonkey = NewReactionTypeEmoji("🙉")
ReactionTypeEmojiUnicorn = NewReactionTypeEmoji("🦄")
ReactionTypeEmojiFaceBlowingAKiss = NewReactionTypeEmoji("😘")
ReactionTypeEmojiPill = NewReactionTypeEmoji("💊")
ReactionTypeEmojiSpeakNoEvilMonkey = NewReactionTypeEmoji("🙊")
ReactionTypeEmojiSmilingFaceWithSunglasses = NewReactionTypeEmoji("😎")
ReactionTypeEmojiAlienMonster = NewReactionTypeEmoji("👾")
ReactionTypeEmojiManShrugging = NewReactionTypeEmoji("🤷‍♂")
ReactionTypeEmojiPersonShrugging = NewReactionTypeEmoji("🤷")
ReactionTypeEmojiWomanShrugging = NewReactionTypeEmoji("🤷‍♀")
ReactionTypeEmojiEnragedFace = NewReactionTypeEmoji("😡")
)

var (
// ReactionTypeEmojiAll is a list of all available emoji reactions
// that can be used in the bot as ReactionType.
ReactionTypeEmojiAll = []ReactionType{
ReactionTypeEmojiThumbsUp,
ReactionTypeEmojiThumbsDown,
ReactionTypeEmojiRedHeart,
ReactionTypeEmojiFire,
ReactionTypeEmojiSmilingFaceWithHearts,
ReactionTypeEmojiClappingHands,
ReactionTypeEmojiBeamingFaceWithSmilingEyes,
ReactionTypeEmojiThinkingFace,
ReactionTypeEmojiExplodingHead,
ReactionTypeEmojiFaceScreamingInFear,
ReactionTypeEmojiFaceWithSymbolsOnMouth,
ReactionTypeEmojiCryingFace,
ReactionTypeEmojiPartyPopper,
ReactionTypeEmojiStarStruck,
ReactionTypeEmojiFaceVomiting,
ReactionTypeEmojiPileOfPoo,
ReactionTypeEmojiFoldedHands,
ReactionTypeEmojiOkHand,
ReactionTypeEmojiDove,
ReactionTypeEmojiClownFace,
ReactionTypeEmojiYawningFace,
ReactionTypeEmojiWoozyFace,
ReactionTypeEmojiSmilingFaceWithHeartEyes,
ReactionTypeEmojiSpoutingWhale,
ReactionTypeEmojiHeartOnFire,
ReactionTypeEmojiNewMoonFace,
ReactionTypeEmojiHotDog,
ReactionTypeEmojiHundredPoints,
ReactionTypeEmojiRollingOnTheFloorLaughing,
ReactionTypeEmojiHighVoltage,
ReactionTypeEmojiBanana,
ReactionTypeEmojiTrophy,
ReactionTypeEmojiBrokenHeart,
ReactionTypeEmojiFaceWithRaisedEyebrow,
ReactionTypeEmojiNeutralFace,
ReactionTypeEmojiStrawberry,
ReactionTypeEmojiBottleWithPoppingCork,
ReactionTypeEmojiKissMark,
ReactionTypeEmojiMiddleFinger,
ReactionTypeEmojiSmilingFaceWithHorns,
ReactionTypeEmojiSleepingFace,
ReactionTypeEmojiLoudlyCryingFace,
ReactionTypeEmojiNerdFace,
ReactionTypeEmojiGhost,
ReactionTypeEmojiManTechnologist,
ReactionTypeEmojiEyes,
ReactionTypeEmojiJackOLantern,
ReactionTypeEmojiSeeNoEvilMonkey,
ReactionTypeEmojiSmilingFaceWithHalo,
ReactionTypeEmojiFearfulFace,
ReactionTypeEmojiHandshake,
ReactionTypeEmojiWritingHand,
ReactionTypeEmojiSmilingFaceWithOpenHands,
ReactionTypeEmojiSalutingFace,
ReactionTypeEmojiSantaClaus,
ReactionTypeEmojiChristmasTree,
ReactionTypeEmojiSnowman,
ReactionTypeEmojiNailPolish,
ReactionTypeEmojiZanyFace,
ReactionTypeEmojiMoai,
ReactionTypeEmojiCoolButton,
ReactionTypeEmojiHeartWithArrow,
ReactionTypeEmojiHearNoEvilMonkey,
ReactionTypeEmojiUnicorn,
ReactionTypeEmojiFaceBlowingAKiss,
ReactionTypeEmojiPill,
ReactionTypeEmojiSpeakNoEvilMonkey,
ReactionTypeEmojiSmilingFaceWithSunglasses,
ReactionTypeEmojiAlienMonster,
ReactionTypeEmojiManShrugging,
ReactionTypeEmojiPersonShrugging,
ReactionTypeEmojiWomanShrugging,
ReactionTypeEmojiEnragedFace,
}
)
80 changes: 80 additions & 0 deletions reactions_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
package tg

import (
"encoding/json"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestReactionType(t *testing.T) {
t.Run("Emoji", func(t *testing.T) {
var r ReactionType

err := r.UnmarshalJSON([]byte(`{"type": "emoji", "emoji": "😀"}`))
require.NoError(t, err)

assert.Equal(t, "emoji", r.Type())
require.NotNil(t, r.Emoji)
assert.Equal(t, "😀", r.Emoji.Emoji)
})

t.Run("CustomEmoji", func(t *testing.T) {
var r ReactionType

err := r.UnmarshalJSON([]byte(`{"type": "custom_emoji", "custom_emoji_id": "12345"}`))
require.NoError(t, err)

assert.Equal(t, "custom_emoji", r.Type())
require.NotNil(t, r.CustomEmoji)
assert.Equal(t, "12345", r.CustomEmoji.CustomEmojiID)
})

t.Run("Unknown", func(t *testing.T) {
var r ReactionType

err := r.UnmarshalJSON([]byte(`{"type": "unknown"}`))
require.Error(t, err)
})

t.Run("InvalidFieldType", func(t *testing.T) {
var r ReactionType

err := r.UnmarshalJSON([]byte(`{"type": 123}`))
require.Error(t, err)
})
}

func TestReactionType_MarshalJSON(t *testing.T) {
t.Run("Emoji", func(t *testing.T) {
r := NewReactionTypeEmoji("😀")

assert.Equal(t, "emoji", r.Type())

b, err := json.Marshal(r)
require.NoError(t, err)

assert.Equal(t, `{"type":"emoji","emoji":"😀"}`, string(b))
})

t.Run("CustomEmoji", func(t *testing.T) {
r := NewReactionTypeCustomEmoji("12345")

assert.Equal(t, "custom_emoji", r.Type())

b, err := json.Marshal(r)
require.NoError(t, err)

assert.Equal(t, `{"type":"custom_emoji","custom_emoji_id":"12345"}`, string(b))
})

t.Run("Unknown", func(t *testing.T) {
r := ReactionType{}

assert.Equal(t, "unknown", r.Type())

_, err := json.Marshal(r)
require.Error(t, err)
})
}
7 changes: 7 additions & 0 deletions tgb/update.go
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,13 @@ func (msg *MessageUpdate) EditReplyMarkup(markup tg.InlineKeyboardMarkup) *tg.Ed
return msg.Client.EditMessageReplyMarkup(msg.Chat, msg.ID).ReplyMarkup(markup)
}

// React to incoming message.
// No arguments means remove all reactions.
func (msg *MessageUpdate) React(reactions ...tg.ReactionType) *tg.SetMessageReactionCall {
return msg.Client.SetMessageReaction(msg.Chat, msg.ID).
Reaction(reactions)
}

type CallbackQueryUpdate struct {
*tg.CallbackQuery

Expand Down
10 changes: 10 additions & 0 deletions tgb/update_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,16 @@ func TestMessageUpdateHelpers(t *testing.T) {
"reply_markup": "{\"inline_keyboard\":[[{\"text\":\"1\",\"callback_data\":\"1\"}]]}",
},
},
{
Name: "React",
Request: msg.React(tg.ReactionTypeEmojiThumbsUp).Request(),
ExceptedMethod: "setMessageReaction",
ExpectedArgs: map[string]string{
"chat_id": "123",
"message_id": "1",
"reaction": `[{"type":"emoji","emoji":"👍"}]`,
},
},
{
Name: "AnswerMediaGroup",
Request: msg.AnswerMediaGroup([]tg.InputMedia{
Expand Down
Loading
Loading