[CSL 7] Convert Conversion to v2 Endpoint (#63)

* Convert conversion to v2

* Update tests

* Remove unused imports

Author: crgee1

README.md

@@ -131,8 +131,8 @@ ConstructorIo.trackBrowseResultClick("Category", "Snacks", "7654321-BA", "4", "P
 ### Conversion Events
 
 ```kotlin
-// // Track when an item converts (a.k.a. is added to cart) regardless of the user journey that led to adding to cart (itemName, customerId, revenue, searchTerm)
-ConstructorIo.trackConversion("Fashionable Toothpicks", "1234567-AB", 12.99, "tooth")
+// Track when an item converts (a.k.a. is added to cart) regardless of the user journey that led to adding to cart (itemName, customerId, revenue, searchTerm, section, conversionType)
+ConstructorIo.trackConversion("Fashionable Toothpicks", "1234567-AB", 12.99, "tooth", "Products", "add_to_cart")
 
 // Track when items are purchased (customerIds, revenue, orderId)
 ConstructorIo.trackPurchase(arrayOf("1234567-AB", "1234567-AB"), 25.98, "ORD-1312343")

library/src/main/java/io/constructor/core/ConstructorIo.kt

@@ -15,6 +15,7 @@ import io.constructor.data.model.browse.BrowseResultClickRequestBody
 import io.constructor.data.model.browse.BrowseResultLoadRequestBody
 import io.constructor.data.model.purchase.PurchaseItem
 import io.constructor.data.model.purchase.PurchaseRequestBody
+import io.constructor.data.model.conversion.ConversionRequestBody
 import io.constructor.injection.component.AppComponent
 import io.constructor.injection.component.DaggerAppComponent
 import io.constructor.injection.module.AppModule
@@ -313,18 +314,33 @@ object ConstructorIo {
      * @param searchTerm the search term that lead to the event (if adding to cart in a search flow)
      * @param sectionName the section that the results came from, i.e. "Products"
      */
-    fun trackConversion(itemName: String, customerId: String, revenue: Double?, searchTerm: String = Constants.QueryConstants.TERM_UNKNOWN, sectionName: String? = null) {
-        var completable = trackConversionInternal(itemName, customerId, revenue, searchTerm, sectionName)
+    fun trackConversion(itemName: String, customerId: String, revenue: Double?, searchTerm: String = Constants.QueryConstants.TERM_UNKNOWN, sectionName: String? = null, conversionType: String? = null) {
+        var completable = trackConversionInternal(itemName, customerId, revenue, searchTerm, sectionName, conversionType)
         disposable.add(completable.subscribeOn(Schedulers.io()).subscribe({}, {
             t -> e("Conversion error: ${t.message}")
         }))
     }
-    internal fun trackConversionInternal(itemName: String, customerId: String, revenue: Double?, searchTerm: String = Constants.QueryConstants.TERM_UNKNOWN, sectionName: String? = null): Completable {
+    internal fun trackConversionInternal(itemName: String, customerId: String, revenue: Double?, searchTerm: String = Constants.QueryConstants.TERM_UNKNOWN, sectionName: String? = null, conversionType: String? = null): Completable {
         preferenceHelper.getSessionId(sessionIncrementHandler)
-        val revenueString = revenue?.let { "%.2f".format(revenue) }
-        return dataManager.trackConversion(searchTerm, itemName, customerId, revenueString, arrayOf(
-                Constants.QueryConstants.SECTION to (sectionName ?: preferenceHelper.defaultItemSection)
-        ))
+        val section = sectionName ?: preferenceHelper.defaultItemSection
+        val conversionRequestBody = ConversionRequestBody(
+                searchTerm,
+                customerId,
+                itemName,
+                String.format("%.2f", revenue),
+                conversionType,
+                BuildConfig.CLIENT_VERSION,
+                preferenceHelper.id,
+                preferenceHelper.getSessionId(),
+                preferenceHelper.apiKey,
+                configMemoryHolder.userId,
+                configMemoryHolder.segments,
+                true,
+                section,
+                System.currentTimeMillis()
+        )
+
+        return dataManager.trackConversion(conversionRequestBody, arrayOf())
     }
 
     /**
@@ -394,7 +410,7 @@ object ConstructorIo {
 
         return dataManager.trackBrowseResultsLoaded(
                 browseResultLoadRequestBody,
-                arrayOf(Constants.QueryConstants.SECTION to section)
+                arrayOf()
         )
     }
 

library/src/main/java/io/constructor/data/DataManager.kt

@@ -6,6 +6,7 @@ import io.constructor.data.model.search.SearchResponse
 import io.constructor.data.model.browse.BrowseResponse
 import io.constructor.data.model.browse.BrowseResultClickRequestBody
 import io.constructor.data.model.browse.BrowseResultLoadRequestBody
+import io.constructor.data.model.conversion.ConversionRequestBody
 import io.constructor.data.model.purchase.PurchaseRequestBody
 import io.constructor.data.remote.ApiPaths
 import io.constructor.data.remote.ConstructorApi
@@ -74,8 +75,8 @@ constructor(private val constructorApi: ConstructorApi, private val moshi: Moshi
         return constructorApi.trackSessionStart(params.toMap())
     }
 
-    fun trackConversion(term: String, itemName: String, customerId: String, revenue: String? = null, params: Array<Pair<String, String>> = arrayOf()): Completable {
-        return constructorApi.trackConversion(term, itemName, customerId, revenue, params.toMap())
+    fun trackConversion(conversionRequestBody: ConversionRequestBody, params: Array<Pair<String, String>> = arrayOf()): Completable {
+        return constructorApi.trackConversion(conversionRequestBody, params.toMap())
     }
 
     fun trackSearchResultClick(itemName: String, customerId: String, term: String, params: Array<Pair<String, String>> = arrayOf(), encodedParams: Array<Pair<String,  String>> = arrayOf()): Completable {

library/src/main/java/io/constructor/data/model/conversion/ConversionRequestBody.kt

@@ -0,0 +1,22 @@
+package io.constructor.data.model.conversion
+
+import com.squareup.moshi.Json
+import io.constructor.data.model.common.*;
+import java.io.Serializable
+
+data class ConversionRequestBody(
+        @Json(name = "search_term") val searchTerm: String,
+        @Json(name = "item_id") val itemID: String,
+        @Json(name = "item_name") val itemName: String,
+        @Json(name = "revenue") val revenue: String,
+        @Json(name = "conversion_type") val conversionType: String?,
+        @Json(name = "c") val c: String,
+        @Json(name = "i") val i: String,
+        @Json(name = "s") val s: Int,
+        @Json(name = "key") val key: String,
+        @Json(name = "ui") val ui: String?,
+        @Json(name = "us") val us: List<String?>,
+        @Json(name= "beacon") val beacon: Boolean?,
+        @Json(name= "section") val section: String?,
+        @Json(name= "_dt") val _dt: Long?
+) : Serializable

library/src/main/java/io/constructor/data/remote/ApiPaths.kt

@@ -5,7 +5,7 @@ object ApiPaths {
     const val URL_AUTOCOMPLETE_SELECT_EVENT = "autocomplete/{term}/select"
     const val URL_SEARCH_SUBMIT_EVENT = "autocomplete/{term}/search"
     const val URL_SESSION_START_EVENT = "behavior"
-    const val URL_CONVERSION_EVENT = "autocomplete/{term}/conversion"
+    const val URL_CONVERSION_EVENT = "v2/behavioral_action/conversion"
     const val URL_SEARCH_RESULT_CLICK_EVENT = "autocomplete/{term}/click_through"
     const val URL_BEHAVIOR = "behavior"
     const val URL_PURCHASE = "v2/behavioral_action/purchase"

library/src/main/java/io/constructor/data/remote/ConstructorApi.kt

@@ -3,6 +3,7 @@ package io.constructor.data.remote
 import io.constructor.data.model.browse.BrowseResultClickRequestBody
 import io.constructor.data.model.browse.BrowseResultLoadRequestBody
 import io.constructor.data.model.purchase.PurchaseRequestBody
+import io.constructor.data.model.conversion.ConversionRequestBody
 import io.reactivex.Completable
 import io.reactivex.Single
 import okhttp3.ResponseBody
@@ -28,11 +29,8 @@ interface ConstructorApi {
     @GET(ApiPaths.URL_SESSION_START_EVENT)
     fun trackSessionStart(@QueryMap params: Map<String, String>): Completable
 
-    @GET(ApiPaths.URL_CONVERSION_EVENT)
-    fun trackConversion(@Path("term") term: String,
-                        @Query("name") itemName: String,
-                        @Query("customer_id") customerId: String,
-                        @Query("revenue") revenue: String?,
+    @POST(ApiPaths.URL_CONVERSION_EVENT)
+    fun trackConversion(@Body conversionRequestBody: ConversionRequestBody,
                         @QueryMap params: Map<String, String>): Completable
 
     @GET(ApiPaths.URL_SEARCH_RESULT_CLICK_EVENT)

library/src/test/java/io/constructor/core/ConstructorIoTrackingTest.kt

@@ -10,6 +10,7 @@ import io.mockk.every
 import io.mockk.mockk
 import okhttp3.mockwebserver.MockResponse
 import okhttp3.mockwebserver.MockWebServer
+import okhttp3.mockwebserver.RecordedRequest
 import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
@@ -18,6 +19,15 @@ import java.util.concurrent.TimeUnit
 import kotlin.test.assertEquals
 import kotlin.test.assertTrue
 
+internal fun getRequestBody(request: RecordedRequest): Map<String, String> {
+    val requestBodyString = request.body.readUtf8().drop(1).dropLast(1).replace("\"", "")
+    val requestBodyList = ArrayList(requestBodyString.split(","))
+    return requestBodyList.associate {
+        val (key, value) = it.split(":")
+        key to value
+    }
+}
+
 class ConstructorIoTrackingTest {
 
     @Rule
@@ -299,7 +309,26 @@ class ConstructorIoTrackingTest {
         val observer = ConstructorIo.trackConversionInternal("titanic replica", "TIT-REP-1997", 89.00).test()
         observer.assertComplete()
         val request = mockServer.takeRequest()
-        val path = "/autocomplete/TERM_UNKNOWN/conversion?name=titanic%20replica&customer_id=TIT-REP-1997&revenue=89.00&section=Products&key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.5.2&_dt=";
+        val path = "/v2/behavioral_action/conversion?key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.5.2&_dt=";
+        assert(request.path.startsWith(path))
+        assertTrue(request.bodySize > 220)
+        assertEquals("POST", request.method)
+    }
+
+    @Test
+    fun trackConversionWithConversionType() {
+        val mockResponse = MockResponse().setResponseCode(204)
+        mockServer.enqueue(mockResponse)
+        val observer = ConstructorIo.trackConversionInternal("titanic replica", "TIT-REP-1997", 89.00, "titanic", "Products", "Like").test()
+        observer.assertComplete()
+        val request = mockServer.takeRequest()
+        val requestBody = getRequestBody(request)
+        val path = "/v2/behavioral_action/conversion?key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.5.2&_dt=";
+        assertEquals(requestBody["conversion_type"], "Like")
+        assertEquals(requestBody["revenue"], "89.00")
+        assertEquals(requestBody["search_term"], "titanic")
+        assertEquals(requestBody["section"], "Products")
+        assertEquals(request.method,"POST")
         assert(request.path.startsWith(path))
     }
 
@@ -310,8 +339,10 @@ class ConstructorIoTrackingTest {
         val observer = ConstructorIo.trackConversionInternal("titanic replica", "TIT-REP-1997", 89.00).test()
         observer.assertError { true }
         val request = mockServer.takeRequest()
-        val path = "/autocomplete/TERM_UNKNOWN/conversion?name=titanic%20replica&customer_id=TIT-REP-1997&revenue=89.00&section=Products&key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.5.2&_dt=";
+        val path = "/v2/behavioral_action/conversion?key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.5.2&_dt=";
         assert(request.path.startsWith(path))
+        assertTrue(request.bodySize > 220)
+        assertEquals("POST", request.method)
     }
 
     @Test
@@ -321,9 +352,8 @@ class ConstructorIoTrackingTest {
         mockServer.enqueue(mockResponse)
         val observer = ConstructorIo.trackConversionInternal("titanic replica", "TIT-REP-1997", 89.00).test()
         observer.assertError(SocketTimeoutException::class.java)
-        val request = mockServer.takeRequest()
-        val path = "/autocomplete/TERM_UNKNOWN/conversion?name=titanic%20replica&customer_id=TIT-REP-1997&revenue=89.00&section=Products&key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.5.2&_dt=";
-        assert(request.path.startsWith(path))
+        val request = mockServer.takeRequest(10, TimeUnit.SECONDS)
+        assertEquals(null, request)
     }
 
     @Test
@@ -380,7 +410,7 @@ class ConstructorIoTrackingTest {
         val observer = ConstructorIo.trackBrowseResultsLoadedInternal("group_id", "Movies", 10).test()
         observer.assertComplete()
         val request = mockServer.takeRequest()
-        val path = "/v2/behavioral_action/browse_result_load?section=Products&key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.5.2&_dt="
+        val path = "/v2/behavioral_action/browse_result_load?key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.5.2&_dt="
         assert(request.path.startsWith(path))
         assertTrue(request.bodySize > 215)
         assertEquals("POST", request.method)
@@ -393,7 +423,7 @@ class ConstructorIoTrackingTest {
         val observer = ConstructorIo.trackBrowseResultsLoadedInternal("group_id", "Movies", 10).test()
         observer.assertError { true }
         val request = mockServer.takeRequest()
-        val path = "/v2/behavioral_action/browse_result_load?section=Products&key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.5.2&_dt="
+        val path = "/v2/behavioral_action/browse_result_load?key=copper-key&i=wacko-the-guid&ui=player-three&s=67&c=cioand-2.5.2&_dt="
         assert(request.path.startsWith(path))
         assertTrue(request.bodySize > 220)
         assertEquals("POST", request.method)

library/src/test/java/io/constructor/core/ConstructorioSegmentsTest.kt

@@ -140,7 +140,7 @@ class ConstructorioSegmentsTest {
         val observer = ConstructorIo.trackConversionInternal("titanic replica", "TIT-REP-1997", 89.00).test()
         observer.assertComplete()
         val request = mockServer.takeRequest()
-        val path = "/autocomplete/TERM_UNKNOWN/conversion?name=titanic%20replica&customer_id=TIT-REP-1997&revenue=89.00&section=Products&key=aluminium-key&i=koopa-the-guid&ui=player-two&s=14&us=mobile&us=COUNTRY_US&c=cioand-2.5.2&_dt=";
+        val path = "/v2/behavioral_action/conversion?key=aluminium-key&i=koopa-the-guid&ui=player-two&s=14&us=mobile&us=COUNTRY_US&c=cioand-2.5.2&_dt=";
         assert(request.path.startsWith(path))
     }
 

library/src/test/java/io/constructor/core/ConstructorioTestCellTest.kt

@@ -141,7 +141,7 @@ class ConstructorioTestCellTest {
         val observer = ConstructorIo.trackConversionInternal("titanic replica", "TIT-REP-1997", 89.00).test()
         observer.assertComplete()
         val request = mockServer.takeRequest()
-        val path = "/autocomplete/TERM_UNKNOWN/conversion?name=titanic%20replica&customer_id=TIT-REP-1997&revenue=89.00&section=Products&key=aluminium-key&i=koopa-the-guid&ui=player-two&s=14&ef-cellone=vanilla&ef-celltwo=whipped-cream&c=cioand-2.5.2&_dt=";
+        val path = "/v2/behavioral_action/conversion?key=aluminium-key&i=koopa-the-guid&ui=player-two&s=14&ef-cellone=vanilla&ef-celltwo=whipped-cream&c=cioand-2.5.2&_dt=";
         assert(request.path.startsWith(path))
     }