added subjects codes to /schedule endpoint

digas99 · Sep 25, 2022 · a956c12 · a956c12
1 parent d4017f8
commit a956c12
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 68 deletions.
diff --git a/README.md b/README.md
@@ -80,7 +80,8 @@ If everything is correct, this should be the response:
                 {
                     "subject": {
                         "name": "SEGURANÇA INFORMÁTICA E NAS ORGANIZAÇÕES",
-                        "abbrev": "SIO"
+                        "abbrev": "SIO",
+                        "code": "42573"
                     },
                     "start": "9h",
                     "duration": "2h",
@@ -91,7 +92,8 @@ If everything is correct, this should be the response:
                 {
                     "subject": {
                         "name": "ARQUITETURA DE COMPUTADORES I",
-                        "abbrev": "AC-I"
+                        "abbrev": "AC-I",
+                        "code": "41948"
                     },
                     "start": "14h",
                     "duration": "1h",
@@ -105,7 +107,8 @@ If everything is correct, this should be the response:
                 {
                     "subject": {
                         "name": "ARQUITETURA DE COMPUTADORES I",
-                        "abbrev": "AC-I"
+                        "abbrev": "AC-I",
+                        "code": "41948"
                     },
                     "start": "9h",
                     "duration": "2h",

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,3 +1,9 @@
+# [Changelog v1.0.5](https://github.com/digas99/paco-ua-api/releases/tag/v1.0.5)
+Released on 25/09/2022
+
+## Content
+- Added subjects codes to /schedule endpoint
+
 # [Changelog v1.0.4](https://github.com/digas99/paco-ua-api/releases/tag/v1.0.4)
 Released on 23/09/2022
 

diff --git a/docs/README.md b/docs/README.md
@@ -30,7 +30,6 @@ This API uses a headless browser to fetch data directly from [paco.ua.pt](https:
     1. [Include Teachers](#include-teachers)
     1. [Subject Program](#subject-program)
 1. [Horário](#horário) &nbsp;&nbsp;```GET /schedule```
-    1. [Subject Schedule](#subject-schedule)
 1. [Requerimentos](#requerimentos) &nbsp;&nbsp;```GET /requests``` 
 
 ---
@@ -868,6 +867,8 @@ RESPONSE: 4.5s 🟢
 RESPONSE: 5s 🟡
 
 ```GET /schedule```
+
+```GET /schedule/subject/<subject_code>```
 ```json5
 // RESPONSE example
 {
@@ -877,7 +878,8 @@ RESPONSE: 5s 🟡
                 {
                     "subject": {
                         "name": "SEGURANÇA INFORMÁTICA E NAS ORGANIZAÇÕES",
-                        "abbrev": "SIO"
+                        "abbrev": "SIO",
+                        "code": "42573"
                     },
                     "start": "9h",
                     "duration": "2h",
@@ -888,7 +890,8 @@ RESPONSE: 5s 🟡
                 {
                     "subject": {
                         "name": "ARQUITETURA DE COMPUTADORES I",
-                        "abbrev": "AC-I"
+                        "abbrev": "AC-I",
+                        "code": "41948"
                     },
                     "start": "14h",
                     "duration": "1h",
@@ -902,7 +905,8 @@ RESPONSE: 5s 🟡
                 {
                     "subject": {
                         "name": "ARQUITETURA DE COMPUTADORES I",
-                        "abbrev": "AC-I"
+                        "abbrev": "AC-I",
+                        "code": "41948"
                     },
                     "start": "9h",
                     "duration": "2h",
@@ -923,65 +927,6 @@ RESPONSE: 5s 🟡
 }
 ```
 
-## Subject Schedule
-
-RESPONSE: 4.5s 🟢
-
-```GET /schedule/subject/<subject_code>```
-```json5
-// GET /schedule/subject/41949
-
-// RESPONSE example
-{
-    "data": {
-        "schedule": {
-            "Segunda": [
-                {
-                    "subject": {
-                        "name": "REDES DE COMUNICAÇÕES II",
-                        "abbrev": "T1"
-                    },
-                    "start": "12h",
-                    "duration": "1,5h",
-                    "capacity": 101,
-                    "room": "ANF. IV"
-                },
-                {
-                    "subject": {
-                        "name": "REDES DE COMUNICAÇÕES II",
-                        "abbrev": "P1"
-                    },
-                    "start": "14,5h",
-                    "duration": "2h",
-                    "capacity": 18,
-                    "room": "04.2.16"
-                },
-                ...
-            ],
-            "Terça": [],
-            "Quarta": [
-                {
-                    "subject": {
-                        "name": "REDES DE COMUNICAÇÕES II",
-                        "abbrev": "P5"
-                    },
-                    "start": "14h",
-                    "duration": "2h",
-                    "capacity": 19,
-                    "room": "04.3.30"
-                }
-            ],
-            ...
-        },
-        "school_year": "2021/2022",
-        "semester": 2
-    },
-    "url": "https://paco.ua.pt/secvirtual/horarios/desenho_horario.asp?tipo=1&value=-210320212",
-    "title": "Horário de REDES DE COMUNICAÇÕES II",
-    "timestamp": "2022-08-18T16:40:10.748Z"
-}
-```
-
 ---
 
 ## Requerimentos

diff --git a/docs/paco-ua-api.yml b/docs/paco-ua-api.yml
@@ -205,6 +205,9 @@ components:
                 abbrev:
                   type: string
                   description: Abbreviation of the name of the subject
+                code:
+                  type: string
+                  description: Code of the subject
             start:
               type: string
               description: Hour of the beginning of the class

diff --git a/scrapers.js b/scrapers.js
@@ -209,7 +209,7 @@ module.exports = {
             if (table) {
                 // info
                 const scheduleInfoElem = table.querySelector("tr").children[0];
-                let scheduleType; 
+                let scheduleType, subjectsList;
 
                 // subject schedule
                 if (scheduleInfoElem.childNodes.length == 1) {
@@ -224,6 +224,9 @@ module.exports = {
                     const scheduleInfo = scheduleInfoElem.childNodes[2].wholeText;
                     data["school_year"] = scheduleInfo.split(" - ")[1].split("AnoLectivo: ")[1];
                     data["semester"] = Number(scheduleInfo.split(" - ")[2].split("º")[0]);
+
+                    // subjects list
+                    subjectsList = Array.from(new Set(Array.from(table.nextElementSibling.querySelectorAll("tr > td:nth-of-type(2)")).map(info => info.innerText.split(" (")[0].trim())));
                 }
 
                 // subjects
@@ -248,7 +251,8 @@ module.exports = {
                         subject = {
                             "subject": {
                                 "name": titleData[0],
-                                "abbrev": elem.childNodes[0].wholeText.split(" ")[0].replace("\n", "")
+                                "abbrev": elem.childNodes[0].wholeText.split(" ")[0].replace("\n", ""),
+                                "code": subjectsList.filter(subject => subject.split(" - ")[1] === titleData[0])[0].split(" - ")[0]
                             },
                             "start": titleData[2].split("INÍCIO: ")[1],
                             "duration": titleData[3].split("DURAÇÃO: ")[1],