Feature/set locale (#467)

* Add setLocale

Author: fitja

LeanplumSDK/LeanplumSDK/Classes/Internal/Leanplum.m

@@ -862,10 +862,8 @@ + (void)startWithUserId:(NSString *)userId
     // Setup parameters.
     NSString *versionName = [self appVersion];
     UIDevice *device = [UIDevice currentDevice];
-    NSLocale *currentLocale = [NSLocale currentLocale];
-    NSString *currentLocaleString = [NSString stringWithFormat:@"%@_%@",
-                                     [[NSLocale preferredLanguages] objectAtIndex:0],
-                                     [currentLocale objectForKey:NSLocaleCountryCode]];
+    NSString *currentLocaleString = [self.locale localeIdentifier];
+
     // Set the device name. But only if running in development mode.
     NSString *deviceName = @"";
     if ([LPConstantsState sharedState].isDevelopmentModeEnabled) {
@@ -2249,6 +2247,35 @@ + (void)setTrafficSourceInfoInternal:(NSDictionary *)info
     [[LPRequestSender sharedInstance] send:request];
 }
 
++ (NSLocale *)systemLocale {
+    static NSLocale * _systemLocale = nil;
+    if (!_systemLocale) {
+        NSLocale *currentLocale = [NSLocale currentLocale];
+        NSString *currentLocaleString = [NSString stringWithFormat:@"%@_%@",
+                                         [[NSLocale preferredLanguages] objectAtIndex:0],
+                                         [currentLocale objectForKey:NSLocaleCountryCode]];
+        _systemLocale = [[NSLocale alloc] initWithLocaleIdentifier:currentLocaleString];
+    }
+    return _systemLocale;
+}
+
+static NSLocale * _locale;
++ (NSLocale *)locale
+{
+    return _locale ?: self.systemLocale;
+}
+
++ (void)setLocale:(NSLocale *)locale
+{
+    _locale = locale;
+    if ([self hasStarted]) {
+        LPRequest *request = [LPRequestFactory setUserAttributesWithParams:@{
+            LP_KEY_LOCALE: [locale localeIdentifier]
+        }];
+        [[LPRequestSender sharedInstance] send:request];
+    }
+}
+
 + (void)advanceTo:(NSString *)state
 {
     [self advanceTo:state withInfo:nil];

LeanplumSDK/LeanplumSDK/Classes/Leanplum.h

@@ -526,6 +526,12 @@ NS_SWIFT_NAME(setUserId(_:attributes:));
 + (void)setTrafficSourceInfo:(NSDictionary *)info
 NS_SWIFT_NAME(setTrafficSource(info:));
 
+/**
+ * Updates a user locale after session start.
+ */
++(void)setLocale:(NSLocale *)locale
+NS_SWIFT_NAME(setLocale(_:));
+
 /**
  * @{
  * Advances to a particular state in your application. The string can be

LeanplumSDKApp/LeanplumSDKTests/Classes/Extensions/Leanplum+Extensions.h

@@ -31,6 +31,8 @@
 
 @interface Leanplum(UnitTest)
 
++ (NSLocale *)systemLocale;
+
 + (void)reset;
 
 + (void)maybePerformActions:(NSArray *)whenConditions

LeanplumSDKApp/LeanplumSDKTests/Classes/LeanplumTest.m

@@ -1075,6 +1075,47 @@ - (void) test_set_device_id_after_start
     XCTAssertTrue([[LPAPIConfig sharedConfig].deviceId isEqualToString:deviceId]);
 }
 
+/**
+ * Tests setting the user locale before Leanplum start
+ */
+- (void) test_set_locale_before_start
+{
+    NSLocale *locale = [[NSLocale alloc] initWithLocaleIdentifier:@"ab_CD"];
+
+    XCTestExpectation *request_expectation = [self expectationWithDescription:@"request_expectation"];
+    [LPRequestSender validate_request_args_dictionary:^(NSDictionary *args) {
+        XCTAssertFalse([args[LP_KEY_LOCALE] isEqualToString:[Leanplum.systemLocale localeIdentifier]]);
+        XCTAssertTrue([args[LP_KEY_LOCALE] isEqualToString:[locale localeIdentifier]]);
+        [request_expectation fulfill];
+    }];
+
+    [Leanplum setLocale:locale];
+    XCTAssertTrue([LeanplumHelper start_development_test]);
+    [self waitForExpectations:@[request_expectation] timeout:1.0];
+}
+
+/**
+ * Tests setting the user locale after Leanplum start
+ */
+- (void) test_set_locale_after_start
+{
+    NSLocale *locale = [[NSLocale alloc] initWithLocaleIdentifier:@"ab_CD"];
+
+    XCTestExpectation *request_expectation = [self expectationWithDescription:@"request_expectation"];
+    [Leanplum onStartResponse:^(BOOL success) {
+        XCTAssertTrue(success);
+        [Leanplum setLocale:locale];
+        [LPRequestSender validate_request_args_dictionary:^(NSDictionary *args) {
+            XCTAssertFalse([args[LP_KEY_LOCALE] isEqualToString:[Leanplum.systemLocale localeIdentifier]]);
+            XCTAssertTrue([args[LP_KEY_LOCALE] isEqualToString:[locale localeIdentifier]]);
+            [request_expectation fulfill];
+        }];
+    }];
+
+    XCTAssertTrue([LeanplumHelper start_development_test]);
+    [self waitForExpectations:@[request_expectation] timeout:1.0];
+}
+
 /**
  * Tests track with events of same type , priority and countdown.
  */