Merge branch 'development'

Author: sofakingforever

README.md

@@ -25,7 +25,7 @@ repositories {
 
 dependencies {
 
-    def version = '1.0.13'
+    def version = '1.0.16'
 
     // add the basic analytics interface library - incl. LoggerDispatcher
     compile "com.sofakingforever.analytics:analytics:version@aar"

analytics/build.gradle

@@ -41,6 +41,10 @@ android {
 //        unitTests.returnDefaultValues = true
 //    }
 }
+repositories {
+    mavenCentral()
+
+}
 
 dependencies {
 
@@ -60,6 +64,7 @@ dependencies {
     androidTestImplementation 'org.mockito:mockito-android:2.7.22'
 
     implementation 'com.squareup.okhttp3:okhttp:3.11.0'
+    implementation 'com.sofakingforever.repoverse:repoverse:1.0.2'
 
 
 
@@ -69,9 +74,6 @@ dependencies {
 //    testCompile 'org.powermock:powermock-api-mockito:1.6.5'
 
 
-}
-repositories {
-    mavenCentral()
 }
 ext {
     bintrayRepo = 'analytics'

analytics/src/main/java/com/sofakingforever/analytics/Analytics.kt

@@ -19,7 +19,7 @@ class Analytics(val settings: AnalyticsSettings, private vararg val dispatchers:
     init {
 
         // check for new library version if enabled
-        if (settings.checkForUpdates) VersionChecker.onCheckVersion()
+        if (settings.checkForUpdates) VersionChecker.invoke()
 
         // init all dispatchers
         dispatchers.forEach { dispatcher ->

analytics/src/main/java/com/sofakingforever/analytics/AnalyticsDispatcher.kt

@@ -1,10 +1,7 @@
 package com.sofakingforever.analytics
 
 import android.content.Context
-import com.sofakingforever.analytics.events.ContentViewEvent
-import com.sofakingforever.analytics.events.CustomEvent
-import com.sofakingforever.analytics.events.InviteEvent
-import com.sofakingforever.analytics.events.SetUserProperty
+import com.sofakingforever.analytics.events.*
 import com.sofakingforever.analytics.events.base.Event
 import com.sofakingforever.analytics.exceptions.UnsupportedEventException
 
@@ -21,14 +18,13 @@ interface AnalyticsDispatcher {
 
     val kit: AnalyticsKit
 
-    val dispatcherName : String
+    val dispatcherName: String
 
     /**
      * Should call the analytics library's initiation methods
      */
     fun initDispatcher(context: Context)
 
-
     fun trackContentView(contentView: ContentViewEvent)
 
     fun trackCustomEvent(event: CustomEvent)
@@ -37,22 +33,48 @@ interface AnalyticsDispatcher {
 
     fun setUserProperty(property: SetUserProperty)
 
+    fun setUserProperties(properties: SetUserProperties)
+
     /**
      * This method is called from the parent @Analytics class for each event.
      * Override this method if you plan on interfacing your own event types.
      */
     fun track(event: Event) {
+        // track the event only if it is not configured as excluded
         if (event.isConsideredIncluded(kit)) {
-            // track the event only if it is not configured as excluded
-            when (event) {
-                // track each type differently
-                is CustomEvent -> trackCustomEvent(event)
-                is ContentViewEvent -> trackContentView(event)
-                is InviteEvent -> trackInviteEvent(event)
-                is SetUserProperty -> setUserProperty(event)
-                // alert developer if this is a customized event implementation
-                else -> throw UnsupportedEventException(event)
+
+            var handled = false
+
+            // track for each type differently, including multiple implementations
+            if (event is CustomEvent) {
+                trackCustomEvent(event)
+                handled = true
+            }
+
+            if (event is ContentViewEvent) {
+                trackContentView(event)
+                handled = true
+            }
+
+            if (event is InviteEvent) {
+                trackInviteEvent(event)
+                handled = true
             }
+
+            if (event is SetUserProperty) {
+                setUserProperty(event)
+                handled = true
+            }
+
+            if (event is SetUserProperties) {
+                setUserProperties(event)
+                handled = true
+            }
+
+            if (!handled) {
+                throw UnsupportedEventException(event)
+            }
+
         }
     }
 

analytics/src/main/java/com/sofakingforever/analytics/events/SetUserProperties.kt

@@ -0,0 +1,10 @@
+package com.sofakingforever.analytics.events
+
+import com.sofakingforever.analytics.AnalyticsKit
+import com.sofakingforever.analytics.events.base.Event
+
+interface SetUserProperties : Event {
+    fun getUserProperties(kit: AnalyticsKit): MutableMap<String, Any> {
+        return mutableMapOf()
+    }
+}

analytics/src/main/java/com/sofakingforever/analytics/kits/logger/LoggerDispatcherImpl.kt

@@ -4,10 +4,7 @@ import android.content.Context
 import android.util.Log
 import com.sofakingforever.analytics.AnalyticsDispatcher
 import com.sofakingforever.analytics.AnalyticsKit
-import com.sofakingforever.analytics.events.ContentViewEvent
-import com.sofakingforever.analytics.events.CustomEvent
-import com.sofakingforever.analytics.events.InviteEvent
-import com.sofakingforever.analytics.events.SetUserProperty
+import com.sofakingforever.analytics.events.*
 
 /**
  * This is just a logger implementation, Use this if you're in DEBUG mode.
@@ -17,6 +14,7 @@ import com.sofakingforever.analytics.events.SetUserProperty
  */
 class LoggerDispatcherImpl(override val init: Boolean) : AnalyticsDispatcher {
 
+
     override val dispatcherName: String = "LoggerDispatcher"
 
     constructor() : this(true)
@@ -45,4 +43,7 @@ class LoggerDispatcherImpl(override val init: Boolean) : AnalyticsDispatcher {
     override fun setUserProperty(property: SetUserProperty) {
         Log.d(tag, "Tracking user property ${property.key} = ${property.value}")
     }
+    override fun setUserProperties(properties: SetUserProperties) {
+        Log.d(tag, "Tracking user properties ${properties.getUserProperties(kit)}")
+    }
 }

analytics/src/main/java/com/sofakingforever/analytics/version/Version.kt

@@ -1,58 +1,19 @@
 package com.sofakingforever.analytics.version
 
-import android.util.Log
-import com.sofakingforever.analytics.exceptions.IllegalVersionFormatException
 import com.sofakingforever.library.BuildConfig
-import okhttp3.*
-import java.io.IOException
+import com.sofakingforever.repoverse.Version
+import com.sofakingforever.repoverse.resolvers.BintrayVersionResolver
 
 object VersionChecker {
 
-    fun onCheckVersion() {
+    private val currentVersion = Version(BuildConfig.VERSION_NAME)
 
-        val currentVersion = Version(BuildConfig.VERSION_NAME)
+    private const val packagePath: String = "sofakingforever/analytics/kotlin-analytics"
 
-        val client = OkHttpClient.Builder()
-                .followRedirects(true)
-                .build()
+    fun invoke() {
+        BintrayVersionResolver(packagePath)
+                .resolve(VersionResolverCallback(currentVersion))
 
-        val request = Request.Builder()
-                .url("https://bintray.com/sofakingforever/analytics/kotlin-analytics/_latestVersion")
-                .get()
-                .build()
-
-        client.newCall(request).enqueue(object : Callback {
-
-            override fun onFailure(call: Call?, e: IOException?) {
-                // ignore failure, no need to fill logcat with bullshit
-            }
-
-            override fun onResponse(call: Call?, response: Response?) {
-                // try to finish up
-                response?.url().also { url ->
-
-                    try {
-                        val latestVersion = Version(extractVersion(url))
-
-                        if (currentVersion < latestVersion) {
-                            // user should update
-                            Log.w("Analytics", "Latest kotlin-analytics version is $latestVersion > $currentVersion")
-                        }
-                    } catch (e: IllegalVersionFormatException) {
-                        // ignore failure, no need to fill logcat with bullshit
-                    }
-
-
-                }
-            }
-
-        })
-    }
-
-    fun extractVersion(it: HttpUrl?) : String = it?.encodedPathSegments()?.last() ?: ""
-
-    private fun Response?.url(): HttpUrl? {
-        return this?.networkResponse()?.request()?.url()
     }
 
 }

analytics/src/main/java/com/sofakingforever/analytics/version/VersionChecker.kt

@@ -0,0 +1,15 @@
+package com.sofakingforever.analytics.version
+
+import android.util.Log
+import com.sofakingforever.repoverse.Version
+import com.sofakingforever.repoverse.resolvers.RemoteVersionResolver
+
+class VersionResolverCallback(private val currentVersion: Version) : RemoteVersionResolver.Callback {
+
+    override fun onVersionResolved(latestVersion: Version) {
+        if (currentVersion < latestVersion) {
+            // user should update
+            Log.w("kotlin-analytics", "Latest library version $latestVersion > $currentVersion (current)")
+        }
+    }
+}

analytics/src/main/java/com/sofakingforever/analytics/version/VersionResolverCallback.kt

@@ -2,14 +2,12 @@ package com.sofakingforever.library
 
 import android.content.Context
 import com.sofakingforever.analytics.Analytics
+import com.sofakingforever.analytics.AnalyticsSettings
 import com.sofakingforever.analytics.exceptions.EventNotTrackedException
 import com.sofakingforever.analytics.exceptions.UnsupportedEventException
 import com.sofakingforever.library.dispatcher.TestKit
 import com.sofakingforever.library.dispatcher.TestableDispatcher
-import com.sofakingforever.library.events.InitDispatcherEvent
-import com.sofakingforever.library.events.TestContentViewEvent
-import com.sofakingforever.library.events.TestCustomEvent
-import com.sofakingforever.library.events.UnsupportedEvent
+import com.sofakingforever.library.events.*
 import org.junit.Test
 import org.mockito.Mockito
 import org.mockito.Mockito.mock
@@ -30,9 +28,9 @@ class AnalyticsUnitTest {
     @Test
     fun testAnalytics() {
 
-        analytics = Analytics(contextMock, dispatcher).apply {
+        analytics = Analytics(AnalyticsSettings(contextMock), dispatcher).apply {
 
-            this.settings.exceptionHandler = object : Analytics.ExceptionHandler {
+            this.exceptionHandler = object : Analytics.ExceptionHandler {
                 override fun onException(e: Exception) {
                     raisedException = e
                 }
@@ -80,7 +78,9 @@ class AnalyticsUnitTest {
 
         analytics.track(TestCustomEvent(5))
 
-        analytics.track(TestContentViewEvent(1))
+        analytics.track(TestContentViewEvent(6))
+
+        analytics.track(TestUserProperties(7))
 
     }
 
@@ -91,11 +91,15 @@ class AnalyticsUnitTest {
         val eventList = dispatcher.eventList
 
         // expect to find 3 custom events , 1 contentview and 1 init event
-        assert(eventList.size == 5)
+        assert(eventList.size == 6)
         assert(eventList[0] is InitDispatcherEvent)
         assert((eventList[1] as TestCustomEvent).number == 1)
         assert((eventList[2] as TestCustomEvent).number == 3)
         assert((eventList[3] as TestCustomEvent).number == 5)
-        assert((eventList[4] as TestContentViewEvent).number == 1)
+        assert((eventList[4] as TestContentViewEvent).number == 6)
+        assert((eventList[5] as TestUserProperties).number == 7)
+        val mapValues = (eventList[5] as TestUserProperties).getUserProperties(TestKit.instance).toString()
+
+
     }
 }

analytics/src/test/java/com/sofakingforever/library/AnalyticsUnitTest.kt

@@ -3,15 +3,13 @@ package com.sofakingforever.library.dispatcher
 import android.content.Context
 import com.sofakingforever.analytics.AnalyticsDispatcher
 import com.sofakingforever.analytics.AnalyticsKit
-import com.sofakingforever.analytics.events.ContentViewEvent
-import com.sofakingforever.analytics.events.CustomEvent
-import com.sofakingforever.analytics.events.InviteEvent
-import com.sofakingforever.analytics.events.SetUserProperty
+import com.sofakingforever.analytics.events.*
 import com.sofakingforever.analytics.events.base.Event
 import com.sofakingforever.library.events.InitDispatcherEvent
 
 class TestableDispatcher : AnalyticsDispatcher {
 
+
     override val init: Boolean = true
 
     override val kit: AnalyticsKit = TestKit.instance
@@ -40,6 +38,10 @@ class TestableDispatcher : AnalyticsDispatcher {
         eventList.add(property)
     }
 
+    override fun setUserProperties(properties: SetUserProperties) {
+        eventList.add(properties)
+    }
+
     override fun track(event: Event) {
         if (event is InitDispatcherEvent) {
             eventList.add(event)

analytics/src/test/java/com/sofakingforever/library/dispatcher/TestableDispatcher.kt

@@ -0,0 +1,15 @@
+package com.sofakingforever.library.events
+
+import com.sofakingforever.analytics.AnalyticsKit
+import com.sofakingforever.analytics.events.SetUserProperties
+
+class TestUserProperties(val number: Int) : SetUserProperties {
+    override fun getUserProperties(kit: AnalyticsKit): MutableMap<String, Any> {
+        val parameters = super.getUserProperties(kit)
+        parameters["int"] = -2
+        parameters["long"] = +2L
+        parameters["boolean"] = true
+        parameters["string"] = "fun #$number"
+        return parameters
+    }
+}