@itutoring/itutoring_application_js_api 1.0.0

package/CookiesManager.js

@@ -0,0 +1,34 @@
+class CookiesManager
+{
+    static SetCookie(name, value, expiracy)
+    {
+        if (this.GetCookie(name) != null)
+            return;
+        
+        document.cookie = name + "=" + value + "; expires=" + expiracy + ";path=/";
+    }
+
+    static GetCookie(name)
+    {
+        var cookie = decodeURIComponent(document.cookie);
+        var values = cookie.split(';');
+
+        for (var i = 0; i < values.length; i++)
+        {
+            var c = values[i];
+
+            while (c.charAt(0) == ' ')
+            {
+                c = c.substring(1);
+            }
+            if (c.indexOf(name) == 0)
+            {
+                return c.substring(name.length + 1, c.length);
+            }
+        }
+
+        return null;
+    }
+}
+
+export default CookiesManager;

package/README.md

@@ -0,0 +1 @@
+# iTutoring_Application_API-js

package/apiController.js

@@ -0,0 +1,227 @@
+import CookiesManager  from "./CookiesManager";
+import R_KEYs from "./objects/Enums";
+
+/**
+ * Main class for comunicating with our backend REST api.
+ */
+class APIController
+{
+    static #R_KEY = "-1";
+    static #CLIENT_KEY = "-1";
+
+    /**
+     * 
+     * @returns Returns apropriate rest url based on current server.
+     */
+    static REST_URL()
+    {
+        if (location.hostname == 'localhost')
+        {
+            return "https://itutoring.9e.cz/server/php/API/";
+
+        }
+        else
+        {
+            return "server/php/API/";
+        }
+    }
+
+    static CreateVisitorSession()
+    {
+        var id = Date.now();
+        var date = new Date();
+        date.setTime(date.getTime() + (7 * 24 * 60 * 60 * 1000));
+
+        CookiesManager.SetCookie("session", id, date.toUTCString());
+    }
+
+    static GetVisitorSessionID()
+    {
+        console.log(CookiesManager.GetCookie("session"));
+        return CookiesManager.GetCookie("session");
+    }
+
+    /**
+     * 
+     * @param module "Name of API module"
+     * @param method "Name of API method "
+     * @param data "data must be as array - key, value pair. They'll be passed into the request"
+     * @returns "Response from server"
+     */
+    static async Get(module, method, data)
+    {
+        await APIController.GetLocalRKey();
+        await APIController.GetClientKey();
+
+        return new Promise(resolve =>
+        {
+            var args = APIController.GetArgsFromArray(data);
+
+            var request = new XMLHttpRequest();
+            request.withCredentials = true;
+            request.open("GET", APIController.REST_URL() + module + "/" + method + "?" + args, true);
+            request.onreadystatechange = function ()
+            {
+                if (request.readyState == 4)
+                {
+                    resolve(request.responseText);
+                }
+            }
+
+            request.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
+            request.setRequestHeader("r-key", APIController.#R_KEY);
+            request.setRequestHeader("sites", location.hostname);
+            request.setRequestHeader("key", APIController.#CLIENT_KEY);
+            request.setRequestHeader("visitor-session", this.GetVisitorSessionID());
+            request.send();
+        });
+    }
+
+    /**
+     * 
+     * @param module "Name of API module"
+     * @param method "Name of API method "
+     * @param data "data must be as array - key, value pair. They'll be passed into the request"
+     * @returns "Response from server"
+     */
+    static async Post(module, method, data)
+    {
+        await APIController.GetLocalRKey();
+        await APIController.GetClientKey();
+
+        return new Promise(resolve =>
+        {
+            var args = APIController.GetArgsFromArray(data);
+
+            var request = new XMLHttpRequest();
+            request.open("POST", APIController.REST_URL() + module + "/" + method, true);
+
+            request.onreadystatechange = function ()
+            {
+                if (request.readyState == 4)
+                {
+                    resolve(request.responseText);
+                }
+            }
+
+            request.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
+            request.setRequestHeader("r-key", APIController.#R_KEY);
+            request.setRequestHeader("sites", location.hostname);
+            request.setRequestHeader("key", APIController.#CLIENT_KEY);
+            request.setRequestHeader("visitor-session", this.GetVisitorSessionID());
+            request.send(args);
+        });
+    }
+
+    static GetArgsFromArray(args)
+    {
+        var argsString = "";
+
+        if (args != null)
+        {
+            for (const [key, value] of Object.entries(args))
+            {
+                argsString += key + "=" + value + "&";
+            }
+        }
+        return argsString;
+    }
+
+    /**
+     * 
+     * @returns r_key for this server
+     */
+    static GetLocalRKey()
+    {
+        return new Promise(resolve =>
+        {
+            if (APIController.#R_KEY != "-1")
+            {
+                resolve(APIController.#R_KEY);
+            }
+
+            // For localhost don't use xml config, but automaticly
+            // return test key.
+            if (location.hostname === "localhost")
+            {
+                APIController.#R_KEY = R_KEYs.r_key_test;
+                resolve(APIController.#R_KEY);
+            }
+            else
+            {
+                fetch('/key_config.xml').then(response => response.text()).then((data) =>
+                {
+                    var parser = new DOMParser();
+                    var rKeyXML = parser.parseFromString(data, "text/xml");
+                    var rKey = rKeyXML.getElementsByTagName("key")[0].childNodes[0].nodeValue;
+
+                    APIController.#R_KEY = rKey;
+                    resolve(APIController.#R_KEY);
+                });
+            }
+        });
+    }
+
+    static GetClientKey()
+    {
+        return new Promise(resolve =>
+        {
+            if (APIController.#CLIENT_KEY != "-1")
+            {
+                resolve(APIController.#CLIENT_KEY);
+            }
+
+            // For localhost don't use xml config, but automaticly
+            // return test key.
+            if (location.hostname === "localhost")
+            {
+                APIController.#CLIENT_KEY = "r5u8x/A?D(G+KbPeShVmYp3s6v9y$B&E";
+                resolve(APIController.#R_KEY);
+            }
+            else
+            {
+                fetch('/client_key.xml').then(response => response.text()).then((data) =>
+                {
+                    var parser = new DOMParser();
+                    var keyXML = parser.parseFromString(data, "text/xml");
+                    var key = keyXML.getElementsByTagName("key")[0].childNodes[0].nodeValue;
+
+                    APIController.#CLIENT_KEY = key;
+                    resolve(APIController.#CLIENT_KEY);
+                });
+            }
+        });
+    }
+
+    static async GetCurrentHostURl()
+    {
+        if (location.hostname == 'localhost')
+        {
+            return "http://localhost:3000";
+        }
+        else
+        {
+            var r_key = await this.GetLocalRKey();
+            if (r_key == R_KEYs.r_key_test)
+            {
+                return "https://itutoring.9e.cz";
+            }
+            else
+            {
+                return "https://itutoring.cz";
+            }
+        }
+    }
+
+    static IntToBool(value)
+    {
+        return value == 1 ? true : false;
+    }
+
+    static BoolToInt(value)
+    {
+        return value ? 1 : 0;
+    }
+}
+
+export default APIController;

package/cache.js

@@ -0,0 +1,19 @@
+class APICache
+{
+    static Cache(key, data)
+    {
+        localStorage.setItem(key, data);
+    }
+
+    static Retrive(key)
+    {
+        return localStorage.getItem(key);
+    }
+
+    static IsCached(key)
+    {
+        return !(localStorage.getItem(key) === null);
+    }
+}
+
+export default APICache;

package/index.js

@@ -0,0 +1,2 @@
+"use strict";
+

package/modules/CoursesSystem.js

@@ -0,0 +1,209 @@
+import APIController from "./../apiController";
+import Course from "./../objects/Course";
+import CourseReservation from "../objects/CourseReservation";
+
+class CoursesSystem
+{
+    /**
+     * Respective module name for this class
+     */
+    static #MODULE = "CourseSystem";
+
+    // All method names
+    static #GET_ALL_AVAILABLE_COURSES = "GetAvailableCourses";
+    static #GET_PRICE = "GetPrice";
+    static #BOOK = "Book";
+    static #RESERVE_PLACE = "ReservePlace";
+    static #CONFIRM_COURSE = "ConfirmCourse";
+    static #ORDER_TIMEOUT = "OrderTimeout";
+    static #GET_RESERVATION = "GetReservation";
+    static #IS_RESERVATION_PAID = "IsReservationPaid";
+    static #MARK_RESERVATION_PAID = "MarkReservationPaid";
+
+    static async MarkReservationPaid(reservationId, transactionId)
+    {
+        var res = await APIController.Get(this.#MODULE, this.#MARK_RESERVATION_PAID, {
+            'reservationId': reservationId,
+            'transactionId': transactionId,
+        });
+
+        return APIController.IntToBool(res);
+    }
+
+    /**
+     * Get if reservation is paid or not
+     * @param {*} id reservation order ID
+     * @returns bool
+     */
+    static async IsReservationPaid(id)
+    {
+        var res = await APIController.Get(this.#MODULE, this.#IS_RESERVATION_PAID, {
+            'order': id,
+        });
+
+        return APIController.IntToBool(res);
+    }
+
+    /**
+     * Get reservation by its ID.
+     * @param {*} id reservation order ID
+     * @returns CourseReservation object
+     */
+    static async GetReservation(id)
+    {
+        var reservationJSON = await APIController.Get(this.#MODULE, this.#GET_RESERVATION, {
+            'order': id,
+        });
+
+        var reservationArray = JSON.parse(reservationJSON);
+
+        var reservation = new CourseReservation();
+        reservation.CourseId = reservationArray['CourseId'];
+        reservation.Email = reservationArray['Email'];
+        reservation.FirstName = reservationArray['FirstName'];
+        reservation.LastName = reservationArray['LastName'];
+        reservation.TeacherId = reservationArray['TeacherId'];
+
+        return reservation;
+    }
+
+    /**
+     * Checks if your reserved place is still in DB, if not returns true.
+     * 
+     * This method uses token stored in session, so you have to run ReservePlace 
+     * before to be able to run this method.
+     * 
+     * Represents creating order timeout.
+     * @returns bool
+     */
+    static async OrderTimeout()
+    {
+        var res = await APIController.Get(this.#MODULE, this.#ORDER_TIMEOUT);
+
+        return APIController.IntToBool(res);
+    }
+
+    /**
+     * Send notification email about reserving course. Reservation is taken from book,
+     *  which means this method will work only after book.
+     * @param {*} resend 
+     * @returns Returns true if succeded.
+     */
+    static async ConfirmCourse(resend)
+    {
+        var res = await APIController.Get(this.#MODULE, this.#CONFIRM_COURSE, {
+            'resend': APIController.BoolToInt(resend),
+        });
+
+        return APIController.IntToBool(res);
+    }
+
+    /**
+     * This method is used to reserve place in course without creating reservation. 
+     * Is used to hold course during creating order. Will create unique token which 
+     * is used to identify your reserved place. This token is not returned and is kept 
+     * on backend side. 
+     * @param {*} courseId 
+     * @returns  int (BookReturn enum)
+     */
+    static async ReservePlace(courseId)
+    {
+        var res = await APIController.Post(this.#MODULE, this.#RESERVE_PLACE, {
+            'courseId': courseId,
+        });
+
+        return res;
+    }
+
+    /**
+     * Book specific course.
+     * 
+     * Teacher id is not needed to be specified as will be fetched by course id.
+     * @param {*} courseReservation CourseReservation object
+     * @returns  int (BookReturn enum)
+     */
+    static async Book(courseReservation)
+    {
+        var res = await APIController.Post(this.#MODULE, this.#BOOK, {
+            'reservation': encodeURIComponent(JSON.stringify(courseReservation)),
+        });
+
+        return res;
+    }
+
+    /**
+     * Get all available courses by specific parameters
+     * @param {*} school type of scool for the course
+     * @param {*} subject subject id (0 - math 1 - czech)
+     * @param {*} length course length (lessons)
+     * @param {*} capacity  course capacity
+     * @returns Course[]
+     */
+    static async GetAvailableCourses(school, subject, length, capacity)
+    {
+        var data = await APIController.Get(this.#MODULE, this.#GET_ALL_AVAILABLE_COURSES, {
+            'school': school,
+            'subject': subject,
+            'length': length,
+            'capacity': capacity,
+        });
+
+        // Check if returned data are valid JSON object.
+        try
+        {
+            JSON.parse(data);
+        }
+        catch
+        {
+            return [];
+        }
+
+        var dataArray = JSON.parse(data);
+
+        var availableCourses = [];
+
+        for (const [key, value] of Object.entries(dataArray))
+        {
+            var course = new Course();
+
+            course.Name = value['Name'];
+            course.NameRaw = value['NameRaw'];
+            course.School = value['School'];
+            course.Price = value['Price'];
+            course.CreditPrice = value['CreditPrice'];
+            course.ID = value['ID'];
+            course.Day = value['Day'];
+            course.Time = value['Time'];
+            course.Length = value['Length'];
+            course.Lessons = value['Lessons'];
+            course.Capacity = value['Capacity'];
+            course.Item = value['Item'];
+            course.Subject = value['Subject'];
+            course.PriceBeforeSale = value['PriceBeforeSale'];
+            course.IsSaled = value['IsSaled'];
+
+            availableCourses[course.ID] = course;
+        }
+
+        return availableCourses;
+    }
+
+    /**
+     * Get price of courses
+     * @param {*} cheap if you want to get the cheapest or the most expensive price tag - bool
+     * @param {*} paramas - optional -  JSON url encoded - additional params to filter the courses - key must be variable name of Course object
+     * @returns int
+     */
+    static async GetPrice(cheap, paramas = [])
+    {
+        var price = await APIController.Get(this.#MODULE, this.#GET_PRICE, {
+            'cheap': APIController.BoolToInt(cheap),
+            'params': encodeURIComponent(JSON.stringify(paramas)),
+        });
+
+        console.log(price);
+        return parseInt(price);
+    }
+}
+
+export default CoursesSystem;

package/modules/CustomerAuth.js

@@ -0,0 +1,76 @@
+import APIController from "./../apiController";
+//import EventHandling from "./EventHandling";
+
+class CustomerAuth
+{
+    /**
+    * Respective module name for this class
+    */
+    static #MODULE = "CustomerAuth";
+
+    // All method names
+    static #IS_AUTHENTICATED = "IsAuthenticated";
+    static #LOG_IN = "Login";
+    static #SIGN_ING = "SignIn";
+
+    /**
+     * Checks if currunet user(customer) is authenticated or not.
+     * @returns bool
+     */
+    static async IsAuthenticated()
+    {
+        var result = await APIController.Get(this.#MODULE, this.#IS_AUTHENTICATED);
+
+        return APIController.IntToBool(result);
+    }
+
+    /**
+     * 
+     * @param {*} email 
+     * @param {*} pass 
+     * @param {*} fname 
+     * @param {*} lname 
+     * @returns Int (AuthResult)
+     */
+    static async SignIn(email, pass, fname, lname)
+    {
+        var result = await APIController.Post(this.#MODULE, this.#SIGN_ING, {
+            'email': email,
+            'pass': pass,
+            'fname': fname,
+            'lname': lname,
+        });
+
+        /*EventHandling.OnUserSignIn.publish(
+            {
+                result: result
+            }
+        );*/
+
+        return result;
+    }
+
+    /**
+     * 
+     * @param {*} email 
+     * @param {*} password 
+     * @returns Int (AuthResult)
+     */
+    static async LogIn(email, password)
+    {
+        var result = await APIController.Post(this.#MODULE, this.#LOG_IN, {
+            'email': email,
+            'pass': password,
+        });
+
+        /*EventHandling.OnUserLogIn.publish(
+            {
+                result: result,
+            }
+        );
+*/
+        return result;
+    }
+}
+
+export default CustomerAuth;

package/modules/CustomerPortal.js

@@ -0,0 +1,38 @@
+import APIController from "./../apiController";
+import Customer from "./../objects/Customer";
+
+class CustomerPortal
+{
+   /**
+   * Respective module name for this class
+   */
+   static #MODULE = "CustomerPortal";
+
+   // All method names
+   static #GET_CUSTOMER_INFO = "GetCustomerInfo";
+
+   /**
+    * Customer must be logged in otherwise this method will return null object.
+    * @returns Customer object
+    */
+   static async GetCustomerInfo()
+   {
+      var customerString = await APIController.Get(this.#MODULE, this.#GET_CUSTOMER_INFO);
+      if (customerString == "null")
+      {
+         return null;
+
+      }
+      var customerArray = JSON.parse(customerString);
+
+      var customer = new Customer();
+      customer.Email = customerArray['Email'];
+      customer.FirstName = customerArray['FirstName'];
+      customer.LastName = customerArray['LastName'];
+      customer.ID = customerArray['ID'];
+
+      return customer;
+   }
+}
+
+export default CustomerPortal;

package/modules/Email.js

@@ -0,0 +1,63 @@
+import APIController from "./../apiController";
+
+class Email
+{
+    /**
+        * Respective module name for this class
+        */
+    static #MODULE = "Email";
+
+    static #SEND = "Send";
+
+    /**
+     * Send email
+     * 
+     * @param {*} header email header
+     * @param {*} message email main text (p)
+     * @param {*} params email parameters as key: value \n (as array)
+     * @param {*} fHeader heading in footer
+     * @param {*} fMessage main text in footer
+     * @param {*} fReason text below footer, saying like: You receiving this email because...
+     * @param {*} buttonText button text in email
+     * @param {*} buttonLink button url link in email
+     * @param {*} title 'optional' int 0/1 to hide the buttons
+     * @param {*} toEmail Email title
+     * @param {*} toName Receipent name
+     * @param {*} buttonHide bool to hide button (false is default)
+     * @param {*} fromEmail 'optional' - sender email (itutoring is default)
+     * @param {*} fromName 'optional' - sender name {itutoring is default)
+     * @returns bool
+     */
+    static async Send(header, message, params, fHeader, fMessage, fReason, buttonText, buttonLink, title, toEmail, toName, buttonHide = false, fromEmail = 'default', fromName = 'default')
+    {
+        var postQuery = {
+            'header': header,
+            'message': message,
+            'params': JSON.stringify(params),
+            'fHeader': fHeader,
+            'fMessage': fMessage,
+            'fReason': fReason,
+            'buttonText': buttonText,
+            'buttonLink': buttonLink,
+            'buttonHide': APIController.BoolToInt(buttonHide),
+            'title': title,
+            'toEmail': toEmail,
+            'toName': toName,
+        }
+        if (fromEmail != 'default')
+        {
+            postQuery.fromEmail = fromEmail;
+        }
+
+        if (fromName != 'default')
+        {
+            postQuery.fromName = fromName;
+        }
+
+        await APIController.Post(this.#MODULE, this.#SEND, postQuery);
+
+        return true;
+    }
+}
+
+export default Email;

package/modules/Newsletters.js

@@ -0,0 +1,22 @@
+import APIController from "./../apiController";
+
+class Newsletters
+{
+    /**
+        * Respective module name for this class
+        */
+    static #MODULE = "Newsletters";
+
+    static #ADD_CUSTOMER = "AddCustomer";
+
+    static async AddCustomer(email)
+    {
+        await APIController.Get(this.#MODULE, this.#ADD_CUSTOMER, {
+            'email': email
+        });
+
+        return true;
+    }
+}
+
+export default Newsletters;