feat(Metadata): Add parsed matching response (#584 - [LL-261](https://learningpool.atlassian.net/browse/LL-261))

https://learningpool.atlassian.net/browse/LL-261
#584

Author: crazy-grizzly

src/apps/statements/models/Result.ts

@@ -1,6 +1,11 @@
 import Extensions from './Extensions';
+import Score from './Score';
 
 interface Result {
+  readonly score?: Score;
+  readonly success?: boolean;
+  readonly completion?: boolean;
+  readonly response?: string;
   readonly duration?: string;
   readonly extensions?: Extensions;
 }

src/apps/statements/models/Score.ts

@@ -0,0 +1,15 @@
+interface Score {
+  /** Decimal number between -1 and 1, inclusive */
+  readonly scaled: number;
+
+  /** Decimal number between min and max (if present, otherwise unrestricted), inclusive */
+  readonly raw?: number;
+
+  /** Decimal number less than max (if present) */
+  readonly min?: number;
+
+  /** Decimal number greater than min (if present) */
+  readonly max?: number;
+}
+
+export default Score;

src/apps/statements/service/storeStatements/queriables/getMetadataFromStatement/getMatchingQuestionsMetadata.ts

@@ -0,0 +1,26 @@
+import { get, has } from 'lodash';
+
+import ActivityInteractionType from '../../../../models/ActivityInteractionType';
+import Statement from '../../../../models/Statement';
+
+export const getMatchingQuestionsMetadata = (statement: Statement)
+  : {readonly [key: string]: any} => {
+  if (
+    !(
+      get(
+        statement.object,
+        ['definition', 'interactionType'],
+      ) === ActivityInteractionType.MATCHING
+      && has(statement, ['result', 'response'])
+    )
+  ) {
+    return {};
+  }
+
+  const matchingQuestionsString = get(statement, ['result', 'response']);
+  const matchingQuestions = matchingQuestionsString
+    .split('[,]')
+    .map((mq: string) => mq.split('[.]'));
+
+  return { 'https://learninglocker&46;net/matching-response': matchingQuestions };
+};

src/apps/statements/service/storeStatements/queriables/getMetadataFromStatement/index.ts

@@ -1,16 +1,19 @@
 import Statement from '../../../../models/Statement';
 import { getBooleanMetadata } from './getBooleanMetadata';
 import { getDurationMetadata } from './getDurationMetadata';
+import { getMatchingQuestionsMetadata } from './getMatchingQuestionsMetadata';
 import { getSequencingMetadata } from './getSequencingMetadata';
 
 export default (statement: Statement): { readonly [key: string]: any } => {
   const durationMetadata = getDurationMetadata(statement);
   const sequencingMetadata = getSequencingMetadata(statement);
+  const matchingMetadata = getMatchingQuestionsMetadata(statement);
   const booleanMetadata = getBooleanMetadata(statement);
 
   return {
     ...durationMetadata,
     ...sequencingMetadata,
+    ...matchingMetadata,
     ...booleanMetadata,
   };
 };

src/apps/statements/tests/storingStatements/queriables/getMetadataFromStatement/fixtures/matching-interaction.fixture.ts

@@ -0,0 +1,79 @@
+import { merge } from 'lodash';
+import InteractionActivityDefinition from '../../../../../models/InteractionActivityDefinition';
+
+import Statement from '../../../../../models/Statement';
+import SubStatementObject from '../../../../../models/SubStatementObject';
+import { statementDefaults } from './statements.fixture';
+
+const singleMatchingQuestion: Statement = {
+  ...statementDefaults,
+  ...{
+    result: {
+      response: 'ben[.]3',
+    },
+    object: {
+      id: 'http://www.example.com/tincan/activities/uyheHUJd76s/question4',
+      objectType: 'Activity',
+      definition: {
+        name: { 'en-US': 'Question 4' },
+        description: { 'en-US': 'Match these people to their kickball team:' },
+        type: 'http://adlnet.gov/expapi/activities/cmi.interaction',
+        interactionType: 'matching',
+        correctResponsesPattern: [
+          'ben[.]3[,]chris[.]2[,]troy[.]4[,]freddie[.]1',
+        ],
+        source: [
+          {
+            id: 'ben',
+            description: { 'en-US': 'Ben' },
+          },
+          {
+            id: 'chris',
+            description: { 'en-US': 'Chris' },
+          },
+          {
+            id: 'troy',
+            description: { 'en-US': 'Troy' },
+          },
+          {
+            id: 'freddie',
+            description: { 'en-US': 'Freddie' },
+          },
+        ],
+        target: [
+          {
+            id: '1',
+            description: { 'en-US': 'SCORM Engine' },
+          },
+          {
+            id: '2',
+            description: { 'en-US': 'Pure-sewage' },
+          },
+          {
+            id: '3',
+            description: { 'en-US': 'Tin Can xAPI' },
+          },
+          {
+            id: '4',
+            description: { 'en-US': 'SCORM Cloud' },
+          },
+        ],
+      } as Partial<InteractionActivityDefinition>,
+    } as SubStatementObject,
+  } as Partial<Statement>,
+};
+
+const multipleMatchingQuestions: Statement = merge(
+  {},
+  singleMatchingQuestion,
+  {
+    result: {
+      response: 'ben[.]3[,]chris[.]2[,]troy[.]4[,]freddie[.]1',
+    },
+  } as Partial<Statement>,
+);
+
+export {
+  singleMatchingQuestion,
+  multipleMatchingQuestions,
+};

src/apps/statements/tests/storingStatements/queriables/getMetadataFromStatement/getMatchingQuestionsMetadata.test.ts

@@ -0,0 +1,57 @@
+import * as assert from 'assert';
+
+import { getMatchingQuestionsMetadata } from '../../../../service/storeStatements/queriables/getMetadataFromStatement/getMatchingQuestionsMetadata';
+import {
+  multipleMatchingQuestions,
+  singleMatchingQuestion,
+} from './fixtures/matching-interaction.fixture';
+
+describe('Retrieve matching questions metadata from statement', () => {
+  it('should return matching questions metadata from statement', () => {
+    const expectedEmptyMetadata = {};
+
+    const actualEmptyMetadataFromEmptyResult = getMatchingQuestionsMetadata(
+      {
+        ...singleMatchingQuestion,
+        ...{
+          result: {},
+        },
+      },
+    );
+
+    assert.deepEqual(actualEmptyMetadataFromEmptyResult, expectedEmptyMetadata);
+  });
+
+  it('should return metadata from single matching question', () => {
+    const actualSingleMatchingQuestionMetadata = getMatchingQuestionsMetadata(
+      singleMatchingQuestion,
+    );
+    const expectedSingleMatchingQuestionMetadata = {
+      'https://learninglocker&46;net/matching-response': [
+        ['ben', '3'],
+      ],
+    };
+
+    assert.deepEqual(actualSingleMatchingQuestionMetadata, expectedSingleMatchingQuestionMetadata);
+  });
+
+  it('should return metadata from multiple matching questions', () => {
+    const actualMultipleMatchingQuestionsMetadata = getMatchingQuestionsMetadata(
+      multipleMatchingQuestions,
+    );
+    const expectedMultipleMatchingQuestionsMetadata = {
+      'https://learninglocker&46;net/matching-response': [
+        ['ben', '3'],
+        ['chris', '2'],
+        ['troy', '4'],
+        ['freddie', '1'],
+      ],
+    };
+
+    assert
+      .deepEqual(
+        actualMultipleMatchingQuestionsMetadata,
+        expectedMultipleMatchingQuestionsMetadata,
+      );
+  });
+});

src/apps/statements/tests/storingStatements/queriables/getMetadataFromStatement/getMetadataFromStatement.test.ts

@@ -3,6 +3,7 @@ import { merge } from 'lodash';
 
 import getMetadataFromStatement
   from '../../../../service/storeStatements/queriables/getMetadataFromStatement';
+import { multipleMatchingQuestions } from './fixtures/matching-interaction.fixture';
 import {
   sequencingInteractionActivityStatement,
   statementDefaults,
@@ -47,4 +48,18 @@ describe('Retrieve metadata from statement', () => {
 
     assert.deepEqual(actualMetadata, expectedMetadata);
   });
+
+  it('should return matching questions metadata', () => {
+    const actualMatchingQuestionsMetadata = getMetadataFromStatement(multipleMatchingQuestions);
+    const expectedMatchingQuestionsMetadata = {
+      'https://learninglocker&46;net/matching-response': [
+        ['ben', '3'],
+        ['chris', '2'],
+        ['troy', '4'],
+        ['freddie', '1'],
+      ],
+    };
+
+    assert.deepEqual(actualMatchingQuestionsMetadata, expectedMatchingQuestionsMetadata);
+  });
 });

yarn.lock

@@ -34,10 +34,9 @@
   dependencies:
     "@babel/highlight" "^7.8.3"
 
-"@babel/highlight@^7.8.3":
-  version "7.8.3"
-  resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.8.3.tgz#28f173d04223eaaa59bc1d439a3836e6d1265797"
-  integrity sha512-PX4y5xQUvy0fnEVHrYOarRPXVWafSjTW9T0Hab8gVIawpl2Sj0ORyrygANq+KjcNlSSTw0YCLSNA8OyZ1I4yEg==
+"@babel/highlight@^7.8.0":
+  version "7.8.0"
+  resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.8.0.tgz#4cc003dc10359919e2e3a1d9459150942913dd1a"
   dependencies:
     chalk "^2.0.0"
     esutils "^2.0.2"
@@ -3131,10 +3130,9 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/eyes/-/eyes-0.1.8.tgz#62cf120234c683785d902348a800ef3e0cc20bc0"
   integrity sha1-Ys8SAjTGg3hdkCNIqADvPgzCC8A=
 
-fast-deep-equal@^3.1.1:
-  version "3.1.1"
-  resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.1.tgz#545145077c501491e33b15ec408c294376e94ae4"
-  integrity sha512-8UEa58QDLauDNfpbrX55Q9jrGHThw2ZMdOky5Gl1CDtVeJDPVrG4Jxx1N8jw2gkWaff5UUuX1KJd+9zGe2B+ZA==
+fast-deep-equal@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz#7b05218ddf9667bf7f370bf7fdb2cb15fdd0aa49"
 
 fast-glob@^3.0.3:
   version "3.2.0"