Merge pull request #185 from InsanusMokrassar/0.17.2

0.17.2

.gitignore

@@ -8,3 +8,4 @@ settings.xml
 .gradle/
 build/
 out/
+kotlin-js-store/

CHANGELOG.md

@@ -1,5 +1,54 @@
 # SauceNaoAPI Changelog
 
+## 0.17.2
+
+* Versions:
+  * `Coroutines`: `1.7.3`
+  * `Ktor`: `2.3.4`
+  * `MicroUtils`: `0.19.9`
+
+## 0.17.1
+
+* Versions:
+  * `Coroutines`: `1.7.2`
+  * `Ktor`: `2.3.2`
+  * `MicroUtils`: `0.19.7`
+
+## 0.17.0
+
+* Versions:
+  * `Kotlin`: `1.8.22`
+  * `Serialization`: `1.5.1`
+  * `Ktor`: `2.3.1`
+  * `MicroUtils`: `0.19.2`
+  * `Klock`: `4.0.3`
+
+## 0.16.0
+
+Add `MicroUtils` as used micro utils
+
+* Versions:
+  * `Kotlin`: `1.8.21`
+  * `Ktor`: `2.3.0`
+
+## 0.15.1
+
+* Versions:
+  * `Ktor`: `2.2.4`
+
+## 0.15.0
+
+* Versions:
+  * `Kotlin`: `1.8.10`
+  * `Serialization`: `1.5.0`
+  * `Ktor`: `2.2.3`
+
+## 0.14.0
+
+* `LimitStatus` is `Comparable<LimitStatus>` since this update
+* `Limits` is `Comparable<Limits>` since this update
+* Main API has been changed
+
 ## 0.13.0
 
 * Versions:

build.gradle

@@ -28,11 +28,19 @@ repositories {
 }
 
 kotlin {
-    jvm()
+    jvm {
+        compilations.main {
+            kotlinOptions {
+                jvmTarget = "1.8"
+            }
+        }
+    }
     js(IR) {
         browser()
         nodejs()
     }
+    linuxX64()
+    mingwX64()
 
 
     sourceSets {
@@ -44,6 +52,9 @@ kotlin {
                 api libs.kt.serialization
                 api libs.klock
                 api libs.ktor.client
+                api libs.microutils.common
+                api libs.microutils.ktor.common
+                api libs.microutils.mimetypes
             }
         }
         commonTest {
@@ -65,3 +76,8 @@ kotlin {
         }
     }
 }
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}

gradle.properties

@@ -1,3 +1,3 @@
 kotlin.code.style=official
 
-library_version=0.13.0
+library_version=0.17.2

gradle/libs.versions.toml

@@ -1,11 +1,13 @@
 [versions]
 
-kt = "1.7.22"
-kt-serialization = "1.4.1"
-kt-coroutines = "1.6.4"
+kt = "1.8.22"
+kt-serialization = "1.5.1"
+kt-coroutines = "1.7.3"
 
-klock = "3.4.0"
-ktor = "2.2.1"
+klock = "4.0.3"
+ktor = "2.3.4"
+
+microutils = "0.19.9"
 
 gh-release = "2.4.1"
 
@@ -20,6 +22,10 @@ klock = { module = "com.soywiz.korlibs.klock:klock", version.ref = "klock" }
 ktor-client = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }
 ktor-client-okhttp = { module = "io.ktor:ktor-client-okhttp", version.ref = "ktor" }
 
+microutils-common = { module = "dev.inmo:micro_utils.common", version.ref = "microutils" }
+microutils-ktor-common = { module = "dev.inmo:micro_utils.ktor.common", version.ref = "microutils" }
+microutils-mimetypes = { module = "dev.inmo:micro_utils.mime_types", version.ref = "microutils" }
+
 buildscript-kt-gradle = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kt" }
 buildscript-kt-serialization = { module = "org.jetbrains.kotlin:kotlin-serialization", version.ref = "kt" }
 buildscript-gh-release = { module = "com.github.breadmoirai:github-release", version.ref = "gh-release" }

gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-bin.zip

src/commonMain/kotlin/dev/inmo/saucenaoapi/SauceNaoAPI.kt

@@ -1,5 +1,7 @@
 package dev.inmo.saucenaoapi
 
+import dev.inmo.micro_utils.common.MPPFile
+import dev.inmo.micro_utils.ktor.common.input
 import dev.inmo.saucenaoapi.exceptions.TooManyRequestsException
 import dev.inmo.saucenaoapi.exceptions.sauceNaoAPIException
 import dev.inmo.saucenaoapi.models.*
@@ -22,6 +24,7 @@ private const val URL_FIELD = "url"
 private const val FILE_FIELD = "file"
 private const val FILENAME_FIELD = "filename"
 private const val DB_FIELD = "db"
+private const val DBS_FIELD = "dbs[]"
 private const val DBMASK_FIELD = "dbmask"
 private const val DBMASKI_FIELD = "dbmaski"
 private const val RESULTS_COUNT_FIELD = "numres"
@@ -92,6 +95,45 @@ data class SauceNaoAPI(
         minSimilarity = minSimilarity
     )
 
+    /**
+     * @param db search a specific index number or all without needing to generate a bitmask.
+     * @param dbs search one or more specific index number, set more than once to search multiple.
+     */
+    suspend fun requestByDBs(
+        url: String,
+        db: Int? = null,
+        dbs: Array<Int>? = null,
+        resultsCount: Int? = null,
+        minSimilarity: Float? = null
+    ): SauceNaoAnswer = makeRequest(
+        url.asSauceRequestSubject,
+        db = db,
+        dbs = dbs,
+        resultsCount = resultsCount,
+        minSimilarity = minSimilarity
+    )
+
+    /**
+     * @param mask Mask for selecting specific indexes to ENABLE. dbmask=8191 will search all of the first 14 indexes. If intending to search all databases, the db=999 option is more appropriate.
+     * @param excludedMask Mask for selecting specific indexes to DISABLE. dbmaski=8191 would search only indexes higher than the first 14. This is ideal when attempting to disable only certain indexes, while allowing future indexes to be included by default.
+     *
+     * Bitmask Note: Index numbers start with 0. Even though pixiv is labeled as index 5, it would be controlled with the 6th bit position, which has a decimal value of 32 when set.
+     * db=<index num or 999 for all>
+     */
+    suspend fun requestByMasks(
+        url: String,
+        mask: Int?,
+        excludedMask: Int? = null,
+        resultsCount: Int? = null,
+        minSimilarity: Float? = null
+    ): SauceNaoAnswer = makeRequest(
+        url.asSauceRequestSubject,
+        dbmask = mask,
+        dbmaski = excludedMask,
+        resultsCount = resultsCount,
+        minSimilarity = minSimilarity
+    )
+
     suspend fun request(
         mediaInput: Input,
         mimeType: ContentType,
@@ -103,51 +145,139 @@ data class SauceNaoAPI(
         minSimilarity = minSimilarity
     )
 
+    /**
+     * @param db search a specific index number or all without needing to generate a bitmask.
+     * @param dbs search one or more specific index number, set more than once to search multiple.
+     */
+    suspend fun requestByDBs(
+        mediaInput: Input,
+        mimeType: ContentType,
+        db: Int? = null,
+        dbs: Array<Int>? = null,
+        resultsCount: Int? = null,
+        minSimilarity: Float? = null
+    ): SauceNaoAnswer = makeRequest(
+        mediaInput.asSauceRequestSubject(mimeType),
+        db = db,
+        dbs = dbs,
+        resultsCount = resultsCount,
+        minSimilarity = minSimilarity
+    )
+
+    /**
+     * @param mask Mask for selecting specific indexes to ENABLE. dbmask=8191 will search all of the first 14 indexes. If intending to search all databases, the db=999 option is more appropriate.
+     * @param excludedMask Mask for selecting specific indexes to DISABLE. dbmaski=8191 would search only indexes higher than the first 14. This is ideal when attempting to disable only certain indexes, while allowing future indexes to be included by default.
+     *
+     * Bitmask Note: Index numbers start with 0. Even though pixiv is labeled as index 5, it would be controlled with the 6th bit position, which has a decimal value of 32 when set.
+     * db=<index num or 999 for all>
+     */
+    suspend fun requestByMasks(
+        mediaInput: Input,
+        mimeType: ContentType,
+        mask: Int?,
+        excludedMask: Int? = null,
+        resultsCount: Int? = null,
+        minSimilarity: Float? = null
+    ): SauceNaoAnswer = makeRequest(
+        mediaInput.asSauceRequestSubject(mimeType),
+        dbmask = mask,
+        dbmaski = excludedMask,
+        resultsCount = resultsCount,
+        minSimilarity = minSimilarity
+    )
+
     suspend fun request(
         file: MPPFile,
         resultsCount: Int? = null,
         minSimilarity: Float? = null
     ): SauceNaoAnswer = request(
-        file.input,
+        file.input(),
         file.contentType,
-        resultsCount = resultsCount,
-        minSimilarity = minSimilarity
+        resultsCount,
+        minSimilarity
     )
 
+    /**
+     * @param db search a specific index number or all without needing to generate a bitmask.
+     * @param dbs search one or more specific index number, set more than once to search multiple.
+     */
+    suspend fun requestByDBs(
+        file: MPPFile,
+        db: Int? = null,
+        dbs: Array<Int>? = null,
+        resultsCount: Int? = null,
+        minSimilarity: Float? = null
+    ): SauceNaoAnswer = requestByDBs(
+        file.input(),
+        file.contentType,
+        db,
+        dbs,
+        resultsCount,
+        minSimilarity
+    )
+
+    /**
+     * @param mask Mask for selecting specific indexes to ENABLE. dbmask=8191 will search all of the first 14 indexes. If intending to search all databases, the db=999 option is more appropriate.
+     * @param excludedMask Mask for selecting specific indexes to DISABLE. dbmaski=8191 would search only indexes higher than the first 14. This is ideal when attempting to disable only certain indexes, while allowing future indexes to be included by default.
+     *
+     * Bitmask Note: Index numbers start with 0. Even though pixiv is labeled as index 5, it would be controlled with the 6th bit position, which has a decimal value of 32 when set.
+     * db=<index num or 999 for all>
+     */
+    suspend fun requestByMasks(
+        file: MPPFile,
+        mask: Int?,
+        excludedMask: Int? = null,
+        resultsCount: Int? = null,
+        minSimilarity: Float? = null
+    ): SauceNaoAnswer = requestByMasks(
+        file.input(),
+        file.contentType,
+        mask,
+        excludedMask,
+        resultsCount,
+        minSimilarity
+    )
+
+    @Deprecated("Renamed", ReplaceWith("requestByDBs(url, db, null, resultsCount, minSimilarity)"))
     suspend fun requestByDb(
         url: String,
         db: Int,
         resultsCount: Int? = null,
         minSimilarity: Float? = null
-    ): SauceNaoAnswer = makeRequest(
-        url.asSauceRequestSubject,
-        db = db,
-        resultsCount = resultsCount,
-        minSimilarity = minSimilarity
+    ): SauceNaoAnswer = requestByDBs(
+        url,
+        db,
+        null,
+        resultsCount,
+        minSimilarity
     )
 
-    suspend fun requestByMask(
+    @Deprecated("Renamed", ReplaceWith("requestByMasks(url, dbmask, null, resultsCount, minSimilarity)"))
+    suspend fun request(
         url: String,
         dbmask: Int,
         resultsCount: Int? = null,
         minSimilarity: Float? = null
-    ): SauceNaoAnswer = makeRequest(
-        url.asSauceRequestSubject,
-        dbmask = dbmask,
-        resultsCount = resultsCount,
-        minSimilarity = minSimilarity
+    ): SauceNaoAnswer = requestByMasks(
+        url,
+        dbmask,
+        null,
+        resultsCount,
+        minSimilarity
     )
 
+    @Deprecated("Renamed", ReplaceWith("requestByMasks(url, null, dbmaski, resultsCount, minSimilarity)"))
     suspend fun requestByMaskI(
         url: String,
         dbmaski: Int,
         resultsCount: Int? = null,
         minSimilarity: Float? = null
-    ): SauceNaoAnswer = makeRequest(
-        url.asSauceRequestSubject,
-        dbmaski = dbmaski,
-        resultsCount = resultsCount,
-        minSimilarity = minSimilarity
+    ): SauceNaoAnswer = requestByMasks(
+        url,
+        null,
+        dbmaski,
+        resultsCount,
+        minSimilarity
     )
 
     private suspend fun makeRequest(
@@ -169,6 +299,7 @@ data class SauceNaoAPI(
     private suspend fun makeRequest(
         request: SauceRequestSubject,
         db: Int? = null,
+        dbs: Array<Int>? = null,
         dbmask: Int? = null,
         dbmaski: Int? = null,
         resultsCount: Int? = null,
@@ -183,6 +314,7 @@ data class SauceNaoAPI(
                 apiToken ?.also { parameter(API_TOKEN_FIELD, it) }
                 parameter(OUTPUT_TYPE_FIELD, JsonOutputType.typeCode)
                 db ?.also { parameter(DB_FIELD, it) }
+                dbs ?.forEach { parameter(DBS_FIELD, it) }
                 dbmask ?.also { parameter(DBMASK_FIELD, it) }
                 dbmaski ?.also { parameter(DBMASKI_FIELD, it) }
                 resultsCount ?.also { parameter(RESULTS_COUNT_FIELD, it) }

src/commonMain/kotlin/dev/inmo/saucenaoapi/additional/Utils.kt

@@ -1,6 +1,6 @@
 package dev.inmo.saucenaoapi.additional
 
-import com.soywiz.klock.TimeSpan
+import korlibs.time.TimeSpan
 
 typealias AccountType = Int
 const val defaultAccountType: AccountType = 1 // "basic"

src/commonMain/kotlin/dev/inmo/saucenaoapi/additional/header/AccountInfo.kt

@@ -29,15 +29,27 @@ val Header.accountInfo
 data class LimitStatus(
     val remain: Int = Int.MAX_VALUE,
     val limit: Int = Int.MAX_VALUE
-)
+) : Comparable<LimitStatus> {
+    override fun compareTo(other: LimitStatus): Int = when {
+        limit == other.limit && remain == other.remain -> 0
+        else -> remain.compareTo(other.remain)
+    }
+}
 
 data class Limits(
     val short: LimitStatus = LimitStatus(),
     val long: LimitStatus = LimitStatus()
-)
+) : Comparable<Limits> {
+    override fun compareTo(other: Limits): Int = when {
+        long == other.long && short == other.short -> 0
+        else -> short.remain.compareTo(other.short.remain)
+    }
+}
 
 data class AccountInfo(
     val accountType: AccountType = defaultAccountType,
     val userId: UserId? = null,
     val limits: Limits = Limits()
-)
+) : Comparable<AccountInfo> {
+    override fun compareTo(other: AccountInfo): Int = limits.compareTo(other.limits)
+}

src/commonMain/kotlin/dev/inmo/saucenaoapi/exceptions/TooManyRequestsException.kt

@@ -1,6 +1,6 @@
 package dev.inmo.saucenaoapi.exceptions
 
-import com.soywiz.klock.TimeSpan
+import korlibs.time.TimeSpan
 import dev.inmo.saucenaoapi.additional.LONG_TIME_RECALCULATING_MILLIS
 import dev.inmo.saucenaoapi.additional.SHORT_TIME_RECALCULATING_MILLIS
 import io.ktor.client.plugins.ClientRequestException

src/commonMain/kotlin/dev/inmo/saucenaoapi/models/LimitsState.kt

@@ -8,4 +8,6 @@ data class LimitsState(
     val maxLongQuota: Int,
     val knownShortQuota: Int,
     val knownLongQuota: Int
-)
+) : Comparable<LimitsState> {
+    override fun compareTo(other: LimitsState): Int = knownShortQuota.compareTo(other.knownShortQuota)
+}

src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/MPPFile.kt

@@ -1,9 +1,26 @@
 package dev.inmo.saucenaoapi.utils
 
+import dev.inmo.micro_utils.common.MPPFile
+import dev.inmo.micro_utils.common.filename
+import dev.inmo.micro_utils.ktor.common.input
+import dev.inmo.micro_utils.mime_types.KnownMimeTypes
+import dev.inmo.micro_utils.mime_types.getMimeType
 import io.ktor.http.ContentType
 import io.ktor.utils.io.core.Input
 
-expect class MPPFile
+@Deprecated(
+    "MPPFile from microutils is preferable since 0.16.0",
+    ReplaceWith("MPPFile", "dev.inmo.micro_utils.common.MPPFile")
+)
+typealias MPPFile = MPPFile
 
-expect val MPPFile.input: Input
-expect val MPPFile.contentType: ContentType
+@Deprecated(
+    "input() from microutils is preferable since 0.16.0",
+    ReplaceWith("this.input()", "dev.inmo.micro_utils.ktor.common.input")
+)
+val MPPFile.input: Input
+    get() = input()
+val MPPFile.contentType: ContentType
+    get() = ContentType.parse(
+        getMimeType(stringWithExtension = filename.extension) ?.raw ?: KnownMimeTypes.Any.raw
+    )

src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/RequestQuotaManager.kt

@@ -1,6 +1,6 @@
 package dev.inmo.saucenaoapi.utils
 
-import com.soywiz.klock.DateTime
+import korlibs.time.DateTime
 import dev.inmo.saucenaoapi.additional.LONG_TIME_RECALCULATING_MILLIS
 import dev.inmo.saucenaoapi.additional.SHORT_TIME_RECALCULATING_MILLIS
 import dev.inmo.saucenaoapi.exceptions.TooManyRequestsException

src/commonMain/kotlin/dev/inmo/saucenaoapi/utils/TimeManager.kt

@@ -1,6 +1,6 @@
 package dev.inmo.saucenaoapi.utils
 
-import com.soywiz.klock.DateTime
+import korlibs.time.DateTime
 import dev.inmo.saucenaoapi.additional.LONG_TIME_RECALCULATING_MILLIS
 import dev.inmo.saucenaoapi.additional.SHORT_TIME_RECALCULATING_MILLIS
 import kotlinx.coroutines.*

src/jsMain/kotlin/dev/inmo/saucenaoapi/utils/ActualMPPFile.kt

@@ -1,18 +0,0 @@
-package dev.inmo.saucenaoapi.utils
-
-import io.ktor.http.ContentType
-import io.ktor.utils.io.core.ByteReadPacket
-import io.ktor.utils.io.core.Input
-import org.khronos.webgl.Int8Array
-import org.w3c.files.File
-import org.w3c.files.FileReaderSync
-
-actual typealias MPPFile = File
-
-actual val MPPFile.input: Input
-    get() {
-        val reader = FileReaderSync()
-        return ByteReadPacket(Int8Array(reader.readAsArrayBuffer(this)) as ByteArray)
-    }
-actual val MPPFile.contentType: ContentType
-    get() = ContentType.parse(type)

src/jvmMain/kotlin/dev/inmo/saucenaoapi/utils/ActualMPPFile.kt

@@ -1,14 +0,0 @@
-package dev.inmo.saucenaoapi.utils
-
-import io.ktor.http.ContentType
-import io.ktor.utils.io.core.Input
-import io.ktor.utils.io.streams.asInput
-import java.io.File
-import java.nio.file.Files
-
-actual typealias MPPFile = File
-
-actual val MPPFile.input: Input
-    get() = inputStream().asInput()
-actual val MPPFile.contentType: ContentType
-    get() = ContentType.parse(Files.probeContentType(toPath()))