flutter_oauth_rework 1.0.0

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • new57

Flutter OAuth

A flutter oauth package for performing user authentication for your apps.

I've tested this with a small collection of APIs (Buffer, Strava, Unsplash and Github). If there is an issue with an API you are trying to work with, please file an issue :)

Authorizing an application

Performing authorization for an API is straight forward using this library. In most cases you will just be able to use the following approach:

final OAuth flutterOAuth = new FlutterOAuth(new Config( "https://unsplash.com/oauth/authorize", "https://unsplash.com/oauth/token", "YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", "http://localhost:8080", "code"));

This allows you to pass in an Authorization URL, Token request URL, Client ID, Client Secret, Redirect URL and the response type. This should satisfy most requests, but if not then you can pass in other optional parameters for:

contentType - This allows you to change the content type for the request. Fr example, for Spotify API authorization you need to use "application/x-www-form-urlencoded"

final OAuth flutterOAuth = new FlutterOAuth(new Config( ..., contentType: "application/x-www-form-urlencoded"));

parameters - Add your own parameters that this library may not support out-of-the-box. For example, with the github API you can send a state string and scopes to gain authorization for

Map<String, String> customParameters = {"state": "SOME_RANDOM_SECURE_STRING", "scope": "public_repo"};

final OAuth flutterOAuth = new FlutterOAuth(new Config( ..., parameters: customParameters));

headers - Some APIs require you to send custom headers, such as an Authorization Header. Use this parameter if you require this

Map<String, String> headers = {"Authorization": "Basic SOME_BASE_64_STRING"};

final OAuth flutterOAuth = new FlutterOAuth(new Config( ..., headers: headers));

Token token = await gitterOAuth.signIn(); String accessToken = token.accessToken;

Thanks to

Kevin Seqaud for his awesome blog post on Flutter OAuth https://medium.com/@segaud.kevin/facebook-oauth-login-flow-with-flutter-9adb717c9f2e

THe auther, Hadrien Lejard, behind the:

The Gitter-Dart repo, where a lot of this library was influenced from https://github.com/dart-flitter/gitter_dart

and the Flutter Webview plugin which this library uses https://github.com/dart-flitter/flutter_webview_plugin

[0.0.1] - TODO: Add release date.

  • TODO: Describe initial release.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutter_oauth_rework: ^1.0.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_oauth_rework/lib/token.dart';
import 'package:flutter_oauth_rework/lib/model/config.dart';
import 'package:flutter_oauth_rework/lib/flutter_auth.dart';
import 'package:flutter_oauth_rework/lib/oauth.dart';
import 'package:flutter_oauth_rework/lib/auth_code_information.dart';
import 'package:flutter_oauth_rework/lib/oauth_token.dart';
import 'package:flutter_oauth_rework/generated/i18n.dart';
  
Version Uploaded Documentation Archive
1.0.0 Nov 14, 2018 Go to the documentation of flutter_oauth_rework 1.0.0 Download flutter_oauth_rework 1.0.0 archive
0.0.1 Nov 14, 2018 Go to the documentation of flutter_oauth_rework 0.0.1 Download flutter_oauth_rework 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
32
Health:
Code health derived from static analysis. [more]
91
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
57
Learn more about scoring.

We analyzed this package on Dec 5, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.7
  • Flutter: 1.0.0

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs (-9.42 points)

81 out of 86 API elements (library, class, field or method) have no adequate dartdoc content. Good documentation improves code readability and discoverability through search.

Maintenance issues and suggestions

Homepage does not exists. (-20 points)

We were unable to access https://brandon-welsch.eu at the time of the analysis.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use flutter_oauth_rework.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
flutter_webview_plugin ^0.2.1+2 0.2.1+2 0.3.0+2
http ^0.12.0 0.12.0
Transitive dependencies
async 2.0.8
charcode 1.1.2
collection 1.14.11
http_parser 3.1.3
meta 1.1.6
path 1.6.2
sky_engine 0.0.99
source_span 1.4.1
string_scanner 1.0.4
typed_data 1.1.6
vector_math 2.0.8