Sprint0 (#25)

* created workshop list and create components and added them eot the navigation

* added the model/api stuff

* issue #14 - added default workshop data to the database

* created a workshop-list service, but it doesnt work

* Updated file to be in correct place

* added skeleton code for workshop service

* created a list function if services/workshops.py so the api lists all of the workshops

* implemented getWorkshops()

* Retrieve workshop data from database and display workshop title and id data on webpage

* Reformat display of workshop list and attributes

* Added comments to explain getWorkshop functions

* Changed getworkshop to getWorkshops and its references

* Adjust workshop initialization & clean up comments in workshop list files

* added description, location, and date to workshops

* added docs to workshop api

* explained args

---------

Co-authored-by: XimenaColopy <[email protected]>
Co-authored-by: Emma Lozevski <[email protected]>
Co-authored-by: Emma Lozevski <[email protected]>
Co-authored-by: Wertops <[email protected]>
Co-authored-by: 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 <[email protected]>

Author: 4 people

backend/api/workshop.py

@@ -0,0 +1,10 @@
+from fastapi import APIRouter, Depends
+from ..models import Workshop
+from ..services.workshop import WorkshopService
+
+api = APIRouter(prefix="/api/workshop")
+
+#returns list of workshop models. It takes in a workshop_service as a dependency
+@api.get("", response_model=list[Workshop], tags=['Workshops'])
+def list_workshops(workshop_svc: WorkshopService = Depends()) -> list[Workshop]:
+    return workshop_svc.list()

backend/entities/__init__.py

@@ -16,6 +16,7 @@
 from .entity_base import EntityBase
 from .user_entity import UserEntity
 from .role_entity import RoleEntity
+from .workshop_entity import WorkshopEntity
 from .permission_entity import PermissionEntity
 from .user_role_entity import user_role_table
 

backend/entities/workshop_entity.py

@@ -0,0 +1,53 @@
+'''User accounts for all registered users in the application.'''
+
+
+from sqlalchemy import Integer, String, DateTime, ForeignKey
+from sqlalchemy.orm import Mapped, mapped_column, relationship
+from typing import Self
+from .entity_base import EntityBase
+from .user_entity import UserEntity
+#from .user_role_entity import user_role_table
+from ..models import Workshop, User
+from datetime import datetime
+
+
+__authors__ = ['Kris Jordan']
+__copyright__ = 'Copyright 2023'
+__license__ = 'MIT'
+
+
+class WorkshopEntity(EntityBase):
+    __tablename__ = 'workshop'
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    title: Mapped[str] = mapped_column(String(64), nullable=False, default='')
+    description: Mapped[str] = mapped_column(String(500), nullable=False, default='')
+    location: Mapped[str] = mapped_column(String(64), nullable=False, default='')
+    date: Mapped[datetime] = mapped_column(DateTime(timezone=True), default=datetime.now)
+    
+    #host: Mapped['UserEntity'] = mapped_column(UserEntity, )
+    host_id: Mapped[int] = mapped_column(ForeignKey('user.id'), nullable=True)
+    #host: Mapped['UserEntity'] = relationship(back_populates='workshop')
+
+    @classmethod
+    def from_model(cls, model: Workshop) -> Self:
+        return cls(
+            id=model.id,
+            title=model.title,  
+            description=model.description,
+            location=model.location,
+            date=model.date,
+            #host_id = model.host_id
+        )
+
+    def to_model(self) -> Workshop:
+        return Workshop(
+            id=self.id,
+            title=self.title,
+            description=self.description,
+            location=self.location,
+            date=self.date,
+            #host_id = model.host_id
+        )
+    
+

backend/main.py

@@ -1,7 +1,7 @@
 """Entrypoint of backend API exposing the FastAPI `app` to be served by an application server such as uvicorn."""
 
 from fastapi import FastAPI
-from .api import health, static_files, profile, authentication, user
+from .api import health, static_files, profile, authentication, user, workshop
 from .api.admin import users as admin_users
 from .api.admin import roles as admin_roles
 
@@ -21,6 +21,7 @@
 )
 
 app.include_router(user.api)
+app.include_router(workshop.api)
 app.include_router(profile.api)
 app.include_router(health.api)
 app.include_router(authentication.api)

backend/models/__init__.py

@@ -5,6 +5,7 @@
 from .user import User, ProfileForm, NewUser
 from .role import Role
 from .role_details import RoleDetails
+from .workshop import Workshop
 
 __authors__ = ["Kris Jordan"]
 __copyright__ = "Copyright 2023"

backend/models/workshop.py

@@ -0,0 +1,21 @@
+"""Workshop is the data object"""
+
+from pydantic import BaseModel
+from . import User
+from datetime import datetime
+
+
+
+__authors__ = ["Kris Jordan"]
+__copyright__ = "Copyright 2023"
+__license__ = "MIT"
+
+
+class Workshop(BaseModel):
+    id: int | None = None
+    title: str
+    description: str | None = "No description provided for this event."
+    location: str | None = "Location TBD"
+    date: datetime | None = None
+    host_id: int | None = None
+    host: User | None = None

backend/script/dev_data/workshops.py

@@ -0,0 +1,23 @@
+"""Sample workshops to use in the development environment.
+
+These were intially designed to be used by the `script.reset_database` module."""
+
+from ...models import Workshop
+from datetime import datetime
+from . import users
+
+
+workshop1 = Workshop(id=1, title="Workshop1", description="this is a sample description for workshop1", location="Sitterson Hall", date=datetime(2023, 4, 5, 12, 0), host_id=users.merritt_manager.id)
+
+workshop2 = Workshop(id=2, title="Workshop2", description="this is a sample description for workshop2", location="Phillips Hall", date=datetime(2023, 4, 10, 3, 0))
+
+workshop3 = Workshop(id=3, title="Workshop3", description="this is a sample description for workshop3", location="Dey Hall", date=datetime(2023, 4, 12, 4, 30))
+
+workshop4 = Workshop(id=4, title="Workshop4", description="this is a sample description for workshop4", location="Peabody Hall", date=datetime(2023, 4, 20, 1, 20))
+
+models = [
+    workshop1, 
+    workshop2,
+    workshop3, 
+    workshop4
+]

backend/script/reset_database.py

@@ -11,7 +11,6 @@
 __copyright__ = "Copyright 2023"
 __license__ = "MIT"
 
-
 if getenv("MODE") != "development":
     print("This script can only be run in development mode.", file=sys.stderr)
     print("Add MODE=development to your .env file in workspace's `backend/` directory")
@@ -60,4 +59,13 @@
         entity.role = session.get(RoleEntity, role.id)
         session.add(entity)
     session.execute(text(f'ALTER SEQUENCE permission_id_seq RESTART WITH {len(permissions.pairs) + 1}'))
-    session.commit()
+    session.commit()
+
+# Add Workshops
+with Session(engine) as session:
+    from .dev_data import workshops
+    to_entity = entities.WorkshopEntity.from_model
+    session.add_all([to_entity(model) for model in workshops.models])
+    session.execute(text(f'ALTER SEQUENCE {entities.WorkshopEntity.__table__}_id_seq RESTART WITH {len(workshops.models) + 1}'))
+    session.commit()
+

backend/services/workshop.py

@@ -0,0 +1,41 @@
+from fastapi import Depends
+from sqlalchemy import select, or_, func
+from sqlalchemy.orm import Session
+from ..database import db_session
+from ..models import Workshop
+from ..entities import WorkshopEntity
+#from . import user
+from ..entities import UserEntity
+#from .permission import PermissionService
+
+#from .permission import PermissionService
+
+
+class WorkshopService:
+
+    _session: Session
+    #_permission: PermissionService
+    #_permission: PermissionService
+
+    def __init__(self, session: Session = Depends(db_session)):
+        self._session = session
+        #self._permission = permission
+
+        #self._permission = permission
+    
+    #def get_host(id: int) -> User:
+    #    query = select(UserEntity).where(WorkshopEntity.id == id)
+    #    user_entity: UserEntity = self._session.scalar(query)
+    #    if user_entity is None:
+    #        return None
+    #    else:
+    #        model = user_entity.to_model()
+    #        model.permissions = self._permission.get_permissions(model)
+    #        return model
+
+
+    def list(self) -> list[Workshop]:
+        query = select(WorkshopEntity)
+        workshop_entities: WorkshopEntity = self._session.execute(query).scalars()
+        return [ workshop_entity.to_model() for workshop_entity in workshop_entities]
+

frontend/src/app/app-routing.module.ts

@@ -4,11 +4,15 @@ import { AppTitleStrategy } from './app-title.strategy';
 import { GateComponent } from './gate/gate.component';
 import { HomeComponent } from './home/home.component';
 import { ProfileEditorComponent } from './profile/profile-editor/profile-editor.component';
+import { WorkshopListComponent } from './workshop-list/workshop-list.component';
+import { WorkshopCreateComponent } from './workshop-create/workshop-create.component';
 
 
 const routes: Routes = [
   HomeComponent.Route,
   ProfileEditorComponent.Route,
+  WorkshopListComponent.Route,
+  WorkshopCreateComponent.Route,
   GateComponent.Route,
   { path: 'admin', title: 'Admin', loadChildren: () => import('./admin/admin.module').then(m => m.AdminModule) },
 ];

frontend/src/app/app.module.ts

@@ -32,7 +32,9 @@ import { NavigationComponent } from './navigation/navigation.component';
 import { ErrorDialogComponent } from './navigation/error-dialog/error-dialog.component';
 import { HomeComponent } from './home/home.component';
 import { GateComponent } from './gate/gate.component';
-import { ProfileEditorComponent } from './profile/profile-editor/profile-editor.component';
+import { ProfileEditorComponent } from './profile/profile-editor/profile-editor.component';
+import { WorkshopListComponent } from './workshop-list/workshop-list.component';
+import { WorkshopCreateComponent } from './workshop-create/workshop-create.component';
 
 @NgModule({
   declarations: [
@@ -41,7 +43,9 @@ import { ProfileEditorComponent } from './profile/profile-editor/profile-editor.
     ErrorDialogComponent,
     HomeComponent,
     GateComponent,
-    ProfileEditorComponent
+    ProfileEditorComponent,
+    WorkshopListComponent,
+    WorkshopCreateComponent
   ],
   imports: [
     BrowserModule,

frontend/src/app/navigation/navigation.component.html

@@ -13,6 +13,8 @@
           <a mat-list-item *ngIf="adminPermission$ | async" routerLink="/admin">Admin</a>
           <mat-divider></mat-divider>
           <a mat-list-item routerLink="/profile">Profile</a>
+          <a mat-list-item routerLink="/workshop-list">View Workshops</a>
+          <a mat-list-item routerLink="/workshop-create">Create Workshops</a>
           <a mat-list-item (click)="auth.signOut()">Sign out</a>
         </ng-template>
       </mat-nav-list>

frontend/src/app/workshop-create/workshop-create.component.css

@@ -0,0 +1 @@
+<p>workshop-create works!</p>

frontend/src/app/workshop-create/workshop-create.component.html

@@ -0,0 +1,23 @@
+import { ComponentFixture, TestBed } from '@angular/core/testing';
+
+import { WorkshopCreateComponent } from './workshop-create.component';
+
+describe('WorkshopCreateComponent', () => {
+  let component: WorkshopCreateComponent;
+  let fixture: ComponentFixture<WorkshopCreateComponent>;
+
+  beforeEach(async () => {
+    await TestBed.configureTestingModule({
+      declarations: [ WorkshopCreateComponent ]
+    })
+    .compileComponents();
+
+    fixture = TestBed.createComponent(WorkshopCreateComponent);
+    component = fixture.componentInstance;
+    fixture.detectChanges();
+  });
+
+  it('should create', () => {
+    expect(component).toBeTruthy();
+  });
+});

frontend/src/app/workshop-create/workshop-create.component.spec.ts

@@ -0,0 +1,20 @@
+import { Component } from '@angular/core';
+import { isAuthenticated } from 'src/app/gate/gate.guard';
+import { ActivatedRoute, Route } from '@angular/router';
+
+
+@Component({
+  selector: 'app-workshop-create',
+  templateUrl: './workshop-create.component.html',
+  styleUrls: ['./workshop-create.component.css']
+})
+export class WorkshopCreateComponent {
+  public static Route: Route = {
+    path: 'workshop-create',
+    component: WorkshopCreateComponent, 
+    title: 'Create Workshop', 
+    canActivate: [isAuthenticated], 
+    //resolve: { profile: profileResolver }
+  };
+
+}

frontend/src/app/workshop-create/workshop-create.component.ts

@@ -0,0 +1,16 @@
+import { TestBed } from '@angular/core/testing';
+
+import { WorkshopListService } from './workshop-list.service';
+
+describe('WorkshopListService', () => {
+  let service: WorkshopListService;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({});
+    service = TestBed.inject(WorkshopListService);
+  });
+
+  it('should be created', () => {
+    expect(service).toBeTruthy();
+  });
+});

frontend/src/app/workshop-list.service.spec.ts

@@ -0,0 +1,40 @@
+import { Injectable } from '@angular/core';
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+
+export interface Workshop {
+  id: number;
+  title: String;
+  description: String | null;
+  location: String | null;
+  // date: datetime | null;
+  // host: User | null;
+}
+
+@Injectable({
+  providedIn: 'root'
+})
+
+export class WorkshopListService {
+
+
+  constructor(protected http: HttpClient) { 
+    
+  }
+
+  getWorkshops(): Observable<Workshop[]>{
+      /* Returns a obersvable list of workshops currently in the database.
+
+      Args:
+        None.
+      
+      Returns:
+        Observable list of workshops.
+
+      Raises:
+        None.
+      */
+    return this.http.get<Workshop[]>("/api/workshop");
+  }
+
+}

frontend/src/app/workshop-list.service.ts

@@ -0,0 +1,22 @@
+<mat-card>
+    <mat-card-header>
+        <mat-card-title>
+            <h1>Workshops</h1>
+        </mat-card-title>
+    </mat-card-header>
+
+    <mat-list>
+        <mat-card *ngFor="let workshop of workshops$ | async" style="background-color: #555555;">
+            <mat-card-header>
+                <mat-card-title>{{workshop.title}}</mat-card-title>
+                <mat-card-subtitle>{{workshop.location}}</mat-card-subtitle>
+            </mat-card-header>
+
+            <p></p>
+
+            <mat-card-content>
+                {{workshop.description}}
+            </mat-card-content>
+        </mat-card>
+    </mat-list>
+</mat-card>