[MOB 2950] [MOB 2966] Flutter API: getUserAttributes getUserAttributeForKey (#37)

* ✨ Add android map for getUserAttributeForKey

* ✨ add ios map for getUserAttributeForKey

* ✨ add dart API for getUserAttributeForKey

* ✨ Add getUserAttributeFromKey to example app

* ✨ Add getUserAttributeForKey test

* ✨ add android map for getUserAttributes

* ✨ add ios map for getUserAttributes

* ✨ add dart API for getUserAttributes

* ✨ add the API getUserAttributes to the example app

* ✨ add getUserAttributes test and move the unit tests file from the example app to the library directory

Author: salmamali

README.md

@@ -36,10 +36,10 @@ The table below contains a list of APIs we're planning to implement for our 1.0
 |`InstabugFlutter.resetTags()`| `Instabug.resetTags()`<br>`+ [Instabug resetTags]`                                                                           |
 |`InstabugFlutter.getTags()`| `Instabug.getTags()`<br>`+ [Instabug getTags]`                                                                               |
 |            | `Instabug.setCustomTextPlaceHolders(InstabugCustomTextPlaceHolder placeholder)`<br>`+ [Instabug setValue:forStringWithKey:]` |
-|            | `Instabug.setUserAttribute(String key, String value)`<br>`+ [Instabug setUserAttribute:withKey:]`                            |
-|`InstabugFlutter.setUserAttributeWithKey(String value, String key)`| `Instabug.getUserAttribute(String key)`<br>`+ [Instabug userAttributeForKey:]`                                               |
+|`InstabugFlutter.setUserAttributeWithKey(String value, String key)`| `Instabug.setUserAttribute(String key, String value)`<br>`+ [Instabug setUserAttribute:withKey:]`                            |
+|`Instabugflutter.getUserAttributeForKey(Sring Key)`| `Instabug.getUserAttribute(String key)`<br>`+ [Instabug userAttributeForKey:]`                                               |
 |`InstabugFlutter.removeUserAttributeForKey(String key)`| `Instabug.removeUserAttribute(String key)`<br>`+ [Instabug removeUserAttributeForKey:]`                                      |
-|            | `Instabug.getAllUserAttributes()`<br>`+ [Instabug userAttributes:]`                                                          |
+|`InstabugFlutter.getUserAttributes()`| `Instabug.getAllUserAttributes()`<br>`+ [Instabug userAttributes:]`                                                          |
 |`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:]`  |

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

@@ -60,8 +60,6 @@ public void onMethodCall(MethodCall call, Result result) {
             if (callMethod.equals(method.getName())) {
                 isImplemented = true;
                 ArrayList<Object> tempParamValues = new ArrayList<>();
-                Log.e("Method Name", callMethod);
-                Log.e("Method Args", call.arguments().toString());
                 if (call.arguments != null) {
                     tempParamValues = (ArrayList<Object>) call.arguments;
                 }
@@ -266,6 +264,23 @@ public void removeUserAttributeForKey(String key) {
         Instabug.removeUserAttribute(key);
     }
 
+    /**
+     * Returns the user attribute associated with a given key.
+     * @param key The key for which to return the corresponding value.
+     * @return The value associated with aKey, or null if no value is associated with aKey.
+     */
+   public String getUserAttributeForKey(String key) {
+       return Instabug.getUserAttribute(key);
+   }
+
+    /**
+     * Returns all user attributes.
+     * @return A new HashMap containing all the currently set user attributes, or an empty HashMap if no user attributes have been set.
+     */
+   public HashMap<String, String> getUserAttributes() {
+       return Instabug.getAllUserAttributes();
+   }
+
     /**
      * invoke sdk manually
      */

example/lib/main.dart

@@ -40,10 +40,14 @@ class _MyAppState extends State<MyApp> {
       InstabugFlutter.setLocale(Locale.German);
       //InstabugFlutter.setLocale(Locale.German);
       InstabugFlutter.setColorTheme(ColorTheme.dark);
-      InstabugFlutter.appendTags(['tag1', 'tag2']);
+      InstabugFlutter.appendTags(<String>['tag1', 'tag2']);
       InstabugFlutter.setUserAttributeWithKey('19', 'Age');
       InstabugFlutter.setUserAttributeWithKey('female', 'gender');
       InstabugFlutter.removeUserAttributeForKey('gender');
+      final String value = await InstabugFlutter.getUserAttributeForKey('Age');
+      print('User Attribute ' + value);
+      final Map<String, String> userAttributes = await InstabugFlutter.getUserAttributes();
+      print(userAttributes.toString()); 
       InstabugFlutter.logUserEventWithName('Aly Event');
 
     } on PlatformException {

ios/Classes/InstabugFlutterPlugin.m

@@ -49,8 +49,8 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
 
 /**
   * starts the SDK
-  * @param {token} token The token that identifies the app
-  * @param {invocationEvents} invocationEvents The events that invoke
+  * @param token token The token that identifies the app
+  * @param invocationEvents invocationEvents The events that invoke
   * the SDK's UI.
   */
 + (void)startWithToken:(NSString *)token invocationEvents:(NSArray*)invocationEventsArray {
@@ -219,6 +219,23 @@ + (void) removeUserAttributeForKey:(NSString*) key {
     [Instabug removeUserAttributeForKey:key];
 }
 
+/**
+ * Returns the user attribute associated with a given key.
+ * @param key The key for which to return the corresponding value.
+ * @return The value associated with aKey, or nil if no value is associated with aKey.
+ */
++ (NSString*) getUserAttributeForKey:(NSString*) key {
+     return [Instabug userAttributeForKey:key];
+}
+
+/**
+ * Returns all user attributes.
+ * @return A new dictionary containing all the currently set user attributes, or an empty dictionary if no user attributes have been set.
+ */
++ (NSDictionary*) getUserAttributes {
+    return Instabug.userAttributes;
+}
+
 /**
  * invoke sdk manually
  */

lib/instabug_flutter.dart

@@ -199,6 +199,18 @@ class InstabugFlutter {
     await _channel.invokeMethod<Object>('removeUserAttributeForKey:', params);
   }
 
+  /// Returns the user attribute associated with a given [key].
+  static Future<String> getUserAttributeForKey(String key) async {
+    final List<dynamic> params = <dynamic>[key];
+    return await _channel.invokeMethod<Object>('getUserAttributeForKey:', params);
+  }
+
+  /// A new Map containing all the currently set user attributes, or an empty Map if no user attributes have been set.
+  static Future<Map<String, String>> getUserAttributes() async {
+    final Object userAttributes = await _channel.invokeMethod<Object>('getUserAttributes');
+    return userAttributes != null ? Map<String, String>.from(userAttributes) : <String, String>{};
+  }
+  
   /// invoke sdk manually
   static void show() async {
     await _channel.invokeMethod<Object>('show');

pubspec.yaml

@@ -18,6 +18,10 @@ dependencies:
   flutter:
     sdk: flutter
 
+dev_dependencies:
+  flutter_test:
+    sdk: flutter
+
 # For information on the generic Dart part of this file, see the
 # following page: https://www.dartlang.org/tools/pub/pubspec
 

example/test/main.dart renamed to test/instabug_flutter.dart

@@ -8,18 +8,24 @@ void main() {
 
   final List<MethodCall> log = <MethodCall>[];
   final appToken = '068ba9a8c3615035e163dc5f829c73be';
-  final invocationEvents = [InvocationEvent.floatingButton];
+  final List<InvocationEvent> invocationEvents = <InvocationEvent>[InvocationEvent.floatingButton];
   final email = "[email protected]";
   final name = "santa";
   String message = "Test Message";
+  const String userAttribute = '19';
+  const Map<String, String> userAttributePair = <String, String>{'gender': 'female'};
 
   setUpAll(() async {
     MethodChannel('instabug_flutter')
         .setMockMethodCallHandler((MethodCall methodCall) async {
       log.add(methodCall);
       switch (methodCall.method) {
         case 'getTags':
-          return ['tag1', 'tag2']; 
+          return <String>['tag1', 'tag2']; 
+        case 'getUserAttributeForKey:':
+          return userAttribute;
+        case 'getUserAttributes':
+          return userAttributePair;
         default:
           return null;
       }
@@ -123,7 +129,8 @@ test('startWithToken:invocationEvents: Test', () async {
     InstabugFlutter.clearAllLogs();
     expect(log, <Matcher>[
       isMethodCall('clearAllLogs',
-        arguments: null)
+        arguments: null
+      )
     ]);
   });
 
@@ -211,6 +218,27 @@ test('startWithToken:invocationEvents: Test', () async {
     ]);
   });
 
+  test('test getUserAttributeForKey should be called with a string argument and return a string', () async {
+    const String key = 'Age';
+    final String value = await InstabugFlutter.getUserAttributeForKey(key);
+    expect(log, <Matcher>[
+      isMethodCall('getUserAttributeForKey:',
+        arguments: <dynamic>[key]
+      )
+    ]);
+    expect(value, userAttribute);
+  });
+
+  test('test getuserAttributes should be called with no arguments and returns a Map', () async {
+    final Map<String, String> result = await InstabugFlutter.getUserAttributes();
+    expect(log, <Matcher>[
+      isMethodCall('getUserAttributes',
+        arguments: null
+      )
+    ]);
+    expect(result, userAttributePair);
+  });
+  
   test('show Test', () async {
     InstabugFlutter.show();
     expect(log, <Matcher>[