version 2.2.3

Author: Oleg Smirnov

README-putyavka.md

@@ -1,19 +1,43 @@
+/*
+The MIT License (MIT)
+
+Copyright (c) 2019 vk.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
 ext.sdkVersions = [
-        code                            : '15',
-        name                            : '2.2.1',
+        code                            : '17',
+        name                            : '2.2.3',
 
         minSdk                          : 16,
         targetSdk                       : 28,
         compileSdk                      : '29',
-        buildTools                      : '29.0.2',
+        buildTools                      : '29.0.3',
 
-        kotlin                          : '1.3.61',
-        androidX                        : '1.0.0',
+        kotlin                          : '1.3.71',
+        androidX                        : '1.1.0',
         okHttp                          : '3.12.1',
 
         picasso                         : '2.71828',
 
-        androidGradlePlugin             : '3.5.0',
+        androidGradlePlugin             : '3.6.0',
 ]
 
 ext.sdkLibraries = [
@@ -27,8 +51,7 @@ ext.sdkLibraries = [
 ext.sdkLibrariesSupport = [
         appCompat                       : "androidx.appcompat:appcompat:$sdkVersions.androidX",
         recyclerView                    : "androidx.recyclerview:recyclerview:$sdkVersions.androidX",
-        supportV4                       : "androidx.legacy:legacy-support-v4:$sdkVersions.androidX",
-        support                         : "androidx.legacy:legacy-support-v13:$sdkVersions.androidX",
+        collection                      : "androidx.collection:collection:$sdkVersions.androidX",
 ]
 
 ext.sdkGradlePlugins = [

dependencies.gradle

@@ -57,7 +57,6 @@ dependencies {
     implementation sdkLibraries.kotlin
     implementation sdkLibrariesSupport.recyclerView
     implementation sdkLibrariesSupport.appCompat
-    implementation sdkLibrariesSupport.support
     implementation (sdkLibraries.picasso) { transitive = false }
     implementation sdkLibraries.okHttp
 

samples/app/build.gradle

@@ -38,7 +38,6 @@ import androidx.recyclerview.widget.RecyclerView
 import com.squareup.picasso.Picasso
 import com.vk.api.sdk.VK
 import com.vk.api.sdk.VKApiCallback
-import com.vk.api.sdk.exceptions.VKApiExecutionException
 import com.vk.sdk.sample.models.VKUser
 import com.vk.sdk.sample.requests.VKFriendsRequest
 import com.vk.sdk.sample.requests.VKUsersCommand
@@ -139,6 +138,7 @@ class UserActivity: Activity() {
         }
         VK.execute(VKWallPostCommand(messageField.text.toString(), photos), object: VKApiCallback<Int> {
             override fun success(result: Int) {
+                // TODO Use ToastUtils
                 Toast.makeText(this@UserActivity, R.string.wall_ok, Toast.LENGTH_SHORT).show()
             }
 

samples/app/src/main/java/com/vk/sdk/sample/UserActivity.kt

@@ -26,9 +26,9 @@ apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 apply from: '../dependencies.gradle'
 
-ext.POM_GROUP_ID = "com.vk"
+version = sdkVersions.name
+group = 'com.vk'
 ext.POM_ARTIFACT_ID = sdkPublish.POM_ARTIFACT_ID
-ext.POM_VERSION = sdkVersions.name
 
 android {
     compileSdkVersion "$sdkVersions.compileSdk".toInteger()
@@ -55,7 +55,7 @@ dependencies {
     implementation sdkLibraries.kotlin
     implementation sdkLibraries.okHttp
     implementation sdkLibraries.okHttpLoggingInterceptor
-    implementation sdkLibrariesSupport.support
+    implementation sdkLibrariesSupport.collection
 }
 
 apply from: '../publish.gradle'

vk-sdk-core/build.gradle

@@ -43,14 +43,17 @@ import java.io.IOException
  * This is an entry point of VK SDK
  */
 object VK {
+    private const val SDK_APP_ID = "com_vk_sdk_AppId"
+
     @SuppressLint("StaticFieldLeak")
     private lateinit var config: VKApiConfig
     internal lateinit var apiManager: VKApiManager
-
-    private val authManager: VKAuthManager = VKAuthManager()
+    private lateinit var authManager: VKAuthManager
 
     private val tokenExpiredHandlers = ArrayList<VKTokenExpiredHandler>()
 
+    private var cachedAppId = 0
+
     /**
      * This method initializes VK SDK with your custom config
      * @param config contains all required data for vk api
@@ -59,7 +62,8 @@ object VK {
     fun setConfig(config: VKApiConfig) {
         this.config = config
         apiManager = VKApiManager(config)
-        authManager.getCurrentToken(config.context)?.let {
+        authManager = VKAuthManager(config.keyValueStorage)
+        authManager.getCurrentToken()?.let {
             apiManager.setCredentials(it.accessToken, it.secret)
         }
     }
@@ -78,35 +82,54 @@ object VK {
 
     /**
      * This method is used to set new credentials for future requests. E.g. if you login via your own lib
+     *
      * @param userId userId of saving user
      * @param accessToken accessToken for future requests
      * @param secret secret for future requests
-     * @param saveAccessTokenToPrefs create access token info and save it to prefs. If you pass {@code false},
-     * you will not able to use sdk execute methods
+     * @param saveAccessTokenToStorage create access token info and save it to keyValueStorage provided
+     * by [VKApiConfig] ([VKApiConfig.keyValueStorage]).
+     * If you pass {@code false} you will not able to use sdk execute methods!
      */
     @JvmStatic
-    fun setCredentials(context: Context, userId: Int, accessToken: String, secret: String?, saveAccessTokenToPrefs: Boolean) {
-        if (saveAccessTokenToPrefs) {
-            VKAccessToken(userId, accessToken, secret).save(authManager.getPreferences(context))
+    fun setCredentials(context: Context, userId: Int, accessToken: String, secret: String?, saveAccessTokenToStorage: Boolean = true) {
+        if (saveAccessTokenToStorage) {
+            VKAccessToken(userId, accessToken, secret).save(config.keyValueStorage)
         }
         apiManager.setCredentials(accessToken, secret)
     }
 
+    /**
+     * Save access token to keyValueStorage provided by [VKApiConfig] ([VKApiConfig.keyValueStorage]).
+     *
+     * @param userId userId of saving user
+     * @param accessToken accessToken for future requests
+     * @param secret secret for future requests
+     */
+    @JvmStatic
+    fun saveAccessToken(context: Context, userId: Int, accessToken: String, secret: String?) {
+        setCredentials(context, userId, accessToken, secret, true)
+    }
+
     /**
      * This method clears information about access token and cookies
      */
     @JvmStatic
     fun logout() {
-        authManager.logout(config.context)
+        authManager.clearAccessToken()
         VKUtils.clearAllCookies(config.context)
     }
 
     /**
      * This method checks if user is already logged in
      */
     @JvmStatic
-    fun isLoggedIn() = authManager.isLoggedIn(config.context)
+    fun isLoggedIn() = authManager.isLoggedIn()
 
+    /**
+     * This method returns userId of currently logged in user or 0 if there is no logged in user
+     */
+    @JvmStatic
+    fun getUserId() = authManager.getCurrentToken()?.userId ?: 0
 
     /**
      * This method provide you an api version of current config
@@ -120,7 +143,7 @@ object VK {
      */
     @JvmStatic
     fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?, callback: VKAuthCallback): Boolean {
-        val result = authManager.onActivityResult(requestCode, resultCode, data, callback, config.context)
+        val result = authManager.onActivityResult(requestCode, resultCode, data, callback)
         if (result && isLoggedIn()) {
             trackVisitor()
         }
@@ -145,7 +168,7 @@ object VK {
     }
 
     internal fun handleTokenExpired() {
-        authManager.logout(config.context)
+        authManager.clearAccessToken()
 
         tokenExpiredHandlers.forEach {
             it.onTokenExpired()
@@ -192,10 +215,7 @@ object VK {
      */
     @JvmStatic
     fun initialize(context: Context) {
-        val appId = authManager.getAppId(context)
-        if (appId == 0) {
-            throw RuntimeException("<integer name=\"com_vk_sdk_AppId\">your_app_id</integer> is not found in your resources.xml")
-        }
+        val appId = getAppId(context)
         setConfig(VKApiConfig(
                 context = context,
                 appId = appId,
@@ -211,12 +231,27 @@ object VK {
      */
     @JvmStatic
     fun getAppId(context: Context): Int {
-        return authManager.getAppId(context)
+        if (cachedAppId != 0) {
+            return cachedAppId
+        }
+
+        val resId = context.resources.getIdentifier(SDK_APP_ID, "integer", context.packageName)
+        cachedAppId = try {
+            context.resources.getInteger(resId)
+        } catch (e: Exception) {
+            0
+        }
+
+        if (cachedAppId == 0) {
+            throw RuntimeException("<integer name=\"com_vk_sdk_AppId\">your_app_id</integer> is not found in your resources.xml")
+        }
+
+        return cachedAppId
     }
 
     @JvmStatic
     fun clearAccessToken(context: Context) {
-        authManager.getPreferences(context).edit().clear().apply()
+        authManager.clearAccessToken()
     }
 
     private fun trackVisitor() {

vk-sdk-core/src/main/java/com/vk/api/sdk/VK.kt

@@ -30,29 +30,36 @@ import com.vk.api.sdk.utils.log.Logger
 import java.util.concurrent.TimeUnit
 
 /**
- * Configuration for VK SDK
- * By using VK.initialize(config) you can customize configuration
+ * Configuration for VK SDK.
+ * By using SuperappKitConfig.setApiConfig(config) you can customize configuration.
+ * VKInitProvider calls VK.initialize() on start of application and provides default implementation
+ * of VKApiConfig.
  */
 @Suppress("ConvertSecondaryConstructorToPrimary")
-data class VKApiConfig(val context: Context,
-                       val appId: Int = 0,
-                       val validationHandler: VKApiValidationHandler?,
-                       val deviceId: Lazy<String> = lazy { "" },
-                       val version: String = DEFAULT_API_VERSION,
-                       val okHttpProvider: VKOkHttpProvider = VKOkHttpProvider.DefaultProvider(),
-                       val defaultTimeoutMs: Long = TimeUnit.SECONDS.toMillis(10),
-                       val postRequestsTimeout: Long = TimeUnit.MINUTES.toMillis(5),
-                       val logger: Logger = DefaultApiLogger(lazy { Logger.LogLevel.NONE }, "VKSdkApi"),
-                       val accessToken: Lazy<String> = lazy { "" },
-                       val secret: Lazy<String?> = lazy { null },
-                       val logFilterCredentials: Boolean = true,
-                       val callsPerSecondLimit: Int = 3,
-                       val httpApiHost: Lazy<String>  = lazy { DEFAULT_API_DOMAIN },
-                       val lang: String = "en") {
+data class VKApiConfig(
+    val context: Context,
+    val appId: Int = 0,
+    val validationHandler: VKApiValidationHandler?,
+    val deviceId: Lazy<String> = lazy { "" },
+    val version: String = DEFAULT_API_VERSION,
+    val okHttpProvider: VKOkHttpProvider = VKOkHttpProvider.DefaultProvider(),
+    val defaultTimeoutMs: Long = TimeUnit.SECONDS.toMillis(10),
+    val postRequestsTimeout: Long = TimeUnit.MINUTES.toMillis(5),
+    val logger: Logger = DefaultApiLogger(lazy { Logger.LogLevel.NONE }, "VKSdkApi"),
+    val accessToken: Lazy<String> = lazy { "" },
+    val secret: Lazy<String?> = lazy { null },
+    val logFilterCredentials: Boolean = true,
+    val debugCycleCalls: Lazy<Boolean> = lazy { false },
+    val callsPerSecondLimit: Int = 3,
+    val httpApiHost: Lazy<String>  = lazy { DEFAULT_API_DOMAIN },
+    val lang: String = "en",
+    val keyValueStorage: VKKeyValueStorage = VKPreferencesKeyValueStorage(context)
+) {
 
     companion object {
         const val DEFAULT_DOMAIN = "vk.com"
         const val DEFAULT_API_VERSION = "5.90"
         const val DEFAULT_API_DOMAIN = "api.vk.com"
+        const val DEFAULT_OAUTH_DOMAIN = "oauth.vk.com"
     }
 }

vk-sdk-core/src/main/java/com/vk/api/sdk/VKApiConfig.kt

@@ -69,7 +69,7 @@ open class VKApiManager(val config: VKApiConfig) {
         var cc: ChainCall<T> = if (call.skipValidation) {
             chainCall
         } else {
-            ValidationHandlerChainCall(this, call.retryCount, chainCall)
+            createValidationHandlerChainCall(call.retryCount, chainCall)
         }
         cc = InvalidCredentialsObserverChainCall(this, cc)
         cc = TooManyRequestRetryChainCall(this, call.retryCount, cc)
@@ -88,13 +88,16 @@ open class VKApiManager(val config: VKApiConfig) {
     }
 
     protected open fun <T> wrapCall(call: VKHttpPostCall, chainCall: ChainCall<T>): ChainCall<T> {
-        var cc: ChainCall<T> = ValidationHandlerChainCall(this, call.retryCount, chainCall)
+        var cc: ChainCall<T> = createValidationHandlerChainCall(call.retryCount, chainCall)
         if (call.retryCount > 0) {
             cc = InternalErrorRetryChainCall(this, call.retryCount, cc)
         }
         return cc
     }
 
+    private fun <T> createValidationHandlerChainCall(retryCount: Int, chainCall: ChainCall<T>) =
+        ValidationHandlerChainCall(this, retryCount, chainCall)
+
     @Throws(InterruptedException::class, IOException::class, VKApiException::class)
     protected open fun <T> executeWithExceptionAdjust(cc: ChainCall<T>) = cc.call(ChainArgs())!!
 

vk-sdk-core/src/main/java/com/vk/api/sdk/VKApiManager.kt

@@ -24,6 +24,7 @@
 
 package com.vk.api.sdk
 
+import com.vk.api.sdk.exceptions.VKApiExecutionException
 import java.util.concurrent.CountDownLatch
 
 /**
@@ -42,12 +43,17 @@ interface VKApiValidationHandler {
      * This method will called, when confirmation from user required
      */
     fun handleConfirm(confirmationText: String, cb: Callback<Boolean>)
+    /**
+     * This method will called, when no other method can handle exception
+     */
+    @Throws(VKApiExecutionException::class)
+    fun tryToHandleException(ex: VKApiExecutionException, apiManager: VKApiManager): Unit = throw ex
 
-    class Callback<T>(private val latch: CountDownLatch) {
+    open class Callback<T>(val latch: CountDownLatch) {
         @Volatile var value: T? = null
 
-        fun cancel() = latch.countDown()
-        fun submit(value: T) {
+        open fun cancel() = latch.countDown()
+        open fun submit(value: T) {
             this.value = value
             latch.countDown()
         }

vk-sdk-core/src/main/java/com/vk/api/sdk/VKApiValidationHandler.kt

@@ -34,7 +34,7 @@ import com.vk.api.sdk.utils.VKValidationLocker
  * Default implementation for VKApiValidationHandler
  * It uses internal sdk activities
  */
-class VKDefaultValidationHandler(val context: Context): VKApiValidationHandler {
+open class VKDefaultValidationHandler(val context: Context): VKApiValidationHandler {
 
     override fun handleCaptcha(img: String, cb: VKApiValidationHandler.Callback<String>) {
         VKCaptchaActivity.start(context, img)