Brings getMarathonMatches(..) back into the challenges service

birdofpreyru · birdofpreyru · commit 5683ba52002e · 2018-05-22T19:23:42.000+02:00
diff --git a/__tests__/__snapshots__/index.js.snap b/__tests__/__snapshots__/index.js.snap
@@ -192,6 +192,7 @@ Object {
       "getService": [Function],
       "normalizeChallenge": [Function],
       "normalizeChallengeDetails": [Function],
+      "normalizeMarathonMatch": [Function],
     },
     "communities": Object {
       "default": undefined,
diff --git a/docs/services.challenges.md b/docs/services.challenges.md
@@ -9,6 +9,7 @@ This module provides a service for convenient manipulation with
     * _static_
         * [.normalizeChallengeDetails(v3, v3Filtered, v3User, v2, username)](#module_services.challenges.normalizeChallengeDetails) ⇒ <code>Object</code>
         * [.normalizeChallenge(challenge, username)](#module_services.challenges.normalizeChallenge)
+        * [.normalizeMarathonMatch(challenge, username)](#module_services.challenges.normalizeMarathonMatch) ⇒ <code>Object</code>
         * [.getService(tokenV3, tokenV2)](#module_services.challenges.getService) ⇒ <code>ChallengesService</code>
     * _inner_
         * [~ChallengesService](#module_services.challenges..ChallengesService)
@@ -20,6 +21,7 @@ This module provides a service for convenient manipulation with
             * [.getChallengeSubtracks()](#module_services.challenges..ChallengesService+getChallengeSubtracks) ⇒ <code>Promise</code>
             * [.getChallengeTags()](#module_services.challenges..ChallengesService+getChallengeTags) ⇒ <code>Promise</code>
             * [.getChallenges(filters, params)](#module_services.challenges..ChallengesService+getChallenges) ⇒ <code>Promise</code>
+            * [.getMarathonMatches(filters, params)](#module_services.challenges..ChallengesService+getMarathonMatches) ⇒ <code>Promise</code>
             * [.getSrms(params)](#module_services.challenges..ChallengesService+getSrms) ⇒ <code>Promise</code>
             * [.getUserChallenges(username, filters, params)](#module_services.challenges..ChallengesService+getUserChallenges) ⇒ <code>Promise</code>
             * [.getUserSrms(handle, params)](#module_services.challenges..ChallengesService+getUserSrms) ⇒ <code>Promise</code>
@@ -73,6 +75,23 @@ breaking anything.
 | challenge | <code>Object</code> | Challenge object received from the backend. |
 | username | <code>String</code> | Optional. |
 
+<a name="module_services.challenges.normalizeMarathonMatch"></a>
+
+### services.challenges.normalizeMarathonMatch(challenge, username) ⇒ <code>Object</code>
+Normalizes a marathon match challenge object received from the backend.
+NOTE: This function is copied from the existing code in the challenge listing
+component. It is possible, that this normalization is not necessary after we
+have moved to Topcoder API v3, but it is kept for now to minimize a risk of
+breaking anything.
+
+**Kind**: static method of [<code>services.challenges</code>](#module_services.challenges)  
+**Returns**: <code>Object</code> - Normalized challenge.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| challenge | <code>Object</code> | MM challenge object received from the backend. |
+| username | <code>String</code> | Optional. |
+
 <a name="module_services.challenges.getService"></a>
 
 ### services.challenges.getService(tokenV3, tokenV2) ⇒ <code>ChallengesService</code>
@@ -102,6 +121,7 @@ Challenge service.
     * [.getChallengeSubtracks()](#module_services.challenges..ChallengesService+getChallengeSubtracks) ⇒ <code>Promise</code>
     * [.getChallengeTags()](#module_services.challenges..ChallengesService+getChallengeTags) ⇒ <code>Promise</code>
     * [.getChallenges(filters, params)](#module_services.challenges..ChallengesService+getChallenges) ⇒ <code>Promise</code>
+    * [.getMarathonMatches(filters, params)](#module_services.challenges..ChallengesService+getMarathonMatches) ⇒ <code>Promise</code>
     * [.getSrms(params)](#module_services.challenges..ChallengesService+getSrms) ⇒ <code>Promise</code>
     * [.getUserChallenges(username, filters, params)](#module_services.challenges..ChallengesService+getUserChallenges) ⇒ <code>Promise</code>
     * [.getUserSrms(handle, params)](#module_services.challenges..ChallengesService+getUserSrms) ⇒ <code>Promise</code>
@@ -208,6 +228,19 @@ Gets challenges.
 | filters | <code>Object</code> | Optional. |
 | params | <code>Object</code> | Optional. |
 
+<a name="module_services.challenges..ChallengesService+getMarathonMatches"></a>
+
+#### challengesService.getMarathonMatches(filters, params) ⇒ <code>Promise</code>
+Gets marathon matches.
+
+**Kind**: instance method of [<code>ChallengesService</code>](#module_services.challenges..ChallengesService)  
+**Returns**: <code>Promise</code> - Resolve to the api response.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| filters | <code>Object</code> | Optional. |
+| params | <code>Object</code> | Optional. |
+
 <a name="module_services.challenges..ChallengesService+getSrms"></a>
 
 #### challengesService.getSrms(params) ⇒ <code>Promise</code>
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,7 +28,7 @@
     "lint:js": "./node_modules/.bin/eslint --ext .js,.jsx .",
     "test": "npm run lint && npm run jest"
   },
-  "version": "0.0.3",
+  "version": "0.0.4",
   "dependencies": {
     "isomorphic-fetch": "^2.2.1",
     "le_node": "^1.7.0",
diff --git a/src/services/challenges.js b/src/services/challenges.js
@@ -260,6 +260,71 @@ export function normalizeChallenge(challenge, username) {
   /* eslint-enable no-param-reassign */
 }
 
+/**
+ * Normalizes a marathon match challenge object received from the backend.
+ * NOTE: This function is copied from the existing code in the challenge listing
+ * component. It is possible, that this normalization is not necessary after we
+ * have moved to Topcoder API v3, but it is kept for now to minimize a risk of
+ * breaking anything.
+ * @param {Object} challenge MM challenge object received from the backend.
+ * @param {String} username Optional.
+ * @return {Object} Normalized challenge.
+ */
+export function normalizeMarathonMatch(challenge, username) {
+  const startDate = _.get(challenge, 'rounds[0].codingStartAt') || challenge.startDate;
+  const endDate = _.get(challenge, 'rounds[0].codingEndAt') || challenge.endDate;
+  const endTimestamp = new Date(endDate).getTime();
+  const status = endTimestamp > Date.now() ? 'Open' : 'Close';
+  const allPhases = [{
+    actualStartTime: startDate,
+    challengeId: challenge.id,
+    phaseType: 'Registration',
+    phaseStatus: status,
+    scheduledEndTime: endDate,
+  }, {
+    actualStartTime: startDate,
+    challengeId: challenge.id,
+    phaseType: 'Submission',
+    phaseStatus: status,
+    scheduledEndTime: endDate,
+  }];
+  const groups = {};
+  if (challenge.groupIds) {
+    challenge.groupIds.forEach((id) => {
+      groups[id] = true;
+    });
+  }
+  _.defaults(challenge, {
+    challengeCommunity: 'Data',
+    challengeType: 'Marathon',
+    allPhases,
+    currentPhases: allPhases.filter(phase => phase.phaseStatus === 'Open'),
+    communities: new Set([COMPETITION_TRACKS.DATA_SCIENCE]),
+    currentPhaseName: endTimestamp > Date.now() ? 'Registration' : '',
+    groups,
+    numRegistrants: challenge.userIds ? challenge.userIds.length : 0,
+    numSubmissions: 0, // currently challenge doesn't return submission value
+    platforms: '',
+    prizes: [0],
+    registrationOpen: endTimestamp > Date.now() &&
+      (challenge.status !== 'PAST') ? 'Yes' : 'No',
+    registrationStartDate: challenge.startDate,
+    submissionEndDate: challenge.endDate,
+    submissionEndTimestamp: endTimestamp,
+    technologies: '',
+    totalPrize: 0,
+    track: 'DATA_SCIENCE',
+    status: endTimestamp > Date.now() ? 'ACTIVE' : 'COMPLETED',
+    subTrack: 'MARATHON_MATCH',
+    users: username ? { username: true } : {},
+  });
+  /* eslint-disable no-param-reassign */
+  challenge.endDate = endDate;
+  challenge.startDate = startDate;
+  if (challenge.status === 'PAST') challenge.status = 'COMPLETED';
+  /* eslint-enable no-param-reassign */
+}
+
 /**
  * Helper method that checks for HTTP error response and throws Error in this case.
  * @param {Object} res HTTP response object
@@ -469,6 +534,20 @@ class ChallengesService {
       });
   }
 
+  /**
+   * Gets marathon matches.
+   * @param {Object} filters Optional.
+   * @param {Object} params Optional.
+   * @return {Promise} Resolve to the api response.
+   */
+  getMarathonMatches(filters, params) {
+    return this.private.getChallenges('/marathonMatches/', filters, params)
+      .then((res) => {
+        res.challenges.forEach(item => normalizeMarathonMatch(item));
+        return res;
+      });
+  }
+
   /**
    * Gets SRM matches.
    * @param {Object} params
