Implement chat room users api

Author: rubengees

library/src/main/java/me/proxer/library/api/chat/ChatApi.java

@@ -45,4 +45,11 @@ public ChatMessagesEndpoint messages(final String roomId) {
     public SendChatMessageEndpoint sendMessage(final String roomId, final String message) {
         return new SendChatMessageEndpoint(internalApi, roomId, message);
     }
+
+    /**
+     * Returns the respective endpoint.
+     */
+    public ChatRoomUsersEndpoint roomUsers(final String roomId) {
+        return new ChatRoomUsersEndpoint(internalApi, roomId);
+    }
 }

library/src/main/java/me/proxer/library/api/chat/ChatRoomUsersEndpoint.java

@@ -0,0 +1,41 @@
+package me.proxer.library.api.chat;
+
+import lombok.experimental.Accessors;
+import me.proxer.library.api.Endpoint;
+import me.proxer.library.api.ProxerCall;
+import me.proxer.library.entity.chat.ChatRoomUser;
+
+import java.util.List;
+
+/**
+ * Endpoint for retrieving messages in a chat room.
+ * <p>
+ * This behaves differently based on the parameter messageId:
+ * 1) messageId = 0: Returns the last messages from the chat room.
+ * 2) messageId != 0: Returns all messages older than that passed from the chat room.
+ *
+ * @author Ruben Gees
+ */
+@Accessors(fluent = true)
+public final class ChatRoomUsersEndpoint implements Endpoint<List<ChatRoomUser>> {
+
+    private final InternalApi internalApi;
+
+    /**
+     * Sets the id of the room to load.
+     */
+    private final String roomId;
+
+    ChatRoomUsersEndpoint(final InternalApi internalApi, final String roomId) {
+        this.internalApi = internalApi;
+        this.roomId = roomId;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public ProxerCall<List<ChatRoomUser>> build() {
+        return internalApi.roomUsers(roomId);
+    }
+}

library/src/main/java/me/proxer/library/api/chat/InternalApi.java

@@ -3,6 +3,7 @@
 import me.proxer.library.api.ProxerCall;
 import me.proxer.library.entity.chat.ChatMessage;
 import me.proxer.library.entity.chat.ChatRoom;
+import me.proxer.library.entity.chat.ChatRoomUser;
 import retrofit2.http.Field;
 import retrofit2.http.FormUrlEncoded;
 import retrofit2.http.GET;
@@ -32,4 +33,7 @@ ProxerCall<List<ChatMessage>> messages(@Query("room_id") String roomId,
     @POST("chat/newmessage")
     ProxerCall<String> sendMessage(@Field("room_id") String roomId,
                                    @Field("message") String message);
+
+    @GET("chat/roomusers")
+    ProxerCall<List<ChatRoomUser>> roomUsers(@Query("room_id") String roomId);
 }

library/src/main/java/me/proxer/library/entity/chat/ChatRoomUser.java

@@ -0,0 +1,52 @@
+package me.proxer.library.entity.chat;
+
+import com.squareup.moshi.Json;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.Value;
+import me.proxer.library.entity.ProxerIdItem;
+import me.proxer.library.entity.ProxerImageItem;
+
+import javax.annotation.Nullable;
+
+/**
+ * Entity representing a user, active in a {@link ChatRoom}.
+ *
+ * @author Ruben Gees
+ */
+@Value
+@EqualsAndHashCode(onParam = @__({@Nullable}))
+public class ChatRoomUser implements ProxerIdItem, ProxerImageItem {
+
+    /**
+     * Returns the id of this user.
+     */
+    @Getter(onMethod = @__({@Override}))
+    @Json(name = "uid")
+    private String id;
+
+    /**
+     * Returns the name.
+     */
+    @Json(name = "username")
+    private String name;
+
+    /**
+     * {@inheritDoc}
+     */
+    @Getter(onMethod = @__({@Override}))
+    @Json(name = "avatar")
+    private String image;
+
+    /**
+     * Returns the status.
+     */
+    @Json(name = "status")
+    private String status;
+
+    /**
+     * Returns if this user is a moderator.
+     */
+    @Json(name = "mod")
+    private boolean isModerator;
+}

library/src/test/java/me/proxer/library/api/chat/ChatRoomUsersEndpointTest.java

@@ -0,0 +1,51 @@
+package me.proxer.library.api.chat;
+
+import me.proxer.library.ProxerTest;
+import me.proxer.library.api.ProxerException;
+import me.proxer.library.entity.chat.ChatRoomUser;
+import okhttp3.mockwebserver.MockResponse;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Ruben Gees
+ */
+public class ChatRoomUsersEndpointTest extends ProxerTest {
+
+    @Test
+    public void testDefault() throws IOException, ProxerException {
+        server.enqueue(new MockResponse().setBody(fromResource("chat_room_users.json")));
+
+        final List<ChatRoomUser> result = api.chat()
+                .roomUsers("123")
+                .build()
+                .execute();
+
+        assertThat(result).first().isEqualTo(buildFirstUser());
+        assertThat(result).last().isEqualTo(buildLastUser());
+    }
+
+    @Test
+    public void testPath() throws ProxerException, IOException, InterruptedException {
+        server.enqueue(new MockResponse().setBody(fromResource("chat_room_users.json")));
+
+        api.chat().roomUsers("12")
+                .build()
+                .execute();
+
+        assertThat(server.takeRequest().getPath()).isEqualTo("/api/v1/chat/roomusers?room_id=12");
+    }
+
+    private ChatRoomUser buildFirstUser() {
+        return new ChatRoomUser("730019", "Akaya-", "730019_0bvh9W.jpg",
+                "My heart is sinking like a stone, in an ocean of it's own.", false);
+    }
+
+    private ChatRoomUser buildLastUser() {
+        return new ChatRoomUser("229687", "Aver", "229687_FYkLhC.png", "....", true);
+    }
+}

library/src/test/resources/chat_room_users.json

@@ -0,0 +1,20 @@
+{
+  "error": 0,
+  "message": "Abrage erfolgreich.",
+  "data": [
+    {
+      "uid": "730019",
+      "username": "Akaya-",
+      "avatar": "730019_0bvh9W.jpg",
+      "status": "My heart is sinking like a stone, in an ocean of it's own.",
+      "mod": "0"
+    },
+    {
+      "uid": "229687",
+      "username": "Aver",
+      "avatar": "229687_FYkLhC.png",
+      "status": "....",
+      "mod": "1"
+    }
+  ]
+}