Add TelegramAware interface, add request-specific extensions

anfanik · anfanik · commit e434e8c6a15a · 2025-01-24T15:47:51.000+03:00
diff --git a/library/src/main/java/com/pengrad/telegrambot/TelegramAware.kt b/library/src/main/java/com/pengrad/telegrambot/TelegramAware.kt
@@ -0,0 +1,10 @@
+package com.pengrad.telegrambot
+
+import com.pengrad.telegrambot.request.BaseRequest
+import com.pengrad.telegrambot.response.BaseResponse
+
+interface TelegramAware {
+
+    fun <REQ : BaseRequest<REQ, RES>, RES : BaseResponse> execute(request: BaseRequest<REQ, RES>): RES
+
+}
diff --git a/library/src/main/java/com/pengrad/telegrambot/TelegramBot.java b/library/src/main/java/com/pengrad/telegrambot/TelegramBot.java
@@ -12,6 +12,7 @@
 import okhttp3.Interceptor;
 import okhttp3.OkHttpClient;
 import okhttp3.logging.HttpLoggingInterceptor;
+import org.jetbrains.annotations.NotNull;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -23,7 +24,7 @@
  * Stas Parshin
  * 16 October 2015
  */
-public class TelegramBot {
+public class TelegramBot implements TelegramAware {
 
     private final String token;
     private final TelegramBotClient api;
@@ -41,7 +42,8 @@ public TelegramBot(String botToken) {
         this.updatesHandler = builder.updatesHandler;
     }
 
-    public <T extends BaseRequest<T, R>, R extends BaseResponse> R execute(BaseRequest<T, R> request) {
+    @NotNull
+    public <T extends BaseRequest<T, R>, R extends BaseResponse> R execute(@NotNull BaseRequest<T, R> request) {
         return api.send(request);
     }
 
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/TelegramAwareExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/TelegramAwareExtension.kt
@@ -0,0 +1,10 @@
+package com.pengrad.telegrambot.utility.kotlin.extension
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.BaseRequest
+import com.pengrad.telegrambot.response.BaseResponse
+
+inline fun <T : BaseRequest<T, R>, R : BaseResponse> TelegramAware.execute(
+    request: T,
+    modifier: T.() -> Unit = {}
+): R = execute(request.apply(modifier))
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/AnswerCallbackQueryExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/AnswerCallbackQueryExtension.kt
@@ -0,0 +1,10 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.AnswerCallbackQuery
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.answerCallbackQuery(
+    callbackQueryId: String,
+    modifier: AnswerCallbackQuery.() -> Unit = {}
+) = this.execute(AnswerCallbackQuery(callbackQueryId), modifier)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/AnswerPreCheckoutQueryExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/AnswerPreCheckoutQueryExtension.kt
@@ -0,0 +1,16 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.AnswerPreCheckoutQuery
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.answerPreCheckoutQuery(
+    preCheckoutId: String,
+    modifier: AnswerPreCheckoutQuery.() -> Unit = {}
+) = this.execute(AnswerPreCheckoutQuery(preCheckoutId), modifier)
+
+inline fun TelegramAware.answerPreCheckoutQuery(
+    preCheckoutId: String,
+    errorMessage: String,
+    modifier: AnswerPreCheckoutQuery.() -> Unit = {}
+) = this.execute(AnswerPreCheckoutQuery(preCheckoutId, errorMessage), modifier)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/DeleteMessageExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/DeleteMessageExtension.kt
@@ -0,0 +1,17 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.DeleteMessage
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.deleteMessage(
+    chatId: Long,
+    messageId: Int,
+    modifier: DeleteMessage.() -> Unit = {}
+) = this.execute(DeleteMessage(chatId, messageId), modifier)
+
+inline fun TelegramAware.deleteMessage(
+    chatId: String,
+    messageId: Int,
+    modifier: DeleteMessage.() -> Unit = {}
+) = this.execute(DeleteMessage(chatId, messageId), modifier)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/EditMessageCaptionExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/EditMessageCaptionExtension.kt
@@ -0,0 +1,25 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.EditMessageCaption
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.editMessageCaption(
+    chatId: Long,
+    messageId: Int,
+    caption: String,
+    modifier: EditMessageCaption.() -> Unit = {}
+) = this.execute(EditMessageCaption(chatId, messageId)) {
+    caption(caption)
+    modifier()
+}
+
+inline fun TelegramAware.editMessageCaption(
+    chatId: String,
+    messageId: Int,
+    caption: String,
+    modifier: EditMessageCaption.() -> Unit = {}
+) = this.execute(EditMessageCaption(chatId, messageId)) {
+    caption(caption)
+    modifier()
+}
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/EditMessageMediaExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/EditMessageMediaExtension.kt
@@ -0,0 +1,20 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.model.request.InputMedia
+import com.pengrad.telegrambot.request.EditMessageMedia
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.editMessageMedia(
+    chatId: Long,
+    messageId: Int,
+    media: InputMedia<*>,
+    modifier: EditMessageMedia.() -> Unit = {}
+) = this.execute(EditMessageMedia(chatId, messageId, media), modifier)
+
+inline fun TelegramAware.editMessageMedia(
+    chatId: String,
+    messageId: Int,
+    media: InputMedia<*>,
+    modifier: EditMessageMedia.() -> Unit = {}
+) = this.execute(EditMessageMedia(chatId, messageId, media), modifier)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/EditMessageReplyMarkupExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/EditMessageReplyMarkupExtension.kt
@@ -0,0 +1,36 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.model.request.InlineKeyboardMarkup
+import com.pengrad.telegrambot.request.EditMessageReplyMarkup
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.editMessageReplyMarkup(
+    chatId: Long,
+    messageId: Int,
+    modifier: EditMessageReplyMarkup.() -> Unit = {}
+) = this.execute(EditMessageReplyMarkup(chatId, messageId), modifier)
+
+inline fun TelegramAware.editMessageReplyMarkup(
+    chatId: String,
+    messageId: Int,
+    modifier: EditMessageReplyMarkup.() -> Unit = {}
+) = this.execute(EditMessageReplyMarkup(chatId, messageId), modifier)
+
+inline fun TelegramAware.removeInlineKeyboard(
+    chatId: Long,
+    messageId: Int,
+    modifier: EditMessageReplyMarkup.() -> Unit = {}
+) = this.editMessageReplyMarkup(chatId, messageId) {
+    replyMarkup(InlineKeyboardMarkup())
+    modifier()
+}
+
+inline fun TelegramAware.removeInlineKeyboard(
+    chatId: String,
+    messageId: Int,
+    modifier: EditMessageReplyMarkup.() -> Unit = {}
+) = this.editMessageReplyMarkup(chatId, messageId) {
+    replyMarkup(InlineKeyboardMarkup())
+    modifier()
+}
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/EditMessageTextExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/EditMessageTextExtension.kt
@@ -0,0 +1,19 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.EditMessageText
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+fun TelegramAware.editMessageText(
+    chatId: Long,
+    messageId: Int,
+    text: String,
+    modifier: EditMessageText.() -> Unit = {}
+) = this.execute(EditMessageText(chatId, messageId, text), modifier)
+
+fun TelegramAware.editMessageText(
+    chatId: String,
+    messageId: Int,
+    text: String,
+    modifier: EditMessageText.() -> Unit = {}
+) = this.execute(EditMessageText(chatId, messageId, text), modifier)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/ForwardMessageExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/ForwardMessageExtension.kt
@@ -0,0 +1,19 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.ForwardMessage
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.forwardMessage(
+    chatId: Long,
+    fromChatId: Long,
+    messageId: Int,
+    modifier: ForwardMessage.() -> Unit = {}
+) = this.execute(ForwardMessage(chatId, fromChatId, messageId), modifier)
+
+inline fun TelegramAware.forwardMessage(
+    chatId: String,
+    fromChatId: Long,
+    messageId: Int,
+    modifier: ForwardMessage.() -> Unit = {}
+) = this.execute(ForwardMessage(chatId, fromChatId, messageId), modifier)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/GetChatExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/GetChatExtension.kt
@@ -0,0 +1,15 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.GetChat
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.getChat(
+    chatId: Long,
+    modifier: GetChat.() -> Unit = {}
+) = this.execute(GetChat(chatId), modifier)
+
+inline fun TelegramAware.getChat(
+    chatId: String,
+    modifier: GetChat.() -> Unit = {}
+) = this.execute(GetChat(chatId), modifier)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/GetFileExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/GetFileExtension.kt
@@ -0,0 +1,10 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.GetFile
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+fun TelegramAware.getFile(
+    fileId: String,
+    modifier: GetFile.() -> Unit = {}
+) = this.execute(GetFile(fileId), modifier)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/GetMeExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/GetMeExtension.kt
@@ -0,0 +1,9 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.GetMe
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.getMe(
+    modifier: GetMe.() -> Unit = {}
+) = this.execute(GetMe(), modifier)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/SendInvoiceExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/SendInvoiceExtension.kt
@@ -0,0 +1,34 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.model.request.LabeledPrice
+import com.pengrad.telegrambot.request.SendInvoice
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+fun TelegramAware.sendInvoice(
+    chatId: Long,
+    title: String,
+    description: String,
+    payload: String,
+    currency: String,
+    items: List<LabeledPrice>,
+    modifier: SendInvoice.() -> Unit = {}
+) = this.execute(SendInvoice(chatId, title, description, payload, currency, *items.toTypedArray()), modifier)
+
+fun TelegramAware.sendInvoice(
+    chatId: Long,
+    title: String,
+    description: String,
+    payload: String,
+    currency: String,
+    item: LabeledPrice,
+    modifier: SendInvoice.() -> Unit = {}
+) = this.sendInvoice(
+    chatId = chatId,
+    title = title,
+    description = description,
+    payload = payload,
+    currency = currency,
+    items = listOf(item),
+    modifier = modifier
+)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/SendMediaGroupExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/SendMediaGroupExtension.kt
@@ -0,0 +1,18 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.model.request.InputMedia
+import com.pengrad.telegrambot.request.SendMediaGroup
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.sendMediaGroup(
+    chatId: Long,
+    media: List<InputMedia<*>>,
+    modifier: SendMediaGroup.() -> Unit = {}
+) = this.execute(SendMediaGroup(chatId, *media.toTypedArray()), modifier)
+
+inline fun TelegramAware.sendMediaGroup(
+    chatId: String,
+    media: List<InputMedia<*>>,
+    modifier: SendMediaGroup.() -> Unit = {}
+) = this.execute(SendMediaGroup(chatId, *media.toTypedArray()), modifier)
diff --git a/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/SendMessageExtension.kt b/library/src/main/java/com/pengrad/telegrambot/utility/kotlin/extension/request/SendMessageExtension.kt
@@ -0,0 +1,17 @@
+package com.pengrad.telegrambot.utility.kotlin.extension.request
+
+import com.pengrad.telegrambot.TelegramAware
+import com.pengrad.telegrambot.request.SendMessage
+import com.pengrad.telegrambot.utility.kotlin.extension.execute
+
+inline fun TelegramAware.sendMessage(
+    chatId: Long,
+    text: String,
+    modifier: SendMessage.() -> Unit = {}
+) = this.execute(SendMessage(chatId, text), modifier)
+
+inline fun TelegramAware.sendMessage(
+    chatId: String,
+    text: String,
+    modifier: SendMessage.() -> Unit = {}
+) = this.execute(SendMessage(chatId, text), modifier)
