Release 1.8.0

Author: aallam

.gitignore

@@ -1,21 +1,31 @@
-/build
-/.idea
+# Gradle
 .gradle
-.DS_STORE
-*.iml
+gradlew.bat
+build
 local.properties
+reports
+build
 
-# fastlane specific
-**/fastlane/report.xml
+# IntelliJ IDEA
+.idea
+*.iml
+*.ipl
+*.iws
+classes/
+idea-classes/
+coverage-error.log
 
-# deliver temporary files
-**/fastlane/Preview.html
+# Finder
+.DS_Store
 
-# snapshot generated screenshots
+# fastlane
+**/fastlane/report.xml
+**/fastlane/Preview.html
 **/fastlane/screenshots
-
-# scan temporary files
 **/fastlane/test_output
 
 # bitrise
 .bitrise.yml
+
+# Java
+*.hprof

CHANGELOG.md

@@ -1,3 +1,15 @@
+# 1.8.0
+
+### Added
+- Facets ordering (#245)
+
+### Fixed
+- Analytics: fields nullability in response variant (#262)
+
+### Changed
+- Update Kotlin to 1.5.10
+- Update Ktor 1.6.0
+
 # 1.7.0
 
 ### Added

DOCKER_README.md

@@ -0,0 +1,83 @@
+In this page you will find our recommended way of installing Docker on your machine.
+This guide is made for OSX users.
+
+## Install docker
+
+First install Docker using [Homebrew](https://brew.sh/)
+```
+$ brew install docker
+```
+
+You can then install [Docker Desktop](https://docs.docker.com/get-docker/) if you wish, or use `docker-machine`. As we prefer the second option, we will only document this one.
+
+## Setup your docker
+
+Install `docker-machine`
+```
+$ brew install docker-machine
+```
+
+Then install [VirtualBox](https://www.virtualbox.org/) with [Homebrew Cask](https://github.com/Homebrew/homebrew-cask) to get a driver for your Docker machine
+```
+$ brew cask install virtualbox
+```
+
+You may need to enter your password and authorize the application in your `System Settings` > `Security & Privacy`.
+
+Create now a new machine, set it up as default and connect your shell to it (here we use zsh. The commands should anyway be displayed in each steps' output)
+
+```
+$ docker-machine create --driver virtualbox default
+$ docker-machine env default
+$ eval "$(docker-machine env default)"
+```
+
+Now you're all setup to use our provided Docker image!
+
+## Build the image
+
+```bash
+docker build -t algolia-kotlin .
+```
+
+## Run the image
+
+You need to provide few environment variables at runtime to be able to run the [Common Test Suite](https://github.com/algolia/algoliasearch-client-specs/tree/master/common-test-suite).
+You can set them up directly in the command:
+
+```bash
+docker run -it --rm --env ALGOLIA_APP_ID=XXXXXX [...] -v $PWD:/app -w /app algolia-kotlin bash
+```
+
+However, we advise you to export them in your `.bashrc` or `.zshrc`. That way, you can use [Docker's shorten syntax](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) to set your variables.
+
+```bash
+### For external contributors, only the following env variables should be enough
+docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
+                    --env ALGOLIA_ADMIN_KEY_1 \
+                    --env ALGOLIA_SEARCH_KEY_1 \
+-v $PWD:/app -w /app algolia-kotlin bash
+
+### This is needed only to run the full test suite
+docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
+                    --env ALGOLIA_ADMIN_KEY_1 \
+                    --env ALGOLIA_SEARCH_KEY_1 \
+                    --env ALGOLIA_APPLICATION_ID_2 \
+                    --env ALGOLIA_ADMIN_KEY_2 \
+                    --env ALGOLIA_APPLICATION_ID_MCM \
+                    --env ALGOLIA_ADMIN_KEY_MCM \
+-v $PWD:/app -w /app algolia-kotlin bash
+```
+
+Once your container is running, any changes you make in your IDE are directly reflected in the container.
+
+To build and run tests, you can use the following commands:
+```shell script
+# build the project
+./gradlew assemble
+
+# run tests
+./gradlew jvmTest
+```
+
+Feel free to contact us if you have any questions.

Dockerfile

@@ -0,0 +1,6 @@
+FROM openjdk:11
+
+ENV GRADLE_OPTS="-Dkotlin.compiler.execution.strategy=in-process -Dkotlin.incremental=false"
+WORKDIR /app
+COPY . /app/
+RUN ./gradlew dependencies

README.md

@@ -159,6 +159,10 @@ If however, you don’t use R8 you have to apply the rules from [this file](src/
 
 Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/kotlin/) where you will find answers for the most common issues and gotchas with the client.
 
+## Use the Dockerfile
+
+If you want to contribute to this project without installing all its dependencies, you can use our Docker image. Please check our [dedicated guide](DOCKER_README.MD) to learn more.
+
 ## 📄 License
 
 Algolia Kotlin API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

build.gradle.kts

@@ -1,167 +1,27 @@
-import com.diffplug.gradle.spotless.SpotlessExtension
-import org.jetbrains.kotlin.gradle.dsl.KotlinCompile
-
 buildscript {
     repositories {
         mavenCentral()
-        google()
     }
     dependencies {
-        classpath(plugin.Spotless())
-    }
-}
-
-plugins {
-    kotlin("multiplatform") version "1.4.30"
-    kotlin("plugin.serialization") version "1.4.30"
-    id("maven-publish")
-    id("signing")
-}
-
-apply(plugin = "com.diffplug.spotless")
-
-repositories {
-    mavenCentral()
-    google()
-}
-
-version = Library.version
-group = Library.group
-
-kotlin {
-    explicitApi()
-    jvm {
-        compilations.all {
-            kotlinOptions {
-                jvmTarget = "1.8"
-            }
-        }
-    }
-
-    sourceSets {
-        all {
-            languageSettings.progressiveMode = true
-        }
-        val commonMain by getting {
-            kotlin.srcDirs("$buildDir/generated/sources/templates/kotlin/main")
-            dependencies {
-                api(Ktor("client"))
-                api(Ktor("client-json"))
-                api(Ktor("client-logging"))
-                api(Ktor("client-serialization"))
-            }
-        }
-        val commonTest by getting {
-            dependencies {
-                implementation(kotlin("test"))
-                implementation(kotlin("test-annotations-common"))
-                implementation(Ktor("client"))
-                implementation(Ktor("client-mock"))
-            }
-        }
-        val jvmTest by getting {
-            dependencies {
-                implementation(kotlin("test-junit"))
-                implementation(Ktor("client-okhttp"))
-                implementation(Ktor("client-apache"))
-                implementation(Ktor("client-android"))
-            }
-        }
-    }
-}
-
-tasks {
-
-    withType<KotlinCompile<*>>().configureEach {
-        dependsOn("copyTemplates")
-        kotlinOptions.freeCompilerArgs += "-Xopt-in=kotlin.RequiresOptIn"
-    }
-
-    register(name = "copyTemplates", type = Copy::class) {
-        from("src/commonMain/templates")
-        into("$buildDir/generated/sources/templates/kotlin/main")
-        expand("projectVersion" to Library.version)
-        filteringCharset = "UTF-8"
-    }
-
-    withType<Test> {
-        maxParallelForks = Runtime.getRuntime().availableProcessors().minus(1).coerceAtLeast(1)
-    }
-}
-
-configure<SpotlessExtension> {
-    kotlin {
-        target("**/*.kt")
-        ktlint("0.40.0")
-        trimTrailingWhitespace()
-        endWithNewline()
+        val kotlinVersion = "1.5.10"
+        classpath(kotlin("gradle-plugin", version = kotlinVersion))
+        classpath(kotlin("serialization", version = kotlinVersion))
+        classpath(MavenPublish())
+        classpath(Spotless())
     }
 }
 
-//** Publish **//
-val emptyJar by tasks.creating(Jar::class) {
-    archiveAppendix.set("empty")
+project.extensions.extraProperties.apply {
+    set("GROUP", Library.group)
+    set("VERSION_NAME", Library.version)
 }
 
-publishing {
+subprojects {
     repositories {
-        maven {
-            name = "MavenCentral"
-            url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2")
-            credentials {
-                username = System.getenv("SONATYPE_USER")
-                password = System.getenv("SONATYPE_KEY")
-            }
-        }
-    }
-
-    publications.withType<MavenPublication>().all {
-        groupId = Library.group
-        version = Library.version
-        artifactId = when (name) {
-            "kotlinMultiplatform" -> Library.artifact
-            else -> "${Library.artifact}-$name"
-        }
-
-        artifact(emptyJar) { classifier = "javadoc" }
-
-        pom.withXml {
-            asNode().apply {
-                appendNode("name", "Algolia Search API Client for Kotlin")
-                appendNode("description",
-                    "Algolia is a powerful search-as-a-service solution, made easy to use with API clients, UI libraries," +
-                        "and pre-built integrations. Algolia API Client for Kotlin lets you easily use the Algolia Search" +
-                        "REST API from your JVM project, such as Android or backend implementations.")
-                appendNode("url", "https://github.com/algolia/algoliasearch-client-kotlin")
-                appendNode("licenses")
-                    .appendNode("license").apply {
-                        appendNode("name", "MIT")
-                        appendNode("url", "http://www.opensource.org/licenses/mit-license.php")
-                        appendNode("distribution", "repo")
-                    }
-                appendNode("developers")
-                    .appendNode("developer").apply {
-                        appendNode("id", "algolia")
-                        appendNode("name", "The Algolia Team")
-                        appendNode("email", "[email protected]")
-                        appendNode("organization", "Algolia")
-                        appendNode("organizationUrl", "https://algolia.com")
-                    }
-                appendNode("scm").apply {
-                    appendNode("url", "https://github.com/algolia/algoliasearch-client-kotlin")
-                    appendNode("connection", "scm:git:git://github.com/algolia/algoliasearch-client-kotlin.git")
-                    appendNode("developerConnection",
-                        "scm:git:ssh://github.com:algolia/algoliasearch-client-kotlin.git")
-                }
-            }
-        }
+        mavenCentral()
     }
 }
 
-signing {
-    val signingKeyId = System.getenv("SIGNING_KEY_ID")
-    val signingKey = System.getenv("SIGNING_KEY")
-    val signingPassword = System.getenv("SIGNING_PASSWORD")
-    useInMemoryPgpKeys(signingKeyId, signingKey, signingPassword)
-    sign(publishing.publications)
+tasks.register<Delete>("clean") {
+    delete(rootProject.buildDir)
 }

buildSrc/src/main/kotlin/Ktor.kt

@@ -2,5 +2,5 @@ object Ktor : Dependency {
 
     override val group = "io.ktor"
     override val artifact = "ktor"
-    override val version = "1.5.1"
+    override val version = "1.6.0"
 }

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.7.0"
+    override val version = "1.8.0"
 }

buildSrc/src/main/kotlin/MavenPublish.kt

@@ -0,0 +1,6 @@
+object MavenPublish : Dependency {
+
+    override val group = "com.vanniktech"
+    override val artifact = "gradle-maven-publish-plugin"
+    override val version = "0.15.1"
+}

buildSrc/src/main/kotlin/plugin/Spotless.kt renamed to buildSrc/src/main/kotlin/Spotless.kt

@@ -1,10 +1,6 @@
-package plugin
-
-import Dependency
-
 object Spotless : Dependency {
 
     override val group = "com.diffplug.spotless"
     override val artifact = "spotless-plugin-gradle"
-    override val version = "5.9.0"
+    override val version = "5.14.0"
 }