feat(sdk): support for passing test key for retrieving variable value used in a particular campaign

Author: HarshRaghavWingify

README.md

@@ -1,12 +1,12 @@
-VWO Android SDK
-======================================
+# VWO Android SDK
+
 [![Status](https://travis-ci.org/wingify/vwo-android.svg)](https://travis-ci.org/wingify/vwo-android)
 
 
 This open source library allows you to A/B Test your Android app.
 
-Getting Started
----------------
+## Getting Started
+
 
 1. Download the latest [VWO Android SDK](https://github.com/wingify/vwo-android/releases).
 2. Have a look at [integrating SDK article](https://developers.vwo.com/reference/android-introduction)
@@ -23,73 +23,79 @@ Once there, you can add a new Android App, and use the generated app key in the
 
 
 ## Setting up VWO account
+
 * Sign Up for VWO account at https://vwo.com
 * Create a new android app from create menu
 * Use the app generated app key, while integrating SDK into android app.
 * Create and run campaigns.
 
 ## How to import in gradle:
-In your top level build.gradle file add the following code under repositories.
 
-    buildscript {
+In your top level `build.gradle` file add the following code under repositories.
+
+```text
+buildscript {
+    ...
+    repositories {
         ...
-        repositories {
-            ...
-        }
     }
+}
 
-    allprojects {
-        repositories {
-            ...
-            mavenCentral()
-            ...
-        }
+allprojects {
+    repositories {
+        ...
+        mavenCentral()
+        ...
     }
+}
+```
 
-Add dependencies to app/build.gradle file
+Add dependencies to `app/build.gradle` file
 
-	dependencies {
-	    ...
-	    implementation 'com.vwo:mobile:2.8.2@aar'
-            implementation ('io.socket:socket.io-client:1.0.0') {
-            // excluding org.json which is provided by Android
-            exclude group: 'org.json', module: 'json'
-        }
+```java
+dependencies {
+    ...
+    implementation 'com.vwo:mobile:2.9.0@aar'
+        implementation ('io.socket:socket.io-client:1.0.0') {
+        // excluding org.json which is provided by Android
+        exclude group: 'org.json', module: 'json'
+    }
 
-        // Skip this if you are already including support library in your app.
-        implementation 'com.android.support:support-core-utils:27.1.1'
-	    ...
-	}
+    // Skip this if you are already including support library in your app.
+    implementation 'com.android.support:support-core-utils:27.1.1'
+    ...
+}
+```
 
 Update your project AndroidManifest.xml with following permissions:
 
-```
+```xml
 <uses-permission android:name="android.permission.INTERNET"/>
 <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
 ```
 
 ## License
 
 ```text
-    MIT License
-
-    Copyright (c) 2018-2022 Wingify Software Pvt. Ltd.
-
-    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.
+MIT License
+
+Copyright (c) 2018-2022 Wingify Software Pvt. Ltd.
+
+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.
 ```

demo/src/main/java/com/vwo/sampleapp/activities/MainActivity.java

@@ -262,35 +262,65 @@ private void initVWO(String key, final boolean showProgress, @Nullable Map<Strin
             }
             VWOLog.setLogLevel(VWOLog.ALL);
             VWOConfig.Builder vwoConfigBuilder = new VWOConfig.Builder();
-//            vwoConfigBuilder.disablePreview();
+
+            /* use the below line of code to disable preview mode
+
+                     vwoConfigBuilder.disablePreview();
+            **/
+
             vwoConfigBuilder.setOptOut(false);
-//            vwoConfigBuilder.isChinaCDN(false);
-            vwoConfigBuilder.userID("userId");
-            if (keys == null) {
-                keys = new HashMap<>();
-            }
-//            keys.put("userType", "free");
-            vwoConfigBuilder.setCustomVariables(keys);
-//            if (!TextUtils.isEmpty(Constants.VWOKeys.CUSTOM_DIMENSION_KEY) && !TextUtils.isEmpty(Constants.VWOKeys.CUSTOM_DIMENSION_VALUE)) {
-//                vwoConfigBuilder.setCustomDimension(Constants.VWOKeys.CUSTOM_DIMENSION_KEY, Constants.VWOKeys.CUSTOM_DIMENSION_VALUE);
-//            }
-
-//            new Handler(Looper.getMainLooper()).postDelayed(() -> {
-//                HashMap<String, String> args = new HashMap<>();
-//                args.put("campaignKey", "491");
-//                args.put("groupId", "10");
-//                VWO.getCampaign("[email protected]", args);
-//            }, 4000);
+
+            //vwoConfigBuilder.isChinaCDN(false);
+
+            /* use the below commented code to set userId
+
+                     vwoConfigBuilder.userID("userId");
+            **/
+
+            /* use below code to set customVariables
+
+                     if (keys == null) {
+                         keys = new HashMap<>();
+                     }
+                     keys.put("userType", "free");
+                     vwoConfigBuilder.setCustomVariables(keys);
+            **/
 
             VWO.with(this, key).config(vwoConfigBuilder.build()).launch(new VWOStatusListener() {
                 @Override
                 public void onVWOLoaded() {
-                    HashMap<String, String> args = new HashMap<>();
-                    args.put("test_key", "TestKey");
-                    args.put("groupId", "4");
-//                    Log.d("ReturnCampaignKey",VWO.getCampaign("[email protected]", args)+" ");
 
-                    Log.d("VariationNameForTestKey", VWO.getVariationNameForTestKey(VWO.getCampaign("[email protected]", args)));
+                    /* use the below commented code to use MEG functionality
+
+                             HashMap<String, String> args = new HashMap<>();
+                             args.put("test_key", "TestKey");
+                             args.put("groupId", "4");
+                             Log.d("ReturnCampaignKey",VWO.getCampaign("[email protected]", args)+" ");
+                             Log.d("VariationNameForTestKey", VWO.getVariationNameForTestKey(VWO.getCampaign("[email protected]", args)));
+                    **/
+
+                    /* use the below commented code to get the variationName and perform actions accordingly
+
+                            String testKey = "Camp test 1";
+                            String variationName = VWO.getVariationNameForTestKey(testKey);
+                            if (variationName != null && variationName == "Control") {
+                                // TODO: code for Control
+                            } else if (variationName != null && variationName == "Variation-1") {
+                                // TODO: code for Variation-1
+                            } else {
+                                // TODO: default case
+                            }
+                    **/
+
+                    /* use the below code to make visitor part of all campaigns who are using this TestVariable
+
+                             int testVariable1 = VWO.getIntegerForKey("TestVariable1", 1);
+                    **/
+
+                    /* use the below code to make visitor part of the specific campaign whose testKey we are using
+
+                             int testVariable1 = VWO.getIntegerForKey(testKey, "TestVariable1", 1);
+                    **/
 
                     if (showProgress) {
                         progressBar.setVisibility(View.GONE);

gradle.properties

@@ -1,7 +1,7 @@
 android.enableD8=true
 
-VERSION_NAME=2.9.0
-VERSION_CODE=29
+VERSION_NAME=2.10.0
+VERSION_CODE=30
 GROUP=com.vwo
 
 POM_DESCRIPTION=VWO mobile SDK for A/B Testing Android applications