Rate Projects

.gitignore

@@ -1,3 +1,4 @@
+package-lock.json
 node_modules/
 dist/
 coverage/

README.md

@@ -7,6 +7,8 @@
 
 Yet another hackathon registration system.
 
+[Docker Development quickstart.md](quickstart.md)
+
 ## Motivation
 
 Like many other hackathons, we previously used [Quill](https://github.com/techx/quill) for our application process, which worked really well for us in the past. Especially Quill's process was a blessing: an application consists of two steps, the profile creation and, once an attendee was admitted to the event, the spot confirmation. We attended different events that used different processes and found this to be easy for both the attendees and organizers.

backend/src/controllers/criterion-controller.ts

@@ -0,0 +1,84 @@
+import {
+  Authorized,
+  Delete,
+  Get,
+  JsonController,
+  Param,
+  Put,
+  Post,
+  Body,
+} from "routing-controllers";
+import { Inject } from "typedi";
+import { UserRole } from "../entities/user-role";
+import {
+  CriterionServiceToken,
+  ICriterionService,
+} from "../services/criterion-service";
+import {
+  CriterionDTO,
+  SuccessResponseDTO,
+  convertBetweenEntityAndDTO,
+} from "./dto";
+import { Criterion } from "../entities/criterion";
+
+@JsonController("/criteria")
+export class CriterionController {
+  public constructor(
+    @Inject(CriterionServiceToken)
+    private readonly _criterion: ICriterionService,
+  ) {}
+
+  /**
+   * Get all criteria.
+   */
+  @Get("/")
+  @Authorized(UserRole.User)
+  public async getAllCriteria(): Promise<CriterionDTO[]> {
+    const criteria = await this._criterion.getAllCriteria();
+    return criteria.map((c) => convertBetweenEntityAndDTO(c, CriterionDTO));
+  }
+
+  /**
+   * Create a criterion.
+   */
+  @Post("/")
+  @Authorized(UserRole.Root)
+  public async createCriterion(
+    @Body() { data: criterionDTO }: { data: CriterionDTO },
+  ): Promise<CriterionDTO> {
+    const criterion = convertBetweenEntityAndDTO(criterionDTO, Criterion);
+    const createdCriterion = await this._criterion.createCriterion(criterion);
+    return convertBetweenEntityAndDTO(createdCriterion, CriterionDTO);
+  }
+
+  /**
+   * Update criteria.
+   */
+  @Put("/:id")
+  @Authorized(UserRole.Root)
+  public async updateCriterion(
+    @Param("id") criterionId: number,
+    @Body() { data: criterionDTO }: { data: CriterionDTO },
+  ): Promise<CriterionDTO> {
+    const criterion = convertBetweenEntityAndDTO(
+      { ...criterionDTO, id: criterionId },
+      Criterion,
+    );
+    const updateCriterion = await this._criterion.updateCriterion(criterion);
+    return convertBetweenEntityAndDTO(updateCriterion, CriterionDTO);
+  }
+
+  /**
+   * Delete criteria.
+   */
+  @Delete("/:id")
+  @Authorized(UserRole.Root)
+  public async deleteCriterion(
+    @Param("id") criterionId: number,
+  ): Promise<SuccessResponseDTO> {
+    await this._criterion.deleteCriterionByID(criterionId);
+    const response = new SuccessResponseDTO();
+    response.success = true;
+    return response;
+  }
+}

backend/src/controllers/dto.ts

@@ -10,7 +10,9 @@ import {
   IsOptional,
   IsString,
   IsUrl,
+  Max,
   MaxLength,
+  Min,
   MinLength,
   ValidateNested,
 } from "class-validator";
@@ -89,6 +91,9 @@ export class ApplicationSettingsDTO implements DTO<ApplicationSettings> {
   @IsNumber()
   @Expose()
   public hoursToConfirm!: number;
+  @IsBoolean()
+  @Expose()
+  public allowRatingProjects!: boolean;
 }
 
 export class FrontendSettingsDTO implements DTO<FrontendSettings> {
@@ -561,3 +566,84 @@ export class TeamUpdateDTO {
   @Expose()
   public description!: string;
 }
+
+export class CriterionDTO {
+  @Expose()
+  public readonly id!: number;
+  @Expose()
+  public title!: string;
+  @Expose()
+  public description!: string;
+}
+
+export class ProjectDTO {
+  @Expose()
+  public readonly id!: number;
+  @Expose()
+  @Type(() => TeamDTO)
+  @ValidateNested()
+  public team!: TeamDTO;
+  @Expose()
+  public title!: string;
+  @Expose()
+  public description!: string;
+  @Expose()
+  public allowRating!: boolean;
+  @Expose()
+  public image!: string;
+}
+
+export class ProjectUpdateDTO {
+  @Expose()
+  public readonly id!: number;
+  @Expose()
+  public title!: string;
+  @Expose()
+  public description!: string;
+  @Expose()
+  public allowRating!: boolean;
+  @Expose()
+  public image!: string;
+}
+
+export class RatingDTO {
+  @Expose()
+  public readonly id!: number;
+  @Expose()
+  @Type(() => UserDTO)
+  @ValidateNested()
+  public user!: UserDTO;
+  @Expose()
+  @Type(() => ProjectDTO)
+  @ValidateNested()
+  public project!: ProjectDTO;
+  @Expose()
+  @Type(() => CriterionDTO)
+  @ValidateNested()
+  public criterion!: CriterionDTO;
+  @Expose()
+  @IsInt()
+  @Min(1)
+  @Max(5)
+  public rating!: number;
+}
+
+class CriterionAvgDTO {
+  @Expose()
+  @Type(() => CriterionDTO)
+  public criterion!: CriterionDTO;
+  @Expose()
+  public average!: number;
+}
+
+// Do not send all ratings to the client,
+// because peoples opinion on the projects should be anonymous
+export class ProjectRatingResultDTO {
+  @Expose()
+  @Type(() => ProjectDTO)
+  public project!: ProjectDTO;
+  @IsArray()
+  @Type(() => CriterionAvgDTO)
+  @Expose()
+  public averagesPerCriterion!: CriterionAvgDTO[];
+}

backend/src/controllers/projects-controller.ts

@@ -0,0 +1,86 @@
+import {
+  Authorized,
+  Get,
+  JsonController,
+  NotFoundError,
+  Put,
+  Param,
+  Body,
+  CurrentUser,
+} from "routing-controllers";
+import { Inject } from "typedi";
+import { UserRole } from "../entities/user-role";
+import {
+  IProjectService,
+  ProjectServiceToken,
+} from "../services/project-service";
+import {
+  ProjectDTO,
+  ProjectUpdateDTO,
+  convertBetweenEntityAndDTO,
+} from "./dto";
+import { Project } from "../entities/project";
+import { User } from "../entities/user";
+
+@JsonController("/projects")
+export class ProjectsController {
+  public constructor(
+    @Inject(ProjectServiceToken) private readonly _projects: IProjectService,
+  ) {}
+
+  /**
+   * Get all projects.
+   */
+  @Get("/")
+  @Authorized(UserRole.User)
+  public async getAllProjects(
+    @CurrentUser() user: User,
+  ): Promise<ProjectDTO[]> {
+    const projects = await this._projects.getAllProjects(user);
+    return projects.map((p) => convertBetweenEntityAndDTO(p, ProjectDTO));
+  }
+
+  /**
+   * Get project by id.
+   * @param id The id of the project
+   */
+  @Get("/:id")
+  @Authorized(UserRole.User)
+  public async getProjectByID(@Param("id") id: number): Promise<ProjectDTO> {
+    const project = await this._projects.getProjectByID(id);
+
+    if (project == null) {
+      throw new NotFoundError(`no project with id ${id}`);
+    }
+
+    return convertBetweenEntityAndDTO(project, ProjectDTO);
+  }
+
+  /**
+   * Update a project (mvp: create one project per team)
+   */
+  @Put("/:id")
+  @Authorized(UserRole.User)
+  public async updateProject(
+    @Param("id") projectId: number,
+    @Body() { data: projectDTO }: { data: ProjectUpdateDTO },
+    @CurrentUser() user: User,
+  ): Promise<ProjectDTO> {
+    const existing = await this._projects.getProjectByID(projectId);
+
+    if (existing == null) {
+      throw new NotFoundError();
+    }
+
+    const project = convertBetweenEntityAndDTO(
+      {
+        ...projectDTO,
+        id: projectId,
+      },
+      Project,
+    );
+
+    const updatedProject = await this._projects.updateProject(project, user);
+    return convertBetweenEntityAndDTO(updatedProject, ProjectDTO);
+  }
+}

backend/src/controllers/rating-controller.ts

@@ -0,0 +1,73 @@
+import {
+  Authorized,
+  JsonController,
+  CurrentUser,
+  Get,
+  Post,
+  Body,
+  Param,
+} from "routing-controllers";
+import { Inject } from "typedi";
+import { UserRole } from "../entities/user-role";
+import { RatingServiceToken, IRatingService } from "../services/rating-service";
+import {
+  RatingDTO,
+  ProjectRatingResultDTO,
+  convertBetweenEntityAndDTO,
+} from "./dto";
+import { User } from "../entities/user";
+import { Rating } from "../entities/rating";
+
+@JsonController("/ratings")
+export class RatingController {
+  public constructor(
+    @Inject(RatingServiceToken) private readonly _ratings: IRatingService,
+  ) {}
+
+  /**
+   * Get aggregated rating results grouped by project and criteria.
+   */
+  @Get("/by-project/:id")
+  @Authorized(UserRole.User)
+  public async getUsersRatingsForProject(
+    @Param("id") projectId: number,
+    @CurrentUser() user: User,
+  ): Promise<RatingDTO[]> {
+    const results = await this._ratings.getUsersRatingsForProject(
+      projectId,
+      user,
+    );
+    return results.map((r) => convertBetweenEntityAndDTO(r, RatingDTO));
+  }
+
+  /**
+   * Get aggregated rating results grouped by project and criteria.
+   */
+  @Get("/results")
+  @Authorized(UserRole.Root)
+  public async getRatingResults(): Promise<ProjectRatingResultDTO[]> {
+    const results = await this._ratings.getRatingResults();
+    return results.map((r) =>
+      convertBetweenEntityAndDTO(r, ProjectRatingResultDTO),
+    );
+  }
+
+  /**
+   * Rate a project
+   */
+  @Post("/rate")
+  @Authorized(UserRole.User)
+  public async rate(
+    @Body() { data: ratingDTO }: { data: RatingDTO },
+    @CurrentUser() user: User,
+  ): Promise<RatingDTO> {
+    const rating = convertBetweenEntityAndDTO(ratingDTO, Rating);
+
+    // Ensure ratings cannot be cast for other users,
+    // write the requesting user into it.
+    rating.user = user;
+
+    const createdRating = await this._ratings.upsertRating(rating, user);
+    return convertBetweenEntityAndDTO(createdRating, RatingDTO);
+  }
+}

backend/src/entities/application-settings.ts

@@ -8,6 +8,9 @@ import {
 } from "typeorm";
 import { FormSettings } from "./form-settings";
 
+// TODO all other settings are part of the settings table, whereas ApplicationSettings
+//  is a separate table. Move into settings table just like EmailSettings.
+
 @Entity()
 export class ApplicationSettings {
   @PrimaryGeneratedColumn()
@@ -26,4 +29,6 @@ export class ApplicationSettings {
   public allowProfileFormUntil!: Date;
   @Column()
   public hoursToConfirm!: number;
+  @Column({ default: false })
+  public allowRatingProjects!: boolean;
 }

backend/src/entities/criterion.ts

@@ -0,0 +1,12 @@
+import { Column, Entity, PrimaryGeneratedColumn } from "typeorm";
+import { Longtext } from "./longtext";
+
+@Entity()
+export class Criterion {
+  @PrimaryGeneratedColumn()
+  public readonly id!: number;
+  @Column({ length: 1024 })
+  public title!: string;
+  @Longtext()
+  public description!: string;
+}