chore(recommend): requests as list of queries (#648)

Author: aallam

src/main/scala/algolia/definitions/GetRecommendationDefinition.scala

@@ -31,7 +31,7 @@ import org.json4s.Formats
 import org.json4s.native.Serialization._
 
 case class GetRecommendationDefinition(
-    query: RecommendationsOptions,
+    queries: List[RecommendationsOptions],
     requestOptions: Option[RequestOptions] = None
 )(implicit val formats: Formats)
     extends Definition {
@@ -44,10 +44,11 @@ case class GetRecommendationDefinition(
     copy(requestOptions = Some(requestOptions))
 
   override private[algolia] def build(): HttpPayload = {
+    val requests = Map("requests" -> queries)
     HttpPayload(
       POST,
       Seq("1", "indexes", "*", "recommendations"),
-      body = Some(write(query)),
+      body = Some(write(requests)),
       isSearch = true,
       requestOptions = requestOptions
     )

src/main/scala/algolia/dsl/GetDsl.scala

@@ -95,15 +95,15 @@ trait GetDsl {
       GetSettingsDictionaryDefinition()
 
     def recommendations(
-        query: RecommendationsQuery
+        query: List[RecommendationsQuery]
     ): GetRecommendationDefinition = GetRecommendationDefinition(query)
 
     def relatedProducts(
-        query: RelatedProductsQuery
+        query: List[RelatedProductsQuery]
     ): GetRecommendationDefinition = GetRecommendationDefinition(query)
 
     def frequentlyBoughtTogether(
-        query: FrequentlyBoughtTogetherQuery
+        query: List[FrequentlyBoughtTogetherQuery]
     ): GetRecommendationDefinition = GetRecommendationDefinition(query)
   }
 
@@ -201,4 +201,19 @@ trait GetDsl {
       client.request[PersonalizationProfileResponse](query.build())
     }
   }
+
+  implicit object GetRecommendationDefinitionExecutable
+      extends Executable[
+        GetRecommendationDefinition,
+        SearchResult
+      ] {
+    override def apply(
+        client: AlgoliaClient,
+        query: GetRecommendationDefinition
+    )(
+        implicit executor: ExecutionContext
+    ): Future[SearchResult] = {
+      client.request[SearchResult](query.build())
+    }
+  }
 }

src/test/scala/algolia/dsl/RecommendTest.scala

@@ -40,18 +40,27 @@ class RecommendTest extends AlgoliaTest {
   describe("test recommend payload") {
 
     it("should produce valid recommendation query payload") {
-      (get recommendations RecommendationsQuery(
+      val queryRelatedProducts = RecommendationsQuery(
+        indexName = "products",
+        model = "related-products",
+        objectID = "B018APC4LE",
+        maxRecommendations = Some(10),
+        queryParameters = Some(Query(attributesToRetrieve = Some(Seq("*"))))
+      )
+      val queryBoughtTogether = RecommendationsQuery(
         indexName = "products",
         model = "bought-together",
         objectID = "B018APC4LE",
         maxRecommendations = Some(10),
         queryParameters = Some(Query(attributesToRetrieve = Some(Seq("*"))))
-      )).build() should be(
+      )
+      (get recommendations List(queryRelatedProducts, queryBoughtTogether))
+        .build() should be(
         HttpPayload(
           POST,
           Seq("1", "indexes", "*", "recommendations"),
           body = Some(
-            "{\"indexName\":\"products\",\"model\":\"bought-together\",\"objectID\":\"B018APC4LE\",\"threshold\":0,\"maxRecommendations\":10,\"queryParameters\":{\"attributesToRetrieve\":[\"*\"]}}"
+            "{\"requests\":[{\"indexName\":\"products\",\"model\":\"related-products\",\"objectID\":\"B018APC4LE\",\"threshold\":0,\"maxRecommendations\":10,\"queryParameters\":{\"attributesToRetrieve\":[\"*\"]}},{\"indexName\":\"products\",\"model\":\"bought-together\",\"objectID\":\"B018APC4LE\",\"threshold\":0,\"maxRecommendations\":10,\"queryParameters\":{\"attributesToRetrieve\":[\"*\"]}}]}"
           ),
           isSearch = true,
           requestOptions = None
@@ -60,18 +69,20 @@ class RecommendTest extends AlgoliaTest {
     }
 
     it("should produce valid related products query payload") {
-      (get relatedProducts RelatedProductsQuery(
-        indexName = "products",
-        objectID = "B018APC4LE",
-        threshold = 10,
-        maxRecommendations = Some(10),
-        queryParameters = Some(Query(attributesToRetrieve = Some(Seq("*"))))
+      (get relatedProducts List(
+        RelatedProductsQuery(
+          indexName = "products",
+          objectID = "B018APC4LE",
+          threshold = 10,
+          maxRecommendations = Some(10),
+          queryParameters = Some(Query(attributesToRetrieve = Some(Seq("*"))))
+        )
       )).build() should be(
         HttpPayload(
           POST,
           Seq("1", "indexes", "*", "recommendations"),
           body = Some(
-            "{\"indexName\":\"products\",\"objectID\":\"B018APC4LE\",\"threshold\":10,\"maxRecommendations\":10,\"queryParameters\":{\"attributesToRetrieve\":[\"*\"]},\"model\":\"related-products\"}"
+            "{\"requests\":[{\"indexName\":\"products\",\"objectID\":\"B018APC4LE\",\"threshold\":10,\"maxRecommendations\":10,\"queryParameters\":{\"attributesToRetrieve\":[\"*\"]},\"model\":\"related-products\"}]}"
           ),
           isSearch = true,
           requestOptions = None
@@ -80,18 +91,20 @@ class RecommendTest extends AlgoliaTest {
     }
 
     it("should produce valid frequently bought together query payload") {
-      (get frequentlyBoughtTogether FrequentlyBoughtTogetherQuery(
-        indexName = "products",
-        objectID = "B018APC4LE",
-        threshold = 10,
-        maxRecommendations = Some(10),
-        queryParameters = Some(Query(attributesToRetrieve = Some(Seq("*"))))
+      (get frequentlyBoughtTogether List(
+        FrequentlyBoughtTogetherQuery(
+          indexName = "products",
+          objectID = "B018APC4LE",
+          threshold = 10,
+          maxRecommendations = Some(10),
+          queryParameters = Some(Query(attributesToRetrieve = Some(Seq("*"))))
+        )
       )).build() should be(
         HttpPayload(
           POST,
           Seq("1", "indexes", "*", "recommendations"),
           body = Some(
-            "{\"indexName\":\"products\",\"objectID\":\"B018APC4LE\",\"threshold\":10,\"maxRecommendations\":10,\"queryParameters\":{\"attributesToRetrieve\":[\"*\"]},\"model\":\"bought-together\"}"
+            "{\"requests\":[{\"indexName\":\"products\",\"objectID\":\"B018APC4LE\",\"threshold\":10,\"maxRecommendations\":10,\"queryParameters\":{\"attributesToRetrieve\":[\"*\"]},\"model\":\"bought-together\"}]}"
           ),
           isSearch = true,
           requestOptions = None