From eb5af1b83b5ed4e339db422861893863f31a2c65 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 5 Apr 2021 05:24:57 +0000 Subject: [PATCH 1/8] Bump javacord from 3.1.2 to 3.2.0 Bumps [javacord](https://github.com/Javacord/Javacord) from 3.1.2 to 3.2.0. - [Release notes](https://github.com/Javacord/Javacord/releases) - [Commits](https://github.com/Javacord/Javacord/compare/v3.1.2...v3.2.0) Signed-off-by: dependabot[bot] --- javacord/build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/javacord/build.gradle b/javacord/build.gradle index 3a90724c..00999a3b 100644 --- a/javacord/build.gradle +++ b/javacord/build.gradle @@ -1,5 +1,5 @@ dependencies { - api group: 'org.javacord', name: 'javacord', version: '3.1.2' + api group: 'org.javacord', name: 'javacord', version: '3.2.0' implementation project(":core") implementation project(":request") } From 4fea7ff69fe72d23fe51221635b71a4d04c5879b Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Tue, 6 Apr 2021 00:16:22 +0200 Subject: [PATCH 2/8] Redesign contributors.md --- contributors.md | 168 ++++++++++++++++++++++++++++++++---------------- 1 file changed, 112 insertions(+), 56 deletions(-) diff --git a/contributors.md b/contributors.md index 48a255a2..e2600ccc 100644 --- a/contributors.md +++ b/contributors.md @@ -1,58 +1,114 @@ - -[contributorsBadge]: https://img.shields.io/badge/Contributors_✨-10-green.svg?style=plastic - +[all-contributors]: https://allcontributors.org +[emojis]: https://allcontributors.org/docs/en/emoji-key + + +[dv8fromtheworld]: https://github.com/DV8FromTheWorld +[jda]: https://github.com/DV8FromTheWorld/JDA + + +[benmanes]: https://github.com/ben-manes +[caffeine]: https://github.com/ben-manes/Caffeine + + +[codemc]: https://github.com/codemc + + +[davidrockin]: https://github.com/DavidRockin +[david_comment]: https://github.com/botblock/JavaBotBlockAPI/pull/3#issuecomment-522036554 + + +[dependabot]: https://github.com/Dependabot + + +[ghostchu]: https://github.com/ghost-chu +[ghostchu_commits]: https://github.com/botblock/JavaBotBlockAPI/commits?author=ghost-chu + + +[javacord]: https://github.com/javacord +[javacord-lib]: https://github.com/javacord/Javacord + + +[stleary]: https://github.com/stleary +[json-java]: https://github.com/stleary/JSON-java + + +[square]: https://github.com/square +[okhttp]: https://github.com/square/OkHttp # Contributors -![contributorsBadge] - -We appreciate any kind of contribution to the JavaBotBlockAPI, as it is our goal to improve over time. - -Contributions aren't just limited to PRs or code examples. -Bug reports, suggestions or general feedback to upcoming features are always apreciated and welcome. - -# Emoji keys -We use different Emojis as "Keys" to summarize what kind of contributions are under this category. - -Below can you see a list of all currently listed emojis, their category and meaning. -A full list of all available categories can be found [here](https://allcontributors.org/docs/en/emoji-key). - -- 🤔 (Ideas) -Suggesting new features, improvements or giving general feedback. -- 🔌 (Plugin) -Developed a library used by this project. -- 🚇 (Infra) -Provides a site, service or similar that is used by the project (e.g. CI-Server). -- 🚧 (Maintenance) -Helps maintaining this project, being it updating dependencies, or adding new features. -- 📖 (Documentation) -Helped updating or improving the documentation of this project. -- 💻(Code) -Contributed Code to improve the Project. - -# List of contributors -Below can you find a list of all currently aknowledged Contributors to our project. - - - - - - - - - - - - - - - - - - - -

Dave
🤔
Austin Keener
🔌
CodeMC
🚇
Dependabot
🚧
Ben Manes
🔌
Square
🔌
JetBrains
🔌

Sean Leary
🔌
Casey Brooks
💻 📖
Ghost_chu
💻
- - - - - +We aknowledge all contributions made to the project, be it Pull requests or even something simple like feedback and/or suggestions. + +To thank every contributor did we adobt the [All Contributors][all-contributors] system and adjusted it slightly. +This page lists every user/organisation who contributed to the project in some way. Please see the [Categories](#categories) below for an explanation about the different Emojis and their meaning. + +## Categories +This file follows a similar system like the All Contributors [Emoji Key System][emojis]. +Each Category has their own emoji which is listed here. + +### 💻 Code +Contributed code towards the project. +This can be through Pull requests or, if having the rights for, through direct commits. + +Will have a link to all commits made by this User/Bot/Organisation. + +### 🤔 Feedback/Ideas +Gave Ideas and or general feedback to improve the project. +Will have links to all issues, Pull requests, Discussions and general comments the User/Organisation made. + +### 🚇 Infrastructure +Provides a place to host the project, jar files, documentation or similar. +A common example would be a CI (Jenkins) Server. + +### 🚧 Maintenance +Helps keeping the project running through actions such as keeping dependencies up to date. + +### 🔌 Plugin(s) +Provides one or multiple dependencies used by the project. +A link to the Project(s) will be provided. + +## Contributors +Here is a list of all the Contributors to our project and how they contributed to this project. + +### [Austin Keener][dv8fromtheworld] + +> Contributions: [🔌](#plugins "Plugin(s)") ([JDA]) + +---- +### [Ben Manes][benmanes] + +> Contribution: [🔌](#plugins "Plugin(s)") ([Caffeine]) + +---- +### [CodeMC][codemc] + +> Contributions: [🚇](#infrastructure "Infrastructure") + +---- +### [Dave][davidrockin] + +> Contributions: [🤔](#feedbackideas "Feedback/Ideas") ([#3 (Comment)][david_comment]) + +---- +### [Dependabot] + +> Contributions: [🚧](#maintenance "Maintenance") + +---- +### [Ghost_chu][ghostchu] + +> Contributions: [💻](#code "Code") ([Commits][ghostchu_commits]) + +---- +### [Javacord] + +> Contribution: [🔌](#plugins "Plugin(s)") ([Javacord][javacord-lib]) + +---- +### [Sean Leary][stleary] + +> Contribution: [🔌](#plugins "Plugin(s)") ([JSON-java][json-java]) + +---- +### [Square][square] + +> Contribution: [🔌](#plugins "Plugin(s)") ([OkHttp]) From a447c7a8ad12b80d3f5e48e1ceb28a407fccb0d1 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Tue, 6 Apr 2021 00:18:25 +0200 Subject: [PATCH 3/8] fix category links --- contributors.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/contributors.md b/contributors.md index e2600ccc..1c0353d9 100644 --- a/contributors.md +++ b/contributors.md @@ -71,44 +71,44 @@ Here is a list of all the Contributors to our project and how they contributed t ### [Austin Keener][dv8fromtheworld] -> Contributions: [🔌](#plugins "Plugin(s)") ([JDA]) +> Contributions: [🔌](#-plugins "Plugin(s)") ([JDA]) ---- ### [Ben Manes][benmanes] -> Contribution: [🔌](#plugins "Plugin(s)") ([Caffeine]) +> Contribution: [🔌](#-plugins "Plugin(s)") ([Caffeine]) ---- ### [CodeMC][codemc] -> Contributions: [🚇](#infrastructure "Infrastructure") +> Contributions: [🚇](#-infrastructure "Infrastructure") ---- ### [Dave][davidrockin] -> Contributions: [🤔](#feedbackideas "Feedback/Ideas") ([#3 (Comment)][david_comment]) +> Contributions: [🤔](#-feedbackideas "Feedback/Ideas") ([#3 (Comment)][david_comment]) ---- ### [Dependabot] -> Contributions: [🚧](#maintenance "Maintenance") +> Contributions: [🚧](#-maintenance "Maintenance") ---- ### [Ghost_chu][ghostchu] -> Contributions: [💻](#code "Code") ([Commits][ghostchu_commits]) +> Contributions: [💻](#-code "Code") ([Commits][ghostchu_commits]) ---- ### [Javacord] -> Contribution: [🔌](#plugins "Plugin(s)") ([Javacord][javacord-lib]) +> Contribution: [🔌](#-plugins "Plugin(s)") ([Javacord][javacord-lib]) ---- ### [Sean Leary][stleary] -> Contribution: [🔌](#plugins "Plugin(s)") ([JSON-java][json-java]) +> Contribution: [🔌](#-plugins "Plugin(s)") ([JSON-java][json-java]) ---- ### [Square][square] -> Contribution: [🔌](#plugins "Plugin(s)") ([OkHttp]) +> Contribution: [🔌](#-plugins "Plugin(s)") ([OkHttp]) From d6f143ac441ac1a4843691e7ffbc5621bb494085 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 6 Apr 2021 05:16:33 +0000 Subject: [PATCH 4/8] Bump actions/setup-java from v1 to v2 Bumps [actions/setup-java](https://github.com/actions/setup-java) from v1 to v2. - [Release notes](https://github.com/actions/setup-java/releases) - [Commits](https://github.com/actions/setup-java/compare/v1...8764a52df183aa0ccea74521dfd9d506ffc7a19a) Signed-off-by: dependabot[bot] --- .github/workflows/generate_javadoc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/generate_javadoc.yml b/.github/workflows/generate_javadoc.yml index 102abcc9..853031a0 100644 --- a/.github/workflows/generate_javadoc.yml +++ b/.github/workflows/generate_javadoc.yml @@ -15,7 +15,7 @@ jobs: with: ref: 'master' - name: Set up Java 11 - uses: actions/setup-java@v1 + uses: actions/setup-java@v2 with: java-version: 1.11 - name: Generate Javadoc @@ -34,7 +34,7 @@ jobs: - name: Checkout Code uses: actions/checkout@v2.3.4 - name: Set up Java 11 - uses: actions/setup-java@v1 + uses: actions/setup-java@v2 with: java-version: 1.11 - name: Generate Jars From e2546cded363adb523630a1d7335233c039f3e2d Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Tue, 6 Apr 2021 18:30:40 +0200 Subject: [PATCH 5/8] Add render option for code section --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 4ed61beb..11c87063 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -77,6 +77,7 @@ body: throw new Exception("ERROR"); } ``` + render: "java" validations: required: true - type: input From c7fa1e812c08656b67eb5bb3430348035b97a18f Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Tue, 6 Apr 2021 18:31:12 +0200 Subject: [PATCH 6/8] Add render option for code example --- .github/ISSUE_TEMPLATE/feature_request.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 3c175110..e11098c8 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -35,6 +35,7 @@ body: ```java public boolean method(){ return true; } ``` + render: "java" - type: textarea attributes: label: "Additional Information" From 9df097af8d1c67e5a37aa1014a3420aeb885ab84 Mon Sep 17 00:00:00 2001 From: Andre601 <11576465+Andre601@users.noreply.github.com> Date: Tue, 6 Apr 2021 18:50:59 +0200 Subject: [PATCH 7/8] Improve Javadoc cpmment and bump version --- build.gradle | 2 +- .../botblock/javabotblockapi/core/Info.java | 2 +- .../botblock/javabotblockapi/core/Site.java | 36 +++++++++---------- 3 files changed, 18 insertions(+), 22 deletions(-) diff --git a/build.gradle b/build.gradle index 760044fb..228583f2 100644 --- 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: 6, patch: 4) +def ver = new Version(major: 6, minor: 6, patch: 5) 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 index 9a2d5d5a..242ddead 100644 --- a/core/src/main/java/org/botblock/javabotblockapi/core/Info.java +++ b/core/src/main/java/org/botblock/javabotblockapi/core/Info.java @@ -39,7 +39,7 @@ public class Info{ /** * Patch version of the Wrapper. */ - public static final int PATCH = 4; + public static final int PATCH = 5; /** * 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 index d70bdbc7..2ddffc77 100644 --- a/core/src/main/java/org/botblock/javabotblockapi/core/Site.java +++ b/core/src/main/java/org/botblock/javabotblockapi/core/Site.java @@ -26,11 +26,23 @@ import java.util.List; /** - * Class containing all (known) Bot lists. - *
The static instances of this class allow the easy use within various methods of the JavaBotBlockAPI. + * This class contains all known sites that are supported by BotBlock's APIs for getting Bot info, getting list info or + * posting Bot info to a list. * - *

Keep in mind that not all Sites support either GET or POST requests. You may use {@link #supportsGet() supportsGet()} - * or {@link #supportsPost() supportsPost()} methods to check whether the instance supports GET and/or POST respectively. + *

The static instances of this class allow an easy and quick usage in various methods of JavaBotBlockAPI without the + * need to remember any bot list name. + * + *

Supported HTTP Methods

+ * The Javadoc comment of each instance lists what HTTP method is supported. + *
If a List supports GET can you use all methods from the GetListAction and GetBotAction classes of the Request module + * while Lists supporting POST also can be utilized within the {@link org.botblock.javabotblockapi.core.BotBlockAPI BotBlockAPI} + * to posts Bot information to that list. + * + *

Trying to use a List for an action it doesn't support (i.e. using a List for POST while it only supports GET) will + * result in exceptions being thrown. + *
Instances marked as Deprecated won't support either method type. If a replacement is mentioned using the + * {@link org.botblock.javabotblockapi.core.annotations.DeprecatedSince DeprecatedSince's} replacement value should it + * be used in favour of the deprecated Instance. * * @since 6.3.0 */ @@ -70,22 +82,6 @@ public class Site{ */ public static final Site BLIST_XYZ = new Site("blist.xyz", HttpMethod.GET, HttpMethod.POST); - /** - * botlist.space - * - *

Supported methods: - *

- * - * @deprecated Domain changed to {@link #DISCORDLIST_SPACE discordlist.space} - */ - @Deprecated - @DeprecatedSince(major = 6, minor = 6, patch = 3, replacements = {"DISCORDLIST_SPACE"}) - @PlannedRemoval(major = 6, minor = 6, patch = 5) - public static final Site BOTLIST_SPACE = new Site("botlist.space"); - /** * botsdatabase.com * From 83300aed51a1ca6f9b453a0f17fa74eb33ed2739 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 7 Apr 2021 05:16:56 +0000 Subject: [PATCH 8/8] Bump javacord from 3.2.0 to 3.3.0 Bumps [javacord](https://github.com/Javacord/Javacord) from 3.2.0 to 3.3.0. - [Release notes](https://github.com/Javacord/Javacord/releases) - [Commits](https://github.com/Javacord/Javacord/compare/v3.2.0...v3.3.0) Signed-off-by: dependabot[bot] --- javacord/build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/javacord/build.gradle b/javacord/build.gradle index 00999a3b..45c6a2c2 100644 --- a/javacord/build.gradle +++ b/javacord/build.gradle @@ -1,5 +1,5 @@ dependencies { - api group: 'org.javacord', name: 'javacord', version: '3.2.0' + api group: 'org.javacord', name: 'javacord', version: '3.3.0' implementation project(":core") implementation project(":request") }