[CI-38165] Add preFilterExpressions, term support to recs (#143)

* add preFilterExpressions, term support to recs

* remove unused

* lint

Author: stanlp1

constructorio-client/src/main/java/io/constructor/client/ConstructorIO.java

@@ -1747,6 +1747,10 @@ public String recommendationsAsJSON(RecommendationsRequest req, UserInfo userInf
                 }
             }
 
+            if (StringUtils.isNotBlank(req.getTerm())) {
+                url = url.newBuilder().addQueryParameter("term", req.getTerm()).build();
+            }
+
             if (req.getFacets() != null) {
                 for (String facetName : req.getFacets().keySet()) {
                     for (String facetValue : req.getFacets().get(facetName)) {
@@ -1766,6 +1770,14 @@ public String recommendationsAsJSON(RecommendationsRequest req, UserInfo userInf
                                 .build();
             }
 
+            if (req.getPreFilterExpression() != null) {
+                url =
+                        url.newBuilder()
+                                .addQueryParameter(
+                                        "pre_filter_expression", req.getPreFilterExpression())
+                                .build();
+            }
+
             Request request = this.makeUserRequestBuilder(userInfo).url(url).get().build();
 
             Response response = clientWithRetry.newCall(request).execute();

constructorio-client/src/main/java/io/constructor/client/RecommendationsRequest.java

@@ -8,10 +8,12 @@
 public class RecommendationsRequest {
 
     private String podId;
+    private String term;
     private int numResults;
     private List<String> itemIds;
     private Map<String, List<String>> facets;
     private String section;
+    private String preFilterExpression;
     private VariationsMap variationsMap;
 
     /**
@@ -27,8 +29,10 @@ public RecommendationsRequest(String podId) throws IllegalArgumentException {
         this.podId = podId;
         this.numResults = 10;
         this.itemIds = null;
+        this.term = null;
         this.section = "Products";
         this.variationsMap = null;
+        this.preFilterExpression = null;
         this.facets = new HashMap<String, List<String>>();
     }
 
@@ -46,6 +50,20 @@ public String getPodId() {
         return podId;
     }
 
+    /**
+     * @param term the term to set (required for query recommendations pods)
+     */
+    public void setTerm(String term) {
+        this.term = term;
+    }
+
+    /**
+     * @return the term
+     */
+    public String getTerm() {
+        return term;
+    }
+
     /**
      * @param numResults the num results to set
      */
@@ -115,4 +133,20 @@ public void setFacets(Map<String, List<String>> facets) {
     public Map<String, List<String>> getFacets() {
         return facets;
     }
+
+    /**
+     * @param preFilterExpression the faceting expression to scope recommendation results
+     *     (JSON-encoded query string). Please refer to
+     *     https://docs.constructor.io/rest_api/collections#add-items-dynamically
+     */
+    public void setPreFilterExpression(String preFilterExpression) {
+        this.preFilterExpression = preFilterExpression;
+    }
+
+    /**
+     * @return the prefilter expression
+     */
+    public String getPreFilterExpression() {
+        return preFilterExpression;
+    }
 }

constructorio-client/src/test/java/io/constructor/client/ConstructorIORecommendationsTest.java

@@ -109,4 +109,34 @@ public void getRecommendationsShouldReturnAResultWithFilters() throws Exception
         assertTrue("recommendation results exist", response.getResponse().getResults().size() > 0);
         assertTrue("recommendation result id exists", response.getResultId() != null);
     }
+
+    @Test
+    public void getRecommendationsShouldReturnAResultWithPreFilterExpression() throws Exception {
+        ConstructorIO constructor = new ConstructorIO("", apiKey, true, null);
+        UserInfo userInfo = new UserInfo(3, "c62a-2a09-faie");
+        RecommendationsRequest request = new RecommendationsRequest("filtered_items");
+        String preFilterExpression =
+                "{\"or\":[{\"and\":[{\"name\":\"group_id\",\"value\":\"electronics-group-id\"},{\"name\":\"Price\",\"range\":[\"-inf\",200.0]}]},{\"and\":[{\"name\":\"Type\",\"value\":\"Laptop\"},{\"not\":{\"name\":\"Price\",\"range\":[800.0,\"inf\"]}}]}]}";
+        request.setPreFilterExpression(preFilterExpression);
+
+        RecommendationsResponse response = constructor.recommendations(request, userInfo);
+        String preFilterExpressionFromRequestJsonString =
+                new Gson().toJson(response.getRequest().get("pre_filter_expression"));
+
+        assertEquals(preFilterExpression, preFilterExpressionFromRequestJsonString);
+        assertTrue("recommendation result id exists", response.getResultId() != null);
+    }
+
+    @Test
+    public void getRecommendationsShouldReturnAResultTerm() throws Exception {
+        ConstructorIO constructor = new ConstructorIO("", apiKey, true, null);
+        UserInfo userInfo = new UserInfo(3, "c62a-2a09-faie");
+        RecommendationsRequest request = new RecommendationsRequest("query_recommendations");
+        request.setTerm("test");
+
+        RecommendationsResponse response = constructor.recommendations(request, userInfo);
+
+        assertEquals(response.getRequest().get("term"), "test");
+        assertTrue("recommendation result id exists", response.getResultId() != null);
+    }
 }

constructorio-client/src/test/java/io/constructor/client/RecommendationsRequestTest.java

@@ -1,6 +1,7 @@
 package io.constructor.client;
 
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
 
 import java.util.Arrays;
 import java.util.HashMap;
@@ -33,14 +34,16 @@ public void newShouldReturnDefaultProperties() throws Exception {
         RecommendationsRequest request = new RecommendationsRequest(podId);
         assertEquals(request.getPodId(), podId);
         assertEquals(request.getNumResults(), 10);
-        assertEquals(request.getItemIds(), null);
+        assertNull(request.getItemIds());
+        assertNull(request.getTerm());
         assertEquals(request.getSection(), "Products");
         assertEquals(request.getFacets().size(), 0);
     }
 
     @Test
     public void settersShouldSet() throws Exception {
         String podId = "home_page_1";
+        String term = "test_term";
         RecommendationsRequest request = new RecommendationsRequest(podId);
         Map<String, List<String>> facets = new HashMap<String, List<String>>();
         facets.put("Flavors", Arrays.asList("Honey Roasted", "Dry Roasted", "Unsalted"));
@@ -50,10 +53,12 @@ public void settersShouldSet() throws Exception {
         request.setItemIds(Arrays.asList("1", "2", "3"));
         request.setSection("Search Suggestions");
         request.setFacets(facets);
+        request.setTerm(term);
 
         assertEquals(request.getPodId(), "zero_results_1");
         assertEquals(request.getNumResults(), 3);
         assertEquals(request.getSection(), "Search Suggestions");
         assertEquals(request.getFacets(), facets);
+        assertEquals(request.getTerm(), term);
     }
 }