Implement link check api and cleanup

rubengees · rubengees · commit 2fe28606ea2a · 2020-05-03T01:21:59.000+02:00
diff --git a/library/src/main/kotlin/me/proxer/library/api/messenger/CheckLinkEndpoint.kt b/library/src/main/kotlin/me/proxer/library/api/messenger/CheckLinkEndpoint.kt
@@ -0,0 +1,20 @@
+package me.proxer.library.api.messenger
+
+import me.proxer.library.ProxerCall
+import me.proxer.library.api.Endpoint
+import me.proxer.library.entity.messenger.LinkCheckResponse
+
+/**
+ * Endpoint for reporting a conference. The given text is sent to the moderators for investigation.
+ *
+ * @author Ruben Gees
+ */
+class CheckLinkEndpoint internal constructor(
+    private val internalApi: InternalApi,
+    private val link: String
+) : Endpoint<LinkCheckResponse> {
+
+    override fun build(): ProxerCall<LinkCheckResponse> {
+        return internalApi.checkLink(link)
+    }
+}
diff --git a/library/src/main/kotlin/me/proxer/library/api/messenger/InternalApi.kt b/library/src/main/kotlin/me/proxer/library/api/messenger/InternalApi.kt
@@ -3,6 +3,7 @@ package me.proxer.library.api.messenger
 import me.proxer.library.ProxerCall
 import me.proxer.library.entity.messenger.Conference
 import me.proxer.library.entity.messenger.ConferenceInfo
+import me.proxer.library.entity.messenger.LinkCheckResponse
 import me.proxer.library.entity.messenger.Message
 import me.proxer.library.enums.ConferenceType
 import retrofit2.http.Field
@@ -81,4 +82,8 @@ internal interface InternalApi {
     @FormUrlEncoded
     @POST("messenger/report")
     fun report(@Field("conference_id") id: String?, @Field("text") text: String?): ProxerCall<Unit>
+
+    @FormUrlEncoded
+    @POST("messenger/checkLink")
+    fun checkLink(@Field("link") link: String?): ProxerCall<LinkCheckResponse>
 }
diff --git a/library/src/main/kotlin/me/proxer/library/api/messenger/MessengerApi.kt b/library/src/main/kotlin/me/proxer/library/api/messenger/MessengerApi.kt
@@ -3,6 +3,7 @@ package me.proxer.library.api.messenger
 import me.proxer.library.api.messenger.ConferenceModificationEndpoint.ConferenceModification
 import me.proxer.library.enums.MessageAction
 import me.proxer.library.util.ProxerUtils
+import okhttp3.HttpUrl
 import retrofit2.Retrofit
 
 /**
@@ -116,6 +117,20 @@ class MessengerApi internal constructor(retrofit: Retrofit) {
         return ReportConferenceEndpoint(internalApi, id, text)
     }
 
+    /**
+     * Returns the respective endpoint.
+     */
+    fun checkLink(link: String): CheckLinkEndpoint {
+        return CheckLinkEndpoint(internalApi, link)
+    }
+
+    /**
+     * Returns the respective endpoint.
+     */
+    fun checkLink(link: HttpUrl): CheckLinkEndpoint {
+        return CheckLinkEndpoint(internalApi, link.toString())
+    }
+
     private fun constructMessageFromAction(action: MessageAction, subject: String): String {
         require(action != MessageAction.NONE) { "Invalid action: $action" }
 
diff --git a/library/src/main/kotlin/me/proxer/library/entity/info/EpisodeInfo.kt b/library/src/main/kotlin/me/proxer/library/entity/info/EpisodeInfo.kt
@@ -1,6 +1,7 @@
 package me.proxer.library.entity.info
 
 import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
 import me.proxer.library.enums.Category
 import me.proxer.library.enums.MediaLanguage
 
@@ -16,6 +17,7 @@ import me.proxer.library.enums.MediaLanguage
  *
  * @author Ruben Gees
  */
+@JsonClass(generateAdapter = true)
 data class EpisodeInfo(
     @Json(name = "start") val firstEpisode: Int,
     @Json(name = "end") val lastEpisode: Int,
diff --git a/library/src/main/kotlin/me/proxer/library/entity/messenger/Conference.kt b/library/src/main/kotlin/me/proxer/library/entity/messenger/Conference.kt
@@ -1,6 +1,7 @@
 package me.proxer.library.entity.messenger
 
 import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
 import me.proxer.library.entity.ProxerDateItem
 import me.proxer.library.entity.ProxerIdItem
 import me.proxer.library.entity.ProxerImageItem
@@ -21,6 +22,7 @@ import java.util.Date
  *
  * @author Ruben Gees
  */
+@JsonClass(generateAdapter = true)
 data class Conference(
     @Json(name = "id") override val id: String,
     @Json(name = "topic") val topic: String,
diff --git a/library/src/main/kotlin/me/proxer/library/entity/messenger/ConferenceInfo.kt b/library/src/main/kotlin/me/proxer/library/entity/messenger/ConferenceInfo.kt
@@ -1,6 +1,7 @@
 package me.proxer.library.entity.messenger
 
 import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
 import java.util.Date
 
 /**
@@ -15,6 +16,7 @@ import java.util.Date
  *
  * @author Desnoo
  */
+@JsonClass(generateAdapter = true)
 data class ConferenceInfo(
     @Json(name = "topic") val topic: String,
     @Json(name = "count") val participantAmount: Int,
diff --git a/library/src/main/kotlin/me/proxer/library/entity/messenger/LinkCheckResponse.kt b/library/src/main/kotlin/me/proxer/library/entity/messenger/LinkCheckResponse.kt
@@ -0,0 +1,16 @@
+package me.proxer.library.entity.messenger
+
+import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
+
+/**
+ * Entity containing the results of a link check.
+ *
+ * @param isSecure If the link is not on any blacklist.
+ * @param link The link sent.
+ */
+@JsonClass(generateAdapter = true)
+data class LinkCheckResponse(
+    @Json(name = "secure") val isSecure: Boolean,
+    @Json(name = "link") val link: String
+)
diff --git a/library/src/main/kotlin/me/proxer/library/entity/notifications/Notification.kt b/library/src/main/kotlin/me/proxer/library/entity/notifications/Notification.kt
@@ -1,6 +1,7 @@
 package me.proxer.library.entity.notifications
 
 import com.squareup.moshi.Json
+import com.squareup.moshi.JsonClass
 import me.proxer.library.entity.ProxerDateItem
 import me.proxer.library.entity.ProxerIdItem
 import me.proxer.library.enums.NotificationType
@@ -19,6 +20,7 @@ import java.util.Date
  *
  * @author Ruben Gees
  */
+@JsonClass(generateAdapter = true)
 data class Notification(
     @Json(name = "id") override val id: String,
     @Json(name = "type") val type: NotificationType,
diff --git a/library/src/main/kotlin/me/proxer/library/entity/notifications/NotificationInfo.kt b/library/src/main/kotlin/me/proxer/library/entity/notifications/NotificationInfo.kt
@@ -1,5 +1,7 @@
 package me.proxer.library.entity.notifications
 
+import com.squareup.moshi.JsonClass
+
 /**
  * Entity holding counts of notification types.
  *
@@ -10,6 +12,7 @@ package me.proxer.library.entity.notifications
  *
  * @author Ruben Gees
  */
+@JsonClass(generateAdapter = true)
 data class NotificationInfo(
     val messageAmount: Int,
     val friendRequestAmount: Int,
diff --git a/library/src/test/kotlin/me/proxer/library/TestUtils.kt b/library/src/test/kotlin/me/proxer/library/TestUtils.kt
@@ -3,17 +3,15 @@ package me.proxer.library
 import okhttp3.mockwebserver.MockResponse
 import okhttp3.mockwebserver.MockWebServer
 import okhttp3.mockwebserver.RecordedRequest
-import okio.buffer
-import okio.source
 import java.lang.invoke.MethodHandles
 import java.text.SimpleDateFormat
 import java.util.Date
 import java.util.Locale
 import java.util.concurrent.TimeUnit
 
 fun fromResource(file: String): String = MethodHandles.lookup().lookupClass().classLoader
-    .let { requireNotNull(it.getResourceAsStream(file)) }
-    .let { it.source().buffer().readUtf8() }
+    .let { requireNotNull(it.getResource(file)) }
+    .readText(Charsets.UTF_8)
 
 fun String.toProxerDate(): Date = SimpleDateFormat("yyyy-MM-dd", Locale.GERMANY).parse(this)
 fun String.toProxerDateTime(): Date = SimpleDateFormat("yyyy-MM-dd hh:mm:ss", Locale.GERMANY).parse(this)
diff --git a/library/src/test/kotlin/me/proxer/library/api/messenger/CheckLinkEndpointTest.kt b/library/src/test/kotlin/me/proxer/library/api/messenger/CheckLinkEndpointTest.kt
@@ -0,0 +1,46 @@
+package me.proxer.library.api.messenger
+
+import me.proxer.library.ProxerTest
+import me.proxer.library.entity.messenger.LinkCheckResponse
+import me.proxer.library.runRequest
+import okhttp3.HttpUrl.Companion.toHttpUrl
+import org.amshove.kluent.shouldBeEqualTo
+import org.junit.jupiter.api.Test
+
+class CheckLinkEndpointTest : ProxerTest() {
+
+    private val expectedResponse = LinkCheckResponse(false, "https://proxer.biz")
+
+    @Test
+    fun testDefault() {
+        val (result, _) = server.runRequest("link_check.json") {
+            api.messenger.checkLink("https://proxer.biz")
+                .build()
+                .execute()
+        }
+
+        result shouldBeEqualTo expectedResponse
+    }
+
+    @Test
+    fun testPath() {
+        val (_, request) = server.runRequest("link_check.json") {
+            api.messenger.checkLink("https://proxer.biz".toHttpUrl())
+                .build()
+                .execute()
+        }
+
+        request.path shouldBeEqualTo "/api/v1/messenger/checkLink"
+    }
+
+    @Test
+    fun testParameter() {
+        val (_, request) = server.runRequest("link_check.json") {
+            api.messenger.checkLink("https://proxer.biz")
+                .build()
+                .execute()
+        }
+
+        request.body.readUtf8() shouldBeEqualTo "link=https%3A%2F%2Fproxer.biz"
+    }
+}
diff --git a/library/src/test/resources/link_check.json b/library/src/test/resources/link_check.json
@@ -0,0 +1,8 @@
+{
+  "error": 0,
+  "message": "Abfrage erfolgreich durchgeführt.",
+  "data": {
+    "secure": false,
+    "link": "https://proxer.biz"
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`package me.proxer.library.entity.notifications`
`2`	`2`
	`3`	`+import com.squareup.moshi.JsonClass`
	`4`	`+`
`3`	`5`	`/**`
`4`	`6`	`* Entity holding counts of notification types.`
`5`	`7`	`*`
`@@ -10,6 +12,7 @@ package me.proxer.library.entity.notifications`
`10`	`12`	`*`
`11`	`13`	`* @author Ruben Gees`
`12`	`14`	`*/`
	`15`	`+@JsonClass(generateAdapter = true)`
`13`	`16`	`data class NotificationInfo(`
`14`	`17`	`val messageAmount: Int,`
`15`	`18`	`val friendRequestAmount: Int,`