added the api class and methods to interact with the server

This commit is contained in:
Arlo Filley 2022-10-05 14:10:32 +01:00
parent bd81a6b624
commit 83aad87364
4 changed files with 141 additions and 2 deletions

135
website/api/api.js Normal file
View File

@ -0,0 +1,135 @@
class API {
constructor() {
this.url = "http://127.0.0.1:8000/api/";
// this is the url of the server
// this may have to change later on
}
/**
* This takes the validated data and makes a post
* request to the rocket server
* @param {String} testType
* @param {int} testLength
* @param {int} testTime
* @param {int} testSeed
* @param {int} quoteId
* @param {int} wpm
* @param {int} accuracy
* @param {int} userId
*/
postTest(testType, testLength, testTime, testSeed, quoteId, wpm, accuracy, userId) {
const data = {
'test_type': testType,
'test_length': testLength,
'test_time': testTime,
'test_seed': testSeed,
'quote_id': quoteId,
'wpm': wpm,
'accuracy': accuracy,
'user_id': userId
}
const xhr = new XMLHttpRequest();
xhr.open("POST", this.url+"post_test");
xhr.send(JSON.stringify(data));
}
/**
* Validates all the parameters used for the postTest function which it then calls
*/
validateTest() {
const test = textbox.getLetters();
const testType = "words";
let testLength = test.length;
let testTime = timer.getTime();
const testSeed = 0;
const quoteId = 0;
let wpm;
const accuracy = 0;
const userId = 0;
// this is the wpm calculation factoring in the time of test
// it assumes that all words are 5 characters long because on average
// they are
wpm = Math.round((testLength / 5) * (60 / testTime));
// the following code is a series of if statements that checks the
// types of the variables is correct if not it errors it and returns
// out of the function
if ( typeof testType !== "string" ) {
console.error(`testType is value ${typeof testType}\nshould be a string`);
return;
}
if ( typeof testLength !== "number") {
console.error(`testLength is value ${typeof testLength}\n should be a number`);
return;
}
if ( typeof testTime !== "number") {
console.error(`testTime is value ${typeof testTime}\n should be a number`);
return;
}
if ( typeof testSeed !== "number") {
console.error(`testSeed is value ${typeof testSeed}\n should be a number`);
return;
}
if ( typeof quoteId !== "number") {
console.error(`quoteId is value ${typeof quoteId}\n should be a number`);
return;
}
if ( typeof wpm !== "number") {
console.error(`wpm is value ${typeof wpm}\n should be a number`);
return;
}
if ( typeof accuracy !== "number") {
console.error(`accuracy is value ${typeof accuracy}\n should be a number`);
return;
}
if ( typeof userId !== "number") {
console.error(`userId is value ${typeof userId}\n should be a number`);
return;
}
// after checking that all variables are of the correct type these if statements check
// that they are acceptable values or are in acceptable bounds depending on variable types
if (testType !== "words") {
// currently words is the only acceptable type but
// this will change in later iterations
console.error(`testType is invalid\nacceptable options ['words']`);
}
// upper bounds for these numbers are less of a concern because the server will automatically
// return an error if values are over the limit
if (testLength < 0) {
console.error(`testLength is too small, min value 0`)
}
if (testTime < 1) {
console.error(`testTime is too small, min value 1`)
}
if (testSeed < 0) {
console.error(`testSeed is too small, min value 0`)
}
if (quoteId < 0) {
console.error(`quoteId is too small, min value 0`)
}
if (wpm < 0) {
console.error(`wpm is too small, min value 0`)
}
// accuracy needs an upper bound check because users can't have more than 100%
// accuracy when completing their tests
if (accuracy < 0) {
console.error(`accuracy is too small, min value 0`)
} else if (accuracy > 100) {
console.error(`accuracy is too big, max value 100`)
}
if (userId < 0) {
console.error(`userId is too small, min value 0`)
}
// there will be other tests here in later iterations but for now these tests should suffice
this.postTest(testType, testLength, testTime, testSeed, quoteId, wpm, accuracy, userId);
}
}

View File

@ -16,6 +16,7 @@
<script src="./ui_elements/timer.js"></script> <script src="./ui_elements/timer.js"></script>
<!-- API Script Files --> <!-- API Script Files -->
<script src="./api/api.js"></script>
</head> </head>
<body> <body>

View File

@ -1,4 +1,5 @@
let canvas; let canvas;
let api;
let textbox, timer; let textbox, timer;
function setup() { function setup() {
@ -10,8 +11,9 @@ function setup() {
frameRate(60); frameRate(60);
textbox = new Textbox(400, 200, 700); textbox = new Textbox(400, 200, 700);
timer = new Timer(0, 0, 100, 100, 0, true, '#000', true, '#000','#F3C969', 30, true); timer = new Timer(0, 0, 100, 100, 0, true, '#000', true, '#000','#F3C969', 10, true);
timer.start(); timer.start();
api = new API();
} }
// this function is called once per frame and draws all other elements // this function is called once per frame and draws all other elements

View File

@ -152,9 +152,10 @@ class Timer {
* this function is called at the end of the timer * this function is called at the end of the timer
*/ */
end() { end() {
this.visible = false;
api.validateTest();
this.timeElapsed = 0; this.timeElapsed = 0;
this.time = 0; this.time = 0;
this.visible = false;
// Then this function will call all other functions necessary to complete the test // Then this function will call all other functions necessary to complete the test
// this will likely including changing the screen and interacting with the api // this will likely including changing the screen and interacting with the api
} }