Refactor some code to meet the Explicit API mode requirements

mrapplexz · mrapplexz · commit 8645195a79da · 2020-08-19T12:42:28.000+05:00
diff --git a/src/commonMain/kotlin/net/pearx/kpastebin/PastebinAccount.kt b/src/commonMain/kotlin/net/pearx/kpastebin/PastebinAccount.kt
@@ -1,36 +1,40 @@
 package net.pearx.kpastebin
 
 import net.pearx.kpastebin.model.ExpireDate
+import net.pearx.kpastebin.model.PasteDetails
 import net.pearx.kpastebin.model.Privacy
+import net.pearx.kpastebin.model.UserDetails
 
-class PastebinAccount(private val client: PastebinClient) {
-    var userKey: String? = null
+public class PastebinAccount(private val client: PastebinClient) {
+    public var userKey: String? = null
 
     private fun checkUserKeyAndReturn(): String {
         val userKey = userKey
-        if(userKey == null)
+        if (userKey == null)
             throw InvalidUserKeyException("You haven't initialized the userKey property. It can be done by setting it directly or using the 'login' function.")
         else
             return userKey
     }
 
-    suspend fun login(username: String, password: String) {
+    public suspend fun login(username: String, password: String) {
         userKey = client.login(username, password)
     }
 
-    suspend fun createPaste(
+    public suspend fun createPaste(
         text: String,
         name: String? = null,
         format: String? = null,
         privacy: Privacy? = null,
         expireDate: ExpireDate? = null
-    ) = client.createPaste(text, checkUserKeyAndReturn(), name, format, privacy, expireDate)
+    ): String = client.createPaste(text, checkUserKeyAndReturn(), name, format, privacy, expireDate)
 
-    suspend fun listPastes(resultsLimit: Int? = null) = client.listPastes(checkUserKeyAndReturn(), resultsLimit)
+    public suspend fun listPastes(resultsLimit: Int? = null): List<PasteDetails> = client.listPastes(checkUserKeyAndReturn(), resultsLimit)
 
-    suspend fun deletePaste(pasteKey: String) = client.deletePaste(checkUserKeyAndReturn(), pasteKey)
+    public suspend fun deletePaste(pasteKey: String) {
+        client.deletePaste(checkUserKeyAndReturn(), pasteKey)
+    }
 
-    suspend fun getUserDetails() = client.getUserDetails(checkUserKeyAndReturn())
+    public suspend fun getUserDetails(): UserDetails = client.getUserDetails(checkUserKeyAndReturn())
 
-    suspend fun getPaste(pasteKey: String) = client.getPaste(checkUserKeyAndReturn(), pasteKey)
+    public suspend fun getPaste(pasteKey: String): String = client.getPaste(checkUserKeyAndReturn(), pasteKey)
 }
diff --git a/src/commonMain/kotlin/net/pearx/kpastebin/PastebinClient.kt b/src/commonMain/kotlin/net/pearx/kpastebin/PastebinClient.kt
@@ -14,7 +14,7 @@ import net.pearx.kpastebin.model.UserDetails
 import nl.adaptivity.xmlutil.serialization.XML
 import nl.adaptivity.xmlutil.serialization.XmlSerialName
 
-class PastebinClient(private val devKey: String) {
+public class PastebinClient(private val devKey: String) {
     private val http = HttpClient {
         defaultRequest {
             contentType(ContentType.Application.FormUrlEncoded)
@@ -37,7 +37,7 @@ class PastebinClient(private val devKey: String) {
 
     private suspend inline fun sendRequest(url: String, parametersBuilder: ParametersBuilder.() -> Unit) = sendRequest(url, Parameters.build(parametersBuilder))
 
-    suspend fun createPaste(
+    public suspend fun createPaste(
         text: String,
         userKey: String? = null,
         name: String? = null,
@@ -61,14 +61,14 @@ class PastebinClient(private val devKey: String) {
         }
     }
 
-    suspend fun login(username: String, password: String): String {
+    public suspend fun login(username: String, password: String): String {
         return sendRequest(API_URL_LOGIN) {
             append("api_user_name", username)
             append("api_user_password", password)
         }
     }
 
-    suspend fun listPastes(userKey: String, resultsLimit: Int? = null): List<PasteDetails> {
+    public suspend fun listPastes(userKey: String, resultsLimit: Int? = null): List<PasteDetails> {
         val out = sendRequest(API_URL_POST) {
             append("api_user_key", userKey)
             append("api_option", "list")
@@ -84,7 +84,7 @@ class PastebinClient(private val devKey: String) {
     @SerialName("root")
     private data class ListPastesResponse(@XmlSerialName("paste", "", "") val data: List<PasteDetails>)
 
-    suspend fun deletePaste(userKey: String, pasteKey: String) {
+    public suspend fun deletePaste(userKey: String, pasteKey: String) {
         val out = sendRequest(API_URL_POST) {
             append("api_option", "delete")
             append("api_user_key", userKey)
@@ -94,15 +94,15 @@ class PastebinClient(private val devKey: String) {
             throw PastebinException(out)
     }
 
-    suspend fun getUserDetails(userKey: String): UserDetails {
+    public suspend fun getUserDetails(userKey: String): UserDetails {
         val out = sendRequest(API_URL_POST) {
             append("api_option", "userdetails")
             append("api_user_key", userKey)
         }
         return xml.parse(UserDetails.serializer(), out)
     }
 
-    suspend fun getPaste(userKey: String, pasteKey: String): String {
+    public suspend fun getPaste(userKey: String, pasteKey: String): String {
         return sendRequest(API_URL_RAW) {
             append("api_option", "show_paste")
             append("api_user_key", userKey)
diff --git a/src/commonMain/kotlin/net/pearx/kpastebin/PastebinExceptions.kt b/src/commonMain/kotlin/net/pearx/kpastebin/PastebinExceptions.kt
@@ -0,0 +1,21 @@
+package net.pearx.kpastebin
+
+import net.pearx.kpastebin.model.Privacy
+
+public class InvalidUserKeyException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+
+public class FreePasteLimitException(public val privacy: Privacy, message: String, cause: Throwable? = null) : PastebinException(message, cause)
+public class PasteSizeException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+public class EmptyPasteException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+public class InvalidPasteFormatException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+
+public class InvalidLoginException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+public class AccountNotActiveException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+
+public class InvalidPermissionException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+
+public class PasteNotFoundException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+
+public class PastePerDayLimitException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+
+public open class PastebinException(message: String, cause: Throwable? = null) : RuntimeException(message, cause)
diff --git a/src/commonMain/kotlin/net/pearx/kpastebin/internal/ExceptionHelper.kt b/src/commonMain/kotlin/net/pearx/kpastebin/internal/ExceptionHelper.kt
@@ -1,5 +1,6 @@
-package net.pearx.kpastebin
+package net.pearx.kpastebin.internal
 
+import net.pearx.kpastebin.*
 import net.pearx.kpastebin.model.Privacy
 
 private const val BAD_API_REQUEST = "Bad API request, "
@@ -30,22 +31,4 @@ internal fun checkPastebinResponse(response: String) {
             }
         }
     }
-}
-
-class InvalidUserKeyException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
-
-class FreePasteLimitException(val privacy: Privacy, message: String, cause: Throwable? = null) : PastebinException(message, cause)
-class PasteSizeException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
-class EmptyPasteException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
-class InvalidPasteFormatException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
-
-class InvalidLoginException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
-class AccountNotActiveException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
-
-class InvalidPermissionException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
-
-class PasteNotFoundException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
-
-class PastePerDayLimitException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
-
-open class PastebinException(message: String, cause: Throwable? = null) : RuntimeException(message, cause)
+}
diff --git a/src/commonMain/kotlin/net/pearx/kpastebin/model/AccountType.kt b/src/commonMain/kotlin/net/pearx/kpastebin/model/AccountType.kt
@@ -5,7 +5,7 @@ import net.pearx.kpastebin.internal.EnumIntSerializer
 import net.pearx.kpastebin.internal.MODEL_PACKAGE
 
 @Serializable(with = AccountType.Ser::class)
-enum class AccountType
+public enum class AccountType
 {
     NORMAL,
     PRO;
diff --git a/src/commonMain/kotlin/net/pearx/kpastebin/model/ExpireDate.kt b/src/commonMain/kotlin/net/pearx/kpastebin/model/ExpireDate.kt
@@ -4,7 +4,7 @@ import kotlinx.serialization.*
 import net.pearx.kpastebin.internal.MODEL_PACKAGE
 
 @Serializable
-enum class ExpireDate(val code: String) {
+public enum class ExpireDate(internal val code: String) {
     NEVER("N"),
     TEN_MINUTES("10M"),
     ONE_HOUR("1H"),
@@ -16,7 +16,7 @@ enum class ExpireDate(val code: String) {
     ONE_YEAR("1Y");
 
     @Serializer(forClass = ExpireDate::class)
-    companion object Ser : KSerializer<ExpireDate> {
+    internal companion object Ser : KSerializer<ExpireDate> {
         override val descriptor: SerialDescriptor = PrimitiveDescriptor("$MODEL_PACKAGE.ExpireDate", PrimitiveKind.STRING)
 
         override fun deserialize(decoder: Decoder): ExpireDate {
diff --git a/src/commonMain/kotlin/net/pearx/kpastebin/model/PasteDetails.kt b/src/commonMain/kotlin/net/pearx/kpastebin/model/PasteDetails.kt
@@ -6,7 +6,7 @@ import nl.adaptivity.xmlutil.serialization.XmlElement
 
 @SerialName("paste")
 @Serializable
-data class PasteDetails(
+public data class PasteDetails(
     @SerialName("paste_key")
     @XmlElement(true)
     val key: String,
diff --git a/src/commonMain/kotlin/net/pearx/kpastebin/model/Privacy.kt b/src/commonMain/kotlin/net/pearx/kpastebin/model/Privacy.kt
@@ -5,7 +5,7 @@ import net.pearx.kpastebin.internal.EnumIntSerializer
 import net.pearx.kpastebin.internal.MODEL_PACKAGE
 
 @Serializable(with = Privacy.Ser::class)
-enum class Privacy {
+public enum class Privacy {
     PUBLIC,
     UNLISTED,
     PRIVATE;
diff --git a/src/commonMain/kotlin/net/pearx/kpastebin/model/UserDetails.kt b/src/commonMain/kotlin/net/pearx/kpastebin/model/UserDetails.kt
@@ -6,7 +6,7 @@ import nl.adaptivity.xmlutil.serialization.XmlElement
 
 @SerialName("user")
 @Serializable
-data class UserDetails(
+public data class UserDetails(
     @SerialName("user_name")
     @XmlElement(true)
     val name: String,

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import net.pearx.kpastebin.internal.EnumIntSerializer`
`5`	`5`	`import net.pearx.kpastebin.internal.MODEL_PACKAGE`
`6`	`6`
`7`	`7`	`@Serializable(with = AccountType.Ser::class)`
`8`		`-enum class AccountType`
	`8`	`+public enum class AccountType`
`9`	`9`	`{`
`10`	`10`	`NORMAL,`
`11`	`11`	`PRO;`