[Mob 3189] - [MOB-3191]: Flutter API: FileAttachments (#55)

Android API Mappings
IOS API Mapping
Flutter API Mapping
Adds tests for new API
updates Readme
updated Changelog

Author: alyezz

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## Master
 
+* Adds addFileAttachmentWithURL, addFileAttachmentWithData, clearFileAttachments API mapping.
 * Adds setUserData API mapping.
 * Adds setPrimaryColor API mapping.
 * Adds setSessionProfilerEnabled API mapping.

README.md

@@ -46,9 +46,9 @@ The section below contains the APIs we're planning to implement for our 1.0 rele
 |`setPrimaryColor(Color color)`                                       | `setPrimaryColor(@ColorInt int primaryColorValue)`<br>`tintColor`                                         |
 |                                                                      | `onReportSubmitHandler(Report.OnReportCreatedListener listener)`<br>`willSendReportHandler`.              |
 |`setUserData(String userData)`                                        | `setUserData(String userData)`<br>`userData`                                                              |
-|                                                                      | `addFileAttachment(Uri fileUri, String fileNameWithExtension)`<br>`+ addFileAttachmentWithURL:`           |
-|                                                                      | `addFileAttachment(byte[] data, String fileNameWithExtension)` `+ addFileAttachmentWithData:`             |
-|                                                                      | `clearFileAttachment()`<br>`+ clearFileAttachments`                                                       |
+| `addFileAttachmentWithURL(String filePath, String fileName)`         | `addFileAttachment(Uri fileUri, String fileNameWithExtension)`<br>`+ addFileAttachmentWithURL:`           |
+| `addFileAttachmentWithData(Uint8List data, String fileName)`         | `addFileAttachment(byte[] data, String fileNameWithExtension)` `+ addFileAttachmentWithData:`             |
+| `clearFileAttachments()`                                             | `clearFileAttachment()`<br>`+ clearFileAttachments`                                                       |
 |                                                                      | `setWelcomeMessageState(WelcomeMessage.State welcomeMessageState)`<br>`welcomeMessageMode`                |
 
 #### `BugReporting`

android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java

@@ -1,6 +1,7 @@
 package com.instabug.instabugflutter;
 
 import android.app.Application;
+import android.net.Uri;
 import android.os.Handler;
 import android.os.Looper;
 import android.util.Log;
@@ -17,6 +18,7 @@
 import com.instabug.library.logging.InstabugLog;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
 
+import java.io.File;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.util.ArrayList;
@@ -423,4 +425,38 @@ public void run() {
     public void setUserData(String userData) {
         Instabug.setUserData(userData);
     }
+
+    /**
+     * The file at filePath will be uploaded along upcoming reports with the name
+     * fileNameWithExtension
+     *
+     * @param fileUri               the file uri
+     * @param fileNameWithExtension the file name with extension
+     */
+    public void addFileAttachmentWithURL(String fileUri, String fileNameWithExtension) {
+        File file = new File(fileUri);
+        if (file.exists()) {
+            Instabug.addFileAttachment(Uri.fromFile(file), fileNameWithExtension);
+        }
+    }
+
+
+    /**
+     * The file at filePath will be uploaded along upcoming reports with the name
+     * fileNameWithExtension
+     *
+     * @param data                  the data of the file
+     * @param fileNameWithExtension the file name with extension
+     */
+    public void addFileAttachmentWithData(byte[] data, String fileNameWithExtension) {
+        Instabug.addFileAttachment(data, fileNameWithExtension);
+    }
+
+    /**
+     * Clears all Uris of the attached files.
+     * The URIs which added via {@link Instabug#addFileAttachment} API not the physical files.
+     */
+    public void clearFileAttachments() {
+        Instabug.clearFileAttachment();
+    }
 }

example/lib/main.dart

@@ -1,5 +1,6 @@
 import 'dart:async';
 import 'dart:io' show Platform;
+import 'dart:typed_data';
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
 import 'package:instabug_flutter/Instabug.dart';
@@ -54,9 +55,12 @@ class _MyAppState extends State<MyApp> {
       Instabug.setValueForStringWithKey('Send some ideas', IBGCustomTextPlaceHolderKey.REPORT_FEEDBACK);
       Instabug.setSessionProfilerEnabled(false);
       Color c = const Color.fromRGBO(255, 0, 255, 1.0);
-      Color c = const Color.fromRGBO(255, 0, 0, 1.0);
       Instabug.setPrimaryColor(c);
       Instabug.setUserData("This is some useful data");
+      var list = Uint8List(10);
+      Instabug.addFileAttachmentWithData(list, "My File");
+      Instabug.clearFileAttachments();
+      //Instabug.clearFileAttachments();
     } on PlatformException {
       platformVersion = 'Failed to get platform version.';
     }

ios/Classes/InstabugFlutterPlugin.m

@@ -319,6 +319,34 @@ + (void)setUserData:(NSString *)userData {
   [Instabug setUserData:userData];
 }
 
+/**
+  * The file at filePath will be uploaded along upcoming reports with the name
+  * fileNameWithExtension
+  *
+  * @param fileUri               the file uri
+  */
++ (void)addFileAttachmentWithURL:(NSString *)fileURLString {
+  [Instabug addFileAttachmentWithURL:[NSURL URLWithString:fileURLString]];
+}
+
+/**
+  * The file at filePath will be uploaded along upcoming reports with the name
+  * fileNameWithExtension
+  *
+  * @param data               the file data
+  */
++ (void)addFileAttachmentWithData:(FlutterStandardTypedData *)data {
+  [Instabug addFileAttachmentWithData:[data data]];
+}
+
+/**
+  * Clears all Uris of the attached files.
+  * The URIs which added via {@link Instabug#addFileAttachment} API not the physical files.
+  */
++ (void)clearFileAttachments {
+  [Instabug clearFileAttachments];
+}
+
 
 + (NSDictionary *)constants {
   return @{

lib/Instabug.dart

@@ -1,5 +1,7 @@
 import 'dart:async';
+import 'dart:typed_data';
 import 'dart:ui';
+import 'dart:io' show Platform;
 import 'package:flutter/services.dart';
 
 enum InvocationEvent {
@@ -227,6 +229,38 @@ class Instabug {
     await _channel.invokeMethod<Object>('setUserData:', params); 
   } 
 
+   ///Add file to be attached to the bug report.
+   ///[filePath] of the file
+   ///[fileName] of the file
+  static void addFileAttachmentWithURL(String filePath, String fileName) async {
+    if (Platform.isIOS) {
+      final List<dynamic> params = <dynamic>[filePath];
+      await _channel.invokeMethod<Object>('addFileAttachmentWithURL:', params); 
+    } else {
+      final List<dynamic> params = <dynamic>[filePath,fileName];
+      await _channel.invokeMethod<Object>('addFileAttachmentWithURL:', params); 
+    }
+  } 
+
+  ///Add file to be attached to the bug report.
+   ///[data] of the file
+   ///[fileName] of the file
+  static void addFileAttachmentWithData(Uint8List data, String fileName) async {
+    if (Platform.isIOS) {
+      final List<dynamic> params = <dynamic>[data];
+      await _channel.invokeMethod<Object>('addFileAttachmentWithData:', params); 
+    } else {
+      final List<dynamic> params = <dynamic>[data,fileName];
+      await _channel.invokeMethod<Object>('addFileAttachmentWithData:', params); 
+    }
+  } 
+
+  ///Clears all Uris of the attached files.
+  ///The URIs which added via {@link Instabug#addFileAttachment} API not the physical files.
+  static void clearFileAttachments() async {
+      await _channel.invokeMethod<Object>('clearFileAttachments'); 
+  } 
+
 }
 
 

test/instabug_flutter_test.dart

@@ -1,4 +1,5 @@
 import 'dart:io';
+import 'dart:typed_data';
 import 'dart:ui';
 
 import 'package:instabug_flutter/Instabug.dart';
@@ -317,6 +318,39 @@ test('startWithToken:invocationEvents: Test', () async {
     ]);
   });
 
+  test('addFileAttachmentWithURL: Test', () async {
+    String filePath = "filePath";
+    String fileName = "fileName";
+    final List<dynamic> args = <dynamic>[filePath, fileName];
+    Instabug.addFileAttachmentWithURL(filePath,fileName);
+    expect(log, <Matcher>[
+      isMethodCall('addFileAttachmentWithURL:',
+        arguments: args,
+      )
+    ]);
+  });
+
+  test('addFileAttachmentWithData: Test', () async {
+    var bdata = new Uint8List(10);
+    String fileName = "fileName";
+    final List<dynamic> args = <dynamic>[bdata, fileName];
+    Instabug.addFileAttachmentWithData(bdata,fileName);
+    expect(log, <Matcher>[
+      isMethodCall('addFileAttachmentWithData:',
+        arguments: args,
+      )
+    ]);
+  });
+
+  test('clearFileAttachments Test', () async {
+    Instabug.clearFileAttachments();
+    expect(log, <Matcher>[
+      isMethodCall('clearFileAttachments',
+        arguments: null,
+      )
+    ]);
+  });
+
 }