Version 1.0.0

Author: Jedlix

README.md

@@ -14,21 +14,20 @@ Add the following to your `build.gradle`:
 
 ```groovy
 dependencies {
-    implementation("com.jedlix:sdk:1.4.0")
+    implementation("com.jedlix:sdk:1.5.0")
 }
 ```
 
 ## Usage
 
-When you sign up for a [Smart Charging API](https://api.jedlix.com/) account, you get a custom `baseURL`. You need to provide it to the SDK, as well as an `Authentication` implementation.
-
-Configure the SDK:
+When you sign up for a [Smart Charging API](https://api.jedlix.com/) account, you get a custom `baseURL` and `apiKey`. Configure the SDK with these values and an `Authentication` implementation. API key is not required if you use your own base URL.
 
 ```kotlin
 import com.jedlix.sdk.JedlixSDK
 
 JedlixSDK.configure(
     /* Base URL */,
+    /* API key */,
     /* Authentication implementation */
 )
 ```
@@ -99,10 +98,11 @@ By default the SDK logs only errors. To change it, update `JedlixSDK.logLevel`:
 
 See the included example to learn how to use the SDK.
 
-Open `ExampleApplication.kt` and specify your `baseURL`:
+Open `ExampleApplication.kt` and specify your `baseURL` and `apiKey`:
 
 ```kotlin
 baseURL = URL("<YOUR BASE URL>")
+apiKey = "<YOUR API KEY>"
 ```
 
 (Optional) If you use [Auth0](https://auth0.com/), you can uncomment the following code to authenticate with an Auth0 account directly, assuming the user identifier is stored in JWT body under `userIdentifierKey`.

build.gradle.kts

@@ -5,7 +5,6 @@ plugins {
 }
 
 buildscript {
-
     repositories {
         google()
         mavenCentral()

example/src/main/java/com/jedlix/sdk/example/ExampleApplication.kt

@@ -30,6 +30,7 @@ import java.net.URL
 class ExampleApplication : Application() {
     companion object {
         lateinit var baseURL: URL
+        lateinit var apiKey: String
         lateinit var authentication: Authentication
     }
 
@@ -39,6 +40,7 @@ class ExampleApplication : Application() {
         super.onCreate()
 
         baseURL = URL("<YOUR BASE URL>")
+        apiKey = "<YOUR API KEY>"
         authentication = DefaultAuthentication(this)
 //        authentication = Auth0Authentication(
 //            "<AUTH0 CLIENT ID>",
@@ -50,6 +52,7 @@ class ExampleApplication : Application() {
 //        )
         JedlixSDK.configure(
             baseURL,
+            apiKey,
             authentication
         )
     }

gradle.properties

@@ -16,4 +16,4 @@ androidxActivityVersion=1.4.0
 androidxLifecycleVersion=2.4.0
 androidxBrowserVersion=1.4.0
 
-sdkVersion=1.4.0
+sdkVersion=1.5.0

sdk/src/main/java/com/jedlix/sdk/JedlixSDK.kt

@@ -29,10 +29,10 @@ import java.util.concurrent.atomic.AtomicReference
  * Manages the settings of the Jedlix SDK
  */
 class JedlixSDK private constructor(
-    private val apiHost: String = "",
-    private val apiBasePath: String = "",
-    private val authentication: Authentication,
-    private val apiKey: String? = null,
+    private val host: String = "",
+    private val basePath: String = "",
+    private val apiKey: String?,
+    private val authentication: Authentication
 ) {
 
     /**
@@ -59,22 +59,23 @@ class JedlixSDK private constructor(
     companion object {
         /**
          * Initializes the SDK with the specified parameters.
-         * @param baseURL Base [URL] of the Smart Charging API.
+         * @param baseURL Base [URL] of the Smart Charging API
+         * @param apiKey API key associated with the developer account
          * @param authentication An object providing access token to the API
          */
         fun configure(
             baseURL: URL,
-            authentication: Authentication,
             apiKey: String? = null,
+            authentication: Authentication
         ): JedlixSDK {
             if (
                 !sdk.compareAndSet(
                     null,
                     JedlixSDK(
-                        apiHost = baseURL.host,
-                        apiBasePath = baseURL.path.substringBefore(EndpointBuilder().path),
-                        authentication = authentication,
-                        apiKey = apiKey,
+                        baseURL.host,
+                        baseURL.path.substringBefore(EndpointBuilder().path),
+                        apiKey,
+                        authentication
                     )
                 )
             ) {
@@ -103,10 +104,10 @@ class JedlixSDK private constructor(
         val api: Api
             get() = sdk.get()!!.run {
                 KtorApi(
-                    apiHost = apiHost,
-                    basePath = apiBasePath,
-                    authentication = authentication,
-                    apiKey = apiKey,
+                    host,
+                    basePath,
+                    apiKey,
+                    authentication
                 )
             }
 

sdk/src/main/java/com/jedlix/sdk/networking/Api.kt

@@ -28,10 +28,11 @@ import java.util.*
 abstract class Api {
 
     companion object {
-        private const val HEADER_CORRELATION_ID = "Jedlix-CorrelationId"
-        private const val HEADER_ACCEPT_LANGUAGE = "Accept-Language"
-        private const val HEADER_AUTHORIZATION = "Authorization"
         private const val HEADER_API_KEY = "ApiKey"
+        private const val HEADER_AUTHORIZATION = "Authorization"
+        private const val HEADER_ACCEPT_LANGUAGE = "Accept-Language"
+        private const val HEADER_CLIENT_VERSION = "Jedlix-ClientVersion"
+        private const val HEADER_CORRELATION_ID = "Jedlix-CorrelationId"
 
         private const val AUTHORIZATION_FORMAT = "Bearer %s"
 
@@ -77,17 +78,18 @@ abstract class Api {
         class SDKNotInitialized<Result> : Failure<Result>()
     }
 
-    protected abstract val apiHost: String
+    protected abstract val host: String
     protected abstract val basePath: String
-    protected abstract val authentication: Authentication
     protected abstract val apiKey: String?
+    protected abstract val authentication: Authentication
 
     protected suspend fun headers(): Map<String, String> = mapOf(
-        HEADER_CORRELATION_ID to UUID.randomUUID().toString(),
+        HEADER_API_KEY to apiKey,
         HEADER_AUTHORIZATION to authentication.getAccessToken()
             ?.let { AUTHORIZATION_FORMAT.format(it) },
         HEADER_ACCEPT_LANGUAGE to Locale.getDefault().toLanguageTag(),
-        HEADER_API_KEY to apiKey,
+        HEADER_CLIENT_VERSION to "1.5.0",
+        HEADER_CORRELATION_ID to UUID.randomUUID().toString()
     )
         .mapNotNull { (key, value) -> value?.let { key to it } }
         .toMap()
@@ -99,7 +101,7 @@ abstract class Api {
      * @return A [Response] from requesting the endpoint
      */
     suspend fun <Result : Any> request(builder: EndpointBuilder.() -> EndpointNode<Result>): Response<Result> {
-        return if (apiHost.isEmpty()) {
+        return if (host.isEmpty()) {
             JedlixSDK.logError("SDK has not been initialized properly. Make sure you configure an API host")
             Response.SDKNotInitialized()
         } else {

sdk/src/main/java/com/jedlix/sdk/networking/KtorApi.kt

@@ -25,16 +25,18 @@ import io.ktor.client.features.json.serializer.*
 import io.ktor.client.features.logging.*
 import io.ktor.client.request.*
 import io.ktor.client.statement.*
+import io.ktor.client.utils.*
 import io.ktor.http.*
+import io.ktor.util.*
 import io.ktor.utils.io.errors.*
 import kotlinx.serialization.SerializationException
 import kotlinx.serialization.builtins.serializer
 
 internal class KtorApi(
-    override val apiHost: String,
+    override val host: String,
     override val basePath: String,
-    override val authentication: Authentication,
     override val apiKey: String?,
+    override val authentication: Authentication
 ) : Api() {
 
     private val json = kotlinx.serialization.json.Json {
@@ -89,6 +91,7 @@ internal class KtorApi(
     override suspend fun <Result : Any> request(endpoint: EndpointNode<Result>): Response<Result> {
         return try {
             client.use { client ->
+                val apiHost = host
                 val response = client.request<HttpResponse> {
                     url {
                         this.protocol = URLProtocol.HTTPS