Merge pull request #412 from pengrad/request_extension

Add API method-specific extension functions

Author: pengrad

library/build.gradle

@@ -16,6 +16,7 @@ dependencies {
     testImplementation 'junit:junit:4.13.1'
     testImplementation 'nl.jqno.equalsverifier:equalsverifier:3.1.13'
     testImplementation 'org.reflections:reflections:0.9.12'
+    testImplementation 'org.jetbrains.kotlin:kotlin-reflect'
 }
 
 jar {

library/src/main/java/com/pengrad/telegrambot/RequestPreprocessor.kt

@@ -0,0 +1,17 @@
+package com.pengrad.telegrambot
+
+import com.pengrad.telegrambot.request.BaseRequest
+import com.pengrad.telegrambot.response.BaseResponse
+
+@get:JvmName("getEmptyRequestPreprocessor")
+val EMPTY_REQUEST_PREPROCESSOR: RequestPreprocessor = object : RequestPreprocessor {
+    override fun <REQ : BaseRequest<REQ, RES>, RES : BaseResponse> process(request: BaseRequest<REQ, RES>) {
+        // do nothing
+    }
+}
+
+interface RequestPreprocessor {
+
+    fun <REQ : BaseRequest<REQ, RES>, RES : BaseResponse> process(request: BaseRequest<REQ, RES>)
+
+}

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
+
+}

library/src/main/java/com/pengrad/telegrambot/TelegramBot.java

@@ -12,23 +12,27 @@
 import okhttp3.Interceptor;
 import okhttp3.OkHttpClient;
 import okhttp3.logging.HttpLoggingInterceptor;
+import org.jetbrains.annotations.NotNull;
 
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URL;
 import java.net.URLConnection;
 import java.util.concurrent.TimeUnit;
 
+import static com.pengrad.telegrambot.RequestPreprocessorKt.getEmptyRequestPreprocessor;
+
 /**
  * Stas Parshin
  * 16 October 2015
  */
-public class TelegramBot {
+public class TelegramBot implements TelegramAware {
 
     private final String token;
     private final TelegramBotClient api;
     private final FileApi fileApi;
     private final UpdatesHandler updatesHandler;
+    private final RequestPreprocessor requestPreprocessor;
 
     public TelegramBot(String botToken) {
         this(new Builder(botToken));
@@ -39,13 +43,17 @@ public TelegramBot(String botToken) {
         this.api = builder.api;
         this.fileApi = builder.fileApi;
         this.updatesHandler = builder.updatesHandler;
+        this.requestPreprocessor = builder.requestPreprocessor;
     }
 
-    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) {
+        requestPreprocessor.process(request);
         return api.send(request);
     }
 
     public <T extends BaseRequest<T, R>, R extends BaseResponse> Cancellable execute(T request, Callback<T, R> callback) {
+        requestPreprocessor.process(request);
         return api.send(request, callback);
     }
 
@@ -98,6 +106,7 @@ public static final class Builder {
         private FileApi fileApi;
         private TelegramBotClient api;
         private UpdatesHandler updatesHandler;
+        private RequestPreprocessor requestPreprocessor;
 
         private OkHttpClient okHttpClient;
         private String apiUrl;
@@ -109,6 +118,7 @@ public Builder(String botToken) {
             api = new TelegramBotClient(client(null), gson(), apiUrl(API_URL, botToken, useTestServer));
             fileApi = new FileApi(botToken);
             updatesHandler = new UpdatesHandler(100);
+            requestPreprocessor = getEmptyRequestPreprocessor();
         }
 
         public Builder debug() {
@@ -141,6 +151,11 @@ public Builder useTestServer(boolean useTestServer) {
             return this;
         }
 
+        public Builder requestPreprocessor(RequestPreprocessor requestPreprocessor) {
+            this.requestPreprocessor = requestPreprocessor;
+            return this;
+        }
+
         public TelegramBot build() {
             if (okHttpClient != null || apiUrl != null) {
                 OkHttpClient client = okHttpClient != null ? okHttpClient : client(null);

library/src/main/java/com/pengrad/telegrambot/model/PreparedInlineMessage.kt

@@ -0,0 +1,6 @@
+package com.pengrad.telegrambot.model
+
+data class PreparedInlineMessage(
+    @get:JvmName("id") val id: String,
+    @get:JvmName("expirationDate") val expirationDate: Int
+)

library/src/main/java/com/pengrad/telegrambot/model/SuccessfulPayment.java

@@ -0,0 +1,14 @@
+package com.pengrad.telegrambot.model
+
+data class SuccessfulPayment(
+    @get:JvmName("currency") val currency: String,
+    @get:JvmName("totalAmount") val totalAmount: Int,
+    @get:JvmName("invoicePayload") val invoicePayload: String,
+    @get:JvmName("subscriptionExpirationDate") val subscriptionExpirationDate: Int? = null,
+    @get:JvmName("isRecurring") val isRecurring: Boolean? = null,
+    @get:JvmName("isFirstRecurring") val isFirstRecurring: Boolean? = null,
+    @get:JvmName("shippingOptionId") val shippingOptionId: String? = null,
+    @get:JvmName("orderInfo") val orderInfo: OrderInfo? = null,
+    @get:JvmName("telegramPaymentChargeId") val telegramPaymentChargeId: String,
+    @get:JvmName("providerPaymentChargeId") val providerPaymentChargeId: String
+)

library/src/main/java/com/pengrad/telegrambot/model/SuccessfulPayment.kt

@@ -0,0 +1,11 @@
+package com.pengrad.telegrambot.model.gift
+
+import com.pengrad.telegrambot.model.Sticker
+
+data class Gift(
+    @get:JvmName("id") val id: String,
+    @get:JvmName("sticker") val sticker: Sticker,
+    @get:JvmName("starCount") val starCount: Int,
+    @get:JvmName("totalCount") val totalCount: Int,
+    @get:JvmName("remainingCount") val remainingCount: Int
+)

library/src/main/java/com/pengrad/telegrambot/model/gift/Gift.kt

@@ -0,0 +1,18 @@
+package com.pengrad.telegrambot.model.gift
+
+data class Gifts(
+    @get:JvmName("gifts") val gifts: Array<Gift>
+) {
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (other !is Gifts) return false
+
+        if (!gifts.contentEquals(other.gifts)) return false
+
+        return true
+    }
+
+    override fun hashCode(): Int {
+        return gifts.contentHashCode()
+    }
+}