add looker service, action and reducer

menji · menji · commit dfd7c74d0b34 · 2018-10-03T10:36:42.000+08:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/actions/index.js b/src/actions/index.js
@@ -12,6 +12,7 @@ import memberTaskActions from './member-tasks';
 import reviewOpportunityActions from './reviewOpportunity';
 import lookupActions from './lookup';
 import settingsActions from './settings';
+import lookerActions from './looker';
 
 export const actions = {
   auth: authActions.auth,
@@ -28,6 +29,7 @@ export const actions = {
   reviewOpportunity: reviewOpportunityActions.reviewOpportunity,
   lookup: lookupActions.lookup,
   settings: settingsActions.settings,
+  looker: lookerActions.looker,
 };
 
 export default undefined;
diff --git a/src/actions/looker.js b/src/actions/looker.js
@@ -0,0 +1,23 @@
+/**
+ * @module "actions.looker"
+ * @desc Actions related to looker data.
+ */
+
+import { createActions } from 'redux-actions';
+import { getService } from '../services/looker';
+
+/**
+ * @static
+ * @desc Creates an action that gets look data by id.
+ * @return {Action}
+ */
+async function getLookerDone(lookerId) {
+  const data = await getService().getLooker(lookerId);
+  return { data, lookerId };
+}
+
+export default createActions({
+  LOOKER: {
+    GET_LOOKER_DONE: getLookerDone,
+  },
+});
diff --git a/src/reducers/index.js b/src/reducers/index.js
@@ -20,6 +20,8 @@ import mySubmissionsManagement, { factory as mySubmissionsManagementFactory }
   from './my-submissions-management';
 import settings, { factory as settingsFactory }
   from './settings';
+import looker, { factory as lookerFactory }
+  from './looker';
 
 
 export function factory(options) {
@@ -38,6 +40,7 @@ export function factory(options) {
     reviewOpportunity: reviewOpportunityFactory(options),
     mySubmissionsManagement: mySubmissionsManagementFactory(options),
     settings: settingsFactory(options),
+    looker: lookerFactory(options),
   });
 }
 
@@ -56,4 +59,5 @@ export default ({
   reviewOpportunity,
   mySubmissionsManagement,
   settings,
+  looker,
 });
diff --git a/src/reducers/looker.js b/src/reducers/looker.js
@@ -0,0 +1,69 @@
+/**
+ * @module "reducers.looker"
+ * @desc Reducer for {@link module:actions.looker} actions.
+ *
+ * State segment managed by this reducer has the following structure:
+ * @param {Object} dataSet={}, index by lookerId.
+ */
+import _ from 'lodash';
+import { handleActions } from 'redux-actions';
+import actions from '../actions/looker';
+
+/**
+ * Handles LOOKER/GET_LOOKER_DONE action.
+ * @param {Object} state
+ * @param {Object} action Payload will be JSON from api call
+ * @return {Object} New state
+ */
+function onGetLookerDone(state, { payload }) {
+  const {
+    data: {
+      res,
+      error,
+    },
+    lookerId,
+  } = payload;
+
+  const newDataSet = {
+    ...state.dataSet,
+  };
+  newDataSet[lookerId] = {
+    lookerData: res,
+    error,
+    msg: res.message,
+  };
+  return ({
+    ...state,
+    dataSet: newDataSet,
+  });
+}
+
+/**
+ * Creates a new Looker reducer with the specified initial state.
+ * @param {Object} initialState Optional. Initial state.
+ * @return {Function} Looker reducer.
+ */
+function create(initialState = {}) {
+  const a = actions.looker;
+  return handleActions({
+    [a.getLookerDone]: onGetLookerDone,
+  }, _.defaults(initialState, {
+    dataSet: {},
+  }));
+}
+
+/**
+ * Factory which creates a new reducer.
+ * @return {Promise}
+ * @resolves {Function(state, action): state} New reducer.
+ */
+export function factory() {
+  return Promise.resolve(create());
+}
+
+/**
+ * @static
+ * @member default
+ * @desc Reducer with default initial state.
+ */
+export default create();
diff --git a/src/services/api.js b/src/services/api.js
@@ -9,6 +9,8 @@ import { config, isomorphy } from 'topcoder-react-utils';
 import { delay } from '../utils/time';
 import { setErrorIcon, ERROR_ICON_TYPES } from '../utils/errors';
 
+config.API.V4 = 'https://api.topcoder.com/v4';
+
 /* The minimal delay [ms] between API calls. To avoid problems with the requests
  * rate limits configured in Topcoder APIs, we throttle requests rate at the
  * client side, and at server-side, in dev mode (which is meant to be used for
@@ -265,3 +267,16 @@ export function getApiV3(token) {
   }
   return lastApiV3;
 }
+
+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.
+ */
+export function getApiV4(token) {
+  if (!lastApiV4 || lastApiV4.private.token !== token) {
+    lastApiV4 = new Api(config.API.V4, token);
+  }
+  return lastApiV4;
+}
diff --git a/src/services/looker.js b/src/services/looker.js
@@ -0,0 +1,48 @@
+/**
+ * @module "services.looker"
+ * @desc  This module provides a service to get look data json
+ * via API V4.
+ */
+import { getApiResponsePayloadV4 } from '../utils/tc';
+import { getApiV4 } from './api';
+
+/**
+ * Service class.
+ */
+class LookerService {
+  /**
+   * @param {String} tokenV4 Optional. Auth token for Topcoder API v4.
+   */
+  constructor(tokenV4) {
+    this.private = {
+      api: getApiV4(tokenV4),
+      tokenV4,
+    };
+  }
+
+  /**
+   * Get json look data by id.
+   * @param {String} lookerId Look id.
+   * @return {Promise} Resolves to the json data.
+   */
+  async getLooker(lookerId) {
+    const res = await this.private.api.get(`/looks/${lookerId}/run/json`);
+    return getApiResponsePayloadV4(res);
+  }
+}
+
+let lastInstance = null;
+/**
+ * Returns a new or existing looker service.
+ * @param {String} tokenV4 Optional. Auth token for Topcoder API v4.
+ * @return {LookerService} looker service object
+ */
+export function getService(tokenV4) {
+  if (!lastInstance || tokenV4 !== lastInstance.private.tokenV4) {
+    lastInstance = new LookerService(tokenV4);
+  }
+  return lastInstance;
+}
+
+/* Using default export would be confusing in this case. */
+export default undefined;
diff --git a/src/utils/tc.js b/src/utils/tc.js
@@ -37,3 +37,27 @@ export async function getApiResponsePayloadV3(res) {
   if (!x.success) throw new Error(x.content);
   return x.content;
 }
+
+
+/**
+ * Gets payload from a standard success response from TC API v4; or throws
+ * an error in case of a failure response.
+ * @param {Object} res
+ * @return {Promise} Resolves to the payload.
+ */
+export async function getApiResponsePayloadV4(res) {
+  const resJson = await res.json();
+  if (Array.isArray(resJson)) {
+    return {
+      res: resJson,
+      error: false,
+    };
+  }
+
+  const x = resJson.result;
+  return {
+    res: x.content,
+    error: !x.success,
+    status: x.status,
+  };
+}
