Merge pull request #167 from erkanyildiz/master

For 20.04.3

Author: erkanyildiz

CHANGELOG.md

@@ -1,3 +1,21 @@
+## 20.04.3
+- Deprecated `recordLocation:`, `recordCity:andISOCountryCode:`, `recordIP:` methods
+- Added new combined `recordLocation:city:ISOCountryCode:IP:` method for recording location related info
+- Deprecated `enableAttribution` initial config flag
+- Added `attributionID` initial config property
+- Added `recordAttributionID:` method 
+- Discarded IDFA usage on optional attribution feature
+- Discarded `COUNTLY_EXCLUDE_IDFA` preprocessor flag
+- Updated `PLCrashReporter` subspec dependency version specifier as `~> 1`
+
+- Other various improvements
+  - Updated HeaderDocs, internal logs, inline notes and pragma marks
+  - Updated some initial config property modifiers as `copy`
+  - Treated empty string `city`, `ISOCountryCode` and `IP` values as `nil`
+  - Added warnings for the cases where `city` and `ISOCountryCode` code are not set as a pair
+
+
+
 ## 20.04.2
 - Implemented overriding default metrics and adding custom ones 
 - Fixed advertising tracking enabled check

Countly.h

@@ -328,14 +328,29 @@ NS_ASSUME_NONNULL_BEGIN
 
 #pragma mark - Location
 
+/**
+ * Records user's location, city, country and IP address to be used for geo-location based push notifications and advanced user segmentation.
+ * @discussion By default, Countly Server uses a geo-ip database for acquiring user's location.
+ * @discussion If the app uses Core Location services and granted permission, a location with better accuracy can be provided using this method.
+ * @discussion If the app has information about user's city and/or country, these information can be provided using this method.
+ * @discussion If the app needs to explicitly specify the IP address due to network requirements, it can be provided using this method.
+ * @discussion This method overrides all location related properties specified on initial configuration or on a previous call to this method, and sends an immediate request.
+ * @discussion City and country code information should be provided together. If one of them is missing while the other one is present, there will be a warning logged.
+ * @param location User's location with latitude and longitude
+ * @param city User's city
+ * @param ISOCountryCode User's country code in ISO 3166-1 alpha-2 format
+ * @param IP User's explicit IP address
+ */
+- (void)recordLocation:(CLLocationCoordinate2D)location city:(NSString * _Nullable)city ISOCountryCode:(NSString * _Nullable)ISOCountryCode IP:(NSString * _Nullable)IP;
+
 /**
  * Records user's location info to be used for geo-location based push notifications and advanced user segmentation.
  * @discussion By default, Countly Server uses a geo-ip database for acquiring user's location.
  * @discussion If the app uses Core Location services and granted permission, a location with better accuracy can be provided using this method.
  * @discussion This method overrides @c location property specified on initial configuration, and sends an immediate request.
  * @param location User's location with latitude and longitude
  */
-- (void)recordLocation:(CLLocationCoordinate2D)location;
+- (void)recordLocation:(CLLocationCoordinate2D)location DEPRECATED_MSG_ATTRIBUTE("Use 'recordLocation:city:ISOCountryCode:IP:' method instead!");
 
 /**
  * Records user's city and country info to be used for geo-location based push notifications and advanced user segmentation.
@@ -345,7 +360,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @param city User's city
  * @param ISOCountryCode User's ISO country code in ISO 3166-1 alpha-2 format
  */
-- (void)recordCity:(NSString *)city andISOCountryCode:(NSString *)ISOCountryCode;
+- (void)recordCity:(NSString *)city andISOCountryCode:(NSString *)ISOCountryCode DEPRECATED_MSG_ATTRIBUTE("Use 'recordLocation:city:ISOCountryCode:IP:' method instead!");
 
 /**
  * Records user's IP address to be used for geo-location based push notifications and advanced user segmentation.
@@ -354,7 +369,7 @@ NS_ASSUME_NONNULL_BEGIN
  * @discussion This method overrides @c IP property specified on initial configuration, and sends an immediate request.
  * @param IP User's explicit IP address
  */
-- (void)recordIP:(NSString *)IP;
+- (void)recordIP:(NSString *)IP DEPRECATED_MSG_ATTRIBUTE("Use 'recordLocation:city:ISOCountryCode:IP:' method instead!");
 
 /**
  * Disables geo-location based push notifications by clearing all existing location info.
@@ -518,6 +533,18 @@ NS_ASSUME_NONNULL_BEGIN
 
 
 
+#pragma mark - Attribution
+
+/**
+ * Records attribution ID (IDFA) for campaign attribution.
+ * @discussion This method overrides @c attributionID property specified on initial configuration, and sends an immediate request.
+ * @discussion Also, this attribution ID will be sent with all @c begin_session requests.
+ * @param attributionID Attribution ID (IDFA)
+ */
+- (void)recordAttributionID:(NSString *)attributionID;
+
+
+
 #pragma mark - Remote Config
 /**
  * Returns last retrieved remote config value for given key, if exists.

Countly.m

@@ -97,13 +97,12 @@ - (void)startWithConfig:(CountlyConfig *)config
     CountlyPersistency.sharedInstance.storedRequestsLimit = MAX(1, config.storedRequestsLimit);
 
     CountlyCommon.sharedInstance.manualSessionHandling = config.manualSessionHandling;
+
     CountlyCommon.sharedInstance.enableAppleWatch = config.enableAppleWatch;
-    CountlyCommon.sharedInstance.enableAttribution = config.enableAttribution;
 
-    CountlyDeviceInfo.sharedInstance.customMetrics = config.customMetrics;
+    CountlyCommon.sharedInstance.attributionID = config.attributionID;
 
-    if (!CountlyCommon.sharedInstance.manualSessionHandling)
-        [CountlyConnectionManager.sharedInstance beginSession];
+    CountlyDeviceInfo.sharedInstance.customMetrics = config.customMetrics;
 
 #if (TARGET_OS_IOS)
     CountlyStarRating.sharedInstance.message = config.starRatingMessage;
@@ -112,13 +111,19 @@ - (void)startWithConfig:(CountlyConfig *)config
     CountlyStarRating.sharedInstance.ratingCompletionForAutoAsk = config.starRatingCompletion;
     [CountlyStarRating.sharedInstance checkForAutoAsk];
 
-    CountlyLocationManager.sharedInstance.location = CLLocationCoordinate2DIsValid(config.location) ? [NSString stringWithFormat:@"%f,%f", config.location.latitude, config.location.longitude] : nil;
-    CountlyLocationManager.sharedInstance.city = config.city;
-    CountlyLocationManager.sharedInstance.ISOCountryCode = config.ISOCountryCode;
-    CountlyLocationManager.sharedInstance.IP = config.IP;
-    [CountlyLocationManager.sharedInstance sendLocationInfo];
+    [CountlyLocationManager.sharedInstance updateLocation:config.location city:config.city ISOCountryCode:config.ISOCountryCode IP:config.IP];
 #endif
 
+    if (!CountlyCommon.sharedInstance.manualSessionHandling)
+        [CountlyConnectionManager.sharedInstance beginSession];
+
+    //NOTE: If there is no consent for sessions, location info and attribution should be sent separately, as they cannot be sent with begin_session request.
+    if (!CountlyConsentManager.sharedInstance.consentForSessions)
+    {
+        [CountlyLocationManager.sharedInstance sendLocationInfo];
+        [CountlyConnectionManager.sharedInstance sendAttribution];
+    }
+
 #if (TARGET_OS_IOS || TARGET_OS_OSX)
 #ifndef COUNTLY_EXCLUDE_PUSHNOTIFICATIONS
     if ([config.features containsObject:CLYPushNotifications])
@@ -159,8 +164,6 @@ - (void)startWithConfig:(CountlyConfig *)config
 
     [CountlyCommon.sharedInstance startAppleWatchMatching];
 
-    [CountlyCommon.sharedInstance startAttribution];
-
     CountlyRemoteConfig.sharedInstance.isEnabledOnInitialConfig = config.enableRemoteConfig;
     CountlyRemoteConfig.sharedInstance.remoteConfigCompletionHandler = config.remoteConfigCompletionHandler;
     [CountlyRemoteConfig.sharedInstance startRemoteConfig];
@@ -599,25 +602,36 @@ - (void)clearPushNotificationToken
 
 #pragma mark - Location
 
+- (void)recordLocation:(CLLocationCoordinate2D)location city:(NSString * _Nullable)city ISOCountryCode:(NSString * _Nullable)ISOCountryCode IP:(NSString * _Nullable)IP
+{
+    [CountlyLocationManager.sharedInstance recordLocation:location city:city ISOCountryCode:ISOCountryCode IP:IP];
+}
+
 - (void)recordLocation:(CLLocationCoordinate2D)location
 {
-    [CountlyLocationManager.sharedInstance recordLocationInfo:location city:nil ISOCountryCode:nil andIP:nil];
+    COUNTLY_LOG(@"recordLocation: method is deprecated. Please use recordLocation:city:countryCode:IP: method instead.");
+
+    [CountlyLocationManager.sharedInstance recordLocation:location city:nil ISOCountryCode:nil IP:nil];
 }
 
 - (void)recordCity:(NSString *)city andISOCountryCode:(NSString *)ISOCountryCode
 {
+    COUNTLY_LOG(@"recordCity:andISOCountryCode: method is deprecated. Please use recordLocation:city:countryCode:IP: method instead.");
+
     if (!city.length && !ISOCountryCode.length)
         return;
 
-    [CountlyLocationManager.sharedInstance recordLocationInfo:kCLLocationCoordinate2DInvalid city:city ISOCountryCode:ISOCountryCode andIP:nil];
+    [CountlyLocationManager.sharedInstance recordLocation:kCLLocationCoordinate2DInvalid city:city ISOCountryCode:ISOCountryCode IP:nil];
 }
 
 - (void)recordIP:(NSString *)IP
 {
+    COUNTLY_LOG(@"recordIP: method is deprecated. Please use recordLocation:city:countryCode:IP: method instead.");
+
     if (!IP.length)
         return;
 
-    [CountlyLocationManager.sharedInstance recordLocationInfo:kCLLocationCoordinate2DInvalid city:nil ISOCountryCode:nil andIP:IP];
+    [CountlyLocationManager.sharedInstance recordLocation:kCLLocationCoordinate2DInvalid city:nil ISOCountryCode:nil IP:IP];
 }
 
 - (void)disableLocationInfo
@@ -728,6 +742,20 @@ - (void)presentFeedbackWidgetWithID:(NSString *)widgetID completionHandler:(void
 
 
 
+#pragma mark - Attribution
+
+- (void)recordAttributionID:(NSString *)attributionID
+{
+    if (!CountlyConsentManager.sharedInstance.consentForAttribution)
+        return;
+
+    CountlyCommon.sharedInstance.attributionID = attributionID;
+
+    [CountlyConnectionManager.sharedInstance sendAttribution];
+}
+
+
+
 #pragma mark - Remote Config
 
 - (id)remoteConfigValueForKey:(NSString *)key

Countly.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'Countly'
-  s.version = '20.04.2'
+  s.version = '20.04.3'
   s.license = { :type => 'MIT', :file => 'LICENSE.md' }
   s.summary  = 'Countly is an innovative, real-time, open source mobile analytics platform.'
   s.homepage = 'https://github.com/Countly/countly-sdk-ios'
@@ -30,7 +30,7 @@ Pod::Spec.new do |s|
   s.subspec 'PL' do |pl|
     pl.platform = :ios
     pl.dependency 'Countly/Core'
-    pl.dependency 'PLCrashReporter', '1.5.1'
+    pl.dependency 'PLCrashReporter', '~> 1'
 
     # It is not possible to set static_framework attribute on subspecs.
     # So, we have to set it on main spec.

Countly.xcodeproj/project.pbxproj

@@ -397,6 +397,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
+				MARKETING_VERSION = 20.04.3;
 				PRODUCT_BUNDLE_IDENTIFIER = ly.count.CountlyiOSSDK;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -423,6 +424,7 @@
 					"@executable_path/Frameworks",
 					"@loader_path/Frameworks",
 				);
+				MARKETING_VERSION = 20.04.3;
 				PRODUCT_BUNDLE_IDENTIFIER = ly.count.CountlyiOSSDK;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				PROVISIONING_PROFILE_SPECIFIER = "";

CountlyCommon.h

@@ -30,9 +30,6 @@
 
 #if (TARGET_OS_IOS)
 #import <UIKit/UIKit.h>
-#ifndef COUNTLY_EXCLUDE_IDFA
-#import <AdSupport/ASIdentifierManager.h>
-#endif
 #import "WatchConnectivity/WatchConnectivity.h"
 #endif
 
@@ -43,9 +40,6 @@
 
 #if (TARGET_OS_TV)
 #import <UIKit/UIKit.h>
-#ifndef COUNTLY_EXCLUDE_IDFA
-#import <AdSupport/ASIdentifierManager.h>
-#endif
 #endif
 
 #import <objc/runtime.h>
@@ -67,7 +61,7 @@ NS_ERROR_ENUM(kCountlyErrorDomain)
 @property (nonatomic) BOOL hasStarted;
 @property (nonatomic) BOOL enableDebug;
 @property (nonatomic) BOOL enableAppleWatch;
-@property (nonatomic) BOOL enableAttribution;
+@property (nonatomic, copy) NSString* attributionID;
 @property (nonatomic) BOOL manualSessionHandling;
 
 void CountlyInternalLog(NSString *format, ...) NS_FORMAT_FUNCTION(1,2);
@@ -89,7 +83,6 @@ void CountlyPrint(NSString *stringToPrint);
 #endif
 
 - (void)startAppleWatchMatching;
-- (void)startAttribution;
 
 - (void)observeDeviceOrientationChanges;
 

CountlyCommon.m

@@ -33,11 +33,10 @@ @interface CountlyCommon ()
 #endif
 @end
 
-NSString* const kCountlySDKVersion = @"20.04.2";
+NSString* const kCountlySDKVersion = @"20.04.3";
 NSString* const kCountlySDKName = @"objc-native-ios";
 
 NSString* const kCountlyParentDeviceIDTransferKey = @"kCountlyParentDeviceIDTransferKey";
-NSString* const kCountlyAttributionIDFAKey = @"idfa";
 
 NSString* const kCountlyErrorDomain = @"ly.count.ErrorDomain";
 
@@ -169,33 +168,6 @@ - (void)startAppleWatchMatching
 #endif
 }
 
-#pragma mark - Attribution
-
-- (void)startAttribution
-{
-    if (!self.enableAttribution)
-        return;
-
-    if (!CountlyConsentManager.sharedInstance.consentForAttribution)
-        return;
-
-    NSDictionary* attribution = nil;
-
-#if (TARGET_OS_IOS || TARGET_OS_TV)
-#ifndef COUNTLY_EXCLUDE_IDFA
-    if (!ASIdentifierManager.sharedManager.advertisingTrackingEnabled)
-    {
-        attribution = @{kCountlyAttributionIDFAKey: ASIdentifierManager.sharedManager.advertisingIdentifier.UUIDString};
-    }
-#endif
-#endif
-
-    if (!attribution)
-        return;
-
-    [CountlyConnectionManager.sharedInstance sendAttribution:[attribution cly_JSONify]];
-}
-
 #pragma mark - Orientation
 
 - (void)observeDeviceOrientationChanges