Added docs

This commit is contained in:
thosakwe 2017-06-03 17:05:13 -04:00
parent 56598f33de
commit 9f812f2485
5 changed files with 136 additions and 3 deletions

18
.idea/auth_oauth2.iml Normal file
View file

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="WEB_MODULE" version="4">
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$">
<excludeFolder url="file://$MODULE_DIR$/.pub" />
<excludeFolder url="file://$MODULE_DIR$/.tmp" />
<excludeFolder url="file://$MODULE_DIR$/build" />
<excludeFolder url="file://$MODULE_DIR$/example/packages" />
<excludeFolder url="file://$MODULE_DIR$/packages" />
<excludeFolder url="file://$MODULE_DIR$/temp" />
<excludeFolder url="file://$MODULE_DIR$/tmp" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
<orderEntry type="library" name="Dart SDK" level="project" />
<orderEntry type="library" name="Dart Packages" level="project" />
</component>
</module>

8
.idea/modules.xml Normal file
View file

@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ProjectModuleManager">
<modules>
<module fileurl="file://$PROJECT_DIR$/.idea/auth_oauth2.iml" filepath="$PROJECT_DIR$/.idea/auth_oauth2.iml" />
</modules>
</component>
</project>

6
.idea/vcs.xml Normal file
View file

@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>

105
README.md
View file

@ -1,5 +1,106 @@
# auth_oauth2 # auth_oauth2
[![version 1.0.0](https://img.shields.io/badge/pub-1.0.0-brightgreen.svg)](https://pub.dartlang.org/packages/angel_auth_oauth2) [![version 1.0.1](https://img.shields.io/badge/pub-1.0.1-brightgreen.svg)](https://pub.dartlang.org/packages/angel_auth_oauth2)
angel_auth strategy for OAuth2 login, i.e. Facebook. `package:angel_auth` strategy for OAuth2 login, i.e. Facebook or Github.
# Usage
First, create an options object:
```dart
configureServer(Angel app) async {
// Load from a Map, i.e. app config:
var opts = new AngelOAuth2Options.fromJson(map);
// Create in-place:
const AngelAuthOAuth2Options OAUTH2_CONFIG = const AngelAuthOAuth2Options(
callback: '<callback-url>',
key: '<client-id>',
secret: '<client-secret>',
authorizationEndpoint: '<authorization-endpoint>',
tokenEndpoint: '<access-token-endpoint>');
}
```
After getting authenticated against the remote server, we need to be able to identify
users within our own application. Use an `OAuth2Verifier` to associate remote users
with local users.
```dart
/// You might use a pure function to create a verifier that queries a
/// given service.
OAuth2Verifier oauth2verifier(Service userService) {
return (oauth2.Client client) async {
var response = await client.get('https://api.github.com/user');
var ghUser = JSON.decode(response.body);
var id = ghUser['id'];
Iterable<Map> matchingUsers = await userService.index({
'query': {'githubId': id}
});
if (matchingUsers.isNotEmpty) {
// Return the corresponding user, if it exists
return User.parse(matchingUsers.firstWhere((u) => u['githubId'] == id));
} else {
// Otherwise,create a user
return await userService.create({'githubId': id}).then(User.parse);
}
};
}
```
Now, initialize an `OAuth2Strategy`, using the options and verifier.
You'll also need to provide a name for this instance of the strategy.
Consider using the name of the remote authentication provider (ex. `facebook`).
```dart
configureServer(Angel app) {
// ...
var oauthStrategy =
new OAuth2Strategy('github', OAUTH2_CONFIG, oauth2Verifier(app.service('users')));
}
```
Lastly, connect it to an `AngelAuth` instance, and wire it up to an `Angel` server.
Set up two routes:
1. Redirect users to the external provider
2. Acts as a callback and handles an access code
In the case of the callback route, you may want to display an HTML page that closes
a popup window. In this case, use `confirmPopupAuthentication`, which is bundled with
`package:angel_auth`, as a `callback` function:
```dart
configureServer(Angel app) async {
// ...
var auth = new AngelAuth();
auth.strategies.add(oauth2Strategy);
// Redirect
app.get('/auth/github', auth.authenticate('github'));
// Callback
app.get('/auth/github/callback', auth.authenticate(
'github',
new AngelAuthOptions(callback: confirmPopupAuthentication())
));
// Connect the plug-in!!!
await app.configure(auth);
}
```
## Custom Scope Delimiter
This package should work out-of-the-box for most OAuth2 providers, such as Github or Dropbox.
However, if your OAuth2 scopes are separated by a delimiter other than the default (`' '`),
you can add it in the `AngelOAuth2Options` constructor:
```dart
configureServer(Angel app) async {
const AngelOAuth2Options OPTS = const AngelOAuth2Options(
// ...
delimiter: ','
);
}
```

View file

@ -1,6 +1,6 @@
name: angel_auth_oauth2 name: angel_auth_oauth2
description: angel_auth strategy for OAuth2 login, i.e. Facebook. description: angel_auth strategy for OAuth2 login, i.e. Facebook.
version: 1.0.0 version: 1.0.1
author: Tobe O <thosakwe@gmail.com> author: Tobe O <thosakwe@gmail.com>
environment: environment:
sdk: ">=1.19.0" sdk: ">=1.19.0"