Download inbox messages (#416)

* exposing download inbox messages method

* unit tests added

Author: dejan2k

Example/Tests/Classes/LPInboxTest.m

@@ -484,4 +484,63 @@ -(void)loadInbox:(void (^)(void))finishBlock
     [[Leanplum inbox] downloadMessages];
 }
 
+- (void)testDownloadMessages
+{
+    // Do not need to fetch images
+    // Prefetching will trigger downloadFile requests
+    [[Leanplum inbox] disableImagePrefetching];
+    // Ensure errors are thrown
+    [LeanplumHelper mockThrowErrorToThrow];
+    
+    id<HTTPStubsDescriptor> getNewsfeedMessagesStub = [HTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest * _Nonnull request) {
+        return [request.URL.host isEqualToString:API_HOST];
+    } withStubResponse:^HTTPStubsResponse * _Nonnull(NSURLRequest *request) {
+        NSString *response_file = OHPathForFile(@"newsfeed_response.json", self.class);
+        return [HTTPStubsResponse responseWithFileAtPath:response_file
+                                                statusCode:200
+                                                   headers:@{@"Content-Type":@"application/json"}];
+    }];
+    
+    dispatch_semaphore_t semaphor = dispatch_semaphore_create(0);
+    [[Leanplum inbox] onChanged:^{
+        [HTTPStubs removeStub:getNewsfeedMessagesStub];
+        dispatch_semaphore_signal(semaphor);
+    }];
+    
+    [LeanplumHelper setup_development_test];
+    [[Leanplum inbox] downloadMessages];
+    
+    long timedOut = dispatch_semaphore_wait(semaphor, [LeanplumHelper default_dispatch_time]);
+    XCTAssertTrue(timedOut == 0);
+}
+
+- (void)testDownloadMessagesWithCompletionHandler
+{
+    // Do not need to fetch images
+    // Prefetching will trigger downloadFile requests
+    [[Leanplum inbox] disableImagePrefetching];
+    // Ensure errors are thrown
+    [LeanplumHelper mockThrowErrorToThrow];
+    
+    id<HTTPStubsDescriptor> getNewsfeedMessagesStub = [HTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest * _Nonnull request) {
+        return [request.URL.host isEqualToString:API_HOST];
+    } withStubResponse:^HTTPStubsResponse * _Nonnull(NSURLRequest *request) {
+        NSString *response_file = OHPathForFile(@"newsfeed_response.json", self.class);
+        return [HTTPStubsResponse responseWithFileAtPath:response_file
+                                                statusCode:200
+                                                   headers:@{@"Content-Type":@"application/json"}];
+    }];
+    
+    dispatch_semaphore_t semaphor = dispatch_semaphore_create(0);
+    
+    [LeanplumHelper setup_development_test];
+    [[Leanplum inbox] downloadMessages:^(BOOL success) {
+        [HTTPStubs removeStub:getNewsfeedMessagesStub];
+        dispatch_semaphore_signal(semaphor);
+    }];
+    
+    long timedOut = dispatch_semaphore_wait(semaphor, [LeanplumHelper default_dispatch_time]);
+    XCTAssertTrue(timedOut == 0);
+}
+
 @end

Leanplum-SDK/Classes/Features/Inbox/LPInbox.m

@@ -404,18 +404,28 @@ - (void)triggerInboxChanged
     LP_END_USER_CODE
 }
 
-- (void)triggerInboxSyncedWithStatus:(BOOL)success
+- (void)triggerInboxSyncedWithStatus:(BOOL)success withCompletionHandler:(nullable LeanplumInboxSyncedBlock)completionHandler
 {
     LP_BEGIN_USER_CODE
-    for (LeanplumInboxSyncedBlock block in _inboxSyncedBlocks.copy) {
-        block(success);
+    if (completionHandler != nil)
+    {
+        completionHandler(success);
+    } else {
+        for (LeanplumInboxSyncedBlock block in _inboxSyncedBlocks.copy) {
+            block(success);
+        }
     }
     LP_END_USER_CODE
 }
 
 #pragma mark - LPInbox methods
 
 - (void)downloadMessages
+{
+    [self downloadMessages:nil];
+}
+
+- (void)downloadMessages:(LeanplumInboxSyncedBlock)completionHandler
 {
     RETURN_IF_NOOP;
     LP_TRY
@@ -460,17 +470,17 @@ - (void)downloadMessages
             [Leanplum onceVariablesChangedAndNoDownloadsPending:^{
                 LP_END_USER_CODE
                 [self updateMessages:messages unreadCount:unreadCount];
-                [self triggerInboxSyncedWithStatus:YES];
+                [self triggerInboxSyncedWithStatus:YES withCompletionHandler:completionHandler];
                 LP_BEGIN_USER_CODE
             }];
         } else {
             [self updateMessages:messages unreadCount:unreadCount];
-            [self triggerInboxSyncedWithStatus:YES];
+            [self triggerInboxSyncedWithStatus:YES withCompletionHandler:completionHandler];
         }
         LP_END_TRY
     }];
     [request onError:^(NSError *error) {
-        [self triggerInboxSyncedWithStatus:NO];
+        [self triggerInboxSyncedWithStatus:NO withCompletionHandler:completionHandler];
     }];
     [[LPRequestSender sharedInstance] send:request];
     LP_END_TRY

Leanplum-SDK/Classes/Internal/Leanplum.m

@@ -2425,7 +2425,7 @@ + (void)forceContentUpdate:(LeanplumVariablesChangedBlock)block
         if ([response[LP_KEY_SYNC_INBOX] boolValue]) {
             [[self inbox] downloadMessages];
         } else {
-            [[self inbox] triggerInboxSyncedWithStatus:YES];
+            [[self inbox] triggerInboxSyncedWithStatus:YES withCompletionHandler:nil];
         }
         LP_END_TRY
         if (block) {
@@ -2436,7 +2436,7 @@ + (void)forceContentUpdate:(LeanplumVariablesChangedBlock)block
         if (block) {
             block();
         }
-        [[self inbox] triggerInboxSyncedWithStatus:NO];
+        [[self inbox] triggerInboxSyncedWithStatus:NO withCompletionHandler:nil];
     }];
     [[LPRequestSender sharedInstance] send:request];
     LP_END_TRY

Leanplum-SDK/Classes/Internal/LeanplumInternal.h

@@ -137,7 +137,7 @@ typedef void (^LeanplumInboxCacheUpdateBlock)(void);
 - (void)removeMessageForId:(NSString *)messageId;
 - (void)reset;
 - (void)triggerInboxChanged;
-- (void)triggerInboxSyncedWithStatus:(BOOL)success;
+- (void)triggerInboxSyncedWithStatus:(BOOL)success withCompletionHandler:(nullable LeanplumInboxSyncedBlock)completionHandler;
 
 @end
 

Leanplum-SDK/Classes/LPInbox.h

@@ -173,6 +173,15 @@ NS_SWIFT_NAME(onInboxChanged(completion:));
  */
 - (void)onForceContentUpdate:(LeanplumInboxSyncedBlock)block;
 
+/**
+ Forces downloading of inbox messages from the server. After messages are downloaded the appropriate callbacks will fire.
+ */
+- (void)downloadMessages;
+/**
+ Forces downloading of inbox messages from the server. After messages are downloaded the appropriate callbacks will fire.
+ @param completionHandler  The callback to invoke when messages are downloaded.
+ */
+- (void)downloadMessages:(nullable LeanplumInboxSyncedBlock)completionHandler;
 /**
  @{
  * Adds a responder to be executed when an event happens.