Implement new filters for user media list and hentai restriction

Author: rubengees

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

@@ -30,7 +30,7 @@ ProxerCall<List<Comment>> comments(@Query("id") String id, @Query("p") Integer p
                                        @Query("sort") CommentSortCriteria criteria);
 
     @GET("info/relations")
-    ProxerCall<List<Relation>> relations(@Query("id") String id);
+    ProxerCall<List<Relation>> relations(@Query("id") String id, @Query("isH") Boolean includeHentai);
 
     @GET("info/translatorgroup")
     ProxerCall<TranslatorGroup> translatorGroup(@Query("id") String id);

library/src/main/java/me/proxer/library/api/info/RelationsEndpoint.java

@@ -1,11 +1,13 @@
 package me.proxer.library.api.info;
 
+import lombok.Setter;
 import lombok.experimental.Accessors;
 import me.proxer.library.api.Endpoint;
 import me.proxer.library.api.ProxerCall;
 import me.proxer.library.entitiy.info.Entry;
 import me.proxer.library.entitiy.info.Relation;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.List;
 
@@ -21,6 +23,13 @@ public class RelationsEndpoint implements Endpoint {
 
     private final String id;
 
+    /**
+     * Sets if hentai should be included in the result.
+     */
+    @Nullable
+    @Setter(onMethod = @__({@NotNull}))
+    private Boolean includeHentai;
+
     RelationsEndpoint(@NotNull final InternalApi internalApi, @NotNull final String id) {
         this.internalApi = internalApi;
         this.id = id;
@@ -32,6 +41,6 @@ public class RelationsEndpoint implements Endpoint {
     @Override
     @NotNull
     public ProxerCall<List<Relation>> build() {
-        return internalApi.relations(id);
+        return internalApi.relations(id, includeHentai);
     }
 }

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

@@ -6,6 +6,7 @@
 import me.proxer.library.entitiy.user.UserInfo;
 import me.proxer.library.entitiy.user.UserMediaListEntry;
 import me.proxer.library.enums.Category;
+import me.proxer.library.enums.UserMediaListFilterType;
 import me.proxer.library.enums.UserMediaListSortCriteria;
 import retrofit2.http.*;
 
@@ -26,7 +27,7 @@ ProxerCall<User> login(@Field("username") String username, @Field("password") St
 
     @GET("user/topten")
     ProxerCall<List<TopTenEntry>> topTen(@Query("uid") String userId, @Query("username") String username,
-                                         @Query("kat") Category category);
+                                         @Query("kat") Category category, @Query("isH") Boolean includeHentai);
 
     @GET("user/userinfo")
     ProxerCall<UserInfo> userInfo(@Query("uid") String userId, @Query("username") String username);
@@ -36,5 +37,7 @@ ProxerCall<List<UserMediaListEntry>> userMediaList(@Query("uid") String userId,
                                                        @Query("kat") Category category, @Query("p") Integer page,
                                                        @Query("limit") Integer limit, @Query("search") String query,
                                                        @Query("search_start") String startQuery,
-                                                       @Query("sort") UserMediaListSortCriteria sortCriteria);
+                                                       @Query("filter") UserMediaListFilterType filter,
+                                                       @Query("sort") UserMediaListSortCriteria sortCriteria,
+                                                       @Query("isH") Boolean includeHentai);
 }

library/src/main/java/me/proxer/library/api/user/UserMediaListEndpoint.java

@@ -7,6 +7,7 @@
 import me.proxer.library.api.ProxerCall;
 import me.proxer.library.entitiy.user.UserMediaListEntry;
 import me.proxer.library.enums.Category;
+import me.proxer.library.enums.UserMediaListFilterType;
 import me.proxer.library.enums.UserMediaListSortCriteria;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -61,6 +62,20 @@ public final class UserMediaListEndpoint implements PagingEndpoint, LimitEndpoin
     @Setter(onMethod = @__({@NotNull}))
     private String searchStart;
 
+    /**
+     * Sets the filter.
+     */
+    @Nullable
+    @Setter(onMethod = @__({@NotNull}))
+    private UserMediaListFilterType filter;
+
+    /**
+     * Sets if hentai should be included in the result.
+     */
+    @Nullable
+    @Setter(onMethod = @__({@NotNull}))
+    private Boolean includeHentai;
+
     /**
      * Set the criteria for sorting.
      */
@@ -85,6 +100,7 @@ public final class UserMediaListEndpoint implements PagingEndpoint, LimitEndpoin
     @Override
     @NotNull
     public ProxerCall<List<UserMediaListEntry>> build() {
-        return internalApi.userMediaList(userId, username, category, page, limit, search, searchStart, sort);
+        return internalApi.userMediaList(userId, username, category, page, limit, search, searchStart, filter, sort,
+                includeHentai);
     }
 }

library/src/main/java/me/proxer/library/api/user/UserTopTenEndpoint.java

@@ -31,6 +31,13 @@ public final class UserTopTenEndpoint implements Endpoint {
     @Setter(onMethod = @__({@NotNull}))
     private Category category;
 
+    /**
+     * Sets if hentai should be included in the result.
+     */
+    @Nullable
+    @Setter(onMethod = @__({@NotNull}))
+    private Boolean includeHentai;
+
     UserTopTenEndpoint(@NotNull final InternalApi internalApi, @Nullable final String userId,
                        @Nullable final String username) {
         if (userId == null && username == null) {
@@ -48,6 +55,6 @@ public final class UserTopTenEndpoint implements Endpoint {
     @Override
     @NotNull
     public ProxerCall<List<TopTenEntry>> build() {
-        return internalApi.topTen(userId, username, category);
+        return internalApi.topTen(userId, username, category, includeHentai);
     }
 }

library/src/main/java/me/proxer/library/enums/UserMediaListFilterType.java

@@ -0,0 +1,15 @@
+package me.proxer.library.enums;
+
+import com.squareup.moshi.Json;
+
+/**
+ * Enum holding the possible filter options for the user media list.
+ *
+ * @author Ruben Gees
+ */
+public enum UserMediaListFilterType {
+    @Json(name = "stateFilter0")WATCHED,
+    @Json(name = "stateFilter1")WATCHING,
+    @Json(name = "stateFilter2")WILL_WATCH,
+    @Json(name = "stateFilter3")CANCELLED
+}

library/src/test/java/me/proxer/library/api/user/UserMediaListEndpointTest.java

@@ -40,12 +40,15 @@ public void testPath() throws ProxerException, IOException, InterruptedException
                 .limit(5)
                 .search("test")
                 .searchStart("startTest")
+                .filter(UserMediaListFilterType.WATCHING)
                 .sort(UserMediaListSortCriteria.STATE_CHANGE_DATE_ASCENDING)
+                .includeHentai(true)
                 .build()
                 .execute();
 
         assertThat(server.takeRequest().getPath()).isEqualTo("/api/v1/user/list?uid=1&username=rubygee" +
-                "&kat=anime&p=0&limit=5&search=test&search_start=startTest&sort=stateChangeDateASC");
+                "&kat=anime&p=0&limit=5&search=test&search_start=startTest" +
+                "&filter=stateFilter1&sort=stateChangeDateASC&isH=true");
     }
 
     @Test

library/src/test/java/me/proxer/library/api/user/UserTopTenEndpointTest.java

@@ -52,11 +52,12 @@ public void testPath() throws ProxerException, IOException, InterruptedException
 
         api.user().topTen("123", "rubygee")
                 .category(Category.ANIME)
+                .includeHentai(true)
                 .build()
                 .execute();
 
         Assertions.assertThat(server.takeRequest().getPath())
-                .isEqualTo("/api/v1/user/topten?uid=123&username=rubygee&kat=anime");
+                .isEqualTo("/api/v1/user/topten?uid=123&username=rubygee&kat=anime&isH=true");
     }
 
     @Test