=====database=====

==== Table of Content ====
     - [[[[wiki:software:beuthbot:database#database|database]]
     - [[[[wiki:software:beuthbot:database#Table of Content|Table of Content]]
     - [[[[wiki:software:beuthbot:database#Motivation|Motivation]]
     - [[[[wiki:software:beuthbot:database#Requirements|Requirements]]
       - [[[[wiki:software:beuthbot:database#Functional|Functional]]
       - [[[[wiki:software:beuthbot:database#Non Functional|Non Functional]]
     - [[[[wiki:software:beuthbot:database#User Stories|User Stories]] 
     - [[[[wiki:software:beuthbot:database#Use Cases|Use Cases]]
     - [[[[wiki:software:beuthbot:database#Klassendiagramm User|Klassendiagramm User]]
     - [[[[wiki:software:beuthbot:database#Technologies|Technologies]]
     - [[[[wiki:software:beuthbot:database#Integration|Integration]]
       - [[[[wiki:software:beuthbot:database#Sequenzdiagramm mit angesteuertem Service|Sequenzdiagramm mit angesteuertem Service]]
       - [[[[wiki:software:beuthbot:database#Sequenzdiagramm nur Datenbank betreffend|Sequenzdiagramm nur Datenbank betreffend]]
     - [[[[wiki:software:beuthbot:database#Getting Started|Getting Started]]
       - [[[[wiki:software:beuthbot:database#Windows|Windows]]
     - [[[[wiki:software:beuthbot:database#API|API]]
       - [[[[wiki:software:beuthbot:database#Request all Users|Request all Users]]
       - [[[[wiki:software:beuthbot:database#Request Users|Request Users]]
       - [[[[wiki:software:beuthbot:database#Add / Change Detail|Add / Change Detail]]
       - [[[[wiki:software:beuthbot:database#Delete all Details|Delete all Details]]
       - [[[[wiki:software:beuthbot:database#Delete Detail|Delete Detail]]

====Motivation====

Die Motivation hinter einer Datenbank im BeuthBot Projekt kommt durch das Problem, dass Benutzer ihre Wünsche immer wieder komplett ausführen müssen.\\
Als Beispiel: Wenn der Benutzer die Mensa nach veganen Gerichten anfragt, dann muss er das bei der nächsten Anfrage wiederholen. \\
Die Datenbank soll das Problem beheben und den Benutzern die Möglichkeit bieten ihre Vorlieben zu persistieren, ohne dass diese sich einen extra Account anlegen müssen.
Dabei muss darauf geachtet werden, dass in der Zukunft noch neue Services dazu kommen können. Die Architektur und die Datenbank sollten so konzipiert werden, dass neue Details die zu neuen Services gehören gespeichert werden können, ohne dass die Datenbank dazu angepasst werden muss.

====Requirements====

// # Was soll die DB können?//

===Functional===

  * ''/DBF100/'' The system must be able to store details about a user.
  * ''/DBF101/'' The system must be able to add a detail related to a user.
  * ''/DBF102/'' The system must be able to change a detail related to a user.
  * ''/DBF103/'' The system must be able to delete a detail related to a user.
  * ''/DBF104/'' The system must be able to load all details about a user.
  * ''/DBF105/'' The system must be able to delete all entries related to a user.
  * ''/DBF106/'' It must be able to add new services and store related user details without modifying the database.

  * ''/DBF200/'' The database must store data related to a user.
  * ''/DBF201/'' The database must be able to store a nickname related to a user.
  * ''/DBF202/'' The database must be able to store a new detail about a user without scaling the schema.
  * ''/DBF203/'' The database must have a capacity of N.

===Non Functional===

  * ''/DBNF200/'' The database must be easily scalable.
  * ''/DBNF201/'' The database must be easy replaceable.

Referenz WS2019:

  * ''/NF500/'' The system should comply with DSGVO guidelines
  * ''/NF501/'' The system should be based on security standards
  * ''/NF502/'' Databases should be protected from unwanted access
  * ''/NF503/'' The databases should be password protected
  * ''/NF504/'' The databases should be based on security standards
  * ''/NF600/'' The system should restart the service independently in the event of a service failure
  * ''/NF700/'' The system should be well documented
  * ''/NF701/'' The system should be easy to understand

====User Stories====

<code>
"Als <Rolle> möchte ich <Ziel/Wunsch>, um <Nutzen>"
</code>

  * ''/DBUS100/'' Als Student möchte ich meine Vorlieben speichern, damit ich sie nicht immer wieder ausschreiben muss.
  * ''/DBUS101/'' Als Student möchte ich nach einigen Anfragen, dass ich gefragt werde ob ich meine Vorlieben speichern möchte, damit ich sie nicht immer wieder ausschreiben muss.
  * ''/DBUS102/'' Als Student möchte ich, dass der Bot mich wiedererkennt ohne einen extra Account anlegen zu müssen, damit ich keine zusätzlichen persönlichen Informationen preisgeben muss.
  * ''/DBUS103/'' Als Student möchte ich dem Bot sagen können, dass er meine ALLE meine Daten löschen soll.
  * ''/DBUS103/'' Als Student möchte ich dem Bot sagen können, dass er ein Detail über mich löschen soll.


====Use Cases====

<uml>
@startuml
left to right direction

actor "Student" as ST 

package BeuthBot {
  actor "DBController" as DBC << Application >>
  usecase "Remember Nickname" as UC1
  usecase "Forget Nickname" as UC2
  usecase "Remember Detail" as UC3
  usecase "Forget Detail" as UC4
  usecase "Forget All Detail" as UC5
}

ST --> UC1
ST --> UC2
ST --> UC3
ST --> UC4
ST --> UC5

UC1 --> DBC
UC2 --> DBC
UC3 --> DBC
UC4 --> DBC
UC5 --> DBC
@enduml
</uml>

====Klassendiagramm User====

<uml>
@startuml
class User {
  id: Int
  nickname: String?
  details: Dictionary<String, AnyObject>
}
hide methods
@enduml
</uml>

====Technologies====

Durch die Anforderung, dass die Details, die zu einem User gespeichert werden sehr variabel sein können, ist von einer relationalen Datenbank wie MySQL o.ä. abzuraten. MongoDB ist eine dokumentenorientierte NoSQL-Datenbank. Mit ihr können Sammlungen von JSON-ähnlichen Dokumenten erstellt und verwaltet werden. So können wir die Daten zu einem User in komplexen Hierarchien verschachteln und erweitern ohne uns Gedanken zu einem Tabellen-Schema machen zu müssen.

  * MongoDB [[https://www.mongodb.com/de|Link]]
  * MongoDB Docker Image [[https://hub.docker.com/_/mongo|Link]]

<uml>
@startuml
package "docker-compose.yml" {
  [MongoDB (Container)]
  [DB Controller (Container)]
}
@enduml
</uml>

====Integration====

<uml>
@startuml
actor "User" as U
rectangle "telgram-bot" as TGB
package "BeuthBot" {
  rectangle "gateway" as GW
  package "Persistence" {
    rectangle "database-container" as DBC
    database "DB_NAME" {
    }
  }
}

U -down-> TGB
TGB -right-> GW
GW -left-> TGB

GW -up-> DBC
DBC -down-> GW

DB_NAME -right-> DBC
DBC -left-> DB_NAME
@enduml
</uml>


===Sequenzdiagramm mit angesteuertem Service===

<uml>
@startuml
participant gateway as GW
participant deconcentrator as DC
box
participant databasecontroller as DBC
database database as DB
endbox
participant service as SE

GW -> DC: Request
activate DC
return Response (Intent + [Args]

GW -> DBC: Request User
activate DBC
DBC -> DB: Get User
activate DB
return Return User
return Responses User

GW -> SE: Request (User + [Args])
activate SE
return Answer
@enduml
</uml>

===Sequenzdiagramm nur Datenbank betreffend===

<uml>
@startuml
participant gateway as GW
participant deconcentrator as DC
box
participant databasecontroller as DBC
database database as DB
endbox

GW -> DC: Request "Merke dir, dass ich vegetarisch esse."
activate DC
return Response (Intent + [Args])

GW -> DBC: Add Detail "vegetarisch"
activate DBC
DBC -> DB: Store "vegetarisch"
activate DB
return Result
return GW: Result
@enduml
</uml>

====Nächsten Schritte====

  * Projekt Ordner und GitHub Repository erstellen
  * DB dem BeuthBot Projekt hinzufügen
  * Geignete Dockerfile formulieren mit MongoDB als Abhängigkeit
  * Datenbankcontroller erstellen, welcher ADD, REMOVE, CHANGE Befehle für Details entgegen nimmt
  * Trainingsmodell für RASA für die Datenbank erstellen
  * Erste versuche mit dem Trainingsmodell von RASA

====Getting Started====

Die Datenbank wurde mit Docker erstellt. Um diese zum laufen zu bringen müssen folgende Befehle ausgeführt werden:

<code>
# clone the repository
git clone https://github.com/beuthbot/database.git

# go to the folder
cd database

# start the docker container to run the mongodb and its corresponding database microservice
docker-compose up
</code>

===Windows===

Damit es auf Windows funktionieren kann müssen folgende Zeilen in der docker-compose.yml Datei geändert werden:

<code>
...
    volumes:
      - mongodata:/data/db # needed for me to run container on Windows 10
      #- ./../.database:/data/db # For Mac/Linux
...
# needed for me to run container on Windows 10
volumes:
  mongodata:
</code>

Außerdem muss ein shared Folder existieren, welcher beispielsweise 'mongodb' genannt werden muss, worin sich der Ordner 'data' mit den Unterordnern 'db' und 'configdb' befindet.
Die Ordnerstruktur sollte nun wie folgt aussehen:
<code>
E:\mongodb
    └───data
          ├───configdb
          └───db
</code>

==== API ====
=== Request all Users ===
Requests all Users in the collection
<code>
GET http://localhost:27000/users
</code>

== Response ==
<code>
{...},
{
  "id": 12345678,
  "nickname": "Alan",
  "details" : {
    "eating_habit" : "vegetarisch",
    "city" : "Berlin"
  }
},
{...}
</code>

== Error ==
<code>
{
  "error": ...
}
</code>
=== Request User ===

<code>
GET http://localhost:27000/users/<id>
</code>

== Reponse ==
Request a single user with the given id.
<code>
{
  "id": 12345678,
  "nickname": "Alan",
  "details" : {
    "eating_habit" : "vegetarisch",
    "city" : "Berlin"
  }
}
</code>

== Error ==

<code>
{
  "error": ...
}
</code>

=== Add / Change Detail ===
Add/Change a Detaile to/from the User with the given id.
<code>
POST http://localhost:27000/users/<id>/detail
</code>

== Request Body ==

<code>
{
  "detail": "eating_habit",
  "value": "vegetarisch"
}
</code>

== Reponse ==
If the operation was successful the error will be set to null and the success will be set to true. If the operation failed an error message will be set and the success will be set to false.
<code>
{
  "error": null,
  "success": true | false
}
</code>
===  Delete all Details ===
Deletes all Details from the User with the given id
<code>
DELETE http://localhost:27000/user/<id>/detail?q=<value>
</code>

== Reponse ==
If the operation was successful the error will be set to null and the success will be set to true. If the operation failed an error message will be set and the success will be set to false.

<code>
{
  "error": null,
  "success": true | false
}
</code>

===  Delete Detail ===
Deletes one Detail from the User with the given id.

<code>
DELETE http://localhost:27000/user/<id>/detail?q=<value>
</code>

== Reponse ==
If the operation was successful the error will be set to null and the success will be set to true. If the operation failed an error message will be set and the success will be set to false.
<code>
{
  "error": null,
  "success": true | false
}
</code>