Added Person Endpoints and renamed some Files

Author: TrueMB

library/src/main/kotlin/me/proxer/library/api/info/InfoApi.kt

@@ -88,6 +88,20 @@ class InfoApi internal constructor(retrofit: Retrofit) {
         return ModifyUserInfoEndpoint(internalApi, entryId, UserInfoType.FINISHED)
     }
 
+    /**
+     * Returns the respective endpoint.
+     */
+    fun person(personId: String): PersonEndpoint {
+        return PersonEndpoint(internalApi, personId)
+    }
+
+    /**
+     * Returns the respective endpoint.
+     */
+    fun persons(entryId: String): PersonsCoreEndpoint {
+        return PersonsCoreEndpoint(internalApi, entryId)
+    }
+
     /**
      * Returns the respective endpoint.
      */

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

@@ -9,6 +9,8 @@ import me.proxer.library.entity.info.EpisodeInfo
 import me.proxer.library.entity.info.ForumDiscussion
 import me.proxer.library.entity.info.Industry
 import me.proxer.library.entity.info.MediaUserInfo
+import me.proxer.library.entity.info.Person
+import me.proxer.library.entity.info.PersonCore
 import me.proxer.library.entity.info.Recommendation
 import me.proxer.library.entity.info.Relation
 import me.proxer.library.entity.info.TranslatorGroup
@@ -61,6 +63,12 @@ internal interface InternalApi {
     @GET("info/industry")
     fun industry(@Query("id") id: String?): ProxerCall<Industry>
 
+    @GET("info/person")
+    fun person(@Query("id") id: String?): ProxerCall<Person>
+
+    @GET("info/persons")
+    fun persons(@Query("id") id: String?): ProxerCall<List<PersonCore>>
+
     @FormUrlEncoded
     @POST("info/setuserinfo")
     fun modifyUserInfo(

library/src/main/kotlin/me/proxer/library/api/info/PersonEndpoint.kt

@@ -0,0 +1,20 @@
+package me.proxer.library.api.info
+
+import me.proxer.library.ProxerCall
+import me.proxer.library.api.Endpoint
+import me.proxer.library.entity.info.Person
+
+/**
+ * Endpoint for retrieving all information of a [Person].
+ *
+ * @author TrueMB
+ */
+class PersonEndpoint internal constructor(
+    private val internalApi: InternalApi,
+    private val id: String
+) : Endpoint<Person> {
+
+    override fun build(): ProxerCall<Person> {
+        return internalApi.person(id)
+    }
+}

library/src/main/kotlin/me/proxer/library/api/info/PersonsCoreEndpoint.kt

@@ -0,0 +1,20 @@
+package me.proxer.library.api.info
+
+import me.proxer.library.ProxerCall
+import me.proxer.library.api.Endpoint
+import me.proxer.library.entity.info.PersonCore
+
+/**
+ * Endpoint for retrieving multiple [PersonCore] Objects for a medium entry.
+ *
+ * @author TrueMB
+ */
+class PersonsCoreEndpoint internal constructor(
+    private val internalApi: InternalApi,
+    private val id: String
+) : Endpoint<List<PersonCore>> {
+
+    override fun build(): ProxerCall<List<PersonCore>> {
+        return internalApi.persons(id)
+    }
+}

library/src/main/kotlin/me/proxer/library/api/list/CharacterSearchEndpoint.kt

@@ -3,7 +3,7 @@ package me.proxer.library.api.list
 import me.proxer.library.ProxerCall
 import me.proxer.library.api.PagingLimitEndpoint
 import me.proxer.library.entity.list.CharacterListEntry
-import me.proxer.library.enums.DescriptionType
+import me.proxer.library.enums.CharacterDescriptionType
 
 /**
  * Search for all available characters. Features various filter and uses paging.
@@ -17,18 +17,18 @@ class CharacterSearchEndpoint internal constructor(
     private var page: Int? = null
     private var limit: Int? = null
 
-    private var start: String? = null
+    private var searchStart: String? = null
     private var contains: String? = null
     private var search: String? = null
-    private var subject: DescriptionType? = null
+    private var subject: CharacterDescriptionType? = null
 
     override fun page(page: Int?) = this.apply { this.page = page }
     override fun limit(limit: Int?) = this.apply { this.limit = limit }
 
     /**
-     * Sets the start String to search for.
+     * Sets the search start String
      */
-    fun start(start: String?) = this.apply { this.start = start }
+    fun searchStart(searchStart: String?) = this.apply { this.searchStart = searchStart }
 
     /**
      * Sets the contains String to search for.
@@ -43,9 +43,9 @@ class CharacterSearchEndpoint internal constructor(
     /**
      * Sets the subject that should be looked in.
      */
-    fun subject(subject: DescriptionType?) = this.apply { this.subject = subject }
+    fun subject(subject: CharacterDescriptionType?) = this.apply { this.subject = subject }
 
     override fun build(): ProxerCall<List<CharacterListEntry>> {
-        return internalApi.characterSearch(start, contains, search, subject, page, limit)
+        return internalApi.characterSearch(searchStart, contains, search, subject, page, limit)
     }
 }

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

@@ -5,19 +5,21 @@ import me.proxer.library.entity.list.CharacterListEntry
 import me.proxer.library.entity.list.IndustryCore
 import me.proxer.library.entity.list.IndustryProject
 import me.proxer.library.entity.list.MediaListEntry
+import me.proxer.library.entity.list.PersonListEntry
 import me.proxer.library.entity.list.Tag
 import me.proxer.library.entity.list.TranslatorGroupCore
 import me.proxer.library.entity.list.TranslatorGroupProject
 import me.proxer.library.enums.Category
 import me.proxer.library.enums.Country
-import me.proxer.library.enums.DescriptionType
+import me.proxer.library.enums.CharacterDescriptionType
 import me.proxer.library.enums.IndustryType
 import me.proxer.library.enums.Language
 import me.proxer.library.enums.LengthBound
 import me.proxer.library.enums.MediaListSortCriteria
 import me.proxer.library.enums.MediaSearchSortCriteria
 import me.proxer.library.enums.MediaType
 import me.proxer.library.enums.Medium
+import me.proxer.library.enums.PersonDescriptionType
 import me.proxer.library.enums.ProjectState
 import me.proxer.library.enums.SortType
 import me.proxer.library.enums.TagRateFilter
@@ -70,7 +72,7 @@ internal interface InternalApi {
         @Query("start") start: String?,
         @Query("contains") contains: String?,
         @Query("search") search: String?,
-        @Query("subject") subject: DescriptionType?,
+        @Query("subject") subject: CharacterDescriptionType?,
         @Query("page") page: Int?,
         @Query("limit") limit: Int?
     ): ProxerCall<List<CharacterListEntry>>
@@ -93,6 +95,16 @@ internal interface InternalApi {
         @Query("limit") limit: Int?
     ): ProxerCall<List<IndustryCore>>
 
+    @GET("list/persons")
+    fun personList(
+        @Query("start") searchStart: String?,
+        @Query("contains") contains: String?,
+        @Query("search") search: String?,
+        @Query("subject") subject: PersonDescriptionType?,
+        @Query("p") page: Int?,
+        @Query("limit") limit: Int?
+    ): ProxerCall<List<PersonListEntry>>
+
     @GET("list/translatorgroupprojects")
     fun translatorGroupProjectList(
         @Query("id") id: String?,

library/src/main/kotlin/me/proxer/library/api/list/ListApi.kt

@@ -32,6 +32,13 @@ class ListApi internal constructor(retrofit: Retrofit) {
         return MediaSearchEndpoint(internalApi)
     }
 
+    /**
+     * Returns the respective endpoint.
+     */
+    fun personSearch(): PersonSearchEndpoint {
+        return PersonSearchEndpoint(internalApi)
+    }
+
     /**
      * Returns the respective endpoint.
      */

library/src/main/kotlin/me/proxer/library/api/list/PersonSearchEndpoint.kt

@@ -0,0 +1,51 @@
+package me.proxer.library.api.list
+
+import me.proxer.library.ProxerCall
+import me.proxer.library.api.PagingLimitEndpoint
+import me.proxer.library.entity.list.PersonListEntry
+import me.proxer.library.enums.PersonDescriptionType
+
+/**
+ * Endpoint for retrieving a list of Persons. Features various filter and uses paging.
+ *
+ * @author TrueMB
+ */
+class PersonSearchEndpoint internal constructor(
+    private val internalApi: InternalApi
+) : PagingLimitEndpoint<List<PersonListEntry>> {
+
+    private var page: Int? = null
+    private var limit: Int? = null
+
+    private var searchStart: String? = null
+    private var contains: String? = null
+    private var search: String? = null
+    private var subject: PersonDescriptionType? = null
+
+    override fun page(page: Int?) = this.apply { this.page = page }
+    override fun limit(limit: Int?) = this.apply { this.limit = limit }
+
+    /**
+     * Sets the query to search for only from the start.
+     */
+    fun searchStart(searchStart: String?) = this.apply { this.searchStart = searchStart }
+
+    /**
+     * Sets the contains String to search for.
+     */
+    fun contains(contains: String?) = this.apply { this.contains = contains }
+
+    /**
+     * Sets the query to search for.
+     */
+    fun search(search: String?) = this.apply { this.search = search }
+
+    /**
+     * Sets the subject (description) in which should be searched. (default: intro)
+     */
+    fun subject(subject: PersonDescriptionType?) = this.apply { this.subject = subject }
+
+    override fun build(): ProxerCall<List<PersonListEntry>> {
+        return internalApi.personList(searchStart, contains, search, subject, page, limit)
+    }
+}

library/src/main/kotlin/me/proxer/library/api/list/TagListEndpoint.kt

@@ -12,7 +12,10 @@ import me.proxer.library.enums.TagType
  *
  * @author Ruben Gees
  */
-class TagListEndpoint internal constructor(private val internalApi: InternalApi) : Endpoint<List<Tag>> {
+class TagListEndpoint internal constructor(
+    private val internalApi: InternalApi
+
+) : Endpoint<List<Tag>> {
 
     private var name: String? = null
     private var type: TagType? = null

library/src/main/kotlin/me/proxer/library/entity/info/Character.kt

@@ -17,7 +17,7 @@ import java.util.Date
  * @property birthday The birthday.
  * @property height The height.
  * @property weight The weight.
- * @property descriptions The description.
+ * @property descriptions The descriptions.
  * @property persons The persons in contact with the character
  *
  * @author Ruben Gees
@@ -33,6 +33,6 @@ data class Character(
     @Json(name = "birthday") val birthday: Date,
     @Json(name = "height") val height: String,
     @Json(name = "weight") val weight: String,
-    @Json(name = "description") val descriptions: Set<Description>,
+    @Json(name = "description") val descriptions: Set<CharacterDescription>,
     @Json(name = "persons") val persons: Set<PersonCore>
 ) : ProxerIdItem