Add way to make login to readme easy

Author: mjcuva

config/default.json

@@ -1,4 +1,5 @@
 {
   "host": "https://metrics.readme.io",
+  "readmeUrl": "http://dash.readme.local:3000",
   "bufferLength": 10
 }

index.js

@@ -1,7 +1,10 @@
 const request = require('r2');
+const uuid = require('node-uuid');
+const jwt = require('jsonwebtoken');
 const config = require('./config');
 
 const constructPayload = require('./lib/construct-payload');
+const getReadmeData = require('./lib/get-readme-data');
 
 // We're doing this to buffer up the response body
 // so we can send it off to the metrics server
@@ -27,7 +30,7 @@ function patchResponse(res) {
   };
 }
 
-module.exports = (apiKey, group, options = {}) => {
+module.exports.metrics = (apiKey, group, options = {}) => {
   if (!apiKey) throw new Error('You must provide your ReadMe API key');
   if (!group) throw new Error('You must provide a grouping function');
 
@@ -72,3 +75,43 @@ module.exports = (apiKey, group, options = {}) => {
     return next();
   };
 };
+
+module.exports.login = (apiKey, userFnc, options = {}) => {
+  if (!apiKey) throw new Error('You must provide your ReadMe API key');
+  if (!userFnc) throw new Error('You must provide a function to get the user');
+  return async (req, res) => {
+    let u;
+    try {
+      u = userFnc(req);
+    } catch (e) {
+      // User isn't logged in
+    }
+
+    if (!u) {
+      const fullUrl = `${req.protocol}://${req.get('host')}${req.originalUrl}`;
+      return res.redirect(`${options.loginUrl}?redirect=${encodeURIComponent(fullUrl)}`);
+    }
+
+    const jwtUrl = await module.exports.magicLink(apiKey, u, req.query.redirect);
+    return res.redirect(jwtUrl);
+  };
+};
+
+module.exports.magicLink = async (apiKey, user, redirectPath = '') => {
+  if (!apiKey) throw new Error('You must provide your ReadMe API key');
+  if (!user) throw new Error('You must provide a user object');
+
+  const readmeData = await getReadmeData(apiKey);
+  let baseUrl = redirectPath;
+
+  if (!redirectPath.startsWith('http')) {
+    baseUrl = `${readmeData.baseUrl}${redirectPath}`;
+  }
+
+  const jwtOptions = {
+    jwtid: uuid.v4(),
+  };
+
+  const token = jwt.sign(user, readmeData.jwtSecret, jwtOptions);
+  return `${baseUrl}?auth_token=${token}`;
+};

lib/construct-payload.js

@@ -1,3 +1,4 @@
+const url = require('url');
 const processRequest = require('./process-request');
 const processResponse = require('./process-response');
 const { name, version } = require('../package.json');
@@ -10,7 +11,13 @@ module.exports = (req, res, group, options, { startedDateTime }) => ({
       creator: { name, version, comment: `${process.platform}/${process.version}` },
       entries: [
         {
-          pageref: req.route ? req.route.path : '',
+          pageref: req.route
+            ? url.format({
+                protocol: req.protocol,
+                host: req.get('host'),
+                pathname: req.route.path,
+              })
+            : '',
           startedDateTime: startedDateTime.toISOString(),
           time: new Date().getTime() - startedDateTime.getTime(),
           request: processRequest(req, options),

lib/get-readme-data.js

@@ -0,0 +1,24 @@
+const LRU = require('lru-cache');
+const request = require('r2');
+const config = require('../config');
+
+const cacheOptions = {
+  length: 500,
+  maxAge: 24 * 60 * 60 * 1000, // 24 Hours
+};
+
+module.exports = async apiKey => {
+  let readmeData = module.exports.cache.get(apiKey);
+
+  if (!readmeData) {
+    const encoded = Buffer.from(`${apiKey}:`).toString('base64');
+    readmeData = await request.get(`${config.readmeUrl}/api/v1/jwt-secret`, {
+      headers: { authorization: `Basic ${encoded}` },
+    }).json;
+    module.exports.cache.set(apiKey, readmeData);
+  }
+
+  return readmeData;
+};
+
+module.exports.cache = LRU(cacheOptions);

lib/process-request.js

@@ -17,7 +17,7 @@ module.exports = (req, options = {}) => {
     method: req.method,
     url: url.format({
       protocol: req.protocol,
-      host: req.get('host'),
+      host: req.headers['x-forwarded-host'] || req.get('host'),
       pathname: req.path,
       query: req.query,
     }),

package-lock.json

@@ -4,8 +4,11 @@
   "version": "0.0.0",
   "dependencies": {
     "configly": "^4.1.0",
+    "jsonwebtoken": "^8.3.0",
     "lodash.omit": "^4.5.0",
     "lodash.pick": "^4.4.0",
+    "lru-cache": "^4.1.3",
+    "node-uuid": "^1.4.8",
     "r2": "^2.0.1"
   },
   "scripts": {

package.json

@@ -57,7 +57,7 @@ describe('constructPayload()', () => {
     request(createApp({}))
       .post('/')
       .expect(({ body }) => {
-        assert.equal(body.request.log.entries[0].pageref, '/*');
+        assert(body.request.log.entries[0].pageref.endsWith('/*'));
       }));
 
   it('#startedDateTime', () => {

test/construct-payload.test.js

@@ -0,0 +1,42 @@
+/* eslint-env mocha */
+const assert = require('assert');
+const nock = require('nock');
+const config = require('../config');
+const getReadmeData = require('../lib/get-readme-data');
+
+describe('#get-readme-data', () => {
+  before(() => {
+    nock.disableNetConnect();
+    nock.enableNetConnect('127.0.0.1');
+  });
+  after(() => nock.cleanAll());
+
+  beforeEach(() => getReadmeData.cache.reset());
+
+  beforeEach(() => {
+    nock(config.readmeUrl)
+      .get('/api/v1/jwt-secret')
+      .basicAuth({
+        user: 'readme_api',
+        pass: '',
+      })
+      .reply(200, { jwtSecret: 'jwt', baseUrl: 'redirect' });
+  });
+
+  it('should send get jwt secret and redirect from readme', async function test() {
+    this.timeout(5000);
+
+    const data = await getReadmeData('readme_api');
+    assert.deepEqual(data, { jwtSecret: 'jwt', baseUrl: 'redirect' });
+  });
+
+  it('should cache if called twice', async () => {
+    await getReadmeData('readme_api');
+    const data = await getReadmeData('readme_api');
+    assert.deepEqual(data, { jwtSecret: 'jwt', baseUrl: 'redirect' });
+    assert.deepEqual(getReadmeData.cache.get('readme_api'), {
+      jwtSecret: 'jwt',
+      baseUrl: 'redirect',
+    });
+  });
+});