feature/scalable-integration - Add dynamic and scalable segment integration

README.md

@@ -88,6 +88,13 @@ Setup your Android, iOS and/or web sources as described at Segment.com and gener
 Set your Segment write key and change the automatic event tracking (only for Android and iOS) on if you wish the library to take care of it for you.
 Remember that the application lifecycle events won't have any special context set for you by the time it is initialized.
 
+### Integration Item List
+| Item           | Supported | Enum Name |
+|------------------|---|---|
+| `Amplitude`       | YES | `SegmentIntegrationItemType.amplitude` | 
+
+You can tell the plugin tu use any integration item by insert them in `integrationItems` in `SegmentConfig`.
+
 ### Via Dart Code
 ```dart
 void main() {
@@ -106,14 +113,17 @@ void main() {
     options: SegmentConfig(
       writeKey: 'YOUR_WRITE_KEY_GOES_HERE',
       trackApplicationLifecycleEvents: false,
-      amplitudeIntegrationEnabled: false,
+      //Insert any plugins you want to use here,
+      //See `SegmentIntegrationItemType` enumeration
+      integrationItems: const [SegmentIntegrationItemType.amplitude],
       debug: false,
     ),
   );
 }
 ```
 
-### Android _(Deprecated*)_
+
+### Android _(Deprecated* & Removed)_
 ```xml
 <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.flutter_segment_example">
     <application>
@@ -128,7 +138,7 @@ void main() {
 </manifest>
 ```
 
-### iOS _(Deprecated*)_
+### iOS _(Deprecated* & Removed)_
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">

android/src/main/java/com/example/flutter_segment/FlutterSegmentOptions.java

@@ -3,18 +3,25 @@
 import android.os.Bundle;
 
 import java.util.HashMap;
+import java.util.ArrayList; // import the ArrayList class
+
 
 public class FlutterSegmentOptions {
     private final String writeKey;
     private final Boolean trackApplicationLifecycleEvents;
-    private final Boolean amplitudeIntegrationEnabled;
     private final Boolean debug;
+    private final ArrayList<String> integrationItems;
+
+    //nullable arguments
+    public  FlutterSegmentOptions(String writeKey, Boolean trackApplicationLifecycleEvents,Boolean debug) {
+        this(writeKey,trackApplicationLifecycleEvents,debug,new ArrayList<String>());
+    }
 
-    public  FlutterSegmentOptions(String writeKey, Boolean trackApplicationLifecycleEvents, Boolean amplitudeIntegrationEnabled,Boolean debug) {
+    public  FlutterSegmentOptions(String writeKey, Boolean trackApplicationLifecycleEvents, Boolean debug, ArrayList<String> integrationItems) {
         this.writeKey = writeKey;
         this.trackApplicationLifecycleEvents = trackApplicationLifecycleEvents;
-        this.amplitudeIntegrationEnabled = amplitudeIntegrationEnabled;
         this.debug = debug;
+        this.integrationItems = integrationItems;
     }
 
     public String getWriteKey() {
@@ -25,28 +32,20 @@ public Boolean getTrackApplicationLifecycleEvents() {
         return trackApplicationLifecycleEvents;
     }
 
-    public Boolean isAmplitudeIntegrationEnabled() {
-        return amplitudeIntegrationEnabled;
+    public ArrayList<String> getIntegrationItems() {
+        return integrationItems;
     }
 
     public Boolean getDebug() {
         return debug;
     }
 
-    static FlutterSegmentOptions create(Bundle bundle) {
-        String writeKey = bundle.getString("com.claimsforce.segment.WRITE_KEY");
-        Boolean trackApplicationLifecycleEvents = bundle.getBoolean("com.claimsforce.segment.TRACK_APPLICATION_LIFECYCLE_EVENTS");
-        Boolean isAmplitudeIntegrationEnabled = bundle.getBoolean("com.claimsforce.segment.ENABLE_AMPLITUDE_INTEGRATION", false);
-        Boolean debug = bundle.getBoolean("com.claimsforce.segment.DEBUG", false);
-        return new FlutterSegmentOptions(writeKey, trackApplicationLifecycleEvents, isAmplitudeIntegrationEnabled, debug);
-    }
-
     static FlutterSegmentOptions create(HashMap<String, Object> options) {
         String writeKey = (String) options.get("writeKey");
         Boolean trackApplicationLifecycleEvents = (Boolean) options.get("trackApplicationLifecycleEvents");
-        Boolean isAmplitudeIntegrationEnabled = orFalse((Boolean) options.get("amplitudeIntegrationEnabled"));
         Boolean debug = orFalse((Boolean) options.get("debug"));
-        return new FlutterSegmentOptions(writeKey, trackApplicationLifecycleEvents, isAmplitudeIntegrationEnabled, debug);
+        ArrayList<String> integrationItems = (ArrayList<String>) options.get("integrationItems");
+        return new FlutterSegmentOptions(writeKey, trackApplicationLifecycleEvents, debug,integrationItems);
     }
 
     private static Boolean orFalse(Boolean value) {

android/src/main/java/com/example/flutter_segment/FlutterSegmentPlugin.java

@@ -20,6 +20,7 @@
 import java.util.LinkedHashMap;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.ArrayList;
 
 import io.flutter.plugin.common.BinaryMessenger;
 import io.flutter.plugin.common.MethodCall;
@@ -54,18 +55,6 @@ private void setupChannels(Context applicationContext, BinaryMessenger messenger
     methodChannel = new MethodChannel(messenger, "flutter_segment");
     // register the channel to receive calls
     methodChannel.setMethodCallHandler(this);
-
-    try {
-      ApplicationInfo ai = applicationContext.getPackageManager()
-              .getApplicationInfo(applicationContext.getPackageName(), PackageManager.GET_META_DATA);
-
-      Bundle bundle = ai.metaData;
-
-      FlutterSegmentOptions options = FlutterSegmentOptions.create(bundle);
-      setupChannels(options);
-    } catch (Exception e) {
-      Log.e("FlutterSegment", e.getMessage());
-    }
   }
 
   private void setupChannels(FlutterSegmentOptions options) {
@@ -83,8 +72,14 @@ private void setupChannels(FlutterSegmentOptions options) {
         analyticsBuilder.logLevel(LogLevel.DEBUG);
       }
 
-      if (options.isAmplitudeIntegrationEnabled()) {
-        analyticsBuilder.use(AmplitudeIntegration.FACTORY);
+      for (String item : options.getIntegrationItems()) {
+        switch(item){
+          case "amplitude":
+            analyticsBuilder.use(AmplitudeIntegration.FACTORY);
+            break;
+          default:
+            // do nothing
+        }
       }
 
       // Here we build a middleware that just appends data to the current context

example/android/app/src/main/AndroidManifest.xml

@@ -31,20 +31,5 @@
         </activity>
 
         <meta-data android:name="flutterEmbedding" android:value="2" />
-
-        <!-- Set your Segment write key and change the automatic event tracking
-            on if you wish the library to take care of it for you.
-            Remember that the application lifecycle events won't have any
-            special context set for you by the time it is initialized. -->
-        <meta-data android:name="com.claimsforce.segment.WRITE_KEY" android:value="YOUR_WRITE_KEY_GOES_HERE" />
-        <meta-data android:name="com.claimsforce.segment.TRACK_APPLICATION_LIFECYCLE_EVENTS" android:value="false" />
-        <!--
-            If you want to debug the plugin events. Default is false.
-            <meta-data android:name="com.claimsforce.segment.DEBUG" android:value="true" />
-
-            Expected shell output (flutter run) when this flag is enabled:
-                D/Analytics(32684): Ran TrackPayload{event="ButtonClicked"} on integration Segment.io in 480110 ns.
-                D/Analytics(32684): Ran TrackPayload{event="ButtonClicked"} on integration Segment.io in 104410 ns.
-        -->
     </application>
 </manifest>

example/ios/Runner/Info.plist

@@ -39,10 +39,6 @@
 		<string>UIInterfaceOrientationLandscapeLeft</string>
 		<string>UIInterfaceOrientationLandscapeRight</string>
 	</array>
-	<key>com.claimsforce.segment.WRITE_KEY</key>
-	<string>YOUR_WRITE_KEY_GOES_HERE</string>
-	<key>com.claimsforce.segment.TRACK_APPLICATION_LIFECYCLE_EVENTS</key>
-	<false/>
 	<key>UIViewControllerBasedStatusBarAppearance</key>
 	<false/>
 </dict>

example/lib/main.dart

@@ -12,6 +12,7 @@ void main() {
     options: SegmentConfig(
       writeKey: 'YOUR_WRITE_KEY_GOES_HERE',
       trackApplicationLifecycleEvents: false,
+      integrationItems: const [SegmentIntegrationItemType.amplitude],
     ),
   );
 
@@ -60,7 +61,7 @@ class MyApp extends StatelessWidget {
                 child: const Text('TRACK ACTION WITH SEGMENT'),
                 onPressed: () {
                   Segment.track(
-                    eventName: 'ButtonClicked',
+                    eventName: 'DevTest ButtonClicked',
                     properties: {
                       'foo': 'bar',
                       'number': 1337,

ios/Classes/FlutterSegmentPlugin.m

@@ -15,12 +15,6 @@ + (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar>*)registrar {
       binaryMessenger:[registrar messenger]];
     FlutterSegmentPlugin* instance = [[FlutterSegmentPlugin alloc] init];
 
-    SEGAnalyticsConfiguration *configuration = [FlutterSegmentPlugin createConfigFromFile];
-    if(configuration) {
-        [instance setup:configuration];
-        wasSetupFromFile = YES;
-    }
-
     [registrar addMethodCallDelegate:instance channel:channel];
 }
 
@@ -341,34 +335,22 @@ - (void)debug:(FlutterMethodCall*)call result:(FlutterResult)result {
   }
 }
 
-+ (SEGAnalyticsConfiguration*)createConfigFromFile {
-    NSString *path = [[NSBundle mainBundle] pathForResource: @"Info" ofType: @"plist"];
-    NSDictionary *dict = [NSDictionary dictionaryWithContentsOfFile: path];
-    NSString *writeKey = [dict objectForKey: @"com.claimsforce.segment.WRITE_KEY"];
-    BOOL trackApplicationLifecycleEvents = [[dict objectForKey: @"com.claimsforce.segment.TRACK_APPLICATION_LIFECYCLE_EVENTS"] boolValue];
-    BOOL isAmplitudeIntegrationEnabled = [[dict objectForKey: @"com.claimsforce.segment.ENABLE_AMPLITUDE_INTEGRATION"] boolValue];
-    if(!writeKey) {
-        return nil;
-    }
-    SEGAnalyticsConfiguration *configuration = [SEGAnalyticsConfiguration configurationWithWriteKey:writeKey];
-    configuration.trackApplicationLifecycleEvents = trackApplicationLifecycleEvents;
-
-    if (isAmplitudeIntegrationEnabled) {
-      [configuration use:[SEGAmplitudeIntegrationFactory instance]];
-    }
-
-    return configuration;
-}
-
 + (SEGAnalyticsConfiguration*)createConfigFromDict:(NSDictionary*) dict {
     NSString *writeKey = [dict objectForKey: @"writeKey"];
     BOOL trackApplicationLifecycleEvents = [[dict objectForKey: @"trackApplicationLifecycleEvents"] boolValue];
-    BOOL isAmplitudeIntegrationEnabled = [[dict objectForKey: @"amplitudeIntegrationEnabled"] boolValue];
+    NSArray *integrationItems = [dict objectForKey: @"integrationItems"];
     SEGAnalyticsConfiguration *configuration = [SEGAnalyticsConfiguration configurationWithWriteKey:writeKey];
     configuration.trackApplicationLifecycleEvents = trackApplicationLifecycleEvents;
 
-    if (isAmplitudeIntegrationEnabled) {
-      [configuration use:[SEGAmplitudeIntegrationFactory instance]];
+    for (NSString* o in integrationItems)
+    {
+      ((void (^)())@{
+          @"amplitude" : ^{
+             [configuration use:[SEGAmplitudeIntegrationFactory instance]];
+          },
+      }[o] ?: ^{
+          //Do Nothing
+      })();
     }
 
     return configuration;

lib/src/segment_config.dart

@@ -1,22 +1,25 @@
+enum SegmentIntegrationItemType { amplitude, unknown }
+
 class SegmentConfig {
   SegmentConfig({
     required this.writeKey,
     this.trackApplicationLifecycleEvents = false,
-    this.amplitudeIntegrationEnabled = false,
     this.debug = false,
+    this.integrationItems,
   });
 
   final String writeKey;
   final bool trackApplicationLifecycleEvents;
-  final bool amplitudeIntegrationEnabled;
+  final List<SegmentIntegrationItemType>? integrationItems;
   final bool debug;
 
   Map<String, dynamic> toMap() {
     return {
       'writeKey': writeKey,
       'trackApplicationLifecycleEvents': trackApplicationLifecycleEvents,
-      'amplitudeIntegrationEnabled': amplitudeIntegrationEnabled,
       'debug': debug,
+      'integrationItems':
+          integrationItems?.map((e) => e.toString().split(".").last).toList(),
     };
   }
 }