[CSL 449] Android Recommendations (#71)

* Convert conversion to v2

* Update tests

* Remove unused imports

* Update conversion tests

* Check request body for v2 endpoints

* Update tests

* Add recommendations support

* Add integration test

* Merge master

* Adjust gradle

* Add data model checks to integration tests

* Remove facets

* Add back private

Author: crgee1

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

@@ -42,6 +42,9 @@ class Constants {
         const val FILTER_VALUE = "filter_value"
         const val RESULT_POSITION_ON_PAGE = "result_position_on_page"
         const val RESULT_COUNT = "result_count"
+        const val NUM_RESULT = "num_result"
+        const val ITEM_ID = "item_id"
+        const val TERM = "term"
     }
 
     object QueryValues {

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

@@ -11,6 +11,7 @@ import io.constructor.data.model.autocomplete.AutocompleteResponse
 import io.constructor.data.model.common.ResultGroup
 import io.constructor.data.model.search.SearchResponse
 import io.constructor.data.model.browse.BrowseResponse
+import io.constructor.data.model.recommendations.RecommendationsResponse
 import io.constructor.data.model.browse.BrowseResultClickRequestBody
 import io.constructor.data.model.browse.BrowseResultLoadRequestBody
 import io.constructor.data.model.purchase.PurchaseItem
@@ -474,4 +475,26 @@ object ConstructorIo {
 
     }
 
-}
+    /**
+     * Returns a list of search results including filters, categories, sort options, etc.
+     * @param podId the pod id
+     * @param facets  additional facets used to refine results
+     * @param numResults the number of results to return
+     * @param sectionName the section the selection will come from, i.e. "Products"
+     * @param itemId: The item id to retrieve recommendations (strategy specific)
+     * @param term: The term to use to refine results (strategy specific)
+     */
+    fun getRecommendationResults(podId: String, facets: List<Pair<String, List<String>>>? = null, numResults: Int? = null, sectionName: String? = null, itemId: String? = null, term: String? = null): Observable<ConstructorData<RecommendationsResponse>> {
+        val encodedParams: ArrayList<Pair<String, String>> = arrayListOf()
+        numResults?.let { encodedParams.add(Constants.QueryConstants.NUM_RESULT.urlEncode() to numResults.toString().urlEncode()) }
+        sectionName?.let { encodedParams.add(Constants.QueryConstants.SECTION.urlEncode() to sectionName.toString().urlEncode()) }
+        itemId?.let { encodedParams.add(Constants.QueryConstants.ITEM_ID.urlEncode() to itemId.toString().urlEncode()) }
+        term?.let { encodedParams.add(Constants.QueryConstants.TERM.urlEncode() to term.toString().urlEncode()) }
+        facets?.forEach { facet ->
+            facet.second.forEach {
+                encodedParams.add(Constants.QueryConstants.FILTER_FACET.format(facet.first).urlEncode() to it.urlEncode())
+            }
+        }
+        return dataManager.getRecommendationResults(podId, encodedParams = encodedParams.toTypedArray())
+    }
+}

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

@@ -4,6 +4,7 @@ import com.squareup.moshi.Moshi
 import io.constructor.data.model.autocomplete.AutocompleteResponse
 import io.constructor.data.model.search.SearchResponse
 import io.constructor.data.model.browse.BrowseResponse
+import io.constructor.data.model.recommendations.RecommendationsResponse
 import io.constructor.data.model.browse.BrowseResultClickRequestBody
 import io.constructor.data.model.browse.BrowseResultLoadRequestBody
 import io.constructor.data.model.conversion.ConversionRequestBody
@@ -122,4 +123,23 @@ constructor(private val constructorApi: ConstructorApi, private val moshi: Moshi
         return constructorApi.trackBrowseResultClick(browseResultClickRequestBody, params.toMap(), encodedParams.toMap())
     }
 
-}
+    fun getRecommendationResults(podId: String, encodedParams: Array<Pair<String, String>> = arrayOf()): Observable<ConstructorData<RecommendationsResponse>> {
+        return constructorApi.getRecommendationResults(podId, encodedParams?.toMap()).map {
+            if (!it.isError) {
+                it.response()?.let {
+                    if (it.isSuccessful) {
+                        val adapter = moshi.adapter(RecommendationsResponse::class.java)
+                        val response = it.body()?.string()
+                        val result = response?.let { adapter.fromJson(it) }
+                        result?.rawData = response
+                        ConstructorData.of(result!!)
+                    } else {
+                        ConstructorData.networkError(it.errorBody()?.string())
+                    }
+                } ?: ConstructorData.error(it.error())
+            } else {
+                ConstructorData.error(it.error())
+            }
+        }.toObservable()
+    }
+}

library/src/main/java/io/constructor/data/model/recommendations/Pod.kt

@@ -0,0 +1,9 @@
+package io.constructor.data.model.recommendations
+
+import com.squareup.moshi.Json
+import java.io.Serializable
+
+data class Pod(
+        @Json(name = "id") val response: String?,
+        @Json(name = "display_name") val resultId: String?
+) : Serializable

library/src/main/java/io/constructor/data/model/recommendations/RecommendationsResponse.kt

@@ -0,0 +1,10 @@
+package io.constructor.data.model.recommendations
+
+import com.squareup.moshi.Json
+import java.io.Serializable
+
+data class RecommendationsResponse(
+        @Json(name = "response") val response: RecommendationsResponseInner?,
+        @Json(name = "result_id") val resultId: String?,
+        var rawData: String?
+) : Serializable

library/src/main/java/io/constructor/data/model/recommendations/RecommendationsResponseInner.kt

@@ -0,0 +1,11 @@
+package io.constructor.data.model.recommendations
+
+import com.squareup.moshi.Json
+import io.constructor.data.model.common.*;
+import java.io.Serializable
+
+data class RecommendationsResponseInner(
+        @Json(name = "pod") val pod: Pod?,
+        @Json(name = "results") val results: List<Result>?,
+        @Json(name = "total_num_results") val resultCount: Int
+) : Serializable

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

@@ -16,4 +16,5 @@ object ApiPaths {
     const val URL_BROWSE = "browse/{filter_name}/{filter_value}"
     const val URL_BROWSE_RESULT_CLICK_EVENT = "v2/behavioral_action/browse_result_click"
     const val URL_BROWSE_RESULT_LOAD_EVENT = "v2/behavioral_action/browse_result_load"
-}
+    const val URL_RECOMMENDATIONS = "recommendations/v1/pods/{podId}"
+}

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

@@ -74,4 +74,7 @@ interface ConstructorApi {
     fun trackBrowseResultsLoaded(@Body browseRequestBody: BrowseResultLoadRequestBody,
                                  @QueryMap params: Map<String, String>): Completable
 
-}
+    @GET(ApiPaths.URL_RECOMMENDATIONS)
+    fun getRecommendationResults(@Path("podId") value: String,
+                                 @QueryMap data: Map<String, String>): Single<Result<ResponseBody>>
+}

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

@@ -47,7 +47,10 @@ class ConstructorIoIntegrationTest {
     @Test
     fun getAutocompleteResultsAgainstRealResponse() {
         val observer = constructorIo.getAutocompleteResults("pork").test()
-        observer.assertComplete();
+        observer.assertComplete().assertValue {
+            it.get()?.sections!!.isNotEmpty()
+            it.get()?.resultId!!.isNotEmpty()
+        }
     }
 
     @Test
@@ -72,7 +75,14 @@ class ConstructorIoIntegrationTest {
     @Test
     fun getSearchResultsAgainstRealResponse() {
         val observer = constructorIo.getSearchResults("pork").test()
-        observer.assertComplete();
+        observer.assertComplete().assertValue {
+            it.get()?.resultId !== null
+            it.get()?.response?.results!!.isNotEmpty()
+            it.get()?.response?.facets!!.isNotEmpty()
+            it.get()?.response?.groups!!.isNotEmpty()
+            it.get()?.response?.filterSortOptions!!.isNotEmpty()
+            it.get()?.response?.resultCount!! > 0
+        }
     }
 
     @Test
@@ -84,8 +94,15 @@ class ConstructorIoIntegrationTest {
 
     @Test
     fun getBrowseResultsAgainstRealResponse() {
-        val observer = constructorIo.getBrowseResults("group_ids", "544").test()
-        observer.assertComplete();
+        val observer = constructorIo.getBrowseResults("group_id", "744").test()
+        observer.assertComplete().assertValue {
+            it.get()?.resultId !== null
+            it.get()?.response?.results!!.isNotEmpty()
+            it.get()?.response?.facets!!.isNotEmpty()
+            it.get()?.response?.groups!!.isNotEmpty()
+            it.get()?.response?.filterSortOptions!!.isNotEmpty()
+            it.get()?.response?.resultCount!! > 0
+        }
     }
 
     @Test
@@ -136,4 +153,15 @@ class ConstructorIoIntegrationTest {
         val observer = constructorIo.trackBrowseResultClickInternal("group_ids", "544", "prrst_shldr_bls", 5).test()
         observer.assertComplete();
     }
+
+    @Test
+    fun getRecommendationResultsAgainstRealResponse() {
+        val observer = constructorIo.getRecommendationResults("best_sellers").test()
+        observer.assertComplete().assertValue {
+            it.get()?.resultId !== null
+            it.get()?.response?.pod !== null
+            it.get()?.response?.results!!.isNotEmpty()
+            it.get()?.response?.resultCount!! > 0
+        }
+    }
 }

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

@@ -0,0 +1,115 @@
+package io.constructor.core
+
+import android.content.Context
+import io.constructor.data.local.PreferencesHelper
+import io.constructor.data.memory.ConfigMemoryHolder
+import io.constructor.test.createTestDataManager
+import io.constructor.util.RxSchedulersOverrideRule
+import io.constructor.util.TestDataLoader
+import io.mockk.every
+import io.mockk.mockk
+import okhttp3.mockwebserver.MockResponse
+import okhttp3.mockwebserver.MockWebServer
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+import java.util.concurrent.TimeUnit
+
+class ConstructorIoRecommendationsTest {
+
+    @Rule
+    @JvmField
+    val overrideSchedulersRule = RxSchedulersOverrideRule()
+
+    private lateinit var mockServer: MockWebServer
+    private var constructorIo = ConstructorIo
+    private val ctx = mockk<Context>()
+    private val preferencesHelper = mockk<PreferencesHelper>()
+    private val configMemoryHolder = mockk<ConfigMemoryHolder>()
+
+    @Before
+    fun setup() {
+        mockServer = MockWebServer()
+        mockServer.start()
+
+        every { ctx.applicationContext } returns ctx
+
+        every { preferencesHelper.apiKey } returns "golden-key"
+        every { preferencesHelper.id } returns "guido-the-guid"
+        every { preferencesHelper.serviceUrl } returns mockServer.hostName
+        every { preferencesHelper.port } returns mockServer.port
+        every { preferencesHelper.scheme } returns "http"
+        every { preferencesHelper.defaultItemSection } returns "Products"
+        every { preferencesHelper.getSessionId(any(), any()) } returns 79
+
+        every { configMemoryHolder.autocompleteResultCount } returns null
+        every { configMemoryHolder.userId } returns "player-one"
+        every { configMemoryHolder.testCellParams } returns emptyList()
+        every { configMemoryHolder.segments } returns emptyList()
+
+        val config = ConstructorIoConfig("dummyKey")
+        val dataManager = createTestDataManager(preferencesHelper, configMemoryHolder, ctx)
+
+        constructorIo.testInit(ctx, config, dataManager, preferencesHelper, configMemoryHolder)
+    }
+
+    @Test
+    fun getRecommendationResults() {
+        val mockResponse = MockResponse().setResponseCode(200).setBody(TestDataLoader.loadAsString("recommendation_response.json"))
+        mockServer.enqueue(mockResponse)
+        val observer = constructorIo.getRecommendationResults("titanic").test()
+        observer.assertComplete().assertValue {
+            it.get()!!.response?.results!!.size == 24
+            it.get()!!.response?.results!![0].value == "LaCroix Sparkling Water Pure Cans - 12-12 Fl. Oz."
+            it.get()!!.response?.results!![0].data.id == "960189161"
+            it.get()!!.response?.results!![0].data.imageUrl == "https://d17bbgoo3npfov.cloudfront.net/images/farmstand-960189161.png"
+            it.get()!!.response?.results!![0].data.metadata?.get("price") == 1.11
+            it.get()!!.response?.resultCount == 225
+        }
+        val request = mockServer.takeRequest()
+        println(request.path)
+        val path = "/recommendations/v1/pods/titanic?key=golden-key&i=guido-the-guid&ui=player-one&s=79&c=cioand-2.6.0&_dt="
+        assert(request.path.startsWith(path))
+    }
+
+    @Test
+    fun getRecommendationResultsWithServerError() {
+        val mockResponse = MockResponse().setResponseCode(500).setBody("Internal server error")
+        mockServer.enqueue(mockResponse)
+        val observer = constructorIo.getRecommendationResults("titanic").test()
+        observer.assertComplete().assertValue {
+            it.networkError
+        }
+        val request = mockServer.takeRequest()
+        val path = "/recommendations/v1/pods/titanic?key=golden-key&i=guido-the-guid&ui=player-one&s=79&c=cioand-2.6.0&_dt="
+        assert(request.path.startsWith(path))
+    }
+
+    @Test
+    fun getRecommendationResultsWithTimeout() {
+        val mockResponse = MockResponse().setResponseCode(200).setBody(TestDataLoader.loadAsString("recommendation_response.json"))
+        mockResponse.throttleBody(128, 5, TimeUnit.SECONDS)
+        mockServer.enqueue(mockResponse)
+        val observer = constructorIo.getRecommendationResults("titanic").test()
+        observer.assertComplete().assertValue {
+            it.isError
+        }
+        val request = mockServer.takeRequest()
+        val path = "/recommendations/v1/pods/titanic?key=golden-key&i=guido-the-guid&ui=player-one&s=79&c=cioand-2.6.0&_dt="
+        assert(request.path.startsWith(path))
+    }
+
+    @Test
+    fun getRecommendationResultsWithEmptyResponse() {
+        val mockResponse = MockResponse().setResponseCode(200).setBody(TestDataLoader.loadAsString("recommendation_response_empty.json"))
+        mockServer.enqueue(mockResponse)
+        val observer = constructorIo.getRecommendationResults("titanic").test()
+        observer.assertComplete().assertValue {
+            it.get()!!.response?.results!!.isEmpty()
+            it.get()!!.response?.resultCount == 0
+        }
+        val request = mockServer.takeRequest()
+        val path = "/recommendations/v1/pods/titanic?key=golden-key&i=guido-the-guid&ui=player-one&s=79&c=cioand-2.6.0&_dt="
+        assert(request.path.startsWith(path))
+    }
+}