Added documenation pdfs

.gitignore

@@ -1 +1,2 @@
 *.bak*
+*.lck

Docs/DB/schema.db

@@ -1,30 +1,38 @@
 https://dbdiagram.io/d/
 
+Table "event" {
+  "id" bigint(20) [pk, not null, increment]
+  "name" varchar(255) [default: NULL]
+  "start" time [default: NULL]
+  "end" time [default: NULL]
+  "is_full_day" bit(1) [not null]
+  "is_private" bit(1) [not null]
+  "priority" int(11) [default: NULL]
+}
 
 Table "user" {
-  "id" INT(10) [pk]
-  "name" VARCHAR(20)
-  "forename" VARCHAR(20)
-  "password" VARCHAR(20)
-  "token" VARCHAR(20)
-  "is_admin" BIT
+  "id" bigint(20) [pk, not null, increment]
+  "login" varchar(255) [default: NULL]
+  "forename" varchar(255) [default: NULL]
+  "name" varchar(255) [default: NULL]
+  "is_admin" bit(1) [not null]
+  "password" tinyblob [default: NULL]
+  "salt" tinyblob [default: NULL]
+  "token" varchar(255) [default: NULL]
 }
 
-Table "event" {
-  "id" INT(10) [pk]
-  "name" VARCHAR(20)
-  "priority" TINYINT(2)
-  "is_full_day" BIT
-  "start" TIME
-  "end" TIME
+Table "user_event" {
+  "date" date [not null, default: `curdate()`]
+  "event_id" bigint(20) [not null]
+  "user_id" bigint(20) [not null]
+
+Indexes {
+  event_id [name: "FKspe8srtv69gubpphvrnd7wekt"]
+  user_id [name: "FKk3smcqwou8absq8qjt3wk4vy9"]
+  (date, event_id, user_id) [pk]
+}
 }
 
-Table "event_list" {
-  "id" INT(10) [pk]
-  "user_id" NT(10)
-  "event_id" NT(10)
-  "date" date
-}
+Ref:"event"."id" < "user_event"."event_id"
 
-Ref:"event_list"."user_id" < "user"."id"
-Ref:"event_list"."event_id" < "event"."id"
+Ref:"user"."id" < "user_event"."user_id"

Docs/REST-API/API Reference.md

@@ -0,0 +1,113 @@
+# API Reference
+
+The vpr Api ist created around REST. Our Api has several different endpoint, that are URL based and accept standard form-encoded request bodies.
+It returns JSON-encoded responses and uses standard HTTP response codes.
+
+---
+
+## The Endpoints at "/vpr/"
+GET:
+- /all-users
+  
+POST:
+- /all-events
+- /add-user
+- /add-event
+- /del-event
+
+---
+
+## Status-codes dan HTTP-responses
+
+| STATUS | meaning |
+| --- | --- |
+| 200 | OK. The Request was successful |
+| 400 | Bad request. Check if you send all parameter |
+| 404 | endpoint not found. The Url might contain a spelling mistake |
+| 405 | Request-Method not allowed. Check if the endpoint requires an GET or POST request |
+| 500 | Internal Server error. The request failed due to an exception at the server, the Request-parameter might be in a wrong format, or the database might be unreachable |
+
+---
+
+## /all-users
+
+Request (GET):
+
+    curl localhost:8080/vpr/all-users | python3 -m json.tool
+
+Response:
+
+    [
+        [
+            userId: int, 
+            forename: string, 
+            name: string 
+        ]
+    ]
+
+---
+
+## /all-events
+
+Request (POST):
+
+    curl localhost:8080/vpr/all-events -X POST -d "userId=<int>"
+
+Response:
+
+    [
+        [
+            eventId: int, 
+            name: string, 
+            start: string, 
+            priority: int,
+            isFullDay: boolean,
+            date: string,
+            userId: int, 
+            forename: string, 
+            name: string 
+            
+        ]
+    ]
+
+---
+
+## /add-user
+
+Request (POST):
+
+    curl localhost:8080/vpr/add-user -X POST -d "name=<string>&forename=<string>&password=<string>&isAdmin=<boolean>"
+
+Response:
+
+    status 200 if request is ok
+    
+    And String "Saved"
+
+---
+
+## /add-event
+
+Request (POST):
+
+    curl localhost:8080/vpr/add-event -X POST -d "userId=<String>&date=<String>&name=<String>&start=<String>&end=<String>&prority=<int>&isFullDay=<boolean>&isPrivate=<boolean>"
+
+Response:
+
+    status 200 if request is ok
+    
+    And String "Saved"
+
+---
+
+## /del-event
+
+Request (POST):
+
+    curl localhost:8080/vpr/del-event -X POST -d "eventId=<int>"
+
+Response:
+
+    status 200 if request is ok
+
+    And String "Deleted"

Docs/REST-API/VPR Collection.postman_collection.json

@@ -0,0 +1,216 @@
+{
+	"info": {
+		"_postman_id": "d73d7eb9-ee3c-4fb4-af6f-baeba6db7f78",
+		"name": "VPR Collection",
+		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+	},
+	"item": [
+		{
+			"name": "User",
+			"item": [
+				{
+					"name": "add user",
+					"request": {
+						"method": "POST",
+						"header": [],
+						"url": {
+							"raw": "http://localhost:8080/user/add?name=Alex&forename=Rechtin&password=pw&isAdmin=true&login=alex",
+							"protocol": "http",
+							"host": [
+								"localhost"
+							],
+							"port": "8080",
+							"path": [
+								"user",
+								"add"
+							],
+							"query": [
+								{
+									"key": "name",
+									"value": "Alex"
+								},
+								{
+									"key": "forename",
+									"value": "Rechtin"
+								},
+								{
+									"key": "password",
+									"value": "pw"
+								},
+								{
+									"key": "isAdmin",
+									"value": "true"
+								},
+								{
+									"key": "login",
+									"value": "alex"
+								}
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "login",
+					"request": {
+						"method": "POST",
+						"header": [],
+						"url": {
+							"raw": "http://localhost:8080/user/add?name=Alex&forename=Rechtin&password=pw&isAdmin=true&login=alex",
+							"protocol": "http",
+							"host": [
+								"localhost"
+							],
+							"port": "8080",
+							"path": [
+								"user",
+								"add"
+							],
+							"query": [
+								{
+									"key": "name",
+									"value": "Alex"
+								},
+								{
+									"key": "forename",
+									"value": "Rechtin"
+								},
+								{
+									"key": "password",
+									"value": "pw"
+								},
+								{
+									"key": "isAdmin",
+									"value": "true"
+								},
+								{
+									"key": "login",
+									"value": "alex"
+								}
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "delete user",
+					"request": {
+						"method": "POST",
+						"header": [],
+						"url": {
+							"raw": "http://localhost:8080/user/del?userId=1",
+							"protocol": "http",
+							"host": [
+								"localhost"
+							],
+							"port": "8080",
+							"path": [
+								"user",
+								"del"
+							],
+							"query": [
+								{
+									"key": "userId",
+									"value": "1"
+								}
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "all  user",
+					"request": {
+						"method": "GET",
+						"header": [],
+						"url": null
+					},
+					"response": []
+				}
+			]
+		},
+		{
+			"name": "Event",
+			"item": [
+				{
+					"name": "add event",
+					"request": {
+						"method": "POST",
+						"header": [],
+						"url": {
+							"raw": "localhost:8080/event/add?userId=1&date=2021-12-24&name=TestEvent&start=&end=&prority=1&isFullDay=true&isPrivate=true",
+							"host": [
+								"localhost"
+							],
+							"port": "8080",
+							"path": [
+								"event",
+								"add"
+							],
+							"query": [
+								{
+									"key": "userId",
+									"value": "1"
+								},
+								{
+									"key": "date",
+									"value": "2021-12-24"
+								},
+								{
+									"key": "name",
+									"value": "TestEvent"
+								},
+								{
+									"key": "start",
+									"value": ""
+								},
+								{
+									"key": "end",
+									"value": ""
+								},
+								{
+									"key": "prority",
+									"value": "1"
+								},
+								{
+									"key": "isFullDay",
+									"value": "true"
+								},
+								{
+									"key": "isPrivate",
+									"value": "true"
+								}
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		},
+		{
+			"name": "Other",
+			"item": [
+				{
+					"name": "status test",
+					"request": {
+						"method": "GET",
+						"header": [],
+						"url": {
+							"raw": "http://localhost:8080/vpr/status-test",
+							"protocol": "http",
+							"host": [
+								"localhost"
+							],
+							"port": "8080",
+							"path": [
+								"vpr",
+								"status-test"
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		}
+	]
+}

Docs/create event testcases.md

@@ -0,0 +1,32 @@
+# Eingabe eines Termins
+
+Beim Anlegen eines Termins wird die Eingabe geprüft.  
+
+Folgende Regeln müssen zutreffen:  
+
+- Der Name muss mindestens 3 Zeichen haben. 
+- Er darf nur folgende Zeichen enthalten: __[A-Za-zÄÖÜäöü0-9 =!?+*/$%€.:,;_<>()-]__
+- Das Datum muss valide sein 
+- Das Datum muss das Format MM/TT/JJJJ haben 
+- Das Datum darf nicht in der Vergangenheit liegen 
+
+<br/><br/>
+
+## Äquivalenzklassen: 
+
+ID | Beschreibung | Eingabe | Erwartetes Ergebniss
+---|---|---|---
+0 | Name < 3 | le | Fehler
+1 | Name > 3, verbotenes Zeichen |Einkaufen\ | Fehler 
+2 | Datum falsches Format | 20/12/2021 | Fehler 
+3 | Datum in Vergangenheit | 12/20/2021 | Fehler 
+4 | Datum nicht valide | 02/31/2021 | Fehler
+5 | Name > 3, kein verbotenes Zeichen, Datum richtiges Format, Datum nicht in der Vergangenheit, Datum Valide | Einkaufen!, 12/23/2021 | Erfolg
+
+<br/><br/>
+
+## Grenzfälle: 
+ID | Beschreibung | Eingabe | Erwartetes Ergebniss
+---|---|---|---
+0 | Name == 3 | SEN | Erfolg
+1 | Datum == Heute | 12/20/2021 | Erfolg

Docs/testcases.md

@@ -0,0 +1,26 @@
+# Testfälle 
+</br>
+
+## 1. Termin anlegen
+</br>
+
+__Zweck:__  
+&nbsp;&nbsp;&nbsp;&nbsp; Testet Fehlerhafte Eingaben  
+__Vorbereitung:__  
+&nbsp;&nbsp;&nbsp;&nbsp; Login mit Username: "testUser" und Passwort "pw"  
+__Aufräumarbeiten:__  
+&nbsp;&nbsp;&nbsp;&nbsp; Keine  
+__Hinweis:__  
+&nbsp;&nbsp;&nbsp;&nbsp; Um einen Termin zu erstellen muss man den ersten Button der linken Navigationsleiste klicken
+</br>
+</br>
+
+## 1.1 Testsequenz: Fehlerhafte Eingabe
+
+ID | Eingabe | Erwartetes Ergebniss | Befund
+--- | --- | --- | --- 
+1.1.1 | Keine Eingabe | Fehlermeldung: "Der Name muss eine Länge von 3 haben" | _befund eintragen_ 
+1.1.2 | Name: "Test\Termin" | Fehlermeldung: "Der Name Darf nur aus Zahlen, Buchstaben </br> und folgenden Sonderzeichen bestehen: =!?+*/$%€.:,;_ <>()-“" | _befund eintragen_ 
+1.1.3 | Name: "TestTermin" | Fehlermeldung: "Bitte eine Priorität wählen." | _befund eintragen_ 
+1.1.4 | Name: "Test Termin" </br> Priorität: "gering" | Fehlermeldung: "Das Datum muss in der Zukunft liegen." | _befund eintragen_
+1.1.5 | Name: "Test Termin" </br> Priorität: "gering" </br> Datum"02-10-1996" | Fehlermeldung: "Das Datum muss in der Zukunft liegen." |_befund eintragen_