E2-10023 add trackGeofence (#237)

* add trackGeofence

* add test

* make trackGeofence event enum

* enumConstants m and h

* add license

* sendIfConnected instead of send

Author: gg4race

Example/Tests/Classes/LeanplumTest.m

@@ -37,6 +37,7 @@
 #import "LPFeatureFlagManager.h"
 #import "Constants.h"
 #import "LPRegisterDevice.h"
+#import "Leanplum.h"
 
 /**
  * Tests leanplum public methods, we seed predefined response that comes from backend
@@ -49,6 +50,8 @@ @interface Leanplum (Test)
 + (NSSet<NSString *> *)parseEnabledFeatureFlagsFromResponse:(NSDictionary *)response;
 + (void)triggerMessageDisplayed:(LPActionContext *)context;
 
++ (void)trackGeofence:(LPGeofenceEventType *)event withValue:(double)value andInfo:(NSString *)info andArgs:(NSDictionary *)args andParameters:(NSDictionary *)params;
+
 @end
 
 @interface LeanplumTest : XCTestCase
@@ -888,6 +891,19 @@ - (void) test_track
             andCurrencyCode:@"USD"
               andParameters:trackParams];
     [Leanplum forceContentUpdate];
+    
+    // Validate track geofence with info request.
+    [LeanplumRequest validate_request:^BOOL(NSString *method, NSString *apiMethod,
+                                            NSDictionary *params) {
+        // Check api method first.
+        XCTAssertEqualObjects(apiMethod, @"trackGeofence");
+        // Check if request has all params.
+        XCTAssertTrue([params[@"event"] isEqualToString:@"enter_region"]);
+        XCTAssertTrue([params[@"info"] isEqualToString:trackInfo]);
+        return YES;
+    }];
+    [Leanplum trackGeofence:LPEnterRegion withValue:0.0 andInfo:trackInfo andArgs:nil andParameters:nil];
+    [Leanplum forceContentUpdate];
 
     XCTAssertTrue([Leanplum hasStarted]);
 }

Leanplum-SDK/Classes/Internal/EnumConstants.h

@@ -0,0 +1,40 @@
+//
+//  EnumConstants.h
+//  Leanplum-SDK
+//
+//  Created by Grace Gu on 12/19/18.
+//  Copyright © 2018 Leanplum. 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.
+
+
+#ifndef EnumConstants_h
+#define EnumConstants_h
+
+@interface LPEnumConstants : NSObject {}
+
+typedef enum {
+    LPEnterRegion,
+    LPExitRegion
+} LPGeofenceEventType;
+
+
++ (NSString *)getEventNameFromGeofenceType:(LPGeofenceEventType)event;
+@end
+
+#endif /* EnumConstants_h */

Leanplum-SDK/Classes/Internal/EnumConstants.m

@@ -0,0 +1,46 @@
+//
+//  EnumConstants.m
+//  Leanplum-SDK
+//
+//  Created by Grace Gu on 12/19/18.
+//  Copyright © 2018 Leanplum. 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 "EnumConstants.h"
+
+@implementation LPEnumConstants
+
++ (NSString *) getEventNameFromGeofenceType:(LPGeofenceEventType)event {
+    NSString *result = nil;
+    
+    switch(event) {
+        case LPEnterRegion:
+            result = @"enter_region";
+            break;
+        case LPExitRegion:
+            result = @"exit_region";
+            break;
+        default:
+            [NSException raise:NSGenericException format:@"Unexpected geofenceEventType."];
+    }
+    
+    return result;
+}
+
+@end

Leanplum-SDK/Classes/Internal/Leanplum.m

@@ -1915,23 +1915,10 @@ + (void)trackInAppPurchase:(SKPaymentTransaction *)transaction
     LP_END_TRY
 }
 
-+ (void)track:(NSString *)event withValue:(double)value andInfo:(NSString *)info
-      andArgs:(NSDictionary *)args andParameters:(NSDictionary *)params
-{
-    RETURN_IF_NOOP;
-    LP_TRY
-    
-    // Track should not be called in background.
-    if (![NSThread isMainThread]) {
-        dispatch_sync(dispatch_get_main_queue(), ^{
-            [self track:event withValue:value andInfo:info andArgs:args andParameters:params];
-        });
-        return;
-    }
-    
++ (NSMutableDictionary *)makeTrackArgs:(NSString *)event withValue:(double)value andInfo: (NSString *)info andArgs:(NSDictionary *)args andParameters:(NSDictionary *)params {
     NSString *valueStr = [NSString stringWithFormat:@"%f", value];
     NSMutableDictionary *arguments = [NSMutableDictionary dictionaryWithObjectsAndKeys:
-                                 valueStr, LP_PARAM_VALUE, nil];
+                                      valueStr, LP_PARAM_VALUE, nil];
     if (args) {
         [arguments addEntriesFromDictionary:args];
     }
@@ -1948,7 +1935,25 @@ + (void)track:(NSString *)event withValue:(double)value andInfo:(NSString *)info
     if ([[UIApplication sharedApplication] applicationState] != UIApplicationStateActive) {
         arguments[@"allowOffline"] = @YES;
     }
+    return arguments;
+}
 
++ (void)track:(NSString *)event withValue:(double)value andInfo:(NSString *)info
+      andArgs:(NSDictionary *)args andParameters:(NSDictionary *)params
+{
+    RETURN_IF_NOOP;
+    LP_TRY
+    
+    // Track should not be called in background.
+    if (![NSThread isMainThread]) {
+        dispatch_sync(dispatch_get_main_queue(), ^{
+            [self track:event withValue:value andInfo:info andArgs:args andParameters:params];
+        });
+        return;
+    }
+    
+    NSMutableDictionary *arguments = [self makeTrackArgs:event withValue:value andInfo:info andArgs:args andParameters:params];
+    
     [self onStartIssued:^{
         [self trackInternal:event withArgs:arguments andParameters:params];
     }];
@@ -1957,6 +1962,39 @@ + (void)track:(NSString *)event withValue:(double)value andInfo:(NSString *)info
     [[LPCountAggregator sharedAggregator] incrementCount:@"track"];
 }
 
++ (void)trackGeofence:(LPGeofenceEventType)event withInfo:(NSString *)info {
+    if ([[LPFeatureFlagManager sharedManager] isFeatureFlagEnabled:@"track_geofence"]) {
+        [self trackGeofence:event withValue:0.0 andInfo:info andArgs:nil andParameters:nil];
+    } else {
+        [[LPCountAggregator sharedAggregator] incrementCount:@"track_geofence_disabled"];
+    }
+}
+
++ (void)trackGeofence:(LPGeofenceEventType)event withValue:(double)value andInfo:(NSString *)info
+                           andArgs:(NSDictionary *)args andParameters:(NSDictionary *)params
+{
+    RETURN_IF_NOOP;
+    LP_TRY
+    
+    // TrackGeofence should not be called in background.
+    if (![NSThread isMainThread]) {
+        dispatch_sync(dispatch_get_main_queue(), ^{
+            [self trackGeofence:event withValue:value andInfo:info andArgs:args andParameters:params];
+        });
+        return;
+    }
+    
+    NSString *eventName = [LPEnumConstants getEventNameFromGeofenceType:event];
+    
+    NSMutableDictionary *arguments = [self makeTrackArgs:eventName withValue:value andInfo:info andArgs:args andParameters:params];
+    
+    LPRequestFactory *reqFactory = [[LPRequestFactory alloc]
+                                    initWithFeatureFlagManager:[LPFeatureFlagManager sharedManager]];
+    id<LPRequesting> request = [reqFactory trackGeofenceWithParams:arguments];
+    [[LPRequestSender sharedInstance] sendIfConnected:request];
+    LP_END_TRY
+}
+
 + (void)trackInternal:(NSString *)event withArgs:(NSDictionary *)args
         andParameters:(NSDictionary *)params
 {

Leanplum-SDK/Classes/Leanplum.h

@@ -28,6 +28,7 @@
 #import "LPActionContext.h"
 #import "LPVar.h"
 #import "LPMessageArchiveData.h"
+#import "EnumConstants.h"
 
 #ifndef LP_NOT_TV
 #if (!defined(TARGET_OS_TV) || !TARGET_OS_TV)
@@ -610,6 +611,8 @@ typedef NS_ENUM(NSUInteger, LPTrackScreenMode) {
 + (void)track:(NSString *)event withValue:(double)value andInfo:(NSString *)info andParameters:(NSDictionary *)params;
 /**@}*/
 
++ (void)trackGeofence:(LPGeofenceEventType)event withInfo:(NSString *)info;
+
 /**
  * @{
  * Gets the path for a particular resource. The resource can be overridden by the server.

Leanplum-SDK/Classes/Managers/Networking/LPRequestFactory.h

@@ -38,6 +38,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (id<LPRequesting>)stopWithParams:(nullable NSDictionary *)params;
 - (id<LPRequesting>)restartWithParams:(nullable NSDictionary *)params;
 - (id<LPRequesting>)trackWithParams:(nullable NSDictionary *)params;
+- (id<LPRequesting>)trackGeofenceWithParams:(nullable NSDictionary *)params;
 - (id<LPRequesting>)advanceWithParams:(nullable NSDictionary *)params;
 - (id<LPRequesting>)pauseSessionWithParams:(nullable NSDictionary *)params;
 - (id<LPRequesting>)pauseStateWithParams:(nullable NSDictionary *)params;

Leanplum-SDK/Classes/Managers/Networking/LPRequestFactory.m

@@ -33,6 +33,7 @@
 NSString *LP_API_METHOD_STOP = @"stop";
 NSString *LP_API_METHOD_RESTART = @"restart";
 NSString *LP_API_METHOD_TRACK = @"track";
+NSString *LP_API_METHOD_TRACK_GEOFENCE = @"trackGeofence";
 NSString *LP_API_METHOD_ADVANCE = @"advance";
 NSString *LP_API_METHOD_PAUSE_SESSION = @"pauseSession";
 NSString *LP_API_METHOD_PAUSE_STATE = @"pauseState";
@@ -104,6 +105,12 @@ -(instancetype)initWithFeatureFlagManager:(LPFeatureFlagManager *)featureFlagMan
     [self.countAggregator incrementCount:@"track_with_params"];
     return [self createPostForApiMethod:LP_API_METHOD_TRACK params:params];
 }
+
+- (id<LPRequesting>)trackGeofenceWithParams:(NSDictionary *)params;
+{
+    [self.countAggregator incrementCount:@"track_geofence_with_params"];
+    return [self createPostForApiMethod:LP_API_METHOD_TRACK_GEOFENCE params:params];
+}
 - (id<LPRequesting>)advanceWithParams:(NSDictionary *)params;
 {
     [self.countAggregator incrementCount:@"advance_with_params"];