Some minor library changes, the HttpClient now should be provided to PastebinClient

Author: mrapplexz

build.gradle.kts

@@ -6,6 +6,7 @@ val projectChangelog: String by project
 val projectDescription: String by project
 
 val ktorVersion: String by project
+val coroutinesVersion: String by project
 
 val pearxRepoUsername: String? by project
 val pearxRepoPassword: String? by project
@@ -32,12 +33,6 @@ configure<MultiGradleExtension> {
     }
 }
 
-repositories {
-    maven {
-        url = uri("https://dl.bintray.com/pdvrieze/maven")
-    }
-}
-
 kotlinMpp {
     explicitApi()
 
@@ -48,39 +43,10 @@ kotlinMpp {
             }
         }
 
-        val androidMain by getting {
-            dependencies {
-                implementation("io.ktor:ktor-client-android:$ktorVersion")
-            }
-        }
-
-        val jvmMain by getting {
-            dependencies {
-                implementation("io.ktor:ktor-client-cio:$ktorVersion")
-            }
-        }
-
-        val jsMain by getting {
-            dependencies {
-                implementation("io.ktor:ktor-client-js:$ktorVersion")
-            }
-        }
-
-        val posixMain by getting {
-            dependencies {
-                implementation("io.ktor:ktor-client-curl:$ktorVersion")
-            }
-        }
-
-        val appleMobileMain by getting {
-            dependencies {
-                implementation("io.ktor:ktor-client-ios:$ktorVersion")
-            }
-        }
-
-        val jvmTest by getting {
+        val commonTest by getting {
             dependencies {
-                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.8")
+                implementation("io.ktor:ktor-client-mock:$ktorVersion")
+                implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutinesVersion")
             }
         }
     }

gradle.properties

@@ -10,7 +10,7 @@ projectChangelog=
 projectDescription=Multiplatform Kotlin library to interact with the pastebin.com API.
 kotlinVersion=1.4.0
 githubReleaseVersion=2.2.12
-multigradleVersion=1.9.1
+multigradleVersion=1.9.2
 
 #Java Stuff
 javaVersion=8
@@ -23,4 +23,5 @@ compileSdkVersion=android-29
 junitVersion=4.13
 
 #Dependencies
-ktorVersion=1.4.0
+ktorVersion=1.4.0
+coroutinesVersion=1.3.8-native-mt-1.4.0-rc

src/commonMain/kotlin/net/pearx/kpastebin/PastebinClient.kt

@@ -1,5 +1,8 @@
 package net.pearx.kpastebin
 
+import io.ktor.client.HttpClient
+import io.ktor.client.features.ClientRequestException
+import io.ktor.client.request.get
 import io.ktor.client.request.post
 import io.ktor.http.*
 import net.pearx.kpastebin.internal.*
@@ -12,35 +15,37 @@ import net.pearx.kpastebin.model.UserDetails
  * Pastebin API client with specified unique developer API key.
  * You can get your key on [official Pastebin website](https://pastebin.com/doc_api#1).
  *
+ * @param http Ktor [HttpClient] to use
  * @param devKey Unique developer API key
  * @param userKey user key used for requests. Use null for guest user.
  */
 public class PastebinClient(
+    private val http: HttpClient,
     private val devKey: String,
     /**
      * User key used for requests. Use null for guest user. It also can be set using [login] method.
      */
     public var userKey: String? = null
 ) {
-    private suspend fun sendRequest(url: String, userKeyRequired: Boolean, parameters: Parameters): String {
-        val userKey = userKey
-        if (userKeyRequired && userKey == null)
+    private suspend fun sendRequest(url: String, userKeyRequired: Boolean, userKey: String?, parameters: Parameters): String {
+        val usrKey = userKey ?: this.userKey
+        if (userKeyRequired && usrKey == null)
             throw InvalidUserKeyException("The 'userKey' property is null. It can be initialized by setting it directly or using the 'login' function.")
-        val out = Http.post<String> {
+        val out = http.post<String> {
             contentType(ContentType.Application.FormUrlEncoded)
             this.url.takeFrom(url)
             body = Parameters.build {
                 append("api_dev_key", devKey)
-                if (userKey != null)
-                    append("api_user_key", userKey)
+                if (usrKey != null)
+                    append("api_user_key", usrKey)
                 appendAll(parameters)
             }.formUrlEncode()
         }
         checkPastebinResponse(out)
         return out
     }
 
-    private suspend inline fun sendRequest(url: String, userKeyRequired: Boolean, parametersBuilder: ParametersBuilder.() -> Unit) = sendRequest(url, userKeyRequired, Parameters.build(parametersBuilder))
+    private suspend inline fun sendRequest(url: String, userKeyRequired: Boolean, userKey: String? = null, parametersBuilder: ParametersBuilder.() -> Unit) = sendRequest(url, userKeyRequired, userKey, Parameters.build(parametersBuilder))
 
     /**
      * Publishes a new paste with specified [text].
@@ -69,7 +74,7 @@ public class PastebinClient(
             append("api_paste_code", text)
             append("api_paste_name", name)
             append("api_paste_format", format)
-            append("api_privacy", privacy.ordinal.toString())
+            append("api_paste_private", privacy.ordinal.toString())
             append("api_paste_expire_date", expireDate.code)
         }
     }
@@ -135,16 +140,26 @@ public class PastebinClient(
 
     /**
      * Gets text of a paste by its [pasteKey].
+     * If [userKey] is null, you can get only public pastes.
      *
-     * @see net.pearx.kpastebin.getPaste
-     *
-     * @throws InvalidUserKeyException when [userKey] is null, expired or invalid.
+     * @throws InvalidUserKeyException when [userKey] is expired or invalid.
      * @throws PasteNotFoundException when no paste with such [pasteKey] is found.
      */
     public suspend fun getPaste(pasteKey: String): String {
-        return sendRequest(API_URL_RAW, true) {
-            append("api_option", "show_paste")
-            append("api_paste_key", pasteKey)
-        }
+        val userKey = userKey // cache userKey because it can change
+        return if (userKey == null)
+            try {
+                http.get { url.takeFrom("$URL_RAW/$pasteKey") }
+            } catch(ex: ClientRequestException) {
+                if(ex.response?.status == HttpStatusCode.NotFound)
+                    throw PasteNotFoundException(ex.message, ex)
+                else
+                    throw ex
+            }
+        else
+            sendRequest(API_URL_RAW, false, userKey) {
+                append("api_option", "show_paste")
+                append("api_paste_key", pasteKey)
+            }
     }
 }

src/commonMain/kotlin/net/pearx/kpastebin/PastebinExceptions.kt

@@ -2,6 +2,9 @@ package net.pearx.kpastebin
 
 import net.pearx.kpastebin.model.Privacy
 
+/** Thrown by [PastebinClient] when provided dev key is invalid. */
+public class InvalidDevKeyException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+
 /** Thrown by [PastebinClient] when provided user key is invalid, expired or null. */
 public class InvalidUserKeyException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
 
@@ -27,10 +30,10 @@ public class InvalidLoginException(message: String, cause: Throwable? = null) :
 public class AccountNotActiveException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
 
 /** Thrown by [PastebinClient] when paste with specified key doesn't exist or you don't have permissions to view or delete it. */
-public class PasteNotFoundException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
+public class PasteNotFoundException(message: String?, cause: Throwable? = null) : PastebinException(message, cause)
 
 /** Thrown by [PastebinClient] when paste publication limit for current IP per day is exceeded. */
 public class PastePerDayLimitException(message: String, cause: Throwable? = null) : PastebinException(message, cause)
 
 /** Generic Pastebin exception thrown by [PastebinClient]. */
-public open class PastebinException(message: String, cause: Throwable? = null) : RuntimeException(message, cause)
+public open class PastebinException(message: String?, cause: Throwable? = null) : RuntimeException(message, cause)

src/commonMain/kotlin/net/pearx/kpastebin/PastebinGuest.kt

@@ -21,6 +21,7 @@ internal fun checkPastebinResponse(response: String) {
                 "account not active" -> AccountNotActiveException(sub)
                 "invalid permission to remove paste" -> PasteNotFoundException(sub)
                 "invalid permission to view this paste or invalid api_paste_key" -> PasteNotFoundException(sub)
+                "invalid api_dev_key" -> InvalidDevKeyException(sub)
                 else -> PastebinException(sub)
             }
         }

src/commonMain/kotlin/net/pearx/kpastebin/internal/ExceptionHelper.kt

@@ -31,7 +31,7 @@ public data class PasteDetails(
     internal companion object {
         fun parseList(input: String): List<PasteDetails> {
             val lst = mutableListOf<PasteDetails>()
-            // it's a hack because currently there's no multiplatform API to parse XML with Kotlin/Native support
+            // it's a hack because currently there's no multiplatform API to parse XML with Kotlin/Native support. xmlutil doesn't support Kotlin/Native :(.
             for (paste in XML_PARENT_REGEX.findAll(input)) {
                 if (paste.groupValues[1] == "paste") {
                     val map = XML_PROPERTY_REGEX.findAll(paste.groupValues[2]).associate { it.groupValues[1].substring(6) to it.groupValues[2] } // .substring(6) is here to cut the 'paste_' part of each property.

src/commonMain/kotlin/net/pearx/kpastebin/internal/HttpClient.kt

@@ -28,7 +28,7 @@ public data class UserDetails(
 ) {
     internal companion object {
         fun parse(input: String): UserDetails {
-            // it's a hack because currently there's no multiplatform API to parse XML with Kotlin/Native support
+            // it's a hack because currently there's no multiplatform API to parse XML with Kotlin/Native support. xmlutil doesn't support Kotlin/Native :(.
             val user = XML_PARENT_REGEX.matchEntire(input)
             if (user != null && user.groupValues[1] == "user") {
                 val map = XML_PROPERTY_REGEX.findAll(user.groupValues[2]).associate { it.groupValues[1].substring(5) to it.groupValues[2] } // .substring(5) is here to cut the 'user_' part of each property.