Add kTelegram for Kotlin Support (#53)

mkotb · web-flow · commit d714010de511 · 2020-08-28T00:59:42.000-07:00
* Add kTelegram as a Kotlin extension

* Add appropriate dependency scopes

* Add typealias for ease of use
diff --git a/jtelegrambotapi-core/src/main/java/com/jtelegram/api/TelegramBot.java b/jtelegrambotapi-core/src/main/java/com/jtelegram/api/TelegramBot.java
@@ -27,7 +27,7 @@ public class TelegramBot {
     @Setter
     private User botInfo;
 
-    TelegramBot(TelegramBotRegistry registry, String apiKey) {
+    protected TelegramBot(TelegramBotRegistry registry, String apiKey) {
         this.registry = registry;
         this.apiKey = apiKey;
         this.eventRegistry = new EventRegistry(this);
diff --git a/jtelegrambotapi-core/src/main/java/com/jtelegram/api/commands/CommandRegistry.java b/jtelegrambotapi-core/src/main/java/com/jtelegram/api/commands/CommandRegistry.java
@@ -9,11 +9,13 @@
 import com.jtelegram.api.message.entity.MessageEntity;
 import com.jtelegram.api.message.entity.MessageEntityType;
 import com.jtelegram.api.message.impl.TextMessage;
+import lombok.Getter;
 
 import java.util.*;
 import java.util.stream.Collectors;
 
 public class CommandRegistry implements EventHandler<TextMessageEvent> {
+    @Getter
     private final TelegramBot bot;
     private final List<CommandFilter> listeners = new ArrayList<>();
 
@@ -61,9 +63,7 @@ public void onEvent(TextMessageEvent event) {
         );
 
         Command command = new Command(baseCommand, mentioned, argsList, message);
-        long handled = listeners.stream()
-                .filter(e -> e.test(event, command))
-                .count();
+        listeners.forEach(e -> e.test(event, command));
         // Log number of handlers that used the command?
     }
 }
diff --git a/jtelegrambotapi-core/src/main/java/com/jtelegram/api/events/EventHandler.java b/jtelegrambotapi-core/src/main/java/com/jtelegram/api/events/EventHandler.java
@@ -1,6 +1,5 @@
 package com.jtelegram.api.events;
 
 public interface EventHandler<E extends Event> {
-
     void onEvent(E event);
 }
diff --git a/jtelegrambotapi-core/src/main/java/com/jtelegram/api/events/EventRegistry.java b/jtelegrambotapi-core/src/main/java/com/jtelegram/api/events/EventRegistry.java
@@ -4,6 +4,7 @@
 import com.jtelegram.api.events.inline.ChosenInlineResultEvent;
 import com.jtelegram.api.requests.inline.AnswerInlineQuery;
 import com.jtelegram.api.util.ExceptionThreadFactory;
+import lombok.Getter;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -20,7 +21,9 @@
  */
 public class EventRegistry {
     private final ThreadFactory factory = new ExceptionThreadFactory();
+    @Getter
     private final TelegramBot bot;
+    @Getter
     private final ExecutorService threadPool;
 
     private Map<Class<? extends Event>, List<EventHandler<? extends Event>>> handlers = new ConcurrentHashMap<>();
diff --git a/jtelegrambotapi-core/src/main/java/com/jtelegram/api/requests/framework/AbstractTelegramRequest.java b/jtelegrambotapi-core/src/main/java/com/jtelegram/api/requests/framework/AbstractTelegramRequest.java
@@ -9,6 +9,7 @@
 import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
+import lombok.Setter;
 import okhttp3.Response;
 
 import java.io.IOException;
@@ -20,7 +21,8 @@ public abstract class AbstractTelegramRequest implements TelegramRequest {
     // utility field
     protected transient static Gson gson = TelegramBotRegistry.GSON;
     private transient final String endPoint;
-    protected transient final Consumer<TelegramException> errorHandler;
+    @Setter
+    protected transient Consumer<TelegramException> errorHandler;
 
     protected void handleError(TelegramException ex) {
         if (errorHandler == null) {
diff --git a/jtelegrambotapi-core/src/main/java/com/jtelegram/api/requests/framework/QueryTelegramRequest.java b/jtelegrambotapi-core/src/main/java/com/jtelegram/api/requests/framework/QueryTelegramRequest.java
@@ -3,6 +3,7 @@
 import com.google.gson.JsonElement;
 import com.jtelegram.api.ex.TelegramException;
 import lombok.EqualsAndHashCode;
+import lombok.Setter;
 import okhttp3.Response;
 
 import java.io.IOException;
@@ -14,7 +15,8 @@
  */
 @EqualsAndHashCode(callSuper = true)
 public abstract class QueryTelegramRequest<T> extends AbstractTelegramRequest {
-    private transient final Consumer<T> callback;
+    @Setter
+    private Consumer<T> callback;
     private transient final Class<T> callbackType;
 
     protected QueryTelegramRequest(String endPoint, Class<T> callbackType, Consumer<T> callback, Consumer<TelegramException> errorHandler) {
diff --git a/jtelegrambotapi-core/src/main/java/com/jtelegram/api/requests/framework/UpdateTelegramRequest.java b/jtelegrambotapi-core/src/main/java/com/jtelegram/api/requests/framework/UpdateTelegramRequest.java
@@ -1,6 +1,7 @@
 package com.jtelegram.api.requests.framework;
 
 import com.jtelegram.api.ex.TelegramException;
+import lombok.Setter;
 import okhttp3.Response;
 
 import java.io.IOException;
@@ -14,6 +15,7 @@
  *
  */
 public abstract class UpdateTelegramRequest extends AbstractTelegramRequest {
+    @Setter
     protected transient Runnable callback;
 
     protected UpdateTelegramRequest(String endPoint, Consumer<TelegramException> errorHandler, Runnable callback) {
diff --git a/jtelegrambotapi-core/src/main/java/com/jtelegram/api/requests/message/framework/req/SendableChatRequest.java b/jtelegrambotapi-core/src/main/java/com/jtelegram/api/requests/message/framework/req/SendableChatRequest.java
@@ -5,13 +5,15 @@
 import com.jtelegram.api.requests.framework.QueryTelegramRequest;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
+import lombok.Setter;
 
 import java.util.function.Consumer;
 
 @Getter
 @EqualsAndHashCode(callSuper = true)
 public class SendableChatRequest<T> extends QueryTelegramRequest<T> {
-    private final ChatId chatId;
+    @Setter
+    private ChatId chatId;
 
     protected SendableChatRequest(String endPoint, Class<T> callbackType, Consumer<T> callback, Consumer<TelegramException> errorHandler, ChatId chatId) {
         super(endPoint, callbackType, callback, errorHandler);
diff --git a/jtelegrambotapi-core/src/main/java/com/jtelegram/api/requests/message/framework/req/SendableMessageRequest.java b/jtelegrambotapi-core/src/main/java/com/jtelegram/api/requests/message/framework/req/SendableMessageRequest.java
@@ -4,12 +4,14 @@
 import com.jtelegram.api.ex.TelegramException;
 import com.jtelegram.api.requests.message.framework.ReplyMarkup;
 import lombok.Getter;
+import lombok.Setter;
 
 import java.util.function.Consumer;
 
 @Getter
 public abstract class SendableMessageRequest<T> extends SendableChatRequest<T> {
-    private final Integer replyToMessageId;
+    @Setter
+    private Integer replyToMessageId;
     private final Boolean disableNotification;
     private final ReplyMarkup replyMarkup;
 
@@ -20,7 +22,6 @@ protected SendableMessageRequest(String endPoint, Class<T> callbackType, Consume
         this.replyMarkup = replyMarkup;
     }
 
-
     @Override
     protected boolean isValid() {
         return super.isValid();
diff --git a/jtelegrambotapi-core/src/main/java/com/jtelegram/api/util/TextBuilder.java b/jtelegrambotapi-core/src/main/java/com/jtelegram/api/util/TextBuilder.java
@@ -28,7 +28,7 @@ public static TextBuilder create() {
         return new TextBuilder();
     }
 
-    private TextBuilder() {
+    protected TextBuilder() {
     }
 
     private String htmlEscaped(String text) {
@@ -85,6 +85,14 @@ public TextBuilder newLine() {
         return this;
     }
 
+    public TextBuilder newLines(int n) {
+        for (int i = 0; i < n; i++) {
+            newLine();
+        }
+
+        return this;
+    }
+
     public TextBuilder nextLine() {
         return newLine();
     }
diff --git a/ktelegrambotapi/pom.xml b/ktelegrambotapi/pom.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xmlns="http://maven.apache.org/POM/4.0.0"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.jtelegram</groupId>
+        <artifactId>jtelegrambotapi</artifactId>
+        <version>4.0.10</version>
+    </parent>
+
+    <properties>
+        <kotlin.version>1.3.72</kotlin.version>
+    </properties>
+
+    <artifactId>ktelegrambotapi</artifactId>
+    <name>jTelegramBotAPI as Kotlin (AKA kTelegramBotAPI)</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.jtelegram</groupId>
+            <artifactId>jtelegrambotapi-core</artifactId>
+            <version>${project.version}</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.jetbrains.kotlin</groupId>
+            <artifactId>kotlin-stdlib</artifactId>
+            <version>${kotlin.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.jetbrains.kotlinx</groupId>
+            <artifactId>kotlinx-coroutines-core</artifactId>
+            <version>1.3.7</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <sourceDirectory>${project.basedir}/src/main/kotlin</sourceDirectory>
+        <testSourceDirectory>${project.basedir}/src/test/kotlin</testSourceDirectory>
+
+        <plugins>
+            <plugin>
+                <groupId>org.jetbrains.kotlin</groupId>
+                <artifactId>kotlin-maven-plugin</artifactId>
+                <version>${kotlin.version}</version>
+                <executions>
+                    <execution>
+                        <id>compile</id>
+                        <phase>compile</phase>
+                        <goals>
+                            <goal>compile</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <jvmTarget>1.8</jvmTarget>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+
+</project>
diff --git a/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/BotContext.kt b/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/BotContext.kt
@@ -0,0 +1,57 @@
+package com.jtelegram.api.kotlin
+
+import com.jtelegram.api.chat.Chat
+import com.jtelegram.api.chat.id.ChatId
+import com.jtelegram.api.message.Message
+import com.jtelegram.api.message.impl.TextMessage
+import com.jtelegram.api.requests.message.framework.ParseMode
+import com.jtelegram.api.requests.message.framework.req.SendableChatRequest
+import com.jtelegram.api.requests.message.framework.req.SendableMessageRequest
+import com.jtelegram.api.requests.message.send.SendText
+import com.jtelegram.api.user.User
+
+class BotContext(val bot: KTelegramBot) {
+    private suspend fun <T> sendText(chatId: ChatId<T>, text: String, parseMode: ParseMode): TextMessage {
+        return bot.execute (
+                SendText.builder()
+                        .chatId(chatId)
+                        .text(text)
+                        .parseMode(parseMode)
+                        .build()
+        )
+    }
+
+    suspend fun Chat.sendText(text: String, parseMode: ParseMode = ParseMode.MARKDOWN): TextMessage {
+        return sendText(chatId, text, parseMode)
+    }
+
+    suspend fun <ST, S: Message<ST>> Chat.sendMessage(request: SendableMessageRequest<S>): S {
+        return sendAction(request)
+    }
+
+    suspend fun <S> Chat.sendAction(request: SendableChatRequest<S>): S {
+        val chatIdO = chatId
+
+        return bot.execute (
+                request.apply {
+                    chatId = chatIdO
+                }
+        )
+    }
+
+    suspend fun User.sendText(text: String, parseMode: ParseMode = ParseMode.MARKDOWN): TextMessage {
+        return sendText(ChatId.of(id), text, parseMode)
+    }
+
+    suspend fun <ST, S: Message<ST>> User.sendMessage(request: SendableMessageRequest<S>): S {
+        return sendAction(request)
+    }
+
+    suspend fun <S> User.sendAction(request: SendableChatRequest<S>): S {
+        return bot.execute (
+                 request.apply {
+                     chatId = ChatId.of(id)
+                 }
+        )
+    }
+}
diff --git a/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/KTelegramBot.kt b/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/KTelegramBot.kt
@@ -0,0 +1,10 @@
+package com.jtelegram.api.kotlin
+
+import com.jtelegram.api.TelegramBot
+import com.jtelegram.api.TelegramBotRegistry
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.asCoroutineDispatcher
+
+class KTelegramBot constructor(registry: TelegramBotRegistry?, apiKey: String?) : TelegramBot(registry, apiKey) {
+    val coroutineScope = CoroutineScope(eventRegistry.threadPool.asCoroutineDispatcher())
+}
diff --git a/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/TelegramBot.kt b/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/TelegramBot.kt
@@ -0,0 +1,36 @@
+package com.jtelegram.api.kotlin
+
+import com.jtelegram.api.TelegramBot
+import com.jtelegram.api.requests.framework.AbstractTelegramRequest
+import com.jtelegram.api.requests.framework.QueryTelegramRequest
+import com.jtelegram.api.requests.framework.UpdateTelegramRequest
+import kotlin.coroutines.Continuation
+import kotlin.coroutines.resume
+import kotlin.coroutines.resumeWithException
+import kotlin.coroutines.suspendCoroutine
+
+suspend fun <T> TelegramBot.execute(request: QueryTelegramRequest<T>): T = suspendCoroutine { cont ->
+    request.useContinuationForErrors(cont)
+
+    request.setCallback {
+        cont.resume(it)
+    }
+
+    perform(request)
+}
+
+suspend fun TelegramBot.execute(request: UpdateTelegramRequest) = suspendCoroutine<Unit?> { cont ->
+    request.useContinuationForErrors(cont)
+
+    request.setCallback {
+        cont.resume(null)
+    }
+
+    perform(request)
+}
+
+private fun <T> AbstractTelegramRequest.useContinuationForErrors(cont: Continuation<T>) {
+    setErrorHandler {
+        cont.resumeWithException(it)
+    }
+}
diff --git a/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/TelegramBotRegistry.kt b/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/TelegramBotRegistry.kt
@@ -0,0 +1,15 @@
+package com.jtelegram.api.kotlin
+
+import com.jtelegram.api.TelegramBotRegistry
+import com.jtelegram.api.requests.GetMe
+
+suspend fun TelegramBotRegistry.registerBot(key: String): KTelegramBot {
+    val bot = KTelegramBot(this, key)
+
+    bot.botInfo = bot.execute(GetMe.builder().build())
+
+    bots.add(bot)
+    updateProvider.listenFor(bot)
+
+    return bot
+}
diff --git a/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/commands/CommandRegistry.kt b/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/commands/CommandRegistry.kt
@@ -0,0 +1,22 @@
+package com.jtelegram.api.kotlin.commands
+
+import com.jtelegram.api.commands.Command
+import com.jtelegram.api.commands.filters.CommandFilter
+import com.jtelegram.api.events.message.TextMessageEvent
+import com.jtelegram.api.kotlin.BotContext
+import com.jtelegram.api.kotlin.KTelegramBot
+import kotlinx.coroutines.launch
+
+fun suspendCommand(filter: suspend BotContext.(TextMessageEvent, Command) -> Unit) = CommandFilter { event, command ->
+    val bot = event.bot
+
+    if (bot !is KTelegramBot) {
+        throw IllegalStateException("Suspending command filters can only be used with KTelegramBots!")
+    }
+
+    bot.coroutineScope.launch {
+        filter.invoke(BotContext(bot), event, command)
+    }
+
+    true
+}
diff --git a/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/events/EventRegistry.kt b/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/events/EventRegistry.kt
diff --git a/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/events/inline/InlineQueryEvent.kt b/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/events/inline/InlineQueryEvent.kt
diff --git a/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/events/message/MessageEvent.kt b/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/events/message/MessageEvent.kt
diff --git a/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/util/TextBuilder.kt b/ktelegrambotapi/src/main/kotlin/com/jtelegram/api/kotlin/util/TextBuilder.kt
diff --git a/pom.xml b/pom.xml

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`package com.jtelegram.api.events;`
`2`	`2`
`3`	`3`	`public interface EventHandler<E extends Event> {`
`4`		`-`
`5`	`4`	`void onEvent(E event);`
`6`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public static TextBuilder create() {`
`28`	`28`	`return new TextBuilder();`
`29`	`29`	`}`
`30`	`30`
`31`		`- private TextBuilder() {`
	`31`	`+ protected TextBuilder() {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`private String htmlEscaped(String text) {`
`@@ -85,6 +85,14 @@ public TextBuilder newLine() {`
`85`	`85`	`return this;`
`86`	`86`	`}`
`87`	`87`
	`88`	`+ public TextBuilder newLines(int n) {`
	`89`	`+ for (int i = 0; i < n; i++) {`
	`90`	`+ newLine();`
	`91`	`+ }`
	`92`	`+`
	`93`	`+ return this;`
	`94`	`+ }`
	`95`	`+`
`88`	`96`	`public TextBuilder nextLine() {`
`89`	`97`	`return newLine();`
`90`	`98`	`}`