topcoder-platform · sushilshinde · Feb 7, 2019 · Feb 4, 2019
diff --git a/__tests__/__snapshots__/index.js.snap b/__tests__/__snapshots__/index.js.snap
@@ -237,6 +237,7 @@ Object {
   "services": Object {
     "api": Object {
       "default": [Function],
+      "getApi": [Function],
       "getApiV2": [Function],
       "getApiV3": [Function],
       "getApiV4": [Function],

diff --git a/__tests__/services/api.js b/__tests__/services/api.js
@@ -5,7 +5,7 @@ jest.mock(
 );
 
 const { config } = require('topcoder-react-utils');
-const { getApiV2, getApiV3 } = require('../../src/services/api');
+const { getApi } = require('../../src/services/api');
 
 describe('Test api', () => {
   const ENDPOINT = '/ENDPOINT';
@@ -79,43 +79,43 @@ describe('Test api', () => {
 
   let api;
   test('API v2 service works without auth token', () => {
-    api = getApiV2();
+    api = getApi('V2');
     return testApi(api, config.API.V2);
   });
 
   test('API v2 service works with auth token', () => {
-    api = getApiV2('TOKEN');
+    api = getApi('V2', 'TOKEN');
     return testApi(api, config.API.V2, 'TOKEN');
   });
 
   test(
     'API v2 service from the previous call is re-used, if token is the same',
-    () => expect(getApiV2('TOKEN')).toBe(api),
+    () => expect(getApi('V2', 'TOKEN')).toBe(api),
   );
 
   test('New API v2 service is created if token is new', () => {
-    const api2 = getApiV2('TOKEN2');
+    const api2 = getApi('V2', 'TOKEN2');
     expect(api2).not.toBe(api);
     return testApi(api2, config.API.V2, 'TOKEN2');
   });
 
   test('API v3 service works without auth token', () => {
-    api = getApiV3();
+    api = getApi('V3');
     return testApi(api, config.API.V3);
   });
 
   test('API v3 service works with auth token', () => {
-    api = getApiV3('TOKEN');
+    api = getApi('V3', 'TOKEN');
     return testApi(api, config.API.V3, 'TOKEN');
   });
 
   test(
     'API v3 service from the previous call is re-used, if token is the same',
-    () => expect(getApiV3('TOKEN')).toBe(api),
+    () => expect(getApi('V3', 'TOKEN')).toBe(api),
   );
 
   test('New API v3 service is created if token is new', () => {
-    const api2 = getApiV3('TOKEN2');
+    const api2 = getApi('V3', 'TOKEN2');
     expect(api2).not.toBe(api);
     return testApi(api2, config.API.V3, 'TOKEN2');
   });

diff --git a/dist/dev/index.js b/dist/dev/index.js
diff --git a/dist/prod/index.js b/dist/prod/index.js
diff --git a/docs/services.api.md b/docs/services.api.md
@@ -7,8 +7,7 @@ This module provides a service for conventient access to Topcoder APIs.
 * [services.api](#module_services.api)
     * _static_
         * [.default](#module_services.api.default)
-        * [.getApiV2(token)](#module_services.api.getApiV2) ⇒ <code>Api</code>
-        * [.getApiV3(token)](#module_services.api.getApiV3) ⇒ <code>Api</code>
+        * [.getApi(version, token)](#module_services.api.getApi) ⇒ <code>Api</code>
     * _inner_
         * [~Api](#module_services.api..Api)
             * [new Api(base, token)](#new_module_services.api..Api_new)
@@ -30,30 +29,19 @@ The default export from the module is
  [Api](#module_services.api..Api) class.
 
 **Kind**: static property of [<code>services.api</code>](#module_services.api)  
-<a name="module_services.api.getApiV2"></a>
+<a name="module_services.api.getApi"></a>
 
-### services.api.getApiV2(token) ⇒ <code>Api</code>
-Returns a new or existing Api object for Topcoder API v2.
+### services.api.getApi(version, token) ⇒ <code>Api</code>
+Returns a new or existing Api object for Topcoder API.
 
 **Kind**: static method of [<code>services.api</code>](#module_services.api)  
-**Returns**: <code>Api</code> - API v2 service object.  
+**Returns**: <code>Api</code> - API service object.  
 
 | Param | Type | Description |
 | --- | --- | --- |
+| version | <code>String</code> | The version of the API. |
 | token | <code>String</code> | Optional. Auth token for Topcoder API v2. |
 
-<a name="module_services.api.getApiV3"></a>
-
-### services.api.getApiV3(token) ⇒ <code>Api</code>
-Returns a new or existing Api object for Topcoder API v3
-
-**Kind**: static method of [<code>services.api</code>](#module_services.api)  
-**Returns**: <code>Api</code> - API v3 service object.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| token | <code>String</code> | Optional. Auth token for Topcoder API v3. |
-
 <a name="module_services.api..Api"></a>
 
 ### services.api~Api

diff --git a/src/actions/auth.js b/src/actions/auth.js
@@ -5,7 +5,7 @@
 
 import { createActions } from 'redux-actions';
 import { decodeToken } from 'tc-accounts';
-import { getApiV3 } from '../services/api';
+import { getApi } from '../services/api';
 
 /**
  * @static
@@ -16,7 +16,7 @@ import { getApiV3 } from '../services/api';
 function loadProfileDone(userTokenV3) {
   if (!userTokenV3) return Promise.resolve(null);
   const user = decodeToken(userTokenV3);
-  const api = getApiV3(userTokenV3);
+  const api = getApi('V3', userTokenV3);
   return Promise.all([
     api.get(`/members/${user.handle}`)
       .then(res => res.json()).then(res => (res.result.status === 200 ? res.result.content : {})),

diff --git a/src/actions/challenge.js b/src/actions/challenge.js
@@ -7,7 +7,7 @@ import _ from 'lodash';
 import { config } from 'topcoder-react-utils';
 import { createActions } from 'redux-actions';
 import { getService as getChallengesService } from '../services/challenges';
-import { getApiV2 } from '../services/api';
+import { getApi } from '../services/api';
 
 /**
  * @static
@@ -70,7 +70,7 @@ function getSubmissionsInit(challengeId) {
  * @return {Action}
  */
 function getSubmissionsDone(challengeId, tokenV2) {
-  return getApiV2(tokenV2)
+  return getApi('V2', tokenV2)
     .fetch(`/challenges/submissions/${challengeId}/mySubmissions`)
     .then(response => response.json())
     .then(response => ({
@@ -169,7 +169,7 @@ function loadResultsInit(challengeId) {
  * @return {Action}
  */
 function loadResultsDone(auth, challengeId, type) {
-  return getApiV2(auth.tokenV2)
+  return getApi('V2', auth.tokenV2)
     .fetch(`/${type}/challenges/result/${challengeId}`)
     .then(response => response.json())
     .then(response => ({
@@ -194,7 +194,7 @@ function fetchCheckpointsInit() {}
  */
 function fetchCheckpointsDone(tokenV2, challengeId) {
   const endpoint = `/design/challenges/checkpoint/${challengeId}`;
-  return getApiV2(tokenV2).fetch(endpoint)
+  return getApi('V2', tokenV2).fetch(endpoint)
     .then((response) => {
       if (response.status !== 200) {
         throw response.status;

diff --git a/src/actions/smp.js b/src/actions/smp.js
@@ -5,7 +5,7 @@
 
 import _ from 'lodash';
 import { createActions } from 'redux-actions';
-import { getApiV3 } from '../services/api';
+import { getApi } from '../services/api';
 
 /**
  * @static
@@ -22,7 +22,7 @@ function deleteSubmissionInit() {}
  * @return {Action}
  */
 function deleteSubmissionDone(tokenV3, submissionId) {
-  return getApiV3(tokenV3).delete(`/submissions/${submissionId}`)
+  return getApi('V3', tokenV3).delete(`/submissions/${submissionId}`)
     .then(() => submissionId);
 }
 

diff --git a/src/services/__mocks__/api.js b/src/services/__mocks__/api.js
@@ -103,36 +103,32 @@ export default class Api {
   }
 }
 
-/**
- * Topcoder API v2.
+/*
+ * Topcoder API
  */
+const lastApiInstances = {};
 
 /**
- * Returns a new or existing Api object for Topcoder API v2.
- * @param {String} token Optional. Auth token for Topcoder API v2.
- * @return {Api} API v2 service object.
+ * Returns a new or existing Api object for Topcoder API.
+ * @param {String} version The API version.
+ * @param {String} token Optional. Auth token for Topcoder API.
+ * @return {Api} API service object.
  */
-let lastApiV2 = null;
-export function getApiV2(token) {
-  if (!lastApiV2 || lastApiV2.private.token !== token) {
-    lastApiV2 = new Api(config.API.V2, token);
+export function getApi(version, token) {
+  if (!version || !config.API[version]) {
+    throw new Error(`${version} is not a valid API version`);
+  }
+  if (!lastApiInstances[version] || lastApiInstances[version].private.token !== token) {
+    lastApiInstances[version] = new Api(config.API[version], token);
   }
-  return lastApiV2;
+  return lastApiInstances[version];
 }
 
 /**
- * Topcoder API v3.
+ * Keep the old API factories for backwards compatibility
+ * DO NOT USE THEM FOR NEW IMPLEMENTATIONS.
+ * USE THE getApi(version, token) FACTORY.
  */
-
-/**
- * Returns a new or existing Api object for Topcoder API v3
- * @param {String} token Optional. Auth token for Topcoder API v3.
- * @return {Api} API v3 service object.
- */
-let lastApiV3 = null;
-export function getApiV3(token) {
-  if (!lastApiV3 || lastApiV3.private.token !== token) {
-    lastApiV3 = new Api(config.API.V3, token);
-  }
-  return lastApiV3;
-}
+export const getApiV2 = token => getApi('V2', token);
+export const getApiV3 = token => getApi('V3', token);
+export const getApiV4 = token => getApi('V4', token);
diff --git a/src/services/__mocks__/challenges.js b/src/services/__mocks__/challenges.js
@@ -5,7 +5,7 @@
 
 import _ from 'lodash';
 import { COMPETITION_TRACKS } from '../../utils/tc';
-import { getApiV2, getApiV3 } from './api';
+import { getApi } from './api';
 
 import sampleApiV3Response from './data/challenges-v3.json';
 import sampleApiV3ResponseSingle from './data/challenge-v3.json';
@@ -215,8 +215,8 @@ class ChallengesService {
     };
 
     this.private = {
-      api: getApiV3(tokenV3),
-      apiV2: getApiV2(tokenV2),
+      api: getApi('V3', tokenV3),
+      apiV2: getApi('V2', tokenV2),
       getChallenges,
       tokenV2,
       tokenV3,

diff --git a/src/services/__mocks__/groups.js b/src/services/__mocks__/groups.js
@@ -17,7 +17,7 @@
 
 import _ from 'lodash';
 import { config } from 'topcoder-react-utils';
-import { getApiV3 } from './api';
+import { getApi } from './api';
 import logger from '../../utils/logger';
 
 /* The value of USER_GROUP_MAXAGE constant converted to [ms]. */
@@ -172,7 +172,7 @@ class GroupService {
    */
   constructor(tokenV3) {
     this.private = {
-      api: getApiV3(tokenV3),
+      api: getApi('V3', tokenV3),
       tokenV3,
     };
   }

diff --git a/src/services/api.js b/src/services/api.js
@@ -236,51 +236,34 @@ class Api {
 export default Api;
 
 /*
- * Topcoder API v2.
+ * Topcoder API
  */
+const lastApiInstances = {};
 
-let lastApiV2 = null;
 /**
- * Returns a new or existing Api object for Topcoder API v2.
- * @param {String} token Optional. Auth token for Topcoder API v2.
- * @return {Api} API v2 service object.
+ * Returns a new or existing Api object for Topcoder API.
+ * @param {String} version The API version.
+ * @param {String} token Optional. Auth token for Topcoder API.
+ * @return {Api} API service object.
  */
-export function getApiV2(token) {
-  if (!lastApiV2 || lastApiV2.private.token !== token) {
-    lastApiV2 = new Api(config.API.V2, token);
+export function getApi(version, token) {
+  if (!version || !config.API[version]) {
+    throw new Error(`${version} is not a valid API version`);
   }
-  return lastApiV2;
-}
-
-/*
- * Topcoder API v3.
- */
-
-let lastApiV3 = null;
-/**
- * Returns a new or existing Api object for Topcoder API v3
- * @param {String} token Optional. Auth token for Topcoder API v3.
- * @return {Api} API v3 service object.
- */
-export function getApiV3(token) {
-  if (!lastApiV3 || lastApiV3.private.token !== token) {
-    lastApiV3 = new Api(config.API.V3, token);
+  if (!lastApiInstances[version] || lastApiInstances[version].private.token !== token) {
+    lastApiInstances[version] = new Api(config.API[version], token);
   }
-  return lastApiV3;
+  return lastApiInstances[version];
 }
 
-let lastApiV4 = null;
 /**
- * Returns a new or existing Api object for Topcoder API V4
- * @param {String} token Optional. Auth token for Topcoder API V4.
- * @return {Api} API V4 service object.
+ * Keep the old API factories for backwards compatibility
+ * DO NOT USE THEM FOR NEW IMPLEMENTATIONS.
+ * USE THE getApi(version, token) FACTORY.
  */
-export function getApiV4(token) {
-  if (!lastApiV4 || lastApiV4.private.token !== token) {
-    lastApiV4 = new Api(config.API.V4, token);
-  }
-  return lastApiV4;
-}
+export const getApiV2 = token => getApi('V2', token);
+export const getApiV3 = token => getApi('V3', token);
+export const getApiV4 = token => getApi('V4', token);
 
 /**
  * Gets a valid TC M2M token, either requesting one from TC Auth0 API, or

diff --git a/src/services/billing.js b/src/services/billing.js
@@ -2,7 +2,7 @@
  * @module "services.billing"
  * @desc Access to Topcoder billing accounts.
  */
-import { getApiV3 } from './api';
+import { getApi } from './api';
 
 /**
  * @static
@@ -21,7 +21,7 @@ class Billing {
    */
   constructor(tokenV3) {
     this.private = {
-      api: getApiV3(tokenV3),
+      api: getApi('V3', tokenV3),
       tokenV3,
     };
   }