add callback on message displayed (#225)

Author: e7mac

Example/Tests/Classes/LeanplumTest.m

@@ -25,6 +25,7 @@
 
 #import <XCTest/XCTest.h>
 #import <UIKit/UIKit.h>
+#import <OCMock/OCMock.h>
 #import <OHHTTPStubs/OHHTTPStubs.h>
 #import <OHHTTPStubs/OHPathHelpers.h>
 #import "LeanplumHelper.h"
@@ -46,6 +47,7 @@ @interface Leanplum (Test)
 
 + (NSSet<NSString *> *)parseEnabledCountersFromResponse:(NSDictionary *)response;
 + (NSSet<NSString *> *)parseEnabledFeatureFlagsFromResponse:(NSDictionary *)response;
++ (void)triggerMessageDisplayed:(LPActionContext *)context;
 
 @end
 
@@ -1781,4 +1783,40 @@ - (void)on_start_response:(BOOL) success
     XCTAssertTrue(success);
 }
 
+/**
+ * Test that method triggerMessageDisplayed calls user defined callback
+ */
+-(void)test_triggerMessageDisplayedCallsCallback
+{
+    __block BOOL blockCalled = NO;
+
+    NSString *messageID = @"testMessageID";
+    NSString *messageBody = @"testMessageBody";
+    NSString *recipientUserID = @"recipientUserID";
+
+    LPActionContext *actionContext = [[LPActionContext alloc] init];
+    id actionContextMock = OCMPartialMock(actionContext);
+
+    OCMStub([actionContextMock messageId]).andReturn(messageID);
+    OCMStub([actionContextMock args]).andReturn(@{@"Message":messageBody});
+
+    id leanplumMock = OCMClassMock([Leanplum class]);
+    OCMStub([leanplumMock userId]).andReturn(recipientUserID);
+
+    LeanplumMessageDisplayedCallbackBlock block =
+    ^void(LPMessageArchiveData *messageArchiveData) {
+        blockCalled = YES;
+        XCTAssertEqual(messageArchiveData.messageID, messageID);
+        XCTAssertEqual(messageArchiveData.messageBody, messageBody);
+        XCTAssertEqual(messageArchiveData.recipientUserID, recipientUserID);
+        NSDate *now = [NSDate date];
+        NSTimeInterval interval = [now timeIntervalSinceDate:messageArchiveData.deliveryDateTime];
+        XCTAssertTrue(interval < 1000);
+    };
+    [Leanplum onMessageDisplayed:block];
+    [Leanplum triggerMessageDisplayed:actionContext];
+
+    XCTAssertTrue(blockCalled);
+}
+
 @end

Leanplum-SDK/Classes/Internal/LPInternalState.h

@@ -13,7 +13,7 @@
 
 @property(strong, nonatomic) NSMutableArray *startBlocks, *variablesChangedBlocks,
 *interfaceChangedBlocks, *eventsChangedBlocks, *noDownloadsBlocks, *onceNoDownloadsBlocks,
-*startIssuedBlocks;
+*startIssuedBlocks, *messageDisplayedBlocks;
 @property(strong, nonatomic) NSMutableDictionary *actionBlocks, *actionResponders;
 @property(strong, nonatomic) NSMutableSet *startResponders, *variablesChangedResponders,
 *interfaceChangedResponders, *eventsChangedResponders, *noDownloadsResponders;

Leanplum-SDK/Classes/Internal/LPInternalState.m

@@ -26,6 +26,7 @@ - (id)init {
         _eventsChangedBlocks = nil;
         _noDownloadsBlocks = nil;
         _onceNoDownloadsBlocks = nil;
+        _messageDisplayedBlocks = nil;
         _actionBlocks = nil;
         _actionResponders = nil;
         _startResponders = nil;

Leanplum-SDK/Classes/Internal/Leanplum.m

@@ -507,6 +507,29 @@ + (void)triggerVariablesChangedAndNoDownloadsPending
     LP_END_USER_CODE
 }
 
++ (void)triggerMessageDisplayed:(LPActionContext *)context
+{
+    LP_BEGIN_USER_CODE
+    NSString *messageID = context.messageId;
+    NSString *messageKey = @"Message";
+    NSString *messageBody = @"";
+    if ([context.args valueForKey:messageKey]) {
+        messageBody = [context.args valueForKey:messageKey];
+    }
+    NSString *recipientUserID = [Leanplum userId];
+    NSDate *deliveryDateTime = [NSDate date];
+    for (LeanplumMessageDisplayedCallbackBlock block in [LPInternalState sharedState]
+         .messageDisplayedBlocks.copy) {
+        LPMessageArchiveData *messageArchiveData = [[LPMessageArchiveData alloc]
+                                                    initWithMessageID: messageID
+                                                    messageBody:messageBody
+                                                    recipientUserID:recipientUserID
+                                                    deliveryDateTime:deliveryDateTime];
+        block(messageArchiveData);
+    }
+    LP_END_USER_CODE
+}
+
 + (void)triggerAction:(LPActionContext *)context
 {
     [self triggerAction:context handledBlock:nil];
@@ -534,6 +557,9 @@ + (void)triggerAction:(LPActionContext *)context handledBlock:(LeanplumHandledBl
 
         if (handledBlock) {
             handledBlock(handled);
+            if (handled) {
+                [Leanplum triggerMessageDisplayed:context];
+            }
         }
     };
 
@@ -1477,6 +1503,21 @@ + (void)onceVariablesChangedAndNoDownloadsPending:(LeanplumVariablesChangedBlock
     }
 }
 
+
++ (void)onMessageDisplayed:(LeanplumMessageDisplayedCallbackBlock)block {
+    if (!block) {
+        [self throwError:@"[Leanplum onMessageDisplayed:] Nil block "
+         @"parameter provided."];
+        return;
+    }
+    LP_TRY
+    if (![LPInternalState sharedState].messageDisplayedBlocks) {
+        [LPInternalState sharedState].messageDisplayedBlocks = [NSMutableArray array];
+    }
+    [[LPInternalState sharedState].messageDisplayedBlocks addObject:[block copy]];
+    LP_END_TRY
+}
+
 + (void)clearUserContent {
     [[LPVarCache sharedCache] clearUserContent];
     [[LPCountAggregator sharedAggregator] incrementCount:@"clear_user_content"];

Leanplum-SDK/Classes/Leanplum.h

@@ -27,6 +27,7 @@
 #import "LPActionArg.h"
 #import "LPActionContext.h"
 #import "LPVar.h"
+#import "LPMessageArchiveData.h"
 
 #ifndef LP_NOT_TV
 #if (!defined(TARGET_OS_TV) || !TARGET_OS_TV)
@@ -371,6 +372,13 @@ typedef enum {
  */
 + (void)onceVariablesChangedAndNoDownloadsPending:(LeanplumVariablesChangedBlock)block;
 
+typedef void (^LeanplumMessageDisplayedCallbackBlock)(LPMessageArchiveData *messageArchiveData);
+
+/**
+ * Block to call when a message is displayed to the user.
+ */
++ (void)onMessageDisplayed:(LeanplumMessageDisplayedCallbackBlock)block;
+
 /**
  * Clears cached values for messages, variables and test assignments.
  * Use sparingly as if the app is updated, you'll have to deal with potentially

Leanplum-SDK/Classes/Models/LPMessageArchiveData.h

@@ -0,0 +1,43 @@
+//
+//  LPMessageArchiveData.h
+//  Leanplum iOS SDK Version 2.0.6
+//
+//  Copyright (c) 2012 Leanplum, Inc. All rights reserved.
+//
+//  Licensed to the Apache Software Foundation (ASF) under one
+//  or more contributor license agreements.  See the NOTICE file
+//  distributed with this work for additional information
+//  regarding copyright ownership.  The ASF licenses this file
+//  to you under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing,
+//  software distributed under the License is distributed on an
+//  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+//  KIND, either express or implied.  See the License for the
+//  specific language governing permissions and limitations
+//  under the License.
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface LPMessageArchiveData : NSObject
+
+-(instancetype)init NS_UNAVAILABLE;
+-(instancetype)initWithMessageID:(NSString *)messageID
+                     messageBody:(NSString *)messageBody
+                 recipientUserID:(NSString *)recipientUserID
+                deliveryDateTime:(NSDate *)deliveryDateTime;
+
+@property (nonatomic, copy) NSString *messageID;
+@property (nonatomic, copy) NSString *messageBody;
+@property (nonatomic, copy) NSString *recipientUserID;
+@property (nonatomic, copy) NSDate *deliveryDateTime;
+
+@end
+
+NS_ASSUME_NONNULL_END

Leanplum-SDK/Classes/Models/LPMessageArchiveData.m

@@ -0,0 +1,43 @@
+//
+//  LPMessageArchiveData.m
+//  Leanplum iOS SDK Version 2.0.6
+//
+//  Copyright (c) 2012 Leanplum, Inc. All rights reserved.
+//
+//  Licensed to the Apache Software Foundation (ASF) under one
+//  or more contributor license agreements.  See the NOTICE file
+//  distributed with this work for additional information
+//  regarding copyright ownership.  The ASF licenses this file
+//  to you under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  http://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing,
+//  software distributed under the License is distributed on an
+//  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+//  KIND, either express or implied.  See the License for the
+//  specific language governing permissions and limitations
+//  under the License.
+
+#import "LPMessageArchiveData.h"
+
+@implementation LPMessageArchiveData
+
+-(instancetype)initWithMessageID:(NSString *)messageID
+                     messageBody:(NSString *)messageBody
+                 recipientUserID:(NSString *)recipientUserID
+                deliveryDateTime:(NSDate *)deliveryDateTime {
+    self = [super init];
+    if (self) {
+        _messageID = messageID;
+        _messageBody = messageBody;
+        _recipientUserID = recipientUserID;
+        _deliveryDateTime = deliveryDateTime;
+    }
+    return self;
+}
+
+
+@end