Merge branch 'develop' into issue/250-tracking-ui

Author: ctarda

.swiftlint.yml

@@ -69,7 +69,7 @@ whitelist_rules:
   # - legacy_constructor
 
   # Lines should not span too many characters.
-  # - line_length
+  - line_length
 
   # MARK comment should be in valid format.
   - mark
@@ -136,6 +136,8 @@ vertical_whitespace:
   max_empty_lines: 3
   severity: error
 
+line_length: 160
+
 control_statement:
   severity: error
 

Networking/Networking.xcodeproj/project.pbxproj

@@ -175,6 +175,8 @@
 		B5C6FCD420A373BB00A4F8E4 /* OrderMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5C6FCD320A373BA00A4F8E4 /* OrderMapper.swift */; };
 		B5C6FCD620A3768900A4F8E4 /* order.json in Resources */ = {isa = PBXBuildFile; fileRef = B5C6FCD520A3768900A4F8E4 /* order.json */; };
 		B5DAEFF02180DD5A0002356A /* NotificationsRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = B5DAEFEF2180DD5A0002356A /* NotificationsRemote.swift */; };
+		CE12FBD9221F3A6F00C59248 /* OrderStatus.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE12FBD8221F3A6F00C59248 /* OrderStatus.swift */; };
+		CE19CB11222486A600E8AF7A /* order-statuses.json in Resources */ = {isa = PBXBuildFile; fileRef = CE19CB10222486A500E8AF7A /* order-statuses.json */; };
 		CE20179320E3EFA7005B4C18 /* broken-orders.json in Resources */ = {isa = PBXBuildFile; fileRef = CE20179220E3EFA7005B4C18 /* broken-orders.json */; };
 		CE50345E21B571A7007573C6 /* SitePlanMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE50345D21B571A7007573C6 /* SitePlanMapper.swift */; };
 		CE50346021B5799F007573C6 /* SitePlan.swift in Sources */ = {isa = PBXBuildFile; fileRef = CE50345F21B5799F007573C6 /* SitePlan.swift */; };
@@ -366,6 +368,8 @@
 		B5DAEFEF2180DD5A0002356A /* NotificationsRemote.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = NotificationsRemote.swift; sourceTree = "<group>"; };
 		BD9439D9B8F2C1ED2EADAA51 /* Pods-NetworkingTests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-NetworkingTests.debug.xcconfig"; path = "../Pods/Target Support Files/Pods-NetworkingTests/Pods-NetworkingTests.debug.xcconfig"; sourceTree = "<group>"; };
 		C8F9A8CC6F90A8C9B5EF2EE2 /* Pods-Networking.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Networking.release.xcconfig"; path = "../Pods/Target Support Files/Pods-Networking/Pods-Networking.release.xcconfig"; sourceTree = "<group>"; };
+		CE12FBD8221F3A6F00C59248 /* OrderStatus.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OrderStatus.swift; sourceTree = "<group>"; };
+		CE19CB10222486A500E8AF7A /* order-statuses.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "order-statuses.json"; sourceTree = "<group>"; };
 		CE20179220E3EFA7005B4C18 /* broken-orders.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "broken-orders.json"; sourceTree = "<group>"; };
 		CE50345D21B571A7007573C6 /* SitePlanMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SitePlanMapper.swift; sourceTree = "<group>"; };
 		CE50345F21B5799F007573C6 /* SitePlan.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SitePlan.swift; sourceTree = "<group>"; };
@@ -612,6 +616,7 @@
 				741B950020EBC8A700DD6E2D /* OrderCouponLine.swift */,
 				B5C6FCCE20A3592900A4F8E4 /* OrderItem.swift */,
 				74C8F06320EEB44800B6EDC9 /* OrderNote.swift */,
+				CE12FBD8221F3A6F00C59248 /* OrderStatus.swift */,
 				B5BB1D1120A255EC00112D92 /* OrderStatusKey.swift */,
 				743E84EB22171F4600FAC9D7 /* ShipmentTracking.swift */,
 				B56C1EB720EA76F500D749F9 /* Site.swift */,
@@ -653,6 +658,7 @@
 				743FDB9A210FB36900AC737F /* order-stats-year.json */,
 				B58D10C52114D1F100107ED4 /* order-stats.json */,
 				7412A51021702E9700994370 /* order-stats-alt.json */,
+				CE19CB10222486A500E8AF7A /* order-statuses.json */,
 				7412A8EF21B6E415005D182A /* report-orders.json */,
 				74046E20217A73D0007DD7BF /* settings-general.json */,
 				7492FAE2217FBDBC00ED2C69 /* settings-general-alt.json */,
@@ -935,6 +941,7 @@
 				743E84F222172D0A00FAC9D7 /* shipment_tracking_plugin_not_active.json in Resources */,
 				74ABA1C9213F19FE00FFAD30 /* top-performers-month.json in Resources */,
 				743E84F622172D3E00FAC9D7 /* shipment_tracking_single.json in Resources */,
+				CE19CB11222486A600E8AF7A /* order-statuses.json in Resources */,
 				74ABA1CA213F19FE00FFAD30 /* top-performers-year.json in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -1029,6 +1036,7 @@
 				74ABA1CD213F1B6B00FFAD30 /* TopEarnerStats.swift in Sources */,
 				B557DA0220975500005962F4 /* JetpackRequest.swift in Sources */,
 				74046E1F217A6B70007DD7BF /* SiteSettingsMapper.swift in Sources */,
+				CE12FBD9221F3A6F00C59248 /* OrderStatus.swift in Sources */,
 				7426CA1121AF30BD004E9FFC /* SiteAPIMapper.swift in Sources */,
 				743E84EC22171F4600FAC9D7 /* ShipmentTracking.swift in Sources */,
 				B56C1EB820EA76F500D749F9 /* Site.swift in Sources */,

Networking/Networking/Mapper/ReportOrderTotalsMapper.swift

@@ -5,37 +5,31 @@ import Foundation
 ///
 struct ReportOrderTotalsMapper: Mapper {
 
-    /// (Attempts) to extract order totals report from a given JSON Encoded response.
+    /// Site Identifier associated to the settings that will be parsed.
+    /// We're injecting this field via `JSONDecoder.userInfo` because
+    /// the remote endpoints don't really return the SiteID in any of the
+    /// settings endpoints.
     ///
-    func map(response: Data) throws -> [OrderStatusKey: Int] {
-        let totalsArray = try JSONDecoder().decode(ReportOrderTotalsEnvelope.self, from: response).totals
-        var returnDict = [OrderStatusKey: Int]()
-        totalsArray.forEach({ (totalResult) in
-            guard let slug = totalResult[Constants.slugKey]?.value as? String, !slug.isEmpty else {
-                return
-            }
-            let status = OrderStatusKey(rawValue: slug)
-            returnDict[status] = totalResult[Constants.totalKey]?.value as? Int ?? 0
-        })
-        return returnDict
-    }
-}
-
+    let siteID: Int
 
-private extension ReportOrderTotalsMapper {
-    enum Constants {
-        static let slugKey  = "slug"
-        static let totalKey = "total"
+    /// (Attempts) to extract order totals report from a given JSON Encoded response.
+    ///
+    func map(response: Data) throws -> [OrderStatus] {
+        let decoder = JSONDecoder()
+        decoder.userInfo = [
+            .siteID: siteID
+        ]
+        return try decoder.decode(ReportOrderTotalsEnvelope.self, from: response).data
     }
 }
 
-
-/// The report endpoint returns the totals document within a `data` key. This entity
-/// allows us to do parse all the things with JSONDecoder.
+/// The report endpoint returns the totals document within a `data` key.
+/// This entity allows us to parse all the things with JSONDecoder.
 ///
 private struct ReportOrderTotalsEnvelope: Decodable {
-    let totals: [[String: AnyDecodable]]
+    let data: [OrderStatus]
+
     private enum CodingKeys: String, CodingKey {
-        case totals = "data"
+        case data
     }
 }

Networking/Networking/Model/Order.swift

@@ -100,6 +100,7 @@ public struct Order: Decodable {
 
         let number = try container.decode(String.self, forKey: .number)
         let statusKey = try container.decode(OrderStatusKey.self, forKey: .status)
+
         let currency = try container.decode(String.self, forKey: .currency)
         let customerNote = try container.decode(String.self, forKey: .customerNote)
 

Networking/Networking/Model/OrderStatus.swift

@@ -0,0 +1,74 @@
+import Foundation
+
+
+/// Represents an OrderStatus Entity.
+///
+public struct OrderStatus: Decodable {
+    public let name: String?
+    public let siteID: Int
+    public let slug: String
+    public let total: Int
+
+    public var status: OrderStatusKey {
+        return OrderStatusKey(rawValue: slug)
+    }
+
+    /// OrderStatus struct initializer.
+    ///
+    public init(name: String?, siteID: Int, slug: String, total: Int) {
+        self.name = name
+        self.siteID = siteID
+        self.slug = slug
+        self.total = total
+    }
+
+    /// The public initializer for OrderStatus.
+    ///
+    public init(from decoder: Decoder) throws {
+        guard let siteID = decoder.userInfo[.siteID] as? Int else {
+            throw OrderStatusError.missingSiteID
+        }
+
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        let name = try container.decode(String.self, forKey: .name)
+        let slug = try container.decode(String.self, forKey: .slug)
+        let total = try container.decode(Int.self, forKey: .total)
+
+        self.init(name: name, siteID: siteID, slug: slug, total: total) // initialize the struct
+    }
+}
+
+
+/// Defines all of the OrderStatus's CodingKeys.
+///
+private extension OrderStatus {
+
+    enum CodingKeys: String, CodingKey {
+        case name
+        case slug
+        case total
+    }
+}
+
+
+// MARK: - Comparable Conformance
+//
+extension OrderStatus: Comparable {
+    public static func == (lhs: OrderStatus, rhs: OrderStatus) -> Bool {
+        return lhs.name == rhs.name &&
+            lhs.slug == rhs.slug &&
+            lhs.total == rhs.total
+    }
+
+    public static func < (lhs: OrderStatus, rhs: OrderStatus) -> Bool {
+        return lhs.total < rhs.total ||
+            (lhs.total == rhs.total && lhs.slug < rhs.slug)
+    }
+}
+
+
+// MARK: - Decoding Errors
+//
+enum OrderStatusError: Error {
+    case missingSiteID
+}

Networking/Networking/Remote/ReportRemote.swift

@@ -7,6 +7,7 @@ import Alamofire
 public class ReportRemote: Remote {
 
     /// Retrieves all of the order totals for a given site.
+    /// Wraps the API request.
     ///
     /// *Note:* This is a Woo REST API v3 endpoint! It will not work on any Woo site under v3.5.
     ///
@@ -15,9 +16,30 @@ public class ReportRemote: Remote {
     ///   - completion: Closure to be executed upon completion.
     ///
     public func loadOrderTotals(for siteID: Int, completion: @escaping ([OrderStatusKey: Int]?, Error?) -> Void) {
+        loadReportOrderTotals(for: siteID) { (orderStatuses, error) in
+            var returnDict = [OrderStatusKey: Int]()
+            orderStatuses?.forEach({ (orderStatus) in
+                let status = OrderStatusKey(rawValue: orderStatus.slug)
+                returnDict[status] = orderStatus.total
+            })
+            completion(returnDict, error)
+        }
+    }
+
+    /// Retrieves all known order statuses.
+    /// Wraps the API request.
+    ///
+    public func loadOrderStatuses(for siteID: Int, completion: @escaping ([OrderStatus]?, Error?) -> Void) {
+        loadReportOrderTotals(for: siteID, completion: completion)
+    }
+
+    /// Retrieves an order totals report
+    ///
+    private func loadReportOrderTotals(for siteID: Int, completion: @escaping ([OrderStatus]?, Error?) -> Void) {
         let path = Constants.orderTotalsPath
         let request = JetpackRequest(wooApiVersion: .mark3, method: .get, siteID: siteID, path: path, parameters: nil)
-        let mapper = ReportOrderTotalsMapper()
+        let mapper = ReportOrderTotalsMapper(siteID: siteID)
+
         enqueue(request, mapper: mapper, completion: completion)
     }
 }

Networking/NetworkingTests/Mapper/ReportOrderMapperTests.swift

@@ -6,6 +6,10 @@ import XCTest
 ///
 class ReportOrderMapperTests: XCTestCase {
 
+    /// Sample SiteID
+    ///
+    let siteID = 1234
+
     /// Verifies that the broken response causes the mapper to return an unknown status
     ///
     func testBrokenResponseReturnsUnknownStatus() {
@@ -16,17 +20,71 @@ class ReportOrderMapperTests: XCTestCase {
     /// Verifies that a valid report totals response is properly parsed (YAY!).
     ///
     func testSampleResponseLoaded() {
-        let reportTotals = try? mapSuccessfulResponse()
+        guard let results = try? mapSuccessfulResponse() else {
+            XCTFail("Sample order report totals didn't load.")
+            return
+        }
+
+        var reportTotals = [OrderStatusKey: Int]()
+        results.forEach({ (orderStatus) in
+            let status = OrderStatusKey(rawValue: orderStatus.slug)
+            reportTotals[status] = orderStatus.total
+        })
+        let orderStatuses = results
+
         XCTAssertNotNil(reportTotals)
-        XCTAssertEqual(reportTotals?.count, 8)
-        XCTAssertEqual(reportTotals?[.pending], 123)
-        XCTAssertEqual(reportTotals?[.processing], 4)
-        XCTAssertEqual(reportTotals?[.onHold], 5)
-        XCTAssertEqual(reportTotals?[.completed], 6)
-        XCTAssertEqual(reportTotals?[.cancelled], 7)
-        XCTAssertEqual(reportTotals?[.refunded], 8)
-        XCTAssertEqual(reportTotals?[.failed], 9)
-        XCTAssertEqual(reportTotals?[OrderStatusKey(rawValue: "cia-investigation")], 10)
+        XCTAssertEqual(reportTotals.count, 9)
+        XCTAssertEqual(reportTotals[.pending], 123)
+        XCTAssertEqual(reportTotals[.processing], 4)
+        XCTAssertEqual(reportTotals[.onHold], 5)
+        XCTAssertEqual(reportTotals[.completed], 6)
+        XCTAssertEqual(reportTotals[.cancelled], 7)
+        XCTAssertEqual(reportTotals[.refunded], 8)
+        XCTAssertEqual(reportTotals[.failed], 9)
+        XCTAssertEqual(reportTotals[OrderStatusKey(rawValue: "cia-investigation")], 10)
+        XCTAssertEqual(reportTotals[OrderStatusKey(rawValue: "pre-ordered")], 1)
+
+        XCTAssertNotNil(orderStatuses)
+        XCTAssertEqual(orderStatuses.count, 9)
+
+        let ciaOrderStatus = OrderStatus(name: "CIA Investigation", siteID: 1234, slug: "cia-investigation", total: 10)
+        let preorderedOrderStatus = OrderStatus(name: "Pre ordered", siteID: 1234, slug: "pre-ordered", total: 1)
+
+        XCTAssertEqual(orderStatuses[0].slug, "pending")
+        XCTAssertEqual(orderStatuses[0].name, "Pending payment")
+        XCTAssertEqual(orderStatuses[0].status, .pending)
+
+        XCTAssertEqual(orderStatuses[1].slug, "processing")
+        XCTAssertEqual(orderStatuses[1].name, "Processing")
+        XCTAssertEqual(orderStatuses[1].status, .processing)
+
+        XCTAssertEqual(orderStatuses[2].slug, "on-hold")
+        XCTAssertEqual(orderStatuses[2].name, "On hold")
+        XCTAssertEqual(orderStatuses[2].status, .onHold)
+
+        XCTAssertEqual(orderStatuses[3].slug, "completed")
+        XCTAssertEqual(orderStatuses[3].name, "Completed")
+        XCTAssertEqual(orderStatuses[3].status, .completed)
+
+        XCTAssertEqual(orderStatuses[4].slug, "cancelled")
+        XCTAssertEqual(orderStatuses[4].name, "Cancelled")
+        XCTAssertEqual(orderStatuses[4].status, .cancelled)
+
+        XCTAssertEqual(orderStatuses[5].slug, "refunded")
+        XCTAssertEqual(orderStatuses[5].name, "Refunded")
+        XCTAssertEqual(orderStatuses[5].status, .refunded)
+
+        XCTAssertEqual(orderStatuses[6].slug, "failed")
+        XCTAssertEqual(orderStatuses[6].name, "Failed")
+        XCTAssertEqual(orderStatuses[6].status, .failed)
+
+        XCTAssertEqual(orderStatuses[7].slug, "cia-investigation")
+        XCTAssertEqual(orderStatuses[7].name, "CIA Investigation")
+        XCTAssertEqual(orderStatuses[7].status, ciaOrderStatus.status)
+
+        XCTAssertEqual(orderStatuses[8].slug, "pre-ordered")
+        XCTAssertEqual(orderStatuses[8].name, "Pre ordered")
+        XCTAssertEqual(orderStatuses[8].status, preorderedOrderStatus.status)
     }
 }
 
@@ -37,21 +95,21 @@ private extension ReportOrderMapperTests {
 
     /// Returns the ReportOrderMapper output upon receiving `filename` (Data Encoded)
     ///
-    func mapOrderStatusResult(from filename: String) throws -> [OrderStatusKey: Int] {
+    func mapOrderStatusResult(from filename: String) throws -> [OrderStatus] {
         let response = Loader.contentsOf(filename)!
-        let mapper = ReportOrderTotalsMapper()
+        let mapper = ReportOrderTotalsMapper(siteID: 1234)
         return try mapper.map(response: response)
     }
 
     /// Returns the ReportOrderMapper output upon receiving data from the endpoint
     ///
-    func mapSuccessfulResponse() throws -> [OrderStatusKey: Int] {
+    func mapSuccessfulResponse() throws -> [OrderStatus] {
         return try mapOrderStatusResult(from: "report-orders")
     }
 
     /// Returns the ReportOrderMapper output upon receiving a broken response.
     ///
-    func mapLoadBrokenResponse() throws -> [OrderStatusKey: Int] {
+    func mapLoadBrokenResponse() throws -> [OrderStatus] {
         return try mapOrderStatusResult(from: "generic_error")
     }
 }

Networking/NetworkingTests/Remote/ReportRemoteTests.swift

@@ -31,7 +31,7 @@ class ReportRemoteTests: XCTestCase {
         remote.loadOrderTotals(for: sampleSiteID) { (reportTotals, error) in
             XCTAssertNil(error)
             XCTAssertNotNil(reportTotals)
-            XCTAssertEqual(reportTotals?.count, 8)
+            XCTAssertEqual(reportTotals?.count, 9)
             XCTAssertEqual(reportTotals?[.pending], 123)
             XCTAssertEqual(reportTotals?[.processing], 4)
             XCTAssertEqual(reportTotals?[.onHold], 5)
@@ -59,7 +59,7 @@ class ReportRemoteTests: XCTestCase {
             }
 
             XCTAssert(error == .unauthorized)
-            XCTAssertNil(reportTotals)
+            XCTAssertEqual(reportTotals?.isEmpty, true)
 
             expectation.fulfill()
         }