UPDATE: adding custom gateway

ironhead/app/hooks/httpClient.js

@@ -0,0 +1,13 @@
+const path = require('path');
+const httpClient = require('../../lib/package/gateway/httpClient');
+
+const CONFIG_PATH = path.join(__dirname, '../../config/http-client');
+
+module.exports = async (app, cb) => {
+    try {
+        await httpClient.init(CONFIG_PATH);
+        cb();
+    } catch (e) {
+        cb(e);
+    }
+};

ironhead/app/hooks/index.js

@@ -1,7 +1,9 @@
-const init = require('./init');
+const httpClient = require('./httpClient');
+const redis = require('./redis');
 
 const hooks = [
-    init
+    redis,
+    httpClient
 ];
 
 module.exports = hooks;

ironhead/app/hooks/redis.js

@@ -0,0 +1,10 @@
+const { init } = require('../../lib/package/adapter/redis');
+
+module.exports = async (app, cb) => {
+    try {
+        await init();
+        cb();
+    } catch (e) {
+        cb(e);
+    }
+}; 

ironhead/app/modules/story/gatewayConfig.js

@@ -0,0 +1,16 @@
+exports.article = {
+    options: {
+        server: 'api',
+        method: 'get',
+        endPoint: '/v2/everything?domains=wsj.com,nytimes.com'
+    }
+};
+
+exports.gateway = () => (
+    {
+        ttl: 60,
+        type: 'rest',
+        cache: true,
+        configKeys: ['article']
+    }
+);

ironhead/app/modules/story/routes/article.js → ironhead/app/modules/story/route.js

@@ -1,4 +1,4 @@
-const gateway = require('../../../gateway/article');
+const { gateway } = require('./gatewayConfig');
 
 module.exports = {
     domain: 'article',

ironhead/app/routes/index.js

@@ -1,4 +1,4 @@
-const article = require('../modules/story/routes/article');
+const article = require('../modules/story/route');
 
 const routes = [
 	article

ironhead/config/config.js

@@ -1,7 +1,9 @@
 const session = require('./session');
 const static = require('./static');
+const gateway = require('./gateway');
 
 module.exports = {
     static,
+    gateway,
     ...session
 };

ironhead/config/gateway.js

@@ -0,0 +1,3 @@
+const gateway = require('../lib/package/gateway');
+
+module.exports = gateway;

ironhead/config/http-client/ease/getConfig.js

@@ -0,0 +1,5 @@
+const { article } = require('../../../app/modules/story/gatewayConfig');
+
+module.exports = {
+    article
+};

ironhead/lib/package/adapter/redis/index.js

@@ -0,0 +1,28 @@
+const Redis = require('ioredis');
+Redis.Promise = require('bluebird')
+
+let connection;
+
+module.exports = {
+    init() {
+        if (connection) {
+            return Promise.resolve(connection);
+        }
+        return new Promise((resolve, reject) => {
+            connection = new Redis();
+            connection.set('testRedisConnection', 'test data');
+            connection.get('testRedisConnection', function (err, data) {
+                if (err) {
+                    reject(err);
+                } else {
+                    if (data === 'test data') {
+                        resolve(connection);
+                    }
+                }
+            });
+        });
+    },
+    getConnection() {
+        return connection;
+    }
+};

ironhead/lib/package/gateway/cacheClient.js

@@ -0,0 +1,22 @@
+const { generateKey } = require('./util');
+const { getConnection } = require('../adapter/redis');
+
+const get = async (config) => {
+    const key = generateKey(JSON.stringify(config));
+    const redis = getConnection();
+    const data = await redis.get(key);
+
+    return data;
+};
+
+const set = (config, response) => {
+    const { ttl } = config;
+    const key = generateKey(JSON.stringify(config));
+    const redis = getConnection();
+    return setTimeout(() => redis.set(key, JSON.stringify(response), 'ex', ttl), 0);
+};
+
+module.exports = {
+    get,
+    set
+};

ironhead/lib/package/gateway/httpClient.js

@@ -0,0 +1,59 @@
+const { fixtures, get } = require('../ease/orchestrator');
+/**
+ *
+ * @description **init** is the wrapper over ease for initiating the fixtures
+ * path.
+ * <br />
+ *
+ * In order to send request using <strong> ease </strong>, we need to initialize
+ * the config path, which <strong> ease </strong> keeps it in memory.
+ * <br/>
+ *
+ * Application using <strong> knucklehead </strong>, needs to initialize it in the beginning
+ * since fixturing is asynchronous.
+ *
+ * @param { fixturesPath } fixturesPath - absolute config path needs to be provided.
+ * It's not a mandatory field otherwise it will bootstrap using the default EASE_CONFIG_PATH
+ * <br />
+ * @returns { Promise } Promise - ConfigPath promise is returned
+ */
+const init = (fixturesPath) => {
+    if (!fixturesPath) throw new Error('Fixtures Path for Gateway initialization not passed.');
+    const configPath = fixturesPath;
+    return fixtures(configPath);
+};
+
+const sanitize = (configKeys, response) => {
+    const isMulti = configKeys.length > 1;
+
+    if (isMulti) {
+        const parsedResponse = configKeys.reduce((acc, key) => {
+            const { [key]: { statusCode, body } } = response;
+            acc[key] = {
+                ...body,
+                apiStatusCode: statusCode
+            };
+            return acc;
+        }, {});
+
+        return parsedResponse;
+    }
+    const [singleKeyName] = configKeys;
+    const { [singleKeyName]: { statusCode, body } } = response;
+    return {
+        ...body,
+        apiStatusCode: statusCode
+    };
+};
+
+const request = async ({ configKeys, reqConfig, handlers }) => {
+    const httpResponse = await get(configKeys, reqConfig);
+    const parsedResponse = sanitize(configKeys, httpResponse);
+    const standardResponse = typeof handler === 'function' ? handler(parsedResponse) : parsedResponse;
+    return standardResponse;
+}
+
+module.exports = {
+    init,
+    request
+};

ironhead/lib/package/gateway/index.js

@@ -0,0 +1,30 @@
+const httpClient = require('./httpClient');
+const cacheClient = require('./cacheClient');
+
+module.exports = async (props) => {
+    const { reqConfig, ...gwConfig } = props;
+    const { configKeys, cache } = gwConfig;
+
+    try {
+        if (cache) {
+            const data = await cacheClient.get(gwConfig);
+
+            if (data) {
+                console.log('hit');
+                const response = JSON.parse(data);
+                return response;
+            }
+            console.log('miss');
+            const response = await httpClient.request(props);
+            cacheClient.set(gwConfig, response);
+            return response;
+        } else {
+            const response = await httpClient.request(props);
+            return response;
+        }
+
+    } catch (e) {
+        throw e;
+    }
+};
+

ironhead/lib/package/gateway/util.js

@@ -0,0 +1,7 @@
+const crypto = require('crypto');
+
+exports.generateKey = (text) => {
+    const hash = crypto.createHash('md5');
+    hash.update(text);
+    return hash.digest('hex');
+};