Release 1.10.0

Author: aallam

CHANGELOG.md

@@ -1,3 +1,14 @@
+# 1.10.0
+
+### Added
+- Recommend API client (#281)
+
+### Fix 
+- Add `abTestID` to `ResponseSearch` (#285)
+
+### Changed
+- Non-null fields from `ResponseSearch` throws `IllegalStateException` instead of NPE (#286)
+
 # 1.9.2
 
 ### Fix

README.md

@@ -145,7 +145,7 @@ query.sortFacetsBy = SortFacetsBy.Count
 If you use this library in an Android project which uses R8, there is nothing you have to do. The specific rules are 
 already bundled into the JAR, which can be interpreted by R8 automatically.
 
-If however, you don’t use R8 you have to apply the rules from [this file](src/jvmMain/resources/META-INF/proguard/algoliasearch.pro).
+If however, you don’t use R8 you have to apply the rules from [this file](client/src/jvmMain/resources/META-INF/proguard/algoliasearch.pro).
 
 ### Guides
 

build.gradle.kts

@@ -3,11 +3,11 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        val kotlinVersion = "1.5.21"
+        val kotlinVersion = "1.5.30"
         classpath(kotlin("gradle-plugin", version = kotlinVersion))
         classpath(kotlin("serialization", version = kotlinVersion))
-        classpath("com.vanniktech:gradle-maven-publish-plugin:0.17.0")
-        classpath("com.diffplug.spotless:spotless-plugin-gradle:5.14.0")
+        classpath("com.vanniktech:gradle-maven-publish-plugin:0.18.0")
+        classpath("com.diffplug.spotless:spotless-plugin-gradle:5.15.0")
     }
 }
 

client/build.gradle.kts

@@ -22,8 +22,7 @@ kotlin {
     sourceSets {
         all {
             languageSettings.apply {
-                progressiveMode = true
-                useExperimentalAnnotation("kotlin.RequiresOptIn")
+                optIn("kotlin.RequiresOptIn")
             }
         }
         val commonMain by getting {

client/src/commonMain/kotlin/com/algolia/search/client/ClientRecommend.kt

@@ -0,0 +1,35 @@
+@file:Suppress("FunctionName")
+
+package com.algolia.search.client
+
+import com.algolia.search.client.internal.ClientRecommendImpl
+import com.algolia.search.configuration.Configuration
+import com.algolia.search.configuration.ConfigurationRecommend
+import com.algolia.search.configuration.Credentials
+import com.algolia.search.configuration.internal.Credentials
+import com.algolia.search.configuration.internal.DEFAULT_LOG_LEVEL
+import com.algolia.search.endpoint.EndpointRecommend
+import com.algolia.search.model.APIKey
+import com.algolia.search.model.ApplicationID
+import com.algolia.search.transport.internal.Transport
+import io.ktor.client.features.logging.LogLevel
+
+public interface ClientRecommend : Configuration, EndpointRecommend, Credentials {
+
+    public companion object
+}
+
+public fun ClientRecommend(
+    applicationID: ApplicationID,
+    apiKey: APIKey,
+    logLevel: LogLevel = DEFAULT_LOG_LEVEL,
+): ClientRecommend = ClientRecommendImpl(
+    Transport(
+        ConfigurationRecommend(applicationID = applicationID, apiKey = apiKey, logLevel = logLevel),
+        Credentials(applicationID = applicationID, apiKey = apiKey)
+    )
+)
+
+public fun ClientRecommend(configuration: ConfigurationRecommend): ClientRecommend = ClientRecommendImpl(
+    Transport(configuration, configuration)
+)

client/src/commonMain/kotlin/com/algolia/search/client/internal/ClientRecommendImpl.kt

@@ -0,0 +1,15 @@
+package com.algolia.search.client.internal
+
+import com.algolia.search.client.ClientRecommend
+import com.algolia.search.configuration.Configuration
+import com.algolia.search.configuration.Credentials
+import com.algolia.search.endpoint.EndpointRecommend
+import com.algolia.search.endpoint.internal.EndpointRecommend
+import com.algolia.search.transport.internal.Transport
+
+internal class ClientRecommendImpl(
+    internal val transport: Transport
+) : ClientRecommend,
+    EndpointRecommend by EndpointRecommend(transport),
+    Configuration by transport,
+    Credentials by transport.credentials

client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationRecommendation.kt renamed to client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationPersonalization.kt

@@ -0,0 +1,55 @@
+package com.algolia.search.configuration
+
+import com.algolia.search.configuration.internal.ConfigurationRecommendImpl
+import com.algolia.search.configuration.internal.DEFAULT_LOG_LEVEL
+import com.algolia.search.configuration.internal.DEFAULT_READ_TIMEOUT
+import com.algolia.search.configuration.internal.DEFAULT_WRITE_TIMEOUT
+import com.algolia.search.model.APIKey
+import com.algolia.search.model.ApplicationID
+import com.algolia.search.transport.internal.searchHosts
+import io.ktor.client.HttpClientConfig
+import io.ktor.client.engine.HttpClientEngine
+import io.ktor.client.features.logging.LogLevel
+
+/**
+ * Configuration used by [ConfigurationRecommend].
+ */
+public interface ConfigurationRecommend : Configuration, Credentials
+
+/**
+ * Create a [ConfigurationRecommend] instance.
+ *
+ * @param applicationID application ID
+ * @param apiKey API key
+ * @param writeTimeout write timout
+ * @param readTimeout read timeout
+ * @param logLevel logging level
+ * @param hosts personalization region hosts
+ * @param defaultHeaders default headers
+ * @param engine http client engine
+ * @param httpClientConfig http client configuration
+ * @param compression request payload compression
+ */
+public fun ConfigurationRecommend(
+    applicationID: ApplicationID,
+    apiKey: APIKey,
+    writeTimeout: Long = DEFAULT_WRITE_TIMEOUT,
+    readTimeout: Long = DEFAULT_READ_TIMEOUT,
+    logLevel: LogLevel = DEFAULT_LOG_LEVEL,
+    hosts: List<RetryableHost> = applicationID.searchHosts,
+    defaultHeaders: Map<String, String>? = null,
+    engine: HttpClientEngine? = null,
+    httpClientConfig: (HttpClientConfig<*>.() -> Unit)? = null,
+    compression: Compression = Compression.None,
+): ConfigurationRecommend = ConfigurationRecommendImpl(
+    applicationID = applicationID,
+    apiKey = apiKey,
+    writeTimeout = writeTimeout,
+    readTimeout = readTimeout,
+    logLevel = logLevel,
+    hosts = hosts,
+    defaultHeaders = defaultHeaders,
+    engine = engine,
+    httpClientConfig = httpClientConfig,
+    compression = compression
+)

client/src/commonMain/kotlin/com/algolia/search/configuration/ConfigurationRecommend.kt

@@ -0,0 +1,32 @@
+package com.algolia.search.configuration.internal
+
+import com.algolia.search.client.ClientRecommend
+import com.algolia.search.configuration.Compression
+import com.algolia.search.configuration.ConfigurationRecommend
+import com.algolia.search.configuration.RetryableHost
+import com.algolia.search.configuration.internal.extension.getHttpClient
+import com.algolia.search.model.APIKey
+import com.algolia.search.model.ApplicationID
+import io.ktor.client.HttpClient
+import io.ktor.client.HttpClientConfig
+import io.ktor.client.engine.HttpClientEngine
+import io.ktor.client.features.logging.LogLevel
+
+/**
+ * Configuration used by [ClientRecommend].
+ */
+internal class ConfigurationRecommendImpl(
+    override val applicationID: ApplicationID,
+    override val apiKey: APIKey,
+    override val writeTimeout: Long,
+    override val readTimeout: Long,
+    override val logLevel: LogLevel,
+    override val hosts: List<RetryableHost>,
+    override val defaultHeaders: Map<String, String>?,
+    override val engine: HttpClientEngine?,
+    override val httpClientConfig: (HttpClientConfig<*>.() -> Unit)?,
+    override val compression: Compression,
+) : ConfigurationRecommend {
+
+    override val httpClient: HttpClient = getHttpClient()
+}

client/src/commonMain/kotlin/com/algolia/search/configuration/internal/ConfigurationRecommendImpl.kt

@@ -12,6 +12,7 @@ import io.ktor.client.features.UserAgent
 import io.ktor.client.features.defaultRequest
 import io.ktor.client.features.json.JsonFeature
 import io.ktor.client.features.json.serializer.KotlinxSerializer
+import io.ktor.client.features.logging.LogLevel
 import io.ktor.client.features.logging.Logger
 import io.ktor.client.features.logging.Logging
 import io.ktor.client.features.logging.SIMPLE
@@ -29,10 +30,7 @@ internal fun HttpClientConfig<*>.configure(configuration: Configuration) {
     install(JsonFeature) {
         serializer = KotlinxSerializer(JsonNonStrict)
     }
-    install(Logging) {
-        level = configuration.logLevel
-        logger = Logger.SIMPLE
-    }
+    installLogging(configuration.logLevel)
     install(UserAgent) {
         agent = clientUserAgent(AlgoliaSearchClient.version)
     }
@@ -47,6 +45,17 @@ internal fun HttpClientConfig<*>.configure(configuration: Configuration) {
     }
 }
 
+/**
+ * Installs [Logging] if logging level is superior to [LogLevel.NONE].
+ */
+private fun HttpClientConfig<*>.installLogging(logLevel: LogLevel) {
+    if (LogLevel.NONE == logLevel) return
+    install(Logging) {
+        level = logLevel
+        logger = Logger.SIMPLE
+    }
+}
+
 internal fun HttpMethod.canCompress(): Boolean {
     return this == HttpMethod.Post || this == HttpMethod.Put
 }