Refactoring: Enhancing code maintainability by reducing code smells.

pom.xml

@@ -81,6 +81,11 @@
 
     <dependencyManagement>
         <dependencies>
+            <dependency>
+                <groupId>org.telegram</groupId>
+                <artifactId>telegrambots</artifactId>
+                <version>6.9.7.1</version>
+            </dependency>
             <dependency>
                 <groupId>org.projectlombok</groupId>
                 <artifactId>lombok</artifactId>
@@ -135,6 +140,11 @@
                 <artifactId>slf4j-api</artifactId>
                 <version>${slf4j.version}</version>
             </dependency>
+            <dependency>
+                <groupId>ch.qos.logback</groupId>
+                <artifactId>logback-classic</artifactId>
+                <version>1.2.6</version>
+            </dependency>
             <dependency>
                 <groupId>org.apache.commons</groupId>
                 <artifactId>commons-lang3</artifactId>
@@ -218,6 +228,25 @@
                     <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                        <artifactId>jacoco-maven-plugin</artifactId>
+                        <version>0.8.5</version>
+                        <executions>
+                            <execution>
+                                <goals>
+                                    <goal>prepare-agent</goal>
+                                </goals>
+                            </execution>
+                            <execution>
+                                <id>report</id>
+                                <phase>test</phase>
+                                <goals>
+                                    <goal>report</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
             <plugin>
                 <groupId>org.sonatype.plugins</groupId>
                 <artifactId>nexus-staging-maven-plugin</artifactId>

telegrambots-abilities/pom.xml

@@ -80,6 +80,11 @@
     </properties>
 
     <dependencies>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>1.2.3</version>
+        </dependency>
         <dependency>
             <groupId>org.telegram</groupId>
             <artifactId>telegrambots</artifactId>

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/objects/Ability.java

@@ -50,10 +50,13 @@ public final class Ability {
   private final List<Reply> replies;
   private final List<Predicate<Update>> flags;
 
+
   @SafeVarargs
   private Ability(String name, String info, Locality locality, Privacy privacy, int argNum, boolean statsEnabled, Consumer<MessageContext> action, Consumer<MessageContext> postAction, List<Reply> replies, Predicate<Update>... flags) {
-    checkArgument(isValidCommandName(name), "Method name can only contain alpha-numeric characters and underscores," +
-            " cannot be longer than 31 characters, empty or null", name);
+    String ERROR_MESSAGE_PREFIX = "Method name can only contain alpha-numeric characters and underscores," ;
+    String ERROR_MESSAGE_SUFFIX = " cannot be longer than 31 characters, empty or null";
+    checkArgument(isValidCommandName(name), "%s%s", ERROR_MESSAGE_PREFIX, ERROR_MESSAGE_SUFFIX, name);
+
     this.name = name;
     this.info = info;
 

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/objects/MessageContext.java

@@ -106,11 +106,11 @@ private void checkLength() {
   @Override
   public String toString() {
     return MoreObjects.toStringHelper(this)
-        .add("user", user)
-        .add("chatId", chatId)
-        .add("arguments", arguments)
-        .add("update", update)
-        .toString();
+            .add("user", user)
+            .add("chatId", chatId)
+            .add("arguments", arguments)
+            .add("update", update)
+            .toString();
   }
 
   @Override
@@ -122,13 +122,13 @@ public boolean equals(Object o) {
 
     MessageContext that = (MessageContext) o;
     return Objects.equal(user, that.user) &&
-        Objects.equal(chatId, that.chatId) &&
-        Arrays.equals(arguments, that.arguments) &&
-        Objects.equal(update, that.update);
+            Objects.equal(chatId, that.chatId) &&
+            Arrays.equals(arguments, that.arguments) &&
+            Objects.equal(update, that.update);
   }
 
   @Override
   public int hashCode() {
     return Objects.hashCode(user, chatId, Arrays.hashCode(arguments), update);
   }
-}
+}

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/sender/DefaultSender.java

@@ -3,9 +3,6 @@
 import org.telegram.telegrambots.meta.api.methods.BotApiMethod;
 import org.telegram.telegrambots.meta.api.methods.groupadministration.SetChatPhoto;
 import org.telegram.telegrambots.meta.api.methods.send.*;
-import org.telegram.telegrambots.meta.api.methods.stickers.AddStickerToSet;
-import org.telegram.telegrambots.meta.api.methods.stickers.CreateNewStickerSet;
-import org.telegram.telegrambots.meta.api.methods.stickers.UploadStickerFile;
 import org.telegram.telegrambots.meta.api.objects.File;
 import org.telegram.telegrambots.meta.api.objects.Message;
 import org.telegram.telegrambots.meta.api.objects.User;
@@ -41,21 +38,6 @@ public <T extends Serializable, Method extends BotApiMethod<T>> T execute(Method
     return bot.execute(method);
   }
 
-  @Override
-  public Boolean addStickerToSet(AddStickerToSet addStickerToSet) throws TelegramApiException {
-    return bot.execute(addStickerToSet);
-  }
-
-  @Override
-  public Boolean createNewStickerSet(CreateNewStickerSet createNewStickerSet) throws TelegramApiException {
-    return bot.execute(createNewStickerSet);
-  }
-
-  @Override
-  public File uploadStickerFile(UploadStickerFile uploadStickerFile) throws TelegramApiException {
-    return bot.execute(uploadStickerFile);
-  }
-
   @Override
   public Boolean setChatPhoto(SetChatPhoto setChatPhoto) throws TelegramApiException {
     return bot.execute(setChatPhoto);
@@ -136,4 +118,4 @@ public Message sendVoice(SendVoice sendVoice) throws TelegramApiException {
   public Message sendVideoNote(SendVideoNote sendVideoNote) {
     return null;
   }
-}
+}

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/sender/DefaultSticker.java

@@ -0,0 +1,41 @@
+package org.telegram.abilitybots.api.sender;
+import org.telegram.telegrambots.meta.api.methods.BotApiMethod;
+import org.telegram.telegrambots.meta.api.methods.stickers.AddStickerToSet;
+import org.telegram.telegrambots.meta.api.methods.stickers.CreateNewStickerSet;
+import org.telegram.telegrambots.meta.api.methods.stickers.UploadStickerFile;
+import org.telegram.telegrambots.meta.api.objects.File;
+import org.telegram.telegrambots.bots.DefaultAbsSender;
+import org.telegram.telegrambots.meta.exceptions.TelegramApiException;
+import org.telegram.telegrambots.meta.updateshandlers.SentCallback;
+
+import java.io.Serializable;
+public class DefaultSticker implements StickerMessage {
+    private static final String TAG = MessageSender.class.getName();
+
+    private DefaultAbsSender bot;
+
+    @Override
+    public <T extends Serializable, Method extends BotApiMethod<T>, Callback extends SentCallback<T>> void executeAsync(Method method, Callback callback) throws TelegramApiException {
+
+    }
+
+    @Override
+    public <T extends Serializable, Method extends BotApiMethod<T>> T execute(Method method) throws TelegramApiException {
+        return null;
+    }
+
+    @Override
+    public Boolean addStickerToSet(AddStickerToSet addStickerToSet) throws TelegramApiException {
+        return bot.execute(addStickerToSet);
+    }
+
+    @Override
+    public Boolean createNewStickerSet(CreateNewStickerSet createNewStickerSet) throws TelegramApiException {
+        return bot.execute(createNewStickerSet);
+    }
+
+    @Override
+    public File uploadStickerFile(UploadStickerFile uploadStickerFile) throws TelegramApiException {
+        return bot.execute(uploadStickerFile);
+    }
+}

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/sender/MessageSender.java

@@ -3,9 +3,6 @@
 import org.telegram.telegrambots.meta.api.methods.BotApiMethod;
 import org.telegram.telegrambots.meta.api.methods.groupadministration.SetChatPhoto;
 import org.telegram.telegrambots.meta.api.methods.send.*;
-import org.telegram.telegrambots.meta.api.methods.stickers.AddStickerToSet;
-import org.telegram.telegrambots.meta.api.methods.stickers.CreateNewStickerSet;
-import org.telegram.telegrambots.meta.api.methods.stickers.UploadStickerFile;
 import org.telegram.telegrambots.meta.api.objects.File;
 import org.telegram.telegrambots.meta.api.objects.Message;
 import org.telegram.telegrambots.meta.api.objects.User;
@@ -28,12 +25,6 @@ public interface MessageSender {
 
   <T extends Serializable, Method extends BotApiMethod<T>> T execute(Method method) throws TelegramApiException;
 
-  Boolean addStickerToSet(AddStickerToSet addStickerToSet) throws TelegramApiException;
-
-  Boolean createNewStickerSet(CreateNewStickerSet createNewStickerSet) throws TelegramApiException;
-
-  File uploadStickerFile(UploadStickerFile uploadStickerFile) throws TelegramApiException;
-
   Boolean setChatPhoto(SetChatPhoto setChatPhoto) throws TelegramApiException;
 
   java.io.File downloadFile(String path) throws TelegramApiException;
@@ -65,4 +56,4 @@ public interface MessageSender {
   Message sendVideoNote(SendVideoNote sendVideoNote) throws TelegramApiException;
 
   Message sendSticker(SendSticker sendSticker) throws TelegramApiException;
-}
+}

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/sender/StickerMessage.java

@@ -0,0 +1,31 @@
+package org.telegram.abilitybots.api.sender;
+
+
+import org.telegram.telegrambots.meta.api.methods.BotApiMethod;
+import org.telegram.telegrambots.meta.api.methods.stickers.AddStickerToSet;
+import org.telegram.telegrambots.meta.api.methods.stickers.CreateNewStickerSet;
+import org.telegram.telegrambots.meta.api.methods.stickers.UploadStickerFile;
+import org.telegram.telegrambots.meta.api.objects.File;
+import org.telegram.telegrambots.bots.DefaultAbsSender;
+import org.telegram.telegrambots.meta.exceptions.TelegramApiException;
+import org.telegram.telegrambots.meta.updateshandlers.SentCallback;
+
+import java.io.Serializable;
+
+/**
+ * A sender interface that replicates {@link DefaultAbsSender} methods.
+ *
+ * @author Abbas Abou Daya
+ */
+public interface StickerMessage {
+
+    <T extends Serializable, Method extends BotApiMethod<T>, Callback extends SentCallback<T>> void executeAsync(Method method, Callback callback) throws TelegramApiException;
+
+    <T extends Serializable, Method extends BotApiMethod<T>> T execute(Method method) throws TelegramApiException;
+    Boolean addStickerToSet(AddStickerToSet addStickerToSet) throws TelegramApiException;
+
+    Boolean createNewStickerSet(CreateNewStickerSet createNewStickerSet) throws TelegramApiException;
+
+    File uploadStickerFile(UploadStickerFile uploadStickerFile) throws TelegramApiException;
+}
+

telegrambots-abilities/src/main/java/org/telegram/abilitybots/api/util/AbilityUtils.java

@@ -302,6 +302,8 @@ public static boolean isValidCommand(String command){
    * @param commandName the command name to be checked for validity
    * @return whether the command name is valid
    */
+
+
   public static boolean isValidCommandName(String commandName){
     if (commandName == null || commandName.length() > 31) return false;
     return commandName.matches("[A-Za-z_0-9]+");

telegrambots-abilities/src/test/java/org/telegram/abilitybots/api/objects/AbilityTest.java

@@ -70,4 +70,3 @@ void abilityBuilderSetStatsEnabledFalseTest() {
     assertFalse(statsDisabledAbility.statsEnabled());
   }
 }
-

telegrambots-extensions/src/test/java/org/telegram/telegrambots/extensions/bots/commandbot/commands/TimedSendLongPollingBotTest.java

@@ -0,0 +1,39 @@
+package org.telegram.telegrambots.extensions.bots.commandbot.commands;
+
+import org.junit.jupiter.api.Test;
+import org.telegram.telegrambots.extensions.bots.timedbot.TimedSendLongPollingBot;
+import org.telegram.telegrambots.meta.api.objects.Update;
+import static org.mockito.Mockito.mock;
+
+
+public class TimedSendLongPollingBotTest
+{
+    @Test
+    public void testMessageProcessing()
+    {
+        TimedSendLongPollingBot testbot = new TimedSendLongPollingBot()
+        {
+            @Override
+            public String getBotUsername() {
+                return null;
+            }
+
+            @Override
+            public void onUpdateReceived(Update update)
+            {
+
+            }
+            @Override
+            public void sendMessageCallback(Long chatId, Object messageRequest)
+            {
+
+            }
+        };
+
+        Long chatId = 2L;
+        Object messageRequest = mock(Object.class);
+
+        testbot.sendTimed(chatId,messageRequest);
+        testbot.finish();
+    }
+}

telegrambots-meta/src/main/java/org/telegram/telegrambots/meta/api/methods/BotApiMethod.java

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
+import org.telegram.telegrambots.meta.exceptions.TelegramApiRequestException;
 
 import java.io.Serializable;
 
@@ -13,7 +14,15 @@
  */
 @JsonIgnoreProperties(ignoreUnknown = true)
 @JsonInclude(JsonInclude.Include.NON_NULL)
-public abstract class BotApiMethod<T extends Serializable> extends PartialBotApiMethod<T> {
-    protected static final String METHOD_FIELD = "method";
+public  class BotApiMethod<T extends Serializable> extends PartialBotApiMethod<T> {
 
+    @Override
+    public T deserializeResponse(String answer) throws TelegramApiRequestException {
+        return null;
+    }
+
+    @Override
+    public String getMethod() {
+        return null;
+    }
 }

telegrambots-meta/src/main/java/org/telegram/telegrambots/meta/api/methods/PartialBotApiMethod.java

@@ -22,6 +22,8 @@ public abstract class PartialBotApiMethod<T extends Serializable> implements Val
     @JsonIgnore
     protected static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
 
+    protected static final String METHOD_FIELD = "method";
+
     /**
      * Deserialize a json answer to the response type to a method
      * @param answer Json answer received
@@ -62,6 +64,7 @@ private T deserializeResponseInternal(String answer, JavaType type) throws Teleg
      * Getter for method path (that is the same as method name)
      * @return Method path
      */
-    @JsonProperty(BotApiMethod.METHOD_FIELD)
+
+    @JsonProperty(METHOD_FIELD)
     public abstract String getMethod();
 }