Version 6.4.0

Andre601 · Andre601 · commit 62443b0d403c · 2021-01-04T14:13:44.000+01:00
+ JavaBotBlockAPIInfo
  Provides static info about the wrapper.
diff --git a/build.gradle b/build.gradle
@@ -6,10 +6,9 @@ plugins{
     id 'maven-publish'
     id 'maven'
     id 'com.github.johnrengelman.shadow' version '5.2.0'
-    id 'net.kyori.blossom' version '1.1.0'
 }
 
-def ver = new Version(major: 6, minor: 3, patch: 4)
+def ver = new Version(major: 6, minor: 4, patch: 0)
 
 allprojects {
     apply plugin: 'com.jfrog.bintray'
@@ -192,10 +191,6 @@ subprojects {
             rootProject.dependencies.compile project
         }
     }
-    
-    blossom{
-        replaceToken("API_VERSION", version)
-    }
 }
 
 configurations {
diff --git a/core/src/main/java/org/botblock/javabotblockapi/core/JavaBotBlockAPIInfo.java b/core/src/main/java/org/botblock/javabotblockapi/core/JavaBotBlockAPIInfo.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2019 - 2021 Andre601
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+ * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package org.botblock.javabotblockapi.core;
+
+/**
+ * Class containing static info used in other modules.
+ * <br>Feel free to use the info shared here inside your bot if you, for example, want to share what Lib your bot
+ * uses to post Guild count or similar.
+ */
+public class JavaBotBlockAPIInfo{
+    
+    /**
+     * Major version of the Wrapper.
+     */
+    public static final String MAJOR = "6";
+    /**
+     * Minor version of the Wrapper.
+     */
+    public static final String MINOR = "4";
+    /**
+     * Patch version of the Wrapper.
+     */
+    public static final String PATCH = "0";
+    
+    /**
+     * Full version in the format {@code major.minor.patch}.
+     */
+    public static final String VERSION = String.format("%s.%s.%s", MAJOR, MINOR, PATCH);
+    
+    /**
+     * URL to the GitHub repository.
+     */
+    public static final String GITHUB = "https://github.com/botblock/JavaBotBlockAPI";
+}
diff --git a/javacord/src/main/java/org/botblock/javabotblockapi/javacord/PostAction.java b/javacord/src/main/java/org/botblock/javabotblockapi/javacord/PostAction.java
@@ -20,6 +20,7 @@
 
 import org.botblock.javabotblockapi.core.BotBlockAPI;
 import org.botblock.javabotblockapi.core.CheckUtil;
+import org.botblock.javabotblockapi.core.JavaBotBlockAPIInfo;
 import org.botblock.javabotblockapi.core.exceptions.RateLimitedException;
 import org.botblock.javabotblockapi.requests.handler.RequestHandler;
 import org.javacord.api.DiscordApi;
@@ -63,9 +64,10 @@ public class PostAction{
      */
     public PostAction(DiscordApi api){
         this.requestHandler = new RequestHandler(String.format(
-                "%s-%s/API_VERSION (Javacord) DBots/%s",
+                "%s-%s/%s (Javacord) DBots/%s",
                 api.getYourself().getName(),
                 api.getYourself().getDiscriminator(),
+                JavaBotBlockAPIInfo.VERSION,
                 api.getYourself().getId()
         ));
         this.scheduler = requestHandler.getScheduler();
@@ -138,7 +140,8 @@ public void disableAutoPost(long time, @Nonnull TimeUnit timeUnit){
         
         try{
             scheduler.shutdown();
-            scheduler.awaitTermination(time, timeUnit);
+            if(!scheduler.awaitTermination(time, timeUnit))
+                LOG.warn("Scheduler couldn't properly wait for termination.");
         }catch(InterruptedException ex){
             LOG.warn("Got interrupted while shutting down the Scheduler!", ex);
         }
diff --git a/jda/src/main/java/org/botblock/javabotblockapi/jda/PostAction.java b/jda/src/main/java/org/botblock/javabotblockapi/jda/PostAction.java
@@ -21,6 +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.JavaBotBlockAPIInfo;
 import org.botblock.javabotblockapi.core.exceptions.RateLimitedException;
 import org.botblock.javabotblockapi.core.CheckUtil;
 import org.botblock.javabotblockapi.requests.handler.RequestHandler;
@@ -78,9 +79,10 @@ public PostAction(@Nonnull ShardManager shardManager){
      */
     public PostAction(@Nonnull JDA jda){
         this.requestHandler = new RequestHandler(String.format(
-                "%s-%s/API_VERSION (JDA) DBots/%s",
+                "%s-%s/%s (JDA) DBots/%s",
                 jda.getSelfUser().getName(),
                 jda.getSelfUser().getDiscriminator(),
+                JavaBotBlockAPIInfo.VERSION,
                 jda.getSelfUser().getId()
         ));
         this.scheduler = requestHandler.getScheduler();
@@ -157,7 +159,8 @@ public void disableAutoPost(long time, @Nonnull TimeUnit timeUnit){
         
         try{
             scheduler.shutdown();
-            scheduler.awaitTermination(time, timeUnit);
+            if(!scheduler.awaitTermination(time, timeUnit))
+                LOG.warn("Scheduler couldn't properly wait for termination.");
         }catch(InterruptedException ex){
             LOG.warn("Got interrupted while shutting down the Scheduler!", ex);
         }
diff --git a/request/src/main/java/org/botblock/javabotblockapi/requests/GetBotAction.java b/request/src/main/java/org/botblock/javabotblockapi/requests/GetBotAction.java
@@ -18,6 +18,7 @@
 
 package org.botblock.javabotblockapi.requests;
 
+import org.botblock.javabotblockapi.core.JavaBotBlockAPIInfo;
 import org.botblock.javabotblockapi.core.Site;
 import org.botblock.javabotblockapi.core.CheckUtil;
 import org.botblock.javabotblockapi.core.exceptions.RateLimitedException;
@@ -53,11 +54,13 @@ public class GetBotAction{
      *     <li>User-Agent: {@code "JavaBotBlockAPI-0000/API_VERSION (Unknown; +https://jbba.dev) DBots/{id}"}</li>
      * </ul>
      *
+     * <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 id is empty.</li>
+     * </ul>
+     *
      * @param id
      *        The id of the bot. This is required for the internal User-Agent.
-     *
-     * @throws java.lang.NullPointerException
-     *         When the provided id is empty.
      */
     public GetBotAction(@Nonnull String id){
         this(false, id);
@@ -72,17 +75,22 @@ public GetBotAction(@Nonnull String id){
      *     <li>User-Agent: {@code "JavaBotBlockAPI-0000/API_VERSION (Unknown; +https://jbba.dev) DBots/{id}"}</li>
      * </ul>
      *
+     * <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 id is empty.</li>
+     * </ul>
+     *
      * @param disableCache
      *        If the cache should be disabled.
      *        <br>{@code true} means the cache is <b>disabled</b>.
      * @param id
      *        The id of the bot. This is required for the internal User-Agent.
-     *
-     * @throws java.lang.NullPointerException
-     *         When the provided id is empty.
      */
     public GetBotAction(boolean disableCache, @Nonnull String id){
-        this(disableCache, "JavaBotBlockAPI-0000/API_VERSION (Unknown; +https://jbba.dev) DBots/{id}", id);
+        this(disableCache, String.format(
+                "JavaBotBlockAPI-0000/%s (Unknown; +https://jbba.dev) DBots/{id}",
+                JavaBotBlockAPIInfo.VERSION
+        ), id);
     }
     
     /**
@@ -104,9 +112,6 @@ public GetBotAction(boolean disableCache, @Nonnull String id){
      *        The Name that should be used as User-Agent.
      * @param id
      *        The id of the bot. This is required for the internal User-Agent.
-     *
-     * @throws java.lang.NullPointerException
-     *         When the provided userAgent or id is empty.
      */
     public GetBotAction(boolean disableCache, @Nonnull String userAgent, @Nonnull String id){
         CheckUtil.notEmpty(userAgent, "UserAgent");
diff --git a/request/src/main/java/org/botblock/javabotblockapi/requests/GetListAction.java b/request/src/main/java/org/botblock/javabotblockapi/requests/GetListAction.java
@@ -18,6 +18,7 @@
 
 package org.botblock.javabotblockapi.requests;
 
+import org.botblock.javabotblockapi.core.JavaBotBlockAPIInfo;
 import org.botblock.javabotblockapi.core.Site;
 import org.botblock.javabotblockapi.core.CheckUtil;
 import org.botblock.javabotblockapi.requests.handler.RequestHandler;
@@ -69,17 +70,22 @@ public GetListAction(@Nonnull String id){
      *     <li>User-Agent: {@code "JavaBotBlockAPI-0000/API_VERSION (Unknown; +https://jbba.dev) DBots/{id}"}</li>
      * </ul>
      *
+     * <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 id is empty.</li>
+     * </ul>
+     *
      * @param disableCache
      *        If the cache should be disabled.
      *        <br>{@code true} means the cache is <b>disabled</b>.
      * @param id
      *        The id of the bot. This is required for the internal User-Agent.
-     *
-     * @throws java.lang.NullPointerException
-     *         When the provided id is empty.
      */
     public GetListAction(boolean disableCache, @Nonnull String id){
-        this(disableCache, "JavaBotBlockAPI-0000/API_VERSION (Unknown; +https://jbba.dev) DBots/{id}", id);
+        this(disableCache, String.format(
+                "JavaBotBlockAPI-0000/%s (Unknown; +https://jbba.dev) DBots/{id}",
+                JavaBotBlockAPIInfo.VERSION
+        ), id);
     }
     
     /**
@@ -101,9 +107,6 @@ public GetListAction(boolean disableCache, @Nonnull String id){
      *        The Name that should be used as User-Agent.
      * @param id
      *        The id of the bot. This is required for the internal User-Agent.
-     *
-     * @throws java.lang.NullPointerException
-     *         When the provided userAgent or id is empty.
      */
     public GetListAction(boolean disableCache, @Nonnull String userAgent, @Nonnull String id){
         CheckUtil.notEmpty(userAgent, "UserAgent");
diff --git a/request/src/main/java/org/botblock/javabotblockapi/requests/PostAction.java b/request/src/main/java/org/botblock/javabotblockapi/requests/PostAction.java
@@ -19,6 +19,7 @@
 package org.botblock.javabotblockapi.requests;
 
 import org.botblock.javabotblockapi.core.BotBlockAPI;
+import org.botblock.javabotblockapi.core.JavaBotBlockAPIInfo;
 import org.botblock.javabotblockapi.core.exceptions.RateLimitedException;
 import org.botblock.javabotblockapi.core.CheckUtil;
 import org.botblock.javabotblockapi.requests.handler.RequestHandler;
@@ -54,14 +55,16 @@ public class PostAction{
      *     <li>User-Agent: {@code "JavaBotBlockAPI-0000/API_VERSION (Unknown; +https://jbba.dev) DBots/{id}"}</li>
      * </ul>
      *
+     * <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 ID is empty.</li>
+     * </ul>
+     *
      * @param id
      *        The id of the bot. This is required for the internal User-Agent.
-     *
-     * @throws NullPointerException
-     *         When the provided id is empty.
      */
     public PostAction(@Nonnull String id){
-        this("JavaBotBlockAPI-0000/API_VERSION (Unknown; +https://jbba.dev) DBots/{id}", id);
+        this(String.format("JavaBotBlockAPI-0000/%s (Unknown; +https://jbba.dev) DBots/{id}", JavaBotBlockAPIInfo.VERSION), id);
     }
     
     /**
@@ -70,13 +73,15 @@ public PostAction(@Nonnull String id){
      *
      * <p>Note that you can provide {@code {id}} inside the userAgent to get it replaced with the provided id.
      *
+     * <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 ID or User Agent are empty.</li>
+     * </ul>
+     *
      * @param userAgent
      *        The Name to use as User-Agent.
      * @param id
      *        The id of the bot. This is required for the internal User-Agent.
-     *
-     * @throws NullPointerException
-     *         When the provided userAgent or id is empty.
      */
     public PostAction(@Nonnull String userAgent, @Nonnull String id){
         CheckUtil.notEmpty(userAgent, "UserAgent");
@@ -152,7 +157,8 @@ public void disableAutoPost(long time, @Nonnull TimeUnit timeUnit){
         
         try{
             scheduler.shutdown();
-            scheduler.awaitTermination(time, timeUnit);
+            if(!scheduler.awaitTermination(time, timeUnit))
+                LOG.warn("Scheduler couldn't properly wait for termination.");
         }catch(InterruptedException ex){
             LOG.warn("Got interrupted while shutting down the Scheduler!", ex);
         }

Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,9 @@ plugins{`
`6`	`6`	`id 'maven-publish'`
`7`	`7`	`id 'maven'`
`8`	`8`	`id 'com.github.johnrengelman.shadow' version '5.2.0'`
`9`		`- id 'net.kyori.blossom' version '1.1.0'`
`10`	`9`	`}`
`11`	`10`
`12`		`-def ver = new Version(major: 6, minor: 3, patch: 4)`
	`11`	`+def ver = new Version(major: 6, minor: 4, patch: 0)`
`13`	`12`
`14`	`13`	`allprojects {`
`15`	`14`	`apply plugin: 'com.jfrog.bintray'`
`@@ -192,10 +191,6 @@ subprojects {`
`192`	`191`	`rootProject.dependencies.compile project`
`193`	`192`	`}`
`194`	`193`	`}`
`195`		`-`
`196`		`- blossom{`
`197`		`- replaceToken("API_VERSION", version)`
`198`		`- }`
`199`	`194`	`}`
`200`	`195`
`201`	`196`	`configurations {`