Example application & documentation update.

Author: tal-mi

CHANGELOG.md

@@ -1,8 +1,13 @@
-
 # 0.0.1
 Inital release.
 
 * Business APIs.
 * Social login (View documentation for supported providers).
 * Web Screen-Sets.
-* Interruption handling.
+* Interruption handling.
+
+# 0.0.2
+Example & documentation.
+
+* Example application updates.
+* Documentation updates.

README.md

@@ -6,14 +6,14 @@ A [Flutter](https://flutter.dev) plugin for interfacing Gigya's native SDKs into
 Flutter plugin that provides an interface for the Gigya API.
 
 ## Developers Preview Status
-The plugin allows you to use the core elements & business API's flows available within the mobile SDKs.
-Session encryption & management is handled in each platform. This plugin is currently in an early **developers preview** stage.
+The plugin allows you to use the core elements & business API flows available within the SAP Customer Data Cloud mobile SDKs.
+This plugin is currently in an early developers preview stage.
 
 ## Setup & Gigya core integration
 
 ### Android setup
 
-Please add the following to your native implementation.
+Add the following to your native implementation.
 
 ```kotlin
 class MainActivity : FlutterActivity() {
@@ -69,14 +69,14 @@ GigyaSdk.instance.send('REQUEST-ENDPOINT', {PARAMETER-MAP}).then((result) {
       debugPrint(error.errorDetails);
     });
 ```
-Example implementation is demostrated in the *send_request.dart* class of the provided example applicaiton.
+Example implementation is demonstrated in the *send_request.dart* class of the provided example application.
 
 ## Business APIs
 
-The plugin provides API to varius business APIs which iclude:
+The plugin provides an interface to these core SDK business APIs:
 **login, register, getAccount, getAccount, isLoggedIn ,logOut, addConnection, removeConnection**
 Implement them using the same request structure as shown above. 
-Example application includes the varius implementations.
+Example application includes the various implementations.
 
 ## Social login
 
@@ -86,21 +86,21 @@ The Flutter plugin supports the same *providers supported by the Core Gigya SDK.
 Supported social login providers:
 google, facebook, line, wechat, apple, amazon, linkedin, yahoo.
 
-## Embeded socail providers
+## Embedded social providers
 
-Specific social providers (Facebook, Google) require addional setup. This due to the their
+Specific social providers (Facebook, Google) require additional setup. This due to the their
 requirement for specific (embedded) SDKs.
 ```
 Example for both Facebook & Google are implemented in the example application.
 ```
 
 ### Facebook
 
-Follow the core SDK documentation and instructions for setting Facbook login.
+Follow the core SDK documentation and instructions for setting Facebook login.
 [Android documentation](https://sap.github.io/gigya-android-sdk/sdk-core/#facebook)
 [iOS documentation](https://sap.github.io/gigya-android-sdk/sdk-core/#facebook)
 
-iOS: In additon add the following to your Runner's *AppDelegate.swift* file:
+iOS: In addition add the following to your Runner's *AppDelegate.swift* file:
 ```swift
 Gigya.sharedInstance(UserHost.self).registerSocialProvider(of: .facebook, wrapper: FacebookWrapper())
 ```
@@ -112,11 +112,11 @@ the [flutter_facebook_login] plugin to your **pubspec.yaml** dependencies.
 
 ### Google
 
-Follow the core SDK documentation and instructions for setting Facbook login.
+Follow the core SDK documentation and instructions for setting Google login.
 [Android documentation](https://sap.github.io/gigya-android-sdk/sdk-core/#google)
 [iOS documentation](https://sap.github.io/gigya-swift-sdk/GigyaSwift/#google)
 
-iOS: In additon add the following to your Runner's *AppDelegate.swift* file:
+iOS: In addition add the following to your Runner's *AppDelegate.swift* file:
 ```swift
 Gigya.sharedInstance(UserHost.self).registerSocialProvider(of: .google, wrapper: GoogleWrapper())
 ```
@@ -172,7 +172,7 @@ GigyaSdk.instance.login(loginId, password).then((result) {
       final response = Account.fromJson(result);
       // Successfully logged in
     }).catchError((error) {
-      // Interruption may occured.
+      // Interruption may have occurred.
       if (error.getInterruption() == Interruption.conflictingAccounts) {
         // Reference the correct resolver
         LinkAccountResolver resolver = GigyaSdk.instance.resolverFactory.getResolver(error);
@@ -187,7 +187,7 @@ GigyaSdk.instance.login(loginId, password).then((result) {
 Once you reference your resolver, create your relevant UI to determine if a site or social linking is
 required (see example app for details) and use the relevant "resolve" method.
 
-Example of resolveing link to site when trying to link a new social account to a site account.
+Example of resolving link to site when trying to link a new social account to a site account.
 ```
 final String password = _linkPasswordController.text.trim();
 resolver.linkToSite(loginId, password).then((res) {

android/build.gradle

@@ -1,5 +1,5 @@
 group 'com.sap.gigya_flutter_plugin'
-version '0.0.1'
+version '0.0.2'
 
 buildscript {
     ext.kotlin_version = '1.3.50'

example/lib/main.dart

@@ -20,16 +20,21 @@ class _MyAppState extends State<MyApp> {
   Widget build(BuildContext context) {
     return MaterialApp(
       initialRoute: '/',
-      routes: {
-        // When navigating to the "/" route, build the FirstScreen widget.
-        '/': (context) => HomePageWidget(),
-        // When navigating to the "/second" route, build the SecondScreen widget.
-        '/send_request': (context) => SendRequestPageWidget(),
-        '/login_credentials': (context) => LoginWidthCredentialsWidget(),
-        '/register_email': (context) => RegisterWithEmailWidget(),
-        '/account_information': (context) => AccountInformationWidget(),
-        '/manage_connections': (context) => ManageConnectionWidget(),
-      },
+      routes: _exampleRoutes(),
     );
   }
+
+  /// Each route demonstrates a different flow.
+  ///
+  /// Specific implementation available in every route widget.
+  Map<String, WidgetBuilder> _exampleRoutes() {
+    return {
+      '/': (context) => HomePageWidget(),
+      '/send_request': (context) => SendRequestPageWidget(),
+      '/login_credentials': (context) => LoginWidthCredentialsWidget(),
+      '/register_email': (context) => RegisterWithEmailWidget(),
+      '/account_information': (context) => AccountInformationWidget(),
+      '/manage_connections': (context) => ManageConnectionWidget(),
+    };
+  }
 }

example/lib/routes/account_information.dart

@@ -30,18 +30,18 @@ class _AccountInformationWidgetState extends State<AccountInformationWidget> {
         builder: (context, snapshot) {
           if (snapshot.hasData) {
             Account account = snapshot.data;
-            _firstNameTextController.text = _firstNameTextController.text.isEmpty
-                ? account.profile.firstName : _firstNameTextController.text.trim() ?? '';
+            _firstNameTextController.text =
+                _firstNameTextController.text.isEmpty ? account.profile.firstName : _firstNameTextController.text.trim() ?? '';
             return Container(
               child: Column(
                 children: [
                   _inProgress
                       ? LinearProgressIndicator(
-                    minHeight: 4,
-                  )
+                          minHeight: 4,
+                        )
                       : SizedBox(
-                    height: 4,
-                  ),
+                          height: 4,
+                        ),
                   Padding(
                     padding: const EdgeInsets.all(16.0),
                     child: Column(
@@ -123,19 +123,23 @@ class _AccountInformationWidgetState extends State<AccountInformationWidget> {
     );
   }
 
+  /// Fetch account information.
   Future<Account> _getAccountInformation() async {
     var result = await GigyaSdk.instance.getAccount();
     debugPrint(jsonEncode(result));
     Account response = Account.fromJson(result);
     return response;
   }
 
+  /// Update account information given new updated [account] object.
   _updateAccountInformation(Account account) async {
     setState(() {
       _inProgress = true;
     });
     String newFirstName = _firstNameTextController.text.trim();
-    var result = await GigyaSdk.instance.setAccount({'profile' : jsonEncode({ 'firstName': newFirstName})});
+    var result = await GigyaSdk.instance.setAccount({
+      'profile': jsonEncode({'firstName': newFirstName})
+    });
     debugPrint(jsonEncode(result));
     FocusScope.of(context).unfocus();
     setState(() {

example/lib/routes/manage_connection.dart

@@ -10,7 +10,6 @@ class ManageConnectionWidget extends StatefulWidget {
 }
 
 class _ManageConnectionWidgetState extends State<ManageConnectionWidget> {
-
   @override
   Widget build(BuildContext context) {
     return Scaffold(
@@ -78,12 +77,18 @@ class _ManageConnectionWidgetState extends State<ManageConnectionWidget> {
     return response;
   }
 
+  /// Add a social connection.
+  ///
+  /// In this case adding Facebook social connection.
   void _addConnection() async {
     var result = await GigyaSdk.instance.addConnection(SocialProvider.facebook);
     debugPrint(jsonEncode(result));
     setState(() {});
   }
 
+  /// Remove a social connection.
+  ///
+  /// In this case removing Facebook connection.
   void _removeConnection() async {
     await GigyaSdk.instance.removeConnection(SocialProvider.facebook);
     setState(() {});

example/pubspec.lock

@@ -85,7 +85,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.0.1"
+    version: "0.0.2"
   google_sign_in:
     dependency: "direct main"
     description:

ios/Classes/GigyaSdkWrapper.swift

@@ -18,7 +18,7 @@ public class GigyaSdkWrapper<T: GigyaAccountProtocol> :GigyaInstanceProtocol {
 
     init(accountSchema: T.Type) {
         // Initializing the Gigya SDK instance.
-        GigyaDefinitions.versionPrefix = "flutter_0.0.1_"
+        GigyaDefinitions.versionPrefix = "flutter_0.0.2_"
         sdk = Gigya.sharedInstance(accountSchema)
     }
 

lib/interruption/interruption_resolver.dart

@@ -2,6 +2,7 @@ import 'package:flutter/services.dart';
 import 'package:gigya_flutter_plugin/gigya_flutter_plugin.dart';
 import 'package:gigya_flutter_plugin/models/gigya_models.dart';
 
+/// Determines the relevant interruption resolver according to given error.
 class ResolverFactory {
   final MethodChannel _channel;
 
@@ -21,18 +22,21 @@ class ResolverFactory {
   }
 }
 
+/// Resolver used for link account flow interruption.
 class LinkAccountResolver with DataMixin {
   final MethodChannel _channel;
 
   LinkAccountResolver(this._channel) {
     getConflictingAccounts();
   }
 
+  /// Get the user conflicting account object to determine how to resolve the flow.
   Future<ConflictingAccounts> getConflictingAccounts() async {
-    Map<String, dynamic> map =  await _channel.invokeMapMethod<String, dynamic>('getConflictingAccounts');
+    Map<String, dynamic> map = await _channel.invokeMapMethod<String, dynamic>('getConflictingAccounts');
     return ConflictingAccounts.fromJson(map);
   }
 
+  /// Link social account to existing site account.
   Future<Map<String, dynamic>> linkToSite(String loginId, String password) async {
     final Map<String, dynamic> res = await _channel.invokeMapMethod<String, dynamic>('linkToSite', {
       'loginId': loginId,
@@ -43,6 +47,7 @@ class LinkAccountResolver with DataMixin {
     return res;
   }
 
+  /// Link site account to existing social account.
   Future<Map<String, dynamic>> linkToSocial(SocialProvider provider) async {
     final Map<String, dynamic> res = await _channel.invokeMapMethod<String, dynamic>('linkToSocial', {
       'provider': provider.name,
@@ -53,11 +58,13 @@ class LinkAccountResolver with DataMixin {
   }
 }
 
+/// Resolver used for pending registration interruption.
 class PendingRegistrationResolver with DataMixin {
   final MethodChannel _channel;
 
   PendingRegistrationResolver(this._channel);
 
+  /// Set the missing account data in order to resolve the interruption.
   Future<Map<String, dynamic>> setAccount(Map<String, dynamic> map) async {
     final Map<String, dynamic> res = await _channel.invokeMapMethod<String, dynamic>('resolveSetAccount', {
       map,
@@ -68,6 +75,9 @@ class PendingRegistrationResolver with DataMixin {
   }
 }
 
+/// Resolver used for pending verification interruption.
+///
+/// Use available [regToken] value to resolve.
 class PendingVerificationResolver {
   final String _regToken;
 

lib/models/gigya_models.dart

@@ -1,5 +1,6 @@
 import 'dart:convert';
 
+/// Available interruptions.
 enum Interruption {
   pendingRegistration,
   pendingVerification,
@@ -813,8 +814,8 @@ class Work {
   }
 }
 
+/// Conflicting accounts model used for resolving a link account interruption flow.
 class ConflictingAccounts {
-
   String loginID;
   List<String> loginProviders;