[Mob 3209] - [MOB-32011]: Flutter API [Surveys] (#60)

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

## Mapped APIs:
* showSurvey
* hasRespondedToSurvey

### Note:
I will bump the version after the changes are accepted and start the release process

Author: alyezz

CHANGELOG.md

@@ -1,5 +1,7 @@
-## Master
+## Version 0.0.4 (2019-04-14)
 
+* Adds hasRespondedToSurvey API mapping.
+* Adds showSurvey API mapping.
 * Adds showSurveyIfAvailable API mapping.
 * Adds setShouldShowWelcomeScreen API mapping.
 * Adds setOnDismissCallback API mapping.

README.md

@@ -88,9 +88,8 @@ The section below contains the APIs we're planning to implement for our 1.0 rele
 | `setOnDismissCallback(Function function)`     | `setOnDismissCallback(OnDismissCallback onDismissCallback)`<br>`didDismissSurveyHandler`                                                    |
 | `setShouldShowWelcomeScreen(bool shouldShowWelcomeScreen)` | `setShouldShowWelcomeScreen(boolean shouldShow)`<br>`shouldShowWelcomeScreen`                                                                 |
 | `showSurveyIfAvailable()`                     | `showSurveyIfAvailable()`<br>`+ showSurveyIfAvailable`                                                                                      |
-|                                               | `showSurvey(String token)`<br>`+ showSurveyWithToken:`                                                                                      |
-|                                               | `setThresholdForReshowingSurveyAfterDismiss(int sessionsCount, int daysCount)`<br>`+ setThresholdForReshowingSurveyAfterDismiss:daysCount:` |
-|                                               | `hasRespondToSurvey(String token)`<br>`+ hasRespondedToSurveyWithToken:`                                                                    |
+| `showSurvey(String surveyToken)`              | `showSurvey(String token)`<br>`+ showSurveyWithToken:`                                                                                      |
+| `hasRespondedToSurvey(String surveyToken, Function function)`   | `hasRespondToSurvey(String token)`<br>`+ hasRespondedToSurveyWithToken:`                                                                    |
 
 ## Integration
 

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

@@ -707,4 +707,29 @@ public void showSurveysIfAvailable() {
         Surveys.showSurveyIfAvailable();
     }
 
+    /**
+     * Shows survey with a specific token.
+     * Does nothing if there are no available surveys with that specific token.
+     * Answered and cancelled surveys won't show up again.
+     *
+     * @param surveyToken A String with a survey token.
+     */
+    public void showSurveyWithToken(String surveyToken) {
+        Surveys.showSurvey(surveyToken);
+    }
+
+
+    /**
+     * Returns true if the survey with a specific token was answered before.
+     * Will return false if the token does not exist or if the survey was not answered before.
+     *
+     * @param surveyToken          the attribute key as string
+     * @return the desired value of whether the user has responded to the survey or not.
+     */
+    public void hasRespondedToSurveyWithToken(String surveyToken) {
+        boolean hasResponded;
+        hasResponded = Surveys.hasRespondToSurvey(surveyToken);
+        channel.invokeMethod("hasRespondedToSurveyCallback", hasResponded);
+    }
+
 }

example/lib/main.dart

@@ -30,7 +30,7 @@ class _MyAppState extends State<MyApp> {
     // Platform messages may fail, so we use a try/catch PlatformException.
     try {
       if (Platform.isIOS) {
-        Instabug.start('9582e6cfe34e2b8897f48cfa3b617adb', <InvocationEvent>[InvocationEvent.shake]);
+        Instabug.start('068ba9a8c3615035e163dc5f829c73be', <InvocationEvent>[InvocationEvent.shake]);
       }
       //Instabug.showWelcomeMessageWithMode(WelcomeMessageMode.beta);
       //Instabug.setWelcomeMessageMode(WelcomeMessageMode.beta);
@@ -115,16 +115,21 @@ class _MyAppState extends State<MyApp> {
      debugPrint('SDK Dismissed ReportType: ' + reportType.toString());
   }
 
+   void hasResponded(bool hasResponded) {
+    debugPrint(hasResponded.toString());
+  }
   void show() {
     //Instabug.show();
-    Surveys.getAvailableSurveys(getSurveys);
-    Surveys.showSurveyIfAvailable();
-    Surveys.setShouldShowWelcomeScreen(true);
+    // Surveys.getAvailableSurveys(getSurveys);
+    // Surveys.showSurveyIfAvailable();
+    // Surveys.setShouldShowWelcomeScreen(true);
+    Surveys.showSurvey("BHJI1iaKYhr4CYHHcUAaTg");
     //BugReporting.showWithOptions(ReportType.bug, <InvocationOption>[InvocationOption.emailFieldHidden]);
   }
 
   void invokeWithMode() {
-    BugReporting.invokeWithMode(InvocationMode.bug, [InvocationOption.emailFieldHidden]);
+    Surveys.hasRespondedToSurvey("BHJI1iaKYhr4CYHHcUAaTg", hasResponded);
+   // BugReporting.invokeWithMode(InvocationMode.bug, [InvocationOption.emailFieldHidden]);
   }
 
   void getTags() async {

ios/Classes/InstabugFlutterPlugin.m

@@ -590,6 +590,30 @@ + (void)showSurveysIfAvailable {
    [IBGSurveys showSurveyIfAvailable];
 }
 
+/**
+  * Shows survey with a specific token.
+  * Does nothing if there are no available surveys with that specific token.
+  * Answered and cancelled surveys won't show up again.
+  *
+  * @param surveyToken A String with a survey token.
+  */
++ (void)showSurveyWithToken:(NSString *)surveyToken {
+   [IBGSurveys showSurveyWithToken:surveyToken];
+}
+
+/**
+  * Returns true if the survey with a specific token was answered before.
+  * Will return false if the token does not exist or if the survey was not answered before.
+  *
+  * @param surveyToken          the attribute key as string
+  * @return the desired value of whether the user has responded to the survey or not.
+  */
++ (void)hasRespondedToSurveyWithToken:(NSString *)surveyToken {
+    bool hasResponded = [IBGSurveys hasRespondedToSurveyWithToken:surveyToken];
+    NSNumber *boolNumber = [NSNumber numberWithBool:hasResponded];
+    [channel invokeMethod:@"hasRespondedToSurveyCallback" arguments:boolNumber];
+}
+
 
 + (NSDictionary *)constants {
   return @{

lib/Surveys.dart

@@ -9,6 +9,7 @@ class Surveys {
   static Function onShowCallback;
   static Function onDismissCallback;
   static Function availableSurveysCallback;
+  static Function hasRespondedToSurveyCallback;
   static const MethodChannel _channel = MethodChannel('instabug_flutter');
 
   static Future<String> get platformVersion async {
@@ -32,6 +33,9 @@ class Surveys {
       }
       availableSurveysCallback(params);
       return ;
+    case 'hasRespondedToSurveyCallback':
+      hasRespondedToSurveyCallback(call.arguments);
+      return ;
   }
 }
    /// @summary Sets whether surveys are enabled or not.
@@ -97,4 +101,25 @@ class Surveys {
   static void showSurveyIfAvailable() async {
     await _channel.invokeMethod<Object>('showSurveysIfAvailable'); 
   } 
+
+   /// Shows survey with a specific token.
+   /// Does nothing if there are no available surveys with that specific token.
+   /// Answered and cancelled surveys won't show up again.
+   /// [surveyToken] - A String with a survey token.
+  static void showSurvey(String surveyToken) async {
+    final List<dynamic> params = <dynamic>[surveyToken];
+    await _channel.invokeMethod<Object>('showSurveyWithToken:', params); 
+  } 
+
+  /// Sets a block of code to be executed just before the SDK's UI is presented.
+   /// This block is executed on the UI thread. Could be used for performing any
+   /// UI changes  after the survey's UI is dismissed.
+   /// [function]  A callback that gets executed after the survey's UI is dismissed.
+  static void hasRespondedToSurvey(String surveyToken, Function function) async {
+     _channel.setMethodCallHandler(_handleMethod);
+    hasRespondedToSurveyCallback = function;
+    final List<dynamic> params = <dynamic>[surveyToken];
+    await _channel.invokeMethod<Object>('hasRespondedToSurveyWithToken:', params); 
+  } 
+
 }

pubspec.yaml

@@ -1,5 +1,5 @@
 name: instabug_flutter
-version: 0.0.3-alpha.1
+version: 0.0.4-alpha.1
 description: >-
   Instabug is an in-app feedback and bug reporting tool for mobile apps. 
   With just a simple shake, your users or beta testers can report bugs or 

test/instabug_flutter_test.dart

@@ -510,6 +510,28 @@ test('startWithToken:invocationEvents: Test', () async {
     ]);
   });
 
+  test('showSurveyWithToken Test', () async {
+    String token = "token";
+    final List<dynamic> args = <dynamic>[token];
+    Surveys.showSurvey(token);
+    expect(log, <Matcher>[
+      isMethodCall('showSurveyWithToken:',
+      arguments: args,
+      )
+    ]);
+  });
+
+  test('hasRespondedToSurvey Test', () async {
+    String token = "token";
+    final List<dynamic> args = <dynamic>[token];
+    Surveys.hasRespondedToSurvey(token,()=> (){});
+    expect(log, <Matcher>[
+      isMethodCall('hasRespondedToSurveyWithToken:',
+      arguments: args,
+      )
+    ]);
+  });
+
 }