feat: add vatsim configuration setup (#135)

* Update index.d.ts

* Update README.md

* Update index.js

* Update index.d.ts

* Create vatsim.js

* Create vatsim-dev.js

* Update index.test-d.ts

Author: enrico-marques

README.md

@@ -64,6 +64,8 @@ You can choose some default setup to assign to `auth` option.
 - `SPOTIFY_CONFIGURATION`
 - `DISCORD_CONFIGURATION`
 - `TWITCH_CONFIGURATION`
+- `VATSIM_CONFIGURATION`
+- `VATSIM_DEV_CONFIGURATION`
 
 ### Custom configuration
 

examples/vatsim-dev.js

@@ -0,0 +1,53 @@
+'use strict'
+
+const fastify = require('fastify')({ logger: { level: 'trace' } })
+const sget = require('simple-get')
+
+// const oauthPlugin = require('fastify-oauth2')
+const oauthPlugin = require('..')
+
+fastify.register(oauthPlugin, {
+  name: 'vatsimoauthdev',
+  scope: ['full_name', 'email', 'vatsim_details', 'country'],
+  credentials: {
+    client: {
+      id: '<CLIENT_ID>',
+      secret: '<CLIENT_SECRET>'
+    },
+    auth: oauthPlugin.VATSIM_DEV_CONFIGURATION
+  },
+  startRedirectPath: '/login/vatsim',
+  callbackUri: 'http://localhost:3000/login/vatsim/callback'
+})
+
+fastify.get('/login/vatsim/callback', function (request, reply) {
+  this.vatsimoauthdev.getAccessTokenFromAuthorizationCodeFlow(
+    request,
+    (err, result) => {
+      if (err) {
+        reply.send(err)
+        return
+      }
+
+      sget.concat(
+        {
+          url: 'https://auth-dev.vatsim.net/api/user',
+          method: 'GET',
+          headers: {
+            Authorization: 'Bearer ' + result.access_token
+          },
+          json: true
+        },
+        function (err, res, data) {
+          if (err) {
+            reply.send(err)
+            return
+          }
+          reply.send(data)
+        }
+      )
+    }
+  )
+})
+
+fastify.listen(3000)

examples/vatsim.js

@@ -0,0 +1,53 @@
+'use strict'
+
+const fastify = require('fastify')({ logger: { level: 'trace' } })
+const sget = require('fastify')
+
+// const oauthPlugin = require('fastify-oauth2')
+const oauthPlugin = require('..')
+
+fastify.register(oauthPlugin, {
+  name: 'vatsimoauth',
+  scope: ['full_name', 'email', 'vatsim_details', 'country'],
+  credentials: {
+    client: {
+      id: '<CLIENT_ID>',
+      secret: '<CLIENT_SECRET>'
+    },
+    auth: oauthPlugin.VATSIM_CONFIGURATION
+  },
+  startRedirectPath: '/login/vatsim',
+  callbackUri: 'http://localhost:3000/login/vatsim/callback'
+})
+
+fastify.get('/login/vatsim/callback', function (request, reply) {
+  this.vatsimoauthdev.getAccessTokenFromAuthorizationCodeFlow(
+    request,
+    (err, result) => {
+      if (err) {
+        reply.send(err)
+        return
+      }
+
+      sget.concat(
+        {
+          url: 'https://auth.vatsim.net/api/user',
+          method: 'GET',
+          headers: {
+            Authorization: 'Bearer ' + result.access_token
+          },
+          json: true
+        },
+        function (err, res, data) {
+          if (err) {
+            reply.send(err)
+            return
+          }
+          reply.send(data)
+        }
+      )
+    }
+  )
+})
+
+fastify.listen(3000)

index.d.ts

@@ -11,6 +11,8 @@ interface FastifyOAuth2 {
   SPOTIFY_CONFIGURATION: ProviderConfiguration;
   VKONTAKTE_CONFIGURATION: ProviderConfiguration;
   TWITCH_CONFIGURATION: ProviderConfiguration;
+  VATSIM_CONFIGURATION: ProviderConfiguration;
+  VATSIM_DEV_CONFIGURATION: ProviderConfiguration;
 }
 
 export const fastifyOauth2: FastifyPluginCallback<FastifyOAuth2Options> & FastifyOAuth2

index.js

@@ -237,4 +237,18 @@ oauthPlugin.TWITCH_CONFIGURATION = {
   tokenPath: '/oauth2/token'
 }
 
+oauthPlugin.VATSIM_CONFIGURATION = {
+  authorizeHost: 'https://auth.vatsim.net',
+  authorizePath: '/oauth/authorize',
+  tokenHost: 'https://auth.vatsim.net',
+  tokenPath: '/oauth/token'
+}
+
+oauthPlugin.VATSIM_DEV_CONFIGURATION = {
+  authorizeHost: 'https://auth-dev.vatsim.net',
+  authorizePath: '/oauth/authorize',
+  tokenHost: 'https://auth-dev.vatsim.net',
+  tokenPath: '/oauth/token'
+}
+
 module.exports = oauthPlugin

test/types/index.test-d.ts

@@ -57,6 +57,8 @@ expectAssignable<ProviderConfiguration>(fastifyOauth2.MICROSOFT_CONFIGURATION);
 expectAssignable<ProviderConfiguration>(fastifyOauth2.SPOTIFY_CONFIGURATION);
 expectAssignable<ProviderConfiguration>(fastifyOauth2.VKONTAKTE_CONFIGURATION);
 expectAssignable<ProviderConfiguration>(fastifyOauth2.TWITCH_CONFIGURATION);
+expectAssignable<ProviderConfiguration>(fastifyOauth2.VATSIM_CONFIGURATION);
+expectAssignable<ProviderConfiguration>(fastifyOauth2.VATSIM_DEV_CONFIGURATION);
 
 server.get('/testOauth/callback', async request => {
   expectType<OAuth2Namespace>(server.testOAuthName);