Merge branch 'feature/class-transformer' into develop

Author: dweber019

README.md

@@ -313,6 +313,8 @@ this.routeGeneratorService.navigateByRouteNames(
 ```
 
 ## Class transfomer (model handling)
+We have included the [class transformer](https://github.com/typestack/class-transformer) which helps creating models (`src/app/models/*`). This transformation can be done
+in both direction (rest to model, model to rest).
 
 ## Dialog service
 There is a custom dialog implementation for simpler useage of elements in dialogs.

package.json

@@ -151,11 +151,13 @@
     "aurelia-validation": "^1.1.1",
     "bluebird": "^3.5.0",
     "bootstrap": "^4.0.0",
+    "class-transformer": "^0.1.9",
     "i18next-browser-languagedetector": "^2.0.0",
     "isomorphic-fetch": "^2.2.1",
     "jquery": "^3.2.1",
     "moment": "^2.18.1",
     "normalize.css": "^8.0.0",
-    "popper.js": "^1.12.9"
+    "popper.js": "^1.12.9",
+    "reflect-metadata": "^0.1.12"
   }
 }

src/app/main.ts

@@ -34,6 +34,7 @@ import LanguageDetector from 'i18next-browser-languagedetector';
 /**
  * Polyfills
  */
+import 'reflect-metadata';
 import 'utils/polyfills.utils';
 
 // Fontawesome setup

src/app/models/user.model.ts

@@ -1,10 +1,15 @@
 
+import { Expose } from 'class-transformer';
+
 export class UserModel {
-  constructor(
-    public avatarUrl: string,
-    public login: string,
-    public htmlUrl: string
-  ) { }
+
+  @Expose({ name: 'avatar_url' })
+  public avatarUrl: string = '';
+
+  public login: string = '';
+
+  @Expose({ name: 'html_url' })
+  public htmlUrl: string = '';
 
   public getLogin(): string {
     return this.login;

src/app/modules/users/users.vm.ts

@@ -1,5 +1,5 @@
 import { autoinject } from 'aurelia-framework';
-import { UserService } from './../../services/user.service';
+import { UserRestService } from './../../services/rest/user.service';
 import { UserModel } from './../../models/user.model';
 
 @autoinject
@@ -8,10 +8,10 @@ export class UsersViewModel {
 	public users: Array<UserModel> = [];
 
 	constructor(
-    private userService: UserService
+    private userRestService: UserRestService
   ) { }
 
 	public async activate(): Promise<void> {
-		this.users = await this.userService.getUsers();
+    this.users = await this.userRestService.getUsers();
 	}
 }

src/app/services/rest/user.service.ts

@@ -0,0 +1,29 @@
+import { autoinject } from 'aurelia-framework';
+import { plainToClass } from 'class-transformer';
+
+import { RestClient } from './rest-client.service';
+import { UserModel } from './../../models/user.model';
+
+export interface IUser {
+  avatar_url: string;
+  login: string;
+  html_url: string;
+}
+
+@autoinject
+export class UserRestService {
+
+  constructor(
+    private restClient: RestClient,
+  ) {
+    this.restClient
+      .useAPI()
+      .withResource('users');
+  }
+
+  public async getUsers(): Promise<UserModel[]> {
+    const users = await this.restClient.findAll<IUser[]>();
+
+    return plainToClass(UserModel, users);
+  }
+}

src/app/services/user.service.ts

@@ -1,6 +1,6 @@
 {
   "NAME": "Development",
-  "API_MAIN_URL": "https://api",
+  "API_MAIN_URL": "https://api.github.com/",
   "API_UAM_URL": "https://api",
   "LOG_LEVEL": "debug"
 }

src/config/development.json

@@ -1,6 +1,6 @@
 {
   "NAME": "Production",
-  "API_MAIN_URL": "https://api",
+  "API_MAIN_URL": "https://api.github.com/",
   "API_UAM_URL": "https://api",
   "LOG_LEVEL": "error"
 }

src/config/production.json

@@ -1745,6 +1745,10 @@ clap@^1.0.9:
   dependencies:
     chalk "^1.1.3"
 
+class-transformer@^0.1.9:
+  version "0.1.9"
+  resolved "https://registry.yarnpkg.com/class-transformer/-/class-transformer-0.1.9.tgz#29977c528233ca014e6fd9523327ebd31d11ca54"
+
 class-utils@^0.3.5:
   version "0.3.6"
   resolved "https://registry.yarnpkg.com/class-utils/-/class-utils-0.3.6.tgz#f93369ae8b9a7ce02fd41faad0ca83033190c463"
@@ -8188,6 +8192,10 @@ reduce-function-call@^1.0.1:
   dependencies:
     balanced-match "^0.4.2"
 
+reflect-metadata@^0.1.12:
+  version "0.1.12"
+  resolved "https://registry.yarnpkg.com/reflect-metadata/-/reflect-metadata-0.1.12.tgz#311bf0c6b63cd782f228a81abe146a2bfa9c56f2"
+
 regenerate@^1.2.1:
   version "1.3.3"
   resolved "https://registry.yarnpkg.com/regenerate/-/regenerate-1.3.3.tgz#0c336d3980553d755c39b586ae3b20aa49c82b7f"