feat(geolocation): geolocation utility

Author: annawen1

packages/react/.env.example

@@ -16,3 +16,6 @@ SCROLL_TRACKING=<boolean to enable scroll tracking, e.g. false>
 
 #Feature Flags
 FOOTER_LOCALE_BUTTON=<Boolean flag to turn on/off the locale selector>
+
+# Geolocation
+GEO_API=<endpoint for getting user country by geolocation>

packages/utilities/.env

@@ -0,0 +1 @@
+GEO_API=https://api.www.s81c.com/webmaster/dbip/

packages/utilities/__mocks__/axios.js

@@ -0,0 +1,3 @@
+module.exports = {
+  get: jest.fn(() => Promise.resolve({ data: {} })),
+};

packages/utilities/package.json

@@ -34,6 +34,7 @@
     "jsdoc": "rimraf docs && jsdoc -c ./jsdoc.json ./README.md"
   },
   "dependencies": {
+    "axios": "^0.19.0",
     "window-or-global": "^1.0.1"
   },
   "devDependencies": {
@@ -69,6 +70,7 @@
     "rollup": "^1.10.0",
     "rollup-plugin-babel": "^4.3.2",
     "rollup-plugin-commonjs": "^9.3.4",
+    "rollup-plugin-node-builtins": "^2.1.2",
     "rollup-plugin-node-resolve": "^4.2.3",
     "rollup-plugin-replace": "^2.2.0",
     "rollup-plugin-sizes": "^0.5.0",

packages/utilities/scripts/rollup.config.js

@@ -6,6 +6,7 @@ const gzip = require('gzip-size');
 
 const commonjs = require('rollup-plugin-commonjs');
 const resolve = require('rollup-plugin-node-resolve');
+const builtins = require('rollup-plugin-node-builtins');
 const babel = require('rollup-plugin-babel');
 const replace = require('rollup-plugin-replace');
 const { terser } = require('rollup-plugin-terser');
@@ -59,6 +60,7 @@ module.exports = {
   input: 'src/index.js',
   plugins: [
     resolve({
+      browser: true,
       mainFields: ['jsnext', 'module', 'main'],
     }),
     commonjs({
@@ -71,6 +73,7 @@ module.exports = {
     replace({
       'process.env.NODE_ENV': JSON.stringify(env),
     }),
+    builtins(),
     ...prodSettings,
   ],
   output: {

packages/utilities/src/utilities/geolocation/__tests__/geolocation.test.js

@@ -0,0 +1,32 @@
+import mockAxios from 'axios';
+import { geolocation } from '../';
+
+mockAxios.get.mockImplementationOnce(() =>
+  Promise.resolve({
+    data: {
+      country: 'us',
+    },
+  })
+);
+
+describe('Geolocation utility', () => {
+  it('should return an object with the expected cc and lc', async () => {
+    Object.defineProperty(window.navigator, 'language', {
+      writable: true,
+      value: 'en',
+    });
+
+    const info = await geolocation();
+    const endpoint = process.env.GEO_API;
+    const expected = {
+      cc: 'us',
+      lc: 'en',
+    };
+    expect(info).toStrictEqual(expected);
+    expect(mockAxios.get).toHaveBeenCalledWith(endpoint, {
+      headers: {
+        'Content-Type': 'application/json; charset=utf-8',
+      },
+    });
+  });
+});

packages/utilities/src/utilities/geolocation/geolocation.js

@@ -0,0 +1,30 @@
+import axios from 'axios';
+
+const _endpoint = process.env.GEO_API;
+/**
+ * Utility to retrieve user's country code based on their IP address
+ * and the language code from the browser language preference
+ *
+ * @returns {object} object with cc and lc data
+ *
+ */
+async function geolocation() {
+  const location = await axios
+    .get(_endpoint, {
+      headers: {
+        'Content-Type': 'application/json; charset=utf-8',
+      },
+    })
+    .then(response => response.data);
+
+  const cc = location && location.country;
+
+  // get language preference from browser
+  const lc = window.navigator.language;
+
+  if (cc && lc) {
+    return { cc, lc };
+  } else return;
+}
+
+export default geolocation;

packages/utilities/src/utilities/geolocation/index.js

@@ -0,0 +1,8 @@
+/**
+ * Copyright IBM Corp. 2016, 2018
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export { default as geolocation } from './geolocation';

packages/utilities/src/utilities/index.js

@@ -7,5 +7,6 @@
 
 export * from './escaperegexp';
 export * from './featureflag';
+export * from './geolocation';
 export * from './serialize';
 export * from './settings';