Merge pull request #91 from InsanusMokrassar/0.27.6

0.27.6

CHANGELOG.md

@@ -49,6 +49,25 @@
         * `closePollExactAfter`
         * `closePollAfter`
 
+### 0.27.6
+
+* `Common`:
+    * Versions:
+        * `Kotlin Coroutines`: `1.3.6` -> `1.3.7`
+* `TelegramBotAPI`:
+    * Interface `PossiblySentViaBot` has been added
+        * Additional interface `PossiblySentViaBotCommonMessage` was added for more explicit typing declaration for
+        compiler
+            * Currently, only `ChannelMessage` and `CommonMessageImpl` are implementing the interface
+            `PossiblySentViaBotCommonMessage`. It could be changed in future
+    * Factory `buildMimeType` was added
+    * `BuiltinMimeTypes` was added
+    * Abstraction `ThumbedWithMimeTypeInlineQueryResult` with `thumbMimeType` field was added
+        * `InlineQueryResultGif` and `InlineQueryResultMpeg4Gif` now extend `ThumbedWithMimeTypeInlineQueryResult`
+        instead of `ThumbedInlineQueryResult`
+* `TelegramBotAPI-extensions-utils`:
+    * New extensions `onlyCommonMessages`, `onlySentViaBot` and `withoutSentViaBot` was added
+
 ### 0.27.5
 
 * `Common`:

TelegramBotAPI-extensions-utils/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/extensions/utils/CommonMessageConversations.kt

@@ -0,0 +1,34 @@
+package com.github.insanusmokrassar.TelegramBotAPI.extensions.utils
+
+import com.github.insanusmokrassar.TelegramBotAPI.types.message.abstracts.CommonMessage
+import com.github.insanusmokrassar.TelegramBotAPI.types.message.abstracts.ContentMessage
+import com.github.insanusmokrassar.TelegramBotAPI.types.message.content.abstracts.MessageContent
+import com.github.insanusmokrassar.TelegramBotAPI.types.message.content.abstracts.PossiblySentViaBotCommonMessage
+import kotlinx.coroutines.flow.*
+
+/**
+ * Simple factory to convert [ContentMessage] to a [CommonMessage]
+ */
+fun <C: MessageContent, T : ContentMessage<C>> Flow<T>.onlyCommonMessages() = filterIsInstance<CommonMessage<C>>()
+
+/**
+ * Filter the messages and checking that incoming [CommonMessage] is [PossiblySentViaBotCommonMessage] and its
+ * [PossiblySentViaBotCommonMessage.senderBot] is not null
+ */
+fun <T : MessageContent> Flow<CommonMessage<T>>.onlySentViaBot() = mapNotNull {
+    (it as? PossiblySentViaBotCommonMessage) ?.let { possiblySentViaBot ->
+        if (possiblySentViaBot.senderBot != null) {
+            possiblySentViaBot
+        } else {
+            null
+        }
+    }
+}
+
+/**
+ * Filter the messages and checking that incoming [CommonMessage] not is [PossiblySentViaBotCommonMessage] or its
+ * [PossiblySentViaBotCommonMessage.senderBot] is null
+ */
+fun <T : MessageContent> Flow<CommonMessage<T>>.withoutSentViaBot() = filter {
+    it !is PossiblySentViaBotCommonMessage || it.senderBot == null
+}

TelegramBotAPI-extensions-utils/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/extensions/utils/updates/SentMessageUpdatesConversations.kt

@@ -12,6 +12,13 @@ fun <T : BaseSentMessageUpdate> Flow<T>.asContentMessagesFlow() = mapNotNull {
     it.data as? ContentMessage<*>
 }
 
+/**
+ * Will map incoming [BaseSentMessageUpdate]s to [CommonMessage] from [BaseSentMessageUpdate.data]
+ */
+fun <T : BaseSentMessageUpdate> Flow<T>.asCommonMessagesFlow() = mapNotNull {
+    it.data as? CommonMessage<*>
+}
+
 /**
  * Will map incoming [BaseSentMessageUpdate]s to [ChatEventMessage] from [BaseSentMessageUpdate.data]
  */

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/Common.kt

@@ -1,5 +1,7 @@
 package com.github.insanusmokrassar.TelegramBotAPI.types
 
+import com.github.insanusmokrassar.TelegramBotAPI.utils.BuiltinMimeTypes
+
 typealias Identifier = Long
 typealias MessageIdentifier = Long
 typealias InlineQueryIdentifier = String
@@ -63,6 +65,12 @@ val quizPollExplanationLimit = explanationLimit
 
 val openPeriodPollSecondsLimit = 5 .. 600
 
+val telegramInlineModeGifPermittedMimeTypes = listOf(
+    BuiltinMimeTypes.Image.Jpg,
+    BuiltinMimeTypes.Image.Gif,
+    BuiltinMimeTypes.Video.MP4
+)
+
 const val chatIdField = "chat_id"
 const val messageIdField = "message_id"
 const val updateIdField = "update_id"
@@ -177,6 +185,7 @@ const val stickerFileIdField = "sticker_file_id"
 const val gameShortNameField = "game_short_name"
 
 const val thumbUrlField = "thumb_url"
+const val thumbMimeTypeField = "thumb_mime_type"
 const val thumbWidthField = "thumb_width"
 const val thumbHeightField = "thumb_height"
 

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/InlineQueries/InlineQueryResult/InlineQueryResultGifImpl.kt

@@ -7,6 +7,7 @@ import com.github.insanusmokrassar.TelegramBotAPI.types.InlineQueries.abstracts.
 import com.github.insanusmokrassar.TelegramBotAPI.types.ParseMode.ParseMode
 import com.github.insanusmokrassar.TelegramBotAPI.types.ParseMode.parseModeField
 import com.github.insanusmokrassar.TelegramBotAPI.types.buttons.InlineKeyboardMarkup
+import com.github.insanusmokrassar.TelegramBotAPI.utils.MimeType
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
@@ -18,6 +19,8 @@ data class InlineQueryResultGifImpl(
     override val url: String,
     @SerialName(thumbUrlField)
     override val thumbUrl: String,
+    @SerialName(thumbMimeTypeField)
+    override val thumbMimeType: MimeType? = null,
     @SerialName(gifWidthField)
     override val width: Int? = null,
     @SerialName(gifHeightField)
@@ -36,4 +39,10 @@ data class InlineQueryResultGifImpl(
     override val inputMessageContent: InputMessageContent? = null
 ) : InlineQueryResultGif {
     override val type: String = inlineQueryResultGifType
+
+    init {
+        if (thumbMimeType != null && thumbMimeType !in telegramInlineModeGifPermittedMimeTypes) {
+            error("Passed thumb mime type is not permitted in Telegram Bot API. Passed $thumbMimeType, but permitted $telegramInlineModeGifPermittedMimeTypes")
+        }
+    }
 }

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/InlineQueries/InlineQueryResult/InlineQueryResultMpeg4GifImpl.kt

@@ -7,6 +7,7 @@ import com.github.insanusmokrassar.TelegramBotAPI.types.InlineQueries.abstracts.
 import com.github.insanusmokrassar.TelegramBotAPI.types.ParseMode.ParseMode
 import com.github.insanusmokrassar.TelegramBotAPI.types.ParseMode.parseModeField
 import com.github.insanusmokrassar.TelegramBotAPI.types.buttons.InlineKeyboardMarkup
+import com.github.insanusmokrassar.TelegramBotAPI.utils.MimeType
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
@@ -18,6 +19,8 @@ data class InlineQueryResultMpeg4GifImpl(
     override val url: String,
     @SerialName(thumbUrlField)
     override val thumbUrl: String,
+    @SerialName(thumbMimeTypeField)
+    override val thumbMimeType: MimeType? = null,
     @SerialName(mpeg4GifWidthField)
     override val width: Int? = null,
     @SerialName(mpeg4GifHeightField)
@@ -36,4 +39,10 @@ data class InlineQueryResultMpeg4GifImpl(
     override val inputMessageContent: InputMessageContent? = null
 ) : InlineQueryResultMpeg4Gif {
     override val type: String = inlineQueryResultMpeg4GifType
+
+    init {
+        if (thumbMimeType != null && thumbMimeType !in telegramInlineModeGifPermittedMimeTypes) {
+            error("Passed thumb mime type is not permitted in Telegram Bot API. Passed $thumbMimeType, but permitted $telegramInlineModeGifPermittedMimeTypes")
+        }
+    }
 }

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/InlineQueries/InlineQueryResult/abstracts/ThumbedInlineQueryResult.kt

@@ -1,5 +1,11 @@
 package com.github.insanusmokrassar.TelegramBotAPI.types.InlineQueries.InlineQueryResult.abstracts
 
+import com.github.insanusmokrassar.TelegramBotAPI.utils.MimeType
+
 interface ThumbedInlineQueryResult : InlineQueryResult {
     val thumbUrl: String?
 }
+
+interface ThumbedWithMimeTypeInlineQueryResult : ThumbedInlineQueryResult {
+    val thumbMimeType: MimeType?
+}

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/InlineQueries/InlineQueryResult/abstracts/results/gif/InlineQueryResultGif.kt

@@ -2,4 +2,4 @@ package com.github.insanusmokrassar.TelegramBotAPI.types.InlineQueries.InlineQue
 
 import com.github.insanusmokrassar.TelegramBotAPI.types.InlineQueries.InlineQueryResult.abstracts.*
 
-interface InlineQueryResultGif : InlineQueryResultGifCommon, UrlInlineQueryResult, ThumbedInlineQueryResult, SizedInlineQueryResult, DuratedInlineResultQuery
+interface InlineQueryResultGif : InlineQueryResultGifCommon, UrlInlineQueryResult, ThumbedWithMimeTypeInlineQueryResult, SizedInlineQueryResult, DuratedInlineResultQuery

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/InlineQueries/InlineQueryResult/abstracts/results/mpeg4gif/InlineQueryResultMpeg4Gif.kt

@@ -2,4 +2,4 @@ package com.github.insanusmokrassar.TelegramBotAPI.types.InlineQueries.InlineQue
 
 import com.github.insanusmokrassar.TelegramBotAPI.types.InlineQueries.InlineQueryResult.abstracts.*
 
-interface InlineQueryResultMpeg4Gif : InlineQueryResultMpeg4GifCommon, UrlInlineQueryResult, ThumbedInlineQueryResult, SizedInlineQueryResult, DuratedInlineResultQuery
+interface InlineQueryResultMpeg4Gif : InlineQueryResultMpeg4GifCommon, UrlInlineQueryResult, ThumbedWithMimeTypeInlineQueryResult, SizedInlineQueryResult, DuratedInlineResultQuery

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/message/ChannelMessage.kt

@@ -1,12 +1,11 @@
 package com.github.insanusmokrassar.TelegramBotAPI.types.message
 
-import com.github.insanusmokrassar.TelegramBotAPI.types.AuthorSignature
+import com.github.insanusmokrassar.TelegramBotAPI.types.*
-import com.github.insanusmokrassar.TelegramBotAPI.types.MessageIdentifier
 import com.github.insanusmokrassar.TelegramBotAPI.types.buttons.InlineKeyboardMarkup
 import com.github.insanusmokrassar.TelegramBotAPI.types.chat.abstracts.Chat
-import com.github.insanusmokrassar.TelegramBotAPI.types.message.abstracts.CommonMessage
+import com.github.insanusmokrassar.TelegramBotAPI.types.message.abstracts.*
-import com.github.insanusmokrassar.TelegramBotAPI.types.message.abstracts.Message
 import com.github.insanusmokrassar.TelegramBotAPI.types.message.content.abstracts.MessageContent
+import com.github.insanusmokrassar.TelegramBotAPI.types.message.content.abstracts.PossiblySentViaBotCommonMessage
 import com.soywiz.klock.DateTime
 
 data class ChannelMessage<T: MessageContent>(
@@ -18,5 +17,6 @@ data class ChannelMessage<T: MessageContent>(
     override val forwardInfo: ForwardInfo?,
     override val replyTo: Message?,
     override val replyMarkup: InlineKeyboardMarkup?,
+    override val senderBot: CommonBot?,
     val authorSignature: AuthorSignature?
-) : CommonMessage<T>
+) : PossiblySentViaBotCommonMessage<T>

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/message/CommonMessageImpl.kt

@@ -1,11 +1,11 @@
 package com.github.insanusmokrassar.TelegramBotAPI.types.message
 
-import com.github.insanusmokrassar.TelegramBotAPI.types.MessageIdentifier
+import com.github.insanusmokrassar.TelegramBotAPI.types.*
-import com.github.insanusmokrassar.TelegramBotAPI.types.User
 import com.github.insanusmokrassar.TelegramBotAPI.types.buttons.InlineKeyboardMarkup
 import com.github.insanusmokrassar.TelegramBotAPI.types.chat.abstracts.Chat
 import com.github.insanusmokrassar.TelegramBotAPI.types.message.abstracts.*
 import com.github.insanusmokrassar.TelegramBotAPI.types.message.content.abstracts.MessageContent
+import com.github.insanusmokrassar.TelegramBotAPI.types.message.content.abstracts.PossiblySentViaBotCommonMessage
 import com.github.insanusmokrassar.TelegramBotAPI.types.message.payments.SuccessfulPaymentInfo
 import com.soywiz.klock.DateTime
 
@@ -19,5 +19,6 @@ data class CommonMessageImpl<T: MessageContent>(
     override val forwardInfo: ForwardInfo?,
     override val replyTo: Message?,
     override val replyMarkup: InlineKeyboardMarkup?,
+    override val senderBot: CommonBot?,
     val paymentInfo: SuccessfulPaymentInfo?
-) : Message, CommonMessage<T>, FromUserMessage
+) : PossiblySentViaBotCommonMessage<T>, FromUserMessage

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/message/RawMessage.kt

@@ -42,6 +42,7 @@ internal data class RawMessage(
     private val forward_sender_name: ForwardSenderName? = null,
     private val forward_date: TelegramDate? = null,
     private val reply_to_message: RawMessage? = null,
+    private val via_bot: CommonBot? = null,
     private val edit_date: TelegramDate? = null,
     private val media_group_id: MediaGroupIdentifier? = null,
     private val author_signature: AuthorSignature? = null,
@@ -147,7 +148,7 @@ internal data class RawMessage(
             )
             forward_from_chat is ChannelChat -> ForwardFromChannelInfo(
                 forward_date,
-                forward_from_message_id ?: throw IllegalStateException("Channel forwarded message must contain message id, but was not"),
+                forward_from_message_id ?: error("Channel forwarded message must contain message id, but was not"),
                 forward_from_chat,
                 forward_signature
             )
@@ -208,7 +209,7 @@ internal data class RawMessage(
                         chatEvent as? ChannelEvent ?: throwWrongChatEvent(ChannelEvent::class, chatEvent),
                         date.asDate
                     )
-                    else -> throw IllegalStateException("Expected one of the public chats, but was $chat (in extracting of chat event message)")
+                    else -> error("Expected one of the public chats, but was $chat (in extracting of chat event message)")
                 }
             } ?: content?.let { content ->
                 media_group_id?.let {
@@ -221,7 +222,7 @@ internal data class RawMessage(
                             when (content) {
                                 is PhotoContent -> content
                                 is VideoContent -> content
-                                else -> throw IllegalStateException("Unsupported content for media group")
+                                else -> error("Unsupported content for media group")
                             },
                             edit_date?.asDate,
                             forwarded,
@@ -237,7 +238,7 @@ internal data class RawMessage(
                             when (content) {
                                 is PhotoContent -> content
                                 is VideoContent -> content
-                                else -> throw IllegalStateException("Unsupported content for media group")
+                                else -> error("Unsupported content for media group")
                             },
                             edit_date?.asDate,
                             forwarded,
@@ -255,12 +256,12 @@ internal data class RawMessage(
                         forwarded,
                         reply_to_message?.asMessage,
                         reply_markup,
+                        via_bot,
                         author_signature
                     )
                     else -> CommonMessageImpl(
                         messageId,
-                        from
+                        from ?: error("Was detected common message, but owner (sender) of the message was not found"),
-                            ?: throw IllegalStateException("Was detected common message, but owner (sender) of the message was not found"),
                         chat,
                         content,
                         date.asDate,
@@ -268,10 +269,11 @@ internal data class RawMessage(
                         forwarded,
                         reply_to_message?.asMessage,
                         reply_markup,
+                        via_bot,
                         paymentInfo
                     )
                 }
-            } ?: throw IllegalStateException("Was not found supported type of data")
+            } ?: error("Was not found supported type of data")
         } catch (e: Exception) {
             UnknownMessageType(
                 messageId,
@@ -283,6 +285,6 @@ internal data class RawMessage(
     }
 
     private fun throwWrongChatEvent(expected: KClass<*>, but: ChatEvent): CommonEvent {
-        throw IllegalStateException("Wrong type of chat event: expected $expected, but was $but")
+        error("Wrong type of chat event: expected $expected, but was $but")
     }
 }

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/message/abstracts/PossiblySentViaBot.kt

@@ -0,0 +1,7 @@
+package com.github.insanusmokrassar.TelegramBotAPI.types.message.abstracts
+
+import com.github.insanusmokrassar.TelegramBotAPI.types.CommonBot
+
+interface PossiblySentViaBot {
+    val senderBot: CommonBot?
+}

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/types/message/content/abstracts/PossiblySentViaBotCommonMessage.kt

@@ -0,0 +1,6 @@
+package com.github.insanusmokrassar.TelegramBotAPI.types.message.content.abstracts
+
+import com.github.insanusmokrassar.TelegramBotAPI.types.message.abstracts.CommonMessage
+import com.github.insanusmokrassar.TelegramBotAPI.types.message.abstracts.PossiblySentViaBot
+
+interface PossiblySentViaBotCommonMessage<T: MessageContent> : CommonMessage<T>, PossiblySentViaBot

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/utils/BuiltinMimeTypes.kt

@@ -0,0 +1,11 @@
+package com.github.insanusmokrassar.TelegramBotAPI.utils
+
+object BuiltinMimeTypes {
+    object Image {
+        val Jpg = buildMimeType("image/jpeg")
+        val Gif = buildMimeType("image/gif")
+    }
+    object Video {
+        val MP4 = buildMimeType("video/mp4")
+    }
+}

TelegramBotAPI/src/commonMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/utils/MimeType.kt

@@ -7,5 +7,7 @@ expect class MimeType {
     val raw: String
 }
 
+expect fun buildMimeType(raw: String): MimeType
+
 @Serializer(MimeType::class)
 internal expect object MimeTypeSerializer : KSerializer<MimeType>

TelegramBotAPI/src/jsMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/utils/MimeType.kt

@@ -23,7 +23,7 @@ internal actual object MimeTypeSerializer : KSerializer<MimeType> {
     override fun deserialize(decoder: Decoder): MimeType {
         val mimeType = decoder.decodeString()
         return mimesCache.getOrPut(mimeType) {
-            MimeType(mimeType)
+            buildMimeType(mimeType)
         }
     }
 
@@ -31,3 +31,5 @@ internal actual object MimeTypeSerializer : KSerializer<MimeType> {
         encoder.encodeString(value.raw)
     }
 }
+
+actual fun buildMimeType(raw: String) = MimeType(raw)

TelegramBotAPI/src/jvmMain/kotlin/com/github/insanusmokrassar/TelegramBotAPI/utils/MimeType.kt

@@ -24,3 +24,5 @@ internal actual object MimeTypeSerializer : KSerializer<MimeType> {
         encoder.encodeString(value.raw)
     }
 }
+
+actual fun buildMimeType(raw: String): MimeType = MimeType(raw)

gradle.properties

@@ -1,6 +1,6 @@
 kotlin.code.style=official
 kotlin_version=1.3.72
-kotlin_coroutines_version=1.3.6
+kotlin_coroutines_version=1.3.7
 kotlin_serialisation_runtime_version=0.20.0
 klock_version=1.11.3
 uuid_version=0.1.0
@@ -9,6 +9,6 @@ ktor_version=1.3.2
 javax_activation_version=1.1.1
 
 library_group=com.github.insanusmokrassar
-library_version=0.27.5
+library_version=0.27.6
 
 gradle_bintray_plugin_version=1.8.4

gradle/wrapper/gradle-wrapper.properties

@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.2.2-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-all.zip