Add !quiz command (#360)

* SlackerBot Event Handler:

- Added logic to handle Slack interactive message responses for the quiz feature.
- Implemented content-type based logic to differentiate between Default messages, Challenge requests and Quiz interactions.
- Captured and processed the user selected quiz answer, comparing it against the correct answer.
- Updated the bot to send a response message back to the user indicating whether the answer was correct or not.

* Create a new SN Quiz.js

- Implemented functionality to capture the quiz topic from the Slack command using regex.
- Integrated OpenAI API to generate multiple-choice quiz questions dynamically based on the quiz topic provided.
- Processed and formatted the AI response into structured JSON, containing the question, options, correct answer, and explanation.
- Enhanced Slack integration using Block Kit to present the quiz question with interactive buttons for each option.

* Scripted Rest API:

- Updated the interaction script to validate user selections and provide feedback based on the correctness of the response.
- Added dynamic button styling (primary/danger) to visually indicate correct and incorrect answers.
- Improved feedback messages with detailed explanations for correct answers.
- Integrated the update_chat method to ensure real-time message updates in Slack with button styling and quiz results.

Slacker Script Include:
- Enhanced maintainability by centralizing the Slack message update logic in a dedicated Script Include function.

* Update - Create a new SN Quiz.js

- Added error handling to manage unexpected responses from the OpenAI API.
- Improved user interaction by formatting the question and answers using Slack Block Kit.
- Ensured that correct answers are validated and passed along with the user selection for feedback.

* Update Create a new SN Quiz.js

Initial comments inserted

* The API - Event Handler has been updated with some adjustments and improvements:

- Fix: The Script Include Slacker() is no longer instantiated twice.
- The block only accepts interaction if the user interacting with the block is the same user who sent the command.
- All other blocks automatically turn red after the user selects the correct option.
- Now the bot briefly explains why the option is correct.
- A note has been added so the user knows that only the person who sent the command can answer the question.

* Update Create a new SN Quiz.js

The script has been updated with some adjustments and improvements:

- The model used in the OpenAI integration has been changed to gpt-4o.
- The ID of the user who asked the question is being retrieved and sent for interaction validation.
- A greeting was added to the quiz so that the person who asked the question knows it is directed at them.
- A note has been added to inform the user that only the person who sent the command can answer the quiz.

* A new function has been created to validate whether the bot can interact in the channel.
The function checks if the original message was sent by a user and if the interaction is of the type “block_actions” - Necessary for setting up the quiz.

The function checks if the interaction contains a bot_id, and if it does, two things are validated:
1. If the type of interaction is “message_changed” - Necessary for the bot to update the styles of the blocks (colors).
2. If the thread was started by a user - Necessary for the bot to respond to the correct question. This way, it does not get stuck in a loop responding to itself.

If the interaction does not have a bot_id, then the message can be sent.

---------

Co-authored-by: admin <admin@example.com>
Co-authored-by: Astrid Sapphire <59789839+SapphicFire@users.noreply.github.com>

Author: 3 people

Parsers/Create a new SN Quiz.js

@@ -0,0 +1,114 @@
+/*
+activation_example:!quiz itsm
+regex:!quiz\s+(.+)
+flags:gmi
+*/
+
+(function(current) {
+    var slacker = new x_snc_slackerbot.Slacker();
+
+    // Capture the text and extract the quiz topic using regex
+    var text = current.text;
+    var match = text.match(/!quiz\s+(.+)/i);
+
+    if (!match) {
+        slacker.send_chat(current, "Please provide a valid ServiceNow quiz topic, e.g., !quiz ITSM.", false);
+        return;
+    }
+
+    var quizTopic = match[1].trim();
+    var originalUserId = current.user.user_id;
+
+    try {
+        // Openai Integration - Generate Quiz
+        var apiKey = gs.getProperty("openai.key");
+
+        var restMessage = new sn_ws.RESTMessageV2();
+        restMessage.setEndpoint('https://api.openai.com/v1/chat/completions');
+        restMessage.setHttpMethod('POST');
+        restMessage.setRequestHeader('Authorization', 'Bearer ' + apiKey);
+        restMessage.setRequestHeader('Content-Type', 'application/json');
+
+        var requestBody = {
+            "model": "gpt-4o",
+            "messages": [{
+                    "role": "system",
+                    "content": "You are an assistant that creates structured multiple-choice quiz questions about ServiceNow topics. Return the question and answers in JSON format."
+                },
+                {
+                    "role": "user",
+                    "content": "Please generate one multiple-choice quiz question on the topic of " + quizTopic + ". The answers should not include any prefixes like 'A)', '1.', etc. Just provide the plain answer text. Return the result in the following JSON format:\n{\n  \"question\": \"<question text>\",\n  \"answers\": [\"option 1\", \"option 2\", \"option 3\", \"option 4\"],\n  \"correct\": \"<correct answer>\",\n  \"explanation\": \"<why this option is correct>\"\n}"
+                }
+            ],
+            "max_tokens": 200
+        };
+
+
+        restMessage.setRequestBody(JSON.stringify(requestBody));
+        var response = restMessage.execute();
+
+        if (response.getStatusCode() !== 200) {
+            throw new Error('Received non-200 response from OpenAI: ' + response.getStatusCode());
+        }
+
+        var responseBody = response.getBody();
+        var jsonResponse = JSON.parse(responseBody);
+
+        if (!jsonResponse.choices || !jsonResponse.choices[0].message || !jsonResponse.choices[0].message.content) {
+            throw new Error('Unexpected response format from OpenAI');
+        }
+
+        var quizData = jsonResponse.choices[0].message.content;
+        var quizQuestion = JSON.parse(quizData);
+
+        // Find the correct answer
+        var correctOptionIndex = "";
+        quizQuestion.answers.forEach(function(answer, index) {
+            if (answer === quizQuestion.correct) {
+                correctOptionIndex = "option_" + (index + 1);
+            }
+        });
+
+        // Prepare Slack Block Kit for the quiz question and answers
+        var optionLetters = ['A', 'B', 'C', 'D'];
+        var blocks = [{
+                "type": "section",
+                "text": {
+                    "type": "mrkdwn",
+                    "text": "Hello, " + current.user.name + "! Test your ServiceNow skills and have fun! \n\n" +
+                        "*Question:* " + quizQuestion.question + "\n\n" +
+                        optionLetters[0] + ") " + quizQuestion.answers[0] + "\n" +
+                        optionLetters[1] + ") " + quizQuestion.answers[1] + "\n" +
+                        optionLetters[2] + ") " + quizQuestion.answers[2] + "\n" +
+                        optionLetters[3] + ") " + quizQuestion.answers[3] + "\n\n" +
+                        "_*Note:* Only the person who initiated the quiz can answer._"
+                }
+            },
+            {
+                "type": "actions",
+                "elements": quizQuestion.answers.map(function(answer, index) {
+                    return {
+                        "type": "button",
+                        "text": {
+                            "type": "plain_text",
+                            "text": optionLetters[index]
+                        },
+
+                        "value": "option_" + (index + 1) + "|" + correctOptionIndex + "|" + originalUserId + "|" + quizQuestion.explanation,
+                        "action_id": "quiz_answer_" + (index + 1)
+                    };
+                })
+            }
+        ];
+
+        // Send Slack message - Quiz
+        slacker.send_chat(current, {
+            "blocks": blocks
+        }, false);
+
+    } catch (error) {
+        gs.error('[SLACKER - QUIZ] Error generating quiz: ' + error.message);
+        slacker.send_chat(current, "Sorry, there was an issue generating the quiz. Please try again later.", false);
+    }
+
+})(current);

b02cf9e61b861d10d806dc23b24bcb3f/checksum.txt

@@ -1 +1 @@
-OXfnAqsApch05cMfRB7DnJnPrhgcNBWxHmqCEtplh9J-0tLkq_ahRkN6ATYblVZEi2dpPa-gS8aTEn4YpeMwCQGYt9UEZjvZbU7yGt79Fm8sKCUTxnt5kPioAP4h13NbBnbSGJAhf796X8mkDhRpthIKIVKAhAkv5qYjRbohRG5HJ8mB4l3pvDIPxsIFEYph5eHyX9ej49Meb1ngqjTdRF7_e8vzqM8gjx2892GdF7gynrmIOpZDjcmJ9miakQWjIFpRGlS1UkhaiA6EeaiDukz6V0iP81OlXlbXghRxamvDwaiXjfemlDHY_R0xmSxb7uJ9eBCvgXmJkFQriOM1Uqu7SvcnfE3jvRcAw22U-snz-VTZxOBhvdsdf2ULyz_5OqsxAiGF3f39xg42lc3jqi8wGubgMvFUvdKCnpoMywoC6tGYX7eXLaAqIdQkAmuK3nXuWYbsl5Q-dM_iRs0sXQ9DK0uEUSBLz8wBjlQXXihsT8Z96NpSz6xg6YPA6ZENNuyUSak2dsOZsoCsQo7Mo-ZbBbbDBScyyU3b42OZ3O0HUx6qpIQxl8CNw0mjJyk30yzThMxOvV5-hgdfcFLWDV3VbNmv65HElwxU4Hc4J6uKHuLyBUzcnx5pXIgM4o0fktAygrdHTP0rToqxGCDsuhLlQnqfNtM0NfrrgFDQAws
+1Xbk9WxmheTaW0AgaPLvwbV3zWsmHQtuzDv3BzXUTOXkkeTOT3dWqOrS7c8vRhhL57_VWPRyJeeP5HfoSHF21CYx49uZ6ejBWpfI8oo79_rSECBBj-o5imozu6nwjoIoqchvEwga8PlPmyZBkslRcpawEqlirCLUNQh0gPJdYMPsSOCAJbjOIWXl8qdsyR_c5fhsNb0VxlciIVbYn6KBZnC_-QzBu1Z7E0lSqeISpirHNr-Y_Et56ZIL-fIAl5Oh-L-WARn_-Ei8lgvy-zs1mIvLyy9rOsKirmI5jzRYCAfO5lvltsjGDfJnCRAr4aRHE5w5-lSmLSgX6mR4EBTc8FkryIbfOHZXsp3HSSJGLVpNYn7n77O2V-F9cNrOidCpmWlXVANq9GpgCmJoeO3TrCmJVwmyuF_3qok2zuxsKR2dCSHVjr2THKK_CmyuQIeaMtUGIxSbw5ngkRVcz3pCIfMvCnfjNLHwPf2EOQgNC8bHkYBOylKsnvnOG9cPiquKE_aS_9lkCR0H_JLQsOGDndDBNOVRqcONO8p1JsFrkP5ihhqAmNjAz8jrRi-cUfyynNVH4FticFbBrNm7pw5aYOq1nwok0EN7SCwNX-LfoUh8uk4HNrPzQvY1Pu9IXZnFpAaTtcK-fg_sAOMVs55itBxzQOVZQjbSC2sORre2P5U

b02cf9e61b861d10d806dc23b24bcb3f/update/sys_script_include_b2c246ae1b861d10d806dc23b24bcbac.xml

@@ -26,10 +26,10 @@ Slacker.prototype = {
             }
         }
 
-		if (slackoff_user.getValue('name_updated') < gs.daysAgoStart(0)) {
-			this.get_user_info(payload_user, userSysID); //Update user info once per day, in case of name change.
-		}
-		
+        if (slackoff_user.getValue('name_updated') < gs.daysAgoStart(0)) {
+            this.get_user_info(payload_user, userSysID); //Update user info once per day, in case of name change.
+        }
+
         return userSysID;
     },
 
@@ -73,6 +73,32 @@ Slacker.prototype = {
         return rm.execute();
     },
 
+    /**
+     * Updates a message on Slack
+     * @example
+     * var payload = {
+     *     "channel": "D0XXXT13XXX", // Channel ID
+     *     "ts": 1728146070.000000, // Message timestamp
+     *     "blocks": blocks, // Optional if the message is block
+     *     "text": message // If the message is text
+     * };
+     * new x_snc_slackerbot.Slacker().update_chat(payload);
+     * @param {object} payload Object containing the payload to be sent to the Slack API
+     * @returns {RESTResponseV2} RESTResponseV2 object containing response payload, and headers
+     */
+    update_chat: function(payload) {
+        var rmUpdateMessage = new sn_ws.RESTMessageV2();
+        rmUpdateMessage.setEndpoint('https://slack.com/api/chat.update');
+        rmUpdateMessage.setHttpMethod('POST');
+        rmUpdateMessage.setRequestHeader('Authorization', 'Bearer ' + gs.getProperty('x_snc_slackerbot.SlackerBot.token'));
+        rmUpdateMessage.setRequestHeader('Content-Type', 'application/json');
+        rmUpdateMessage.setRequestBody(JSON.stringify(payload));
+		
+        var response = rmUpdateMessage.execute();
+		var responseBody = response.getBody();
+		return responseBody;
+    },
+
     send_delete: function(channel, ts) {
         var rm = new sn_ws.RESTMessageV2();
         rm.setHttpMethod('POST');
@@ -109,7 +135,7 @@ Slacker.prototype = {
             var grupdate = new GlideRecord('x_snc_slackerbot_user');
             grupdate.get(record_id);
             grupdate.setValue('name', response_body.user.real_name);
-			grupdate.setValue('name_updated', new GlideDateTime());
+            grupdate.setValue('name_updated', new GlideDateTime());
             grupdate.update();
             return true;
         } else {
@@ -160,13 +186,13 @@ Slacker.prototype = {
         <sys_created_by>earl.duque</sys_created_by>
         <sys_created_on>2022-09-23 06:06:00</sys_created_on>
         <sys_id>b2c246ae1b861d10d806dc23b24bcbac</sys_id>
-        <sys_mod_count>3</sys_mod_count>
+        <sys_mod_count>7</sys_mod_count>
         <sys_name>Slacker</sys_name>
         <sys_package display_value="SlackerBot" source="x_snc_slackerbot">b02cf9e61b861d10d806dc23b24bcb3f</sys_package>
         <sys_policy>read</sys_policy>
         <sys_scope display_value="SlackerBot">b02cf9e61b861d10d806dc23b24bcb3f</sys_scope>
         <sys_update_name>sys_script_include_b2c246ae1b861d10d806dc23b24bcbac</sys_update_name>
-        <sys_updated_by>SapphicFire</sys_updated_by>
-        <sys_updated_on>2023-11-04 10:48:44</sys_updated_on>
+        <sys_updated_by>admin</sys_updated_by>
+        <sys_updated_on>2024-10-05 17:42:35</sys_updated_on>
     </sys_script_include>
 </record_update>

b02cf9e61b861d10d806dc23b24bcb3f/update/sys_ws_operation_bbcb42a61bc61d10d806dc23b24bcbd2.xml

@@ -1,26 +1,126 @@
 <?xml version="1.0" encoding="UTF-8"?><record_update table="sys_ws_operation">
     <sys_ws_operation action="INSERT_OR_UPDATE">
         <active>true</active>
-        <consumes>application/json,application/xml,text/xml</consumes>
-        <consumes_customized>false</consumes_customized>
+        <consumes>application/json,application/xml,text/xml,application/x-www-form-urlencoded</consumes>
+        <consumes_customized>true</consumes_customized>
         <default_operation_uri/>
         <enforce_acl>cf9d01d3e73003009d6247e603f6a990</enforce_acl>
         <http_method>POST</http_method>
         <name>Event</name>
-        <operation_script><![CDATA[(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
-
-    if (request.body.data.challenge){
-		response.setStatus(200);
-		response.setContentType('text/plain');
-		response.getStreamWriter().writeString(request.body.data.challenge);
-	} else {
-		if (request.body.data.event.bot_id) return;
-		//gs.info('slackoff: ' + (request.body.dataString));
-		var payload = new GlideRecord('x_snc_slackerbot_payload');
-		payload.initialize();
-		payload.setValue('payload', JSON.stringify(request.body.data, null, 2));
-		payload.insert(); 
-	}
+        <operation_script><![CDATA[(function process( /*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {
+    var contentType = request.getHeader('Content-Type');
+    var slackerProvider = new x_snc_slackerbot.Slacker();
+
+    if (contentType === 'application/json') {
+        if (request.body.data.challenge) {
+            response.setStatus(200);
+            response.setContentType('text/plain');
+            response.getStreamWriter().writeString(request.body.data.challenge);
+        } else {
+            var botCanAnswerJson = checkIfBotCanAnswer(request.body.data.event);
+            if (!botCanAnswerJson) return;
+
+            //gs.info('slackoff: ' + (request.body.dataString));
+            var payload = new GlideRecord('x_snc_slackerbot_payload');
+            payload.initialize();
+            payload.setValue('payload', JSON.stringify(request.body.data, null, 2));
+            payload.insert();
+        }
+
+    } else if (contentType === 'application/x-www-form-urlencoded') {
+        var bodyData = request.queryParams;
+        var formData = bodyData.payload;
+        var interactionPayload = JSON.parse(formData);
+        var botCanAnswerEncoded = checkIfBotCanAnswer(interactionPayload);
+        if (!botCanAnswerEncoded) return;
+
+        sendQuizInteraction(bodyData, formData, interactionPayload);
+    }
+
+    // ###### Slacker QUIZ ###### //
+    function sendQuizInteraction(bodyData, formData) {
+        // Get selected option, correct option, the user ID that initiated the quiz, and explanation
+        var action = interactionPayload.actions[0];
+        var selectedOption = action.value;
+        var parts = selectedOption.split("|");
+        var userSelection = parts[0];
+        var correctOption = parts[1];
+        var originalUserId = parts[2];
+        var explanation = parts[3];
+
+        // Verify if the interacting user is the same as the original user
+        if (interactionPayload.user.id !== originalUserId) return;
+
+        // Apply styles to each button based on whether it was selected and whether it's correct
+        var blocks = interactionPayload.message.blocks;
+        var correctIndex = parseInt(correctOption.split('_')[1]) - 1;
+
+        blocks[1].elements.forEach(function(button, index) {
+            if (userSelection === correctOption) {
+                button.style = (index === correctIndex) ? "primary" : "danger";
+            } else {
+                if (button.value === selectedOption) {
+                    button.style = "danger";
+                }
+            }
+        });
+
+        var updateMessagePayload = {
+            "channel": interactionPayload.channel.id,
+            "ts": interactionPayload.message.ts,
+            "blocks": blocks,
+            "text": "UpdatingQuiz"
+        };
+
+        var responseMessageUpdated = slackerProvider.update_chat(updateMessagePayload);
+
+        // Validate User Answer and send appropriate feedback
+        var current = {
+            "text": interactionPayload.message.blocks[0].text.text,
+            "ts": interactionPayload.message.ts,
+            "thread_ts": interactionPayload.container.message_ts,
+            "channel": interactionPayload.channel.id,
+            "user": {
+                "user_id": interactionPayload.user.id,
+                "name": interactionPayload.user.name
+            }
+        };
+
+        var questionText = interactionPayload.message.blocks[0].text.text;
+        var textLines = questionText.split("\n");
+        var correctAnswerText = textLines[correctIndex + 4].trim();
+        var correctAnswer = correctAnswerText.replace(/^[A-D]\)\s*/, '');
+
+        if (userSelection === correctOption) {
+            var correctMessage = "Well done! The correct answer is:\n*" + correctAnswer + "*\n\n" + explanation;
+            slackerProvider.send_chat(current, correctMessage, false);
+        } else {
+            var incorrectMessage = "Oops, not quite! Try Again.";
+            slackerProvider.send_chat(current, incorrectMessage, false);
+        }
+    }
+
+    function checkIfBotCanAnswer(requestBodyEvent) {
+        var botCanAnswer = false;
+
+		// Allows response if the type is block_action and the message was sent by a user
+		if(requestBodyEvent.user && requestBodyEvent.user.username && requestBodyEvent.type === "block_actions") return true;
+		
+        if (requestBodyEvent.bot_id) {
+            // Allows response if the message subtype is message update
+            if (requestBodyEvent.subtype && requestBodyEvent.subtype === "message_changed") {
+				botCanAnswer = true;
+            }
+            // Allows response if the thread was started by a user
+            else if (requestBodyEvent.parent_user_id && requestBodyEvent.parent_user_id !== requestBodyEvent.user) {
+                botCanAnswer = true;
+            }
+        } else {
+            botCanAnswer = true;
+        }
+
+        return botCanAnswer;
+    }
 
 })(request, response);]]></operation_script>
         <operation_uri>/api/x_snc_slackerbot/slackerbot_event_handler</operation_uri>
@@ -36,11 +136,14 @@
         <sys_created_by>earl.duque</sys_created_by>
         <sys_created_on>2022-09-23 06:36:30</sys_created_on>
         <sys_id>bbcb42a61bc61d10d806dc23b24bcbd2</sys_id>
+        <sys_mod_count>105</sys_mod_count>
         <sys_name>Event</sys_name>
         <sys_package display_value="SlackerBot" source="x_snc_slackerbot">b02cf9e61b861d10d806dc23b24bcb3f</sys_package>
         <sys_policy/>
         <sys_scope display_value="SlackerBot">b02cf9e61b861d10d806dc23b24bcb3f</sys_scope>
         <sys_update_name>sys_ws_operation_bbcb42a61bc61d10d806dc23b24bcbd2</sys_update_name>
+        <sys_updated_by>admin</sys_updated_by>
+        <sys_updated_on>2024-10-11 00:48:14</sys_updated_on>
         <web_service_definition display_value="SlackerBot Event Handler">1fabce661bc61d10d806dc23b24bcbd6</web_service_definition>
         <web_service_version/>
     </sys_ws_operation>