[Mob 3202] - [MOB-3208]: Flutter API [Surveys] (#59)

alyezz · web-flow · commit de700ff911c5 · 2019-04-11T11:05:48.000+02:00
* Android API Mappings
* IOS API Mapping
* Flutter API Mapping
* Adds tests for new API
* updates Readme
* updated Changelog

## Mapped APIs:
* Surveys.setEnabled
* setAutoShowingEnabled
* getAvailableSurveys
* setOnShowCallback
* setOnDismissCallback
* setShouldShowWelcomeScreen
* showSurveyIfAvailable
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 ## Master
 
+* Adds showSurveyIfAvailable API mapping.
+* Adds setShouldShowWelcomeScreen API mapping.
+* Adds setOnDismissCallback API mapping.
+* Adds setOnShowCallback API mapping.
+* Adds getAvailableSurveys API mapping.
+* Adds setAutoShowingEnabled API mapping.
+* Adds Surveys.setEnabled API mapping.
 * Adds showWithOptions API mapping.
 * Adds setInvocationOptions API mapping.
 * Adds setExtendedBugReportMode API mapping.
diff --git a/README.md b/README.md
@@ -81,13 +81,13 @@ The section below contains the APIs we're planning to implement for our 1.0 rele
 
 | API Method                                    | Native Equivalent (Android/iOS)                                                                                                             |
 |-----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
-|                                               | `setState(Feature.State state)`<br>`enabled`                                                                                                |
-|                                               | `setAutoShowingEnabled(boolean isAutoShowingEnabled)`<br>`autoShowingEnabled`                                                               |
-|                                               | `getAvailableSurveys()`<br>`+ availableSurveys`                                                                                             |
-|                                               | `setOnShowCallback(OnShowCallback onShowCallback)`<br>`willShowSurveyHandler`                                                               |
-|                                               | `setOnDismissCallback(OnDismissCallback onDismissCallback)`<br>`didDismissSurveyHandler`                                                    |
-|                                               | `setShouldShowWelcomeScreen(boolean shouldShow)`<br>`shouldShowWelcomeScreen`                                                               |
-|                                               | `showSurveyIfAvailable()`<br>`+ showSurveyIfAvailable`                                                                                      |
+| `setEnabled(bool isEnabled)`                  | `setState(Feature.State state)`<br>`enabled`                                                                                                |
+| `setAutoShowingEnabled(bool isEnabled)`       | `setAutoShowingEnabled(boolean isAutoShowingEnabled)`<br>`autoShowingEnabled`                                                               |
+| `getAvailableSurveys(Function function)`      | `getAvailableSurveys()`<br>`+ availableSurveys`                                                                                             |
+| `setOnShowCallback(Function function)`        | `setOnShowCallback(OnShowCallback onShowCallback)`<br>`willShowSurveyHandler`                                                               |
+| `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:`                                                                    |
diff --git a/android/build.gradle b/android/build.gradle
@@ -34,6 +34,6 @@ android {
 }
 
 dependencies {
-    implementation 'com.instabug.library:instabug:8.1.2'
+    implementation 'com.instabug.library:instabug:8.2.0'
     testImplementation 'junit:junit:4.12'
 }
diff --git a/android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java b/android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java
@@ -20,6 +20,10 @@
 import com.instabug.library.invocation.OnInvokeCallback;
 import com.instabug.library.logging.InstabugLog;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
+import com.instabug.survey.OnDismissCallback;
+import com.instabug.survey.OnShowCallback;
+import com.instabug.survey.Survey;
+import com.instabug.survey.Surveys;
 
 import java.io.File;
 import java.lang.reflect.InvocationTargetException;
@@ -613,4 +617,94 @@ public void showBugReportingWithReportTypeAndOptions(final String reportType, fi
         int reportTypeInt = ArgsRegistry.getDeserializedValue(reportType, Integer.class);
         BugReporting.show(reportTypeInt,options);
     }
+
+    /**
+     * Show any valid survey if exist
+     *
+     * @param {isEnabled} boolean
+     */
+    public void setSurveysEnabled(final boolean isEnabled) {
+        new Handler(Looper.getMainLooper()).post(new Runnable() {
+            @Override
+            public void run() {
+                if (isEnabled) {
+                    Surveys.setState(Feature.State.ENABLED);
+                } else {
+                    Surveys.setState(Feature.State.DISABLED);
+                }
+            }
+        });
+    }
+
+    /**
+     * Set Surveys auto-showing state, default state auto-showing enabled
+     *
+     * @param isEnabled whether Surveys should be auto-showing or not
+     */
+    public void setAutoShowingSurveysEnabled(boolean isEnabled) {
+        Surveys.setAutoShowingEnabled(isEnabled);
+    }
+
+     /**
+     * Sets the runnable that gets executed just before showing any valid survey<br/>
+     * WARNING: This runs on your application's main UI thread. Please do not include
+     * any blocking operations to avoid ANRs.
+     */
+    public void setOnShowSurveyCallback() {
+            Surveys.setOnShowCallback(new OnShowCallback() {
+                @Override
+                public void onShow() {
+                    channel.invokeMethod("onShowSurveyCallback", null);
+                }
+            });
+    }
+
+    /**
+     * Sets the runnable that gets executed just after showing any valid survey<br/>
+     * WARNING: This runs on your application's main UI thread. Please do not include
+     * any blocking operations to avoid ANRs.
+     *
+     */
+    public void setOnDismissSurveyCallback() {
+
+            Surveys.setOnDismissCallback(new OnDismissCallback() {
+                @Override
+                public void onDismiss() {
+                    channel.invokeMethod("onDismissSurveyCallback", null);
+                }
+            });
+    }
+
+    /**
+     * Returns an array containing the available surveys.*
+     */
+    public void getAvailableSurveys() {
+        List<Survey> availableSurveys = Surveys.getAvailableSurveys();
+        ArrayList<String> result = new ArrayList<>();
+        for (Survey obj : availableSurveys) {
+            result.add(obj.getTitle());
+        }
+        channel.invokeMethod("availableSurveysCallback", result);
+    }
+
+
+     /**
+     * Set Surveys welcome screen enabled, default value is false
+     *
+     * @param shouldShow shouldShow whether should a welcome screen be shown
+     *                   before taking surveys or not
+     */
+    public void setShouldShowSurveysWelcomeScreen(boolean shouldShow) {
+        Surveys.setShouldShowWelcomeScreen(shouldShow);
+    }
+
+    /**
+     * Show any valid survey if exist
+     *
+     * @return true if a valid survey was shown otherwise false
+     */
+    public void showSurveysIfAvailable() {
+        Surveys.showSurveyIfAvailable();
+    }
+
 }
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -6,6 +6,7 @@ import 'package:flutter/services.dart';
 import 'package:instabug_flutter/Instabug.dart';
 import 'package:instabug_flutter/BugReporting.dart';
 import 'package:instabug_flutter/InstabugLog.dart';
+import 'package:instabug_flutter/Surveys.dart';
 
 void main() => runApp(MyApp());
 
@@ -66,10 +67,15 @@ class _MyAppState extends State<MyApp> {
       BugReporting.setOnInvokeCallback(sdkInvoked);
       BugReporting.setOnDismissCallback(sdkDismissed);
       BugReporting.setInvocationEvents(<InvocationEvent>[InvocationEvent.floatingButton]);
+      Surveys.setEnabled(true);
+      Surveys.setAutoShowingEnabled(false);
+      Surveys.setOnShowCallback(surveyShown);
+      Surveys.setOnDismissCallback(surveyDismiss);
       //BugReporting.setEnabledAttachmentTypes(false, false, false, false);
       //BugReporting.setReportTypes(<ReportType>[ReportType.FEEDBACK,ReportType.BUG]);
       //BugReporting.setExtendedBugReportMode(ExtendedBugReportMode.ENABLED_WITH_REQUIRED_FIELDS);
       //BugReporting.setInvocationOptions(<InvocationOption>[InvocationOption.EMAIL_FIELD_HIDDEN]);
+      
     } on PlatformException {
       platformVersion = 'Failed to get platform version.';
     }
@@ -87,18 +93,34 @@ class _MyAppState extends State<MyApp> {
     Instabug.resetTags();
   }
 
+  void getSurveys(List<String> surveys) {
+    int x = surveys.length;
+    debugPrint(x.toString());
+  }
+
   void sdkInvoked() {
     debugPrint("I am called before invocation");
   }
 
+  void surveyShown() {
+    debugPrint("The user will se a survey nwoww");
+  }
+
+  void surveyDismiss() {
+    debugPrint("The survey is Dismissed");
+  }
+
   void sdkDismissed(DismissType dismissType, ReportType reportType) {
     debugPrint('SDK Dismissed DismissType: ' + dismissType.toString());
      debugPrint('SDK Dismissed ReportType: ' + reportType.toString());
   }
 
   void show() {
     //Instabug.show();
-    BugReporting.showWithOptions(ReportType.bug, <InvocationOption>[InvocationOption.emailFieldHidden]);
+    Surveys.getAvailableSurveys(getSurveys);
+    Surveys.showSurveyIfAvailable();
+    Surveys.setShouldShowWelcomeScreen(true);
+    //BugReporting.showWithOptions(ReportType.bug, <InvocationOption>[InvocationOption.emailFieldHidden]);
   }
 
   void invokeWithMode() {
diff --git a/ios/Classes/InstabugFlutterPlugin.m b/ios/Classes/InstabugFlutterPlugin.m
@@ -511,6 +511,86 @@ + (void)showBugReportingWithReportTypeAndOptions:(NSString*)reportType options:(
     [IBGBugReporting showWithReportType:reportTypeInt options:invocationOptions];
 }
 
+/**
+  * Show any valid survey if exist
+  *
+  * @param {isEnabled} boolean
+  */
++ (void)setSurveysEnabled:(NSNumber *)isEnabled {
+   BOOL boolValue = [isEnabled boolValue];
+   IBGSurveys.enabled = boolValue;
+}
+
+/**
+  * Set Surveys auto-showing state, default state auto-showing enabled
+  *
+  * @param {isEnabled} whether Surveys should be auto-showing or not
+  */
++ (void)setAutoShowingSurveysEnabled:(NSNumber *)isEnabled {
+   BOOL boolValue = [isEnabled boolValue];
+   IBGSurveys.autoShowingEnabled = boolValue;
+}
+
+
+/**
+  * Sets the runnable that gets executed just before showing any valid survey<br/>
+  * WARNING: This runs on your application's main UI thread. Please do not include
+  * any blocking operations to avoid ANRs.
+  */
++ (void)setOnShowSurveyCallback {
+  IBGSurveys.willShowSurveyHandler = ^{
+           [channel invokeMethod:@"onShowSurveyCallback" arguments:nil];
+        };
+}
+
+/**
+  * Sets the runnable that gets executed just after showing any valid survey<br/>
+  * WARNING: This runs on your application's main UI thread. Please do not include
+  * any blocking operations to avoid ANRs.
+  *
+  */
++ (void)setOnDismissSurveyCallback {
+  IBGSurveys.didDismissSurveyHandler = ^{
+            [channel invokeMethod:@"onDismissSurveyCallback" arguments:nil];
+        };
+}
+
+/**
+  * Sets a block of code to be executed right after the SDK's UI is dismissed.
+  * This block is executed on the UI thread. Could be used for performing any
+  * UI changes after the SDK's UI is dismissed.
+  */
++ (void)getAvailableSurveys {
+     NSArray<IBGSurvey *> *surveys = [IBGSurveys availableSurveys];
+     NSMutableArray <NSString *> *surveysArray = [[NSMutableArray alloc] init];
+     for (IBGSurvey * survey in surveys) {
+        [surveysArray addObject:survey.title];
+    }
+    NSArray *result = [surveysArray copy];
+    [channel invokeMethod:@"availableSurveysCallback" arguments:result];
+}
+
+
+/**
+  * Set Surveys auto-showing state, default state auto-showing enabled
+  *
+  * @param {isEnabled} whether Surveys should be auto-showing or not
+  */
++ (void)setShouldShowSurveysWelcomeScreen:(NSNumber *)shouldShowWelcomeScreen {
+   BOOL boolValue = [shouldShowWelcomeScreen boolValue];
+   IBGSurveys.shouldShowWelcomeScreen = boolValue;
+}
+
+/**
+  * Show any valid survey if exist
+  *
+  * @return true if a valid survey was shown otherwise false
+  */
++ (void)showSurveysIfAvailable {
+   [IBGSurveys showSurveyIfAvailable];
+}
+
+
 + (NSDictionary *)constants {
   return @{
       @"InvocationEvent.shake": @(IBGInvocationEventShake),
diff --git a/ios/instabug_flutter.podspec b/ios/instabug_flutter.podspec
@@ -15,7 +15,7 @@ A new flutter plugin project.
   s.source_files = 'Classes/**/*'
   s.public_header_files = 'Classes/**/*.h'
   s.dependency 'Flutter'
-  s.dependency 'Instabug', '8.1'
+  s.dependency 'Instabug', '8.2.2'
 
   s.ios.deployment_target = '10.0'
 end
diff --git a/lib/Surveys.dart b/lib/Surveys.dart
diff --git a/test/instabug_flutter_test.dart b/test/instabug_flutter_test.dart

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,6 @@ android {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`dependencies {`
`37`		`- implementation 'com.instabug.library:instabug:8.1.2'`
	`37`	`+ implementation 'com.instabug.library:instabug:8.2.0'`
`38`	`38`	`testImplementation 'junit:junit:4.12'`
`39`	`39`	`}`