Small fix to API docs

Merge branch 'nightly' into ui
UI objects for UserSharingsGet and FingerprintPut added
2020-09-10 22:58:09 +02:00 · 2020-09-10 22:02:34 +02:00 · 2020-09-10 11:46:31 +02:00 · 2020-09-09 21:35:48 +02:00 · 2020-09-08 14:21:04 +02:00 · 2020-09-07 22:45:52 +02:00
24 changed files with 544 additions and 4 deletions
--- a/.gitignore
+++ b/.gitignore
@ -3,4 +3,5 @@ backend/cache
 backend/tmp
 backend/qr
 api/docs
+*.js
 .idea
--- a/api/openapi.yaml
+++ b/api/openapi.yaml
@ -97,6 +97,8 @@ paths:
      tags:
        - User
      summary: A list of all sharings with other users.
+      parameters:
+        - $ref: '#/components/parameters/UserId'
      responses:
        200:
          description: Returns the success state and a list with all sharings of the user.
@ -113,10 +115,10 @@ paths:
                    example:
                      - sharingId: 8
                        userId: 25
-                        userSharingId: 42
+                        userSharedId: 42
                      - sharingId: 9
                        userId: 25
-                        userSharingId:
+                        userSharedId: 7
        default:
          $ref: '#/components/responses/Error'

@ -125,6 +127,8 @@ paths:
      tags:
        - User
      summary: A list containing all fingerprints of the user
+      parameters:
+        - $ref: '#/components/parameters/UserId'
      responses:
        200:
          description: Returns the success state and a list with all fingerprints of the user.
--- a/backend/classes/controller/FingerprintPutController.php
+++ b/backend/classes/controller/FingerprintPutController.php
@ -31,7 +31,7 @@ final class FingerprintPutController extends AbstractController
 		try {
 			$fingerprint = new Fingerprint($this->fingerprintId);

-			if ($this->hasUserPermission($fingerprint->getUserId()) || $this->handleFingerprint($fingerprint)) {
+			if ($this->hasUserPermission($fingerprint->getUserId()) && $this->handleFingerprint($fingerprint)) {
 				return;
 			}

--- a/index.html
+++ b/index.html
@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Ringfinger</title>
+    <script type="module" src="js/ringfinger.js"></script>
+</head>
+<body>
+
+</body>
+</html>
--- a/js/api/ApiRequest.ts
+++ b/js/api/ApiRequest.ts
@ -0,0 +1,54 @@
+import RequestMethod from "./RequestMethod.js";
+
+export default class ApiRequest
+{
+	protected static BASE_URL: string = 'api/v1/';
+
+	protected request: XMLHttpRequest;
+	protected method: RequestMethod;
+	protected url: string;
+	protected parameters: Record<string, any> = {};
+	protected onSuccess: (responseText: string) => void;
+	protected onError: (responseText: string, status: number) => void;
+
+	public constructor(url: string, method: RequestMethod)
+	{
+		this.url = ApiRequest.BASE_URL + url;
+		this.method = method;
+		this.request = new XMLHttpRequest();
+		this.request.open(this.method, this.url);
+		this.onSuccess = () => {};
+		this.onError = () => {};
+	}
+
+	public addParameter(name: string, value: any): void
+	{
+		this.parameters[name] = value;
+	}
+
+	public submit(): void
+	{
+		this.request.onreadystatechange = () => {
+			if (this.request.readyState === 4) {
+				if (this.request.status === 200) {
+					this.onSuccess(this.request.responseText);
+				} else {
+					this.onError(this.request.responseText, this.request.status);
+				}
+			}
+		}
+
+		this.request.setRequestHeader('Content-Type', 'application/json');
+		this.request.send(JSON.stringify(this.parameters));
+	}
+
+	public setOnSuccess(callback: (responseText: string) => void): void
+	{
+		this.onSuccess = callback;
+	}
+
+	public setOnError(callback: (responseText: string, status: number) => void): void
+	{
+		this.onError = callback;
+	}
+}
--- a/js/api/FingerprintGetApiRequest.ts
+++ b/js/api/FingerprintGetApiRequest.ts
@ -0,0 +1,19 @@
+import ApiRequest from "./ApiRequest.js";
+import RequestMethod from "./RequestMethod.js";
+import Fingerprint from "../types/Fingerprint.js";
+import FingerprintGetEvent from "../event/FingerprintGetEvent.js";
+
+export default class FingerprintGetApiRequest extends ApiRequest
+{
+	public constructor(fingerprintId: number) {
+		super('fingerprint/' + fingerprintId, RequestMethod.GET);
+
+		this.onSuccess = (response: string): void => {
+			let json = JSON.parse(response);
+
+			let fingerprint = new Fingerprint(json.result.fingerprintId, json.result.fingerprint, json.result.userId);
+
+			window.dispatchEvent(new FingerprintGetEvent(fingerprint));
+		}
+	}
+}
--- a/js/api/FingerprintPostApiRequest.ts
+++ b/js/api/FingerprintPostApiRequest.ts
@ -0,0 +1,29 @@
+import ApiRequest from "./ApiRequest.js";
+import RequestMethod from "./RequestMethod.js";
+import Fingerprint from "../types/Fingerprint.js";
+import FingerprintCreatedEvent from "../event/FingerprintCreatedEvent.js";
+
+export default class FingerprintPostApiRequest extends ApiRequest
+{
+	private fingerprint: string;
+	private userId: number;
+
+	public constructor(fingerprint: string, userId: number) {
+		super('fingerprint', RequestMethod.POST);
+
+		this.fingerprint = fingerprint;
+		this.userId = userId;
+
+		this.addParameter('fingerprint', this.fingerprint);
+		this.addParameter('userId', this.userId);
+
+		this.setOnSuccess(
+			(response: string) => {
+				let json = JSON.parse(response);
+				let fingerprint = new Fingerprint(json.userId, this.fingerprint, this.userId);
+
+				window.dispatchEvent(new FingerprintCreatedEvent(fingerprint));
+			}
+		);
+	}
+}
--- a/js/api/FingerprintPutApiRequest.ts
+++ b/js/api/FingerprintPutApiRequest.ts
@ -0,0 +1,18 @@
+import ApiRequest from "./ApiRequest.js";
+import Fingerprint from "../types/Fingerprint.js";
+import RequestMethod from "./RequestMethod.js";
+import FingerprintChangedEvent from "../event/FingerprintChangedEvent.js";
+
+export default class FingerprintPutApiRequest extends ApiRequest
+{
+	public constructor(fingerprint: Fingerprint) {
+		super('fingerprint/' + fingerprint.getFingerprintId(), RequestMethod.PUT);
+
+		this.addParameter('fingerprint', fingerprint.getFingerprint());
+
+		this.onSuccess = (responseText: string) => {
+			console.log(responseText);
+			window.dispatchEvent(new FingerprintChangedEvent(fingerprint));
+		};
+	}
+}
--- a/js/api/RequestMethod.ts
+++ b/js/api/RequestMethod.ts
@ -0,0 +1,8 @@
+enum RequestMethod {
+	GET = 'GET',
+	POST = 'POST',
+	PUT = 'PUT',
+	DELETE = 'DELETE',
+}
+
+export default RequestMethod;
--- a/js/api/UserGetApiRequest.ts
+++ b/js/api/UserGetApiRequest.ts
@ -0,0 +1,24 @@
+import ApiRequest from "./ApiRequest.js";
+import RequestMethod from "./RequestMethod.js";
+import UserGetEvent from "../event/UserGetEvent.js";
+import User from "../types/User.js";
+
+export default class UserGetApiRequest extends ApiRequest
+{
+	public constructor(userId: number)
+	{
+		super('user/' + userId, RequestMethod.GET);
+
+		this.onSuccess = (response: string) => {
+			let json = JSON.parse(response);
+
+			let user = new User(json.result.userId);
+			user.setUsername(json.result.username);
+			user.setJabberAddress(json.result.jabberAddress);
+			user.setAdmin(json.result.isAdmin);
+			user.setFingerprintIds(json.result.fingerprintIds);
+
+			window.dispatchEvent(new UserGetEvent(user));
+		}
+	}
+}
--- a/js/api/UserLoginApiRequest.ts
+++ b/js/api/UserLoginApiRequest.ts
@ -0,0 +1,20 @@
+import ApiRequest from "./ApiRequest.js";
+import RequestMethod from "./RequestMethod.js";
+import UserLoginSuccessEvent from "../event/UserLoginSuccessEvent.js";
+
+export default class UserLoginApiRequest extends ApiRequest
+{
+	public constructor(username: string, password: string)
+	{
+		super('user/session', RequestMethod.POST);
+
+		this.addParameter('username', username);
+		this.addParameter('password', password);
+
+		this.onSuccess = (response: string) =>
+		{
+			let json = JSON.parse(response);
+			window.dispatchEvent(new UserLoginSuccessEvent(json.userId));
+		};
+	}
+}
--- a/js/api/UserLogoutApiRequest.ts
+++ b/js/api/UserLogoutApiRequest.ts
@ -0,0 +1,9 @@
+import ApiRequest from "./ApiRequest.js";
+import RequestMethod from "./RequestMethod.js";
+
+export default class UserLogoutApiRequest extends ApiRequest
+{
+	public constructor() {
+		super('user/session', RequestMethod.DELETE);
+	}
+}
--- a/js/api/UserSharingsGetApiRequest.ts
+++ b/js/api/UserSharingsGetApiRequest.ts
@ -0,0 +1,26 @@
+import ApiRequest from "./ApiRequest.js";
+import RequestMethod from "./RequestMethod.js";
+import Sharing from "../types/Sharing.js";
+import UserSharingsGetEvent from "../event/UserSharingsGetEvent.js";
+
+export default class UserSharingsGetApiRequest extends ApiRequest
+{
+	public constructor(userId: number)
+	{
+		super('user/' + userId + '/sharings', RequestMethod.GET);
+
+		this.onSuccess = (response: string) => {
+			let json = JSON.parse(response);
+
+			let sharings: Array<Sharing> = [];
+
+			json.sharings.forEach(
+				(result: any) => {
+					sharings.push(new Sharing(result.sharingId, result.userId, result.userSharedId));
+				}
+			);
+
+			window.dispatchEvent(new UserSharingsGetEvent(sharings));
+		}
+	}
+}
--- a/js/event/FingerprintChangedEvent.ts
+++ b/js/event/FingerprintChangedEvent.ts
@ -0,0 +1,18 @@
+import RingfingerEvent from "./RingfingerEvent.js";
+import Fingerprint from "../types/Fingerprint.js";
+
+export default class FingerprintChangedEvent extends RingfingerEvent
+{
+	private fingerprint: Fingerprint;
+
+	public constructor(fingerprint: Fingerprint) {
+		super(FingerprintChangedEvent.name);
+
+		this.fingerprint = fingerprint;
+	}
+
+	public getFingerprint(): Fingerprint
+	{
+		return this.fingerprint;
+	}
+}
--- a/js/event/FingerprintCreatedEvent.ts
+++ b/js/event/FingerprintCreatedEvent.ts
@ -0,0 +1,18 @@
+import RingfingerEvent from "./RingfingerEvent.js";
+import Fingerprint from "../types/Fingerprint.js";
+
+export default class FingerprintCreatedEvent extends RingfingerEvent
+{
+	private fingerprint: Fingerprint;
+
+	public constructor(fingerprint: Fingerprint) {
+		super(FingerprintCreatedEvent.name);
+
+		this.fingerprint = fingerprint;
+	}
+
+	public getFingerprint(): Fingerprint
+	{
+		return this.fingerprint;
+	}
+}
--- a/js/event/FingerprintGetEvent.ts
+++ b/js/event/FingerprintGetEvent.ts
@ -0,0 +1,20 @@
+import RingfingerEvent from "./RingfingerEvent.js";
+import Fingerprint from "../types/Fingerprint.js";
+
+export default class FingerprintGetEvent extends RingfingerEvent
+{
+	public static readonly NAME: string = 'fingerprintgetevent';
+
+	private fingerprint: Fingerprint;
+
+	public constructor(fingerprint: Fingerprint) {
+		super(FingerprintGetEvent.NAME);
+
+		this.fingerprint = fingerprint;
+	}
+
+	public getFingerprint(): Fingerprint
+	{
+		return this.fingerprint;
+	}
+}
--- a/js/event/RingfingerEvent.ts
+++ b/js/event/RingfingerEvent.ts
@ -0,0 +1,4 @@
+export default class RingfingerEvent extends Event
+{
+	public static readonly NAME: string;
+}
--- a/js/event/UserGetEvent.ts
+++ b/js/event/UserGetEvent.ts
@ -0,0 +1,21 @@
+import RingfingerEvent from "./RingfingerEvent.js";
+import User from "../types/User.js";
+
+export default class UserGetEvent extends RingfingerEvent
+{
+	public static readonly NAME: string = 'usergetevent';
+
+	private user: User;
+
+	public constructor(user: User)
+	{
+		super(UserGetEvent.NAME);
+
+		this.user = user;
+	}
+
+	public getUser(): User
+	{
+		return this.user;
+	}
+}
--- a/js/event/UserLoginSuccessEvent.ts
+++ b/js/event/UserLoginSuccessEvent.ts
@ -0,0 +1,19 @@
+import RingfingerEvent from "./RingfingerEvent.js";
+
+export default class UserLoginSuccessEvent extends RingfingerEvent
+{
+	public static readonly NAME: string = 'userloginsuccessevent';
+
+	private userId: number;
+
+	public constructor(userId: number) {
+		super(UserLoginSuccessEvent.NAME);
+
+		this.userId = userId;
+	}
+
+	public getUserId(): number
+	{
+		return this.userId;
+	}
+}
--- a/js/event/UserSharingsGetEvent.ts
+++ b/js/event/UserSharingsGetEvent.ts
@ -0,0 +1,18 @@
+import RingfingerEvent from "./RingfingerEvent.js";
+import Sharing from "../types/Sharing.js";
+
+export default class UserSharingsGetEvent extends RingfingerEvent
+{
+	private sharings: Array<Sharing>;
+
+	public constructor(sharings: Array<Sharing>) {
+		super(UserSharingsGetEvent.name);
+
+		this.sharings = sharings;
+	}
+
+	public getSharings(): Array<Sharing>
+	{
+		return this.sharings;
+	}
+}
--- a/js/types/Fingerprint.ts
+++ b/js/types/Fingerprint.ts
@ -0,0 +1,49 @@
+export default class Fingerprint
+{
+	private static readonly CHARS_ALLOWED: string = '1234567890abcdef';
+
+	private readonly fingerprintId: number;
+	private readonly fingerprint: string;
+	private readonly userId: number;
+
+	public constructor(fingerprintId: number, fingerprint: string, userId: number)
+	{
+		if (!Fingerprint.validateFingerprint(fingerprint)) {
+			throw new Error(fingerprint + ' is not a valid fingerprint!');
+		}
+
+		this.fingerprintId = fingerprintId;
+		this.fingerprint = fingerprint;
+		this.userId = userId;
+	}
+
+	public getFingerprint(): string
+	{
+		return this.fingerprint;
+	}
+
+	public getUserId(): number
+	{
+		return this.userId;
+	}
+
+	public getFingerprintId(): number
+	{
+		return this.fingerprintId;
+	}
+
+	private static validateFingerprint(fingerprint: string): boolean
+	{
+		if (fingerprint.length !== 64) {
+			return false;
+		}
+
+		for (let i: number = 0; i < fingerprint.length; ++i) {
+			if (Fingerprint.CHARS_ALLOWED.indexOf(fingerprint[i]) === -1) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+}
--- a/js/types/Sharing.ts
+++ b/js/types/Sharing.ts
@ -0,0 +1,28 @@
+export default class Sharing
+{
+	private readonly sharingId: number;
+	private readonly userId: number;
+	private readonly userSharingId: number;
+
+	public constructor(sharingId: number, userId: number, userSharingId: number)
+	{
+		this.sharingId = sharingId;
+		this.userId = userId;
+		this.userSharingId = userSharingId;
+	}
+
+	public getSharingId(): number
+	{
+		return this.sharingId;
+	}
+
+	public getUserId(): number
+	{
+		return this.userId;
+	}
+
+	public getUserSharingId(): number
+	{
+		return this.userSharingId;
+	}
+}
--- a/js/types/User.ts
+++ b/js/types/User.ts
@ -0,0 +1,53 @@
+export default class User
+{
+	private userId: number;
+	private username: string = '';
+	private jabberAddress: string = '';
+	private admin: boolean = false;
+	private fingerprintIds: Array<number> = [];
+
+	public constructor(userId: number)
+	{
+		this.userId = userId;
+	}
+
+	public setUsername(username: string): void
+	{
+		this.username = username;
+	}
+
+	public getUsername(): string
+	{
+		return this.username;
+	}
+
+	public setJabberAddress(jabberAddress: string): void
+	{
+		this.jabberAddress = jabberAddress;
+	}
+
+	public getJabberAddress(): string
+	{
+		return this.jabberAddress;
+	}
+
+	public setAdmin(isAdmin: boolean): void
+	{
+		this.admin = isAdmin;
+	}
+
+	public isAdmin(): boolean
+	{
+		return this.admin;
+	}
+
+	public setFingerprintIds(fingerprintIds: Array<number>)
+	{
+		this.fingerprintIds = fingerprintIds;
+	}
+
+	public getFingerprintIds(): Array<number>
+	{
+		return this.fingerprintIds;
+	}
+}
--- a/tsconfig.json
+++ b/tsconfig.json
@ -0,0 +1,69 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "es2020",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  }
+}
Author	SHA1	Message	Date
mal	9c287012e7	Small fix to API docs	2020-09-10 22:58:09 +02:00
mal	dc6f8f732e	Merge branch 'nightly' into ui	2020-09-10 22:02:34 +02:00
Mal	22e27ed899	UI objects for UserSharingsGet and FingerprintPut added	2020-09-10 11:46:31 +02:00
Mal	b5184b9b3c	Merge branch 'nightly' into ui	2020-09-09 21:35:48 +02:00
Mal	ab86081dd9	Fingerprint creation implemented.	2020-09-08 14:21:04 +02:00
Mal	894ba92016	Session requests and types for fingerprint and user added.	2020-09-07 22:45:52 +02:00
Mal	49a1fd26e7	First API requests implemented.	2020-09-06 12:07:26 +02:00