Implement new "has" filter for the user comments endpoint

Author: rubengees

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

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

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

@@ -4,6 +4,7 @@ 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.CommentContentType
 import me.proxer.library.enums.UserMediaProgress
 import me.proxer.library.util.ProxerUtils
 
@@ -28,6 +29,7 @@ class UserCommentsEndpoint internal constructor(
     private var category: Category? = null
     private var minimumLength: Int? = null
     private var states: Set<UserMediaProgress>? = null
+    private var hasContent: Set<CommentContentType>? = null
 
     init {
         require(userId.isNullOrBlank().not() || username.isNullOrBlank().not()) {
@@ -51,13 +53,19 @@ class UserCommentsEndpoint internal constructor(
     /**
      * Sets the states to filter by.
      */
-    fun states(vararg states: UserMediaProgress) = this.apply {
-        this.states = states.toSet()
-    }
+    fun states(vararg states: UserMediaProgress) = this.apply { this.states = states.toSet() }
+
+    /**
+     * Content types to filter by.
+     */
+    fun hasContent(vararg contentTypes: CommentContentType) = this.apply { this.hasContent = contentTypes.toSet() }
 
     override fun build(): ProxerCall<List<UserComment>> {
         val joinedStates = states?.joinToString(DELIMITER) { ProxerUtils.getSafeApiEnumName(it) }
+        val joinedHasContent = hasContent?.joinToString(DELIMITER) { ProxerUtils.getSafeApiEnumName(it) }
 
-        return internalApi.comments(userId, username, category, page, limit, minimumLength, joinedStates)
+        return internalApi.comments(
+            userId, username, category, page, limit, minimumLength, joinedStates, joinedHasContent
+        )
     }
 }

library/src/main/kotlin/me/proxer/library/enums/CommentContentType.kt

@@ -0,0 +1,17 @@
+package me.proxer.library.enums
+
+import com.squareup.moshi.Json
+
+/**
+ * Enum holding possiblke values for the "has"-filter of the [me.proxer.library.api.user.UserCommentsEndpoint].
+ *
+ * @author Ruben Gees
+ */
+enum class CommentContentType {
+
+    @Json(name = "rating")
+    RATING,
+
+    @Json(name = "comment")
+    COMMENT
+}

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

@@ -4,6 +4,7 @@ import me.proxer.library.ProxerTest
 import me.proxer.library.entity.info.RatingDetails
 import me.proxer.library.entity.user.UserComment
 import me.proxer.library.enums.Category
+import me.proxer.library.enums.CommentContentType
 import me.proxer.library.enums.Medium
 import me.proxer.library.enums.UserMediaProgress
 import me.proxer.library.runRequest
@@ -47,12 +48,14 @@ class UserCommentsEndpointTest : ProxerTest() {
                 .minimumLength(1234)
                 .category(Category.ANIME)
                 .states(UserMediaProgress.WATCHED, UserMediaProgress.WATCHING)
+                .hasContent(CommentContentType.COMMENT, CommentContentType.RATING)
                 .build()
                 .execute()
         }
 
         request.path shouldEqual """
             /api/v1/user/comments?uid=123&username=abc&kat=anime&p=3&limit=12&length=1234&state=0%2B1
+            &has=comment%2Brating
         """.trimIndent().replace("\n", "")
     }