Add a page and number parameter

Updates the fetch followed sites API call in `ReaderTopicServiceRemote` to take two additional parameters, `page` and `number`. Author: Chris McGraw <[email protected]>
wordpress-mobile · Mar 29, 2024 · 70526db · 70526db
1 parent 69532b7
commit 70526db
Show file tree

Hide file tree

Showing 6 changed files with 452 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -72,6 +72,7 @@ _None._
 ### Internal Changes
 
 - Add WP.com theme type information. [#750]
+- Add `page` and `number` parameters to fetchFollowedSites in `ReaderTopicServiceRemote` [#753]
 
 ## 14.0.1
 

diff --git a/Sources/WordPressKit/Services/ReaderTopicServiceRemote.h b/Sources/WordPressKit/Services/ReaderTopicServiceRemote.h
@@ -19,13 +19,26 @@ extern NSString * const WordPressComReaderEndpointURL;
  failure:(void (^)(NSError *error))failure;
 
 /**
- Get a list of the sites the user follows.
+ Get a list of the sites the user follows with the default API parameters.
 
  @param success block called on a successful fetch.
  @param failure block called if there is any error. `error` can be any underlying network error.
  */
 - (void)fetchFollowedSitesWithSuccess:(void(^)(NSArray *sites))success
- failure:(void(^)(NSError *error))failure;
+ failure:(void(^)(NSError *error))failure DEPRECATED_MSG_ATTRIBUTE("Use fetchFollowedSitesForPage:number:success:failure: instead.");
+
+/**
+ Get a list of the sites the user follows with the specified API parameters.
+
+ @param page The page number to fetch.
+ @param number The number of sites to fetch per page.
+ @param success block called on a successful fetch.
+ @param failure block called if there is any error. `error` can be any underlying network error.
+ */
+- (void)fetchFollowedSitesForPage:(NSUInteger)page
+ number:(NSUInteger)number
+ success:(void(^)(NSNumber *totalSites, NSArray<RemoteReaderSiteInfo *> *sites))success
+ failure:(void(^)(NSError *error))failure;
 
 /**
  Unfollows the topic with the specified slug.

diff --git a/Sources/WordPressKit/Services/ReaderTopicServiceRemote.m b/Sources/WordPressKit/Services/ReaderTopicServiceRemote.m
@@ -61,7 +61,21 @@ - (void)fetchReaderMenuWithSuccess:(void (^)(NSArray *topics))success failure:(v
 
 - (void)fetchFollowedSitesWithSuccess:(void(^)(NSArray *sites))success failure:(void(^)(NSError *error))failure
 {
- NSString *path = @"read/following/mine?meta=site,feed";
+ void (^wrappedSuccess)(NSNumber *, NSArray<RemoteReaderSiteInfo *> *) = ^(NSNumber *totalSites, NSArray<RemoteReaderSiteInfo *> *sites) {
+ if (success) {
+ success(sites);
+ }
+ };
+
+ [self fetchFollowedSitesForPage:0 number:0 success:wrappedSuccess failure:failure];
+}
+
+- (void)fetchFollowedSitesForPage:(NSUInteger)page
+ number:(NSUInteger)number
+ success:(void(^)(NSNumber *totalSites, NSArray<RemoteReaderSiteInfo *> *sites))success
+ failure:(void(^)(NSError *error))failure
+{
+ NSString *path = [self pathForFollowedSitesWithPage:page number:number];
  NSString *requestUrl = [self pathForEndpoint:path
  withVersion:ServiceRemoteWordPressComRESTApiVersion_1_2];
 
@@ -70,14 +84,14 @@ - (void)fetchFollowedSitesWithSuccess:(void(^)(NSArray *sites))success failure:(
  return;
  }
  NSDictionary *response = (NSDictionary *)responseObject;
+ NSNumber *totalSites = [response numberForKey:@"total_subscriptions"];
  NSArray *subscriptions = [response arrayForKey:@"subscriptions"];
  NSMutableArray *sites = [NSMutableArray array];
  for (NSDictionary *dict in subscriptions) {
  RemoteReaderSiteInfo *siteInfo = [self siteInfoFromFollowedSiteDictionary:dict];
  [sites addObject:siteInfo];
  }
- success(sites);
-
+ success(totalSites, sites);
  } failure:^(NSError *error, NSHTTPURLResponse *httpResponse) {
  if (failure) {
  failure(error);
@@ -300,4 +314,17 @@ - (RemoteReaderTopic *)normalizeMenuTopicDictionary:(NSDictionary *)topicDict su
  return topic;
 }
 
+- (NSString *)pathForFollowedSitesWithPage:(NSUInteger)page number:(NSUInteger)number
+{
+ NSString *path = @"read/following/mine?meta=site,feed";
+ if (page > 0) {
+ path = [path stringByAppendingFormat:@"&page=%lu", (unsigned long)page];
+ }
+ if (number > 0) {
+ path = [path stringByAppendingFormat:@"&number=%lu", (unsigned long)number];
+ }
+
+ return path;
+}
+
 @end
diff --git a/Tests/WordPressKitTests/Mock Data/reader-following-mine.json b/Tests/WordPressKitTests/Mock Data/reader-following-mine.json
@@ -0,0 +1,153 @@
+{
+ "subscriptions": [
+ {
+ "ID": "764146175",
+ "blog_ID": "3584907",
+ "feed_ID": "25823",
+ "URL": "http://en.blog.wordpress.com",
+ "date_subscribed": "2024-03-05T20:48:52+00:00",
+ "delivery_methods": {
+ "email": {
+ "send_posts": true,
+ "send_comments": false,
+ "post_delivery_frequency": "instantly",
+ "date_subscribed": "2024-03-05 20:48:53"
+ },
+ "notification": {
+ "send_posts": false
+ }
+ },
+ "name": "WordPress.com News",
+ "organization_id": 0,
+ "unseen_count": 0,
+ "last_updated": "2024-03-07T15:00:00+00:00",
+ "site_icon": "https://secure.gravatar.com/blavatar/4d5d4c4006d86ff465780ec0d2671c0231c8536cc2fa8167aca8a4dd76811795",
+ "is_owner": false,
+ "meta": {
+ "links": {
+ "site": "https://public-api.wordpress.com/rest/v1.2/read/sites/3584907",
+ "feed": "https://public-api.wordpress.com/rest/v1.1/read/feed/25823"
+ },
+ "data": {
+ "site": {
+ "ID": 3584907,
+ "name": "WordPress.com News",
+ "description": "The latest news on WordPress.com and the WordPress community.",
+ "URL": "http://en.blog.wordpress.com",
+ "jetpack": false,
+ "jetpack_connection": false,
+ "post_count": 1728,
+ "subscribers_count": 104372237,
+ "lang": "en",
+ "icon": {
+ "img": "https://secure.gravatar.com/blavatar/4d5d4c4006d86ff465780ec0d2671c0231c8536cc2fa8167aca8a4dd76811795",
+ "ico": "https://secure.gravatar.com/blavatar/4d5d4c4006d86ff465780ec0d2671c0231c8536cc2fa8167aca8a4dd76811795"
+ },
+ "logo": {
+ "id": 0,
+ "sizes": [],
+ "url": ""
+ },
+ "visible": true,
+ "is_private": false,
+ "is_coming_soon": false,
+ "is_following": true,
+ "organization_id": 0,
+ "meta": {
+ "links": {
+ "self": "https://public-api.wordpress.com/rest/v1.2/sites/3584907",
+ "help": "https://public-api.wordpress.com/rest/v1.2/sites/3584907/help",
+ "posts": "https://public-api.wordpress.com/rest/v1.2/sites/3584907/posts/",
+ "comments": "https://public-api.wordpress.com/rest/v1.1/sites/3584907/comments/",
+ "xmlrpc": "https://en.blog.wordpress.com/xmlrpc.php"
+ }
+ },
+ "launch_status": false,
+ "site_migration": null,
+ "is_fse_active": false,
+ "is_fse_eligible": false,
+ "is_core_site_editor_enabled": false,
+ "is_wpcom_atomic": false,
+ "is_wpcom_staging_site": false,
+ "capabilities": {
+ "edit_pages": false,
+ "edit_posts": false,
+ "edit_others_posts": false,
+ "edit_theme_options": false,
+ "list_users": false,
+ "manage_categories": false,
+ "manage_options": false,
+ "publish_posts": false,
+ "upload_files": false,
+ "view_stats": false
+ },
+ "is_multi_author": true,
+ "feed_ID": 25823,
+ "feed_URL": "http://en.blog.wordpress.com",
+ "header_image": false,
+ "owner": {
+ "ID": 26957695,
+ "login": "a8cuser",
+ "name": "Automattic",
+ "first_name": "Automattic",
+ "last_name": "",
+ "nice_name": "a8cuser",
+ "URL": "",
+ "avatar_URL": "https://1.gravatar.com/avatar/48e997e4a437d5002ae4c1eff741b37c2f4e1cad14d45f173ae78c25a0c41a38?s=96&d=retro",
+ "profile_URL": "https://gravatar.com/a8cuser",
+ "ip_address": false,
+ "site_visible": true,
+ "has_avatar": true
+ },
+ "subscription": {
+ "delivery_methods": {
+ "email": {
+ "send_posts": true,
+ "send_comments": false,
+ "post_delivery_frequency": "instantly",
+ "date_subscribed": "2024-03-05 20:48:53"
+ },
+ "notification": {
+ "send_posts": false
+ }
+ }
+ },
+ "is_blocked": false,
+ "unseen_count": 0
+ },
+ "feed": {
+ "blog_ID": "3584907",
+ "feed_ID": "25823",
+ "name": "WordPress.com News",
+ "URL": "http://en.blog.wordpress.com/",
+ "feed_URL": "http://en.blog.wordpress.com",
+ "subscribers_count": 104372237,
+ "is_following": true,
+ "last_update": "2024-03-07T15:00:00+00:00",
+ "last_checked": "2024-03-07T17:08:35+00:00",
+ "marked_for_refresh": false,
+ "next_refresh_time": null,
+ "organization_id": 0,
+ "unseen_count": 0,
+ "meta": {
+ "links": {
+ "self": "https://public-api.wordpress.com/rest/v1.1/read/feed/25823",
+ "site": "https://public-api.wordpress.com/rest/v1.1/read/sites/3584907"
+ }
+ },
+ "image": "http://0.gravatar.com/blavatar/4d5d4c4006d86ff465780ec0d2671c0231c8536cc2fa8167aca8a4dd76811795?s=96&amp;d=http%3A%2F%2Fs0.wp.com%2Fi%2Fbuttonw-com.png",
+ "description": "The latest news on WordPress.com and the WordPress community.",
+ "subscription_id": 764146175
+ }
+ }
+ },
+ "is_wpforteams_site": false,
+ "is_paid_subscription": false,
+ "is_rss": false,
+ "is_gift": false
+ }
+ ],
+ "page": 1,
+ "number": 1,
+ "total_subscriptions": 1
+}