Merge pull request #206 from botblock/master

Andre601 · web-flow · commit 2eb5083d535d · 2021-02-21T22:12:04.000+01:00
Update dev branch
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,20 +1,15 @@
 version: 2
 updates:
-- package-ecosystem: pip
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-  labels:
-  - 'Type: Dependency update'
 - package-ecosystem: github-actions
+  target-branch: development
   directory: "/"
   schedule:
     interval: daily
   open-pull-requests-limit: 10
   labels:
   - 'Type: Dependency update'
 - package-ecosystem: gradle
+  target-branch: development
   directory: "/"
   schedule:
     interval: daily
diff --git a/.github/workflows/generate_javadoc.yml b/.github/workflows/generate_javadoc.yml
@@ -25,7 +25,7 @@ jobs:
       with: 
         github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: ./docs
-        commit_message: "Update Docs (${GITHUB_SHA:0:7})"
+        commit_message: "Update Docs"
   generateJars:
     needs: [generateJavadoc]
     if: success()
diff --git a/build.gradle b/build.gradle
@@ -7,7 +7,7 @@ plugins{
     id 'com.github.johnrengelman.shadow' version '5.2.0'
 }
 
-def ver = new Version(major: 6, minor: 5, patch: 0)
+def ver = new Version(major: 6, minor: 6, patch: 1)
 
 allprojects {
     apply plugin: 'maven-publish'
diff --git a/core/src/main/java/org/botblock/javabotblockapi/core/Info.java b/core/src/main/java/org/botblock/javabotblockapi/core/Info.java
@@ -0,0 +1,55 @@
+/*
+ * 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 general information about the project.
+ * 
+ * <p>The class can be used for things such as determining the {@link #VERSION used version} or to get some static info 
+ * like the {@link #GITHUB GitHub} or {@link #JENKINS Jenkins CI} URL.
+ * 
+ * @since 6.6.0
+ */
+public class Info{
+    
+    /**
+     * Major version of the Wrapper.
+     */
+    public static final int MAJOR = 6;
+    /**
+     * Minor version of the Wrapper.
+     */
+    public static final int MINOR = 6;
+    /**
+     * Patch version of the Wrapper.
+     */
+    public static final int PATCH = 1;
+    
+    /**
+     * Full version in the format {@code major.minor.patch}.
+     */
+    public static final String VERSION = String.format("%d.%d.%d", MAJOR, MINOR, PATCH);
+    
+    /**
+     * URL to the GitHub repository.
+     */
+    public static final String GITHUB = "https://github.com/botblock/JavaBotBlockAPI";
+    
+    public static final String JENKINS = "https://ci.codemc.io/job/botblock/job/JavaBotBlockAPI";
+}
diff --git a/core/src/main/java/org/botblock/javabotblockapi/core/JavaBotBlockAPIInfo.java b/core/src/main/java/org/botblock/javabotblockapi/core/JavaBotBlockAPIInfo.java
@@ -18,27 +18,35 @@
 
 package org.botblock.javabotblockapi.core;
 
+import org.botblock.javabotblockapi.core.annotations.DeprecatedSince;
+import org.botblock.javabotblockapi.core.annotations.PlannedRemoval;
+
 /**
  * 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.
  * 
+ * @deprecated Class was changed to {@link org.botblock.javabotblockapi.core.Info Info}.
+ * 
  * @since 6.4.0
  */
+@Deprecated
+@DeprecatedSince(major = 6, minor = 6, patch = 0, replacements = {"Info.java"})
+@PlannedRemoval(major = 6, minor = 6, patch = 2)
 public class JavaBotBlockAPIInfo{
     
     /**
      * Major version of the Wrapper.
      */
-    public static final String MAJOR = "6";
+    public static final String MAJOR = String.valueOf(Info.MAJOR);
     /**
      * Minor version of the Wrapper.
      */
-    public static final String MINOR = "4";
+    public static final String MINOR = String.valueOf(Info.MINOR);
     /**
      * Patch version of the Wrapper.
      */
-    public static final String PATCH = "2";
+    public static final String PATCH = String.valueOf(Info.PATCH);
     
     /**
      * Full version in the format {@code major.minor.patch}.
diff --git a/core/src/main/java/org/botblock/javabotblockapi/core/Site.java b/core/src/main/java/org/botblock/javabotblockapi/core/Site.java
@@ -18,6 +18,9 @@
 
 package org.botblock.javabotblockapi.core;
 
+import org.botblock.javabotblockapi.core.annotations.DeprecatedSince;
+import org.botblock.javabotblockapi.core.annotations.PlannedRemoval;
+
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -108,9 +111,14 @@ public class Site{
      *     <li>GET</li>
      * </ul>
      * 
+     * @deprecated Site no longer available.
+     * 
      * @since 6.4.1
      */
-    public static final Site BOTS_DISTOP_XYZ = new Site("bots.distop.xyz", HttpMethod.POST);
+    @Deprecated
+    @DeprecatedSince(major = 6, minor = 6, patch = 1)
+    @PlannedRemoval(major = 6, minor = 6, patch = 3)
+    public static final Site BOTS_DISTOP_XYZ = new Site("bots.distop.xyz");
     
     /**
      * <a href="https://botsfordiscord.com" target="_blank">botsfordiscord.com</a>
@@ -131,8 +139,13 @@ public class Site{
      *     <li>GET</li>
      *     <li>POST</li>
      * </ul>
+     * 
+     * @deprecated Site no longer available.
      */
-    public static final Site BOTS_IDLEDEV_ORG = new Site("bots.idledev.org", HttpMethod.GET, HttpMethod.POST);
+    @Deprecated
+    @DeprecatedSince(major = 6, minor = 6, patch = 1)
+    @PlannedRemoval(major = 6, minor = 6, patch = 3)
+    public static final Site BOTS_IDLEDEV_ORG = new Site("bots.idledev.org");
     
     /**
      * <a href="https://bots.ondiscord.xyz" target="_blank">bots.ondiscord.xyz</a>
@@ -255,6 +268,17 @@ public class Site{
      */
     public static final Site DISFORGE_COM = new Site("disforge.com", HttpMethod.POST);
     
+    /**
+     * <a href="https://fasteslist.xyz" target="_blank">fateslist.xyz</a>
+     * 
+     * <p>Supported methods:
+     * <ul>
+     *     <li>GET</li>
+     *     <li>POST</li>
+     * </ul>
+     */
+    public static final Site FATESLIST_XYZ = new Site("fateslist.xyz", HttpMethod.GET, HttpMethod.POST);
+    
     /**
      * <a href="https://infinitybotlist.com" target="_blank">infinitybotlist.com</a>
      *

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ plugins{`
`7`	`7`	`id 'com.github.johnrengelman.shadow' version '5.2.0'`
`8`	`8`	`}`
`9`	`9`
`10`		`-def ver = new Version(major: 6, minor: 5, patch: 0)`
	`10`	`+def ver = new Version(major: 6, minor: 6, patch: 1)`
`11`	`11`
`12`	`12`	`allprojects {`
`13`	`13`	`apply plugin: 'maven-publish'`