Merge branch 'develop'

Release 1.4.0

Author: aallam

.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+tab_width = 4
+
+# noinspection EditorConfigKeyCorrectness
+# Disable Ktlint import ordering temporarily
+# https://github.com/pinterest/ktlint/issues/527
+[*.{kt, kts}]
+disabled_rules = import-ordering

CHANGELOG.md

@@ -1,3 +1,33 @@
+# 1.4.0
+
+Starting from this version, the library is compatible only with kotlin version `1.3.70` or higher, 
+this due the [breaking changes](https://github.com/Kotlin/kotlinx.serialization/blob/master/CHANGELOG.md#0200--2020-03-04) of kotlin serialization library.
+
+### Added
+- Recommendation client (#148)
+- Analytics regions (#170)
+- Natural languages parameter to search query (#173)
+- Logs inner queries (#174)
+- Personalization as part of the `RankingInfo` of the `ResponseSearch` (#185)
+- Unquoted variant of legacy `FilterConverter` (#188)
+- Accept `enablePersonalization` boolean as a valid setting parameter (#183)
+- `appliedRules` as part of the `ResponseSearch` (#184)
+
+### Changed
+- Updated Kotlin to `1.3.72`
+- Updated Ktor client to `1.3.2`
+- Updated Kotlin serialization `0.20.0`
+- Split `Promotion` into two variants: `Single` and `Multiple` (#191)
+
+### Fixed
+- Ensure correctly typing of API key's `restrictIndices` and `restrictSources` parameters (#167, #168)
+- Search response serialization after enabling personalization (#185)
+- Insights event serialization causing errors in old Android JVMs (#189)
+- Omit all line terminators in the base64 encoder (instantsearch-android#191)
+
+### Removed
+- Remove deprecated personalization endpoint in favor of the recommendation client (#185)
+
 # 1.3.1
 
 - Updated Ktor to `1.3.0`
@@ -65,4 +95,4 @@
 - It is now possible to configure `HttpClientConfig` in `Configuration`
 - Added `ClientPlaces` to access Algolia Places endpoints. See this [file](docs/Places.md) for getting starting with Places.
 - `QueryLanguage` is renamed to `Language`
-- Fixed a bug in `browseAllABTests` methods
+- Fixed a bug in `browseAllABTests` methods

CODEOWNERS

@@ -1 +1 @@
-* @q-litzler @PLNech
+* @spinach @Aallam

README.md

@@ -21,7 +21,7 @@
 
 ## ✨ Features
 
-- The Kotlin client is compatible with Kotlin `1.3.41` and higher.
+- The Kotlin client is compatible with Kotlin `1.3.70` and higher.
 - It is compatible with Kotlin project on the JVM, such as backend and Android applications.
 - It relies on the open source Kotlin libraries for seamless integration into Kotlin projects:
   - [Kotlin multiplatform](https://kotlinlang.org/docs/reference/multiplatform.html).
@@ -41,7 +41,11 @@ Install the Kotlin client by adding the following dependency to your `gradle.bui
   }
   
   dependencies {
+     // Search API Client
      implementation "com.algolia:algoliasearch-client-kotlin-jvm:$kotlin_client_version"
+     // alternately - for android, use the following
+     implementation "com.algolia:algoliasearch-client-kotlin-android:$kotlin_client_version"
+
      // Choose one of the following http client
      implementation "io.ktor:ktor-client-apache:$ktor_version"
      implementation "io.ktor:ktor-client-okhttp:$ktor_version"
@@ -53,6 +57,8 @@ Install the Kotlin client by adding the following dependency to your `gradle.bui
 
 For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/api-client/getting-started/install/kotlin/)**.
 
+⚠️ Important: starting from version `1.4.0` the library is compatible only with kotlin version `1.3.70` or higher; for previous versions of kotlin, please use version `1.3.1` of the library.
+
 ### Coroutines
 
 All methods performing HTTP calls in the Kotlin client are [suspending functions](https://kotlinlang.org/docs/reference/coroutines/composing-suspending-functions.html#composing-suspending-functions). 

SECURITY.md

@@ -0,0 +1,3 @@
+## Reporting a Vulnerability
+
+To report a security vulnerability, please use the [Algolia security email]([email protected]). Algolia will coordinate the fix and disclosure.

build.gradle.kts

@@ -1,38 +1,51 @@
 import com.android.build.gradle.LibraryExtension
+import com.diffplug.gradle.spotless.SpotlessExtension
 import com.jfrog.bintray.gradle.tasks.BintrayUploadTask
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 import java.net.URI
 
 buildscript {
     repositories {
+        mavenCentral()
         google()
     }
     dependencies {
-        classpath("com.android.tools.build:gradle:3.5.2")
+        classpath(plugin.Android())
+        classpath(plugin.Spotless())
     }
 }
 
 plugins {
-    id("kotlin-multiplatform") version "1.3.60"
-    id("kotlinx-serialization") version "1.3.60"
+    id("kotlin-multiplatform") version "1.3.72"
+    id("kotlinx-serialization") version "1.3.72"
     id("maven-publish")
     id("com.jfrog.bintray") version "1.8.4"
     id("com.github.kukuhyoniatmoko.buildconfigkotlin") version "1.0.5"
 }
 
 apply(plugin = "com.android.library")
+apply(plugin = "com.diffplug.gradle.spotless")
 
 repositories {
     jcenter()
     google()
     mavenCentral()
     maven { url = URI("https://dl.bintray.com/kotlin/ktor") }
     maven { url = URI("https://kotlin.bintray.com/kotlinx") }
+    maven { url = URI("https://oss.sonatype.org/content/repositories/snapshots") }
 }
 
 version = Library.version
 group = Library.group
 
+allprojects {
+    tasks.withType<org.jetbrains.kotlin.gradle.dsl.KotlinCompile<*>> {
+        kotlinOptions {
+            freeCompilerArgs = listOfNotNull("-Xopt-in=kotlin.RequiresOptIn")
+        }
+    }
+}
+
 extensions.getByType(LibraryExtension::class.java).apply {
     compileSdkVersion(29)
 
@@ -211,7 +224,7 @@ bintray {
         repo = "maven"
         name = Library.artifact
         websiteUrl = "https://www.algolia.com/"
-        issueTrackerUrl =  "https://github.com/algolia/algoliasearch-client-kotlin/issues"
+        issueTrackerUrl = "https://github.com/algolia/algoliasearch-client-kotlin/issues"
         setLicenses("MIT")
         setLabels("Kotlin", "Algolia")
         vcsUrl = "https://github.com/algolia/algoliasearch-client-kotlin.git"
@@ -235,4 +248,17 @@ tasks {
 
 tasks.withType<Test> {
     maxParallelForks = Runtime.getRuntime().availableProcessors().minus(1).coerceAtLeast(1)
-}
+}
+
+configure<SpotlessExtension> {
+    kotlin {
+        target("**/*.kt")
+        ktlint("0.36.0").userData(mapOf(
+            // Disable Ktlint import ordering temporarily.
+            // https://github.com/pinterest/ktlint/issues/527
+            "disabled_rules" to "import-ordering"
+        ))
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+}

buildSrc/build.gradle.kts

@@ -4,4 +4,4 @@ plugins {
 
 repositories {
     jcenter()
-}
+}

buildSrc/src/main/kotlin/AndroidTestExtRunner.kt

@@ -3,4 +3,4 @@ object AndroidTestExtRunner : Dependency {
     override val group = "androidx.test.ext"
     override val artifact = "junit"
     override val version = "1.1.1"
-}
+}

buildSrc/src/main/kotlin/AndroidTestRunner.kt

@@ -3,4 +3,4 @@ object AndroidTestRunner : Dependency {
     override val group = "androidx.test"
     override val artifact = "runner"
     override val version = "1.2.0"
-}
+}

buildSrc/src/main/kotlin/Dependency.kt

@@ -9,4 +9,4 @@ interface Dependency {
 
         return "$group:$artifact$optionalModule:$version"
     }
-}
+}