Merge pull request #18 from mixpanel/more-config-options

Add API `setUseIpAddressForGeolocation`

Author: zihejia

android/src/main/java/com/mixpanel/mixpanel_flutter/MixpanelFlutterPlugin.java

@@ -56,6 +56,15 @@ public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
             case "initialize":
                 handleInitialize(call, result);
                 break;
+            case "setServerURL":
+                handleSetServerURL(call, result);
+                break;
+            case "setLoggingEnabled":
+                handleSetLoggingEnabled(call, result);
+                break;
+            case "setUseIpAddressForGeolocation":
+                handleSetUseIpAddressForGeolocation(call, result);
+                break;
             case "hasOptedOutTracking":
                 handleHasOptedOutTracking(call, result);
                 break;
@@ -186,6 +195,24 @@ private void handleInitialize(MethodCall call, Result result) {
         result.success(Integer.toString(mixpanel.hashCode()));
     }
 
+    private void handleSetServerURL(MethodCall call, Result result) {
+        String serverURL = call.argument("serverURL");
+        mixpanel.setServerURL(serverURL);
+        result.success(null);
+    }
+
+    private void handleSetLoggingEnabled(MethodCall call, Result result) {
+        Boolean enableLogging = call.argument("loggingEnabled");
+        mixpanel.setEnableLogging(enableLogging);
+        result.success(null);
+    }
+
+    private void handleSetUseIpAddressForGeolocation(MethodCall call, Result result) {
+        Boolean useIpAddressForGeolocation = call.argument("useIpAddressForGeolocation");
+        mixpanel.setUseIpAddressForGeolocation(useIpAddressForGeolocation);
+        result.success(null);
+    }
+
     private void handleHasOptedOutTracking(MethodCall call, Result result) {
         result.success(mixpanel.hasOptedOutTracking());
     }

example/ios/Podfile.lock

@@ -1,11 +1,11 @@
 PODS:
   - Flutter (1.0.0)
-  - Mixpanel-swift (2.8.3):
-    - Mixpanel-swift/Complete (= 2.8.3)
-  - Mixpanel-swift/Complete (2.8.3)
-  - mixpanel_flutter (1.0.1):
+  - Mixpanel-swift (2.10.2):
+    - Mixpanel-swift/Complete (= 2.10.2)
+  - Mixpanel-swift/Complete (2.10.2)
+  - mixpanel_flutter (1.1.0):
     - Flutter
-    - Mixpanel-swift (= 2.8.3)
+    - Mixpanel-swift (= 2.10.2)
 
 DEPENDENCIES:
   - Flutter (from `Flutter`)
@@ -23,8 +23,8 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   Flutter: 434fef37c0980e73bb6479ef766c45957d4b510c
-  Mixpanel-swift: 947354668bf7dcaff5aaf9c64232fb5bea6ff0c7
-  mixpanel_flutter: 59130decd93dbb51e1a8a258d0d9af432287768e
+  Mixpanel-swift: dc07ae05df9ff47c80542531f55e2120ec2a410a
+  mixpanel_flutter: 1b239a014f75503531dd60e8315c82c3e86ad3ad
 
 PODFILE CHECKSUM: aafe91acc616949ddb318b77800a7f51bffa2a4c
 

example/pubspec.lock

@@ -87,7 +87,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.0.1"
+    version: "1.1.0"
   path:
     dependency: transitive
     description:

ios/Classes/SwiftMixpanelFlutterPlugin.swift

@@ -25,6 +25,9 @@ public class SwiftMixpanelFlutterPlugin: NSObject, FlutterPlugin {
         case "setLoggingEnabled":
             handleSetLoggingEnabled(call, result: result)
             break
+        case "setUseIpAddressForGeolocation":
+            handleSetUseIpAddressForGeolocation(call, result: result)
+            break
         case "hasOptedOutTracking":
             handleHasOptedOutTracking(call, result: result)
             break
@@ -176,6 +179,13 @@ public class SwiftMixpanelFlutterPlugin: NSObject, FlutterPlugin {
         instance?.loggingEnabled = loggingEnabled
         result(nil)
     }
+
+    private func handleSetUseIpAddressForGeolocation(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
+        let arguments = call.arguments as? [String: Any] ?? [String: Any]()
+        let useIpAddressForGeolocation = arguments["useIpAddressForGeolocation"] as! Bool
+        instance?.useIPAddressForGeoLocation = useIpAddressForGeolocation
+        result(nil)
+    }
 
     private func handleHasOptedOutTracking(_ call: FlutterMethodCall, result: @escaping FlutterResult) {
         result(instance?.hasOptedOutTracking())

ios/mixpanel_flutter.podspec

@@ -12,7 +12,7 @@ Pod::Spec.new do |s|
   s.source           = { :path => '.' }
   s.source_files = 'Classes/**/*'
   s.dependency 'Flutter'
-  s.dependency 'Mixpanel-swift', '2.8.3'
+  s.dependency 'Mixpanel-swift', '2.10.2'
   s.platform = :ios, '9.0'
 
   # Flutter.framework does not contain a i386 slice.

lib/mixpanel_flutter.dart

@@ -39,40 +39,47 @@ class Mixpanel {
   /// Set the base URL used for Mixpanel API requests.
   /// Useful if you need to proxy Mixpanel requests. Defaults to https://api.mixpanel.com.
   /// To route data to Mixpanel's EU servers, set to https://api-eu.mixpanel.com
-  /// - Note: This method will only work for iOS. For android, please refer to:
-  /// https://developer.mixpanel.com/docs/android
   ///
   /// * [serverURL] the base URL used for Mixpanel API requests
   void setServerURL(String serverURL) {
-    if (Platform.isIOS) {
-      if (_MixpanelHelper.isValidString(serverURL)) {
-        _channel.invokeMethod<void>(
-            'setServerURL', <String, dynamic>{'serverURL': serverURL});
-      } else {
-        developer.log('`setServerURL` failed: serverURL cannot be blank',
-            name: 'Mixpanel');
-      }
+    if (_MixpanelHelper.isValidString(serverURL)) {
+      _channel.invokeMethod<void>(
+          'setServerURL', <String, dynamic>{'serverURL': serverURL});
+    } else {
+      developer.log('`setServerURL` failed: serverURL cannot be blank',
+          name: 'Mixpanel');
     }
   }
 
   /// This allows enabling or disabling of all Mixpanel logs at run time.
-  /// - Note: This method will only work for iOS. For android, please refer to:
-  /// https://developer.mixpanel.com/docs/android
   /// All logging is disabled by default. Usually, this is only required if
   /// you are running into issues with the SDK that you want to debug
   ///
   /// * [loggingEnabled] whether to enable logging
   void setLoggingEnabled(bool loggingEnabled) {
-    if (Platform.isIOS) {
-      // ignore: unnecessary_null_comparison
-      if (loggingEnabled != null) {
-        _channel.invokeMethod<void>('setLoggingEnabled',
-            <String, dynamic>{'loggingEnabled': loggingEnabled});
-      } else {
-        developer.log(
-            '`setLoggingEnabled` failed: loggingEnabled cannot be blank',
-            name: 'Mixpanel');
-      }
+    if (loggingEnabled != null) { // ignore: unnecessary_null_comparison
+      _channel.invokeMethod<void>('setLoggingEnabled',
+          <String, dynamic>{'loggingEnabled': loggingEnabled});
+    } else {
+      developer.log(
+          '`setLoggingEnabled` failed: loggingEnabled cannot be blank',
+          name: 'Mixpanel');
+    }
+  }
+
+  /// This controls whether to automatically send the client IP Address as part of event tracking.
+  /// With an IP address, geo-location is possible down to neighborhoods within a city,
+  /// although the Mixpanel Dashboard will just show you city level location specificity.
+  ///
+  /// * [useIpAddressForGeolocation] whether to automatically send the client IP Address. Defaults to true.
+  void setUseIpAddressForGeolocation(bool useIpAddressForGeolocation) {
+    if (useIpAddressForGeolocation != null) { // ignore: unnecessary_null_comparison
+      _channel.invokeMethod<void>('setUseIpAddressForGeolocation',
+          <String, dynamic>{'useIpAddressForGeolocation': useIpAddressForGeolocation});
+    } else {
+      developer.log(
+          '`setUseIpAddressForGeolocation` failed: useIpAddressForGeolocation cannot be blank',
+          name: 'Mixpanel');
     }
   }
 

test/mixpanel_flutter_test.dart

@@ -62,6 +62,39 @@ void main() {
       );
     });
 
+    test('check setServerURL', () async {
+      _mixpanel.setServerURL("https://api-eu.mixpanel.com");
+      expect(
+        methodCall,
+        isMethodCall(
+          'setServerURL',
+          arguments: <String, dynamic>{'serverURL': 'https://api-eu.mixpanel.com'},
+        ),
+      );
+    });
+
+    test('check setLoggingEnabled', () async {
+      _mixpanel.setLoggingEnabled(true);
+      expect(
+        methodCall,
+        isMethodCall(
+          'setLoggingEnabled',
+          arguments: <String, dynamic>{'loggingEnabled': true},
+        ),
+      );
+    });
+
+    test('check setUseIpAddressForGeolocation', () async {
+      _mixpanel.setUseIpAddressForGeolocation(true);
+      expect(
+        methodCall,
+        isMethodCall(
+          'setUseIpAddressForGeolocation',
+          arguments: <String, dynamic>{'useIpAddressForGeolocation': true},
+        ),
+      );
+    });
+
     test('check optInTracking', () async {
       _mixpanel.optInTracking();
       expect(