v2.0.0 - Made namespace optional (#67)

* Made namespace optional

* Release 2.0.0

* Increased test coverage

Author: pozil

README.md

@@ -43,6 +43,23 @@ You'll need a free [Heroku account](https://signup.heroku.com) to set it up. A f
 
 ### Step 1: Host App Installation
 
+There are two installation options for the host app:
+
+#### Option 1: Managed Package (recommended)
+
+1. Click [this link](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t0N000001Bl41QAC) to install the host app package and choose **Install for All Users**.
+
+    You'll need to approve access to `https://chart.googleapis.com`. We use this library to draw leaderboads.
+
+1. Set up permissions:
+    1. Navigate to **Setup > Users > Permission Sets**, click **Quiz Host**
+    1. Click **Manage Assignements**
+    1. Click **Add Assignement**
+    1. Check your user and click **Assign**.
+1. Navigate to **Setup > Integrations > Change Data Capture**, enable Change Data Capture for the **Quiz Player** object and **Save**.
+
+#### Option 2: Scratch Org (for development purposes)
+
 We assume that you have a working Salesforce DX environment (Salesforce CLI installed, Dev Hub configured and authorized). See this [Trailhead project](https://trailhead.salesforce.com/en/content/learn/modules/sfdx_app_dev/sfdx_app_dev_setup_dx) for guided steps.
 
 1. Open a Terminal and clone the git repository:
@@ -124,7 +141,7 @@ You can create or import questions by adding records manually or by importing th
 Use this table template to save time:
 
 | Label     | Answer A | Answer B | Answer C | Answer D | Correct Answer |
-| --------- | ---------|----------|----------|----------|--------------- |
+| --------- | -------- | -------- | -------- | -------- | -------------- |
 | 1 + 1 = ? | 1        | 2        | 3        | 4        | B              |
 
 #### Option 2: Importing questions using the Salesforce CLI

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "sfdx-quiz",
-    "version": "1.4.0",
+    "version": "2.0.0",
     "private": true,
     "description": "Lightning Web Component Quiz App on a Salesforce Org",
     "engines": {
@@ -19,13 +19,13 @@
         "postinstall": "node bin/check-version.js"
     },
     "devDependencies": {
-        "@salesforce/eslint-config-lwc": "^0.6.0",
+        "@salesforce/eslint-config-lwc": "^0.7.0",
         "@salesforce/sfdx-lwc-jest": "^0.7.1",
-        "eslint": "^7.0.0",
+        "eslint": "^7.1.0",
         "husky": "^4.2.5",
-        "lint-staged": "^10.2.6",
+        "lint-staged": "^10.2.9",
         "prettier": "^2.0.5",
-        "prettier-plugin-apex": "^1.4.0",
+        "prettier-plugin-apex": "^1.5.0",
         "semver": "^7.3.2"
     },
     "husky": {

package.json

@@ -4,8 +4,8 @@
             "path": "src",
             "default": true,
             "package": "Quiz",
-            "versionName": "ver 1.4.0",
-            "versionNumber": "1.4.0.NEXT"
+            "versionName": "ver 2.0.0",
+            "versionNumber": "2.0.0.NEXT"
         }
     ],
     "namespace": "",

sfdx-project.json

@@ -0,0 +1,20 @@
+global with sharing class QuizAnswer {
+    @AuraEnabled
+    global Id id { get; set; }
+    @AuraEnabled
+    global Id playerId { get; set; }
+    @AuraEnabled
+    global Id questionId { get; set; }
+    @AuraEnabled
+    global String answer { get; set; }
+
+    global QuizAnswer() {
+    }
+
+    global QuizAnswer(Quiz_Answer__c answer) {
+        this.id = answer.Id;
+        this.playerId = answer.Player__c;
+        this.questionId = answer.Question__c;
+        this.answer = answer.Answer__c;
+    }
+}

src/main/default/classes/QuizAnswer.cls

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>48.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

src/main/default/classes/QuizAnswer.cls-meta.xml

@@ -7,7 +7,11 @@ global abstract class QuizAnswerRestResource {
         Object responseData;
         Integer statusCode;
         try {
-            responseData = answerService.create(playerId, answer);
+            Quiz_Answer__c answerRecord = answerService.create(
+                playerId,
+                answer
+            );
+            responseData = new QuizAnswer(answerRecord);
             statusCode = 200;
         } catch (QuizAnswerService.InvalidPhaseException e) {
             responseData = new ErrorMessage(

src/main/default/classes/QuizAnswerRestResource.cls

@@ -8,8 +8,9 @@ public with sharing class QuizController {
     private static final QuizSettingsService settingsService = new QuizSettingsService();
 
     @AuraEnabled(cacheable=true)
-    public static Quiz_Settings__mdt getQuizSettings() {
-        return settingsService.get();
+    public static QuizSettings getQuizSettings() {
+        Quiz_Settings__mdt settings = settingsService.get();
+        return new QuizSettings(settings);
     }
 
     @AuraEnabled(cacheable=true)
@@ -40,7 +41,7 @@ public with sharing class QuizController {
     }
 
     @AuraEnabled
-    public static Quiz_Question__c getCurrentQuestion(Id sessionId) {
+    public static QuizQuestion getCurrentQuestion(Id sessionId) {
         if (sessionId == null) {
             throw new AuraHandledException('Missing session Id.');
         }
@@ -52,7 +53,7 @@ public with sharing class QuizController {
                 'Missing current question for session.'
             );
         }
-        return question;
+        return new QuizQuestion(question);
     }
 
     @AuraEnabled
@@ -61,23 +62,28 @@ public with sharing class QuizController {
     }
 
     @AuraEnabled
-    public static List<Quiz_Player__c> getPlayersSortedByScore(
+    public static List<QuizPlayer> getPlayersSortedByScore(
         Integer maxFetchCount
     ) {
-        return playerService.getPlayersSortedByScore(maxFetchCount);
+        List<Quiz_Player__c> players = playerService.getPlayersSortedByScore(
+            maxFetchCount
+        );
+        return QuizPlayer.fromRecordList(players);
     }
 
     @AuraEnabled
-    public static Quiz_Session__c getQuizSession() {
-        return sessionService.getQuizSession();
+    public static QuizSession getQuizSession() {
+        Quiz_Session__c session = sessionService.getQuizSession();
+        return new QuizSession(session);
     }
 
     @AuraEnabled
-    public static Quiz_Session__c triggerNextPhase(Id sessionId) {
+    public static QuizSession triggerNextPhase(Id sessionId) {
         if (sessionId == null) {
             throw new AuraHandledException('Missing session Id.');
         }
-        return sessionHelper.triggerNextPhase(sessionId);
+        Quiz_Session__c session = sessionHelper.triggerNextPhase(sessionId);
+        return new QuizSession(session);
     }
 
     @AuraEnabled

src/main/default/classes/QuizController.cls

@@ -3,8 +3,9 @@ public with sharing class QuizEditorController {
     private static final QuizSessionService sessionService = new QuizSessionService();
 
     @AuraEnabled(cacheable=true)
-    public static List<Quiz_Question__c> getAllQuestions() {
-        return questionService.getQuestions();
+    public static List<QuizQuestion> getAllQuestions() {
+        List<Quiz_Question__c> questions = questionService.getQuestions();
+        return QuizQuestion.fromRecordList(questions);
     }
 
     @AuraEnabled
@@ -19,10 +20,17 @@ public with sharing class QuizEditorController {
     }
 
     @AuraEnabled(cacheable=true)
-    public static List<Quiz_Question__c> getSessionQuestions(Id sessionId) {
+    public static List<Id> getSessionQuestionIds(Id sessionId) {
         if (sessionId == null) {
             throw new AuraHandledException('Missing session Id.');
         }
-        return sessionService.getSessionQuestions(sessionId);
+        List<Quiz_Question__c> questions = sessionService.getSessionQuestions(
+            sessionId
+        );
+        List<Id> questionIds = new List<Id>();
+        for (Quiz_Question__c question : questions) {
+            questionIds.add(question.Id);
+        }
+        return questionIds;
     }
 }

src/main/default/classes/QuizEditorController.cls

@@ -0,0 +1,30 @@
+global with sharing class QuizPlayer {
+    @AuraEnabled
+    global Id id { get; set; }
+    @AuraEnabled
+    global String name { get; set; }
+    @AuraEnabled
+    global Decimal score { get; set; }
+    @AuraEnabled
+    global Decimal rank { get; set; }
+
+    global QuizPlayer() {
+    }
+
+    global QuizPlayer(Quiz_Player__c player) {
+        this.id = player.Id;
+        this.name = player.Name;
+        this.score = player.Score__c;
+        this.rank = player.Ranking__c;
+    }
+
+    global static List<QuizPlayer> fromRecordList(
+        List<Quiz_Player__c> records
+    ) {
+        List<QuizPlayer> players = new List<QuizPlayer>();
+        for (Quiz_Player__c record : records) {
+            players.add(new QuizPlayer(record));
+        }
+        return players;
+    }
+}