Miss any of our Open RFC calls?Watch the recordings here! »

@adonisjs/ally

2.1.3 • Public • Published

Adonis Ally

NPM Version Build Status Appveyor Coveralls

Adonis Ally is a 1st party authentication provider for AdonisJs apps. It gives you the functionality to authenticate users using social websites like Facebook, Twitter, Google, Github etc 🌲

Setup

The setup process is simple like any other provider for AdonisJs.

Install Via Npm

adonis install @adonisjs/ally

Register The Provider

The provider needs to be registered inside start/app.js file.

const providers = [
  '@adonisjs/ally/providers/AllyProvider'
]

BOOM! Now you are good to make use of the ally provider and authenticate your users via available drivers.


## Available Drivers Below is the list of available drivers and you are free to add more.
  1. Facebook
  2. Github
  3. Google
  4. LinkedIn
  5. Twitter
  6. Instagram
  7. Foursquare

## Config

Configuration is defined inside a file called config/services.js under ally object.

config/services.js

ally: {
  facebook: {
    clientId: '',
    clientSecret: '',
    redirectUri: ''
  }
}

## Getting Started

Below is the list of methods you can make use of to redirect the user and fetch their profile details.

getRedirectUrl()

Get the redirect url for the 3rd party website.

const url = await ally.driver('facebook').getRedirectUrl()

redirect

Redirect to the 3rd party website.

await ally.driver('facebook').redirect()

getUser

Get the user details on the redirect URL.

const user = await ally.driver('facebook').getUser()

If you are working with api and you have an OAuth2 access token you can get the user calling the getUserByToken method.

const user = await ally.driver('facebook').getUserByToken(accessToken)

When you have a OAuth1 access token and Access secret key you can call

const user = await ally.driver('facebook').getUserByToken(accessToken, accessSecret)

All this methods the user is an instance of AllyUser which has following methods to access the user details.

e7f272b... get user from access token

user.getId() // user id
user.getName() // get user name
user.getEmail() // get user email address
user.getNickname() // get user nick name
user.getAvatar() // get user profile picture url
user.getAccessToken() // get access token
user.getRefreshToken() // get refresh token (only when using OAuth2)
user.getExpires() // get access token expiry (only when using OAuth2)
user.getTokenSecret() // get token secret (only when using OAuth1)

Additional Methods

user.toJSON() // get user JSON representation
user.getOriginal() // get the original response object from 3rd party website

👉 Read the Official Documentation


Moving Forward

Checkout the official documentation at the AdonisJs website for more info.

Tests

Tests are written using japa. Run the following commands to run tests.

npm run test:local
 
# report coverage 
npm run test
 
# on windows 
npm run test:win

Release History

Checkout CHANGELOG.md file for release history.

Meta

AdonisJs – @adonisframeworkvirk@adonisjs.com

Checkout LICENSE.txt for license information

Harminder Virk (Aman) - https://github.com/thetutlage

Install

npm i @adonisjs/ally

DownloadsWeekly Downloads

688

Version

2.1.3

License

MIT

Unpacked Size

92.9 kB

Total Files

33

Last publish

Collaborators

  • avatar
  • avatar