Update readme, make error from result not optional

Author: LucaScorpion

README.md

@@ -8,7 +8,7 @@ A devRant API wrapper for Java.
 ## Using JavaRant
 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>
@@ -24,15 +24,61 @@ To access devRant simply create a new `DevRant` object:
 DevRant devRant = new DevRant();
 ```
 
-You can then use it to get specific rants and users, or access the feed:
+Most object that are returned from `DevRant` are wrapped in a `Result` object.
+This will contain an optional result value, along with an error message.
+If the optional result is empty, then an error occurred and the error message will be set.
+For example:
+
+```
+Result<CommentedRant> result = devRant.getRant(832125);
+
+if (!result.getValue().isPresent()) {
+    System.out.println("An error occurred: " + result.getError());
+} else {
+    CommentedRant rant = result.getValue().get();
+    System.out.println(rant.getUser().getUsername() + '\n' + rant.getText());
+}
+```
+
+The `DevRant` class itself can be used to get specific rants and users.
 
 ```
 // Get a specific rant.
-Optional<CommentedRant> rant = devRant.getRant(686001);
+Result<CommentedRant> rant = devRant.getRant(686001);
 
 // Get a user by username.
-Optional<User> me = devRant.getUser("LucaScorpion");
+Result<User> me = devRant.getUser("LucaScorpion");
+```
+
+The `DevRant` class contains 2 methods for getting to specific parts of the api.
+First, `getFeed()` which returns a `DevRantFeed` object.
+This is used to access the rant and collab feeds.
+
+```
+// Get the 10 latest rants.
+Result<List<Rant>> recent = devRant.getFeed().getRants(Sort.RECENT, 10, 0);
+
+// Get the 10 best stories.
+Result<List<Rant>> stories = devRant.getFeed().getStories(Sort.TOP, 0);
+
+// Get 10 collabs.
+Result<List<Collab>> collabs = devRant.getFeed().getCollabs(10);
+```
+
+Second, `getAuth()` which returns a `DevRantAuth` object, which is used to access user functionality.
+Note that a user needs to be logged in before this can be accessed.
+
+```
+// Log in to devRant.
+char[] password = "<password>".toCharArray();
+devRant.login("<username>", password);
+
+// Upvote a rant.
+devRant.getAuth().voteRant(832125, Vote.UP);
+
+// Clear the vote on a comment.
+devRant.getAuth().voteComment(832169, Vote.NONE);
 
-// Get the 10 newest rants.
-Optional<List<Rant>> recent = devRant.getFeed().getRants(Sort.RECENT);
+// Log out to clear the token.
+devRant.logout();
 ```

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.scorpiac.javarant</groupId>
     <artifactId>javarant</artifactId>
-    <version>2.0.0-SNAPSHOT</version>
+    <version>2.0.0</version>
     <packaging>jar</packaging>
 
     <name>JavaRant</name>

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

@@ -81,15 +81,15 @@ public Result<CommentedRant> getRant(int id) {
      * @return The user.
      */
     public Result<User> getUser(String username) {
-        Result<Integer> id = requestHandler.get(ApiEndpoint.USER_ID, UserIdResponse.class, new BasicNameValuePair("username", username));
+        Result<Integer> result = requestHandler.get(ApiEndpoint.USER_ID, UserIdResponse.class, new BasicNameValuePair("username", username));
 
         // Check the result.
-        if (id.getError().isPresent() || !id.getValue().isPresent()) {
+        if (!result.getValue().isPresent()) {
             // When the username is invalid, no error message is returned by the API.
             return new Result<>("Invalid username specified.");
         }
 
-        return getUser(id.getValue().get());
+        return getUser(result.getValue().get());
     }
 
     /**
@@ -102,7 +102,7 @@ public Result<User> getUser(int id) {
         Result<User> result = requestHandler.get(ApiEndpoint.USERS.toString() + '/' + id, UserResponse.class);
 
         // Check the result.
-        if (result.getError().isPresent() || !result.getValue().isPresent()) {
+        if (!result.getValue().isPresent()) {
             // When the user id is invalid, no error message is returned by the API.
             return new Result<>("Invalid user id specified.");
         }

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

@@ -75,7 +75,7 @@ public Result<List<Rant>> getStories(Sort sort, int skip) {
      * @param limit How many rants to get.
      * @return Collabs from the feed.
      */
-    public Result<List<Rant>> getCollabs(int limit) {
+    public Result<List<Collab>> getCollabs(int limit) {
         return devRant.getRequestHandler().get(ApiEndpoint.COLLABS, RantsFeedResponse.class,
                 new BasicNameValuePair("limit", String.valueOf(limit))
         );

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

@@ -18,11 +18,23 @@ public Result(Response<T> response) {
         value = response.getValue();
     }
 
+    /**
+     * Get the result value.
+     * If an error occurred, this will be empty and the error will be set.
+     *
+     * @return The value.
+     */
     public Optional<T> getValue() {
         return Optional.ofNullable(value);
     }
 
-    public Optional<String> getError() {
-        return Optional.ofNullable(error);
+    /**
+     * Get the error message.
+     * If there was no error, this returns {@code null}.
+     *
+     * @return The error, or {@code null} if there was none.
+     */
+    public String getError() {
+        return error;
     }
 }

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

@@ -8,6 +8,7 @@
 import static com.github.tomakehurst.wiremock.client.WireMock.*;
 import static org.testng.Assert.assertEquals;
 import static org.testng.Assert.assertFalse;
+import static org.testng.Assert.assertNull;
 
 public class DevRantAuthIT extends ITHelper {
     private String authBody;
@@ -27,7 +28,7 @@ public void testUpvoteRant() throws IOException {
         ));
 
         Result<Rant> result = devRant.getAuth().voteRant(843654, Vote.UP);
-        assertFalse(result.getError().isPresent());
+        assertNull(result.getError());
         assertEquals(result.getValue().get().getVoteState(), VoteState.UP);
     }
 
@@ -40,7 +41,7 @@ public void testDownvoteRant() throws IOException {
         ));
 
         Result<Rant> result = devRant.getAuth().voteRant(843654, Vote.DOWN(Reason.NOT_FOR_ME));
-        assertFalse(result.getError().isPresent());
+        assertNull(result.getError());
         assertEquals(result.getValue().get().getVoteState(), VoteState.DOWN);
     }
 
@@ -53,7 +54,7 @@ public void testNonevoteComment() throws IOException {
         ));
 
         Result<Comment> result = devRant.getAuth().voteComment(843736, Vote.NONE);
-        assertFalse(result.getError().isPresent());
+        assertNull(result.getError());
         assertEquals(result.getValue().get().getVoteState(), VoteState.NONE);
     }
 }

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

@@ -7,7 +7,7 @@
 
 import static com.github.tomakehurst.wiremock.client.WireMock.*;
 import static org.testng.Assert.assertEquals;
-import static org.testng.Assert.assertFalse;
+import static org.testng.Assert.assertNull;
 
 public class DevRantFeedIT extends ITHelper {
     @Test
@@ -21,7 +21,7 @@ public void testGetRants() throws IOException {
         ));
 
         Result<List<Rant>> result = devRant.getFeed().getRants(Sort.RECENT, 4, 1);
-        assertFalse(result.getError().isPresent());
+        assertNull(result.getError());
         List<Rant> rants = result.getValue().get();
         assertEquals(rants.size(), 4);
 
@@ -43,7 +43,7 @@ public void testSearch() throws IOException {
         ));
 
         Result<List<Rant>> result = devRant.getFeed().search("wtf");
-        assertFalse(result.getError().isPresent());
+        assertNull(result.getError());
 
         validateRant(result.getValue().get().get(1),
                 542296,
@@ -64,7 +64,7 @@ public void testGetWeekly() throws IOException {
         ));
 
         Result<List<Rant>> result = devRant.getFeed().getWeekly(Sort.ALGO, 2);
-        assertFalse(result.getError().isPresent());
+        assertNull(result.getError());
         List<Rant> rants = result.getValue().get();
 
         validateRant(rants.get(0),
@@ -86,7 +86,7 @@ public void testGetStories() throws IOException {
         ));
 
         Result<List<Rant>> result = devRant.getFeed().getStories(Sort.TOP, 4);
-        assertFalse(result.getError().isPresent());
+        assertNull(result.getError());
         List<Rant> rants = result.getValue().get();
 
         validateRant(rants.get(0),
@@ -106,9 +106,9 @@ public void testGetCollabs() throws IOException {
                 "/feed-collabs.json"
         ));
 
-        Result<List<Rant>> result = devRant.getFeed().getCollabs(2);
-        assertFalse(result.getError().isPresent());
-        List<Rant> rants = result.getValue().get();
+        Result<List<Collab>> result = devRant.getFeed().getCollabs(2);
+        assertNull(result.getError());
+        List<Collab> rants = result.getValue().get();
 
         validateRant(rants.get(0),
                 838945,

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

@@ -16,7 +16,7 @@ public void testGetRant() throws IOException {
         ));
 
         Result<CommentedRant> result = devRant.getRant(686001);
-        assertFalse(result.getError().isPresent());
+        assertNull(result.getError());
         CommentedRant rant = result.getValue().get();
 
         validateRant(rant,
@@ -43,7 +43,7 @@ public void testGetRantInvalid() throws IOException {
 
         Result<CommentedRant> result = devRant.getRant(0);
         assertFalse(result.getValue().isPresent());
-        assertTrue(result.getError().isPresent());
+        assertNotNull(result.getError());
     }
 
     @Test
@@ -55,7 +55,7 @@ public void testGetRantServerError() throws IOException {
 
         Result<CommentedRant> result = devRant.getRant(123456);
         assertFalse(result.getValue().isPresent());
-        assertTrue(result.getError().isPresent());
+        assertNotNull(result.getError());
     }
 
     @Test
@@ -71,7 +71,7 @@ public void testGetUserByUsername() throws IOException {
         ));
 
         Result<User> result = devRant.getUser("LucaScorpion");
-        assertFalse(result.getError().isPresent());
+        assertNull(result.getError());
 
         validateUser(result.getValue().get(),
                 102959,
@@ -98,9 +98,9 @@ public void testGetUserByUsernameInvalid() throws IOException {
                 "/user-id-invalid.json"
         ));
 
-        Result<User> user = devRant.getUser("invalid");
-        assertFalse(user.getValue().isPresent());
-        assertTrue(user.getError().isPresent());
+        Result<User> result = devRant.getUser("invalid");
+        assertFalse(result.getValue().isPresent());
+        assertNotNull(result.getError());
     }
 
     @Test
@@ -112,7 +112,7 @@ public void testGetUserInvalid() throws IOException {
 
         Result<User> result = devRant.getUser(123);
         assertFalse(result.getValue().isPresent());
-        assertTrue(result.getError().isPresent());
+        assertNotNull(result.getError());
     }
 
     @Test
@@ -153,7 +153,7 @@ public void testGetCollab() throws IOException {
         ));
 
         Result<Collab> result = devRant.getCollab(785714);
-        assertFalse(result.getError().isPresent());
+        assertNull(result.getError());
         Collab collab = result.getValue().get();
 
         validateCollab(collab,