Add endpoint to fetch stats emails

Author: kean

Package.swift

@@ -11,8 +11,8 @@ let package = Package(
     targets: [
         .binaryTarget(
             name: "WordPressKit",
-            url: "https://github.com/user-attachments/files/21474850/WordPressKit.zip",
-            checksum: "4621e8faa2ce9c7ef847008b044ac9e04e733e6d8ede9e4a424eeb8c832b85c3"
+            url: "https://github.com/user-attachments/files/21488685/WordPressKit.zip",
+            checksum: "c591b9d12fdfeeedf7f31d884c6ce751722a37ae8ebb396a511fdb045698bccd"
         ),
     ]
 )

Sources/WordPressKit/Models/Stats/Emails/StatsEmailOpensData.swift

@@ -0,0 +1,42 @@
+import Foundation
+
+public struct StatsEmailOpensData: Decodable, Equatable {
+    public let totalSends: Int?
+    public let uniqueOpens: Int?
+    public let totalOpens: Int?
+    public let opensRate: Double?
+
+    public init(totalSends: Int?, uniqueOpens: Int?, totalOpens: Int?, opensRate: Double?) {
+        self.totalSends = totalSends
+        self.uniqueOpens = uniqueOpens
+        self.totalOpens = totalOpens
+        self.opensRate = opensRate
+    }
+
+    private enum CodingKeys: String, CodingKey {
+        case totalSends = "total_sends"
+        case uniqueOpens = "unique_opens"
+        case totalOpens = "total_opens"
+        case opensRate = "opens_rate"
+    }
+
+    public init(from decoder: any Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        totalSends = try container.decodeIfPresent(Int.self, forKey: .totalSends)
+        uniqueOpens = try container.decodeIfPresent(Int.self, forKey: .uniqueOpens)
+        totalOpens = try container.decodeIfPresent(Int.self, forKey: .totalOpens)
+        opensRate = try container.decodeIfPresent(Double.self, forKey: .opensRate)
+    }
+}
+
+extension StatsEmailOpensData {
+    public init?(jsonDictionary: [String: AnyObject]) {
+        do {
+            let jsonData = try JSONSerialization.data(withJSONObject: jsonDictionary, options: [])
+            let decoder = JSONDecoder()
+            self = try decoder.decode(Self.self, from: jsonData)
+        } catch {
+            return nil
+        }
+    }
+}

Sources/WordPressKit/Services/StatsServiceRemoteV2.swift

@@ -372,6 +372,28 @@ public extension StatsServiceRemoteV2 {
     }
 }
 
+// MARK: - Email Opens
+
+public extension StatsServiceRemoteV2 {
+    func getEmailOpens(for postID: Int, completion: @escaping ((StatsEmailOpensData?, Error?) -> Void)) {
+        let path = self.path(forEndpoint: "sites/\(siteID)/stats/opens/emails/\(postID)/rate", withVersion: ._1_1)
+
+        wordPressComRESTAPI.get(path, parameters: [:], success: { (response, _) in
+            guard
+                let jsonResponse = response as? [String: AnyObject],
+                let emailOpensData = StatsEmailOpensData(jsonDictionary: jsonResponse)
+            else {
+                completion(nil, ResponseError.decodingFailure)
+                return
+            }
+
+            completion(emailOpensData, nil)
+        }, failure: { (error, _) in
+            completion(nil, error)
+        })
+    }
+}
+
 // This serves both as a way to get the query properties in a "nice" way,
 // but also as a way to narrow down the generic type in `getInsight(completion:)` method.
 public protocol StatsInsightData {

Tests/WordPressKitTests/Mock Data/stats-email-opens.json

@@ -0,0 +1,6 @@
+{
+    "total_sends": 1,
+    "unique_opens": 1,
+    "total_opens": 4,
+    "opens_rate": 1
+}

Tests/WordPressKitTests/Tests/StatsRemoteV2Tests.swift

@@ -27,6 +27,7 @@ class StatsRemoteV2Tests: RemoteTestCase, RESTTestable {
     let toggleSpamStateResponseFilename = "stats-referrer-mark-as-spam.json"
     let getStatsSummaryFilename = "stats-summary.json"
     let getArchivesDataFilename = "stats-archives-data.json"
+    let getEmailOpensFilename = "stats-email-opens.json"
 
     // MARK: - Properties
 
@@ -44,6 +45,7 @@ class StatsRemoteV2Tests: RemoteTestCase, RESTTestable {
     var sitePostDetailsEndpoint: String { return "sites/\(siteID)/stats/post/9001" }
     var siteStatsSummaryEndpoint: String { return "sites/\(siteID)/stats/summary/" }
     var siteArchivesDataEndpoint: String { return "sites/\(siteID)/stats/archives" }
+    var siteEmailOpensEndpoint: String { return "sites/\(siteID)/stats/opens/emails/231/rate" }
 
     func toggleSpamStateEndpoint(for referrerDomain: String, markAsSpam: Bool) -> String {
         let action = markAsSpam ? "new" : "delete"
@@ -832,4 +834,24 @@ class StatsRemoteV2Tests: RemoteTestCase, RESTTestable {
         XCTAssertEqual(author.last?.value, "")
         XCTAssertEqual(author.last?.views, 2)
     }
+
+    func testEmailOpens() {
+        let expect = expectation(description: "It should return email opens data")
+
+        stubRemoteResponse(siteEmailOpensEndpoint, filename: getEmailOpensFilename, contentType: .ApplicationJSON)
+
+        remote.getEmailOpens(for: 231) { (emailOpens, error) in
+            XCTAssertNil(error)
+            XCTAssertNotNil(emailOpens)
+
+            XCTAssertEqual(emailOpens?.totalSends, 1)
+            XCTAssertEqual(emailOpens?.uniqueOpens, 1)
+            XCTAssertEqual(emailOpens?.totalOpens, 4)
+            XCTAssertEqual(emailOpens?.opensRate, 1)
+
+            expect.fulfill()
+        }
+
+        waitForExpectations(timeout: timeout, handler: nil)
+    }
 }

WordPressKit.xcodeproj/project.pbxproj

@@ -9,11 +9,13 @@
 /* Begin PBXBuildFile section */
 		01383F7F2BD5545B00496B76 /* StatsEmailsSummaryDataTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 01383F7E2BD5545B00496B76 /* StatsEmailsSummaryDataTests.swift */; };
 		01383F822BD556B100496B76 /* stats-emails-summary.json in Resources */ = {isa = PBXBuildFile; fileRef = 01383F802BD5549E00496B76 /* stats-emails-summary.json */; };
+		7B859118F037432BB78618D6 /* stats-email-opens.json in Resources */ = {isa = PBXBuildFile; fileRef = 7B859117F037432BB78618D6 /* stats-email-opens.json */; };
 		01438D362B6A31540097D60A /* stats-visits-month-unit-week.json in Resources */ = {isa = PBXBuildFile; fileRef = 01438D342B6A2B2C0097D60A /* stats-visits-month-unit-week.json */; };
 		01438D392B6A361B0097D60A /* stats-summary.json in Resources */ = {isa = PBXBuildFile; fileRef = 01438D372B6A35FB0097D60A /* stats-summary.json */; };
 		01438D3B2B6A36BF0097D60A /* StatsTotalsSummaryData.swift in Sources */ = {isa = PBXBuildFile; fileRef = 01438D3A2B6A36BF0097D60A /* StatsTotalsSummaryData.swift */; };
 		0152100C28EDA9E400DD6783 /* StatsAnnualAndMostPopularTimeInsightDecodingTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0152100B28EDA9E400DD6783 /* StatsAnnualAndMostPopularTimeInsightDecodingTests.swift */; };
 		019C5B8B2BD59CE000A69DB0 /* StatsEmailsSummaryData.swift in Sources */ = {isa = PBXBuildFile; fileRef = 019C5B892BD59CE000A69DB0 /* StatsEmailsSummaryData.swift */; };
+		11B3582786AD49E591C8615E /* StatsEmailOpensData.swift in Sources */ = {isa = PBXBuildFile; fileRef = 11B3582686AD49E591C8615E /* StatsEmailOpensData.swift */; };
 		0847B92C2A4442730044D32F /* IPLocationRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0847B92B2A4442730044D32F /* IPLocationRemote.swift */; };
 		08C7493E2A45EA11000DA0E2 /* IPLocationRemoteTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 08C7493D2A45EA11000DA0E2 /* IPLocationRemoteTests.swift */; };
 		0C0791B22BFE7DE50049C06E /* JetpackAssistantFeatureDetails.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0C0791B12BFE7DE50049C06E /* JetpackAssistantFeatureDetails.swift */; };
@@ -798,11 +800,13 @@
 /* Begin PBXFileReference section */
 		01383F7E2BD5545B00496B76 /* StatsEmailsSummaryDataTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatsEmailsSummaryDataTests.swift; sourceTree = "<group>"; };
 		01383F802BD5549E00496B76 /* stats-emails-summary.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "stats-emails-summary.json"; sourceTree = "<group>"; };
+		7B859117F037432BB78618D6 /* stats-email-opens.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "stats-email-opens.json"; sourceTree = "<group>"; };
 		01438D342B6A2B2C0097D60A /* stats-visits-month-unit-week.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "stats-visits-month-unit-week.json"; sourceTree = "<group>"; };
 		01438D372B6A35FB0097D60A /* stats-summary.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "stats-summary.json"; sourceTree = "<group>"; };
 		01438D3A2B6A36BF0097D60A /* StatsTotalsSummaryData.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = StatsTotalsSummaryData.swift; sourceTree = "<group>"; };
 		0152100B28EDA9E400DD6783 /* StatsAnnualAndMostPopularTimeInsightDecodingTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatsAnnualAndMostPopularTimeInsightDecodingTests.swift; sourceTree = "<group>"; };
 		019C5B892BD59CE000A69DB0 /* StatsEmailsSummaryData.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = StatsEmailsSummaryData.swift; sourceTree = "<group>"; };
+		11B3582686AD49E591C8615E /* StatsEmailOpensData.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = StatsEmailOpensData.swift; sourceTree = "<group>"; };
 		0847B92B2A4442730044D32F /* IPLocationRemote.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IPLocationRemote.swift; sourceTree = "<group>"; };
 		08C7493D2A45EA11000DA0E2 /* IPLocationRemoteTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IPLocationRemoteTests.swift; sourceTree = "<group>"; };
 		0C0791B12BFE7DE50049C06E /* JetpackAssistantFeatureDetails.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = JetpackAssistantFeatureDetails.swift; sourceTree = "<group>"; };
@@ -1617,6 +1621,7 @@
 			isa = PBXGroup;
 			children = (
 				019C5B892BD59CE000A69DB0 /* StatsEmailsSummaryData.swift */,
+				11B3582686AD49E591C8615E /* StatsEmailOpensData.swift */,
 			);
 			path = Emails;
 			sourceTree = "<group>";
@@ -2621,6 +2626,7 @@
 				01438D342B6A2B2C0097D60A /* stats-visits-month-unit-week.json */,
 				40819779221F153A00A298E4 /* stats-visits-week.json */,
 				01383F802BD5549E00496B76 /* stats-emails-summary.json */,
+				7B859117F037432BB78618D6 /* stats-email-opens.json */,
 				436D56392118DE3B00CEAA33 /* supported-countries-success.json */,
 				436D56522121F60400CEAA33 /* supported-states-empty.json */,
 				436D563D2118E34D00CEAA33 /* supported-states-success.json */,
@@ -3297,6 +3303,7 @@
 				7434E1DE1F17C3C900C40DDB /* site-users-update-role-unknown-user-failure.json in Resources */,
 				4081977B221F153B00A298E4 /* stats-visits-week.json in Resources */,
 				01383F822BD556B100496B76 /* stats-emails-summary.json in Resources */,
+				7B859118F037432BB78618D6 /* stats-email-opens.json in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -3385,6 +3392,7 @@
 				40E7FEB722106A8D0032834E /* StatsCommentsInsight.swift in Sources */,
 				0C31499B2E2FFBA100AAF9DF /* StatsArchiveTimeIntervalData.swift in Sources */,
 				019C5B8B2BD59CE000A69DB0 /* StatsEmailsSummaryData.swift in Sources */,
+				11B3582786AD49E591C8615E /* StatsEmailOpensData.swift in Sources */,
 				9856BE962630B5C200C12FEB /* RemoteUser+Likes.swift in Sources */,
 				3FD634E52BC3A55F00CEDF5E /* WordPressOrgXMLRPCValidator.swift in Sources */,
 				3FE2E97B2BC3A332002CA2E1 /* WordPressAPIError+NSErrorBridge.swift in Sources */,