Add tags to IAM

   * Add OSInAppMessageTag class
   * Add send Tags when available
   * Add remove Tags when available
   * Add test for new functionality

Author: Jeasmine

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -81,6 +81,7 @@
 		7A12EBD723060A6F005C4FA5 /* OneSignalSessionManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A12EBD523060A6F005C4FA5 /* OneSignalSessionManager.m */; };
 		7A12EBDA23060AEE005C4FA5 /* OSOutcomesUtils.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A12EBD923060AEE005C4FA5 /* OSOutcomesUtils.m */; };
 		7A12EBDD23060B37005C4FA5 /* OSIndirectNotification.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A12EBDC23060B37005C4FA5 /* OSIndirectNotification.m */; };
+		7A1F2D8F2406EFC5007799A9 /* OSInAppMessageTag.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A1F2D8E2406EFC5007799A9 /* OSInAppMessageTag.m */; };
 		7A674F192360D813001F9ACD /* OSBaseFocusTimeProcessor.h in Headers */ = {isa = PBXBuildFile; fileRef = 7A674F182360D813001F9ACD /* OSBaseFocusTimeProcessor.h */; };
 		7A674F1B2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A674F1A2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m */; };
 		7A674F1C2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A674F1A2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m */; };
@@ -93,6 +94,8 @@
 		7A880F2C23FB45FB0081F5E8 /* OSInAppMessageOutcome.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A880F2A23FB45FB0081F5E8 /* OSInAppMessageOutcome.m */; };
 		7A880F2D23FB45FB0081F5E8 /* OSInAppMessageOutcome.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A880F2A23FB45FB0081F5E8 /* OSInAppMessageOutcome.m */; };
 		7A9173A2231971E5007848FA /* OneSignalReceiveReceiptsController.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A9173A1231971E5007848FA /* OneSignalReceiveReceiptsController.m */; };
+		7AA2848A2406FC6400C25D76 /* OSInAppMessageTag.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A1F2D8E2406EFC5007799A9 /* OSInAppMessageTag.m */; };
+		7AA2848B2406FC6500C25D76 /* OSInAppMessageTag.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A1F2D8E2406EFC5007799A9 /* OSInAppMessageTag.m */; };
 		7AD8DDE7234BD3BE00747A8A /* OneSignalUserDefaults.m in Sources */ = {isa = PBXBuildFile; fileRef = 7AD8DDE6234BD3BE00747A8A /* OneSignalUserDefaults.m */; };
 		7ADE379422E8B69C00263048 /* OneSignalOutcomeEventsController.m in Sources */ = {isa = PBXBuildFile; fileRef = 7ADE379322E8B69C00263048 /* OneSignalOutcomeEventsController.m */; };
 		7ADE37AD22F2554400263048 /* OneSignalOutcomeEventsController.m in Sources */ = {isa = PBXBuildFile; fileRef = 7ADE379322E8B69C00263048 /* OneSignalOutcomeEventsController.m */; };
@@ -403,6 +406,8 @@
 		7A12EBD923060AEE005C4FA5 /* OSOutcomesUtils.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OSOutcomesUtils.m; sourceTree = "<group>"; };
 		7A12EBDB23060B37005C4FA5 /* OSIndirectNotification.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OSIndirectNotification.h; sourceTree = "<group>"; };
 		7A12EBDC23060B37005C4FA5 /* OSIndirectNotification.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OSIndirectNotification.m; sourceTree = "<group>"; };
+		7A1F2D8E2406EFC5007799A9 /* OSInAppMessageTag.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSInAppMessageTag.m; sourceTree = "<group>"; };
+		7A1F2D902406EFDA007799A9 /* OSInAppMessageTag.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSInAppMessageTag.h; sourceTree = "<group>"; };
 		7A674F182360D813001F9ACD /* OSBaseFocusTimeProcessor.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSBaseFocusTimeProcessor.h; sourceTree = "<group>"; };
 		7A674F1A2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSBaseFocusTimeProcessor.m; sourceTree = "<group>"; };
 		7A72EB0D23E252C200B4D50F /* OSInAppMessageDisplayStats.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSInAppMessageDisplayStats.m; sourceTree = "<group>"; };
@@ -951,6 +956,8 @@
 				7A72EB0D23E252C200B4D50F /* OSInAppMessageDisplayStats.m */,
 				7A880F2923FB45CE0081F5E8 /* OSInAppMessageOutcome.h */,
 				7A880F2A23FB45FB0081F5E8 /* OSInAppMessageOutcome.m */,
+				7A1F2D902406EFDA007799A9 /* OSInAppMessageTag.h */,
+				7A1F2D8E2406EFC5007799A9 /* OSInAppMessageTag.m */,
 			);
 			name = Model;
 			sourceTree = "<group>";
@@ -1228,6 +1235,7 @@
 				7AF76E91234252210085F926 /* OSSessionResult.m in Sources */,
 				91F58D831E7C80DA0017D24D /* OneSignalNotificationSettingsIOS8.m in Sources */,
 				CAAEA68721ED68A40049CF15 /* OneSignalNotificationCategoryController.m in Sources */,
+				7A1F2D8F2406EFC5007799A9 /* OSInAppMessageTag.m in Sources */,
 				9D1BD9602379E7C300A064F7 /* OSOutcomeEvent.m in Sources */,
 				7A72EB0E23E252C200B4D50F /* OSInAppMessageDisplayStats.m in Sources */,
 				9124121E1E73342200E41FD7 /* OneSignalJailbreakDetection.m in Sources */,
@@ -1299,6 +1307,7 @@
 				91F58D861E7C88250017D24D /* OneSignalNotificationSettingsIOS8.m in Sources */,
 				CAAEA68821ED68A40049CF15 /* OneSignalNotificationCategoryController.m in Sources */,
 				9124121F1E73342200E41FD7 /* OneSignalJailbreakDetection.m in Sources */,
+				7AA2848A2406FC6400C25D76 /* OSInAppMessageTag.m in Sources */,
 				CA08FC7A1FE99B13004C445F /* OneSignalRequest.m in Sources */,
 				7A72EB0F23E252C700B4D50F /* OSInAppMessageDisplayStats.m in Sources */,
 				912412481E73369700E41FD7 /* OneSignalHelper.m in Sources */,
@@ -1404,6 +1413,7 @@
 				CA42CAC320D99CB90001F2F2 /* ProvisionalAuthorizationTests.m in Sources */,
 				5B58E4F8237CE7B4009401E0 /* UIDeviceOverrider.m in Sources */,
 				CA8E19022193C6B0009DA223 /* InAppMessagingIntegrationTests.m in Sources */,
+				7AA2848B2406FC6500C25D76 /* OSInAppMessageTag.m in Sources */,
 				CAB4112B20852E4C005A70D1 /* DelayedInitializationParameters.m in Sources */,
 				7AECE59223674A9700537907 /* OSAttributedFocusTimeProcessor.m in Sources */,
 				912412341E73342200E41FD7 /* OneSignalTracker.m in Sources */,

iOS_SDK/OneSignalSDK/Source/OSInAppMessageAction.h

@@ -27,6 +27,7 @@
 
 #import <Foundation/Foundation.h>
 #import "OSInAppMessageOutcome.h"
+#import "OSInAppMessageTag.h"
 #import "OSJSONHandling.h"
 #import "OneSignal.h"
 
@@ -51,6 +52,9 @@ typedef NS_ENUM(NSUInteger, OSInAppMessageActionUrlType) {
 // The outcome to send for this action
 @property (strong, nonatomic, nullable) NSArray<OSInAppMessageOutcome *> *outcomes;
 
+// The tags to send for this action
+@property (strong, nonatomic, nullable) OSInAppMessageTag *tags;
+
 // Determines where the URL is loaded, ie. app opens a webview
 @property (nonatomic) OSInAppMessageActionUrlType urlActionType;
 

iOS_SDK/OneSignalSDK/Source/OSInAppMessageAction.m

@@ -71,7 +71,7 @@ + (instancetype)instanceWithJson:(NSDictionary *)json {
         action.closesMessage = true; // Default behavior
 
     NSMutableArray *outcomes = [NSMutableArray new];
-    
+    //TODO: when backend is ready check that key matches
     if ([json[@"outcomes"] isKindOfClass:[NSArray class]]) {
         NSArray *outcomesString = json[@"outcomes"];
 
@@ -81,7 +81,17 @@ + (instancetype)instanceWithJson:(NSDictionary *)json {
     }
     action.outcomes = outcomes;
 
+    if (json[@"tags"]) {
+        action.tags= [OSInAppMessageTag instanceWithJson:json[@"tags"]];
+    } else {
+        action.tags = nil;
+    }
+    
     return action;
 }
 
+- (NSString *)description {
+    return [NSString stringWithFormat:@"OSInAppMessageAction outcome: %@ \ntag: %@", _outcomes, _tags];
+}
+
 @end

iOS_SDK/OneSignalSDK/Source/OSInAppMessageOutcome.h

@@ -25,6 +25,9 @@
  * THE SOFTWARE.
  */
 
+#ifndef OSInAppMessageOutcome_h
+#define OSInAppMessageOutcome_h
+
 #import <Foundation/Foundation.h>
 #import "OSJSONHandling.h"
 #import "OneSignal.h"
@@ -36,3 +39,5 @@
 @property (nonatomic) BOOL unique;
 
 @end
+
+#endif /* OSInAppMessageOutcome_h */

iOS_SDK/OneSignalSDK/Source/OSInAppMessageTag.h

@@ -0,0 +1,42 @@
+/**
+* Modified MIT License
+*
+* Copyright 2020 OneSignal
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* 1. The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* 2. All copies of substantial portions of the Software may only be used in connection
+* with services provided by OneSignal.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+* THE SOFTWARE.
+*/
+
+#ifndef OSInAppMessageTag_h
+#define OSInAppMessageTag_h
+
+#import <Foundation/Foundation.h>
+#import "OSJSONHandling.h"
+#import "OneSignal.h"
+
+@interface OSInAppMessageTag : NSObject <OSJSONDecodable>
+
+@property (strong, nonatomic, nullable) NSDictionary *tagsToAdd;
+@property (strong, nonatomic, nullable) NSArray *tagsToRemove;
+
+@end
+
+#endif /* OSInAppMessageTag_h */

iOS_SDK/OneSignalSDK/Source/OSInAppMessageTag.m

@@ -0,0 +1,71 @@
+/**
+* Modified MIT License
+*
+* Copyright 2020 OneSignal
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* 1. The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* 2. All copies of substantial portions of the Software may only be used in connection
+* with services provided by OneSignal.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+* THE SOFTWARE.
+*/
+
+#import "OSInAppMessageTag.h"
+
+@implementation OSInAppMessageTag
+
++ (instancetype)instanceWithData:(NSData *)data {
+    NSError *error;
+    NSDictionary *json = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];
+    
+    if (error || !json) {
+        [OneSignal onesignal_Log:ONE_S_LL_ERROR message:[NSString stringWithFormat:@"Unable to decode in-app message tag JSON: %@", error.description ?: @"No Data"]];
+        return nil;
+    }
+    
+    return [self instanceWithJson:json];
+}
+
++ (instancetype)instanceWithJson:(NSDictionary *)json {
+    OSInAppMessageTag *tag = [OSInAppMessageTag new];
+
+    //TODO: when backend is ready check that key matches
+    if ([json[@"adds"] isKindOfClass:[NSDictionary class]]) {
+        tag.tagsToAdd = json[@"adds"];
+    } else {
+        tag.tagsToAdd = nil;
+    }
+    //TODO: when backend is ready check that key matches
+    if ([json[@"removes"] isKindOfClass:[NSArray class]]) {
+        tag.tagsToRemove = json[@"removes"];
+    } else {
+        tag.tagsToRemove = nil;
+    }
+    
+    return tag;
+}
+
++ (instancetype _Nullable)instancePreviewFromPayload:(OSNotificationPayload * _Nonnull)payload {
+    return nil;
+}
+
+- (NSString *)description {
+    return [NSString stringWithFormat:@"OSInAppMessageTag tagsToAdd: %@ \ntagsToRemove: %@", _tagsToAdd, _tagsToRemove];
+}
+
+@end

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m

@@ -510,6 +510,16 @@ - (void)sendClickRESTCall:(OSInAppMessage *)message withAction:(OSInAppMessageAc
                                       }];
 }
 
+- (void)sendTagCallWithAction:(OSInAppMessageAction *)action {
+    if (action.tags) {
+        OSInAppMessageTag *tag = action.tags;
+        if (tag.tagsToAdd)
+            [OneSignal sendTags:tag.tagsToAdd];
+        if (tag.tagsToRemove)
+            [OneSignal deleteTags:tag.tagsToRemove];
+    }
+}
+
 - (void)sendOutcomes:(NSArray<OSInAppMessageOutcome *>*)outcomes {
     for (OSInAppMessageOutcome *outcome in outcomes) {
         if (outcome.unique) {
@@ -533,7 +543,7 @@ - (void)messageViewDidSelectAction:(OSInAppMessage *)message withAction:(OSInApp
         self.actionClickBlock(action);
 
     [self sendClickRESTCall:message withAction:action];
-    
+    [self sendTagCallWithAction:action];
     [self sendOutcomes:action.outcomes];
 }
 

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -1257,7 +1257,7 @@ + (void)deleteTagsWithJsonString:(NSString*)jsonString {
 + (void)deleteTags:(NSArray*)keys onSuccess:(OSResultSuccessBlock)successBlock onFailure:(OSFailureBlock)failureBlock {
     NSMutableDictionary* tags = [[NSMutableDictionary alloc] init];
 
-    for(NSString* key in keys) {
+    for (NSString* key in keys) {
         if (tagsToSend && tagsToSend[key]) {
             if (![tagsToSend[key] isEqual:@""])
                 [tagsToSend removeObjectForKey:key];

iOS_SDK/OneSignalSDK/Source/Requests.m

@@ -537,7 +537,7 @@ + (instancetype _Nonnull)unattributedWithOutcome:(OSOutcomeEvent * _Nonnull)outc
     params[DEVICE] = deviceType;
 
     params[OUTCOME_ID] = outcome.name;
-    
+
     if ([outcome.weight doubleValue] > 0)
         params[WEIGHT] = outcome.weight;