Merge branch 'release/0.3.0'

Author: iVirn

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.0
+
+* API update: new `launch` method, deprecate all old `launch...` methods
+* Fix Android init
+
 ## 0.2.5
 
 * Fix Android error handling

README.md

@@ -16,7 +16,7 @@ To use Qonversion in your Flutter app, add `qonversion` as a [dependency in your
 
 ```
 dependencies:
-  qonversion_flutter: ^0.2
+  qonversion_flutter: ^0.3.0
 ```
 
 Run `flutter pub get` to install dependency.
@@ -32,53 +32,36 @@ import 'package:qonversion_flutter/qonversion.dart';
 
 ...
 
+String _qonversionUserId;
+
 @override
 void initState() {
   super.initState();
-  Qonversion.launchWith(
+  
+  _launchQonversion();
+}
+
+Future<String> _launchQonversion() async {
+  _qonversionUserId = await Qonversion.launch(
     iosApiKey: 'YOUR_IOS_API_KEY',
     androidApiKey: 'YOUR_ANDROID_API_KEY',
-    onComplete: (uid) => print(uid),
   );
 }
 
 ...
 ```
 
-Usually Qonversion will track purchases automatically.
-
-Still, there are few ways to launch Qonversion:
-
-1. Launches Qonversion SDK with the given API keys for each platform: [androidApiKey] and [iosApiKey] respectively.
-[onComplete] will return `uid` for Ads integrations.
-
-```subscriptions, basic purchases) automatically.
-static Future<void> launchWith({
-  String androidApiKey,
-  String iosApiKey,
-  void Function(String) onComplete,
-})
-```
-
-2. Same as previous but allows you to specify client side `userid` (instead of Qonversion user-id) that will be used for matching data in the third party data:
-
-```
-static Future<void> launchWithClientSideUserId(
-    String userID, {
-    String androidApiKey,
-    String iosApiKey,
-})
-```
+Qonversion will track purchases automatically.
 
-3. **Under development**. Same as previous but allows you to turn off auto tracking purchases and track it manually.
+You can also specify your client side `userId` (instead of Qonversion user-id) that will be used for matching data in the third party data:
 
 ```
-static Future<void> launchWithAutoTrackPurchases(
-    bool autoTrackPurchases, {
-    String androidApiKey,
-    String iosApiKey,
-    void Function(String) onComplete,
-})
+final userId = 'CLIENT_SIDE_USER_ID';
+Qonversion.launch(
+  iosApiKey: 'YOUR_IOS_API_KEY',
+  androidApiKey: 'YOUR_ANDROID_API_KEY',
+  userId: userId,
+);
 ```
 
 ## License

android/build.gradle

@@ -41,5 +41,5 @@ android {
 
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    implementation "com.qonversion.android.sdk:sdk:0.2.4"
+    implementation "com.qonversion.android.sdk:sdk:0.3.0"
 }

android/src/main/kotlin/com/qonversion/flutter/sdk/qonversion_flutter_sdk/FlutterResult+CustomErrors.kt

@@ -0,0 +1,23 @@
+package com.qonversion.flutter.sdk.qonversion_flutter_sdk
+
+import io.flutter.plugin.common.MethodChannel
+
+fun MethodChannel.Result.noArgsError() {
+    return this.error("0", "Could not find call arguments", "Make sure you pass Map as call arguments")
+}
+
+fun MethodChannel.Result.noApiKeyError() {
+    return this.error("1", "Could not find API key", "Make sure you pass Map as call arguments")
+}
+
+fun MethodChannel.Result.noUserIdError() {
+    return this.error("2", "Could not find userID", "Make sure you pass Map as call arguments")
+}
+
+fun MethodChannel.Result.noAutoTrackPurchasesError() {
+    return this.error("3", "Could not find autoTrackPurchases boolean value", "Make sure you pass Map as call arguments")
+}
+
+fun MethodChannel.Result.qonversionError(message: String, cause: String) {
+    return this.error("9", message, cause)
+}

android/src/main/kotlin/com/qonversion/flutter/sdk/qonversion_flutter_sdk/QonversionFlutterSdkPlugin.kt

@@ -1,10 +1,8 @@
 package com.qonversion.flutter.sdk.qonversion_flutter_sdk
 
+import android.app.Activity
 import android.app.Application
 import androidx.annotation.NonNull;
-import com.android.billingclient.api.BillingClient
-import com.android.billingclient.api.BillingResult
-import io.flutter.embedding.engine.plugins.FlutterPlugin
 import io.flutter.plugin.common.MethodCall
 import io.flutter.plugin.common.MethodChannel
 import io.flutter.plugin.common.MethodChannel.MethodCallHandler
@@ -14,99 +12,106 @@ import io.flutter.plugin.common.PluginRegistry.Registrar
 import com.qonversion.android.sdk.Qonversion;
 import com.qonversion.android.sdk.QonversionBillingBuilder
 import com.qonversion.android.sdk.QonversionCallback
-import io.flutter.embedding.engine.plugins.activity.ActivityAware
-import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding
 
 /** QonversionFlutterSdkPlugin */
-class QonversionFlutterSdkPlugin: FlutterPlugin, MethodCallHandler, ActivityAware {
-  private lateinit var channel : MethodChannel
-  private var application: Application? = null
-
-
-  override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
-    channel = MethodChannel(flutterPluginBinding.getFlutterEngine().getDartExecutor(), "qonversion_flutter_sdk")
-    channel.setMethodCallHandler(this);
-  }
-
-  override fun onDetachedFromEngine(@NonNull binding: FlutterPlugin.FlutterPluginBinding) {
-    channel.setMethodCallHandler(null)
-  }
-
-  override fun onAttachedToActivity(binding: ActivityPluginBinding) {
-    this.application = binding.activity.application
-  }
-
-  override fun onDetachedFromActivityForConfigChanges() {
-    this.application = null
-  }
-
-  override fun onReattachedToActivityForConfigChanges(binding: ActivityPluginBinding) {
-    this.application = binding.activity.application
-  }
-
-  override fun onDetachedFromActivity() {
-    this.application = null
-  }
-
-  companion object {
-    @JvmStatic
-    fun registerWith(registrar: Registrar) {
-      val channel = MethodChannel(registrar.messenger(), "qonversion_flutter_sdk")
-      channel.setMethodCallHandler(QonversionFlutterSdkPlugin())
-    }
-  }
-
-  override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) {
-    val args = call.arguments as? Map<String, Any> ?: return result.error("1",
-            "Please provide arguments",
-            "There was no arguments in method call")
-
-    val key = args["key"] as? String
-    val internalUserId = args["userID"] as? String
-
-    when (call.method) {
-      "launchWithKeyCompletion" -> launchWith(key, internalUserId, result)
-      "launchWithKeyUserId" -> launchWith(key, internalUserId, result)
-      "launchWithKeyAutoTrackPurchasesCompletion" -> launchWith(key, internalUserId, result)
-      "addAttributionData" -> result.notImplemented() // since there is no such method in Android SDK
-      else -> result.notImplemented()
+class QonversionFlutterSdkPlugin internal constructor(registrar: Registrar): MethodCallHandler {
+    private val activity: Activity = registrar.activity()
+    private val application: Application = activity.application
+
+    companion object {
+        @JvmStatic
+        fun registerWith(registrar: Registrar) {
+            val channel = MethodChannel(registrar.messenger(), "qonversion_flutter_sdk")
+            channel.setMethodCallHandler(QonversionFlutterSdkPlugin(registrar))
+        }
     }
-  }
 
-  private fun launchWith(key: String?, internalUserId: String?, result: Result) {
-    if (key == null) {
-      return result.error("1", "Could not find API key", "Please provide valid API key")
+    override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) {
+        val args = call.arguments<Map<String, Any>>()
+
+        if (args == null || args.isEmpty()) {
+            result.noArgsError()
+            return
+        }
+
+        val apiKey = call.argument<String>("key")
+        if (apiKey == null) {
+            result.noApiKeyError()
+            return
+        }
+
+        val internalUserId = args["userID"] as? String ?: ""
+        val autoTrackPurchases = args["autoTrackPurchases"] as? Boolean ?: true
+
+        when (call.method) {
+            "launch" -> launch(apiKey, args, result)
+
+            // TODO remove when old methods get removed on Dart side
+            "launchWithKeyCompletion",
+            "launchWithKeyUserId",
+            "launchWithKeyAutoTrackPurchasesCompletion" -> launchWith(apiKey, internalUserId, autoTrackPurchases, result)
+            "addAttributionData" -> result.notImplemented() // since there is no such method in Android SDK
+            else -> result.notImplemented()
+        }
     }
 
-    val billingBuilder = buildBilling()
-
-    val callback = object: QonversionCallback {
-      override fun onSuccess(uid: String) {
-        result.success(uid)
-      }
-
-      override fun onError(t: Throwable) {
-        result.error("1", t.localizedMessage, t.cause.toString())
-      }
+    private fun launch(apiKey: String, args: Map<String, Any>, result: Result) {
+        val userId = args["userID"] as? String ?: ""
+
+        val billingBuilder = QonversionBillingBuilder()
+                .enablePendingPurchases()
+                .setListener { _, _ ->  }
+
+        val callback = object: QonversionCallback {
+            override fun onSuccess(uid: String) {
+                result.success(uid)
+            }
+
+            override fun onError(t: Throwable) {
+                result.qonversionError(t.localizedMessage, t.cause.toString())
+            }
+        }
+
+        Qonversion.initialize(
+                application,
+                apiKey,
+                userId,
+                billingBuilder,
+                true,
+                callback
+        )
     }
 
-    val app = application ?: return
-
-    Qonversion.initialize(
-            app,
-            key,
-            internalUserId ?: "",
-            billingBuilder,
-            true,
-            callback
-    )
-  }
-
-  private fun buildBilling(): QonversionBillingBuilder {
-    return QonversionBillingBuilder()
-            .enablePendingPurchases()
-            .setChildDirected(BillingClient.ChildDirected.CHILD_DIRECTED)
-            .setUnderAgeOfConsent(BillingClient.UnderAgeOfConsent.UNSPECIFIED)
-            .setListener { _, _ -> }
-  }
+    // TODO remove when old methods get removed on Dart side
+    private fun launchWith(key: String?,
+                           internalUserId: String = "",
+                           autoTrackPurchases: Boolean = true,
+                           result: Result) {
+        if (key == null) {
+          return result.error("1", "Could not find API key", "Please provide valid API key")
+        }
+
+        val billingBuilder = QonversionBillingBuilder()
+                .enablePendingPurchases()
+                .setListener { _, _ ->  }
+
+        val callback = object: QonversionCallback {
+            override fun onSuccess(uid: String) {
+                result.success(uid)
+            }
+
+            override fun onError(t: Throwable) {
+                result.qonversionError(t.localizedMessage, t.cause.toString())
+            }
+        }
+
+        Qonversion.initialize(
+                application,
+                key,
+                internalUserId,
+                billingBuilder,
+                autoTrackPurchases,
+                callback
+        )
+    }
 }

example/.gitignore

@@ -29,6 +29,10 @@
 .pub-cache/
 .pub/
 /build/
+pubspec.lock
+
+# iOS related
+ios/Podfile.lock
 
 # Web related
 lib/generated_plugin_registrant.dart