Add new state parameter to user comments api

Author: rubengees

library/src/main/kotlin/me/proxer/library/api/user/InternalApi.kt

@@ -74,7 +74,8 @@ internal interface InternalApi {
         @Query("kat") category: Category?,
         @Query("p") page: Int?,
         @Query("limit") limit: Int?,
-        @Query("length") minimumLength: Int?
+        @Query("length") minimumLength: Int?,
+        @Query("state") state: String?
     ): ProxerCall<List<UserComment>>
 
     @GET("user/history")

library/src/main/kotlin/me/proxer/library/api/user/UserCommentsEndpoint.kt

@@ -4,6 +4,8 @@ import me.proxer.library.ProxerCall
 import me.proxer.library.api.PagingLimitEndpoint
 import me.proxer.library.entity.user.UserComment
 import me.proxer.library.enums.Category
+import me.proxer.library.enums.UserMediaProgress
+import me.proxer.library.util.ProxerUtils
 
 /**
  * Endpoint for requesting various information of an user.
@@ -16,11 +18,16 @@ class UserCommentsEndpoint internal constructor(
     private val username: String?
 ) : PagingLimitEndpoint<List<UserComment>> {
 
+    private companion object {
+        private const val DELIMITER = "+"
+    }
+
     private var page: Int? = null
     private var limit: Int? = null
 
     private var category: Category? = null
     private var minimumLength: Int? = null
+    private var states: Set<UserMediaProgress>? = null
 
     init {
         require(userId.isNullOrBlank().not() || username.isNullOrBlank().not()) {
@@ -41,7 +48,16 @@ class UserCommentsEndpoint internal constructor(
      */
     fun minimumLength(minimumLength: Int?) = this.apply { this.minimumLength = minimumLength }
 
+    /**
+     * Sets the states to filter by.
+     */
+    fun states(vararg states: UserMediaProgress) = this.apply {
+        this.states = states.toSet()
+    }
+
     override fun build(): ProxerCall<List<UserComment>> {
-        return internalApi.comments(userId, username, category, page, limit, minimumLength)
+        val joinedStates = states?.joinToString(DELIMITER) { ProxerUtils.getSafeApiEnumName(it) }
+
+        return internalApi.comments(userId, username, category, page, limit, minimumLength, joinedStates)
     }
 }

library/src/test/kotlin/me/proxer/library/api/user/UserCommentsEndpointTest.kt

@@ -30,8 +30,8 @@ class UserCommentsEndpointTest : ProxerTest() {
     fun testDefault() {
         val (result, _) = server.runRequest("user_comment.json") {
             api.user
-            .comments("123", "abc")
-            .build()
+                .comments("123", "abc")
+                .build()
                 .safeExecute()
         }
 
@@ -46,11 +46,14 @@ class UserCommentsEndpointTest : ProxerTest() {
                 .limit(12)
                 .minimumLength(1234)
                 .category(Category.ANIME)
+                .states(UserMediaProgress.WATCHED, UserMediaProgress.WATCHING)
                 .build()
                 .execute()
         }
 
-        request.path shouldEqual "/api/v1/user/comments?uid=123&username=abc&kat=anime&p=3&limit=12&length=1234"
+        request.path shouldEqual """
+            /api/v1/user/comments?uid=123&username=abc&kat=anime&p=3&limit=12&length=1234&state=0%2B1
+        """.trimIndent().replace("\n", "")
     }
 
     @Test