Merge branch 'feature/65-donor_controllers' of git.odit.services:lfk/backend into feature/65-donor_controllers

ref #65

.drone.yml

@@ -37,11 +37,23 @@ steps:
       tags:
         - dev
       registry: registry.odit.services
-    when:
-      branch:
-        - dev
-      event:
-        - push
+  - name: run full license export
+    depends_on: ["clone"]
+    image: node:alpine
+    commands:
+      - yarn
+      - yarn licenses:export
+  - name: push new licenses file to repo
+    depends_on: ["run full license export"]
+    image: appleboy/drone-git-push
+    settings:
+      branch: dev
+      commit: true
+      commit_message: new license file version [CI SKIP]
+      author_email: bot@odit.services
+      remote: git@git.odit.services:lfk/backend.git
+      ssh_key:
+        from_secret: GITLAB_SSHKEY
 
 trigger:
   branch:

.gitignore

@@ -133,4 +133,5 @@ build
 *.sqlite
 *.sqlite-jurnal
 /docs
-lib
+lib
+/oss-attribution

package.json

@@ -48,6 +48,7 @@
     "validator": "^13.5.2"
   },
   "devDependencies": {
+    "@odit/license-exporter": "^0.0.6",
     "@types/cors": "^2.8.8",
     "@types/csvtojson": "^1.1.5",
     "@types/express": "^4.17.9",
@@ -74,7 +75,8 @@
     "test:watch": "jest --watchAll",
     "test:ci": "start-server-and-test dev http://localhost:4010/api/docs/openapi.json test",
     "seed": "ts-node ./node_modules/typeorm/cli.js schema:sync && ts-node ./node_modules/typeorm-seeding/dist/cli.js seed",
-    "openapi:export": "ts-node src/openapi_export.ts"
+    "openapi:export": "node scripts/openapi_export.js",
+    "licenses:export": "license-exporter --md"
   },
   "nodemonConfig": {
     "ignore": [

scripts/openapi_export.ts

@@ -4,9 +4,9 @@ import fs from "fs";
 import "reflect-metadata";
 import { createExpressServer, getMetadataArgsStorage } from "routing-controllers";
 import { routingControllersToSpec } from 'routing-controllers-openapi';
-import { config } from './config';
-import authchecker from "./middlewares/authchecker";
-import { ErrorHandler } from './middlewares/ErrorHandler';
+import { config } from '../src/config';
+import authchecker from "../src/middlewares/authchecker";
+import { ErrorHandler } from '../src/middlewares/ErrorHandler';
 
 const CONTROLLERS_FILE_EXTENSION = process.env.NODE_ENV === 'production' ? 'js' : 'ts';
 createExpressServer({

src/controllers/DonorController.ts

@@ -0,0 +1,105 @@
+import { Authorized, Body, Delete, Get, JsonController, OnUndefined, Param, Post, Put, QueryParam } from 'routing-controllers';
+import { OpenAPI, ResponseSchema } from 'routing-controllers-openapi';
+import { getConnectionManager, Repository } from 'typeorm';
+import { DonorIdsNotMatchingError, DonorNotFoundError } from '../errors/DonorErrors';
+import { CreateDonor } from '../models/actions/CreateDonor';
+import { UpdateDonor } from '../models/actions/UpdateDonor';
+import { Donor } from '../models/entities/Donor';
+import { ResponseDonor } from '../models/responses/ResponseDonor';
+import { ResponseEmpty } from '../models/responses/ResponseEmpty';
+
+@JsonController('/donors')
+@OpenAPI({ security: [{ "AuthToken": [] }, { "RefreshTokenCookie": [] }] })
+export class DonorController {
+	private donorRepository: Repository<Donor>;
+
+	/**
+	 * Gets the repository of this controller's model/entity.
+	 */
+	constructor() {
+		this.donorRepository = getConnectionManager().get().getRepository(Donor);
+	}
+
+	@Get()
+	@Authorized("DONOR:GET")
+	@ResponseSchema(ResponseDonor, { isArray: true })
+	@OpenAPI({ description: 'Lists all runners from all teams/orgs. <br> This includes the runner\'s group and distance ran.' })
+	async getAll() {
+		let responseDonors: ResponseDonor[] = new Array<ResponseDonor>();
+		const donors = await this.donorRepository.find();
+		donors.forEach(donor => {
+			responseDonors.push(new ResponseDonor(donor));
+		});
+		return responseDonors;
+	}
+
+	@Get('/:id')
+	@Authorized("DONOR:GET")
+	@ResponseSchema(ResponseDonor)
+	@ResponseSchema(DonorNotFoundError, { statusCode: 404 })
+	@OnUndefined(DonorNotFoundError)
+	@OpenAPI({ description: 'Lists all information about the runner whose id got provided.' })
+	async getOne(@Param('id') id: number) {
+		let donor = await this.donorRepository.findOne({ id: id })
+		if (!donor) { throw new DonorNotFoundError(); }
+		return new ResponseDonor(donor);
+	}
+
+	@Post()
+	@Authorized("DONOR:CREATE")
+	@ResponseSchema(ResponseDonor)
+	@OpenAPI({ description: 'Create a new runner. <br> Please remeber to provide the runner\'s group\'s id.' })
+	async post(@Body({ validate: true }) createRunner: CreateDonor) {
+		let donor;
+		try {
+			donor = await createRunner.toDonor();
+		} catch (error) {
+			throw error;
+		}
+
+		donor = await this.donorRepository.save(donor)
+		return new ResponseDonor(await this.donorRepository.findOne(donor));
+	}
+
+	@Put('/:id')
+	@Authorized("DONOR:UPDATE")
+	@ResponseSchema(ResponseDonor)
+	@ResponseSchema(DonorNotFoundError, { statusCode: 404 })
+	@ResponseSchema(DonorIdsNotMatchingError, { statusCode: 406 })
+	@OpenAPI({ description: "Update the runner whose id you provided. <br> Please remember that ids can't be changed." })
+	async put(@Param('id') id: number, @Body({ validate: true }) donor: UpdateDonor) {
+		let oldDonor = await this.donorRepository.findOne({ id: id });
+
+		if (!oldDonor) {
+			throw new DonorNotFoundError();
+		}
+
+		if (oldDonor.id != donor.id) {
+			throw new DonorIdsNotMatchingError();
+		}
+
+		await this.donorRepository.save(await donor.updateDonor(oldDonor));
+		return new ResponseDonor(await this.donorRepository.findOne({ id: id }));
+	}
+
+	@Delete('/:id')
+	@Authorized("DONOR:DELETE")
+	@ResponseSchema(ResponseDonor)
+	@ResponseSchema(ResponseEmpty, { statusCode: 204 })
+	@OnUndefined(204)
+	@OpenAPI({ description: 'Delete the runner whose id you provided. <br> If no runner with this id exists it will just return 204(no content).' })
+	async remove(@Param("id") id: number, @QueryParam("force") force: boolean) {
+		let donor = await this.donorRepository.findOne({ id: id });
+		if (!donor) { return null; }
+		const responseDonor = await this.donorRepository.findOne(donor);
+
+		if (!donor) {
+			throw new DonorNotFoundError();
+		}
+
+		//TODO: DELETE DONATIONS AND WARN FOR FORCE (https://git.odit.services/lfk/backend/issues/66)
+
+		await this.donorRepository.delete(donor);
+		return new ResponseDonor(responseDonor);
+	}
+}

src/errors/DonorErrors.ts

@@ -0,0 +1,25 @@
+import { IsString } from 'class-validator';
+import { NotAcceptableError, NotFoundError } from 'routing-controllers';
+
+/**
+ * Error to throw when a donor couldn't be found.
+ */
+export class DonorNotFoundError extends NotFoundError {
+	@IsString()
+	name = "DonorNotFoundError"
+
+	@IsString()
+	message = "Donor not found!"
+}
+
+/**
+ * Error to throw when two donors' ids don't match.
+ * Usually occurs when a user tries to change a donor's id.
+ */
+export class DonorIdsNotMatchingError extends NotAcceptableError {
+	@IsString()
+	name = "DonorIdsNotMatchingError"
+
+	@IsString()
+	message = "The ids don't match! \n And if you wanted to change a donor's id: This isn't allowed!"
+}

src/models/actions/CreateDonor.ts

@@ -0,0 +1,33 @@
+import { IsBoolean, IsOptional } from 'class-validator';
+import { Donor } from '../entities/Donor';
+import { CreateParticipant } from './CreateParticipant';
+
+/**
+ * This classed is used to create a new Donor entity from a json body (post request).
+ */
+export class CreateDonor extends CreateParticipant {
+
+    /**
+     * Does this donor need a receipt?
+     */
+    @IsBoolean()
+    @IsOptional()
+    receiptNeeded?: boolean = false;
+
+    /**
+     * Creates a new Donor entity from this.
+     */
+    public async toDonor(): Promise<Donor> {
+        let newDonor: Donor = new Donor();
+
+        newDonor.firstname = this.firstname;
+        newDonor.middlename = this.middlename;
+        newDonor.lastname = this.lastname;
+        newDonor.phone = this.phone;
+        newDonor.email = this.email;
+        newDonor.receiptNeeded = this.receiptNeeded;
+        newDonor.address = await this.getAddress();
+
+        return newDonor;
+    }
+}

src/models/actions/CreateRunnerOrganisation.ts

@@ -41,7 +41,7 @@ export class CreateRunnerOrganisation extends CreateRunnerGroup {
 
         newRunnerOrganisation.name = this.name;
         newRunnerOrganisation.contact = await this.getContact();
-        newRunnerOrganisation.address = await this.getAddress();
+        // newRunnerOrganisation.address = await this.getAddress();
 
         return newRunnerOrganisation;
     }

src/models/actions/UpdateDonor.ts

@@ -0,0 +1,39 @@
+import { IsBoolean, IsInt, IsOptional } from 'class-validator';
+import { Donor } from '../entities/Donor';
+import { CreateParticipant } from './CreateParticipant';
+
+/**
+ * This class is used to update a Donor entity (via put request).
+ */
+export class UpdateDonor extends CreateParticipant {
+
+    /**
+     * The updated donor's id.
+     * This shouldn't have changed but it is here in case anyone ever wants to enable id changes (whyever they would want to).
+     */
+    @IsInt()
+    id: number;
+
+    /**
+     * Does the updated donor need a receipt?
+     */
+    @IsBoolean()
+    @IsOptional()
+    receiptNeeded?: boolean;
+
+
+    /**
+     * Updates a provided Donor entity based on this.
+     */
+    public async updateDonor(donor: Donor): Promise<Donor> {
+        donor.firstname = this.firstname;
+        donor.middlename = this.middlename;
+        donor.lastname = this.lastname;
+        donor.phone = this.phone;
+        donor.email = this.email;
+        donor.receiptNeeded = this.receiptNeeded;
+        donor.address = await this.getAddress();
+
+        return donor;
+    }
+}

src/models/actions/UpdateRunnerOrganisation.ts

@@ -45,7 +45,7 @@ export class UpdateRunnerOrganisation extends CreateRunnerGroup {
 
         organisation.name = this.name;
         organisation.contact = await this.getContact();
-        organisation.address = await this.getAddress();
+        // organisation.address = await this.getAddress();
 
         return organisation;
     }

src/models/entities/Address.ts

@@ -8,7 +8,6 @@ import {
 import { Column, Entity, OneToMany, PrimaryGeneratedColumn } from "typeorm";
 import { config } from '../../config';
 import { Participant } from "./Participant";
-import { RunnerOrganisation } from "./RunnerOrganisation";
 
 /**
  * Defines the Address entity.
@@ -82,9 +81,9 @@ export class Address {
   @OneToMany(() => Participant, participant => participant.address, { nullable: true })
   participants: Participant[];
 
-  /**
-   * Used to link the address to runner groups.
-   */
-  @OneToMany(() => RunnerOrganisation, group => group.address, { nullable: true })
-  groups: RunnerOrganisation[];
+  // /**
+  //  * Used to link the address to runner groups.
+  //  */
+  // @OneToMany(() => RunnerOrganisation, group => group.address, { nullable: true })
+  // groups: RunnerOrganisation[];
 }

src/models/entities/Donation.ts

@@ -3,7 +3,7 @@ import {
   IsNotEmpty
 } from "class-validator";
 import { Entity, ManyToOne, PrimaryGeneratedColumn, TableInheritance } from "typeorm";
-import { Participant } from "./Participant";
+import { Donor } from './Donor';
 
 /**
  * Defines the Donation entity.
@@ -24,8 +24,8 @@ export abstract class Donation {
    * The donations's donor.
    */
   @IsNotEmpty()
-  @ManyToOne(() => Participant, donor => donor.donations)
-  donor: Participant;
+  @ManyToOne(() => Donor, donor => donor.donations)
+  donor: Donor;
 
   /**
    * The donation's amount in cents (or whatever your currency's smallest unit is.).

src/models/entities/Donor.ts

@@ -1,5 +1,6 @@
 import { IsBoolean } from "class-validator";
-import { ChildEntity, Column } from "typeorm";
+import { ChildEntity, Column, OneToMany } from "typeorm";
+import { Donation } from './Donation';
 import { Participant } from "./Participant";
 
 /**
@@ -14,4 +15,11 @@ export class Donor extends Participant {
   @Column()
   @IsBoolean()
   receiptNeeded: boolean = false;
+
+  /**
+ * Used to link the participant as the donor of a donation.
+ * Attention: Only runner's can be associated as a distanceDonations distance source.
+ */
+  @OneToMany(() => Donation, donation => donation.donor, { nullable: true })
+  donations: Donation[];
 }

src/models/entities/Participant.ts

@@ -7,10 +7,9 @@ import {
 
   IsString
 } from "class-validator";
-import { Column, Entity, ManyToOne, OneToMany, PrimaryGeneratedColumn, TableInheritance } from "typeorm";
+import { Column, Entity, ManyToOne, PrimaryGeneratedColumn, TableInheritance } from "typeorm";
 import { config } from '../../config';
 import { Address } from "./Address";
-import { Donation } from "./Donation";
 
 /**
  * Defines the Participant entity.
@@ -74,11 +73,4 @@ export abstract class Participant {
   @IsOptional()
   @IsEmail()
   email?: string;
-
-  /**
-   * Used to link the participant as the donor of a donation.
-   * Attention: Only runner's can be associated as a distanceDonations distance source.
-   */
-  @OneToMany(() => Donation, donation => donation.donor, { nullable: true })
-  donations: Donation[];
 }

src/models/entities/Runner.ts

@@ -18,7 +18,7 @@ export class Runner extends Participant {
    * Can be a runner team or organisation.
    */
   @IsNotEmpty()
-  @ManyToOne(() => RunnerGroup, group => group.runners, { nullable: false })
+  @ManyToOne(() => RunnerGroup, group => group.runners)
   group: RunnerGroup;
 
   /**

src/models/entities/RunnerOrganisation.ts

@@ -1,6 +1,5 @@
-import { IsInt, IsOptional } from "class-validator";
-import { ChildEntity, ManyToOne, OneToMany } from "typeorm";
-import { Address } from "./Address";
+import { IsInt } from "class-validator";
+import { ChildEntity, OneToMany } from "typeorm";
 import { Runner } from './Runner';
 import { RunnerGroup } from "./RunnerGroup";
 import { RunnerTeam } from "./RunnerTeam";
@@ -12,12 +11,12 @@ import { RunnerTeam } from "./RunnerTeam";
 @ChildEntity()
 export class RunnerOrganisation extends RunnerGroup {
 
-  /**
-   * The organisations's address.
-   */
-  @IsOptional()
-  @ManyToOne(() => Address, address => address.groups, { nullable: true })
-  address?: Address;
+  // /**
+  //  * The organisations's address.
+  //  */
+  // @IsOptional()
+  // @ManyToOne(() => Address, address => address.groups, { nullable: true })
+  // address?: Address;
 
   /**
    * The organisation's teams.

src/models/enums/PermissionTargets.ts

@@ -9,5 +9,6 @@ export enum PermissionTarget {
     USER = 'USER',
     USERGROUP = 'USERGROUP',
     PERMISSION = 'PERMISSION',
-    STATSCLIENT = 'STATSCLIENT'
+    STATSCLIENT = 'STATSCLIENT',
+    DONOR = 'DONOR'
 }

src/models/responses/ResponseDonor.ts

@@ -0,0 +1,26 @@
+import {
+    IsBoolean
+} from "class-validator";
+import { Donor } from '../entities/Donor';
+import { ResponseParticipant } from './ResponseParticipant';
+
+/**
+ * Defines the donor response.
+*/
+export class ResponseDonor extends ResponseParticipant {
+
+    /**
+     * Does this donor need a receipt?
+     */
+    @IsBoolean()
+    receiptNeeded: boolean;
+
+    /**
+     * Creates a ResponseRunner object from a runner.
+     * @param runner The user the response shall be build for.
+     */
+    public constructor(donor: Donor) {
+        super(donor);
+        this.receiptNeeded = donor.receiptNeeded;
+    }
+}

src/models/responses/ResponseRunnerOrganisation.ts

@@ -32,7 +32,7 @@ export class ResponseRunnerOrganisation extends ResponseRunnerGroup {
      */
     public constructor(org: RunnerOrganisation) {
         super(org);
-        this.address = org.address;
+        // this.address = org.address;
         this.teams = org.teams;
     }
 }