Update dependency org.apache.httpcomponents.client5:httpclient5 to v5.4.1

Reviewed-on: #16

.gitea/workflows/publish.yml

@@ -23,7 +23,7 @@ jobs:
 
       # Setup Java and Maven
       - name: Set up JDK and Maven
-        uses: s4u/setup-maven-action@v1.12.0
+        uses: s4u/setup-maven-action@v1.14.0
         with:
           java-version: ${{ matrix.java-version }}
           distribution: "zulu"

README.md

@@ -1,35 +1,3 @@
 # Minecraft Utilities - Java Library
 
-The Java library for the Minecraft Utilities API.
-
-## Usage
-
-Maven:
-
-```xml
-<repositories>
-    <repository>
-        <id>fascinated-repo-public</id>
-        <name>Fascinated's Repository</name>
-        <url>https://repo.fascinated.cc/public</url>
-    </repository>
-</repositories>
-
-<dependencies>
-    <dependency>
-        <groupId>xyz.mcutils</groupId>
-        <artifactId>mcutils-java-library</artifactId>
-        <version>1.1</version>
-    </dependency>
-</dependencies>
-```
-
-Usage:
-
-```java
-public class Main {
-    public static void main(String[] args) {
-        System.out.println(McUtilsAPI.getPlayer("Notch"));
-    }
-}
-```
+See [The Website](https://mcutils.xyz) or [Minecraft Utilities Documentation](https://mcutils.xyz/docs) for more information.

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>xyz.mcutils</groupId>
     <artifactId>mcutils-java-library</artifactId>
-    <version>1.1</version>
+    <version>1.2.4</version>
 
     <properties>
         <maven.compiler.source>17</maven.compiler.source>
@@ -28,7 +28,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>
-                <version>3.2.4</version>
+                <version>3.6.0</version>
                 <executions>
                     <execution>
                         <phase>package</phase>
@@ -46,13 +46,13 @@
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
-            <version>1.18.32</version>
+            <version>1.18.34</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
-            <version>2.10.1</version>
+            <version>2.11.0</version>
             <scope>compile</scope>
         </dependency>
 
@@ -60,13 +60,13 @@
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-web</artifactId>
-            <version>6.1.6</version>
+            <version>6.1.13</version>
             <scope>compile</scope>
         </dependency>
         <dependency>
             <groupId>org.apache.httpcomponents.client5</groupId>
             <artifactId>httpclient5</artifactId>
-            <version>5.3</version>
+            <version>5.4.1</version>
             <scope>compile</scope>
         </dependency>
 
@@ -74,13 +74,13 @@
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-engine</artifactId>
-            <version>5.10.2</version>
+            <version>5.11.1</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>
-            <version>5.10.2</version>
+            <version>5.11.1</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ]
+}

src/main/java/xyz/mcutils/McUtilsAPI.java

@@ -2,10 +2,8 @@ package xyz.mcutils;
 
 import xyz.mcutils.common.WebRequest;
 import xyz.mcutils.exception.ErrorResponse;
-import xyz.mcutils.models.mojang.CachedMojangEndpointStatus;
-import xyz.mcutils.models.player.CachedPlayer;
-import xyz.mcutils.models.player.CachedPlayerSkinPart;
-import xyz.mcutils.models.player.CachedUsernameToUuid;
+import xyz.mcutils.models.cache.*;
+import xyz.mcutils.models.cache.CachedPlayerSkinPart;
 import xyz.mcutils.models.player.Skin;
 import xyz.mcutils.models.server.*;
 
@@ -17,6 +15,7 @@ public class McUtilsAPI {
     private static final String PLAYER_SKIN_PART_ENDPOINT = API_ENDPOINT + "/player/%s/%s";
     private static final String SERVER_ENDPOINT = API_ENDPOINT + "/server/%s/%s";
     private static final String SERVER_ICON_ENDPOINT = API_ENDPOINT + "/server/icon/%s";
+    private static final String SERVER_PREVIEW_ENDPOINT = API_ENDPOINT + "/server/%s/preview/%s";
     private static final String SERVER_BLOCKED_STATUS_ENDPOINT = API_ENDPOINT + "/server/blocked/%s";
 
     /**
@@ -109,4 +108,16 @@ public class McUtilsAPI {
     public static CachedServerBlockedStatus getServerBlockedStatus(String id) throws ErrorResponse {
         return WebRequest.get(SERVER_BLOCKED_STATUS_ENDPOINT.formatted(id), CachedServerBlockedStatus.class);
     }
+
+    /**
+     * Gets the icon of a Java server from the API.
+     *
+     * @param id The id of the server to get the icon of.
+     * @return The server icon.
+     * @throws ErrorResponse If an error occurs.
+     */
+    public static CachedServerPreview getServerPreview(ServerPlatform platform, String id) throws ErrorResponse {
+        byte[] bytes = WebRequest.get(SERVER_PREVIEW_ENDPOINT.formatted(platform.name(), id), byte[].class);
+        return new CachedServerPreview(bytes);
+    }
 }

src/main/java/xyz/mcutils/models/cache/CachedBedrockMinecraftServer.java

@@ -1,7 +1,8 @@
-package xyz.mcutils.models.server;
+package xyz.mcutils.models.cache;
 
 import lombok.Getter;
 import lombok.ToString;
+import xyz.mcutils.models.server.MinecraftServer;
 
 @Getter
 public class CachedBedrockMinecraftServer extends MinecraftServer {

src/main/java/xyz/mcutils/models/cache/CachedJavaMinecraftServer.java

@@ -1,7 +1,8 @@
-package xyz.mcutils.models.server;
+package xyz.mcutils.models.cache;
 
 import lombok.Getter;
 import lombok.ToString;
+import xyz.mcutils.models.server.MinecraftServer;
 
 @Getter
 public class CachedJavaMinecraftServer extends MinecraftServer {

src/main/java/xyz/mcutils/models/cache/CachedMojangEndpointStatus.java

@@ -0,0 +1,17 @@
+package xyz.mcutils.models.cache;
+
+import lombok.Getter;
+import lombok.ToString;
+import xyz.mcutils.models.CachedResponse;
+import xyz.mcutils.models.mojang.EndpointStatus;
+
+import java.util.List;
+
+@Getter @ToString
+public class CachedMojangEndpointStatus extends CachedResponse {
+
+    /**
+     * The list of endpoints and their status.
+     */
+    private List<EndpointStatus> endpoints;
+}

src/main/java/xyz/mcutils/models/cache/CachedPlayer.java

@@ -1,8 +1,10 @@
-package xyz.mcutils.models.player;
+package xyz.mcutils.models.cache;
 
 import lombok.Getter;
 import lombok.ToString;
 import xyz.mcutils.models.CachedResponse;
+import xyz.mcutils.models.player.Cape;
+import xyz.mcutils.models.player.Skin;
 
 import java.util.UUID;
 

src/main/java/xyz/mcutils/models/cache/CachedPlayerSkinPart.java

@@ -1,4 +1,4 @@
-package xyz.mcutils.models.player;
+package xyz.mcutils.models.cache;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

src/main/java/xyz/mcutils/models/cache/CachedServerBlockedStatus.java

@@ -1,4 +1,4 @@
-package xyz.mcutils.models.server;
+package xyz.mcutils.models.cache;
 
 import lombok.AllArgsConstructor;
 import lombok.Getter;

src/main/java/xyz/mcutils/models/cache/CachedServerPreview.java

@@ -0,0 +1,13 @@
+package xyz.mcutils.models.cache;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.ToString;
+
+@AllArgsConstructor @Getter @ToString
+public class CachedServerPreview {
+    /**
+     * The bytes for the skin part
+     */
+    private byte[] bytes;
+}

src/main/java/xyz/mcutils/models/cache/CachedUsernameToUuid.java

@@ -1,4 +1,4 @@
-package xyz.mcutils.models.player;
+package xyz.mcutils.models.cache;
 
 import lombok.Getter;
 import lombok.ToString;

src/main/java/xyz/mcutils/models/mojang/EndpointStatus.java

@@ -1,21 +1,28 @@
 package xyz.mcutils.models.mojang;
 
-import lombok.AllArgsConstructor;
 import lombok.Getter;
-import lombok.ToString;
-import xyz.mcutils.models.CachedResponse;
 
-import java.util.Map;
-
-@AllArgsConstructor
-@Getter @ToString
-public class CachedMojangEndpointStatus extends CachedResponse {
+@Getter
+public class EndpointStatus {
 
     /**
-     * The list of endpoints and their status.
+     * The name of the service.
      */
-    private Map<String, Status> endpoints;
+    private String name;
 
+    /**
+     * The hostname of the service.
+     */
+    private String hostname;
+
+    /**
+     * The status of the service.
+     */
+    private Status status;
+
+    /**
+     * Statuses for the endpoint.
+     */
     public enum Status {
         /**
          * The service is online and operational.
@@ -33,4 +40,4 @@ public class CachedMojangEndpointStatus extends CachedResponse {
          */
         OFFLINE
     }
-}
+}

src/main/java/xyz/mcutils/models/server/MinecraftServer.java

@@ -39,8 +39,13 @@ public class MinecraftServer {
      */
     private Players players;
 
-    @AllArgsConstructor @Getter
-    private static class MOTD {
+    /**
+     * The location of the server.
+     */
+    private GeoLocation location;
+
+    @Getter
+    public static class MOTD {
 
         /**
          * The raw motd lines
@@ -56,13 +61,18 @@ public class MinecraftServer {
          * The html motd lines
          */
         private String[] html;
+
+        /**
+         * The server list MOTD preview.
+         */
+        private String preview;
     }
 
     /**
      * Player count data for a server.
      */
     @Getter
-    private static class Players {
+    public static class Players {
         /**
          * The online players on this server.
          */
@@ -94,4 +104,35 @@ public class MinecraftServer {
             private String name;
         }
     }
+
+    /**
+     * The location of the server.
+     */
+    @Getter
+    public static class GeoLocation {
+        /**
+         * The country of the server.
+         */
+        private String country;
+
+        /**
+         * The region of the server.
+         */
+        private String region;
+
+        /**
+         * The city of the server.
+         */
+        private String city;
+
+        /**
+         * The latitude of the server.
+         */
+        private double latitude;
+
+        /**
+         * The longitude of the server.
+         */
+        private double longitude;
+    }
 }

src/test/java/xyz/mcutils/MojangTests.java

@@ -2,7 +2,7 @@ package xyz.mcutils;
 
 import lombok.SneakyThrows;
 import org.junit.jupiter.api.Test;
-import xyz.mcutils.models.mojang.CachedMojangEndpointStatus;
+import xyz.mcutils.models.cache.CachedMojangEndpointStatus;
 
 public class MojangTests {
 

src/test/java/xyz/mcutils/PlayerTests.java

@@ -3,9 +3,9 @@ package xyz.mcutils;
 import lombok.SneakyThrows;
 import org.junit.jupiter.api.Test;
 import xyz.mcutils.exception.ErrorResponse;
-import xyz.mcutils.models.player.CachedPlayer;
-import xyz.mcutils.models.player.CachedPlayerSkinPart;
-import xyz.mcutils.models.player.CachedUsernameToUuid;
+import xyz.mcutils.models.cache.CachedPlayer;
+import xyz.mcutils.models.cache.CachedPlayerSkinPart;
+import xyz.mcutils.models.cache.CachedUsernameToUuid;
 import xyz.mcutils.models.player.Skin;
 
 public class PlayerTests {

src/test/java/xyz/mcutils/ServerTests.java

@@ -3,10 +3,12 @@ package xyz.mcutils;
 import lombok.SneakyThrows;
 import org.junit.jupiter.api.Test;
 import xyz.mcutils.exception.ErrorResponse;
-import xyz.mcutils.models.server.CachedBedrockMinecraftServer;
-import xyz.mcutils.models.server.CachedJavaMinecraftServer;
-import xyz.mcutils.models.server.CachedServerBlockedStatus;
+import xyz.mcutils.models.cache.CachedBedrockMinecraftServer;
+import xyz.mcutils.models.cache.CachedJavaMinecraftServer;
+import xyz.mcutils.models.cache.CachedServerBlockedStatus;
+import xyz.mcutils.models.cache.CachedServerPreview;
 import xyz.mcutils.models.server.CachedServerIcon;
+import xyz.mcutils.models.server.ServerPlatform;
 
 public class ServerTests {
 
@@ -71,4 +73,38 @@ public class ServerTests {
             assert ex.getCode() == 400;
         }
     }
+
+    @Test
+    @SneakyThrows
+    public void ensureBedrockServerIconLookupSuccess() {
+        CachedServerIcon icon = McUtilsAPI.getServerIcon(testBedrockServer);
+        assert icon.getBytes() != null;
+    }
+
+    @Test
+    @SneakyThrows
+    public void ensureBedrockServerIconLookupFailure() {
+        try {
+            McUtilsAPI.getServerIcon(testInvalidServer);
+        } catch (ErrorResponse ex) {
+            assert ex.getCode() == 400;
+        }
+    }
+
+    @Test
+    @SneakyThrows
+    public void ensureServerPreviewLookupSuccess() {
+        CachedServerPreview icon = McUtilsAPI.getServerPreview(ServerPlatform.JAVA, testJavaServer);
+        assert icon.getBytes() != null;
+    }
+
+    @Test
+    @SneakyThrows
+    public void ensureServerPreviewLookupFailure() {
+        try {
+            McUtilsAPI.getServerPreview(ServerPlatform.JAVA, testInvalidServer);
+        } catch (ErrorResponse ex) {
+            assert ex.getCode() == 400;
+        }
+    }
 }