Merge pull request #297 from woocommerce/develop

Merging 0.7 into Master

Author: jleandroperez

Networking/Networking.xcodeproj/project.pbxproj

@@ -0,0 +1,14 @@
+import Foundation
+
+
+/// Mapper: TopEarnerStats
+///
+class TopEarnerStatsMapper: Mapper {
+
+    /// (Attempts) to convert a dictionary into an TopEarnerStats entity.
+    ///
+    func map(response: Data) throws -> TopEarnerStats {
+        let decoder = JSONDecoder()
+        return try decoder.decode(TopEarnerStats.self, from: response)
+    }
+}

Networking/Networking/Mapper/TopEarnerStatsMapper.swift

@@ -50,3 +50,22 @@ private extension Account {
         case gravatarUrl    = "avatar_URL"
     }
 }
+
+
+// MARK: - Comparable Conformance
+//
+extension Account: Comparable {
+    public static func == (lhs: Account, rhs: Account) -> Bool {
+        return lhs.userID == rhs.userID &&
+            lhs.displayName == rhs.displayName &&
+            lhs.email == rhs.email &&
+            lhs.username == rhs.username &&
+            lhs.gravatarUrl == rhs.gravatarUrl
+    }
+
+    public static func < (lhs: Account, rhs: Account) -> Bool {
+        return lhs.userID < rhs.userID ||
+            (lhs.userID == rhs.userID && lhs.username < rhs.username) ||
+            (lhs.userID == rhs.userID && lhs.username == rhs.username && lhs.displayName < rhs.displayName)
+    }
+}

Networking/Networking/Model/Account.swift

@@ -183,7 +183,8 @@ extension Order: Comparable {
             lhs.paymentMethodTitle == rhs.paymentMethodTitle &&
             lhs.billingAddress == rhs.billingAddress &&
             lhs.shippingAddress == rhs.shippingAddress &&
-            lhs.coupons == rhs.coupons &&
+            lhs.coupons.count == rhs.coupons.count &&
+            lhs.coupons.sorted() == rhs.coupons.sorted() &&
             lhs.items.count == rhs.items.count &&
             lhs.items.sorted() == rhs.items.sorted()
     }

Networking/Networking/Model/Order.swift

@@ -58,6 +58,26 @@ public struct Site: Decodable {
 }
 
 
+// MARK: - Comparable Conformance
+//
+extension Site: Comparable {
+    public static func == (lhs: Site, rhs: Site) -> Bool {
+        return lhs.siteID == rhs.siteID &&
+            lhs.name == rhs.name &&
+            lhs.description == rhs.description &&
+            lhs.url == rhs.url &&
+            lhs.isWooCommerceActive == rhs.isWooCommerceActive &&
+            lhs.isWordPressStore == rhs.isWordPressStore
+    }
+
+    public static func < (lhs: Site, rhs: Site) -> Bool {
+        return lhs.siteID < rhs.siteID ||
+            (lhs.siteID == rhs.siteID && lhs.name < rhs.name) ||
+            (lhs.siteID == rhs.siteID && lhs.name == rhs.name && lhs.description < rhs.description)
+    }
+}
+
+
 /// Defines all of the Site CodingKeys.
 ///
 private extension Site {

Networking/Networking/Model/Site.swift

@@ -0,0 +1,65 @@
+import Foundation
+
+
+/// Represents Top Earner (aka top performer) stats over a specific period.
+///
+public struct TopEarnerStats: Decodable {
+    public let date: String
+    public let granularity: StatGranularity
+    public let limit: String
+    public let items: [TopEarnerStatsItem]?
+
+
+    /// The public initializer for top earner stats.
+    ///
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        let date = try container.decode(String.self, forKey: .date)
+        let granularity = try container.decode(StatGranularity.self, forKey: .unit)
+        let limit = try container.decode(String.self, forKey: .limit)
+        let items = try container.decode([TopEarnerStatsItem].self, forKey: .items)
+
+        self.init(date: date, granularity: granularity, limit: limit, items: items)
+    }
+
+
+    /// TopEarnerStats struct initializer.
+    ///
+    public init(date: String, granularity: StatGranularity, limit: String, items: [TopEarnerStatsItem]?) {
+        self.date = date
+        self.granularity = granularity
+        self.limit = limit
+        self.items = items
+    }
+}
+
+
+/// Defines all of the TopEarnerStats CodingKeys.
+///
+private extension TopEarnerStats {
+    enum CodingKeys: String, CodingKey {
+        case date = "date"
+        case unit = "unit"
+        case limit = "limit"
+        case items = "data"
+    }
+}
+
+
+// MARK: - Comparable Conformance
+//
+extension TopEarnerStats: Comparable {
+    public static func == (lhs: TopEarnerStats, rhs: TopEarnerStats) -> Bool {
+        return lhs.date == rhs.date &&
+            lhs.granularity == rhs.granularity &&
+            lhs.limit == rhs.limit &&
+            lhs.items?.count == rhs.items?.count &&
+            lhs.items?.sorted() == rhs.items?.sorted()
+    }
+
+    public static func < (lhs: TopEarnerStats, rhs: TopEarnerStats) -> Bool {
+        return lhs.date < rhs.date ||
+            (lhs.date == rhs.date && lhs.limit < rhs.limit)
+    }
+}

Networking/Networking/Model/Stats/TopEarnerStats.swift

@@ -0,0 +1,83 @@
+import Foundation
+
+
+/// Represents a single top earner stat for a specific period.
+///
+public struct TopEarnerStatsItem: Decodable {
+
+    /// Product ID
+    ///
+    public let productID: Int
+
+    /// Product name
+    ///
+    public let productName: String
+
+    /// Quantity sold
+    ///
+    public let quantity: Int
+
+    /// Average price of item
+    ///
+    public let price: Double
+
+    /// Total revenue from product
+    ///
+    public let total: Double
+
+    /// Currency
+    ///
+    public let currency: String
+
+    /// Image URL for product
+    ///
+    public let imageUrl: String?
+
+
+    /// Designated Initializer.
+    ///
+    public init(productID: Int, productName: String, quantity: Int, price: Double, total: Double, currency: String, imageUrl: String?) {
+        self.productID = productID
+        self.productName = productName
+        self.quantity = quantity
+        self.price = price
+        self.total = total
+        self.currency = currency
+        self.imageUrl = imageUrl
+    }
+}
+
+
+/// Defines all of the TopEarnerStatsItem CodingKeys.
+///
+private extension TopEarnerStatsItem {
+    enum CodingKeys: String, CodingKey {
+        case productID = "ID"
+        case productName = "name"
+        case total = "total"
+        case quantity = "quantity"
+        case price = "price"
+        case imageUrl = "image"
+        case currency = "currency"
+    }
+}
+
+
+// MARK: - Comparable Conformance
+//
+extension TopEarnerStatsItem: Comparable {
+    public static func == (lhs: TopEarnerStatsItem, rhs: TopEarnerStatsItem) -> Bool {
+        return lhs.productID == rhs.productID &&
+            lhs.productName == rhs.productName &&
+            lhs.quantity == rhs.quantity &&
+            lhs.price == rhs.price &&
+            lhs.total == rhs.total &&
+            lhs.currency == rhs.currency &&
+            lhs.imageUrl == rhs.imageUrl
+    }
+
+    public static func < (lhs: TopEarnerStatsItem, rhs: TopEarnerStatsItem) -> Bool {
+        return lhs.quantity < rhs.quantity ||
+            (lhs.quantity == rhs.quantity && lhs.productName < rhs.productName)
+    }
+}

Networking/Networking/Model/Stats/TopEarnerStatsItem.swift

@@ -0,0 +1,45 @@
+import Foundation
+import Alamofire
+
+
+/// TopEarnersStats: Remote Endpoints
+///
+public class TopEarnersStatsRemote: Remote {
+
+    /// Fetch the top earner (aka Top Performer) stats ( stats for a given site for the current day, week, month, or year (depends on the given granularity of the `unit` parameter).
+    ///
+    /// - Parameters:
+    ///   - siteID: The site ID
+    ///   - unit: Defines the granularity of the stats we are fetching (one of 'day', 'week', 'month', or 'year')
+    ///   - latestDateToInclude: The latest date to include in the results (see Note below)
+    ///   - limit: Maximum number of `unit`s to fetch
+    ///   - completion: Closure to be executed upon completion.
+    ///
+    /// Note: `latestDateToInclude` date string must be formatted appropriately given the `unit` param. See: `DateFormatter.Stats` extension for some helper funcs.
+    ///
+    public func loadTopEarnersStats(for siteID: Int, unit: StatGranularity, latestDateToInclude: String, limit: Int, completion: @escaping (TopEarnerStats?, Error?) -> Void) {
+        let path = "\(Constants.sitesPath)/\(siteID)/\(Constants.topEarnersStatsPath)/"
+        let parameters = [ParameterKeys.unit: unit.rawValue,
+                          ParameterKeys.date: latestDateToInclude,
+                          ParameterKeys.limit: String(limit)]
+        let request = DotcomRequest(wordpressApiVersion: .wpcomMark2, method: .get, path: path, parameters: parameters)
+        let mapper = TopEarnerStatsMapper()
+        enqueue(request, mapper: mapper, completion: completion)
+    }
+}
+
+
+// MARK: - Constants!
+//
+private extension TopEarnersStatsRemote {
+    enum Constants {
+        static let sitesPath: String            = "sites"
+        static let topEarnersStatsPath: String  = "stats/top-earners"
+    }
+
+    enum ParameterKeys {
+        static let unit: String     = "unit"
+        static let date: String     = "date"
+        static let limit: String    = "limit"
+    }
+}