Merge pull request #1 from gustapp/GNMD-1

GNMD-1 Architecture Design

.vscode/launch.json

@@ -2,10 +2,19 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Node.JS (local)",
+            "name": "Cloud functions debug",
             "type": "node",
             "request": "attach",
             "port": 9229
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Run script",
+            "program": "${workspaceFolder}/scripts/firestore.manual_fill.js",
+            "outFiles": [
+                "${workspaceFolder}/**/*.js"
+            ]
         }
     ]
 }

functions/src/dao/data-access-base.ts

@@ -0,0 +1,39 @@
+export abstract class DataAccessBase<T> {
+
+    protected abstract collectionId;
+
+    constructor(private db: FirebaseFirestore.Firestore){}
+
+    public get(id?: string) {
+        // Get only one entity
+        if(id){
+            return this.db.collection(this.collectionId).doc(id).get().then(doc => {
+                if (doc.exists) {
+                    // returns orm data
+                    return this.map(doc.data());
+                } else {
+                    // no document found
+                    return undefined;
+                }
+            }).catch(error => {
+                return error;
+            });
+        }
+        // Get collection of documents
+        else {
+            return this.db.collection(this.collectionId).get().then(querySnapshot => {
+                // Collection of retrieved documents
+                let result = [];
+                querySnapshot.forEach(doc => {
+                    result.push(this.map(doc.data()));
+                });
+                return result;
+
+            }).catch(error => {
+                return error;
+            });
+        }
+    }
+
+    protected abstract map(data: FirebaseFirestore.DocumentData) : T;
+}

functions/src/dao/data-access-classes.ts

@@ -0,0 +1,11 @@
+import { DataAccessBase } from "./data-access-base";
+import { ClassProxy } from "../model/business-class";
+
+export class DataAccessClasses extends DataAccessBase<ClassProxy> {
+
+    protected collectionId = 'cursos';
+
+    protected map(data: FirebaseFirestore.DocumentData) : ClassProxy {
+        return new ClassProxy(data.codigo_turma, data.tipo_turma);
+    }
+}

functions/src/dao/data-access-courses.ts

@@ -0,0 +1,11 @@
+import { DataAccessBase } from "./data-access-base";
+import { CourseProxy } from "../model/business-course";
+
+export class DataAccessCourse extends DataAccessBase<CourseProxy> {
+
+    protected collectionId = 'cursos';
+
+    protected map(data: FirebaseFirestore.DocumentData) : CourseProxy {
+        return new CourseProxy(data.sigla, data.name, data.objetivos, data.docentes, data.programa_resumido, data.programa, data.avaliacao, data.bibliografia, data.carga_horaria, data.creditos, data.requisitos);
+    }
+}

functions/src/dao/data-access-schedules.ts

@@ -0,0 +1,11 @@
+import { DataAccessBase } from "./data-access-base";
+import { Schedule } from "../model/business-class";
+
+export class DataAccessSchedules extends DataAccessBase<Schedule> {
+
+    protected collectionId = 'cursos';
+
+    protected map(data: FirebaseFirestore.DocumentData) : Schedule {
+        return new Schedule(data.dia, data.horario_inicio, data.horario_fim, data.professor);
+    }
+}

functions/src/index.ts

@@ -49,13 +49,9 @@ export const dialogflowFirebaseFulfillment = functions.https.onRequest((request,
     intentMap.set('GetCourseTeacher', (client) => facade.getCourseTeacher(client)); //ok
     intentMap.set('GetCourseSchedule', (client) => facade.getCourseSchedule(client)); //ok
     intentMap.set('GetCourseCredit', (client) => facade.getCourseCredit(client)); //ok
-    intentMap.set('getCourseFromScheduleDay', facade.getCourseFromScheduleDay);
-    intentMap.set('getCourseFromScheduleDayHour', facade.getCourseFromScheduleDayHour);
-    intentMap.set('getCourseSuggestion', facade.getCourseSuggestion);
-    intentMap.set('getCourseSuggestionBefore', facade.getCourseSuggestionBefore);
-    intentMap.set('getCourseSuggestionAfter', facade.getCourseSuggestionAfter);
-    intentMap.set('getCourseSuggestionBetween', facade.getCourseSuggestionBetween);
-    intentMap.set('getCourseSuggestionDays', facade.getCourseSuggestionDays);
+    intentMap.set('getCourseFromScheduleDay', facade.getCourseFromScheduleDay); //not implemented
+    intentMap.set('getCourseFromScheduleDayHour', facade.getCourseFromScheduleDayHour); //not implemented
+    intentMap.set('GetCourseSuggestion', facade.getCourseSuggestion);
 
     agent.handleRequest(intentMap);
 });

functions/src/model/business-base.ts

@@ -0,0 +1,10 @@
+import { DataAccessBase } from "../dao/data-access-base";
+
+export abstract class BusinessBase {
+
+    private dataAccessObject: DataAccessBase<BusinessBase>;
+
+    constructor(db: FirebaseFirestore.Firestore){
+        // TODO
+    }
+}

functions/src/model/business-class.ts

@@ -0,0 +1,34 @@
+interface IClass {
+    code: String;
+    type: String;
+    getSchedules(): Schedule[];
+}
+
+export class Class implements IClass {
+
+    constructor(private readonly schedules: Schedule[], readonly code: string, readonly type: string){}
+
+    public getSchedules(): Schedule[]{
+        return this.schedules;
+    }
+}
+
+export class ClassProxy implements IClass {
+    private class: IClass;
+
+    constructor(readonly code: string, readonly type: string){}
+
+    public getSchedules(): Schedule[] {
+        if(!this.class){
+            // let daSchedules = new DataAccessSchedules()
+            // this.class = 
+        }
+
+        return this.class.getSchedules();
+    }
+}
+
+export class Schedule {
+    constructor(readonly weekday: string, readonly start:  string, readonly end: string, readonly teacher: string){}
+}
+