Version 5.2.1

Andre601 · Andre601 · commit bda5de2f9721 · 2020-06-18T22:30:56.000+02:00
diff --git a/build.gradle b/build.gradle
@@ -9,7 +9,7 @@ plugins{
     id 'net.kyori.blossom' version '1.1.0'
 }
 
-def ver = new Version(major: 5, minor: 2, revision: 0)
+def ver = new Version(major: 5, minor: 2, revision: 1)
 
 group = "org.botblock"
 version = "$ver"
diff --git a/src/main/java/org/botblock/javabotblockapi/BotBlockAPI.java b/src/main/java/org/botblock/javabotblockapi/BotBlockAPI.java
@@ -18,6 +18,7 @@
 package org.botblock.javabotblockapi;
 
 import org.botblock.javabotblockapi.annotations.DeprecatedSince;
+import org.botblock.javabotblockapi.requests.CheckUtil;
 import org.botblock.javabotblockapi.requests.PostAction;
 import org.jetbrains.annotations.NotNull;
 
@@ -104,8 +105,7 @@ public Builder(){}
          * @since 2.1.0
          */
         public Builder addAuthToken(@NotNull Site site, @NotNull String token){
-            if(token.isEmpty())
-                throw new NullPointerException("Token may not be null.");
+            CheckUtil.notEmpty(token, "Token");
 
             tokens.put(site.getSite(), token);
 
@@ -129,9 +129,9 @@ public Builder addAuthToken(@NotNull Site site, @NotNull String token){
          * @return The Builder after the site and token were set. Useful for chaining.
          */
         public Builder addAuthToken(@NotNull String site, @NotNull String token){
-            if(site.isEmpty() || token.isEmpty())
-                throw new NullPointerException("Site and/or token may not be null.");
-
+            CheckUtil.notEmpty(site, "Site");
+            CheckUtil.notEmpty(token, "Token");
+            
             tokens.put(site, token);
 
             return this;
@@ -150,8 +150,7 @@ public Builder addAuthToken(@NotNull String site, @NotNull String token){
          * @return The Builder after the Map was set. Useful for chaining.
          */
         public Builder setAuthTokens(@NotNull Map<String, String> tokens){
-            if(tokens.isEmpty())
-                throw new NullPointerException("Tokens may not be empty.");
+            CheckUtil.notEmpty(tokens, "Tokens");
 
             this.tokens = tokens;
 
@@ -165,14 +164,13 @@ public Builder setAuthTokens(@NotNull Map<String, String> tokens){
          * @param  updateDelay
          *         The update interval in minutes that should be used. This can't be less than 2.
          *
-         * @throws java.lang.IllegalArgumentException
+         * @throws java.lang.IllegalStateException
          *         When the updateInterval is less than 2.
          *
          * @return The Builder after the updateInterval was set. Useful for chaining.
          */
         public Builder setUpdateDelay(@NotNull Integer updateDelay){
-            if(updateDelay < 2)
-                throw new IllegalArgumentException("Update interval may not be less than 2.");
+            CheckUtil.condition(updateDelay < 2, "UpdateDelay may not be less than 2.");
 
             this.updateDelay = updateDelay;
 
@@ -181,10 +179,15 @@ public Builder setUpdateDelay(@NotNull Integer updateDelay){
 
         /**
          * Builds the instance of {@link org.botblock.javabotblockapi.BotBlockAPI BotBlockAPI}.
+         * 
+         * @throws java.lang.NullPointerException
+         *         When the Tokens Map is empty.
          *
          * @return The built, usable {@link org.botblock.javabotblockapi.BotBlockAPI BotBlockAPI}.
          */
         public BotBlockAPI build(){
+            CheckUtil.notEmpty(tokens, "Tokens");
+            
             return new BotBlockAPI(tokens, updateDelay);
         }
     }
diff --git a/src/main/java/org/botblock/javabotblockapi/Site.java b/src/main/java/org/botblock/javabotblockapi/Site.java
@@ -98,6 +98,13 @@ public enum Site {
      */
     DISCORDLIST_CO("discordlist.co"),
     
+    /**
+     * <a href="https://discordlistology.com" target="_blank">discordlistology.com</a>
+     * 
+     * @since 5.2.1
+     */
+    DISCORDLISTOLOGY_COM("discordlistology.com"),
+    
     /**
      * <a href="https://glennbotlist.xyz" target="_blank">glennbotlist.xyz</a>
      */
@@ -113,6 +120,13 @@ public enum Site {
      */
     SPACE_BOT_LIST_ORG("space-bot-list.org"),
     
+    /**
+     * <a href="https://vultrex.io" target="_blank">vultrex.io</a>
+     * 
+     * @since 5.2.1
+     */
+    VULTREX_IO("vultrex.io"),
+    
     /**
      * <a href="https://wonderbotlist.com" target="_blank">wonderbotlist.com</a>
      */
diff --git a/src/main/java/org/botblock/javabotblockapi/exceptions/RatelimitedException.java b/src/main/java/org/botblock/javabotblockapi/exceptions/RatelimitedException.java
@@ -20,15 +20,15 @@
 import org.json.JSONObject;
 
 /**
- * Class used to indicate when the bot gets Ratelimited by the BotBlock API.
- * <br>You can use {@link #getDelay() getDelay()} to find out how long you have to wait before you can access
- * {@link #getRoute() the route} again.
+ * 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}.
  */
 public class RatelimitedException extends RuntimeException{
-    private int delay;
-    private String botId;
-    private String ip;
-    private String route;
+    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);
@@ -49,27 +49,27 @@ public int getDelay(){
     }
     
     /**
-     * Returns the bot id that was ratelimited.
+     * Returns the bot id that was rate limited.
      * 
-     * @return The id of the bot that was ratelimited
+     * @return The id of the bot that was rate limited
      */
     public String getBotId(){
         return botId;
     }
     
     /**
-     * Returns the ip that was ratelimited.
+     * Returns the ip that was rate limited.
      * 
-     * @return The ip that was ratelimited
+     * @return The ip that was rate limited
      */
     public String getIp(){
         return ip;
     }
     
     /**
-     * Returns the route on which the bot was ratelimited.
+     * Returns the route on which the bot was rate limited.
      * 
-     * @return The route on which the bot was ratelimited
+     * @return The route on which the bot was rate limited
      */
     public String getRoute(){
         return route;
@@ -82,18 +82,19 @@ public String getRoute(){
      */
     @Override
     public String toString(){
-        return "RatelimitedException{delay=" + delay
-                + ", botId=" + botId
-                + ", ip=" + ip
-                + ", route=" + route
+        return "RatelimitedException{"
+                + "delay=" + delay + ", "
+                + "botId=" + botId + ", "
+                + "ip="    + ip    + ", "
+                + "route=" + route + ", "
                 + "}";
     }
     
     /**
      * Returns a formatted message displaying the various information returned in this exception.
-     * <br>This essentially calls {@link #toString() toString()} in this class.
+     * <br>This essentially returns the same value as {@link #toString() toString()} does.
      *
-     * @return Same output as {@link #toString() toString()}
+     * @return Formatted String containing the provided information from the response. Same format as {@link #toString() toString()}.
      */
     @Override
     public String getMessage(){
diff --git a/src/main/java/org/botblock/javabotblockapi/requests/CheckUtil.java b/src/main/java/org/botblock/javabotblockapi/requests/CheckUtil.java
@@ -18,11 +18,23 @@
 
 package org.botblock.javabotblockapi.requests;
 
-class CheckUtil{
+import java.util.Map;
+
+public class CheckUtil{
     
     public static void notEmpty(String value, String name){
         if(value.isEmpty())
             throw new NullPointerException(name + " may not be empty.");
     }
     
+    public static void notEmpty(Map<?, ?> value, String name){
+        if(value.isEmpty())
+            throw new NullPointerException(name + " may not be empty.");
+    }
+    
+    public static void condition(boolean check, String message){
+        if(check)
+            throw new IllegalStateException(message);
+    }
+    
 }
diff --git a/src/main/java/org/botblock/javabotblockapi/requests/GetBotAction.java b/src/main/java/org/botblock/javabotblockapi/requests/GetBotAction.java
@@ -398,44 +398,6 @@ public String getGitHub(@NotNull String id){
         return json.getString("github");
     }
     
-    /**
-     * Gets the OAuth invite of the bot.
-     * <br>The invite is based on the most common appearance of it.
-     *
-     * @param  id
-     *         The id of the bot to get the OAuth link from.
-     *
-     * @return Possibly-empty String containing the OAuth invite for the bot.
-     * 
-     * @deprecated Replaced with {@link #getOAuthInvite(Long) getOAuthInvite(Long)} to be more clear.
-     */
-    @Deprecated
-    @DeprecatedSince(version = "5.2.0", replacements = {"#getOAuthInvite(Long)"})
-    public String getInvite(@NotNull Long id){
-        JSONObject json = REQUEST_HANDLER.performGetBot(Long.toString(id), disableCache);
-        
-        return json.getString("invite");
-    }
-    
-    /**
-     * Gets the OAuth invite of the bot.
-     * <br>The invite is based on the most common appearance of it.
-     *
-     * @param  id
-     *         The id of the bot to get the OAuth link from.
-     *
-     * @return Possibly-empty String containing the OAuth invite for the bot.
-     * 
-     * @deprecated Replaced with {@link #getOAuthInvite(String) getOAuthInvite(String)} to be more clear.
-     */
-    @Deprecated
-    @DeprecatedSince(version = "5.2.0", replacements = {"#getOAuthInvite(String)"})
-    public String getInvite(@NotNull String id){
-        JSONObject json = REQUEST_HANDLER.performGetBot(id, disableCache);
-        
-        return json.getString("invite");
-    }
-    
     /**
      * Gets the currently used library of the bot.
      * <br>The library is based on the most common appearance of it.
@@ -513,7 +475,7 @@ public String getName(@NotNull String id){
      *         
      * @return Possibly-empty String containing the OAuth link for the bot.
      * 
-     * @since  5.2.0
+     * @since  5.1.13
      */
     public String getOAuthInvite(@NotNull Long id){
         JSONObject json = REQUEST_HANDLER.performGetBot(String.valueOf(id), disableCache);
@@ -530,7 +492,7 @@ public String getOAuthInvite(@NotNull Long id){
      *
      * @return Possibly-empty String containing the OAuth link for the bot.
      * 
-     * @since  5.2.0
+     * @since  5.1.13
      */
     public String getOAuthInvite(@NotNull String id){
         JSONObject json = REQUEST_HANDLER.performGetBot(id, disableCache);
diff --git a/src/main/java/org/botblock/javabotblockapi/requests/RequestHandler.java b/src/main/java/org/botblock/javabotblockapi/requests/RequestHandler.java
@@ -29,8 +29,6 @@
 import org.json.JSONObject;
 
 import java.io.IOException;
-import java.util.ArrayList;
-import java.util.List;
 import java.util.concurrent.TimeUnit;
 
 class RequestHandler{
@@ -136,8 +134,7 @@ private JSONObject performGET(@NotNull String url, String header) throws IOExcep
     }
     
     void performPOST(@NotNull JSONObject json, int sites) throws IOException{
-        if(sites < 1)
-            throw new IllegalStateException("POST action requires at least one site!");
+        CheckUtil.condition(sites < 1, "The POST action requires at least 1 site!");
         
         String url = BASE_URL + "count";
         final long timeout = sites * 10;
@@ -179,27 +176,30 @@ void performPOST(@NotNull JSONObject json, int sites) throws IOException{
             JSONObject responseJson = new JSONObject(responseBody);
             if(responseJson.has("failure")){
                 JSONObject failure = responseJson.getJSONObject("failure");
-                List<String> failedSites = new ArrayList<>();
+                JSONArray failures = new JSONArray();
                 
                 for(String key : failure.keySet()){
                     try{
                         JSONArray array = failure.getJSONArray(key);
-                        failedSites.add(String.format(
-                                "%s{code=%d, message=%s}",
-                                key,
-                                array.getInt(0),
-                                array.getString(1)
-                        ));
+                        failures.put(getJson(key, array));
                     }catch(JSONException ex){
-                        failedSites.add("unknown{}");
+                        failures.put(getJson(key, null));
                     }
                 }
                 
                 throw new IOException(String.format(
-                        "One or multiple post requests failed! Response(s): failed{[%s]}",
-                        String.join(", ", failedSites)
+                        "One or multiple post requests failed! Response(s): failed{%s}",
+                        failures.toString()
                 ));
             }
         }
     }
+    
+    private JSONObject getJson(String key, JSONArray array){
+        JSONObject json = new JSONObject()
+                .put("code", array == null ? "?" : array.get(0))
+                .put("message", array == null ? "?" : array.get(1));
+        
+        return new JSONObject().put(key, json);
+    }
 }
diff --git a/wiki/docs/wiki/changelog.md b/wiki/docs/wiki/changelog.md
@@ -11,6 +11,16 @@ This page lists all versions of JavaBotBlockAPI and the changes being made.
 Split up the different `GET` actions into bot and list related actions.  
 Many new `GET` actions added for list related stuff.
 
+### 5.2.1
+- Site updated:
+    - Added [`DISCORDLISTOLOGY_COM`](https://discordlistology.com)
+    - Added [`VULTREX_IO`](https://vultrex.io)
+- Dependencies updated:
+    - JDA: `4.1.1_156` to `4.1.1_165`
+- Improved Javadoc
+- Removed deprecated `getInvite` methods from `GetBotAction`
+- Make the RequestHandler return proper JSON on (partially) failed POST
+
 ### 5.2.0
 
 !!! warning "Important"

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ plugins{`
`9`	`9`	`id 'net.kyori.blossom' version '1.1.0'`
`10`	`10`	`}`
`11`	`11`
`12`		`-def ver = new Version(major: 5, minor: 2, revision: 0)`
	`12`	`+def ver = new Version(major: 5, minor: 2, revision: 1)`
`13`	`13`
`14`	`14`	`group = "org.botblock"`
`15`	`15`	`version = "$ver"`