Merge pull request #28 from crobox/components

Conveniences for retrieving Text and Image badges
crobox · Jul 24, 2024 · b4b93c7 · b4b93c7
2 parents 86bdf18 + afba968
commit b4b93c7
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 60 deletions.
diff --git a/app/src/main/kotlin/com/crobox/sdk/testapp/MainActivity.kt b/app/src/main/kotlin/com/crobox/sdk/testapp/MainActivity.kt
@@ -225,7 +225,7 @@ class MainActivity : AppCompatActivity() {
                             Campaign:$campaignId
                             Variant:$variantId
                             Msg Id:${promotion.content?.messageId}
-                            Component:${promotion.content?.component}
+                            Component:${promotion.content?.componentName}
                             Msg Config:${promotion.content?.config}
                             Image Badge:${promotion.content?.getImageBadge()}
                             Text Badge:${promotion.content?.getTextBadge()}

diff --git a/sdk/build.gradle b/sdk/build.gradle
@@ -41,12 +41,12 @@ android {
 
 dependencies {
     implementation 'io.github.oshai:kotlin-logging-jvm:7.0.0'
-    testImplementation 'junit:junit:4.13.2'
-    testImplementation 'org.slf4j:slf4j-simple:2.0.3'
+    implementation 'org.slf4j:slf4j-api:2.0.7'
     implementation 'com.squareup.retrofit2:retrofit:2.9.0'
     implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
     implementation 'com.google.code.gson:gson:2.11.0'
     implementation(platform("com.squareup.okhttp3:okhttp-bom:4.9.3"))
     implementation("com.squareup.okhttp3:okhttp")
-    implementation("com.squareup.okhttp3:logging-interceptor")
+    testImplementation 'junit:junit:4.13.2'
+    testImplementation 'org.slf4j:slf4j-simple:2.0.7'
 }
diff --git a/sdk/src/main/kotlin/com/crobox/sdk/data/api/CroboxAPI.kt b/sdk/src/main/kotlin/com/crobox/sdk/data/api/CroboxAPI.kt
@@ -1,6 +1,5 @@
 package com.crobox.sdk.data.api
 
-import com.crobox.sdk.domain.BaseResponse
 import com.crobox.sdk.domain.PromotionsResponse
 import okhttp3.RequestBody
 import retrofit2.Call
@@ -16,5 +15,5 @@ internal interface CroboxAPI {
     ): Call<PromotionsResponse?>?
 
     @GET("/socket.gif")
-    fun event(@QueryMap options: Map<String, String>): Call<BaseResponse?>
+    fun event(@QueryMap options: Map<String, String>): Call<Void?>
 }
diff --git a/sdk/src/main/kotlin/com/crobox/sdk/domain/BaseResponse.kt b/sdk/src/main/kotlin/com/crobox/sdk/domain/BaseResponse.kt
diff --git a/sdk/src/main/kotlin/com/crobox/sdk/domain/Components.kt b/sdk/src/main/kotlin/com/crobox/sdk/domain/Components.kt
@@ -1,23 +1,41 @@
 package com.crobox.sdk.domain
 
+enum class PromotionContentType { ImageBadge, TextBadge }
+
+interface PromotionContentConfig {
+    val contentType: PromotionContentType
+    val name: String
+}
+
 data class ImageBadge(
     /// Image url
     val image: String,
 
     /// Alternate Text
-    val altText: String?
-)
+    val altText: String?,
+
+    /// Component name
+    override val name: String,
 
-data class TextBadge (
+    ) : PromotionContentConfig {
+    override val contentType: PromotionContentType = PromotionContentType.ImageBadge
+}
+
+data class TextBadge(
     /// Text message
     val text: String,
 
     /// Font color
-    val fontColor: String,
+    val fontColor: String?,
 
     /// Background color
     val backgroundColor: String?,
 
     /// Border color
-    val borderColor: String?
-)
+    val borderColor: String?,
+
+    /// Component name
+    override val name: String
+) : PromotionContentConfig {
+    override val contentType: PromotionContentType = PromotionContentType.TextBadge
+}
diff --git a/sdk/src/main/kotlin/com/crobox/sdk/domain/PromotionContent.kt b/sdk/src/main/kotlin/com/crobox/sdk/domain/PromotionContent.kt
@@ -25,24 +25,44 @@ data class PromotionContent(
      * Component Name
      */
     @SerializedName("component")
-    val component: String
+    val componentName: String
 ) {
 
+    /**
+     * Returns component if an Image or Text Badge is available
+     */
+    val contentConfig: PromotionContentConfig? =
+        when {
+            config.containsKey("image") -> getImageBadge()
+            config.containsKey("text") -> getTextBadge()
+            else -> null
+        }
+
+    /**
+     * Returns Badge type
+     */
+    val promotionType: PromotionContentType? = contentConfig?.contentType
+
     /**
      * Returns an Image Badge if an image component exists with the following pre-defined keys: "image" and "altText"
      */
     fun getImageBadge(): ImageBadge? {
-        return config["image"]?.let { ImageBadge(it, config["altText"]) }
+        return config["image"]?.let { ImageBadge(it, config["altText"], componentName) }
     }
 
     /**
      * Returns a Text Badge if a text component exists with the following pre-defined keys: "text", "fontColor", "backgroundColor" and "borderColor"
      */
     fun getTextBadge(): TextBadge? {
         return config["text"]?.let { text ->
-            config["fontColor"]?.let { fontColor ->
-                TextBadge(text, fontColor, config["backgroundColor"], config["borderColor"])
-            }
+            TextBadge(
+                text,
+                config["fontColor"],
+                config["backgroundColor"],
+                config["borderColor"],
+                componentName
+            )
+
         }
     }
 }

diff --git a/sdk/src/main/kotlin/com/crobox/sdk/presenter/CroboxAPIPresenter.kt b/sdk/src/main/kotlin/com/crobox/sdk/presenter/CroboxAPIPresenter.kt
@@ -15,7 +15,6 @@ import com.crobox.sdk.data.model.PageViewParams
 import com.crobox.sdk.data.model.ProductParams
 import com.crobox.sdk.data.model.PurchaseParams
 import com.crobox.sdk.data.model.RequestQueryParams
-import com.crobox.sdk.domain.BaseResponse
 import com.crobox.sdk.domain.PromotionsResponse
 import okhttp3.MediaType.Companion.toMediaTypeOrNull
 import okhttp3.RequestBody
@@ -76,9 +75,9 @@ internal class CroboxAPIPresenter(private val config: CroboxConfig) {
         val parameters = eventQuery(queryParams, additionalParams, eventType)
         val stringParameters = parameters.mapValues { it.value.toString() }
 
-        apiInterface.event(stringParameters).enqueue(object : Callback<BaseResponse?> {
+        apiInterface.event(stringParameters).enqueue(object : Callback<Void?> {
             override fun onResponse(
-                call: Call<BaseResponse?>, response: Response<BaseResponse?>
+                call: Call<Void?>, response: Response<Void?>
             ) {
                 try {
                     if (!response.isSuccessful) {
@@ -89,7 +88,7 @@ internal class CroboxAPIPresenter(private val config: CroboxConfig) {
                 }
             }
 
-            override fun onFailure(call: Call<BaseResponse?>, t: Throwable) {
+            override fun onFailure(call: Call<Void?>, t: Throwable) {
                 CroboxDebug.eventError(t.message.toString())
             }
         })

diff --git a/sdk/src/test/java/android/util/Log.java b/sdk/src/test/java/android/util/Log.java