diff --git a/.gitignore b/.gitignore index 3597c7c..c1d3235 100644 --- a/.gitignore +++ b/.gitignore @@ -108,3 +108,8 @@ utils/table-generator/tables/ utils/table-generator/tables.md utils/table-generator/activities/ utils/table-generator/activities.md + +# Package files +package-lock.json +yarn.lock +pnpm-lock.yaml diff --git a/docs/README.md b/docs/README.md index cb7c880..91b3637 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,25 +6,12 @@ actionLink: /intro/ footer: "ECL 2.0 Licensed | Copyright © 2024 [Your Name]" --- -**Виконали:** +**Виконав:** -*студенти 2-го курсу, групи ІО-23:* - -*Олег ШМУЛЯР [shmuliar1@ukr.net, [@dmytrofiot23](https://t.me/dmytrofiot23)]* +*студент 2-го курсу, групи ІО-23:* *Андрій БОДНАР [bodnarandrew123@gmail.com, [@andrux4](https://t.me/andrux4)]* -*Андрій ШВЕД [andreyfrog26@gmail.com, [@Rhinemann](https://t.me/Rhinemann)]* - -*Євгеній ГОЛОВАТЕНКО [ievgeniigol@gmail.com, [@yevholova](https://t.me/yevholova)]* - -*Вікторія ВОДЯНА [vodyanayaviktoria@gmail.com, [@victoriavodyana](https://t.me/victoriavodyana)]* - -*Михайло КОРБУТ [korbutmykhailo@gmail.com, [@misha1tigr](https://t.me/misha1tigr)]* - -*Олександр ГУРАНЕЦЬ [bacant150@gmail.com, [@Bacant150](https://t.me/Bacant150)]* - - **Керівник** *доцент кафедри ОТ ФІОТ, к.т.н., доцент* **Андрій БОЛДАК** diff --git a/docs/conclusion/README.md b/docs/conclusion/README.md index 0076ccc..edadd7c 100644 --- a/docs/conclusion/README.md +++ b/docs/conclusion/README.md @@ -1,12 +1,7 @@ # Висновки -У висновках наводять оцінку отриманих результатів, можливі галузі його використання. Висновки повинні містити в собі коротку узагальнену оцінку результатів розробки, у -тому числі і з погляду на їх технічно-економічну ефективність. Необхідно порівняти -отримані результати усіх характеристик об’єкта проєктування із завданням і з основними показниками сучасних аналогічних об’єктів. +В результаті проведеної роботи ми розробили модель бази даних, яку можна використовувати для реалізації систем проведення експертних опитувань. В рамках цього проєкту я розробив серверну частину, що надає RESTFUL-інтерфейс для доступу до бази даних. Вона може використовуватися для взаємодії з таблицею питань (question). Для створення RESTful сервісу було використано мови програмування Python та веб-фреймворк Flask. -Необхідно вказати яке нове технічне рішення покладене в основу проєкту і у чому її -переваги, що нового було запропоновано самим студентом. - -На базі отриманих висновків можуть надаватися рекомендації по використанню розробки. Вони повинні -мати конкретний характер і бути цілком підтверджені проєктом. +Таким чином, створена система забезпечує ефективний та гнучкий інструмент для проведення експертних опитувань. Вона дозволяє автоматизувати процес збору та аналізу відповідей, що значно знижує час та ресурси, необхідні для проведення таких опитувань. Завдяки використанню сучасних технологій, таких як Flask, система має високу продуктивність та може легко масштабуватися відповідно до потреб користувачів. +Загалом, реалізована модель та серверна частина створюють міцний фундамент для подальшого розвитку та вдосконалення системи експертних опитувань, відкриваючи нові можливості для досліджень та аналізу даних. \ No newline at end of file diff --git a/docs/software/README.md b/docs/software/README.md index bef4c7c..be1b69f 100644 --- a/docs/software/README.md +++ b/docs/software/README.md @@ -110,4 +110,67 @@ ENGINE = InnoDB; SET SQL_MODE=@OLD_SQL_MODE; SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS; SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS; +``` + +## RESTfull-сервіс для керування опитуваннями + +Код серверу (Python, Flask) для таблиці "question": +```python +from flask import Flask, request +import mariadb as mdb +import json + +def init_db(): + try: + return mdb.connect( + host="10.1.1.36", + port=3306, + user="andruxa", + password="password1", + database="odb" + ) + except mdb.Error as e: + print(f"Error connecting to MariaDB Platform: {e}") + return None + +app = Flask(__name__) + +@app.route("/api/question", methods=["GET", "POST", "PUT", "DELETE"]) +def api_question(): + db = init_db() + if not db: + return '{"error": "Failed to connect to database"}\n', 500 + + cur = db.cursor() + + match request.method: + case "GET": + cur.execute("SELECT id, text, survey_id FROM question;") + result = [{"id": row[0], "text": row[1], "survey_id": row[2]} for row in cur] + db.close() + return json.dumps(result) + + case "POST": + data = request.get_json() + cur.execute("INSERT INTO question (text, survey_id) VALUES (?, ?);", (data['text'], data['survey_id'])) + db.commit() + db.close() + return '{"success": true}\n' + + case "PUT": + data = request.get_json() + cur.execute("UPDATE question SET text = ?, survey_id = ? WHERE id = ?;", (data['text'], data['survey_id'], data['id'])) + db.commit() + db.close() + return '{"success": true}\n' + + case "DELETE": + data = request.get_json() + cur.execute("SELECT id, text, survey_id FROM question WHERE id = ?;", (data['id'],)) + result = [{"id": row[0], "text": row[1], "survey_id": row[2]} for row in cur] + cur.execute("DELETE FROM question WHERE id = ?;", (data['id'],)) + db.commit() + db.close() + return json.dumps(result) + ``` \ No newline at end of file diff --git a/docs/test/README.md b/docs/test/README.md index 4cf2563..847a6f0 100644 --- a/docs/test/README.md +++ b/docs/test/README.md @@ -1,4 +1,33 @@ # Тестування працездатності системи +Для тестування системи використовувся додаток Postman +## Запуск сервера + ![](./startFlask.png) -*В цьому розділі необхідно вказати засоби тестування, навести вихідні коди тестів та результати тестування.* +## Метод POST +### POST QUESTION +#### Запит та відповідь + ![](./post.png) + +#### Перевірка за допомогою GET + ![](./get.png) + +## Метод PUT + +### PUT QUESTION +#### Запит та відповідь + ![](./put.png) + +#### Перевірка за допомогою GET + ![](./get2.png) + + ## Метод DELETE + +### DELETE QUESTION +#### Запит та відповідь + ![](./delete.png) + +#### Перевірка за допомогою GET + ![](./get3.png) + + diff --git a/docs/test/delete.png b/docs/test/delete.png new file mode 100644 index 0000000..fc428cd Binary files /dev/null and b/docs/test/delete.png differ diff --git a/docs/test/get.png b/docs/test/get.png new file mode 100644 index 0000000..3cff20d Binary files /dev/null and b/docs/test/get.png differ diff --git a/docs/test/get2.png b/docs/test/get2.png new file mode 100644 index 0000000..a4fcfb1 Binary files /dev/null and b/docs/test/get2.png differ diff --git a/docs/test/get3.png b/docs/test/get3.png new file mode 100644 index 0000000..2495804 Binary files /dev/null and b/docs/test/get3.png differ diff --git a/docs/test/post.png b/docs/test/post.png new file mode 100644 index 0000000..e1d1fee Binary files /dev/null and b/docs/test/post.png differ diff --git a/docs/test/put.png b/docs/test/put.png new file mode 100644 index 0000000..26305fb Binary files /dev/null and b/docs/test/put.png differ diff --git a/docs/test/startFlask.png b/docs/test/startFlask.png new file mode 100644 index 0000000..66f3124 Binary files /dev/null and b/docs/test/startFlask.png differ diff --git a/src/restful-server/serverQuestion.py b/src/restful-server/serverQuestion.py new file mode 100644 index 0000000..bce2589 --- /dev/null +++ b/src/restful-server/serverQuestion.py @@ -0,0 +1,56 @@ +from flask import Flask, request +import mariadb as mdb +import json + +def init_db(): + try: + return mdb.connect( + host="10.1.1.36", + port=3306, + user="andruxa", + password="password1", + database="odb" + ) + except mdb.Error as e: + print(f"Error connecting to MariaDB Platform: {e}") + return None + +app = Flask(__name__) + +@app.route("/api/question", methods=["GET", "POST", "PUT", "DELETE"]) +def api_question(): + db = init_db() + if not db: + return '{"error": "Failed to connect to database"}\n', 500 + + cur = db.cursor() + + match request.method: + case "GET": + cur.execute("SELECT id, text, survey_id FROM question;") + result = [{"id": row[0], "text": row[1], "survey_id": row[2]} for row in cur] + db.close() + return json.dumps(result) + + case "POST": + data = request.get_json() + cur.execute("INSERT INTO question (text, survey_id) VALUES (?, ?);", (data['text'], data['survey_id'])) + db.commit() + db.close() + return '{"success": true}\n' + + case "PUT": + data = request.get_json() + cur.execute("UPDATE question SET text = ?, survey_id = ? WHERE id = ?;", (data['text'], data['survey_id'], data['id'])) + db.commit() + db.close() + return '{"success": true}\n' + + case "DELETE": + data = request.get_json() + cur.execute("SELECT id, text, survey_id FROM question WHERE id = ?;", (data['id'],)) + result = [{"id": row[0], "text": row[1], "survey_id": row[2]} for row in cur] + cur.execute("DELETE FROM question WHERE id = ?;", (data['id'],)) + db.commit() + db.close() + return json.dumps(result)