Merge pull request #2 from funwithflutter/oauth-plugin

Oauth plugin

Author: funwithflutter

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.2.0
+
+- BREAKING: change in Apple authentication method
+- BREAKING: change in the way buttons are customized through `AuthConfig`
+- feat: additional sign-in providers added - Github, Twitter and Apple (iOS, Android and Web)
+- docs: various documentation updates
+
 # 0.1.3
 
 - feat: add functionality to customize notification messages

README.md

@@ -10,19 +10,19 @@ Pre-lit Firebase authentication. It provides a set of convenient utilities and w
 ## Features
 
 - **Multiple platform support**
-  - Works on mobile and web. No changes needed
+  - Works on mobile (Android/iOS) and web. No changes needed
   - Windows, macOS and Linux to be added in the future
 - **Multiple authentication providers**
-  - Package supported: Google and Apple
-  - Please see [Authentication Providers](#authentication-providers) for other sign-in providers
+  - Package supported: Google, Apple, Twitter and Github
+  - Please see [Authentication Providers](#authentication-providers) for additional information
 - **Services and state managed for you**
   - Easily interact with Firebase from anywhere in your app
   - Monitor the auth state and react to changes
 - **Error handling and error messages**
   - Built in error handling that will display friendly in-app error messages
-  - Error/Success dialogs will be customizable in future versions
+  - Error/Success dialogs can be customized
 - **Highly customizable**
-  - Either use the standard sign-in widgets, or easily create your own.
+  - Either use the standard sign-in widgets, or create your own.
 
 ## Getting started
 
@@ -122,16 +122,10 @@ class MyApp extends StatelessWidget {
       authProviders: AuthProviders(
         emailAndPassword: true, // enabled by default
         google: true,
+        apple: true,
+        twitter: true,
+        github: true,
         anonymous: true,
-        apple: AppleAuthProvider(
-          // required for web-based authentication flows (Android)
-          webAuthenticationOptions: WebAuthenticationOptions(
-            clientId: 'com.aboutyou.dart_packages.sign_in_with_apple.example', // example clientId
-            redirectUri: Uri.parse(
-              'https://flutter-sign-in-with-apple-example.glitch.me/callbacks/sign_in_with_apple', // example redirectUri
-            ),
-          ),
-        ),
       ),
       child: MaterialApp(
         title: 'Material App',
@@ -242,15 +236,51 @@ context.getSignedInUser()
 ## Authentication Providers
 For the time being, Lit Firebase auth will only directly provide Google and Apple sign in.
 
-**NOTE:** Apple requires Apple sign in to be a sign-in option if any other third-party sign-in option is used.
+**NOTE:** Apple requires Apple sign in to be enalbed if any other third-party sign-in option is used.
+
+The supported third-party providers are:
+* Google
+* Apple
+* Github
+* Twitter
+
+These need to be enabled in the `LitAuthInit` widget.
+```dart
+LitAuthInit(
+  // specify which auth providers to enable
+  authProviders: AuthProviders(
+    emailAndPassword: true, // enabled by default
+    google: true,
+    apple: true,
+    twitter: true,
+    github: true,
+    anonymous: true,
+  ),
+  child: MaterialApp(
+    title: 'Material App',
+    home: Home(),
+  ),
+);
+```
+
+To initiate authentication with one of these providers, call the relevant method. For example:
 
-Other identity providers (Facebook, Github, etc.) will need to be implemented seperately. After successful third party sign in, you can sign in to Firebase by making use of the `signInWithCredential` method available on `BuildContext`.
+```dart
+FlatButton(
+  onPressed: () {
+    context.signInWithGithub();
+  },
+  child: Text('Github Sign In'),
+),
+```
+
+Other identity providers (for example, Facebook) will need to be implemented seperately. After successful third party sign in you can sign in to Firebase by making use of the `signInWithCredential` method available on `BuildContext`.
 
 For example:
 
 ```dart
  Widget build(BuildContext context) {
-   AuthCredential credential = // get credential for identity provider (Facebook, Github, etc.)
+   AuthCredential credential = // get credential for identity provider (Facebook, etc.)
    context.signInWithCredential(credential);
  }
  ```
@@ -276,18 +306,18 @@ return LitAuth(
  ```dart
 return LitAuth(
   config: AuthConfig(
-    googleButton: ButtonConfig(
-      type: ButtonType.raised(),
-      themeData: ButtonThemeData(
-        buttonColor: Colors.red,
-      ),
-      child: Text('My styled Google Sign-in'),
+    signInButton: ButtonConfig.raised(
+      themedata: ButtonThemeData(buttonColor: Colors.red),
+      child: Text('Sign in with Email'),
     ),
+    googleButton: GoogleButtonConfig.light(),
+    appleButton: AppleButtonConfig.dark(),
   ),
-);
-
+),
  ```
 
+There are a number of different button customizations that you can do.
+
 ### Notifications
 Notifications are rendered using the [flushbar](https://pub.dev/packages/flushbar) package.
 
@@ -307,6 +337,7 @@ There are many attributes that can be altered to create the desired notification
 For further customization you can directly make use of the Lit Firebase components to build a completely custom sign-in widget.
 
 Instead of using the standard `AuthConfig`, set it to custom and provide your custom sign-in widget:
+
 ```dart
 return LitAuth.custom(
   child: YourCustomSignInWidget(),
@@ -375,14 +406,14 @@ class YourCustomSignInWidget extends StatelessWidget {
 |                   | State       |                                                                  |
 | ----------------- | ----------  | ---------------------------------------------------------------- |
 | Platforms         | ⌛          | Support more platforms (Windows, macOS, Linux)                   |
-| Auth providers    | ⌛          | Support more authentication providers (Github, Facebook)         |
+| Auth providers    | ⌛          | Support more authentication providers (Facebook, Microsoft)         |
 | Cupertino         | ⌛          | Cupertino look and feel                                          |
 | Password reset    | ❌          | Add services and UI to reset password/email                      |
 | Email confirmation| ❌          | Add UI to notify users they need to confirm their email address  |
 | Support UI        | ❌          | Assist users who cannot authenticate with support links          |
-| Custom dialogs    | ❌          | Add support to customize dialog messages                         |
+| Custom dialogs    | ✔️          | Add support to customize dialog messages                         |
 | Adaptive layouts  | ⌛          | Adaptive layouts to support multiple screen sizes               |
-| Customization     | ❌          | Even more, or easier, customization                             |
+| Customization     | ✔️          | Even more, or easier, customization                             |
 | Testing           | ❌          | Add testing                                                     |
 
 ## Dart Versions

example/lib/main.dart

@@ -11,7 +11,10 @@ class MyApp extends StatelessWidget {
       authProviders: AuthProviders(
         emailAndPassword: true, // enabled by default
         google: true,
+        apple: true,
         anonymous: true,
+        github: true,
+        twitter: true,
         // apple: AppleAuthProvider(
         //   // required for web-based authentication flows
         //   webAuthenticationOptions: WebAuthenticationOptions(
@@ -24,10 +27,15 @@ class MyApp extends StatelessWidget {
       ),
       child: MaterialApp(
         title: 'Material App',
+        themeMode: ThemeMode.light,
+        darkTheme: ThemeData.dark(),
         theme: ThemeData(
-          primaryColor: Colors.blueGrey,
-          accentColor: Colors.pink[400],
           visualDensity: VisualDensity.adaptivePlatformDensity,
+          buttonTheme: ButtonThemeData(
+            buttonColor: Colors.white,
+            textTheme: ButtonTextTheme.primary,
+            height: 40,
+          ),
         ),
         home: SplashScreen(),
       ),
@@ -56,6 +64,8 @@ class SplashScreen extends StatelessWidget {
                   textAlign: TextAlign.center,
                   style: Theme.of(context).textTheme.headline4,
                 ),
+                googleButton: GoogleButtonConfig.light(),
+                appleButton: AppleButtonConfig.dark(),
               ),
             ),
 
@@ -136,10 +146,16 @@ class CustomSignInWidget extends StatelessWidget {
                 },
                 child: Text('Anony Sign In'),
               ),
-              SignInWithAppleButton(
+              // SignInWithAppleButton(
+              //   onPressed: () {
+              //     context.signInWithApple();
+              //   },
+              // ),
+              FlatButton(
                 onPressed: () {
-                  context.signInWithApple();
+                  context.signInWithGithub();
                 },
+                child: Text('Github Sign In'),
               ),
             ],
           ),

example/pubspec.lock

@@ -78,6 +78,27 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "0.16.1"
+  firebase_auth_oauth:
+    dependency: transitive
+    description:
+      name: firebase_auth_oauth
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.1.1+1"
+  firebase_auth_oauth_platform_interface:
+    dependency: transitive
+    description:
+      name: firebase_auth_oauth_platform_interface
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.1.0+6"
+  firebase_auth_oauth_web:
+    dependency: transitive
+    description:
+      name: firebase_auth_oauth_web
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "0.1.0+7"
   firebase_auth_platform_interface:
     dependency: transitive
     description:
@@ -125,20 +146,13 @@ packages:
     description: flutter
     source: sdk
     version: "0.0.0"
-  flutter_auth_buttons:
-    dependency: transitive
-    description:
-      name: flutter_auth_buttons
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "0.8.0"
   flutter_state_notifier:
     dependency: transitive
     description:
       name: flutter_state_notifier
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.4.2"
+    version: "0.6.1"
   flutter_test:
     dependency: "direct dev"
     description: flutter
@@ -155,7 +169,7 @@ packages:
       name: freezed_annotation
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.11.0"
+    version: "0.11.0+1"
   google_sign_in:
     dependency: transitive
     description:
@@ -211,7 +225,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.1.3"
+    version: "0.2.0"
   matcher:
     dependency: transitive
     description:
@@ -268,13 +282,6 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "2.1.3"
-  sign_in_with_apple:
-    dependency: transitive
-    description:
-      name: sign_in_with_apple
-      url: "https://pub.dartlang.org"
-    source: hosted
-    version: "2.5.2"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -300,7 +307,7 @@ packages:
       name: state_notifier
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.5.0"
+    version: "0.6.0"
   stream_channel:
     dependency: transitive
     description:

graphics/apple_logo_black.png

@@ -1,5 +1,3 @@
-export 'package:sign_in_with_apple/sign_in_with_apple.dart';
-
 export 'src/domain/auth/auth_providers.dart';
 export 'src/domain/auth/i_auth_facade.dart';
 export 'src/infrastructure/firebase_auth_facade.dart';