Merge pull request #132 from algolia/feature/target-android

q-litzler · web-flow · commit 687ca26e9c77 · 2019-11-08T10:54:39.000+01:00
Feature/target android
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,7 +1,16 @@
+import com.android.build.gradle.LibraryExtension
 import com.jfrog.bintray.gradle.tasks.BintrayUploadTask
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 import java.net.URI
 
+buildscript {
+    repositories {
+        google()
+    }
+    dependencies {
+        classpath("com.android.tools.build:gradle:3.5.0")
+    }
+}
 
 plugins {
     id("kotlin-multiplatform") version "1.3.50"
@@ -11,16 +20,48 @@ plugins {
     id("com.github.kukuhyoniatmoko.buildconfigkotlin") version "1.0.5"
 }
 
-version = Library.version
-group = Library.group
+apply(plugin = "com.android.library")
 
 repositories {
     jcenter()
+    google()
     mavenCentral()
     maven { url = URI("https://dl.bintray.com/kotlin/ktor") }
     maven { url = URI("https://kotlin.bintray.com/kotlinx") }
 }
 
+version = Library.version
+group = Library.group
+
+extensions.getByType(LibraryExtension::class.java).apply {
+    compileSdkVersion(28)
+
+    defaultConfig {
+        minSdkVersion(17)
+        targetSdkVersion(28)
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    testOptions.unitTests.isIncludeAndroidResources = true
+
+    sourceSets {
+        getByName("main") {
+            manifest.srcFile("src/androidMain/AndroidManifest.xml")
+            java.srcDirs("src/androidMain/kotlin")
+            res.srcDirs("src/androidMain/res")
+        }
+        getByName("test") {
+            java.srcDirs("src/androidTest/kotlin")
+            res.srcDirs("src/androidTest/res")
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+}
+
 buildConfigKotlin {
     sourceSet("metadata") {
         buildConfig(name = "version", value = Library.version)
@@ -35,6 +76,17 @@ kotlin {
             }
         }
     }
+    android {
+        mavenPublication {
+            artifactId = "${Library.artifact}-android"
+        }
+        publishLibraryVariants("release")
+        compilations.all {
+            kotlinOptions {
+                jvmTarget = "1.8"
+            }
+        }
+    }
     sourceSets {
         all {
             languageSettings.progressiveMode = true
@@ -76,6 +128,26 @@ kotlin {
                 implementation(Ktor("client-android"))
             }
         }
+        val androidMain by getting {
+            dependencies {
+                api(kotlin("stdlib-jdk8"))
+                api(Ktor("client-core-jvm"))
+                api(Ktor("client-json-jvm"))
+                api(Ktor("client-logging-jvm"))
+                api(Ktor("client-serialization-jvm"))
+            }
+        }
+        val androidTest by getting {
+            dependencies {
+                implementation(kotlin("test"))
+                implementation(kotlin("test-junit"))
+                implementation(Ktor("client-mock-jvm"))
+                implementation(Ktor("client-android"))
+                implementation(AndroidTestRunner())
+                implementation(AndroidTestExtRunner())
+                implementation(Robolectric())
+            }
+        }
     }
 }
 
@@ -151,9 +223,8 @@ bintray {
 
 tasks {
     val bintrayUpload by getting(BintrayUploadTask::class) {
-        dependsOn(publishToMavenLocal)
         doFirst {
-            setPublications("jvm", "metadata")
+            setPublications("jvm", "metadata", "androidRelease")
         }
     }
     withType<KotlinCompile> {
diff --git a/buildSrc/src/main/kotlin/AndroidTestExtRunner.kt b/buildSrc/src/main/kotlin/AndroidTestExtRunner.kt
@@ -0,0 +1,6 @@
+object AndroidTestExtRunner : Dependency {
+
+    override val group = "androidx.test.ext"
+    override val artifact = "junit"
+    override val version = "1.1.1"
+}
diff --git a/buildSrc/src/main/kotlin/AndroidTestRunner.kt b/buildSrc/src/main/kotlin/AndroidTestRunner.kt
@@ -0,0 +1,6 @@
+object AndroidTestRunner : Dependency {
+
+    override val group = "androidx.test"
+    override val artifact = "runner"
+    override val version = "1.2.0"
+}
diff --git a/buildSrc/src/main/kotlin/Dependency.kt b/buildSrc/src/main/kotlin/Dependency.kt
@@ -4,7 +4,9 @@ interface Dependency {
     val artifact: String
     val version: String
 
-    operator fun invoke(module: String): String {
-        return "$group:$artifact-$module:$version"
+    operator fun invoke(module: String? = null): String {
+        val optionalModule = if (module != null) "-$module" else ""
+
+        return "$group:$artifact$optionalModule:$version"
     }
 }
diff --git a/buildSrc/src/main/kotlin/Library.kt b/buildSrc/src/main/kotlin/Library.kt
@@ -2,5 +2,5 @@ object Library: Dependency {
 
     override val group = "com.algolia"
     override val artifact = "algoliasearch-client-kotlin"
-    override val version = "1.1.4"
+    override val version = "1.2.0-beta01"
 }
diff --git a/buildSrc/src/main/kotlin/Robolectric.kt b/buildSrc/src/main/kotlin/Robolectric.kt
@@ -0,0 +1,6 @@
+object Robolectric : Dependency {
+
+    override val group = "org.robolectric"
+    override val artifact = "robolectric"
+    override val version = "4.3"
+}
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.3.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -2,7 +2,9 @@ import java.net.URI
 
 pluginManagement {
     repositories {
+        google()
         mavenCentral()
+        jcenter()
         maven { url = URI("https://plugins.gradle.org/m2/") }
     }
     resolutionStrategy {
diff --git a/src/androidMain/AndroidManifest.xml b/src/androidMain/AndroidManifest.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest package="com.algolia.search"/>
diff --git a/src/androidMain/kotlin/com/algolia/search/helper/Date.kt b/src/androidMain/kotlin/com/algolia/search/helper/Date.kt
@@ -0,0 +1,24 @@
+package com.algolia.search.helper
+
+import java.text.SimpleDateFormat
+import java.util.*
+
+
+internal actual object DateISO8601 {
+
+    val dateISO8601 = SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'", Locale.US).apply {
+        timeZone = TimeZone.getTimeZone("UTC")
+    }
+
+    val dateISO8601Millis = SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", Locale.US).apply {
+        timeZone = TimeZone.getTimeZone("UTC")
+    }
+
+    actual fun format(timestamp: Long, inMilliseconds: Boolean): String {
+        return if (inMilliseconds) dateISO8601Millis.format(Date(timestamp)) else dateISO8601.format(Date(timestamp))
+    }
+
+    actual fun parse(date: String, inMilliseconds: Boolean): Long {
+        return if (inMilliseconds) dateISO8601Millis.parse(date)?.time ?: -1 else dateISO8601.parse(date)?.time ?: -1
+    }
+}
diff --git a/src/androidMain/kotlin/com/algolia/search/helper/Encoding.kt b/src/androidMain/kotlin/com/algolia/search/helper/Encoding.kt
@@ -0,0 +1,8 @@
+package com.algolia.search.helper
+
+import java.net.URLEncoder
+
+
+internal actual fun String.encodeUTF8(): String {
+    return URLEncoder.encode(this, "UTF-8")
+}
diff --git a/src/androidMain/kotlin/com/algolia/search/helper/Hashing.kt b/src/androidMain/kotlin/com/algolia/search/helper/Hashing.kt
@@ -0,0 +1,26 @@
+package com.algolia.search.helper
+
+import android.util.Base64
+import kotlinx.io.core.toByteArray
+import kotlinx.serialization.internal.HexConverter
+import javax.crypto.Mac
+import javax.crypto.spec.SecretKeySpec
+
+
+internal actual fun String.sha256(key: String): String {
+    return Mac.getInstance("HmacSHA256").run {
+        val secretKey = SecretKeySpec(this@sha256.toByteArray(), "HmacSHA256")
+
+        init(secretKey)
+        val hash = doFinal(key.toByteArray())
+        HexConverter.printHexBinary(hash, true)
+    }
+}
+
+internal actual fun String.encodeBase64(): String {
+    return String(Base64.encode(toByteArray(), Base64.NO_WRAP))
+}
+
+internal actual fun String.decodeBase64(): String {
+    return String(Base64.decode(this, Base64.NO_WRAP))
+}
diff --git a/src/androidMain/kotlin/com/algolia/search/model/ClientDate.kt b/src/androidMain/kotlin/com/algolia/search/model/ClientDate.kt
@@ -0,0 +1,25 @@
+package com.algolia.search.model
+
+import com.algolia.search.helper.DateISO8601
+import com.algolia.search.serialize.KSerializerClientDate
+import kotlinx.serialization.Serializable
+import java.util.*
+
+
+/**
+ * JVM implementation converting a [String] or a [Long] into a [Date] format. Relies on ISO8601.
+ */
+@Serializable(KSerializerClientDate::class)
+public actual data class ClientDate internal actual constructor(override val raw: String) : Raw<String> {
+
+    internal actual constructor(timestamp: Long) : this(DateISO8601.format(timestamp))
+
+    /**
+     * In the eventuality of the Date format being wrong, we create an empty [Date] object instead of throwing an exception.
+     */
+    val date: Date = when {
+        raw.length == 20 -> DateISO8601.dateISO8601.parse(raw)
+        raw.length == 24 -> DateISO8601.dateISO8601Millis.parse(raw)
+        else -> Date()
+    }
+}
diff --git a/src/androidMain/kotlin/com/algolia/search/model/Time.kt b/src/androidMain/kotlin/com/algolia/search/model/Time.kt
@@ -0,0 +1,9 @@
+package com.algolia.search.model
+
+
+internal actual object Time {
+
+    actual fun getCurrentTimeMillis(): Long {
+        return System.currentTimeMillis()
+    }
+}
diff --git a/src/androidMain/kotlin/com/algolia/search/transport/Gzip.kt b/src/androidMain/kotlin/com/algolia/search/transport/Gzip.kt
@@ -0,0 +1,19 @@
+package com.algolia.search.transport
+
+import io.ktor.util.GZip
+import io.ktor.util.toByteArray
+import kotlinx.coroutines.io.ByteReadChannel
+import kotlinx.coroutines.runBlocking
+
+
+internal actual object Gzip : (String) -> ByteArray {
+
+    @Suppress("EXPERIMENTAL_API_USAGE")
+    override fun invoke(input: String): ByteArray {
+        return runBlocking {
+            GZip.run {
+                encode(ByteReadChannel(input)).toByteArray()
+            }
+        }
+    }
+}
diff --git a/src/androidTest/kotlin/Actual.kt b/src/androidTest/kotlin/Actual.kt
@@ -0,0 +1,82 @@
+import com.algolia.search.client.ClientAnalytics
+import com.algolia.search.client.ClientInsights
+import com.algolia.search.client.ClientPlaces
+import com.algolia.search.client.ClientSearch
+import com.algolia.search.configuration.Compression
+import com.algolia.search.configuration.ConfigurationSearch
+import com.algolia.search.helper.toAPIKey
+import com.algolia.search.helper.toApplicationID
+import kotlinx.coroutines.CoroutineScope
+import java.io.File
+import java.text.SimpleDateFormat
+import java.util.*
+import kotlin.coroutines.CoroutineContext
+
+
+internal actual val clientSearch = ClientSearch(
+    System.getenv("ALGOLIA_APPLICATION_ID_1")!!.toApplicationID(),
+    System.getenv("ALGOLIA_SEARCH_KEY_1")!!.toAPIKey()
+)
+internal actual val clientAdmin1 = ClientSearch(
+    System.getenv("ALGOLIA_APPLICATION_ID_1")!!.toApplicationID(),
+    System.getenv("ALGOLIA_ADMIN_KEY_1")!!.toAPIKey()
+)
+internal actual val clientAdmin2 = ClientSearch(
+    ConfigurationSearch(
+        System.getenv("ALGOLIA_APPLICATION_ID_2")!!.toApplicationID(),
+        System.getenv("ALGOLIA_ADMIN_KEY_2")!!.toAPIKey(),
+        compression = Compression.None
+    )
+)
+internal actual val clientMcm = ClientSearch(
+    System.getenv("ALGOLIA_ADMIN_ID_MCM")!!.toApplicationID(),
+    System.getenv("ALGOLIA_ADMIN_KEY_MCM")!!.toAPIKey()
+)
+internal actual val clientAnalytics = ClientAnalytics(
+    System.getenv("ALGOLIA_APPLICATION_ID_1")!!.toApplicationID(),
+    System.getenv("ALGOLIA_ADMIN_KEY_1")!!.toAPIKey()
+)
+internal actual val clientInsights = ClientInsights(
+    System.getenv("ALGOLIA_APPLICATION_ID_1")!!.toApplicationID(),
+    System.getenv("ALGOLIA_ADMIN_KEY_1")!!.toAPIKey()
+)
+internal actual val clientPlaces = ClientPlaces(
+    System.getenv("ALGOLIA_PLACES_APP_ID")!!.toApplicationID(),
+    System.getenv("ALGOLIA_PLACES_KEY")!!.toAPIKey()
+)
+
+internal actual val username: String
+    get() {
+        return try {
+            System.getProperty("user.name")!!
+        } catch (exception: Exception) {
+            "unknown"
+        }
+    }
+
+internal actual fun runBlocking(coroutineContext: CoroutineContext, block: suspend CoroutineScope.() -> Unit) {
+    kotlinx.coroutines.runBlocking(coroutineContext, block = block)
+}
+
+internal actual object DateFormat {
+
+    private val dateFormat = SimpleDateFormat("YYYY-MM-dd-HH-mm-ss").also {
+        it.timeZone = TimeZone.getTimeZone("UTC")
+    }
+
+    actual fun format(timestamp: Long?): String {
+        return dateFormat.format(if (timestamp != null) Date(timestamp) else Date())
+    }
+
+    actual fun parse(date: String): Long {
+        return dateFormat.parse(date)!!.time
+    }
+}
+
+internal actual fun loadScratch(name: String): String {
+    return if (File("src/commonTest/resources").exists()) {
+        File("src/commonTest/resources/$name").readText()
+    } else {
+        File("../../src/commonTest/resources/$name").readText()
+    }
+}
diff --git a/src/androidTest/kotlin/suite/TestSecuredAPIKey.kt b/src/androidTest/kotlin/suite/TestSecuredAPIKey.kt
diff --git a/src/commonTest/kotlin/suite/TestSecuredAPIKeyTools.kt b/src/commonTest/kotlin/suite/TestSecuredAPIKeyTools.kt
diff --git a/src/jvmTest/kotlin/suite/TestSecuredAPIKey.kt b/src/jvmTest/kotlin/suite/TestSecuredAPIKey.kt

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,9 @@ interface Dependency {`
`4`	`4`	`val artifact: String`
`5`	`5`	`val version: String`
`6`	`6`
`7`		`- operator fun invoke(module: String): String {`
`8`		`- return "$group:$artifact-$module:$version"`
	`7`	`+ operator fun invoke(module: String? = null): String {`
	`8`	`+ val optionalModule = if (module != null) "-$module" else ""`
	`9`	`+`
	`10`	`+ return "$group:$artifact$optionalModule:$version"`
`9`	`11`	`}`
`10`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@ object Library: Dependency {`
`2`	`2`
`3`	`3`	`override val group = "com.algolia"`
`4`	`4`	`override val artifact = "algoliasearch-client-kotlin"`
`5`		`- override val version = "1.1.4"`
	`5`	`+ override val version = "1.2.0-beta01"`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@ import java.net.URI`
`2`	`2`
`3`	`3`	`pluginManagement {`
`4`	`4`	`repositories {`
	`5`	`+ google()`
`5`	`6`	`mavenCentral()`
	`7`	`+ jcenter()`
`6`	`8`	`maven { url = URI("https://plugins.gradle.org/m2/") }`
`7`	`9`	`}`
`8`	`10`	`resolutionStrategy {`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<?xml version="1.0" encoding="utf-8"?>`
	`2`	`+<manifest package="com.algolia.search"/>`