api v2 #30
Open
api v2 #30
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThis pull request updates components that interact with the Kiai API. In the Changes
Sequence Diagram(s)sequenceDiagram
participant C as Client
participant K as Kiai API Handler
participant A as Kiai API
C->>K: Invoke getUser(guildId, userId)
K->>A: Send HTTP request (endpoint without "/guild/" prefix)
A-->>K: Return JSON response with user data
K->>K: Parse JSON using Gson into User object
K-->>C: Return CompletableFuture<User>
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (4)
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
src/main/java/com/buape/kiaimc/api/User.java (1)
3-14: Add constructor and field validations.Consider the following improvements:
- Add a constructor to initialize fields.
- Add
@Nullableannotation for potentially nullable fields likerankCardBackground.- Add validation for numeric fields to ensure they are non-negative.
+import javax.annotation.Nullable; + public class User { private String id; private String guildId; private int currentLevel; private int nextLevel; private int nextLevelXp; private int xp; private int messagesSent; private int voiceMinutes; + @Nullable private String rankCardBackground; private int currentXpStreak; private boolean streakDoneToday; + + public User(String id, String guildId, int currentLevel, int nextLevel, + int nextLevelXp, int xp, int messagesSent, int voiceMinutes, + @Nullable String rankCardBackground, int currentXpStreak, + boolean streakDoneToday) { + this.id = id; + this.guildId = guildId; + this.currentLevel = validateNonNegative(currentLevel, "currentLevel"); + this.nextLevel = validateNonNegative(nextLevel, "nextLevel"); + this.nextLevelXp = validateNonNegative(nextLevelXp, "nextLevelXp"); + this.xp = validateNonNegative(xp, "xp"); + this.messagesSent = validateNonNegative(messagesSent, "messagesSent"); + this.voiceMinutes = validateNonNegative(voiceMinutes, "voiceMinutes"); + this.rankCardBackground = rankCardBackground; + this.currentXpStreak = validateNonNegative(currentXpStreak, "currentXpStreak"); + this.streakDoneToday = streakDoneToday; + } + + private static int validateNonNegative(int value, String fieldName) { + if (value < 0) { + throw new IllegalArgumentException(fieldName + " cannot be negative"); + } + return value; + }src/main/java/com/buape/kiaimc/api/Kiai.java (1)
12-12: Configure Gson for robust JSON handling.Consider configuring Gson with custom type adapters and null handling:
- private static final Gson gson = new Gson(); + private static final Gson gson = new GsonBuilder() + .serializeNulls() + .setDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'") + .create();src/main/java/com/buape/kiaimc/KiaiMC.java (1)
47-47: Add base URL validation and version change logging.Consider adding URL validation and logging the API version change:
- baseUrl = "https://api.kiai.app/v2"; + baseUrl = validateBaseUrl("https://api.kiai.app/v2"); + logger.info("Using Kiai API v2"); + private String validateBaseUrl(String url) { + if (!url.matches("^https?://[^\\s/$.?#].[^\\s]*$")) { + throw new IllegalArgumentException("Invalid base URL format"); + } + return url; + }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
src/main/java/com/buape/kiaimc/KiaiMC.java(1 hunks)src/main/java/com/buape/kiaimc/api/Kiai.java(3 hunks)src/main/java/com/buape/kiaimc/api/User.java(1 hunks)
🔇 Additional comments (1)
src/main/java/com/buape/kiaimc/api/User.java (1)
16-58: LGTM!The getter methods are well-implemented, following Java naming conventions and providing clean access to the private fields.
…paper:paper-api' to 1.21.4-R0.1-SNAPSHOT & update paper-api dependency url
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit