Added {guild_id}/metrics, {guild_id}/qotw/leaderboard & {guild_id}/{user_id} routes

Author: jasonlessenich

build.gradle.kts

@@ -33,6 +33,9 @@ dependencies {
     // Discord OAuth2
     implementation("com.github.Mokulu:discord-oauth2-api:1.0.2")
 
+    // Caffeine (Caching Library)
+    implementation("com.github.ben-manes.caffeine:caffeine:3.1.0")
+
     implementation("com.google.code.gson:gson:2.9.0")
     implementation("org.yaml:snakeyaml:1.30")
     implementation("com.google.re2j:re2j:1.6")

src/main/java/net/javadiscord/javabot/Bot.java

@@ -127,6 +127,7 @@ public static void main(String[] args) throws Exception {
 		dih4jda = DIH4JDABuilder.setJDA(jda)
 				.setCommandsPackage("net.javadiscord.javabot")
 				.setDefaultCommandType(RegistrationType.GLOBAL)
+				.disableLogging()
 				.build();
 		SystemsConfig.ApiConfig apiConfig = config.getSystems().getApiConfig();
 		oAuth = new DiscordOAuth(jda.getSelfUser().getApplicationId(), apiConfig.getClientSecret(), apiConfig.getRedirectUrl(), apiConfig.getScopes());

src/main/java/net/javadiscord/javabot/api/gson/GsonColorAdapter.java

@@ -0,0 +1,22 @@
+package net.javadiscord.javabot.api.gson;
+
+import com.google.gson.*;
+import org.jetbrains.annotations.NotNull;
+
+import java.awt.*;
+import java.lang.reflect.Type;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+
+public class GsonColorAdapter implements JsonSerializer<Color>, JsonDeserializer<Color> {
+
+	@Override
+	public Color deserialize(@NotNull JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {
+		return Color.decode(jsonElement.getAsString());
+	}
+
+	@Override
+	public JsonPrimitive serialize(@NotNull Color color, Type type, JsonSerializationContext jsonSerializationContext) {
+		return new JsonPrimitive("#" + Integer.toHexString(color.getRGB()).substring(2).toUpperCase());
+	}
+}

src/main/java/net/javadiscord/javabot/api/gson/GsonLocalDateTimeAdapter.java

@@ -0,0 +1,20 @@
+package net.javadiscord.javabot.api.gson;
+
+import com.google.gson.*;
+
+import java.lang.reflect.Type;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+
+public class GsonLocalDateTimeAdapter implements JsonSerializer<LocalDateTime>, JsonDeserializer<LocalDateTime> {
+
+	@Override
+	public LocalDateTime deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {
+		return LocalDateTime.parse(jsonElement.getAsString(), DateTimeFormatter.ISO_LOCAL_DATE_TIME);
+	}
+
+	@Override
+	public JsonElement serialize(LocalDateTime localDateTime, Type type, JsonSerializationContext jsonSerializationContext) {
+		return new JsonPrimitive(localDateTime.format(DateTimeFormatter.ISO_LOCAL_DATE_TIME));
+	}
+}

src/main/java/net/javadiscord/javabot/api/model/QOTWLeaderboardData.java

@@ -0,0 +1,35 @@
+package net.javadiscord.javabot.api.response;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import net.javadiscord.javabot.api.gson.GsonColorAdapter;
+import net.javadiscord.javabot.api.gson.GsonLocalDateTimeAdapter;
+
+import java.awt.*;
+import java.time.LocalDateTime;
+import java.util.HashMap;
+import java.util.Map;
+
+public class ApiResponseBuilder {
+
+	private final Gson gson;
+	private final Map<String, Object> params;
+
+	public ApiResponseBuilder() {
+		gson = new GsonBuilder()
+				.setPrettyPrinting()
+				.registerTypeAdapter(LocalDateTime.class, new GsonLocalDateTimeAdapter())
+				.registerTypeAdapter(Color.class, new GsonColorAdapter())
+				.create();
+		params = new HashMap<>();
+	}
+
+	public ApiResponseBuilder add(String param, Object value) {
+		params.put(param, value);
+		return this;
+	}
+
+	public String build() {
+		return gson.toJson(params);
+	}
+}

src/main/java/net/javadiscord/javabot/api/response/ApiResponseBuilder.java

@@ -0,0 +1,15 @@
+package net.javadiscord.javabot.api.response;
+
+public class ApiResponses {
+		public static String INTERNAL_SERVER_ERROR = buildError("internal_server_error", "Internal server error encountered");
+		public static String NOT_FOUND_ERROR = buildError("not_found", "Resource not found");
+		public static String BAD_REQUEST = buildError("bad_request", "Bad Request");
+		public static String REQUEST_METHOD_NOT_SUPPORTED = buildError("unsupported_method", "Request method not supported");
+		public static String INVALID_GUILD_IN_REQUEST = buildError("invalid_guild", "Invalid 'guild_id' in request");
+		public static String INVALID_USER_IN_REQUEST = buildError("invalid_user", "Invalid 'user_id' in request");
+		public static String INVALID_NUMBER_IN_REQUEST = buildError("invalid_number", "Invalid number in request");
+
+		private static String buildError(String name, String description) {
+			return new ApiResponseBuilder().add("error", name).add("error_description", description).build();
+		}
+}

src/main/java/net/javadiscord/javabot/api/response/ApiResponses.java

@@ -0,0 +1,10 @@
+package net.javadiscord.javabot.api.routes;
+
+import net.dv8tion.jda.api.JDA;
+import net.javadiscord.javabot.Bot;
+
+public interface JDAEntity {
+	default JDA getJDA() {
+		return Bot.getDih4jda().getJDA();
+	}
+}

src/main/java/net/javadiscord/javabot/api/routes/JDAEntity.java

@@ -0,0 +1,43 @@
+package net.javadiscord.javabot.api.routes.metrics;
+
+import lombok.extern.slf4j.Slf4j;
+import net.dv8tion.jda.api.entities.Guild;
+import net.javadiscord.javabot.api.response.ApiResponseBuilder;
+import net.javadiscord.javabot.api.response.ApiResponses;
+import net.javadiscord.javabot.api.routes.JDAEntity;
+import net.javadiscord.javabot.api.routes.metrics.model.MetricsData;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Handles all GET-Requests on the {guild_id}/metrics route.
+ */
+@Slf4j
+@RestController
+public class MetricsController implements JDAEntity {
+
+	/**
+	 * Serves metrics for the specified guild.
+	 *
+	 * @param guildId The guilds' id.
+	 * @return The {@link ResponseEntity}.
+	 */
+	@GetMapping(
+			value = "{guild_id}/metrics",
+			produces = MediaType.APPLICATION_JSON_VALUE
+	)
+	public ResponseEntity<String> getMetrics(@PathVariable(value = "guild_id") String guildId) {
+		Guild guild = getJDA().getGuildById(guildId);
+		if (guild == null) {
+			return new ResponseEntity<>(ApiResponses.INVALID_GUILD_IN_REQUEST, HttpStatus.BAD_REQUEST);
+		}
+		MetricsData data = new MetricsData();
+		data.setMemberCount(guild.getMemberCount());
+		data.setOnlineCount(guild.retrieveMetaData().complete().getApproximatePresences());
+		return new ResponseEntity<>(new ApiResponseBuilder().add("metrics", data).build(), HttpStatus.OK);
+	}
+}

src/main/java/net/javadiscord/javabot/api/routes/metrics/MetricsController.java

@@ -1,4 +1,4 @@
-package net.javadiscord.javabot.api.model;
+package net.javadiscord.javabot.api.routes.metrics.model;
 
 import lombok.Data;