Simple Twitter login, without much of the bullshit. and promises... who doesn't like them?
Features
- Twitter OAuth lightweight wrap.
- Promises. 🎈
- Readable Objects.
All this in < 4kb, what else do you need? ✨
Install
$ npm i async-twitter-login
Usage
We will configure two routes in our web server, auth/login
and auth/callback
can have any name :P
Initialization
We import and instantiate, you will need your consumer key and your comsumer secret... both are obtained when creating an application from the Twitter Developer Portal.
Finally you will need your callback url, as we said before it would be https://example.com/auth/callback
.
const { AsyncTwitterLogin } = require('async-twitter-login')
import { AsyncTwitterLogin } from 'async-twitter-login'
const twitterLogin = new AsyncTwitterLogin({
consumerKey: 'your-consumer-key',
consumerSecret: 'your-consumer-secret',
callbackUrl: 'https://example.com/auth/callback'
})
Login
From our auth/login
path we call the request()
method and save in a safe place tokenSecret
to use it later.
app.get('/auth/login', async (req, res) => {
try {
const { token, tokenSecret, redirectUrl } = await twitterLogin.request()
req.session.tokenSecret = tokenSecret
res.redirect(redirectUrl)
} catch (err) {
}
})
Callback
If the user completes the authorization from twitter, he will be redirected to his auth/callback
path together with oauth_token
and oauth_verifier
as query parameters in the URL, they are accessed with req.query
.
We call the callback()
method from our auth/callback
path and pass the parameters to it along with the tokenSecret
that we saved in the previous step.
This method will return a user object. 🧔
app.get('/auth/callback', async (req, res) => {
try {
const { oauth_token: token, oauth_verifier: verifier } = req.query
const tokenSecret = req.session.tokenSecret
const user = await twitterLogin.callback(token, tokenSecret, verifier)
delete req.session.tokenSecret
req.session.user = user
res.redirect('/')
} catch (err) {
}
})
License
MIT License © 2021- Brian Fernandez.