@coorpacademy/app-review 0.2.6 → 0.2.8

package/es/services/fetch-rank.d.ts

@@ -0,0 +1,2 @@
+import { Rank } from '../types/common';
+export declare const fetchRank: (token: string) => Promise<Rank>;

package/es/services/fetch-rank.js

@@ -0,0 +1,10 @@
+import crossFetch from 'cross-fetch';
+import decode from 'jwt-decode';
+import { toJSON } from './tools/fetch-responses';
+export const fetchRank = async (token) => {
+    const { user: userId, host } = decode(token);
+    const response = await crossFetch(`${host}/api/v1/leaderboard/rank/${userId}?group=ALL`, {
+        headers: { authorization: token }
+    });
+    return toJSON(response);
+};

package/es/services/index.js

@@ -1,10 +1,12 @@
 import { fetchCorrection } from './fetch-correction';
+import { fetchRank } from './fetch-rank';
 import { fetchSkills } from './fetch-skills';
 import { fetchSlide } from './fetch-slide';
 import { postAnswer } from './post-answer';
 import { postProgression } from './post-progression';
 export const getServices = () => ({
     fetchCorrection,
+    fetchRank,
     fetchSkills,
     fetchSlide,
     postAnswer,

package/es/services/test/fetch-rank.test.d.ts

@@ -0,0 +1 @@
+export {};

package/es/services/test/fetch-rank.test.js

@@ -0,0 +1,24 @@
+import test from 'ava';
+import nock from 'nock';
+import { fetchRank } from '../fetch-rank';
+const result = {
+    rank: 93
+};
+test.before(() => {
+    nock('http://localhost:3000')
+        .get('/api/v1/leaderboard/rank/592d830b240b923f00bffba6?group=ALL')
+        .reply(200, result);
+});
+test.after(() => {
+    nock.cleanAll();
+});
+test('should fetch rank with success', async (t) => {
+    const token = process.env.API_TEST_TOKEN || '';
+    const rank = await fetchRank(token);
+    t.deepEqual(result, rank);
+});
+test('should reject bad token', async (t) => {
+    const badToken = 'token is not a jwt';
+    const error = await t.throwsAsync(() => fetchRank(badToken));
+    t.is(error?.message, "Invalid token specified: Cannot read properties of undefined (reading 'replace')");
+});

package/es/test/util/services.mock.js

@@ -42,6 +42,9 @@ const fetchSkillsResponse = [
         custom: true
     }
 ];
+const fetchRankResponse = {
+    rank: 93
+};
 export const postProgressionResponse = {
     _id: '62b1d1087aa12f00253f40ee',
     content,
@@ -402,5 +405,6 @@ export const services = {
         const currentSlide = progression.state.nextContent.ref;
         return Promise.resolve(get(currentSlide, postAnswerResponses));
     },
-    fetchCorrection: ref => Promise.resolve(getChoicesCorrection(ref))
+    fetchCorrection: ref => Promise.resolve(getChoicesCorrection(ref)),
+    fetchRank: () => Promise.resolve(fetchRankResponse)
 };

package/es/types/common.d.ts

@@ -74,6 +74,9 @@ export declare type SlideFromAPI = {
         type: 'chapter' | 'course';
     };
 };
+export declare type Rank = {
+    rank: number;
+};
 export declare type ProgressionAnswerItem = {
     isCorrect: boolean;
     slideRef: string;
@@ -130,6 +133,7 @@ export declare type Services = {
     postProgression(skillRef: string, token: string): Promise<ProgressionFromAPI>;
     postAnswer(progression: ProgressionFromAPI, token: string, answer: string[]): Promise<ProgressionFromAPI>;
     fetchCorrection(slideRef: string, token: string, progressionId: string, answer: string[]): Promise<CorrectionFromAPI | void>;
+    fetchRank(token: string): Promise<Rank>;
 };
 export declare type Options = {
     services: Services;

package/lib/services/fetch-rank.d.ts

@@ -0,0 +1,2 @@
+import { Rank } from '../types/common';
+export declare const fetchRank: (token: string) => Promise<Rank>;

package/lib/services/fetch-rank.js

@@ -0,0 +1,54 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import crossFetch from 'cross-fetch';
+import decode from 'jwt-decode';
+import { toJSON } from './tools/fetch-responses';
+export var fetchRank = function (token) { return __awaiter(void 0, void 0, void 0, function () {
+    var _a, userId, host, response;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                _a = decode(token), userId = _a.user, host = _a.host;
+                return [4 /*yield*/, crossFetch("".concat(host, "/api/v1/leaderboard/rank/").concat(userId, "?group=ALL"), {
+                        headers: { authorization: token }
+                    })];
+            case 1:
+                response = _b.sent();
+                return [2 /*return*/, toJSON(response)];
+        }
+    });
+}); };

package/lib/services/index.js

@@ -1,10 +1,12 @@
 import { fetchCorrection } from './fetch-correction';
+import { fetchRank } from './fetch-rank';
 import { fetchSkills } from './fetch-skills';
 import { fetchSlide } from './fetch-slide';
 import { postAnswer } from './post-answer';
 import { postProgression } from './post-progression';
 export var getServices = function () { return ({
     fetchCorrection: fetchCorrection,
+    fetchRank: fetchRank,
     fetchSkills: fetchSkills,
     fetchSlide: fetchSlide,
     postAnswer: postAnswer,

package/lib/services/test/fetch-rank.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/services/test/fetch-rank.test.js

@@ -0,0 +1,78 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+import test from 'ava';
+import nock from 'nock';
+import { fetchRank } from '../fetch-rank';
+var result = {
+    rank: 93
+};
+test.before(function () {
+    nock('http://localhost:3000')
+        .get('/api/v1/leaderboard/rank/592d830b240b923f00bffba6?group=ALL')
+        .reply(200, result);
+});
+test.after(function () {
+    nock.cleanAll();
+});
+test('should fetch rank with success', function (t) { return __awaiter(void 0, void 0, void 0, function () {
+    var token, rank;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                token = process.env.API_TEST_TOKEN || '';
+                return [4 /*yield*/, fetchRank(token)];
+            case 1:
+                rank = _a.sent();
+                t.deepEqual(result, rank);
+                return [2 /*return*/];
+        }
+    });
+}); });
+test('should reject bad token', function (t) { return __awaiter(void 0, void 0, void 0, function () {
+    var badToken, error;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                badToken = 'token is not a jwt';
+                return [4 /*yield*/, t.throwsAsync(function () { return fetchRank(badToken); })];
+            case 1:
+                error = _a.sent();
+                t.is(error === null || error === void 0 ? void 0 : error.message, "Invalid token specified: Cannot read properties of undefined (reading 'replace')");
+                return [2 /*return*/];
+        }
+    });
+}); });

package/lib/test/util/services.mock.js

@@ -54,6 +54,9 @@ var fetchSkillsResponse = [
         custom: true
     }
 ];
+var fetchRankResponse = {
+    rank: 93
+};
 export var postProgressionResponse = {
     _id: '62b1d1087aa12f00253f40ee',
     content: content,
@@ -415,5 +418,6 @@ export var services = {
         var currentSlide = progression.state.nextContent.ref;
         return Promise.resolve(get(currentSlide, postAnswerResponses));
     },
-    fetchCorrection: function (ref) { return Promise.resolve(getChoicesCorrection(ref)); }
+    fetchCorrection: function (ref) { return Promise.resolve(getChoicesCorrection(ref)); },
+    fetchRank: function () { return Promise.resolve(fetchRankResponse); }
 };

package/lib/types/common.d.ts

@@ -74,6 +74,9 @@ export declare type SlideFromAPI = {
         type: 'chapter' | 'course';
     };
 };
+export declare type Rank = {
+    rank: number;
+};
 export declare type ProgressionAnswerItem = {
     isCorrect: boolean;
     slideRef: string;
@@ -130,6 +133,7 @@ export declare type Services = {
     postProgression(skillRef: string, token: string): Promise<ProgressionFromAPI>;
     postAnswer(progression: ProgressionFromAPI, token: string, answer: string[]): Promise<ProgressionFromAPI>;
     fetchCorrection(slideRef: string, token: string, progressionId: string, answer: string[]): Promise<CorrectionFromAPI | void>;
+    fetchRank(token: string): Promise<Rank>;
 };
 export declare type Options = {
     services: Services;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coorpacademy/app-review",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "",
   "engines": {
     "node": ">=16.15.0"
@@ -41,7 +41,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@coorpacademy/components": "10.22.21",
+    "@coorpacademy/components": "10.22.23",
     "@coorpacademy/redux-task": "^1.1.5",
     "cross-fetch": "^3.1.5",
     "jwt-decode": "^3.1.2",
@@ -78,5 +78,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.7.4"
   },
-  "gitHead": "2496c794545cc1b5177f07e585d4f3740aa6f7b6"
+  "gitHead": "31b40916b16bd71f9e2717ef10fdb00f4404f5c4"
 }

package/src/services/fetch-rank.ts

@@ -0,0 +1,14 @@
+import crossFetch from 'cross-fetch';
+import decode from 'jwt-decode';
+
+import {JWT, Rank} from '../types/common';
+import {toJSON} from './tools/fetch-responses';
+
+export const fetchRank = async (token: string): Promise<Rank> => {
+  const {user: userId, host}: JWT = decode(token);
+  const response = await crossFetch(`${host}/api/v1/leaderboard/rank/${userId}?group=ALL`, {
+    headers: {authorization: token}
+  });
+
+  return toJSON<Rank>(response);
+};

package/src/services/index.ts

@@ -1,5 +1,6 @@
 import {Services} from '../types/common';
 import {fetchCorrection} from './fetch-correction';
+import {fetchRank} from './fetch-rank';
 import {fetchSkills} from './fetch-skills';
 import {fetchSlide} from './fetch-slide';
 import {postAnswer} from './post-answer';
@@ -7,6 +8,7 @@ import {postProgression} from './post-progression';
 
 export const getServices = (): Services => ({
   fetchCorrection,
+  fetchRank,
   fetchSkills,
   fetchSlide,
   postAnswer,

package/src/services/test/fetch-rank.test.ts

@@ -0,0 +1,34 @@
+import test from 'ava';
+import nock from 'nock';
+import {Rank} from '../../types/common';
+import {fetchRank} from '../fetch-rank';
+
+const result: Rank = {
+  rank: 93
+};
+
+test.before(() => {
+  nock('http://localhost:3000')
+    .get('/api/v1/leaderboard/rank/592d830b240b923f00bffba6?group=ALL')
+    .reply(200, result);
+});
+
+test.after(() => {
+  nock.cleanAll();
+});
+
+test('should fetch rank with success', async t => {
+  const token = process.env.API_TEST_TOKEN || '';
+  const rank = await fetchRank(token);
+  t.deepEqual(result, rank);
+});
+
+test('should reject bad token', async t => {
+  const badToken = 'token is not a jwt';
+  const error = await t.throwsAsync(() => fetchRank(badToken));
+
+  t.is(
+    error?.message,
+    "Invalid token specified: Cannot read properties of undefined (reading 'replace')"
+  );
+});

package/src/test/util/services.mock.ts

@@ -55,6 +55,10 @@ const fetchSkillsResponse = [
   }
 ];
 
+const fetchRankResponse = {
+  rank: 93
+};
+
 export const postProgressionResponse: ProgressionFromAPI = {
   _id: '62b1d1087aa12f00253f40ee',
   content,
@@ -419,5 +423,6 @@ export const services: Services = {
     const currentSlide = progression.state.nextContent.ref;
     return Promise.resolve(get(currentSlide, postAnswerResponses));
   },
-  fetchCorrection: ref => Promise.resolve(getChoicesCorrection(ref))
+  fetchCorrection: ref => Promise.resolve(getChoicesCorrection(ref)),
+  fetchRank: () => Promise.resolve(fetchRankResponse)
 };

package/src/types/common.ts

@@ -90,6 +90,10 @@ export type SlideFromAPI = {
   };
 };
 
+export type Rank = {
+  rank: number;
+};
+
 export type ProgressionAnswerItem = {
   isCorrect: boolean;
   slideRef: string;
@@ -163,6 +167,7 @@ export type Services = {
     progressionId: string,
     answer: string[]
   ): Promise<CorrectionFromAPI | void>;
+  fetchRank(token: string): Promise<Rank>;
 };
 
 export type Options = {