Skip to content
This repository was archived by the owner on Sep 15, 2025. It is now read-only.

Add support for fetching detail stats for specific post #102

Merged
merged 3 commits into from
Feb 22, 2019
Merged

Add support for fetching detail stats for specific post #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe9e21f
Add support for fetching detail stats for specific post
jklausa Feb 22, 2019
4908722
Merge branch 'develop' into feature/stats-fetch-post-details
jklausa Feb 22, 2019
0f98a2c
fix broken merge
jklausa Feb 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions WordPressKit.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,17 @@
404057DC221C9FD80060250C /* stats-referrer-data.json in Resources */ = {isa = PBXBuildFile; fileRef = 404057DB221C9FD70060250C /* stats-referrer-data.json */; };
4041405E220F9EF500CF7C5B /* StatsDotComFollowersInsight.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4041405D220F9EF500CF7C5B /* StatsDotComFollowersInsight.swift */; };
40414060220F9F1F00CF7C5B /* StatsAllTimesInsight.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4041405F220F9F1F00CF7C5B /* StatsAllTimesInsight.swift */; };
40819778221F00E600A298E4 /* SummaryStatsType.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40819777221F00E600A298E4 /* SummaryStatsType.swift */; };
4081977B221F153B00A298E4 /* stats-visits-week.json in Resources */ = {isa = PBXBuildFile; fileRef = 40819779221F153A00A298E4 /* stats-visits-week.json */; };
4081977C221F153B00A298E4 /* stats-visits-day.json in Resources */ = {isa = PBXBuildFile; fileRef = 4081977A221F153A00A298E4 /* stats-visits-day.json */; };
4081977E221F269A00A298E4 /* stats-visits-month.json in Resources */ = {isa = PBXBuildFile; fileRef = 4081977D221F269A00A298E4 /* stats-visits-month.json */; };
4081976F221DDE9B00A298E4 /* PostsStatsType.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4081976E221DDE9B00A298E4 /* PostsStatsType.swift */; };
40819771221DFDB700A298E4 /* stats-posts-data.json in Resources */ = {isa = PBXBuildFile; fileRef = 40819770221DFDB600A298E4 /* stats-posts-data.json */; };
40819773221E10C900A298E4 /* PublishedPostsStatsType.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40819772221E10C900A298E4 /* PublishedPostsStatsType.swift */; };
40819775221E497D00A298E4 /* stats-published-posts.json in Resources */ = {isa = PBXBuildFile; fileRef = 40819774221E497C00A298E4 /* stats-published-posts.json */; };
40819778221F00E600A298E4 /* SummaryStatsType.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40819777221F00E600A298E4 /* SummaryStatsType.swift */; };
4081977B221F153B00A298E4 /* stats-visits-week.json in Resources */ = {isa = PBXBuildFile; fileRef = 40819779221F153A00A298E4 /* stats-visits-week.json */; };
4081977C221F153B00A298E4 /* stats-visits-day.json in Resources */ = {isa = PBXBuildFile; fileRef = 4081977A221F153A00A298E4 /* stats-visits-day.json */; };
4081977E221F269A00A298E4 /* stats-visits-month.json in Resources */ = {isa = PBXBuildFile; fileRef = 4081977D221F269A00A298E4 /* stats-visits-month.json */; };
40819783221F5C8200A298E4 /* StatsPostDetails.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40819782221F5C8200A298E4 /* StatsPostDetails.swift */; };
40819785221F74B200A298E4 /* stats-post-details.json in Resources */ = {isa = PBXBuildFile; fileRef = 40819784221F74B200A298E4 /* stats-post-details.json */; };
408197882220A35000A298E4 /* StatsLastPostInsight.swift in Sources */ = {isa = PBXBuildFile; fileRef = 408197872220A35000A298E4 /* StatsLastPostInsight.swift */; };
40A71C6E220E1D8E002E3D25 /* StatsServiceRemoteV2.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40A71C6D220E1D8E002E3D25 /* StatsServiceRemoteV2.swift */; };
40AB1ADA200FED25009B533D /* PluginDirectoryFeedPage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40AB1AD9200FED25009B533D /* PluginDirectoryFeedPage.swift */; };
40E4698B2017C2840030DB5F /* plugin-directory-popular.json in Resources */ = {isa = PBXBuildFile; fileRef = 40E4698A2017C2840030DB5F /* plugin-directory-popular.json */; };
Expand Down Expand Up @@ -473,7 +476,6 @@
E6C1E8491EF21FC100D139D9 /* is-passwordless-account-no-account-found.json in Resources */ = {isa = PBXBuildFile; fileRef = E6C1E8471EF21FC100D139D9 /* is-passwordless-account-no-account-found.json */; };
E6C1E84A1EF21FC100D139D9 /* is-passwordless-account-success.json in Resources */ = {isa = PBXBuildFile; fileRef = E6C1E8481EF21FC100D139D9 /* is-passwordless-account-success.json */; };
E6D0EE621F7EF9CE0064D3FC /* AccountServiceRemoteREST+SocialService.swift in Sources */ = {isa = PBXBuildFile; fileRef = E6D0EE611F7EF9CE0064D3FC /* AccountServiceRemoteREST+SocialService.swift */; };
F96E0643221E15A9008E7D97 /* StatsLastPostInsight.swift in Sources */ = {isa = PBXBuildFile; fileRef = F96E0642221E15A9008E7D97 /* StatsLastPostInsight.swift */; };
FF20AD2220B8471A00082398 /* WordPressKit.podspec in Resources */ = {isa = PBXBuildFile; fileRef = FF20AD2120B8471A00082398 /* WordPressKit.podspec */; };
FFE247A720C891D1002DF3A2 /* WordPressComOAuthTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = FFE247A620C891D1002DF3A2 /* WordPressComOAuthTests.swift */; };
FFE247AF20C891E6002DF3A2 /* WordPressComOAuthWrongPasswordFail.json in Resources */ = {isa = PBXBuildFile; fileRef = FFE247A820C891E5002DF3A2 /* WordPressComOAuthWrongPasswordFail.json */; };
Expand Down Expand Up @@ -525,14 +527,17 @@
404057DB221C9FD70060250C /* stats-referrer-data.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "stats-referrer-data.json"; sourceTree = "<group>"; };
4041405D220F9EF500CF7C5B /* StatsDotComFollowersInsight.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatsDotComFollowersInsight.swift; sourceTree = "<group>"; };
4041405F220F9F1F00CF7C5B /* StatsAllTimesInsight.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatsAllTimesInsight.swift; sourceTree = "<group>"; };
40819777221F00E600A298E4 /* SummaryStatsType.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SummaryStatsType.swift; sourceTree = "<group>"; };
40819779221F153A00A298E4 /* stats-visits-week.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "stats-visits-week.json"; sourceTree = "<group>"; };
4081977A221F153A00A298E4 /* stats-visits-day.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "stats-visits-day.json"; sourceTree = "<group>"; };
4081977D221F269A00A298E4 /* stats-visits-month.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "stats-visits-month.json"; sourceTree = "<group>"; };
4081976E221DDE9B00A298E4 /* PostsStatsType.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PostsStatsType.swift; sourceTree = "<group>"; };
40819770221DFDB600A298E4 /* stats-posts-data.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "stats-posts-data.json"; sourceTree = "<group>"; };
40819772221E10C900A298E4 /* PublishedPostsStatsType.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PublishedPostsStatsType.swift; sourceTree = "<group>"; };
40819774221E497C00A298E4 /* stats-published-posts.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "stats-published-posts.json"; sourceTree = "<group>"; };
40819777221F00E600A298E4 /* SummaryStatsType.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SummaryStatsType.swift; sourceTree = "<group>"; };
40819779221F153A00A298E4 /* stats-visits-week.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "stats-visits-week.json"; sourceTree = "<group>"; };
4081977A221F153A00A298E4 /* stats-visits-day.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "stats-visits-day.json"; sourceTree = "<group>"; };
4081977D221F269A00A298E4 /* stats-visits-month.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "stats-visits-month.json"; sourceTree = "<group>"; };
40819782221F5C8200A298E4 /* StatsPostDetails.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatsPostDetails.swift; sourceTree = "<group>"; };
40819784221F74B200A298E4 /* stats-post-details.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "stats-post-details.json"; sourceTree = "<group>"; };
408197872220A35000A298E4 /* StatsLastPostInsight.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = StatsLastPostInsight.swift; sourceTree = "<group>"; };
40A71C6D220E1D8E002E3D25 /* StatsServiceRemoteV2.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatsServiceRemoteV2.swift; sourceTree = "<group>"; };
40AB1AD9200FED25009B533D /* PluginDirectoryFeedPage.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PluginDirectoryFeedPage.swift; sourceTree = "<group>"; };
40E4698A2017C2840030DB5F /* plugin-directory-popular.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "plugin-directory-popular.json"; sourceTree = "<group>"; };
Expand Down Expand Up @@ -980,7 +985,6 @@
E6D0EE611F7EF9CE0064D3FC /* AccountServiceRemoteREST+SocialService.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "AccountServiceRemoteREST+SocialService.swift"; sourceTree = "<group>"; };
ED05C8FF3E61D93CE5BA527E /* Pods_WordPressKitTests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_WordPressKitTests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
EFF80A6E6EE37118CB1DA158 /* Pods_WordPressKit.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_WordPressKit.framework; sourceTree = BUILT_PRODUCTS_DIR; };
F96E0642221E15A9008E7D97 /* StatsLastPostInsight.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatsLastPostInsight.swift; sourceTree = "<group>"; };
FF20AD2120B8471A00082398 /* WordPressKit.podspec */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = WordPressKit.podspec; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.ruby; };
FFE247A620C891D1002DF3A2 /* WordPressComOAuthTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = WordPressComOAuthTests.swift; sourceTree = "<group>"; };
FFE247A820C891E5002DF3A2 /* WordPressComOAuthWrongPasswordFail.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = WordPressComOAuthWrongPasswordFail.json; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1048,7 +1052,7 @@
40414061220F9F2800CF7C5B /* Insights */ = {
isa = PBXGroup;
children = (
F96E0642221E15A9008E7D97 /* StatsLastPostInsight.swift */,
408197872220A35000A298E4 /* StatsLastPostInsight.swift */,
4041405D220F9EF500CF7C5B /* StatsDotComFollowersInsight.swift */,
40E7FEA8220FA4050032834E /* StatsEmailFollowersInsight.swift */,
4041405F220F9F1F00CF7C5B /* StatsAllTimesInsight.swift */,
Expand All @@ -1067,6 +1071,7 @@
children = (
404057C3221B30140060250C /* Time-based data */,
40414061220F9F2800CF7C5B /* Insights */,
40819782221F5C8200A298E4 /* StatsPostDetails.swift */,
);
name = V2;
sourceTree = "<group>";
Expand Down Expand Up @@ -1559,6 +1564,7 @@
93BD27421EE73384002BB00B /* Mock Data */ = {
isa = PBXGroup;
children = (
40819784221F74B200A298E4 /* stats-post-details.json */,
4081977A221F153A00A298E4 /* stats-visits-day.json */,
4081977D221F269A00A298E4 /* stats-visits-month.json */,
40819779221F153A00A298E4 /* stats-visits-week.json */,
Expand Down Expand Up @@ -2017,6 +2023,7 @@
93BD275C1EE73442002BB00B /* is-available-username-success.json in Resources */,
93AC8ED81ED32FD000900F5A /* stats-v1.1-top-posts-day.json in Resources */,
74D67F331F15C3740010C5ED /* site-users-delete-auth-failure.json in Resources */,
40819785221F74B200A298E4 /* stats-post-details.json in Resources */,
436D563A2118DE3B00CEAA33 /* supported-countries-success.json in Resources */,
740B23E71F17FB4200067A2A /* xmlrpc-metaweblog-newpost-success.xml in Resources */,
74FC6F411F191C1D00112505 /* notifications-last-seen.json in Resources */,
Expand Down Expand Up @@ -2286,6 +2293,7 @@
7430C9B41F1927C50051B8E6 /* RemoteReaderSite.m in Sources */,
74585B8E1F0D51A100E7E667 /* DomainsServiceRemote.swift in Sources */,
7430C9A41F1927180051B8E6 /* ReaderPostServiceRemote.m in Sources */,
408197882220A35000A298E4 /* StatsLastPostInsight.swift in Sources */,
74E2294E1F1E73FE0085F7F2 /* RemotePublicizeService.swift in Sources */,
9F3E0BA22087345F009CB5BA /* ServiceRequest.swift in Sources */,
E1A6605F1FD694ED00BAC339 /* PluginDirectoryEntry.swift in Sources */,
Expand Down Expand Up @@ -2344,7 +2352,6 @@
93F50A381F226B9300B5BEBA /* WordPressComServiceRemote.m in Sources */,
9F4E52002088E38200424676 /* ObjectValidation.swift in Sources */,
7430C9B81F1927C50051B8E6 /* RemoteReaderTopic.m in Sources */,
F96E0643221E15A9008E7D97 /* StatsLastPostInsight.swift in Sources */,
7403A3021EF0726E00DED7DC /* AccountSettings.swift in Sources */,
40E7FEA9220FA4060032834E /* StatsEmailFollowersInsight.swift in Sources */,
404057DA221C9D560060250C /* ReferrerStatsType.swift in Sources */,
Expand All @@ -2361,6 +2368,7 @@
93BD27831EE73944002BB00B /* WordPressRSDParser.swift in Sources */,
7328420421CD786C00126755 /* WordPressComServiceRemote+SiteCreation.swift in Sources */,
826016F31F9FA17B00533B6C /* Activity.swift in Sources */,
40819783221F5C8200A298E4 /* StatsPostDetails.swift in Sources */,
7397F01A220A072500C723F3 /* ActivityServiceRemote_ApiVersion1_0.swift in Sources */,
40E7FEB1220FB3B60032834E /* StatsAnnualAndMostPopularTimeInsight.swift in Sources */,
7E3E7A4A20E443890075D159 /* Scanner+extensions.swift in Sources */,
Expand Down
148 changes: 148 additions & 0 deletions WordPressKit/StatsPostDetails.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
public struct StatsPostDetails {
public let fetchedDate: Date
public let totalViewsCount: Int

public let recentWeeks: [StatsWeeklyBreakdown]
public let dailyAveragesPerMonth: [StatsPostViews]
public let monthlyBreakdown: [StatsPostViews]
public let lastTwoWeeks: [StatsPostViews]
}

public struct StatsWeeklyBreakdown {
public let startDay: DateComponents
public let endDay: DateComponents

public let totalViewsCount: Int
public let averageViewsCount: Int
public let changePercentage: Double

public let days: [StatsPostViews]
}

public struct StatsPostViews {
public let period: StatsPeriodUnit
public let date: DateComponents
public let viewsCount: Int
}

extension StatsPostDetails {
init?(jsonDictionary: [String: AnyObject]) {
guard
let fetchedDateString = jsonDictionary["date"] as? String,
let date = type(of: self).dateFormatter.date(from: fetchedDateString),
let totalViewsCount = jsonDictionary["views"] as? Int,
let monthlyBreakdown = jsonDictionary["years"] as? [String: AnyObject],
let monthlyAverages = jsonDictionary["averages"] as? [String: AnyObject],
let recentWeeks = jsonDictionary["weeks"] as? [[String: AnyObject]],
let data = jsonDictionary["data"] as? [[Any]]
else {
return nil
}

self.fetchedDate = date
self.totalViewsCount = totalViewsCount

// It's very hard to describe the format of this response. I tried to make the parsing
// as nice and readable as possible, but in all honestly it's still pretty nasty.
// If you want to see an example response to see how weird this response is, check out
// `stats-post-details.json`.
self.recentWeeks = StatsPostViews.mapWeeklyBreakdown(jsonDictionary: recentWeeks)
self.monthlyBreakdown = StatsPostViews.mapMonthlyBreakdown(jsonDictionary: monthlyBreakdown)
self.dailyAveragesPerMonth = StatsPostViews.mapMonthlyBreakdown(jsonDictionary: monthlyAverages)
self.lastTwoWeeks = StatsPostViews.mapDailyData(data: Array(data.suffix(14)))
}

static var dateFormatter: DateFormatter {
let df = DateFormatter()
df.locale = Locale(identifier: "en_US_POS")
df.dateFormat = "yyyy-MM-dd"
return df
}
}

extension StatsPostViews {
static func mapMonthlyBreakdown(jsonDictionary: [String: AnyObject]) -> [StatsPostViews] {
return jsonDictionary.flatMap { yearKey, value -> [StatsPostViews] in
guard
let yearInt = Int(yearKey),
let monthsDict = value as? [String: AnyObject],
let months = monthsDict["months"] as? [String: Int]
else {
return []
}

return months.compactMap { monthKey, value in
guard
let month = Int(monthKey)
else {
return nil
}

return StatsPostViews(period: .month,
date: DateComponents(year: yearInt, month: month),
viewsCount: value)
}
}
}
}

extension StatsPostViews {
static func mapWeeklyBreakdown(jsonDictionary: [[String: AnyObject]]) -> [StatsWeeklyBreakdown] {
return jsonDictionary.compactMap {
guard
let totalViews = $0["total"] as? Int,
let averageViews = $0["average"] as? Int,
let days = $0["days"] as? [[String: AnyObject]]
else {
return nil
}

let change = ($0["change"] as? Double) ?? 0.0

let mappedDays: [StatsPostViews] = days.compactMap {
guard
let dayString = $0["day"] as? String,
let date = StatsPostDetails.dateFormatter.date(from: dayString),
let viewsCount = $0["count"] as? Int
else {
return nil
}

return StatsPostViews(period: .day,
date: Calendar.autoupdatingCurrent.dateComponents([.year, .month, .day], from: date),
viewsCount: viewsCount)
}

guard !mappedDays.isEmpty else {
return nil
}


return StatsWeeklyBreakdown(startDay: mappedDays.first!.date,
endDay: mappedDays.last!.date,
totalViewsCount: totalViews,
averageViewsCount: averageViews,
changePercentage: change,
days: mappedDays)
}

}
}

extension StatsPostViews {
static func mapDailyData(data: [[Any]]) -> [StatsPostViews] {
return data.compactMap {
guard
let dateString = $0[0] as? String,
let date = StatsPostDetails.dateFormatter.date(from: dateString),
let viewsCount = $0[1] as? Int
else {
return nil
}

return StatsPostViews(period: .day,
date: Calendar.autoupdatingCurrent.dateComponents([.year, .month, .day], from: date),
viewsCount: viewsCount)
}
}
}
18 changes: 18 additions & 0 deletions WordPressKit/StatsServiceRemoteV2.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,24 @@ public class StatsServiceRemoteV2: ServiceRemoteWordPressComREST {
completion(nil, error)
})
}

public func getDetails(forPostID postID: Int, completion: @escaping ((StatsPostDetails?, Error?) -> Void)) {
let path = self.path(forEndpoint: "sites/\(siteID)/post/\(postID)/", withVersion: ._1_1)

wordPressComRestApi.GET(path, parameters: [:], success: { (response, _) in
guard
let jsonResponse = response as? [String: AnyObject],
let postDetails = StatsPostDetails(jsonDictionary: jsonResponse)
else {
completion(nil, ResponseError.decodingFailure)
return
}

completion(postDetails, nil)
}, failure: { (error, _) in
completion(nil, error)
})
}
}

// MARK: - StatsLastPostInsight-specific hack
Expand Down
Loading