adonis-ally

Adonis Ally

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 :evergreen_tree:

Table of Contents

• Setup
• Available Drivers
• Config
• Getting Started
• Contribution Guidelines

## Setup

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

Install Via Npm

npm i --save adonis-ally

Register The Provider

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

const providers = [
  'adonis-ally/providers/AllyProvider'
]

Register The Middleware

A global needs to be added in order to make use of ally. The attaches a key called ally to the request object.

app/Http/kernel.js

const globalMiddleware = [
  'Adonis/Middleware/Ally'
]

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.

• Facebook
• Github
• Google
• LinkedIn
• Twitter

## 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 = yield request.ally.driver('facebook').getRedirectUrl()

redirect

Redirect to the 3rd party website.

yield request.ally.driver('facebook').redirect()

getUser

Get the user details on the redirect URL.

const user = yield request.ally.driver('facebook').getUser()

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

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

:point_right: Read the Official Documentation

## Contribution Guidelines

In favor of active development we accept contributions from everyone. You can contribute by submitting a bug, creating pull requests or even improving documentation.

You can find a complete guide to be followed strictly before submitting your pull requests in the Official Documentation.