Merge pull request #130 from woocommerce/feature/102-orders-yosemite-mark2

Yosemite Integration for Orders: Mark 2

Author: bummytime

Networking/Networking/Model/Address.swift

@@ -13,6 +13,8 @@ public struct Address: Decodable {
     public let state: String
     public let postcode: String
     public let country: String
+    public let phone: String?
+    public let email: String?
 }
 
 
@@ -30,6 +32,8 @@ private extension Address {
         case state      = "state"
         case postcode   = "postcode"
         case country    = "country"
+        case phone      = "phone"
+        case email      = "email"
     }
 }
 
@@ -46,7 +50,9 @@ extension Address: Comparable {
             lhs.city == rhs.city &&
             lhs.state == rhs.state &&
             lhs.postcode == rhs.postcode &&
-            lhs.country == rhs.country
+            lhs.country == rhs.country &&
+            lhs.phone == rhs.phone &&
+            lhs.email == rhs.email
     }
 
     public static func < (lhs: Address, rhs: Address) -> Bool {

Networking/Networking/Remote/OrdersRemote.swift

@@ -12,14 +12,31 @@ public class OrdersRemote: Remote {
     ///     - siteID: Site for which we'll fetch remote orders.
     ///     - completion: Closure to be executed upon completion.
     ///
-    public func loadAllOrders(for siteID: Int, completion: @escaping ([Order]?, Error?) -> Void) {
-        let path = "orders"
-        let request = JetpackRequest(wooApiVersion: .mark2, method: .get, siteID: siteID, path: path)
+    public func loadAllOrders(for siteID: Int, page: Int = 1, completion: @escaping ([Order]?, Error?) -> Void) {
+        let path = Constants.ordersPath
+        let parameters = [ParameterKeys.page: String(page),
+                          ParameterKeys.perPage: String(Constants.defaultPageSize)]
+        let request = JetpackRequest(wooApiVersion: .mark2, method: .get, siteID: siteID, path: path, parameters: parameters)
         let mapper = OrderListMapper()
 
         enqueue(request, mapper: mapper, completion: completion)
     }
 
+    /// Retrieves a specific `Order`
+    ///
+    /// - Parameters:
+    ///     - siteID: Site for which we'll fetch remote orders.
+    ///     - orderID: Order for which we'll fetch remote orders.
+    ///     - completion: Closure to be executed upon completion.
+    ///
+    public func loadOrder(for siteID: Int, orderID: Int, completion: @escaping (Order?, Error?) -> Void) {
+        let path = "\(Constants.ordersPath)/\(orderID)"
+        let request = JetpackRequest(wooApiVersion: .mark2, method: .get, siteID: siteID, path: path, parameters: nil)
+        let mapper = OrderMapper()
+
+        enqueue(request, mapper: mapper, completion: completion)
+    }
+
     /// Updates the `OrderStatus` of a given Order.
     ///
     /// - Parameters:
@@ -29,11 +46,27 @@ public class OrdersRemote: Remote {
     ///     - completion: Closure to be executed upon completion.
     ///
     public func updateOrder(from siteID: Int, orderID: Int, status: String, completion: @escaping (Order?, Error?) -> Void) {
-        let path = "orders/" + String(orderID)
-        let parameters = ["status": status]
+        let path = "\(Constants.ordersPath)/" + String(orderID)
+        let parameters = [ParameterKeys.status: status]
         let mapper = OrderMapper()
 
         let request = JetpackRequest(wooApiVersion: .mark2, method: .post, siteID: siteID, path: path, parameters: parameters)
         enqueue(request, mapper: mapper, completion: completion)
     }
 }
+
+
+// MARK: - Constants!
+//
+private extension OrdersRemote {
+    enum Constants {
+        static let defaultPageSize: Int         = 75
+        static let ordersPath: String           = "orders"
+    }
+
+    enum ParameterKeys {
+        static let status: String   = "status"
+        static let page: String     = "page"
+        static let perPage: String  = "per_page"
+    }
+}

Networking/NetworkingTests/Remote/OrdersRemoteTests.swift

@@ -44,6 +44,23 @@ class OrdersRemoteTests: XCTestCase {
         wait(for: [expectation], timeout: Constants.expectationTimeout)
     }
 
+    /// Verifies that loadOrder properly parses the `order` sample response.
+    ///
+    func testLoadSingleOrderProperlyReturnsParsedOrder() {
+        let remote = OrdersRemote(network: network)
+        let expectation = self.expectation(description: "Load Order")
+
+        network.simulateResponse(requestUrlSuffix: "orders/\(sampleOrderID)", filename: "order")
+
+        remote.loadOrder(for: sampleSiteID, orderID: sampleOrderID) { order, error in
+            XCTAssertNil(error)
+            XCTAssertNotNil(order)
+            expectation.fulfill()
+        }
+
+        wait(for: [expectation], timeout: Constants.expectationTimeout)
+    }
+
     /// Verifies that loadAllOrders properly relays Networking Layer errors.
     ///
     func testLoadAllOrdersProperlyRelaysNetwokingErrors() {

WooCommerce/Classes/Yosemite/AuthenticatedState.swift

@@ -34,7 +34,8 @@ class AuthenticatedState: StoresManagerState {
         let network = AlamofireNetwork(credentials: credentials)
 
         services = [
-            AccountStore(dispatcher: dispatcher, storageManager: storageManager, network: network)
+            AccountStore(dispatcher: dispatcher, storageManager: storageManager, network: network),
+            OrderStore(dispatcher: dispatcher, storageManager: storageManager, network: network)
         ]
 
         self.credentials = credentials

Yosemite/Yosemite.xcodeproj/project.pbxproj

@@ -9,6 +9,7 @@
 /* Begin PBXBuildFile section */
 		0E67B79585034C4DD75C8117 /* Pods_Yosemite.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C25501C7F936D2FD32FAF3F4 /* Pods_Yosemite.framework */; };
 		36941EA7B9242CAB1FF828BC /* Pods_YosemiteTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 991BBCE6E4A92F0A028885D8 /* Pods_YosemiteTests.framework */; };
+		7424B49420EAD37C00CC62F6 /* order.json in Resources */ = {isa = PBXBuildFile; fileRef = 7424B49320EAD37C00CC62F6 /* order.json */; };
 		74A7688C20D45EBA00F9D437 /* OrderStore.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74A7688B20D45EBA00F9D437 /* OrderStore.swift */; };
 		74A7688E20D45ED400F9D437 /* OrderStoreTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74A7688D20D45ED400F9D437 /* OrderStoreTests.swift */; };
 		74A7689020D45F9300F9D437 /* OrderAction.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74A7688F20D45F9300F9D437 /* OrderAction.swift */; };
@@ -47,6 +48,7 @@
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
+		7424B49320EAD37C00CC62F6 /* order.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = order.json; sourceTree = "<group>"; };
 		745D21C120D8043A00BBE7C3 /* generic_error.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = generic_error.json; sourceTree = "<group>"; };
 		74A7688B20D45EBA00F9D437 /* OrderStore.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OrderStore.swift; sourceTree = "<group>"; };
 		74A7688D20D45ED400F9D437 /* OrderStoreTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OrderStoreTests.swift; sourceTree = "<group>"; };
@@ -146,6 +148,7 @@
 			children = (
 				B5BC736A20D1AAE900B5B6FA /* me.json */,
 				74A7689120D47F9E00F9D437 /* orders.json */,
+				7424B49320EAD37C00CC62F6 /* order.json */,
 				745D21C120D8043A00BBE7C3 /* generic_error.json */,
 			);
 			path = Resources;
@@ -379,6 +382,7 @@
 			files = (
 				74A7689220D47F9E00F9D437 /* orders.json in Resources */,
 				B5BC736B20D1AAE900B5B6FA /* me.json in Resources */,
+				7424B49420EAD37C00CC62F6 /* order.json in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

Yosemite/Yosemite/Actions/OrderAction.swift

@@ -7,4 +7,5 @@ import Networking
 //
 public enum OrderAction: Action {
     case retrieveOrders(siteID: Int, onCompletion: ([Order]?, Error?) -> Void)
+    case retrieveOrder(siteID: Int, orderID: Int, onCompletion: (Order?, Error?) -> Void)
 }

Yosemite/Yosemite/Stores/OrderStore.swift

@@ -23,6 +23,8 @@ public class OrderStore: Store {
         switch action {
         case .retrieveOrders(let siteId, let onCompletion):
             retrieveOrders(siteId: siteId, onCompletion: onCompletion)
+        case .retrieveOrder(let siteId, let orderId, let onCompletion):
+            retrieveOrder(siteId: siteId, orderId: orderId, onCompletion: onCompletion)
         }
     }
 }
@@ -46,4 +48,19 @@ extension OrderStore  {
             onCompletion(orders, nil)
         }
     }
+
+    /// Retrieves a specific order associated with a given Site ID (if any!).
+    ///
+    func retrieveOrder(siteId: Int, orderId: Int, onCompletion: @escaping (Order?, Error?) -> Void) {
+        let remote = OrdersRemote(network: network)
+
+        remote.loadOrder(for: siteId, orderID: orderId) { (order, error) in
+            guard let order = order else {
+                onCompletion(nil, error)
+                return
+            }
+
+            onCompletion(order, nil)
+        }
+    }
 }