Rename RatelimitedException to RateLimitedException, add basic logging and more

Author: Andre601

build.gradle

@@ -26,6 +26,7 @@ allprojects {
             api group: 'org.json', name: 'json', version: '20200518'
             api group: 'com.github.ben-manes.caffeine', name: 'caffeine', version: '2.8.0'
             api group: 'com.google.code.findbugs', name: 'jsr305', version: '3.0.2'
+            api group: 'org.slf4j', name: 'slf4j-api', version: '1.7.25'
 
             artifactId = (rootProject == project? project.name : "$rootProject.name-$project.name").toLowerCase()
             moduleName = "${group}.javabotblockapi${rootProject == project? "" : ".${project.name.toLowerCase()}"}"

core/src/main/java/org/botblock/javabotblockapi/core/BotBlockAPI.java

@@ -80,19 +80,16 @@ public Builder(){}
          * <p>Following Exceptions can be thrown from the {@link org.botblock.javabotblockapi.core.CheckUtil CheckUtil}:
          * <ul>
          *     <li>{@link java.lang.NullPointerException NullPointerException} - When the provided Token is empty.</li>
+         *     <li>{@link java.lang.IllegalStateException IllegalStateException} - When the provided Site doesn't support POST requests.</li>
          * </ul>
-         * 
-         * @throws java.lang.IllegalStateException
-         *         When the provided site does not support POST requests.
          *
          * @return The Builder after the site and token were set. Useful for chaining.
          *
          * @since 2.1.0
          */
         public Builder addAuthToken(@Nonnull Site site, @Nonnull String token){
             CheckUtil.notEmpty(token, "Token");
-            if(!site.supportsPost())
-                throw new IllegalArgumentException(site.getSite() + " does not support POST requests!");
+            CheckUtil.condition(!site.supportsPost(), site.getSite() + " does not support POST requests!");
 
             tokens.put(site.getSite(), token);
             return this;

core/src/main/java/org/botblock/javabotblockapi/core/exceptions/RatelimitedException.java renamed to core/src/main/java/org/botblock/javabotblockapi/core/exceptions/RateLimitedException.java

@@ -19,57 +19,74 @@
 
 import org.json.JSONObject;
 
+import javax.annotation.Nullable;
+
 /**
  * Indicates that the Wrapper got rate limited by the BotBlock API.
  * <br>Use {@link #getDelay() getDelay()} to find out how long you have to wait until you can perform another request
  * towards {@link #getRoute() the targeted route}.
+ * 
+ * <p>Note that this Wrapper will do <b>no attempt</b> at delaying any further requests! I is your own responsability to
+ * handle rate limits properly in those cases and delay any future requests accordingly.
+ * <br>Any automated POSTing method of this Wrapper should not get rate limited due to keeping a minimal delay between each
+ * request that is more than enough.
  */
-public class RatelimitedException extends RuntimeException{
+public class RateLimitedException extends RuntimeException{
     private final int delay;
     private final String botId;
     private final String ip;
     private final String route;
 
-    public RatelimitedException(String response){
-        JSONObject json = new JSONObject(response);
-
-        this.delay = json.getInt("retry_after");
-        this.botId = json.getString("ratelimit_bot_id");
-        this.ip = json.getString("ratelimit_ip");
-        this.route = json.getString("ratelimit_route");
+    public RateLimitedException(JSONObject json){
+        this(json.optInt("retry_after", -1), json.optString("ratelimit_bot_id", null),
+             json.optString("ratelimit_ip", null), json.optString("ratelimit_route", null));
+    }
+    
+    private RateLimitedException(int delay, String botId, String ip, String route){
+        super("Got rate limited on route " + route + " with bot id " + botId + " (ip: " + ip + "). Retry after: " + delay);
+        
+        this.delay = delay;
+        this.botId = botId;
+        this.ip = ip;
+        this.route = route;
     }
 
     /**
      * Returns the delay - in milliseconds - you have to wait to perform a request again.
+     * <br>When no delay could be extracted from the received JSON (The JSON was malformed) then {@code -1} will be returned.
      * 
-     * @return The delay you have to wait in milliseconds
+     * @return The delay you have to wait in milliseconds or {@code -1}.
      */
     public int getDelay(){
         return delay;
     }
 
     /**
      * Returns the bot id that was rate limited.
+     * <br>When no botId could be extracted from the received JSON (The JSON was malformed) then {@code null} will be returned.
      * 
-     * @return The id of the bot that was rate limited
+     * @return Possibly-null String representing the id of the rate limited bot.
      */
+    @Nullable
     public String getBotId(){
         return botId;
     }
 
     /**
      * Returns the ip that was rate limited.
+     * <br>When no ip could be extracted from the received JSON (The JSON was malformed) then {@code null} will be returned.
      * 
-     * @return The ip that was rate limited
+     * @return Possibly-null String representing the ip of the rate limited bot.
      */
     public String getIp(){
         return ip;
     }
 
     /**
      * Returns the route on which the bot was rate limited.
+     * <br>When no route could be extracted from the received JSON (The JSON was malformed) then {@code null} will be returned.
      * 
-     * @return The route on which the bot was rate limited
+     * @return Possibly-null String representing the route on which the bot got rate limited.
      */
     public String getRoute(){
         return route;
@@ -98,6 +115,6 @@ public String toString(){
      */
     @Override
     public String getMessage(){
-        return "Got rate limited on route" + route + " for " + delay + "ms with bot id " + botId + " (ip: " + ip + ")";
+        return "Got rate limited on route " + route + " with bot id " + botId + " (ip: " + ip + "). Retry after: " + delay;
     }
 }

javacord/src/main/java/org/botblock/javabotblockapi/javacord/PostAction.java

@@ -20,7 +20,7 @@
 
 import org.botblock.javabotblockapi.core.BotBlockAPI;
 import org.botblock.javabotblockapi.core.CheckUtil;
-import org.botblock.javabotblockapi.core.exceptions.RatelimitedException;
+import org.botblock.javabotblockapi.core.exceptions.RateLimitedException;
 import org.botblock.javabotblockapi.requests.handler.RequestHandler;
 import org.javacord.api.DiscordApi;
 import org.json.JSONArray;
@@ -141,7 +141,7 @@ public void disableAutoPost(long time, @Nonnull TimeUnit timeUnit){
      * Starts a {@link java.util.concurrent.ScheduledExecutorService#scheduleAtFixedRate(Runnable, long, long, TimeUnit) scheduleAtFixedRate}
      * task, which will post the statistics of the provided {@link org.javacord.api.DiscordApi DiscordApi instance} every n minutes.
      * 
-     * <p>If the post can't be performed - either by getting a {@link org.botblock.javabotblockapi.core.exceptions.RatelimitedException RateLimitedException}
+     * <p>If the post can't be performed - either by getting a {@link RateLimitedException RateLimitedException}
      * or by getting an {@link java.io.IOException IOException} - will the exception be caught and a Stacktrace printed.
      * 
      * <p>The scheduler will wait an initial delay of 1 minute and then performs a task every n minutes, where n is the
@@ -164,7 +164,7 @@ public void enableAutoPost(@Nonnull BotBlockAPI botBlockAPI, @Nonnull DiscordApi
         scheduler.scheduleAtFixedRate(() -> {
             try{
                 postGuilds(botBlockAPI, discordApis);
-            }catch(IOException | RatelimitedException ex){
+            }catch(IOException | RateLimitedException ex){
                 ex.printStackTrace();
             }
         }, 1, botBlockAPI.getUpdateDelay(), TimeUnit.MINUTES);
@@ -189,10 +189,10 @@ public void enableAutoPost(@Nonnull BotBlockAPI botBlockAPI, @Nonnull DiscordApi
      *        
      * @throws java.io.IOException
      *         When the POST request wasn't successful.
-     * @throws org.botblock.javabotblockapi.core.exceptions.RatelimitedException
+     * @throws RateLimitedException
      *         When we get rate limited by the BotBlock API (returns error code 429).
      */
-    public void postGuilds(@Nonnull BotBlockAPI botBlockAPI, @Nonnull DiscordApi... discordApis) throws IOException, RatelimitedException{
+    public void postGuilds(@Nonnull BotBlockAPI botBlockAPI, @Nonnull DiscordApi... discordApis) throws IOException, RateLimitedException{
         CheckUtil.condition(discordApis.length <= 0, "At least one DiscordApi instance needs to be provided!");
 
         JSONObject json = new JSONObject()

jda/src/main/java/org/botblock/javabotblockapi/jda/PostAction.java

@@ -21,7 +21,7 @@
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.sharding.ShardManager;
 import org.botblock.javabotblockapi.core.BotBlockAPI;
-import org.botblock.javabotblockapi.core.exceptions.RatelimitedException;
+import org.botblock.javabotblockapi.core.exceptions.RateLimitedException;
 import org.botblock.javabotblockapi.core.CheckUtil;
 import org.botblock.javabotblockapi.requests.handler.RequestHandler;
 import org.json.JSONArray;
@@ -163,7 +163,7 @@ public void disableAutoPost(long time, @Nonnull TimeUnit timeUnit){
      * Starts a {@link java.util.concurrent.ScheduledExecutorService#scheduleAtFixedRate(Runnable, long, long, TimeUnit) scheduleAtFixedRate}
      * task, which will post the statistics of the provided {@link net.dv8tion.jda.api.JDA JDA instance} every n minutes.
      * 
-     * <p>If the post can't be performed - either by getting a {@link org.botblock.javabotblockapi.core.exceptions.RatelimitedException RatelimitedException}
+     * <p>If the post can't be performed - either by getting a {@link RateLimitedException RatelimitedException}
      * or by getting an {@link java.io.IOException IOException} - will the exception be catched and the stacktrace printed.
      * 
      * <p>The scheduler will wait an initial delay of 1 minute and then performs a task every n minutes, where n is the
@@ -181,7 +181,7 @@ public void enableAutoPost(@Nonnull JDA jda, @Nonnull BotBlockAPI botBlockAPI){
         scheduler.scheduleAtFixedRate(() -> {
             try{
                 postGuilds(jda, botBlockAPI);
-            }catch(IOException | RatelimitedException ex){
+            }catch(IOException | RateLimitedException ex){
                 ex.printStackTrace();
             }
         }, 1, botBlockAPI.getUpdateDelay(), TimeUnit.MINUTES);
@@ -191,7 +191,7 @@ public void enableAutoPost(@Nonnull JDA jda, @Nonnull BotBlockAPI botBlockAPI){
      * Starts a {@link java.util.concurrent.ScheduledExecutorService#scheduleAtFixedRate(Runnable, long, long, TimeUnit) scheduleAtFixedRate}
      * task, which will post the statistics of the provided {@link net.dv8tion.jda.api.sharding.ShardManager ShardManager instance} every n minutes.
      *
-     * <p>If the post can't be performed - either by getting a {@link org.botblock.javabotblockapi.core.exceptions.RatelimitedException RatelimitedException}
+     * <p>If the post can't be performed - either by getting a {@link RateLimitedException RatelimitedException}
      * or by getting an {@link java.io.IOException IOException} - will the exception be caught and a Stacktrace printed.
      *
      * <p>The scheduler will wait an initial delay of 1 minute and then performs a task every n minutes, where n is the
@@ -207,7 +207,7 @@ public void enableAutoPost(@Nonnull ShardManager shardManager, @Nonnull BotBlock
         scheduler.scheduleAtFixedRate(() -> {
             try{
                 postGuilds(shardManager, botBlockAPI);
-            }catch(IOException | RatelimitedException ex){
+            }catch(IOException | RateLimitedException ex){
                 ex.printStackTrace();
             }
         }, botBlockAPI.getUpdateDelay(), botBlockAPI.getUpdateDelay(), TimeUnit.MINUTES);
@@ -227,10 +227,10 @@ public void enableAutoPost(@Nonnull ShardManager shardManager, @Nonnull BotBlock
      *         
      * @throws java.io.IOException
      *         When the POST request wasn't successful.
-     * @throws org.botblock.javabotblockapi.core.exceptions.RatelimitedException
+     * @throws RateLimitedException
      *         When we get rate limited by the BotBlock API (returns error code 429).
      */
-    public void postGuilds(@Nonnull JDA jda, @Nonnull BotBlockAPI botBlockAPI) throws IOException, RatelimitedException{
+    public void postGuilds(@Nonnull JDA jda, @Nonnull BotBlockAPI botBlockAPI) throws IOException, RateLimitedException{
         JSONObject json = new JSONObject()
                 .put("server_count", jda.getGuildCache().size())
                 .put("bot_id", jda.getSelfUser().getId());
@@ -257,10 +257,10 @@ public void postGuilds(@Nonnull JDA jda, @Nonnull BotBlockAPI botBlockAPI) throw
      *         When the first shard (id 0) of the provided ShardManager is null.
      * @throws java.io.IOException
      *         When the POST request wasn't successful.
-     * @throws org.botblock.javabotblockapi.core.exceptions.RatelimitedException
+     * @throws RateLimitedException
      *         When we get rate limited by the BotBlock API (returns error code 429).
      */
-    public void postGuilds(@Nonnull ShardManager shardManager, @Nonnull BotBlockAPI botBlockAPI) throws IOException, RatelimitedException{
+    public void postGuilds(@Nonnull ShardManager shardManager, @Nonnull BotBlockAPI botBlockAPI) throws IOException, RateLimitedException{
         JDA shard = shardManager.getShardById(0);
         CheckUtil.condition(shard == null, "Shard 0 of ShardManager was invalid (null).");