Optimized Controller classes

Author: jasonlessenich

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

@@ -5,14 +5,12 @@
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.entities.Guild;
 import net.javadiscord.javabot.Bot;
-import net.javadiscord.javabot.api.response.ApiResponseBuilder;
 import net.javadiscord.javabot.api.response.ApiResponses;
 import net.javadiscord.javabot.api.routes.CaffeineCache;
 import net.javadiscord.javabot.api.routes.metrics.model.MetricsData;
 import net.javadiscord.javabot.data.config.guild.MetricsConfig;
 import org.springframework.beans.factory.annotation.Autowired;
 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;
@@ -49,10 +47,9 @@ public MetricsController(final JDA jda) {
 	 * @return The {@link ResponseEntity}.
 	 */
 	@GetMapping(
-			value = "{guild_id}/metrics",
-			produces = MediaType.APPLICATION_JSON_VALUE
+			value = "{guild_id}/metrics"
 	)
-	public ResponseEntity<String> getMetrics(@PathVariable(value = "guild_id") String guildId) {
+	public ResponseEntity<?> getMetrics(@PathVariable(value = "guild_id") long guildId) {
 		Guild guild = jda.getGuildById(guildId);
 		if (guild == null) {
 			return new ResponseEntity<>(ApiResponses.INVALID_GUILD_IN_REQUEST, HttpStatus.BAD_REQUEST);
@@ -67,6 +64,6 @@ public ResponseEntity<String> getMetrics(@PathVariable(value = "guild_id") Strin
 			data.setActiveMembers(config.getActiveMembers());
 			getCache().put(guild.getIdLong(), data);
 		}
-		return new ResponseEntity<>(new ApiResponseBuilder().add("metrics", data).build(), HttpStatus.OK);
+		return new ResponseEntity<>(data, HttpStatus.OK);
 	}
 }

src/main/java/net/javadiscord/javabot/api/routes/metrics/model/MetricsData.java

@@ -1,12 +1,14 @@
 package net.javadiscord.javabot.api.routes.metrics.model;
 
 import lombok.Data;
+import lombok.EqualsAndHashCode;
 
 /**
  * API-Data class which contains all necessary information about a guilds'
  * metrics.
  */
 @Data
+@EqualsAndHashCode(callSuper = false)
 public class MetricsData {
 	private long memberCount;
 	private long onlineCount;

src/main/java/net/javadiscord/javabot/api/routes/qotw_leaderboard/QOTWLeaderboardController.java

@@ -4,12 +4,10 @@
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.entities.Guild;
 import net.javadiscord.javabot.Bot;
-import net.javadiscord.javabot.api.response.ApiResponseBuilder;
 import net.javadiscord.javabot.api.response.ApiResponses;
 import net.javadiscord.javabot.api.routes.CaffeineCache;
 import net.javadiscord.javabot.api.routes.qotw_leaderboard.model.QOTWMemberData;
 import net.javadiscord.javabot.systems.qotw.QOTWPointsService;
-import net.javadiscord.javabot.util.Checks;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
@@ -48,25 +46,21 @@ public QOTWLeaderboardController(final JDA jda) {
 	 * amount of qotw-points.
 	 *
 	 * @param guildId     The guilds' id.
-	 * @param amountParam The amount of users to return. Defaults to 3.
+	 * @param amount The amount of users to return. Defaults to 3.
 	 * @return The {@link ResponseEntity}.
 	 */
 	@GetMapping(
 			value = "{guild_id}/qotw/leaderboard",
 			produces = MediaType.APPLICATION_JSON_VALUE
 	)
-	public ResponseEntity<String> getQOTWLeaderboard(
-			@PathVariable(value = "guild_id") String guildId,
-			@RequestParam(value = "amount", defaultValue = "3") String amountParam
+	public ResponseEntity<?> getQOTWLeaderboard(
+			@PathVariable(value = "guild_id") long guildId,
+			@RequestParam(value = "amount", defaultValue = "3") int amount
 	) {
 		Guild guild = jda.getGuildById(guildId);
 		if (guild == null) {
 			return new ResponseEntity<>(ApiResponses.INVALID_GUILD_IN_REQUEST, HttpStatus.BAD_REQUEST);
 		}
-		if (!Checks.checkInteger(amountParam)) {
-			return new ResponseEntity<>(ApiResponses.INVALID_NUMBER_IN_REQUEST, HttpStatus.BAD_REQUEST);
-		}
-		int amount = Integer.parseInt(amountParam);
 		QOTWPointsService service = new QOTWPointsService(Bot.getDataSource());
 		List<QOTWMemberData> members = getCache().getIfPresent(guild.getIdLong());
 		if (members == null || members.isEmpty()) {
@@ -83,6 +77,6 @@ public ResponseEntity<String> getQOTWLeaderboard(
 					.toList();
 			getCache().put(guild.getIdLong(), members);
 		}
-		return new ResponseEntity<>(new ApiResponseBuilder().add("leaderboard", members.stream().limit(amount).toList()).build(), HttpStatus.OK);
+		return new ResponseEntity<>(members.stream().limit(amount).toList(), HttpStatus.OK);
 	}
 }

src/main/java/net/javadiscord/javabot/api/routes/qotw_leaderboard/model/QOTWMemberData.java

@@ -5,7 +5,7 @@
 
 /**
  * API-Data class which contains all necessary information about a single users'
- * qotw account.
+ * QOTW-Account.
  */
 @Data
 public class QOTWMemberData {

src/main/java/net/javadiscord/javabot/api/routes/user_profile/UserProfileController.java

@@ -5,7 +5,6 @@
 import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.User;
 import net.javadiscord.javabot.Bot;
-import net.javadiscord.javabot.api.response.ApiResponseBuilder;
 import net.javadiscord.javabot.api.response.ApiResponses;
 import net.javadiscord.javabot.api.routes.CaffeineCache;
 import net.javadiscord.javabot.api.routes.user_profile.model.HelpAccountData;
@@ -67,9 +66,9 @@ public UserProfileController(final JDA jda) {
 			value = "{guild_id}/{user_id}",
 			produces = MediaType.APPLICATION_JSON_VALUE
 	)
-	public ResponseEntity<String> getUserProfile(
-			@PathVariable(value = "guild_id") String guildId,
-			@PathVariable(value = "user_id") String userId
+	public ResponseEntity<?> getUserProfile(
+			@PathVariable(value = "guild_id") long guildId,
+			@PathVariable(value = "user_id") long userId
 	) {
 		Guild guild = jda.getGuildById(guildId);
 		if (guild == null) {
@@ -107,7 +106,7 @@ public ResponseEntity<String> getUserProfile(
 				// Insert into cache
 				getCache().put(new Pair<>(guild.getIdLong(), user.getIdLong()), data);
 			}
-			return new ResponseEntity<>(new ApiResponseBuilder().add("profile", data).build(), HttpStatus.OK);
+			return new ResponseEntity<>(data, HttpStatus.OK);
 		} catch (SQLException e) {
 			ExceptionLogger.capture(e, getClass().getSimpleName());
 			return new ResponseEntity<>(ApiResponses.INTERNAL_SERVER_ERROR, HttpStatus.INTERNAL_SERVER_ERROR);

src/main/java/net/javadiscord/javabot/util/Checks.java

@@ -103,21 +103,6 @@ public static boolean checkColor(String nm) {
 		}
 	}
 
-	/**
-	 * Checks if the specified string is a valid {@link Integer}.
-	 *
-	 * @param integer The provided integer, as a string.
-	 * @return Whether the specified string is a valid {@link Integer}.
-	 */
-	public static boolean checkInteger(String integer) {
-		try {
-			int value = Integer.parseInt(integer);
-			return true;
-		} catch (NumberFormatException e) {
-			return false;
-		}
-	}
-
 	public static boolean checkHexColor(String hex) {
 		return HEX_PATTERN.matcher(hex).matches();
 	}