Prepare for release 0.0.7.

Author: petersamokhin

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+Version 0.0.7 *(2020-09-11)*
+----------------------------
+* Update to Kotlin 1.4.10
+* Fix #19 by #22 thanks to [@4uf04eG](https://github.com/4uf04eG)
+* Fix docs
+
 Version 0.0.6 *(2020-09-06)*
 ----------------------------
 * Kotlin `1.4.0` support

README.md

@@ -6,15 +6,15 @@
 
 ---
 
-![Build](https://github.com/vksdk/vk-sdk-kotlin/workflows/Release/badge.svg) ![Documentation](https://github.com/vksdk/vk-sdk-kotlin/workflows/Documentation/badge.svg) [![Kotlin 1.4.0](https://img.shields.io/badge/Kotlin-1.4.0-blue.svg?style=flat)](http://kotlinlang.org) [![API version](https://img.shields.io/badge/API%20version-5.103+-blue?style=flat&logo=vk&logoColor=white)](https://vk.com/dev/versions)
+![Build](https://github.com/vksdk/vk-sdk-kotlin/workflows/Release/badge.svg) ![Documentation](https://github.com/vksdk/vk-sdk-kotlin/workflows/Documentation/badge.svg) [![Kotlin 1.4.10](https://img.shields.io/badge/Kotlin-1.4.10-blue.svg?style=flat)](http://kotlinlang.org) [![API version](https://img.shields.io/badge/API%20version-5.103+-blue?style=flat&logo=vk&logoColor=white)](https://vk.com/dev/versions)
 [![GitHub license](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat)](https://github.com/vksdk/vk-sdk-kotlin/blob/master/LICENSE)
 
 Unofficial VK.com SDK, written in Kotlin.
 Based on Kotlin Multiplatform project, but has Java-friendly API.
 
 See the documentation: [https://vksdk.github.io/vk-sdk-kotlin](https://vksdk.github.io/vk-sdk-kotlin)
 
-Latest version:  [![maven-central](https://img.shields.io/badge/Maven%20Central-0.0.6-yellowgreen?style=flat)](https://search.maven.org/search?q=g:com.petersamokhin.vksdk)
+Latest version:  [![maven-central](https://img.shields.io/badge/Maven%20Central-0.0.7-yellowgreen?style=flat)](https://search.maven.org/search?q=g:com.petersamokhin.vksdk)
 
 For Kotlin 1.3.72 use version 0.0.5 and below.
 
@@ -103,7 +103,7 @@ implementation "com.petersamokhin.vksdk:http-client-jvm-okhttp:$vkSdkVersion"
 
 // Or else you can use the common HTTP client, which is based on ktor 
 // and available for all of the platforms, including JVM.
-// In this case, you also should specify the ktor engine.
+// In this case, you also must specify the ktor engine.
 implementation "com.petersamokhin.vksdk:http-client-common-ktor:$vkSdkVersion"
 ```
 

buildSrc/src/main/kotlin/Config.kt

@@ -1,7 +1,7 @@
 object Config {
     object Versions {
         object Kotlin {
-            const val kotlin = "1.4.0"
+            const val kotlin = "1.4.10"
             const val coroutines = "1.3.9"
             const val serialization = "1.0.0-RC"
         }

docs/http-clients.md

@@ -12,11 +12,15 @@ Configuration for clients is also optional, but may be useful.
 val httpClientConfig: HttpClientConfig = HttpClientConfig(
     connectTimeout = 30_000,
     readTimeout = 30_000,
-    defaultHeaders = mapOf("User-Agent", "VK SDK Kotlin/0.0.x")
+    defaultHeaders = mapOf("User-Agent" to "VK SDK Kotlin/0.0.x")
 )
 ```
 Usually, this configuration is provided into HTTP client constructor.
 
+!!! info "Note about the logging"
+    It is barely possible to help you without seeing the VK responses, so you need to log it by yourself.
+    For this, you can provide overrided client and configure this using the logging-interceptor for OkHttp, or the logging feature for ktor.
+
 ### Abstract HTTP client methods
 To implement this interface, you should override some simple methods:
 
@@ -93,27 +97,25 @@ implementation("io.ktor:ktor-client-cio:1.3.2")
 ### Use
 You can provide ktor HttpClient in constructor:
 ```kotlin
-val httpClient: HttpClient = VkOkHttpClient(
-    coroutineContext = Dispatchers.IO + SupervisorJob(),
-    
-    // provide your http client,
-    overrideClient = HttpClient(CIO),
-
-    // HTTP client configuration is optional, see the snippet above
-    overrideConfig = HttpClientConfig()
-)
+val httpClient: HttpClient = VkKtorHttpClient(
+            coroutineContext = Dispatchers.IO /* + job */,
+            overrideClient = HttpClient(CIO) {
+                engine {
+                    requestTimeout = 30_000L
+                }
+            }
+        )
 ```
 
 Otherwise, override `createEngineWithConfig` method: 
 ```kotlin
 class CioKtorHttpClient: VkKtorHttpClient(
-    coroutineContext = Dispatchers.IO + SupervisorJob()
+    coroutineContext = Dispatchers.IO /* + job */
 ) {
     override fun createEngineWithConfig(config: HttpClientConfig): HttpClientEngine? {
         return CIO.create {
-            endpoint {
-                connectTimeout = config.connectTimeout.toLong()
-                requestTimeout = config.readTimeout.toLong()
+            engine {
+                requestTimeout = 30_000L
             }
         }
     }

docs/usage.md

@@ -6,7 +6,7 @@ See the [example projects](https://github.com/vksdk/vk-sdk-kotlin/tree/master/ex
     - [https://github.com/vksdk/vk-sdk-kotlin/tree/master/examples/jvm-kotlin-example](https://github.com/vksdk/vk-sdk-kotlin/tree/master/examples/jvm-kotlin-example)
 - Minimal example without Kotlin in dependencies:
     - [https://github.com/vksdk/vk-sdk-kotlin/tree/master/examples/jvm-only-java-example](https://github.com/vksdk/vk-sdk-kotlin/tree/master/examples/jvm-only-java-example)
-- Minimal multipatform app example (single activity on Android and SwiftUI on iOS):
+- Minimal multiplatform app example (single activity on Android and SwiftUI on iOS):
     - [https://github.com/vksdk/vk-sdk-kotlin/tree/master/examples/mpp-example](https://github.com/vksdk/vk-sdk-kotlin/tree/master/examples/mpp-example)
 
 ### Artifacts
@@ -57,9 +57,9 @@ val vkClientSettings = VkSettings(
     // HTTP client is required
     httpClient = httpClient,                    
 
-    // Default is [VkApi.DEFAULT_VERSION], 5.103 for 0.0.2
+    // Default is [VkApi.DEFAULT_VERSION], 5.122 for 0.0.7
     // See: https://vk.com/dev/versions
-    apiVersion = 5.103,                         
+    apiVersion = 5.122,                         
 
     // Default params are empty
     defaultParams = paramsOf("lang" to "en"),   
@@ -71,7 +71,7 @@ val vkClientSettings = VkSettings(
     // See the mutiplatform example and iOS note for ktor
     backgroundDispatcher = Dispatchers.Default, 
 
-    json = Json { /* yours configuration */ }
+    json = Json { /* your configuration */ }
 )
 ```
 

gradle.properties

@@ -1,5 +1,5 @@
 GROUP=com.petersamokhin.vksdk
-VERSION_NAME=0.0.6
+VERSION_NAME=0.0.7
 
 POM_URL=https://github.com/vksdk/vk-sdk-kotlin/
 POM_SCM_URL=https://github.com/vksdk/vk-sdk-kotlin/