[CSL-2581] Add refined content to browse (#178)

Author: stanlp1

AutocompleteClient/FW/API/Parser/Browse/BrowseResponseParser.swift

@@ -22,6 +22,7 @@ class BrowseResponseParser: AbstractBrowseResponseParser {
             let resultsObj: [JSONObject]? = response["results"] as? [JSONObject]
             let sortOptionsObj: [JSONObject]? = response["sort_options"] as? [JSONObject]
             let groupsObj = response["groups"] as? [JSONObject]
+            let refinedContentObj = response["refined_content"] as? [JSONObject]
 
             let facets: [CIOFilterFacet] = (facetsObj)?.compactMap { obj in return CIOFilterFacet(json: obj) } ?? []
             let results: [CIOResult] = (resultsObj)?.compactMap { obj in return CIOResult(json: obj) } ?? []
@@ -31,6 +32,7 @@ class BrowseResponseParser: AbstractBrowseResponseParser {
             let collection: CIOCollectionData? = CIOCollectionData(json: response["collection"] as? JSONObject)
             let resultID = json?["result_id"] as? String ?? ""
             let resultSources: CIOResultSources? = CIOResultSources(json: response["result_sources"] as? JSONObject)
+            let refinedContent: [CIORefinedContent] = refinedContentObj?.compactMap({ obj in return CIORefinedContent(json: obj) }) ?? []
 
             guard let request: JSONObject = json?["request"] as? JSONObject else {
                 throw CIOError(errorType: .invalidResponse)
@@ -44,6 +46,7 @@ class BrowseResponseParser: AbstractBrowseResponseParser {
                 totalNumResults: totalNumResults,
                 resultID: resultID,
                 collection: collection,
+                refinedContent: refinedContent,
                 resultSources: resultSources,
                 request: request
             )

AutocompleteClient/FW/Logic/Result/Responses/CIOBrowseResponse.swift

@@ -47,6 +47,11 @@ public struct CIOBrowseResponse {
      */
     public let collection: CIOCollectionData?
 
+    /**
+     A list of refined content
+     */
+    public let refinedContent: [CIORefinedContent]
+
     /**
      Sources of the result set
      */

AutocompleteClientTests/FW/API/Parser/BrowseResponseParserTest.swift

@@ -53,4 +53,24 @@ class BrowseResponseParserTests: XCTestCase {
             XCTFail("Parse should never throw an exception when a valid JSON string is passed.")
         }
     }
+    
+    func testBrowseParser_ParsingJSONString_ParsesRefinedContent() {
+        let data = TestResource.load(name: TestResource.Response.browseJSONFilename)
+        do {
+            let response = try self.parser.parse(browseResponseData: data)
+            let refinedContentData = response.refinedContent.first!.data
+
+            XCTAssertNotNil(refinedContentData["header"], "Valid header should be correctly parsed")
+            XCTAssertNotNil(refinedContentData["body"], "Valid body should be correctly parsed")
+            XCTAssertNotNil(refinedContentData["altText"], "Valid altText should be correctly parsed")
+            XCTAssertNotNil(refinedContentData["assetUrl"], "Valid assetUrl should be correctly parsed")
+            XCTAssertNotNil(refinedContentData["mobileAssetUrl"], "Valid mobileAssetUrl should be correctly parsed")
+            XCTAssertNotNil(refinedContentData["mobileAssetAltText"], "Valid mobileAssetAltText should be correctly parsed")
+            XCTAssertNotNil(refinedContentData["ctaLink"], "Valid ctaLink should be correctly parsed")
+            XCTAssertNotNil(refinedContentData["ctaText"], "Valid ctaText should be correctly parsed")
+
+        } catch {
+            XCTFail("Parse should never throw an exception when a valid JSON string is passed.")
+        }
+    }
 }

AutocompleteClientTests/FW/Logic/Worker/ConstructorIOIntegrationTests.swift

@@ -942,6 +942,62 @@ class ConstructorIOIntegrationTests: XCTestCase {
         self.wait(for: expectation)
     }
 
+    func testBrowse_ShouldReturnRefinedContent() {
+        let constructorClient = ConstructorIO(config: ConstructorIOConfig(apiKey: testACKey))
+        let expectation = XCTestExpectation(description: "Request 204")
+        let query = CIOBrowseQuery(filterName: groupFilterName, filterValue: groupFilterValue)
+        constructorClient.browse(forQuery: query, completionHandler: { response in
+            let cioError = response.error as? CIOError
+            let responseData = response.data!
+            let refinedContent = responseData.refinedContent[0]
+            let refinedContentData = refinedContent.data
+            let header = refinedContentData["header"] as? String
+            let body = refinedContentData["body"] as? String
+            let altText = refinedContentData["altText"] as? String
+            let assetUrl = refinedContentData["assetUrl"] as? String
+            let mobileAssetUrl = refinedContentData["mobileAssetUrl"] as? String
+            let mobileAssetAltText = refinedContentData["mobileAssetAltText"] as? String
+            let ctaLink = refinedContentData["ctaLink"] as? String
+            let ctaText = refinedContentData["ctaText"] as? String
+
+            XCTAssertNil(cioError)
+            XCTAssertNotNil(refinedContent)
+            XCTAssertEqual(header, "Content 1 Header")
+            XCTAssertEqual(body, "Content 1 Body")
+            XCTAssertEqual(altText, "Content 1 desktop alt text")
+            XCTAssertEqual(assetUrl, "https://constructor.io/wp-content/uploads/2022/09/groceryshop-2022-r2.png")
+            XCTAssertEqual(mobileAssetUrl, "https://constructor.io/wp-content/uploads/2022/09/groceryshop-2022-r2.png")
+            XCTAssertEqual(mobileAssetAltText, "Content 1 mobile alt text")
+            XCTAssertEqual(ctaLink, "https://constructor.io/wp-content/uploads/2022/09/groceryshop-2022-r2.png")
+            XCTAssertEqual(ctaText, "Content 1 CTA Button")
+            expectation.fulfill()
+        })
+        self.wait(for: expectation)
+    }
+
+    func testBrowse_ShouldReturnRefinedContentWithArtbitraryData() {
+        let constructorClient = ConstructorIO(config: ConstructorIOConfig(apiKey: testACKey))
+        let expectation = XCTestExpectation(description: "Request 204")
+        let query = CIOBrowseQuery(filterName: groupFilterName, filterValue: groupFilterValue)
+        constructorClient.browse(forQuery: query, completionHandler: { response in
+            let cioError = response.error as? CIOError
+            let responseData = response.data!
+            let refinedContent = responseData.refinedContent[2]
+            let refinedContentData = refinedContent.data
+            let tag1Value = refinedContentData["tag-1"] as? String
+            let tag2Value = refinedContentData["tag-2"] as? String
+            let arbitraryDataObject = refinedContentData["arbitraryDataObject"] as? [String: String] ?? [:]
+
+            XCTAssertNil(cioError)
+            XCTAssertNotNil(refinedContent)
+            XCTAssertEqual(tag1Value, "tag-1-value")
+            XCTAssertEqual(tag2Value, "tag-2-value")
+            XCTAssertEqual(arbitraryDataObject["pizza"], "pie")
+            expectation.fulfill()
+        })
+        self.wait(for: expectation)
+    }
+
     func testBrowseItems() {
         let expectation = XCTestExpectation(description: "Request 204")
         let query = CIOBrowseItemsQuery(ids: itemIds)

AutocompleteClientTests/Resources/response_browse_json.json

@@ -242,7 +242,29 @@
                 "status": "selected"
             }
         ],
-        "refined_content": [],
+        "refined_content": [{
+          "data": {
+            "body": "Content 1 Body",
+            "header": "Content 1 Header",
+            "altText": "Content 1 desktop alt text",
+            "ctaLink": "https://constructor.io/wp-content/uploads/2022/09/groceryshop-2022-r2.png",
+            "ctaText": "Content 1 CTA Button",
+            "assetUrl": "https://constructor.io/wp-content/uploads/2022/09/groceryshop-2022-r2.png",
+            "mobileAssetUrl": "https://constructor.io/wp-content/uploads/2022/09/groceryshop-2022-r2.png",
+            "mobileAssetAltText": "Content 1 mobile alt text"
+          }
+        }, {
+          "data": {
+            "body": "Content 2 Body",
+            "header": "Content 2 Header",
+            "altText": "Content 2 desktop alt text",
+            "ctaLink": "https://constructor.io/wp-content/uploads/2022/04/Dont-just-trust-the-AI-1.png",
+            "ctaText": "Content 2 Button",
+            "assetUrl": "https://constructor.io/wp-content/uploads/2022/04/Dont-just-trust-the-AI-1.png",
+            "mobileAssetUrl": "https://constructor.io/wp-content/uploads/2022/04/Dont-just-trust-the-AI-1.png",
+            "mobileAssetAltText": "Content 2 mobile alt text"
+          }
+        }],
         "total_num_results": 3,
         "features": [
             {