Add provider for KissMetrics (#20)

* Add provider for KissMetrics

Author: jahunt1

.idea/runConfigurations/Unit_Tests___KissMetrics_Provider.xml

@@ -15,7 +15,7 @@ allprojects {
 In your module's build.gradle file, add the dependency:
 ```groovy
 dependencies {
-		compile 'com.github.busybusy.AnalyticsKit-Android:analyticskit:0.8.2'
+		implementation "com.github.busybusy.AnalyticsKit-Android:analyticskit:0.8.2"
         ...
 	}
 ```
@@ -24,7 +24,7 @@ You can include the implemented providers you want by adding them to the same de
 ```groovy
 dependencies {
 		...
-        compile 'com.github.busybusy.AnalyticsKit-Android:mixpanel-provider:0.8.2'
+        implementation "com.github.busybusy.AnalyticsKit-Android:mixpanel-provider:0.8.2"
 	}
 ```
 

README.md

@@ -15,17 +15,20 @@
  */
 
 buildscript {
+	ext {
+		kotlin_version = '1.3.72'
+	}
 	repositories {
 		google()
 		jcenter()
 		maven { url "https://jitpack.io" }
 		maven { url 'https://maven.fabric.io/public' }
 	}
 	dependencies {
-		classpath 'com.android.tools.build:gradle:3.6.2'
+		classpath 'com.android.tools.build:gradle:4.0.1'
 		classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
 		classpath 'com.google.gms:google-services:4.3.3'
-		classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.71"
+		classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.72"
 	}
 }
 
@@ -43,13 +46,13 @@ ext {
 	compileSdkVersion = 29
 	minSdkVersion = 16
 	targetSdkVersion = 29
-	buildToolsVersion = "28.0.3"
+	buildToolsVersion = "30.0.1"
 	versionCode = 12
 	versionName = "0.7.0"
 
 	// dependency versions
 	assertjVersion = "3.14.0"
-	kotlinVersion = "1.3.71"
+	kotlinVersion = "1.3.72"
 	mockitoVersion = "2.12.0"
 	mockitoKotlinVersion = "2.2.0"
 	supportAnnotationsVersion = "28.0.0"

build.gradle

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.2.2-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.jar

@@ -29,6 +29,9 @@ if "%DIRNAME%" == "" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,2 @@
+/build
+kissmetrics-provider.iml

gradlew.bat

@@ -0,0 +1,93 @@
+/*
+ * Copyright 2020 busybusy, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+apply plugin: 'com.android.library'
+apply plugin: 'com.github.dcendents.android-maven'
+apply plugin: 'kotlin-android'
+apply plugin: 'kotlin-android-extensions'
+
+android {
+    compileSdkVersion rootProject.ext.compileSdkVersion
+    buildToolsVersion rootProject.ext.buildToolsVersion
+
+    defaultConfig {
+        minSdkVersion rootProject.ext.minSdkVersion
+        targetSdkVersion rootProject.ext.targetSdkVersion
+        versionCode 1
+        versionName "0.8.0"
+    }
+
+    buildTypes {
+        release {
+            debuggable false
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+        debug {
+            debuggable true
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+
+    sourceSets {
+        main.java.srcDirs += 'src/main/kotlin'
+        test.java.srcDirs += 'src/test/kotlin'
+    }
+
+    testOptions {
+        unitTests.returnDefaultValues = true
+    }
+}
+
+dependencies {
+    implementation 'androidx.core:core-ktx:1.2.0'
+
+    implementation project(path: rootProject.ext.analytics_kit)
+    implementation "com.android.support:support-annotations:$rootProject.ext.supportAnnotationsVersion"
+    compileOnly 'com.kissmetrics.sdk:KISSmetricsSDK:2.2.2'
+
+    testImplementation 'com.kissmetrics.sdk:KISSmetricsSDK:2.2.2'
+    testImplementation "junit:junit:$rootProject.ext.junit_version"
+    testImplementation "org.assertj:assertj-core:$rootProject.ext.assertjVersion"
+    testImplementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$rootProject.ext.kotlinVersion"
+    testImplementation "org.jetbrains.kotlin:kotlin-test-junit:$rootProject.ext.kotlinVersion"
+    testImplementation "com.nhaarman.mockitokotlin2:mockito-kotlin:$rootProject.ext.mockitoKotlinVersion"
+
+    testImplementation "org.powermock:powermock-api-mockito2:2.0.2"
+    testImplementation "org.powermock:powermock-module-junit4:2.0.2"
+}
+
+task sourcesJar(type: Jar) {
+    archiveClassifier.set("sources")
+    from android.sourceSets.main.java.srcDirs
+}
+
+task javadoc(type: Javadoc) {
+    failOnError false
+    source = android.sourceSets.main.java.sourceFiles
+    setClasspath(getClasspath() + project.files(android.getBootClasspath().join(File.pathSeparator)))
+}
+
+task javadocJar(type: Jar, dependsOn: javadoc) {
+    archiveClassifier.set("javadoc")
+    from javadoc.destinationDir
+}
+
+artifacts {
+    archives sourcesJar
+    archives javadocJar
+}

kissmetrics-provider/.gitignore

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

kissmetrics-provider/build.gradle

@@ -0,0 +1,18 @@
+<!--
+  ~ Copyright 2020 busybusy, Inc.
+  ~
+  ~  Licensed under the Apache License, Version 2.0 (the "License");
+  ~  you may not use this file except in compliance with the License.
+  ~  You may obtain a copy of the License at
+  ~
+  ~       http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~  Unless required by applicable law or agreed to in writing, software
+  ~  distributed under the License is distributed on an "AS IS" BASIS,
+  ~  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~  See the License for the specific language governing permissions and
+  ~  limitations under the License.
+  -->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.busybusy.analyticskit.kissmetrics_provider" />

kissmetrics-provider/proguard-rules.pro

@@ -0,0 +1,111 @@
+/*
+ * Copyright 2020 busybusy, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package com.busybusy.analyticskit.kissmetrics_provider
+
+import com.busybusy.analyticskit_android.AnalyticsEvent
+import com.busybusy.analyticskit_android.AnalyticsKitProvider
+import com.busybusy.analyticskit_android.AnalyticsKitProvider.PriorityFilter
+import com.kissmetrics.sdk.KISSmetricsAPI
+import com.kissmetrics.sdk.KISSmetricsAPI.RecordCondition
+import java.text.DecimalFormat
+
+/**
+ * Provider that facilitates reporting events to KissMetrics.
+ * *Note* The KissMetrics SDK supports sending a [RecordCondition]. To send a [RecordCondition] with this provider,
+ * simply add it to the event's attribute map with "`record_condition`" as the key. From Kotlin code this can
+ * also be accomplished by calling the `recordCondition(condition)` extension function on an [AnalyticsEvent] instance.
+ * @see <a href="https://developers.kissmetrics.com/reference#android">KissMetrics Android SDK documentation</a>
+ *
+ * @constructor Initializes a new [KissMetricsProvider] object.
+ *
+ * @property kissMetrics your already-initialized [KISSmetricsAPI] instance. Please call
+ * KISSmetricsAPI.sharedAPI(API_KEY, APPLICATION_CONTEXT) prior to setting up your [KissMetricsProvider].
+ * @property priorityFilter the [PriorityFilter] to use when evaluating events
+ */
+class KissMetricsProvider(private val kissMetrics: KISSmetricsAPI,
+                          private val priorityFilter: PriorityFilter = PriorityFilter { true }
+) : AnalyticsKitProvider {
+    private val timedEvents: MutableMap<String, AnalyticsEvent> = mutableMapOf()
+    private val eventTimes: MutableMap<String, Long> = mutableMapOf()
+
+    override fun getPriorityFilter(): PriorityFilter = priorityFilter
+
+    override fun endTimedEvent(timedEvent: AnalyticsEvent) {
+        val endTime: Long = System.currentTimeMillis()
+        val startTime: Long? = this.eventTimes.remove(timedEvent.name())
+        val finishedEvent: AnalyticsEvent? = timedEvents.remove(timedEvent.name())
+
+        if (startTime != null && finishedEvent != null) {
+            val durationSeconds = (endTime - startTime) / 1000.0
+            val df = DecimalFormat("#.###")
+            finishedEvent.putAttribute(DURATION, df.format(durationSeconds))
+            logKissMetricsEvent(finishedEvent)
+        } else {
+            error("Attempted ending an event that was never started (or was previously ended): " + timedEvent.name())
+        }
+    }
+
+    override fun sendEvent(event: AnalyticsEvent) {
+        if (event.isTimed) { // Hang onto it until it is done
+            eventTimes[event.name()] = System.currentTimeMillis()
+            timedEvents[event.name()] = event
+        } else {  // Send the event through the Intercom SDK
+            logKissMetricsEvent(event)
+        }
+    }
+
+    private fun logKissMetricsEvent(event: AnalyticsEvent) {
+        if (event.attributes != null && event.attributes?.isNotEmpty() == true) {
+            val attributes: MutableMap<String, Any> = event.attributes as MutableMap<String, Any>
+            if (attributes.containsKey(RECORD_CONDITION)) {
+                val condition: RecordCondition = attributes.remove(RECORD_CONDITION) as RecordCondition
+                if (attributes.isNotEmpty()) { // other attributes there we need to track
+                    val stringProperties = attributes.stringifyAttributes()
+                    KISSmetricsAPI.sharedAPI().record(event.name(), stringProperties, condition)
+                } else { // just the condition to send
+                    KISSmetricsAPI.sharedAPI().record(event.name(), condition)
+                }
+            } else { // no condition to record, just attributes
+                val stringProperties = attributes.stringifyAttributes()
+                KISSmetricsAPI.sharedAPI().record(event.name(), stringProperties)
+            }
+        } else { // record event by name only
+            KISSmetricsAPI.sharedAPI().record(event.name())
+        }
+    }
+}
+
+internal const val DURATION = "event_duration"
+const val RECORD_CONDITION = "record_condition"
+
+/**
+ * Converts an attributes Map to to Map<String, String> to appease the KissMetrics API.
+ */
+fun Map<String, Any>.stringifyAttributes(): Map<String, String> {
+    return if (this.isNotEmpty()) {
+        val attributeMap = mutableMapOf<String, String>()
+        for (key in this.keys) {
+            attributeMap[key] = this[key].toString()
+        }
+        attributeMap
+    } else emptyMap()
+}
+
+fun AnalyticsEvent.recordCondition(condition: RecordCondition): AnalyticsEvent {
+    this.putAttribute(RECORD_CONDITION, condition)
+    return this
+}