[CDX-255] Expose features object in request models (#168)

* Add Feature and Variant models, expose features for Search and Browse

* Remove print

* Remove print

* Lint

* Add tests for null variants

---------

Co-authored-by: Tarek Ahmed <tarek.ahmed@tarek.ahmed-F5P62C970K>

Author: TarekAlQaddy

constructorio-client/src/main/java/io/constructor/client/models/BrowseResponseInner.java

@@ -12,6 +12,9 @@ public class BrowseResponseInner extends BaseResultsResponse {
     @SerializedName("refined_content")
     private List<RefinedContent> refinedContent;
 
+    @SerializedName("features")
+    private List<Feature> features;
+
     /**
      * @return the item collection data
      */
@@ -26,11 +29,22 @@ public List<RefinedContent> getRefinedContent() {
         return refinedContent;
     }
 
+    /**
+     * @return features list
+     */
+    public List<Feature> getFeatures() {
+        return features;
+    }
+
     public void setCollection(ItemCollection collection) {
         this.collection = collection;
     }
 
     public void setRefinedContent(List<RefinedContent> refinedContent) {
         this.refinedContent = refinedContent;
     }
+
+    public void setFeatures(List<Feature> features) {
+        this.features = features;
+    }
 }

constructorio-client/src/main/java/io/constructor/client/models/Feature.java

@@ -0,0 +1,62 @@
+package io.constructor.client.models;
+
+import com.google.gson.annotations.SerializedName;
+
+public class Feature {
+
+    @SerializedName("display_name")
+    private String displayName;
+
+    @SerializedName("feature_name")
+    private String featureName;
+
+    @SerializedName("enabled")
+    private Boolean enabled;
+
+    @SerializedName("variant")
+    private Variant variant;
+
+    /**
+     * @return the display name
+     */
+    public String getDisplayName() {
+        return displayName;
+    }
+
+    /**
+     * @return the feature name
+     */
+    public String getFeatureName() {
+        return featureName;
+    }
+
+    /**
+     * @return enabled
+     */
+    public Boolean getEnabled() {
+        return enabled;
+    }
+
+    /**
+     * @return the variant
+     */
+    public Variant getVariant() {
+        return variant;
+    }
+
+    public void setDisplayName(String displayName) {
+        this.displayName = displayName;
+    }
+
+    public void setFeatureName(String featureName) {
+        this.featureName = featureName;
+    }
+
+    public void setEnabled(Boolean enabled) {
+        this.enabled = enabled;
+    }
+
+    public void setVariant(Variant variant) {
+        this.variant = variant;
+    }
+}

constructorio-client/src/main/java/io/constructor/client/models/SearchResponseInner.java

@@ -12,6 +12,9 @@ public class SearchResponseInner extends BaseResultsResponse {
     @SerializedName("refined_content")
     private List<RefinedContent> refinedContent;
 
+    @SerializedName("features")
+    private List<Feature> features;
+
     /**
      * @return redirect data
      */
@@ -26,11 +29,22 @@ public List<RefinedContent> getRefinedContent() {
         return refinedContent;
     }
 
+    /**
+     * @return features list
+     */
+    public List<Feature> getFeatures() {
+        return features;
+    }
+
     public void setRedirect(Redirect redirect) {
         this.redirect = redirect;
     }
 
     public void setRefinedContent(List<RefinedContent> refinedContent) {
         this.refinedContent = refinedContent;
     }
+
+    public void setFeatures(List<Feature> features) {
+        this.features = features;
+    }
 }

constructorio-client/src/main/java/io/constructor/client/models/Variant.java

@@ -0,0 +1,34 @@
+package io.constructor.client.models;
+
+import com.google.gson.annotations.SerializedName;
+
+public class Variant {
+
+    @SerializedName("name")
+    private String name;
+
+    @SerializedName("display_name")
+    private String displayName;
+
+    /**
+     * @return the name
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * @return the display name
+     */
+    public String getDisplayName() {
+        return displayName;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public void setDisplayName(String displayName) {
+        this.displayName = displayName;
+    }
+}

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

@@ -300,4 +300,36 @@ public void createBrowseResponseShouldReturnAResultWithIsSlotted() throws Except
                 response.getResponse().getResults().get(1).getIsSlotted(),
                 false);
     }
+
+    @Test
+    public void createBrowseResponseShouldReturnAResultWithFeatures() throws Exception {
+        String string = Utils.getTestResource("response.browse.color.blue.json");
+        BrowseResponse response = ConstructorIO.createBrowseResponse(string);
+        assertEquals(
+                "browse result [features] exists", response.getResponse().getFeatures().size(), 5);
+        assertEquals(
+                "browse result feature [feature name] exists",
+                response.getResponse().getFeatures().get(0).getFeatureName(),
+                "auto_generated_refined_query_rules");
+        assertEquals(
+                "browse result feature [display name] exists",
+                response.getResponse().getFeatures().get(0).getDisplayName(),
+                "Affinity Engine");
+        assertEquals(
+                "browse result feature [enabled] exists",
+                response.getResponse().getFeatures().get(0).getEnabled(),
+                true);
+        assertEquals(
+                "browse result feature variant [display name] exists",
+                response.getResponse().getFeatures().get(0).getVariant().getDisplayName(),
+                "Default weights");
+        assertEquals(
+                "browse result feature variant [name] exists",
+                response.getResponse().getFeatures().get(0).getVariant().getName(),
+                "default_rules");
+        assertEquals(
+                "browse result feature variant returns null if empty",
+                response.getResponse().getFeatures().get(1).getVariant(),
+                null);
+    }
 }

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

@@ -276,4 +276,36 @@ public void createSearchResponseShouldReturnAResultWithIsSlotted() throws Except
                 response.getResponse().getResults().get(1).getIsSlotted(),
                 false);
     }
+
+    @Test
+    public void createSearchResponseShouldReturnAResultWithFeatures() throws Exception {
+        String string = Utils.getTestResource("response.search.item.json");
+        SearchResponse response = ConstructorIO.createSearchResponse(string);
+        assertEquals(
+                "search result [features] exists", response.getResponse().getFeatures().size(), 5);
+        assertEquals(
+                "search result feature [feature name] exists",
+                response.getResponse().getFeatures().get(0).getFeatureName(),
+                "auto_generated_refined_query_rules");
+        assertEquals(
+                "search result feature [display name] exists",
+                response.getResponse().getFeatures().get(0).getDisplayName(),
+                "Affinity Engine");
+        assertEquals(
+                "search result feature [enabled] exists",
+                response.getResponse().getFeatures().get(0).getEnabled(),
+                true);
+        assertEquals(
+                "search result feature variant [name] exists",
+                response.getResponse().getFeatures().get(0).getVariant().getName(),
+                "default_rules");
+        assertEquals(
+                "search result feature variant [display name] exists",
+                response.getResponse().getFeatures().get(0).getVariant().getDisplayName(),
+                "Default weights");
+        assertEquals(
+                "search result feature variant returns null if empty",
+                response.getResponse().getFeatures().get(2).getVariant(),
+                null);
+    }
 }