Bodega Sample App : Part 1 (#90)

rubikzube · web-flow · commit 5c7de5f62ee8 · 2019-10-14T14:49:14.000-04:00
* Updated access levels
* Added sort options
* Test updates
* Added sorting in Search
diff --git a/AutocompleteClient/Constants/Constants.swift b/AutocompleteClient/Constants/Constants.swift
@@ -80,6 +80,8 @@ struct Constants {
         static let groupFilter = "filters[group_id]"
         static let facetFilterKey = { (key: String) -> String in "filters[\(key)]" }
         static let section = "section"
+        static let sortBy = "sort_by"
+        static let sortOrder = "sort_order"
         static let defaultSectionName = "Products"
     }
 
diff --git a/AutocompleteClient/FW/Logic/Query/SearchFilters.swift b/AutocompleteClient/FW/Logic/Query/SearchFilters.swift
@@ -13,4 +13,9 @@ public typealias Filter = (key: String, value: String)
 public struct SearchFilters {
     public let groupFilter: String?
     public let facetFilters: [Filter]?
+
+    public init(groupFilter: String?, facetFilters: [Filter]?){
+        self.groupFilter = groupFilter
+        self.facetFilters = facetFilters
+    }
 }
diff --git a/AutocompleteClient/FW/Logic/Request/Builder/RequestBuilder+QueryItems.swift b/AutocompleteClient/FW/Logic/Request/Builder/RequestBuilder+QueryItems.swift
@@ -106,6 +106,12 @@ extension RequestBuilder {
         queryItems.add(URLQueryItem(name: Constants.SearchQuery.facetFilterKey(filter.key), value: filter.value))
     }
 
+    func set(sortOption: SortOption?) {
+        guard let option = sortOption else { return }
+        queryItems.add(URLQueryItem(name: Constants.SearchQuery.sortBy, value: option.sortBy))
+        queryItems.add(URLQueryItem(name: Constants.SearchQuery.sortOrder, value: option.sortOrder.rawValue))
+    }
+
     func set(_ value: String, forKey key: String) {
         queryItems.add(URLQueryItem(name: key, value: value))
     }
diff --git a/AutocompleteClient/FW/Logic/Request/CIOAutocompleteQuery.swift b/AutocompleteClient/FW/Logic/Request/CIOAutocompleteQuery.swift
@@ -36,27 +36,30 @@ public struct CIOAutocompleteQuery: CIORequestData {
 // TODO: Move to a separate file
 public struct CIOSearchQuery: CIORequestData {
 
-    let query: String
-    let filters: SearchFilters?
-    let page: Int
-    let section: String
+    public let query: String
+    public let page: Int
+    public let section: String
+    public let filters: SearchFilters?
+    public let sortOption: SortOption?
 
     func url(with baseURL: String) -> String {
         return String(format: Constants.Query.queryStringFormat, baseURL,
                       Constants.SearchQuery.pathString, query)
     }
 
-    public init(query: String, filters: SearchFilters? = nil, page: Int = 1, section: String? = nil) {
+    public init(query: String, filters: SearchFilters? = nil, sortOption: SortOption? = nil, page: Int = 1, section: String? = nil) {
         self.query = query.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed)!
         self.filters = filters
         self.page = page
         self.section = section != nil ? section! : Constants.SearchQuery.defaultSectionName
+        self.sortOption = sortOption
     }
 
     func decorateRequest(requestBuilder: RequestBuilder) {
         requestBuilder.set(page: self.page)
         requestBuilder.set(groupFilter: self.filters?.groupFilter)
         requestBuilder.set(facetFilters: self.filters?.facetFilters)
         requestBuilder.set(searchSection: self.section)
+        requestBuilder.set(sortOption: self.sortOption)
     }
 }
diff --git a/AutocompleteClient/FW/Logic/Result/Search/CIOSearchResponse.swift b/AutocompleteClient/FW/Logic/Result/Search/CIOSearchResponse.swift
@@ -12,17 +12,15 @@ import Foundation
  Struct representing the search data response from the server.
  */
 public struct CIOSearchResponse {
-    let facets: [Facet]
-    let results: [SearchResult]
-    let groups: [CIOGroup]
-    let redirectInfo: SearchRedirectInfo?
-    let sortOptions: [SortOption]
-    let resultCount: Int
-    let resultID: String
+    public let facets: [Facet]
+    public let results: [SearchResult]
+    public let groups: [CIOGroup]
+    public let redirectInfo: SearchRedirectInfo?
+    public let sortOptions: [SortOption]
+    public let resultCount: Int
+    public let resultID: String
 
-    var isRedirect: Bool {
-        get {
-            return self.redirectInfo != nil
-        }
+    public var isRedirect: Bool {
+        return self.redirectInfo != nil
     }
 }
diff --git a/AutocompleteClient/FW/Logic/Result/Search/Facet.swift b/AutocompleteClient/FW/Logic/Result/Search/Facet.swift
@@ -8,14 +8,14 @@
 
 import Foundation
 
-struct Facet {
-    let name: String
-    let displayName: String
-    let options: [FacetOption]
-    let type: String
+public struct Facet {
+    public let name: String
+    public let displayName: String
+    public let options: [FacetOption]
+    public let type: String
 }
 
-extension Facet {
+public extension Facet {
     init?(json: JSONObject) {
         guard let name = json["name"] as? String else {
             return nil
diff --git a/AutocompleteClient/FW/Logic/Result/Search/FacetOption.swift b/AutocompleteClient/FW/Logic/Result/Search/FacetOption.swift
@@ -8,15 +8,15 @@
 
 import Foundation
 
-struct FacetOption {
-    let count: Int
-    let displayName: String
-    let status: String
-    let value: String
-    let data: [String: Any]
+public struct FacetOption {
+    public let count: Int
+    public let displayName: String
+    public let status: String
+    public let value: String
+    public let data: [String: Any]
 }
 
-extension FacetOption {
+public extension FacetOption {
     init?(json: JSONObject) {
         guard let count = json["count"] as? Int else { return nil }
         guard let value = json["value"] as? String else { return nil }
diff --git a/AutocompleteClient/FW/Logic/Result/Search/SearchRedirectInfo.swift b/AutocompleteClient/FW/Logic/Result/Search/SearchRedirectInfo.swift
@@ -8,13 +8,13 @@
 
 import Foundation
 
-struct SearchRedirectInfo {
-    let url: String
-    let matchID: Int
-    let ruleID: Int
+public struct SearchRedirectInfo {
+    public let url: String
+    public let matchID: Int
+    public let ruleID: Int
 }
 
-extension SearchRedirectInfo {
+public extension SearchRedirectInfo {
     init?(object: JSONObject?) {
         guard let json = object else { return nil }
         guard let data = json["data"] as? JSONObject else { return nil }
diff --git a/AutocompleteClient/FW/Logic/Result/Search/SearchResult.swift b/AutocompleteClient/FW/Logic/Result/Search/SearchResult.swift
@@ -8,9 +8,9 @@
 
 import Foundation
 
-struct SearchResult {
-    let value: String
-    let data: SearchResultData
-    let matchedTerms: [String]
-    let variations: [SearchVariation]
+public struct SearchResult {
+    public let value: String
+    public let data: SearchResultData
+    public let matchedTerms: [String]
+    public let variations: [SearchVariation]
 }
diff --git a/AutocompleteClient/FW/Logic/Result/Search/SearchResultData.swift b/AutocompleteClient/FW/Logic/Result/Search/SearchResultData.swift
@@ -8,17 +8,17 @@
 
 import Foundation
 
-struct SearchResultData {
-    let id: String
-    let url: String?
-    let quantity: String?
-    let imageURL: String?
-    let metadata: [String: Any]
-    let facets: [SearchResultFacet]?
-    let groups: [CIOGroup]?
+public struct SearchResultData {
+    public let id: String
+    public let url: String?
+    public let quantity: String?
+    public let imageURL: String?
+    public let metadata: [String: Any]
+    public let facets: [SearchResultFacet]?
+    public let groups: [CIOGroup]?
 }
 
-extension SearchResultData {
+public extension SearchResultData {
     init?(json: JSONObject) {
         guard let id = json["id"] as? String else { return nil }
         self.id = id
diff --git a/AutocompleteClient/FW/Logic/Result/Search/SearchResultFacet.swift b/AutocompleteClient/FW/Logic/Result/Search/SearchResultFacet.swift
@@ -8,11 +8,11 @@
 
 import Foundation
 
-struct SearchResultFacet {
-    let name: String
-    let values: [String]
+public struct SearchResultFacet {
+    public let name: String
+    public let values: [String]
 
-    init?(json: JSONObject) {
+    public init?(json: JSONObject) {
         guard let name = json["name"] as? String else { return nil }
 
         self.name = name
diff --git a/AutocompleteClient/FW/Logic/Result/Search/SearchVariation.swift b/AutocompleteClient/FW/Logic/Result/Search/SearchVariation.swift
@@ -8,12 +8,12 @@
 
 import Foundation
 
-struct SearchVariation {
-    let value: String
-    let data: SearchVariationData
+public struct SearchVariation {
+    public let value: String
+    public let data: SearchVariationData
 }
 
-extension SearchVariation {
+public extension SearchVariation {
     init?(json: JSONObject) {
         guard let value = json["value"] as? String else { return nil }
         guard let dataObj = json["data"] as? [String: Any] else { return nil }
diff --git a/AutocompleteClient/FW/Logic/Result/Search/SearchVariationData.swift b/AutocompleteClient/FW/Logic/Result/Search/SearchVariationData.swift
@@ -8,14 +8,14 @@
 
 import Foundation
 
-struct SearchVariationData {
-    let variationId: String
-    let url: String?
-    let imageURL: String?
-    let metadata: [String: Any]
+public struct SearchVariationData {
+    public let variationId: String
+    public let url: String?
+    public let imageURL: String?
+    public let metadata: [String: Any]
 }
 
-extension SearchVariationData {
+public extension SearchVariationData {
     init?(json: JSONObject) {
         guard let variationId = json["variation_id"] as? String else { return nil }
         let url = json["url"] as? String
diff --git a/AutocompleteClient/FW/Logic/Result/Search/SortOption.swift b/AutocompleteClient/FW/Logic/Result/Search/SortOption.swift
@@ -8,14 +8,14 @@
 
 import Foundation
 
-struct SortOption {
-    let displayName: String
-    let sortBy: String
-    let sortOrder: SortOrder
-    let status: String
+public struct SortOption {
+    public let displayName: String
+    public let sortBy: String
+    public let sortOrder: SortOrder
+    public let status: String
 }
 
-enum SortOrder: String {
-    case ascending = "ascending"
-    case descending = "descending"
+public enum SortOrder: String {
+    case ascending
+    case descending
 }
diff --git a/AutocompleteClientTests/FW/Logic/Request/AutocompleteQueryRequestBuilderTests.swift b/AutocompleteClientTests/FW/Logic/Request/AutocompleteQueryRequestBuilderTests.swift
@@ -50,7 +50,7 @@ class AutocompleteQueryRequestBuilderTests: XCTestCase {
     func testAutocompleteQueryBuilder_WithNumResultsForSection() {
         let singleSectionQuery = CIOAutocompleteQuery(query: self.query, numResultsForSection: ["section1": 1])
         builder.build(trackData: singleSectionQuery)
-        var request = builder.getRequest()
+        let request = builder.getRequest()
         let url = request.url!.absoluteString
 
         XCTAssertTrue(url.hasPrefix("https://ac.cnstrc.com/autocomplete/\(endodedQuery)?"))
@@ -63,7 +63,7 @@ class AutocompleteQueryRequestBuilderTests: XCTestCase {
     func testAutocompleteQueryBuilder_WithNumResultsForMultipleSections() {
         let multiSectionQuery = CIOAutocompleteQuery(query: self.query, numResultsForSection: ["section1": 3, "section_999": 999])
         builder.build(trackData: multiSectionQuery)
-        var request = builder.getRequest()
+        let request = builder.getRequest()
         let url = request.url!.absoluteString
 
         XCTAssertTrue(url.hasPrefix("https://ac.cnstrc.com/autocomplete/\(endodedQuery)?"))
diff --git a/AutocompleteClientTests/FW/Logic/Request/Mock/CIOGroup+Mock.swift b/AutocompleteClientTests/FW/Logic/Request/Mock/CIOGroup+Mock.swift
@@ -10,7 +10,7 @@ import XCTest
 import ConstructorAutocomplete
 
 public extension CIOGroup {
-    public class func mock(withName name: String? = nil) -> CIOGroup {
+    class func mock(withName name: String? = nil) -> CIOGroup {
         let naem = name ?? "group"
         return CIOGroup(displayName: naem, groupID: naem, path: "path/to/group")
     }
diff --git a/AutocompleteClientTests/FW/Logic/Request/Mock/CIOResult+Mock.swift b/AutocompleteClientTests/FW/Logic/Request/Mock/CIOResult+Mock.swift
@@ -11,7 +11,7 @@ import ConstructorAutocomplete
 
 public extension CIOResult {
 
-    public class func mock(withValue value: String, group: CIOGroup? = nil) -> CIOResult {
+    class func mock(withValue value: String, group: CIOGroup? = nil) -> CIOResult {
         let json: [String: Any] = TestResource.load(name: TestResource.Response.singleResultJSONFilename).toJSONDictionary()!
         return CIOResult(autocompleteResult: CIOAutocompleteResult(json: json)!, group: group)
     }
diff --git a/AutocompleteClientTests/FW/Logic/Request/QueryItemCollection/QueryItemCollectionTests.swift b/AutocompleteClientTests/FW/Logic/Request/QueryItemCollection/QueryItemCollectionTests.swift
@@ -17,7 +17,7 @@ class QueryItemCollectionTests: XCTestCase {
     }
 
     func testQueryItemCollection_SubscriptGetter() {
-        var collection = QueryItemCollection()
+        let collection = QueryItemCollection()
         let _ = collection["key"]
     }
 
diff --git a/AutocompleteClientTests/FW/Logic/Worker/ConstructorIOSearchTests.swift b/AutocompleteClientTests/FW/Logic/Worker/ConstructorIOSearchTests.swift
diff --git a/AutocompleteClientTests/FW/UI/ViewModel/AutocompleteViewModelTests.swift b/AutocompleteClientTests/FW/UI/ViewModel/AutocompleteViewModelTests.swift

Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,8 @@ struct Constants {`
`80`	`80`	`static let groupFilter = "filters[group_id]"`
`81`	`81`	`static let facetFilterKey = { (key: String) -> String in "filters[\(key)]" }`
`82`	`82`	`static let section = "section"`
	`83`	`+ static let sortBy = "sort_by"`
	`84`	`+ static let sortOrder = "sort_order"`
`83`	`85`	`static let defaultSectionName = "Products"`
`84`	`86`	`}`
`85`	`87`
Original file line number	Diff line number	Diff line change
`@@ -106,6 +106,12 @@ extension RequestBuilder {`
`106`	`106`	`queryItems.add(URLQueryItem(name: Constants.SearchQuery.facetFilterKey(filter.key), value: filter.value))`
`107`	`107`	`}`
`108`	`108`
	`109`	`+ func set(sortOption: SortOption?) {`
	`110`	`+ guard let option = sortOption else { return }`
	`111`	`+ queryItems.add(URLQueryItem(name: Constants.SearchQuery.sortBy, value: option.sortBy))`
	`112`	`+ queryItems.add(URLQueryItem(name: Constants.SearchQuery.sortOrder, value: option.sortOrder.rawValue))`
	`113`	`+ }`
	`114`	`+`
`109`	`115`	`func set(_ value: String, forKey key: String) {`
`110`	`116`	`queryItems.add(URLQueryItem(name: key, value: value))`
`111`	`117`	`}`