Separate exceptions for username and id, update changelog and readme

Author: LucaScorpion

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.1.0
+
+Add an exception model and change the return values of all API methods.
+All methods now simply return the value, or throw an exception if something went wrong.
+
 ## 2.0.0
 
-Initial version (since rework).
+Initial version.

README.md

@@ -5,18 +5,18 @@ A devRant API wrapper for Java.
 [![Jenkins](https://img.shields.io/jenkins/s/https/jenkins.scorpiac.com/job/JavaRant/job/master.svg)](https://jenkins.scorpiac.com/job/JavaRant/)
 [![Jenkins tests](https://img.shields.io/jenkins/t/https/jenkins.scorpiac.com/job/JavaRant/job/master.svg)](https://jenkins.scorpiac.com/job/JavaRant/job/master/lastCompletedBuild/testReport/)
 
-## Using JavaRant
+## Maven
 JavaRant is available on [Maven](http://mvnrepository.com/artifact/com.scorpiac.javarant/javarant), simply add this dependency to your `pom.xml` file:
 
 ```xml
 <dependency>
 	<groupId>com.scorpiac.javarant</groupId>
 	<artifactId>javarant</artifactId>
-	<version>2.0.0</version>
+	<version>2.1.0</version>
 </dependency>
 ```
 
-## Getting started
+## Using JavaRant
 
 To access devRant simply create a new `DevRant` object:
 

src/main/java/com/scorpiac/javarant/DevRant.java

@@ -91,7 +91,7 @@ public CommentedRant getRant(int id) {
      */
     public User getUser(String username) {
         Integer result = requestHandler.get(ApiEndpoint.USER_ID, UserIdResponse.class, new BasicNameValuePair("username", username))
-                .getValue().orElseThrow(() -> new NoSuchUserException(username));
+                .getValue().orElseThrow(() -> new NoSuchUsernameException(username));
 
         return getUser(result);
     }
@@ -104,7 +104,7 @@ public User getUser(String username) {
      */
     public User getUser(int id) {
         User user = requestHandler.get(ApiEndpoint.USERS.toString() + '/' + id, UserResponse.class)
-                .getValue().orElseThrow(() -> new NoSuchUserException(id));
+                .getValue().orElseThrow(() -> new NoSuchUserIdException(id));
 
         // Set the id, as that is not part of the response.
         user.setId(id);

src/main/java/com/scorpiac/javarant/NoSuchRantException.java

@@ -1,7 +1,14 @@
 package com.scorpiac.javarant;
 
 public class NoSuchRantException extends RuntimeException {
+    private final int id;
+
     public NoSuchRantException(int id) {
         super("A rant with id " + id + " does not exist.");
+        this.id = id;
+    }
+
+    public int getId() {
+        return id;
     }
 }

src/main/java/com/scorpiac/javarant/NoSuchUserException.java

@@ -1,11 +1,7 @@
 package com.scorpiac.javarant;
 
-public class NoSuchUserException extends RuntimeException {
-    public NoSuchUserException(String username) {
-        super("The user '" + username + "' does not exist.");
-    }
-
-    public NoSuchUserException(int id) {
-        super("A user with id " + id + " does not exist.");
+public abstract class NoSuchUserException extends RuntimeException {
+    public NoSuchUserException(String message) {
+        super(message);
     }
 }

src/main/java/com/scorpiac/javarant/NoSuchUserIdException.java

@@ -0,0 +1,14 @@
+package com.scorpiac.javarant;
+
+public class NoSuchUserIdException extends NoSuchUserException {
+    private final int id;
+
+    public NoSuchUserIdException(int id) {
+        super("A user with id " + id + " does not exist.");
+        this.id = id;
+    }
+
+    public int getId() {
+        return id;
+    }
+}

src/main/java/com/scorpiac/javarant/NoSuchUsernameException.java

@@ -0,0 +1,14 @@
+package com.scorpiac.javarant;
+
+public class NoSuchUsernameException extends NoSuchUserException {
+    private final String username;
+
+    public NoSuchUsernameException(String username) {
+        super("The user '" + username + "' does not exist.");
+        this.username = username;
+    }
+
+    public String getUsername() {
+        return username;
+    }
+}

src/test/java/com/scorpiac/javarant/DevRantIT.java

@@ -81,7 +81,7 @@ public void testGetUserByUsername() throws IOException {
         );
     }
 
-    @Test(expectedExceptions = NoSuchUserException.class, expectedExceptionsMessageRegExp = ".*'not-a-name'.*")
+    @Test(expectedExceptions = NoSuchUsernameException.class, expectedExceptionsMessageRegExp = ".*'not-a-name'.*")
     public void testGetUserByUsernameInvalid() throws IOException {
         server.stubFor(stubGet(
                 get(urlPathEqualTo("/api/get-user-id"))
@@ -92,7 +92,7 @@ public void testGetUserByUsernameInvalid() throws IOException {
         devRant.getUser("not-a-name");
     }
 
-    @Test(expectedExceptions = NoSuchUserException.class, expectedExceptionsMessageRegExp = ".*123.*")
+    @Test(expectedExceptions = NoSuchUserIdException.class, expectedExceptionsMessageRegExp = ".*123.*")
     public void testGetUserInvalid() throws IOException {
         server.stubFor(stubGet(
                 get(urlPathEqualTo("/api/users/123")),

src/test/java/com/scorpiac/javarant/DevRantSmokeTestIT.java

@@ -42,13 +42,13 @@ public void testGetUserByUsername() {
         assertTrue(user.getRantsCount() > 0);
     }
 
-    @Test(expectedExceptions = NoSuchUserException.class, expectedExceptionsMessageRegExp = ".*'This-is-a-non-existing-username.*'.*")
+    @Test(expectedExceptions = NoSuchUsernameException.class, expectedExceptionsMessageRegExp = ".*'This-is-a-non-existing-username.*'.*")
     public void testGetUserByUsernameInvalid() {
         // Add some randomness in case someone wants to fuck this test by registering this username.
         devRant.getUser("This-is-a-non-existing-username-" + UUID.randomUUID().toString());
     }
 
-    @Test(expectedExceptions = NoSuchUserException.class, expectedExceptionsMessageRegExp = ".*123.*")
+    @Test(expectedExceptions = NoSuchUserIdException.class, expectedExceptionsMessageRegExp = ".*123.*")
     public void testGetUserInvalid() {
         devRant.getUser(123);
     }