Additional serializers for tgbotapi model

Author: madhead

settings.gradle.kts

@@ -5,6 +5,7 @@ rootProject.name = "jprof_by_bot"
 
 include(":utils:dynamodb")
 include(":utils:aws-junit5")
+include(":utils:tgbotapi-serialization")
 include(":votes")
 include(":votes:dynamodb")
 include(":votes:tgbotapi-extensions")

utils/tgbotapi-serialization/build.gradle.kts

@@ -0,0 +1,13 @@
+plugins {
+    kotlin("jvm")
+    kotlin("plugin.serialization")
+}
+
+dependencies {
+    api(libs.tgbotapi.core)
+    implementation(libs.kotlinx.serialization.core)
+
+    testImplementation(libs.junit.jupiter.api)
+    testImplementation(libs.junit.jupiter.params)
+    testRuntimeOnly(libs.junit.jupiter.engine)
+}

utils/tgbotapi-serialization/src/main/kotlin/by/jprof/telegram/bot/utils/tgbotapi_serialization/TgBotAPI.kt

@@ -0,0 +1,36 @@
+package by.jprof.telegram.bot.utils.tgbotapi_serialization
+
+import by.jprof.telegram.bot.utils.tgbotapi_serialization.serializers.TextContentSerializer
+import dev.inmo.tgbotapi.types.message.content.TextContent
+import dev.inmo.tgbotapi.types.message.content.abstracts.MessageContent
+import kotlinx.serialization.modules.SerializersModule
+import kotlinx.serialization.modules.polymorphic
+
+object TgBotAPI {
+    val module = SerializersModule {
+        polymorphic(MessageContent::class) {
+            // subclass(AnimationContent::class, AnimationContentSerializer())
+            // subclass(AudioContent::class, AudioContentSerializer())
+            // subclass(AudioMediaGroupContent::class, AudioMediaGroupContentSerializer())
+            // subclass(ContactContent::class, ContactContentSerializer())
+            // subclass(DiceContent::class, DiceContentSerializer())
+            // subclass(DocumentContent::class, DocumentContentSerializer())
+            // subclass(DocumentMediaGroupContent::class, DocumentMediaGroupContentSerializer())
+            // subclass(GameContent::class, GameContentSerializer())
+            // subclass(InvoiceContent::class, InvoiceContentSerializer())
+            // subclass(LocationContent::class, LocationContentSerializer())
+            // subclass(MediaCollectionContent::class, MediaCollectionContentSerializer())
+            // subclass(MediaContent::class, MediaContentSerializer())
+            // subclass(MediaGroupContent::class, MediaGroupContentSerializer())
+            // subclass(PhotoContent::class, PhotoContentSerializer())
+            // subclass(PollContent::class, PollContentSerializer())
+            // subclass(StickerContent::class, StickerContentSerializer())
+            subclass(TextContent::class, TextContentSerializer())
+            // subclass(VenueContent::class, VenueContentSerializer())
+            // subclass(VideoContent::class, VideoContentSerializer())
+            // subclass(VideoNoteContent::class, VideoNoteContentSerializer())
+            // subclass(VisualMediaGroupContent::class, VisualMediaGroupContentSerializer())
+            // subclass(VoiceContent::class, VoiceContentSerializer())
+        }
+    }
+}

utils/tgbotapi-serialization/src/main/kotlin/by/jprof/telegram/bot/utils/tgbotapi_serialization/serializers/TextContentSerializer.kt

@@ -0,0 +1,30 @@
+package by.jprof.telegram.bot.utils.tgbotapi_serialization.serializers
+
+import by.jprof.telegram.bot.utils.tgbotapi_serialization.surrogates.TextContentSurrogate
+import dev.inmo.tgbotapi.types.message.content.TextContent
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+
+internal class TextContentSerializer : KSerializer<TextContent> {
+    override val descriptor: SerialDescriptor = TextContentSurrogate.serializer().descriptor
+
+    override fun serialize(encoder: Encoder, value: TextContent) {
+        val surrogate = TextContentSurrogate(
+            text = value.text,
+            textSources = value.textSources,
+        )
+
+        encoder.encodeSerializableValue(TextContentSurrogate.serializer(), surrogate)
+    }
+
+    override fun deserialize(decoder: Decoder): TextContent {
+        val surrogate = decoder.decodeSerializableValue(TextContentSurrogate.serializer())
+
+        return TextContent(
+            text = surrogate.text,
+            textSources = surrogate.textSources,
+        )
+    }
+}

utils/tgbotapi-serialization/src/main/kotlin/by/jprof/telegram/bot/utils/tgbotapi_serialization/surrogates/TextContentSurrogate.kt

@@ -0,0 +1,12 @@
+package by.jprof.telegram.bot.utils.tgbotapi_serialization.surrogates
+
+import dev.inmo.tgbotapi.types.MessageEntity.textsources.TextSourcesList
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+@SerialName("TextContent")
+internal data class TextContentSurrogate(
+    val text: String,
+    val textSources: TextSourcesList = emptyList()
+)

utils/tgbotapi-serialization/src/test/kotlin/by/jprof/telegram/bot/utils/tgbotapi_serialization/TextContentSerializerTest.kt

@@ -0,0 +1,40 @@
+package by.jprof.telegram.bot.utils.tgbotapi_serialization
+
+import dev.inmo.tgbotapi.types.MessageEntity.textsources.BotCommandTextSource
+import dev.inmo.tgbotapi.types.MessageEntity.textsources.RegularTextSource
+import dev.inmo.tgbotapi.types.message.content.TextContent
+import dev.inmo.tgbotapi.types.message.content.abstracts.MessageContent
+import kotlinx.serialization.decodeFromString
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+import org.junit.jupiter.api.Assertions
+import org.junit.jupiter.api.Test
+
+internal class TextContentSerializerTest {
+    private val json = Json { serializersModule = TgBotAPI.module }
+    private val textContent = TextContent(
+        text = "/start up",
+        textSources = listOf(
+            BotCommandTextSource(source = "/start"),
+            RegularTextSource(source = " up")
+        )
+    )
+    private val serialized =
+        "{\"type\":\"TextContent\",\"text\":\"/start up\",\"textSources\":[{\"type\":\"bot_command\",\"value\":{\"source\":\"/start\"}},{\"type\":\"regular\",\"value\":{\"source\":\" up\"}}]}"
+
+    @Test
+    fun serialize() {
+        Assertions.assertEquals(
+            serialized,
+            json.encodeToString<MessageContent>(textContent)
+        )
+    }
+
+    @Test
+    fun deserialize() {
+        Assertions.assertEquals(
+            textContent,
+            json.decodeFromString<MessageContent>(serialized)
+        )
+    }
+}