Browse and Browse Items support for filter_match_type (#146)

* Browse and Browse Items support for filter_match_type

* Update docs

* Update facet

* Address comments

* typo

Author: mocca102

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

@@ -19,6 +19,7 @@ public class BrowseItemsRequest {
     private Map<String, String> formatOptions;
     private List<String> hiddenFields;
     private List<String> hiddenFacets;
+    private Map<String, String> filterMatchTypes;
 
     /**
      * Creates a browse request
@@ -39,6 +40,7 @@ public BrowseItemsRequest(List<String> ids) throws IllegalArgumentException {
         this.formatOptions = new HashMap<String, String>();
         this.hiddenFields = new ArrayList<String>();
         this.hiddenFacets = new ArrayList<String>();
+        this.filterMatchTypes = new HashMap<String, String>();
     }
 
     /**
@@ -194,4 +196,20 @@ public void setHiddenFacets(List<String> hiddenFacets) {
     public List<String> getHiddenFacets() {
         return hiddenFacets;
     }
+
+    /**
+     * @param filterMatchTypes the filterMatchTypes to set. Please refer to
+     *     https://docs-beta.constructor.io/reference/v1-browse-get-browse-items-results for details
+     *     Possible values 'all', 'any' or 'none'
+     */
+    public void setFilterMatchTypes(Map<String, String> filterMatchTypes) {
+        this.filterMatchTypes = filterMatchTypes;
+    }
+
+    /**
+     * @return the filterMatchTypes
+     */
+    public Map<String, String> getFilterMatchTypes() {
+        return filterMatchTypes;
+    }
 }

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

@@ -25,6 +25,7 @@ public class BrowseRequest {
     private String qsParam;
     private String now;
     private int offset;
+    private Map<String, String> filterMatchTypes;
 
     /**
      * Creates a browse request
@@ -55,6 +56,7 @@ public BrowseRequest(String filterName, String filterValue) throws IllegalArgume
         this.qsParam = null;
         this.now = null;
         this.offset = 0;
+        this.filterMatchTypes = new HashMap<String, String>();
     }
 
     /**
@@ -301,4 +303,20 @@ public void setOffset(int offset) {
     public int getOffset() {
         return offset;
     }
+
+    /**
+     * @param filterMatchTypes the filterMatchTypes to set. Please refer to
+     *     https://docs-beta.constructor.io/reference/v1-browse-get-browse-results for details
+     *     Possible values 'all', 'any' or 'none'
+     */
+    public void setFilterMatchTypes(Map<String, String> filterMatchTypes) {
+        this.filterMatchTypes = filterMatchTypes;
+    }
+
+    /**
+     * @return the filterMatchTypes
+     */
+    public Map<String, String> getFilterMatchTypes() {
+        return filterMatchTypes;
+    }
 }

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

@@ -1219,6 +1219,16 @@ protected Request createBrowseRequest(BrowseRequest req, UserInfo userInfo)
                                 .build();
             }
 
+            for (String filterMatchTypesKey : req.getFilterMatchTypes().keySet()) {
+                String filterMatchTypesValue = req.getFilterMatchTypes().get(filterMatchTypesKey);
+                url =
+                        url.newBuilder()
+                                .addQueryParameter(
+                                        "filter_match_types[" + filterMatchTypesKey + "]",
+                                        filterMatchTypesValue)
+                                .build();
+            }
+
             Request request =
                     this.makeUserRequestBuilder(userInfo, authorizedRequest).url(url).get().build();
 
@@ -1389,6 +1399,16 @@ protected Request createBrowseItemsRequest(BrowseItemsRequest req, UserInfo user
                                 .build();
             }
 
+            for (String filterMatchTypesKey : req.getFilterMatchTypes().keySet()) {
+                String filterMatchTypesValue = req.getFilterMatchTypes().get(filterMatchTypesKey);
+                url =
+                        url.newBuilder()
+                                .addQueryParameter(
+                                        "filter_match_types[" + filterMatchTypesKey + "]",
+                                        filterMatchTypesValue)
+                                .build();
+            }
+
             Request request = this.makeUserRequestBuilder(userInfo).url(url).get().build();
 
             return request;

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

@@ -49,6 +49,8 @@ public void settersShouldSet() throws Exception {
         formatOptions.put("groups_start", "top");
         List<String> hiddenFields = Arrays.asList("hiddenField1", "hiddenField2");
         List<String> hiddenFacets = Arrays.asList("hiddenFacet1", "hiddenFacet2");
+        Map<String, String> filterMatchTypes = new HashMap<String, String>();
+        filterMatchTypes.put("Color", "all");
 
         request.setIds(newIds);
         request.setSection("Browse Suggestions");
@@ -61,6 +63,7 @@ public void settersShouldSet() throws Exception {
         request.setFormatOptions(formatOptions);
         request.setHiddenFields(hiddenFields);
         request.setHiddenFacets(hiddenFacets);
+        request.setFilterMatchTypes(filterMatchTypes);
 
         assertEquals(request.getIds(), newIds);
         assertEquals(request.getSection(), "Browse Suggestions");
@@ -73,5 +76,6 @@ public void settersShouldSet() throws Exception {
         assertEquals(request.getFormatOptions(), formatOptions);
         assertEquals(request.getHiddenFields(), hiddenFields);
         assertEquals(request.getHiddenFacets(), hiddenFacets);
+        assertEquals(request.getFilterMatchTypes(), filterMatchTypes);
     }
 }

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

@@ -68,6 +68,8 @@ public void settersShouldSet() throws Exception {
                 "{\"num_results_per_page\":\"10\",\"filters\":{\"keywords\":[\"battery-powered\"]}}";
         String now = "1659049486";
         int offset = 2;
+        Map<String, String> filterMatchTypes = new HashMap<String, String>();
+        filterMatchTypes.put("Color", "all");
 
         request.setFilterName("VacationType");
         request.setFilterValue("Air Travel");
@@ -85,6 +87,7 @@ public void settersShouldSet() throws Exception {
         request.setQsParam(qsParam);
         request.setNow(now);
         request.setOffset(offset);
+        request.setFilterMatchTypes(filterMatchTypes);
 
         assertEquals(request.getFilterName(), "VacationType");
         assertEquals(request.getFilterValue(), "Air Travel");
@@ -102,5 +105,6 @@ public void settersShouldSet() throws Exception {
         assertEquals(request.getQsParam(), qsParam);
         assertEquals(request.getNow(), now);
         assertEquals(request.getOffset(), offset);
+        assertEquals(request.getFilterMatchTypes(), filterMatchTypes);
     }
 }

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

@@ -303,4 +303,22 @@ public boolean test(FilterFacet f) {
         assertNotNull("browse facet [Brand] exists", brandFacet);
         assertTrue("browse facet [Brand] is hidden", brandFacet.getHidden());
     }
+
+    @Test
+    public void BrowseItemsShouldReturnAResultWithFilterMatchTypes() throws Exception {
+        ConstructorIO constructor = new ConstructorIO("", apiKey, true, null);
+        UserInfo userInfo = new UserInfo(3, "c62a-2a09-faie");
+        List<String> ids = Arrays.asList("10001", "10002");
+        BrowseItemsRequest request = new BrowseItemsRequest(ids);
+        request.getFacets().put("Brand", Arrays.asList("XYZ"));
+        request.getFilterMatchTypes().put("Brand", "all");
+        BrowseResponse response = constructor.browseItems(request, userInfo);
+
+        assertTrue("browse result id exists", response.getResultId() != null);
+        assertTrue("request exists", response.getRequest() != null);
+        assertTrue(
+                "filter match types exists",
+                response.getRequest().get("filter_match_types") != null);
+        assertTrue("browse results exist", response.getResponse().getResults().size() >= 0);
+    }
 }

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

@@ -624,4 +624,21 @@ public void BrowseShouldReturnItemLevelGroupsObject() throws Exception {
                 "All");
         assertEquals("first pathListItem id matches", groupPathList.get(0).getId(), "All");
     }
+
+    @Test
+    public void BrowseShouldReturnAResultWithFilterMatchTypes() throws Exception {
+        ConstructorIO constructor = new ConstructorIO("", apiKey, true, null);
+        UserInfo userInfo = new UserInfo(3, "c62a-2a09-faie");
+        BrowseRequest request = new BrowseRequest("Color", "yellow");
+        request.getFacets().put("Brand", Arrays.asList("XYZ"));
+        request.getFilterMatchTypes().put("Brand", "all");
+        BrowseResponse response = constructor.browse(request, userInfo);
+
+        assertTrue("browse result id exists", response.getResultId() != null);
+        assertTrue("request exists", response.getRequest() != null);
+        assertTrue(
+                "filter match types exists",
+                response.getRequest().get("filter_match_types") != null);
+        assertTrue("browse results exist", response.getResponse().getResults().size() >= 0);
+    }
 }