breaking: support multiple strategies (#34)

Author: gjovanov

README.md

@@ -31,7 +31,7 @@ fastify.register(oauthPlugin, {
 })
 
 fastify.get('/login/facebook/callback', async function (request, reply) {
-  const token = await this.getAccessTokenFromAuthorizationCodeFlow(request)
+  const token = await this.facebookOAuth2.getAccessTokenFromAuthorizationCodeFlow(request)
 
   console.log(token.access_token)
 
@@ -85,11 +85,31 @@ See the [`example/`](./examples/) folder for more example.
 ## Reference
 
 This fastify plugin decorates the fastify instance with the [`simple-oauth2`](https://github.com/lelylan/simple-oauth2)
-instance.
+instance inside a **namespace** specified by the property `name`.
+
+E.g. For `name: 'customOauth2'`, the `simple-oauth2` instance will become accessible like this:
+
+`fastify.customOauth2.oauth2`
+
+In this manner we are able to register multiple OAuth providers and each OAuth providers `simple-oauth2` instance will live in it's own **namespace**.
+
+E.g. 
+
+- `fastify.facebook.oauth2`
+- `fastify.github.oauth2`
+- `fastify.spotify.oauth2`
+- `fastify.vkontakte.oauth2`
+
+Assuming we have registered multiple OAuth providers like this:
+- `fastify.register(oauthPlugin, { name: 'facebook', { ... } // facebooks credentials, startRedirectPath, callbackUri etc )`
+- `fastify.register(oauthPlugin, { name: 'github', { ... } // githubs credentials, startRedirectPath, callbackUri etc )`
+- `fastify.register(oauthPlugin, { name: 'spotify', { ... } // spotifys credentials, startRedirectPath, callbackUri etc )`
+- `fastify.register(oauthPlugin, { name: 'vkontakte', { ... } // vkontaktes credentials, startRedirectPath, callbackUri etc )`
+
 
 ## Utilities
 
-This fastify plugin adds 2 utility decorators to your fastify instance:
+This fastify plugin adds 2 utility decorators to your fastify instance using the same **namespace**:
 
   - `getAccessTokenFromAuthorizationCodeFlow(request, callback)`: A function that uses the Authorization code flow to fetch an OAuth2 token using the data in the last request of the flow. If the callback is not passed it will return a promise. The object resulting from the callback call or the promise resolution is a *token response* object containing the following keys:
     - `access_token`
@@ -98,6 +118,10 @@ This fastify plugin adds 2 utility decorators to your fastify instance:
     - `expires_in` (number of seconds for the token to expire, e.g. `240000`)
   - `getNewAccessTokenUsingRefreshToken(refreshToken, params, callback)`: A function that takes a refresh token and retrieves a new *token response* object. This is generally useful with background processing workers to re-issue a new token when the original token has expired. The `params` argument is optional and it's an object that can be used to pass in extra parameters to the refresh request (e.g. a stricter set of scopes). If the callback is not passed this function will return a promise. The object resulting from the callback call or the promise resolution is a new *token response* object (see fields above).
 
+E.g. For `name: 'customOauth2'`, both helpers `getAccessTokenFromAuthorizationCodeFlow` and `getNewAccessTokenUsingRefreshToken` will become accessible like this:
+ - `fastify.customOauth2.getAccessTokenFromAuthorizationCodeFlow`
+ - `fastify.customOauth2.getNewAccessTokenUsingRefreshToken`
+
 ## License
 
 Licensed under [MIT](./LICENSE).

examples/facebook.js

@@ -19,7 +19,7 @@ fastify.register(oauthPlugin, {
 })
 
 fastify.get('/login/facebook/callback', function (request, reply) {
-  this.getAccessTokenFromAuthorizationCodeFlow(request, (err, result) => {
+  this.facebookOAuth2.getAccessTokenFromAuthorizationCodeFlow(request, (err, result) => {
     if (err) {
       reply.send(err)
       return

examples/google.js

@@ -20,7 +20,7 @@ fastify.register(oauthPlugin, {
 })
 
 fastify.get('/login/google/callback', function (request, reply) {
-  this.getAccessTokenFromAuthorizationCodeFlow(request, (err, result) => {
+  this.googleOAuth2.getAccessTokenFromAuthorizationCodeFlow(request, (err, result) => {
     if (err) {
       reply.send(err)
       return

examples/spotify.js

@@ -16,7 +16,7 @@ fastify.register(oauthPlugin, {
 })
 
 fastify.get('/login/spotify/callback', async (req, reply) => {
-  const token = await fastify.getAccessTokenFromAuthorizationCodeFlow(req)
+  const token = await fastify.Spotify.getAccessTokenFromAuthorizationCodeFlow(req)
 
   req.log.info('The Spotify token is %o', token)
   reply.send({ access_token: token.access_token })

examples/vkontakte.js

@@ -16,7 +16,7 @@ fastify.register(oauthPlugin, {
 })
 
 fastify.get('/login/vk/callback', async (req, reply) => {
-  const token = await fastify.getAccessTokenFromAuthorizationCodeFlow(req)
+  const token = await fastify.vkOAuth2.getAccessTokenFromAuthorizationCodeFlow(req)
 
   console.log(token)
   reply.send({ access_token: token.access_token })

index.js

@@ -62,12 +62,12 @@ const oauthPlugin = fp(function (fastify, options, next) {
       state: state
     })
 
-    const authorizationUri = this[name].authorizationCode.authorizeURL(urlOptions)
+    const authorizationUri = this[name].oauth2.authorizationCode.authorizeURL(urlOptions)
     reply.redirect(authorizationUri)
   }
 
   const cbk = function (o, code, callback) {
-    return o.authorizationCode.getToken({
+    return o.oauth2.authorizationCode.getToken({
       code: code,
       redirect_uri: callbackUri
     }, callback)
@@ -95,7 +95,7 @@ const oauthPlugin = fp(function (fastify, options, next) {
   }
 
   function getNewAccessTokenUsingRefreshTokenCallbacked (refreshToken, params, callback) {
-    const accessToken = fastify[name].accessToken.create({ refresh_token: refreshToken })
+    const accessToken = fastify[name].oauth2.accessToken.create({ refresh_token: refreshToken })
     accessToken.refresh(params, callback)
   }
   const getNewAccessTokenUsingRefreshTokenPromisified = promisify(getNewAccessTokenUsingRefreshTokenCallbacked)
@@ -111,12 +111,14 @@ const oauthPlugin = fp(function (fastify, options, next) {
 
   if (startRedirectPath) {
     fastify.get(startRedirectPath, startRedirectHandler)
-    fastify.decorate('getAccessTokenFromAuthorizationCodeFlow', getAccessTokenFromAuthorizationCodeFlow)
-    fastify.decorate('getNewAccessTokenUsingRefreshToken', getNewAccessTokenUsingRefreshToken)
   }
 
   try {
-    fastify.decorate(name, oauth2)
+    fastify.decorate(name, {
+      oauth2: oauth2,
+      getAccessTokenFromAuthorizationCodeFlow,
+      getNewAccessTokenUsingRefreshToken
+    })
   } catch (e) {
     next(e)
     return

test.js

@@ -80,11 +80,11 @@ t.test('fastify-oauth2', t => {
     })
 
     fastify.get('/', function (request, reply) {
-      this.getAccessTokenFromAuthorizationCodeFlow(request, (err, result) => {
+      this.githubOAuth2.getAccessTokenFromAuthorizationCodeFlow(request, (err, result) => {
         if (err) throw err
 
         // attempts to refresh the token
-        this.getNewAccessTokenUsingRefreshToken(result.refresh_token, undefined, (err, result) => {
+        this.githubOAuth2.getNewAccessTokenUsingRefreshToken(result.refresh_token, undefined, (err, result) => {
           if (err) throw err
 
           const newToken = result
@@ -122,10 +122,10 @@ t.test('fastify-oauth2', t => {
     })
 
     fastify.get('/', function (request, reply) {
-      return this.getAccessTokenFromAuthorizationCodeFlow(request)
+      return this.githubOAuth2.getAccessTokenFromAuthorizationCodeFlow(request)
         .then(result => {
           // attempts to refresh the token
-          return this.getNewAccessTokenUsingRefreshToken(result.refresh_token)
+          return this.githubOAuth2.getNewAccessTokenUsingRefreshToken(result.refresh_token)
         })
         .then(token => {
           return {
@@ -159,7 +159,7 @@ t.test('fastify-oauth2', t => {
     })
 
     fastify.get('/', function (request, reply) {
-      return this.getAccessTokenFromAuthorizationCodeFlow(request)
+      return this.githubOAuth2.getAccessTokenFromAuthorizationCodeFlow(request)
         .catch(e => {
           reply.code(400)
           return e.message
@@ -195,7 +195,7 @@ t.test('options.name should be a string', t => {
     })
 })
 
-t.test('options.credentials should be and object', t => {
+t.test('options.credentials should be an object', t => {
   t.plan(1)
 
   const fastify = createFastify({ logger: { level: 'silent' } })
@@ -208,7 +208,7 @@ t.test('options.credentials should be and object', t => {
     })
 })
 
-t.test('options.callbackUri should be and object', t => {
+t.test('options.callbackUri should be an object', t => {
   t.plan(1)
 
   const fastify = createFastify({ logger: { level: 'silent' } })
@@ -228,7 +228,7 @@ t.test('options.callbackUri should be and object', t => {
     })
 })
 
-t.test('options.callbackUriParams should be and object', t => {
+t.test('options.callbackUriParams should be an object', t => {
   t.plan(1)
 
   const fastify = createFastify({ logger: { level: 'silent' } })
@@ -289,7 +289,7 @@ t.test('options.callbackUriParams', t => {
   })
 })
 
-t.test('options.generateStateFunction should be and object', t => {
+t.test('options.generateStateFunction should be an object', t => {
   t.plan(1)
 
   const fastify = createFastify({ logger: { level: 'silent' } })
@@ -311,7 +311,7 @@ t.test('options.generateStateFunction should be and object', t => {
     })
 })
 
-t.test('options.checkStateFunction should be and object', t => {
+t.test('options.checkStateFunction should be an object', t => {
   t.plan(1)
 
   const fastify = createFastify({ logger: { level: 'silent' } })