[MOB-2971] Flutter API: logUserEventWithName: (#39)

1) Adds Api Mapping in Both android and ios
2) Adds Api method in flutter
3) Adds Testing for the API method call
4) Updates README with the method name in flutter

Author: alyezz

README.md

@@ -40,7 +40,7 @@ The table below contains a list of APIs we're planning to implement for our 1.0
 |`InstabugFlutter.setUserAttributeWithKey(String value, String key)`| `Instabug.getUserAttribute(String key)`<br>`+ [Instabug userAttributeForKey:]`                                               |
 |`InstabugFlutter.removeUserAttributeForKey(String key)`| `Instabug.removeUserAttribute(String key)`<br>`+ [Instabug removeUserAttributeForKey:]`                                      |
 |            | `Instabug.getAllUserAttributes()`<br>`+ [Instabug userAttributes:]`                                                          |
-|            | `Instabug.logUserEvent(String name)`<br>`+ [Instabug logUserEventWithName:]`                                                 |
+|`logUserEventWithName(String name)`| `Instabug.logUserEvent(String name)`<br>`+ [Instabug logUserEventWithName:]`                                                 |
 |`show()`| `Instabug.show()`<br>`+ [Instabug show]`                                                                       |
 |`invokeWithMode(InvocationMode invocationMode, [List<InvocationOption> invocationOptions])`| `BugReporting.invoke(InvocationMode mode, @InvocationOption int... options)`<br>`+ [IBGBugReporting invokeWithMode:options:]`  |
 |`logDebug(String message)`| `InstabugLog.d(String message)`<br>`+ [IBGLog logDebug:]`                                                                    |

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

@@ -299,4 +299,14 @@ public void invokeWithMode(String invocationMode, List<String> invocationOptions
         int invMode = ArgsRegistry.getDeserializedValue(invocationMode, Integer.class);
         BugReporting.show(invMode, options);
      }
+
+    /**
+     * Logs a user event that happens through the lifecycle of the application.
+     * Logged user events are going to be sent with each report, as well as at the end of a session.
+     *
+     * @param name Event name.
+     */
+    public void logUserEventWithName(String name) {
+        Instabug.logUserEvent(name);
+      }
 }

example/lib/main.dart

@@ -44,6 +44,7 @@ class _MyAppState extends State<MyApp> {
       InstabugFlutter.setUserAttributeWithKey('19', 'Age');
       InstabugFlutter.setUserAttributeWithKey('female', 'gender');
       InstabugFlutter.removeUserAttributeForKey('gender');
+      InstabugFlutter.logUserEventWithName('Aly Event');
 
     } on PlatformException {
       platformVersion = 'Failed to get platform version.';

example/test/main.dart

@@ -18,40 +18,8 @@ void main() {
         .setMockMethodCallHandler((MethodCall methodCall) async {
       log.add(methodCall);
       switch (methodCall.method) {
-        case 'startWithToken:invocationEvents:':
-          return null;
-        case 'showWelcomeMessageWithMode:':
-          return null;
-        case 'identifyUserWithEmail:':
-          return null;
-        case 'logOut':
-          return null;
-        case 'setLocale:':
-          return null;
-        case 'logVerbose:':
-          return null;
-        case 'logDebug:':
-          return null; 
-        case 'logInfo:':
-          return null; 
-        case 'clearAllLogs:':
-          return null;
-        case 'logError:':
-          return null;
-        case 'logWarn:':
-          return null;
-        case 'setColorTheme:':
-          return null; 
         case 'getTags':
           return ['tag1', 'tag2']; 
-        case 'setUserAttribute:withKey:':
-          return null;  
-        case 'removeUserAttributeForKey:':
-          return null;
-        case 'show':
-          return null;
-        case 'invokeWithMode:options:':
-          return null;
         default:
           return null;
       }
@@ -252,6 +220,7 @@ test('startWithToken:invocationEvents: Test', () async {
     ]);
   });
 
+  
   test('invokeWithMode:options: Test', () async {
     InstabugFlutter.invokeWithMode(InvocationMode.BUG, [InvocationOption.COMMENT_FIELD_REQUIRED]);
     final List<dynamic> args = <dynamic>[InvocationMode.BUG.toString(), <String>[InvocationOption.COMMENT_FIELD_REQUIRED.toString()]];
@@ -262,6 +231,16 @@ test('startWithToken:invocationEvents: Test', () async {
     ]);
   });
 
+  test('logUserEventWithName: Test', () async {
+    InstabugFlutter.logUserEventWithName(name);
+    final List<dynamic> args = <dynamic>[name];
+    expect(log, <Matcher>[
+      isMethodCall('logUserEventWithName:',
+        arguments: args,
+      )
+    ]);
+  });
+
 }
 
 

ios/Classes/InstabugFlutterPlugin.m

@@ -250,6 +250,16 @@ + (void) invokeWithMode:(NSString *)invocationMode options:(NSArray*)invocationO
     [IBGBugReporting showWithReportType:invocation options:invocationOptions];
 }
 
+ /**
+  * Logs a user event that happens through the lifecycle of the application.
+  * Logged user events are going to be sent with each report, as well as at the end of a session.
+  *
+  * @param name Event name.
+  */
++ (void) logUserEventWithName:(NSString *) name {
+    [Instabug logUserEventWithName:name];
+}
+
 + (NSDictionary *)constants {
   return @{
       @"InvocationEvent.shake": @(IBGInvocationEventShake),

lib/instabug_flutter.dart

@@ -218,4 +218,13 @@ class InstabugFlutter {
     final List<dynamic> params = <dynamic>[invocationMode.toString(), invocationOptionsStrings];
     await _channel.invokeMethod<Object>('invokeWithMode:options:',params);
   }
+
+  /// Logs a user event with [name] that happens through the lifecycle of the application.
+  /// Logged user events are going to be sent with each report, as well as at the end of a session.
+  static void logUserEventWithName(String name) async {
+    final List<String> params = <String>[name];
+    await _channel.invokeMethod<Object>('logUserEventWithName:', params);
+  }
 }
+
+