@autofleet/node-common 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,37 @@
+# AutoFleet Node Common
+This respostory is made in order have as much of common code as we can.
+
+Each line of code used in wrriten in this repo will be used in the enetire AutoFleet system.
+
+Make sure you have:
+* Tests
+* Docs
+
+## Network
+Server 2 Servers communication.
+
+Implement:
+* Retriving service urls from environment
+* Retry - TBD
+* Caching - TBD
+* Syntatic response for fail - TBD
+* Circuit Breaking - TBD
+
+The API is just like [axios](https://github.com/axios/axios) api but the creation of new instance **must** have either `serviceName` or `serviceUrl` in options.
+
+In case `serviceName` used the constractor will look for an environment varible with the the name `SERVICE_URL_<SERVICE_NAME>`.
+
+For Example:
+```
+const { Network } = require('@autofleet/node-common');
+
+n = new Network({ serviceName: 'TEST' });
+
+n.get('/posts/1');
+```
+.env file:
+```
+SERVICE_URL_TEST=https://jsonplaceholder.typicode.com
+```
+
+To learn more [click here](https://blog.risingstack.com/designing-microservices-architecture-for-failure/).

package/network/index.js

@@ -0,0 +1,60 @@
+const axios = require('axios');
+require('dotenv').config();
+/**
+ * Add support for nock testing 
+ * see s://github.com/axios/axios/issues/305
+ */
+if (process.env.NODE_ENV === 'test') {
+  axios.defaults.adapter = require('axios/lib/adapters/http')
+}
+
+const Methods = [
+  'get',
+  'post',
+  'delete',
+  'head',
+  'put',
+  'patch',
+  'options'
+]
+
+const defaultSettings = {
+  timeout: 2500,
+  headers: { 'X-AF-AUTH': 'ANYONE' }
+}
+
+module.exports = class Network {
+  constructor(settings = {}) {
+    this.settings = Object.assign(defaultSettings, settings)
+    this.validate()
+    this.createBaseUrl()
+    this.buildClassHttpMethods()
+  }
+
+  validate() {
+    if (!this.settings.serviceUrl && ! this.settings.serviceName) {
+      throw new Error('At least one of the settings Missing serviceUrl or serviceName')
+    }
+  }
+
+  createBaseUrl() {
+    let settings = this.settings
+    if (settings.serviceUrl) {
+      settings.baseURL = settings.serviceUrl;
+    } else if (settings.serviceName) {
+      const envServiceHostName = `${settings.serviceName}_SERVICE_HOST`
+      settings.baseURL = 'http://' + process.env[envServiceHostName]
+      if(!settings.baseURL) {
+        throw new Error(`Missing environment variable: ${envServiceHostName}`)
+      }
+    }
+  }
+  
+  /**
+   * Build class methods that wrap axios methods
+   */
+  buildClassHttpMethods() {
+    this.axios = axios.create(this.settings);
+    Methods.map((method) => this[method] = (...args) => this.axios[method](...args))
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/node-common",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "",
   "main": "index.js",
   "scripts": {

package/Network/index.js

@@ -1,44 +0,0 @@
-const axios = require('axios');
-require('dotenv').config();
-
-const HTTPMethods = [
-  'get',
-  'post',
-  'delete',
-  'head',
-  'put',
-  'patch',
-  'options'
-]
-const defaultSettings = {
-  timeout: 2500,
-  headers: { 'X-AF-AUTH': 'ANYONE' }
-}
-
-module.exports = class Network {
-  constructor(settings = {}) {
-    this.settings = Object.assign(defaultSettings, settings);
-
-    if (settings.serviceUrl) {
-      settings.baseURL = settings.serviceUrl;
-    } else if (settings.serviceName) {
-      settings.baseURL = process.env[`SERVICE_URL_${settings.serviceName}`];
-
-      if (!settings.baseURL) {
-        throw new Error(`Missing enviermint varible: SERVICE_URL_${settings.serviceName}`);
-      }
-    }
-
-    if (!settings.baseURL) {
-      throw new Error('Missing serviceUrl or serviceName')
-    }
-
-    this.axios = axios.create(settings);
-
-    HTTPMethods.map((method) => this[method] = (...args) => this.axios[method](...args)
-      .then((response) => {
-        console.log('Request:', response.config.method.toUpperCase(), response.config.url)
-        console.log('Response:', response.data)
-      }));
-  }
-}