Merge branch 'dev' into feature/93-user_endpoints

src/models/actions/create/CreateDistanceDonation.ts

@@ -0,0 +1,52 @@
+import { IsInt, IsPositive } from 'class-validator';
+import { getConnection } from 'typeorm';
+import { RunnerNotFoundError } from '../../../errors/RunnerErrors';
+import { DistanceDonation } from '../../entities/DistanceDonation';
+import { Runner } from '../../entities/Runner';
+import { CreateDonation } from './CreateDonation';
+
+/**
+ * This class is used to create a new FixedDonation entity from a json body (post request).
+ */
+export class CreateDistanceDonation extends CreateDonation {
+
+    /**
+     * The donation's associated runner.
+     * This is important to link the runner's distance ran to the donation.
+     */
+    @IsInt()
+    @IsPositive()
+    runner: number;
+
+    /**
+     * The donation's amount per distance (full kilometer aka 1000 meters).
+     * The unit is your currency's smallest unit (default: euro cent).
+     */
+    @IsInt()
+    @IsPositive()
+    amountPerDistance: number;
+
+    /**
+     * Creates a new FixedDonation entity from this.
+     */
+    public async toEntity(): Promise<DistanceDonation> {
+        let newDonation = new DistanceDonation;
+
+        newDonation.amountPerDistance = this.amountPerDistance;
+        newDonation.donor = await this.getDonor();
+        newDonation.runner = await this.getRunner();
+
+        return newDonation;
+    }
+
+    /**
+     * Gets a runner based on the runner id provided via this.runner.
+     */
+    public async getRunner(): Promise<Runner> {
+        const runner = await getConnection().getRepository(Runner).findOne({ id: this.runner });
+        if (!runner) {
+            throw new RunnerNotFoundError();
+        }
+        return runner;
+    }
+}

src/models/actions/create/CreateDonation.ts

@@ -0,0 +1,34 @@
+import { IsInt, IsPositive } from 'class-validator';
+import { getConnection } from 'typeorm';
+import { DonorNotFoundError } from '../../../errors/DonorErrors';
+import { Donation } from '../../entities/Donation';
+import { Donor } from '../../entities/Donor';
+
+/**
+ * This class is used to create a new Donation entity from a json body (post request).
+ */
+export abstract class CreateDonation {
+    /**
+     * The donation's associated donor.
+     * This is important to link donations to donors.
+     */
+    @IsInt()
+    @IsPositive()
+    donor: number;
+
+    /**
+     * Creates a new Donation entity from this.
+     */
+    public abstract toEntity(): Promise<Donation>;
+
+    /**
+     * Gets a donor based on the donor id provided via this.donor.
+     */
+    public async getDonor(): Promise<Donor> {
+        const donor = await getConnection().getRepository(Donor).findOne({ id: this.donor });
+        if (!donor) {
+            throw new DonorNotFoundError();
+        }
+        return donor;
+    }
+}

src/models/actions/create/CreateFixedDonation.ts

@@ -0,0 +1,28 @@
+import { IsInt, IsPositive } from 'class-validator';
+import { FixedDonation } from '../../entities/FixedDonation';
+import { CreateDonation } from './CreateDonation';
+
+/**
+ * This class is used to create a new FixedDonation entity from a json body (post request).
+ */
+export class CreateFixedDonation extends CreateDonation {
+    /**
+     * The donation's amount.
+     * The unit is your currency's smallest unit (default: euro cent).
+     */
+    @IsInt()
+    @IsPositive()
+    amount: number;
+
+    /**
+     * Creates a new FixedDonation entity from this.
+     */
+    public async toEntity(): Promise<FixedDonation> {
+        let newDonation = new FixedDonation;
+
+        newDonation.amount = this.amount;
+        newDonation.donor = await this.getDonor();
+
+        return newDonation;
+    }
+}

src/models/actions/update/UpdateDistanceDonation.ts

@@ -0,0 +1,51 @@
+import { IsInt, IsPositive } from 'class-validator';
+import { getConnection } from 'typeorm';
+import { RunnerNotFoundError } from '../../../errors/RunnerErrors';
+import { DistanceDonation } from '../../entities/DistanceDonation';
+import { Runner } from '../../entities/Runner';
+import { UpdateDonation } from './UpdateDonation';
+
+/**
+ * This class is used to update a DistanceDonation entity (via put request).
+ */
+export class UpdateDistanceDonation extends UpdateDonation {
+
+    /**
+     * The donation's associated runner.
+     * This is important to link the runner's distance ran to the donation.
+     */
+    @IsInt()
+    @IsPositive()
+    runner: number;
+
+    /**
+     * The donation's amount per distance (full kilometer aka 1000 meters).
+     * The unit is your currency's smallest unit (default: euro cent).
+     */
+    @IsInt()
+    @IsPositive()
+    amountPerDistance: number;
+
+    /**
+     * Update a DistanceDonation entity based on this.
+     * @param donation The donation that shall be updated.
+     */
+    public async update(donation: DistanceDonation): Promise<DistanceDonation> {
+        donation.amountPerDistance = this.amountPerDistance;
+        donation.donor = await this.getDonor();
+        donation.runner = await this.getRunner();
+
+        return donation;
+    }
+
+    /**
+     * Gets a runner based on the runner id provided via this.runner.
+     */
+    public async getRunner(): Promise<Runner> {
+        const runner = await getConnection().getRepository(Runner).findOne({ id: this.runner });
+        if (!runner) {
+            throw new RunnerNotFoundError();
+        }
+        return runner;
+    }
+}

src/models/actions/update/UpdateDonation.ts

@@ -0,0 +1,41 @@
+import { IsInt, IsPositive } from 'class-validator';
+import { getConnection } from 'typeorm';
+import { DonorNotFoundError } from '../../../errors/DonorErrors';
+import { Donation } from '../../entities/Donation';
+import { Donor } from '../../entities/Donor';
+
+/**
+ * This class is used to update a Donation entity (via put request).
+ */
+export abstract class UpdateDonation {
+    /**
+     * The updated donation'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;
+
+    /**
+     * The updated donation's associated donor.
+     * This is important to link donations to donors.
+     */
+    @IsInt()
+    @IsPositive()
+    donor: number;
+
+    /**
+     * Creates a new Donation entity from this.
+     */
+    public abstract update(donation: Donation): Promise<Donation>;
+
+    /**
+     * Gets a donor based on the donor id provided via this.donor.
+     */
+    public async getDonor(): Promise<Donor> {
+        const donor = await getConnection().getRepository(Donor).findOne({ id: this.donor });
+        if (!donor) {
+            throw new DonorNotFoundError();
+        }
+        return donor;
+    }
+}

src/models/actions/update/UpdateFixedDonation.ts

@@ -0,0 +1,27 @@
+import { IsInt, IsPositive } from 'class-validator';
+import { FixedDonation } from '../../entities/FixedDonation';
+import { UpdateDonation } from './UpdateDonation';
+
+/**
+ * This class is used to update a FixedDonation entity (via put request).
+ */
+export class UpdateFixedDonation extends UpdateDonation {
+    /**
+     * The updated donation's amount.
+     * The unit is your currency's smallest unit (default: euro cent).
+     */
+    @IsInt()
+    @IsPositive()
+    amount: number;
+
+    /**
+     * Update a FixedDonation entity based on this.
+     * @param donation The donation that shall be updated.
+     */
+    public async update(donation: FixedDonation): Promise<FixedDonation> {
+        donation.amount = this.amount;
+        donation.donor = await this.getDonor();
+
+        return donation;
+    }
+}

src/models/entities/DistanceDonation.ts

@@ -1,5 +1,6 @@
 import { IsInt, IsNotEmpty, IsPositive } from "class-validator";
 import { ChildEntity, Column, ManyToOne } from "typeorm";
+import { ResponseDistanceDonation } from '../responses/ResponseDistanceDonation';
 import { Donation } from "./Donation";
 import { Runner } from "./Runner";
 
@@ -31,7 +32,7 @@ export class DistanceDonation extends Donation {
    * Get's calculated from the runner's distance ran and the amount donated per kilometer.
    */
   public get amount(): number {
-    let calculatedAmount = -1;
+    let calculatedAmount = 0;
     try {
       calculatedAmount = this.amountPerDistance * (this.runner.distance / 1000);
     } catch (error) {
@@ -43,7 +44,7 @@ export class DistanceDonation extends Donation {
   /**
    * Turns this entity into it's response class.
    */
-  public toResponse() {
-    return new Error("NotImplemented");
+  public toResponse(): ResponseDistanceDonation {
+    return new ResponseDistanceDonation(this);
   }
 }

src/models/entities/Donation.ts

@@ -3,6 +3,7 @@ import {
   IsNotEmpty
 } from "class-validator";
 import { Entity, ManyToOne, PrimaryGeneratedColumn, TableInheritance } from "typeorm";
+import { ResponseDonation } from '../responses/ResponseDonation';
 import { Donor } from './Donor';
 
 /**
@@ -31,12 +32,13 @@ export abstract class Donation {
    * The donation's amount in cents (or whatever your currency's smallest unit is.).
    * The exact implementation may differ for each type of donation.
    */
-  abstract amount: number;
+  public abstract get amount(): number;
+
 
   /**
    * Turns this entity into it's response class.
    */
-  public toResponse() {
-    return new Error("NotImplemented");
+  public toResponse(): ResponseDonation {
+    return new ResponseDonation(this);
   }
 }

src/models/entities/Donor.ts

@@ -1,4 +1,4 @@
-import { IsBoolean } from "class-validator";
+import { IsBoolean, IsInt } from "class-validator";
 import { ChildEntity, Column, OneToMany } from "typeorm";
 import { ResponseDonor } from '../responses/ResponseDonor';
 import { Donation } from './Donation';
@@ -24,6 +24,15 @@ export class Donor extends Participant {
   @OneToMany(() => Donation, donation => donation.donor, { nullable: true })
   donations: Donation[];
 
+  /**
+   * Returns the total donations of a donor based on his linked donations.
+  */
+  @IsInt()
+  public get donationAmount(): number {
+    if (!this.donations) { return 0; }
+    return this.donations.reduce((sum, current) => sum + current.amount, 0);
+  }
+
   /**
    * Turns this entity into it's response class.
    */

src/models/entities/FixedDonation.ts

@@ -1,5 +1,6 @@
 import { IsInt, IsPositive } from "class-validator";
 import { ChildEntity, Column } from "typeorm";
+import { ResponseDonation } from '../responses/ResponseDonation';
 import { Donation } from "./Donation";
 
 /**
@@ -11,16 +12,33 @@ export class FixedDonation extends Donation {
 
   /**
    * The donation's amount in cents (or whatever your currency's smallest unit is.).
+   * This is the "real" value used by fixed donations.
    */
   @Column()
   @IsInt()
   @IsPositive()
-  amount: number;
+  private _amount: number;
+
+  /**
+   * The donation's amount in cents (or whatever your currency's smallest unit is.).
+   */
+  @IsInt()
+  @IsPositive()
+  public get amount(): number {
+    return this._amount;
+  }
+
+  /**
+   * The donation's amount in cents (or whatever your currency's smallest unit is.).
+   */
+  public set amount(value: number) {
+    this._amount = value;
+  }
 
   /**
    * Turns this entity into it's response class.
    */
-  public toResponse() {
-    return new Error("NotImplemented");
+  public toResponse(): ResponseDonation {
+    return new ResponseDonation(this);
   }
 }

src/models/enums/PermissionTargets.ts

@@ -13,5 +13,6 @@ export enum PermissionTarget {
     DONOR = 'DONOR',
     SCAN = 'SCAN',
     STATION = 'STATION',
-    CARD = 'CARD'
+    CARD = 'CARD',
+    DONATION = 'DONATION'
 }

src/models/responses/ResponseDistanceDonation.ts

@@ -0,0 +1,35 @@
+import { IsInt, IsObject, IsPositive } from 'class-validator';
+import { DistanceDonation } from '../entities/DistanceDonation';
+import { ResponseDonation } from './ResponseDonation';
+import { ResponseRunner } from './ResponseRunner';
+
+/**
+ * Defines the distance donation response.
+*/
+export class ResponseDistanceDonation extends ResponseDonation {
+
+    /**
+     * The donation's associated runner.
+     * Used as the source of the donation's distance.
+     */
+    @IsObject()
+    runner: ResponseRunner;
+
+    /**
+     * The donation's amount donated per distance.
+     * The amount the donor set to be donated per kilometer that the runner ran.
+     */
+    @IsInt()
+    @IsPositive()
+    amountPerDistance: number;
+
+    /**
+     * Creates a ResponseDistanceDonation object from a scan.
+     * @param donation The distance donation the response shall be build for.
+     */
+    public constructor(donation: DistanceDonation) {
+        super(donation);
+        this.runner = donation.runner.toResponse();
+        this.amountPerDistance = donation.amountPerDistance;
+    }
+}

src/models/responses/ResponseDonation.ts

@@ -0,0 +1,37 @@
+import { IsInt, IsNotEmpty, IsPositive } from "class-validator";
+import { Donation } from '../entities/Donation';
+import { ResponseDonor } from './ResponseDonor';
+
+/**
+ * Defines the donation response.
+*/
+export class ResponseDonation {
+    /**
+     * The donation's id.
+     */
+    @IsInt()
+    @IsPositive()
+    id: number;
+
+    /**
+     * The donation's donor.
+     */
+    @IsNotEmpty()
+    donor: ResponseDonor;
+
+    /**
+     * The donation's amount in the smalles unit of your currency (default: euro cent).
+     */
+    @IsInt()
+    amount: number;
+
+    /**
+     * Creates a ResponseDonation object from a scan.
+     * @param donation The donation the response shall be build for.
+     */
+    public constructor(donation: Donation) {
+        this.id = donation.id;
+        this.donor = donation.donor.toResponse();
+        this.amount = donation.amount;
+    }
+}

src/models/responses/ResponseDonor.ts

@@ -1,5 +1,5 @@
 import {
-    IsBoolean
+    IsBoolean, IsInt
 } from "class-validator";
 import { Donor } from '../entities/Donor';
 import { ResponseParticipant } from './ResponseParticipant';
@@ -15,6 +15,12 @@ export class ResponseDonor extends ResponseParticipant {
     @IsBoolean()
     receiptNeeded: boolean;
 
+    /**
+    * Returns the total donations of a donor based on his linked donations.
+    */
+    @IsInt()
+    donationAmount: number;
+
     /**
      * Creates a ResponseRunner object from a runner.
      * @param runner The user the response shall be build for.
@@ -22,5 +28,6 @@ export class ResponseDonor extends ResponseParticipant {
     public constructor(donor: Donor) {
         super(donor);
         this.receiptNeeded = donor.receiptNeeded;
+        this.donationAmount = donor.donationAmount;
     }
 }