Merge pull request #64 from FoalTS/v0-4-0-beta-4

LoicPoullain · web-flow · commit 0adb06c4e483 · 2018-05-06T19:43:11.000+02:00
v0.4.0-beta.4
diff --git a/generators/app/index.js b/generators/app/index.js
@@ -42,6 +42,7 @@ Welcome to the FoalTS generator! The following questions will help you create yo
           { name: 'None', value: null },
           { name: 'SQLite', value: 'sqlite' },
           { name: 'PostgreSQL', value: 'postgres' },
+          { name: 'Microsoft SQL Server', value: 'mssql' },
           // { name: 'MySQL', value: 'mysql' },
         ],
         default: 'sqlite'
@@ -79,7 +80,7 @@ Welcome to the FoalTS generator! The following questions will help you create yo
             name: 'type',
             message: 'Which authenticator do you want to use?',
             choices: [
-              choice('Local authenticator (with email and password)', 'local-authenticator'),
+              choice('Email and password authenticator', 'email-and-password-authenticator'),
               // choice('I\'ll create one on my own.', 'authenticator')
             ],
             default: 0
@@ -152,7 +153,6 @@ Welcome to the FoalTS generator! The following questions will help you create yo
         'src/app/auth/index.ts',
         'src/app/auth/login-view.service.spec.ts',
         'src/app/auth/login-view.service.ts',
-        'src/app/shared/user.interface.ts',
         'src/app/shared/user.service.ts',
       );
     }
@@ -182,17 +182,20 @@ Welcome to the FoalTS generator! The following questions will help you create yo
     let dbDependencies = [];
     switch(this.database) {
       case 'sqlite':
-        dbDependencies.push('@foal/sequelize@0.4.0-beta.2', 'sqlite3');
+        dbDependencies.push('@foal/sequelize@0.4.0-beta.3', 'sqlite3');
         break;
       case 'postgres':
-        dbDependencies.push('@foal/sequelize@0.4.0-beta.2', 'pg@6', 'pg-hstore');
+        dbDependencies.push('@foal/sequelize@0.4.0-beta.3', 'pg@6', 'pg-hstore');
+        break;
+      case 'mssql':
+        dbDependencies.push('@foal/sequelize@0.4.0-beta.3', 'tedious');
         break;
       case 'mysql':
-        dbDependencies.push('@foal/sequelize@0.4.0-beta.2', 'mysql2');
+        dbDependencies.push('@foal/sequelize@0.4.0-beta.3', 'mysql2');
         break;
     }
     if (this.authentication) {
-      dbDependencies.push('@foal/authentication@0.4.0-beta.2', 'bcrypt-nodejs');
+      dbDependencies.push('@foal/authentication@0.4.0-beta.3');
     }
     if (dbDependencies.length !== 0) {
       this.npmInstall(dbDependencies, {}, () => {}, { cwd: this.names.kebabName });
diff --git a/generators/app/templates/package.json b/generators/app/templates/package.json
@@ -22,11 +22,11 @@
     "express-session": "^1.15.6",
     "helmet": "^3.9.0",
     "@types/node": "^8.0.47",
-    "@foal/ajv": "^0.4.0-beta.1",
-    "@foal/common": "^0.4.0-beta.2",
-    "@foal/core": "^0.4.0-beta.1",
-    "@foal/ejs": "^0.4.0-beta.2",
-    "@foal/express": "^0.4.0-beta.1",
+    "@foal/ajv": "^0.4.0-beta.3",
+    "@foal/common": "^0.4.0-beta.3",
+    "@foal/core": "^0.4.0-beta.3",
+    "@foal/ejs": "^0.4.0-beta.3",
+    "@foal/express": "^0.4.0-beta.3",
     "source-map-support": "^0.5.1"
   },
   "devDependencies": {
diff --git a/generators/app/templates/src/app/auth/auth.module.ts b/generators/app/templates/src/app/auth/auth.module.ts
@@ -1,32 +1,20 @@
-import { validate } from '@foal/ajv';
-import { authentication } from '@foal/authentication';
-import { basic, HttpResponseRedirect, Module } from '@foal/core';
-
+import { authentication, validateEmailAndPasswordCredentialsFormat } from '@foal/authentication';
 import { view } from '@foal/common';
+import { Module } from '@foal/core';
+
 import { AuthenticatorService } from './authenticator.service';
 import { LoginViewService } from './login-view.service';
 
 export const AuthModule: Module = {
   controllers: [
     authentication
-      .attachService('/local', AuthenticatorService, {
+      .attachService('/email', AuthenticatorService, {
         failureRedirect: '/auth?invalid_credentials=true', // Optional
         successRedirect: '/whatever_you_like', // Optional
       })
-      .withPreHook(validate({
-        additionalProperties: false,
-        properties: {
-          email: { type: 'string', format: 'email' },
-          password: { type: 'string' }
-        },
-        required: [ 'email', 'password' ],
-        type: 'object',
-      })),
-    basic
-      .attachHandlingFunction('POST', 'logout', ctx => {
-        delete ctx.session.authentication;
-        return new HttpResponseRedirect('/auth');
-      }),
+      .withPreHook(validateEmailAndPasswordCredentialsFormat()),
+    authentication
+      .attachLogout('/logout', { redirect: '/auth' }),
     view
       .attachService('/', LoginViewService)
       .withPreHook(ctx => {
diff --git a/generators/app/templates/src/app/auth/authenticator.service.ts b/generators/app/templates/src/app/auth/authenticator.service.ts
@@ -1,10 +1,10 @@
-import { LocalAuthenticatorService } from '@foal/authentication';
+import { EmailAndPasswordAuthenticatorService } from '@foal/authentication';
 import { Service } from '@foal/core';
 
 import { User, UserService } from '../shared';
 
 @Service()
-export class AuthenticatorService extends LocalAuthenticatorService<User> {
+export class AuthenticatorService extends EmailAndPasswordAuthenticatorService<User> {
   constructor(userService: UserService) {
     super(userService);
   }
diff --git a/generators/app/templates/src/app/auth/login-view.service.spec.ts b/generators/app/templates/src/app/auth/login-view.service.spec.ts
@@ -12,7 +12,7 @@ const template1 =
   <title>Login</title>
 </head>
 <body>
-  <form action="/auth/local" method="post">
+  <form action="/auth/email" method="post">
     <input type="hidden" name="_csrf" value="foobar">
     <input type="email" name="email" required autofocus>
     <br>
@@ -32,7 +32,7 @@ const template2 =
   <title>Login</title>
 </head>
 <body>
-  <form action="/auth/local" method="post">
+  <form action="/auth/email" method="post">
     <strong>Invalid credentials.</strong>
     <input type="hidden" name="_csrf" value="foobar">
     <input type="email" name="email" required autofocus>
diff --git a/generators/app/templates/src/app/auth/templates/login-view.html b/generators/app/templates/src/app/auth/templates/login-view.html
@@ -18,7 +18,7 @@
   </style>
 </head>
 <body>
-  <form class="text-center" action="/auth/local" method="post">
+  <form class="text-center" action="/auth/email" method="post">
     <h1 class="h3 mb-4">Log in</h1><% if (invalidCredentials) { %>
     <div class="alert alert-danger">
       <strong>Invalid credentials.</strong>
diff --git a/generators/app/templates/src/app/shared/index.ts b/generators/app/templates/src/app/shared/index.ts
@@ -1,3 +1,2 @@
 export { ConnectionService } from './connection.service';<% if (authentication) { %>
-export { User } from './user.interface';
-export { UserService } from './user.service';<% } %>
+export { User, UserService } from './user.service';<% } %>
diff --git a/generators/app/templates/src/app/shared/user.interface.ts b/generators/app/templates/src/app/shared/user.interface.ts
diff --git a/generators/app/templates/src/app/shared/user.service.ts b/generators/app/templates/src/app/shared/user.service.ts
@@ -1,29 +1,21 @@
-import { CheckPassword } from '@foal/authentication';
+import {
+  BaseUser,
+  EmailAndPassword,
+  emailAndPasswordSchema,
+  parsePassword,
+  UserModelService,
+} from '@foal/authentication';
 import { Service } from '@foal/core';
-import { DefaultIdAndTimeStamps, Sequelize, SequelizeModelService } from '@foal/sequelize';
-import * as bcrypt from 'bcrypt-nodejs';
 
 import { ConnectionService } from './connection.service';
-import { User } from './user.interface';
+
+export type User = BaseUser & EmailAndPassword;
 
 @Service()
-export class UserService extends SequelizeModelService<User> implements CheckPassword<User> {
-  constructor(connection: ConnectionService) {
-    super('users', {
-      email: { type: Sequelize.STRING, unique: true, allowNull: false },
-      isAdmin: { type: Sequelize.BOOLEAN, allowNull: false },
-      password: { type: Sequelize.STRING, allowNull: false },
-    }, connection);
-  }
+export class UserService extends UserModelService<User> {
 
-  public createOne(data: User): Promise<User & DefaultIdAndTimeStamps> {
-    return super.createOne({
-      ...data,
-      password: bcrypt.hashSync(data.password)
-    });
+  constructor(connection: ConnectionService) {
+    super(emailAndPasswordSchema, connection, [ parsePassword ]);
   }
 
-  public checkPassword(user: User, password: string): boolean {
-    return bcrypt.compareSync(password, user.password);
-  }
 }
diff --git a/generators/app/templates/src/config/config.ts b/generators/app/templates/src/config/config.ts
@@ -1,12 +1,10 @@
-import { ObjectType } from '@foal/core';
-
-export interface Config extends ObjectType {
+export interface Config {
   app: {
     name: string;
   };
   csrfProtection: boolean;
   db: {
-    options: ObjectType;
+    options: any;
     uri: string;
   };
   debugMode: boolean;
diff --git a/generators/service-controller-factory/templates/service-controller-factory.spec.ts b/generators/service-controller-factory/templates/service-controller-factory.spec.ts
@@ -25,11 +25,11 @@ describe('<%= camelName %>', () => {
   describe('when attachService is called', () => {
 
     it('should return a controller with a proper "main" route.', () => {
-      const controller = <%= camelName %>.attachService('/', MockService);
+      const controller = <%= camelName %>.attachService('/foobar', MockService);
       const actual = controller.getRoute('main');
 
       expect(actual.httpMethod).to.equal('GET');
-      expect(actual.path).to.equal('/');
+      expect(actual.path).to.equal('/foobar');
 
       const ctx = createEmptyContext();
       const result = actual.handler(ctx, new ServiceManager());
diff --git a/generators/service-controller-factory/templates/service-controller-factory.ts b/generators/service-controller-factory/templates/service-controller-factory.ts
@@ -1,17 +1,18 @@
-import { Class, Controller, HttpReponseOK, ServiceControllerFactory } from '@foal/core';
+import { Class, Controller, HttpReponseOK, IServiceControllerFactory } from '@foal/core';
 
 import { I<%= CamelName %> } from './<%= kebabName %>.interface';
 
 export type RouteName = 'main';
 
-export class <%= CamelName %>Factory extends ServiceControllerFactory<I<%= CamelName %>, RouteName> {
+export class <%= CamelName %>Factory implements IServiceControllerFactory {
 
-  protected defineController(controller: Controller<RouteName>,
-                             ServiceClass: Class<I<%= CamelName %>>) {
-    controller.addRoute('main', 'GET', '/', (ctx, services) => {
+  public attachService(path: string, ServiceClass: Class<I<%= CamelName %>>): Controller<RouteName> {
+    const controller = new Controller<RouteName>(path);
+    controller.addRoute('main', 'GET', '', (ctx, services) => {
       console.log(services.get(ServiceClass));
       return new HttpReponseOK();
     });
+    return controller;
   }
 
 }
diff --git a/generators/service/index.js b/generators/service/index.js
@@ -28,11 +28,11 @@ module.exports = class extends Generator {
         message: 'Type',
         choices: [
           choice('Empty', 'empty'),
-          choice('[Authenticator] Local authenticator (with email and password)', 'local-authenticator'),
+          choice('[Authenticator] Email and password authenticator', 'email-and-password-authenticator'),
           choice('[View] Single EJS template', 'ejs-template'),
           choice('[MultipleViews] Multiple EJS templates', 'multiple-ejs-templates'),
-          choice('[Model] Sequelize model (PostgreSQL, SQLite)', 'sequelize-model'),
-          choice('Sequelize connection (PostgreSQL, SQLite)', 'sequelize-connection'),
+          choice('[Model] Sequelize model (PostgreSQL, SQLite, MS SQL)', 'sequelize-model'),
+          choice('Sequelize connection (PostgreSQL, SQLite, MS SQL)', 'sequelize-connection'),
           choice('Authenticator (to implement)', 'authenticator'),
           // choice('Model (to implement)', 'model'),
           choice('View (to implement)', 'view'),
@@ -51,7 +51,7 @@ module.exports = class extends Generator {
         underscoreName: `${this.names.kebabName.replace(/-/g,'_')}`
       }, this.names)
     );
-    if (this.type !== 'local-authenticator' && this.type !== 'sequelize-model') {
+    if (this.type !== 'email-and-password-authenticator' && this.type !== 'sequelize-model') {
       this.fs.copyTpl(
         this.templatePath(`${this.type}-service.spec.ts`),
         this.destinationPath(`${this.names.kebabName}.service.spec.ts`),
diff --git a/generators/service/templates/email-and-password-authenticator-service.ts b/generators/service/templates/email-and-password-authenticator-service.ts
@@ -0,0 +1,12 @@
+import { EmailAndPasswordAuthenticatorService } from '@foal/authentication';
+import { Service } from '@foal/core';
+
+import { User, UserService } from 'somewhere';
+
+@Service()
+export class <%= CamelName %>Service extends EmailAndPasswordAuthenticatorService<User> {
+  constructor(userService: UserService) {
+    super(userService);
+  }
+
+}
diff --git a/generators/service/templates/local-authenticator-service.ts b/generators/service/templates/local-authenticator-service.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "generator-foal",
-  "version": "0.4.0-beta.3",
+  "version": "0.4.0-beta.4",
   "description": "Yeoman generators to quickly start a project and create components (services, controllers, etc.)",
   "files": [
     "generators"
diff --git a/test/service-controller-factory/files/foo-bar.controller-factory.spec.ts b/test/service-controller-factory/files/foo-bar.controller-factory.spec.ts
@@ -25,11 +25,11 @@ describe('fooBar', () => {
   describe('when attachService is called', () => {
 
     it('should return a controller with a proper "main" route.', () => {
-      const controller = fooBar.attachService('/', MockService);
+      const controller = fooBar.attachService('/foobar', MockService);
       const actual = controller.getRoute('main');
 
       expect(actual.httpMethod).to.equal('GET');
-      expect(actual.path).to.equal('/');
+      expect(actual.path).to.equal('/foobar');
 
       const ctx = createEmptyContext();
       const result = actual.handler(ctx, new ServiceManager());
diff --git a/test/service-controller-factory/files/foo-bar.controller-factory.ts b/test/service-controller-factory/files/foo-bar.controller-factory.ts
@@ -1,17 +1,18 @@
-import { Class, Controller, HttpReponseOK, ServiceControllerFactory } from '@foal/core';
+import { Class, Controller, HttpReponseOK, IServiceControllerFactory } from '@foal/core';
 
 import { IFooBar } from './foo-bar.interface';
 
 export type RouteName = 'main';
 
-export class FooBarFactory extends ServiceControllerFactory<IFooBar, RouteName> {
+export class FooBarFactory implements IServiceControllerFactory {
 
-  protected defineController(controller: Controller<RouteName>,
-                             ServiceClass: Class<IFooBar>) {
-    controller.addRoute('main', 'GET', '/', (ctx, services) => {
+  public attachService(path: string, ServiceClass: Class<IFooBar>): Controller<RouteName> {
+    const controller = new Controller<RouteName>(path);
+    controller.addRoute('main', 'GET', '', (ctx, services) => {
       console.log(services.get(ServiceClass));
       return new HttpReponseOK();
     });
+    return controller;
   }
 
 }
diff --git a/test/service/files/email-and-password-authenticator.service.ts b/test/service/files/email-and-password-authenticator.service.ts
@@ -0,0 +1,12 @@
+import { EmailAndPasswordAuthenticatorService } from '@foal/authentication';
+import { Service } from '@foal/core';
+
+import { User, UserService } from 'somewhere';
+
+@Service()
+export class FooBarService extends EmailAndPasswordAuthenticatorService<User> {
+  constructor(userService: UserService) {
+    super(userService);
+  }
+
+}
diff --git a/test/service/files/local-authenticator.service.ts b/test/service/files/local-authenticator.service.ts
diff --git a/test/service/index.spec.js b/test/service/index.spec.js
@@ -35,7 +35,7 @@ function testWithName(name) {
   describe(`called with argument name=${name}`, () => {
 
     testWithType(name, 'empty');
-    testWithType(name, 'local-authenticator', false);
+    testWithType(name, 'email-and-password-authenticator', false);
     testWithType(name, 'ejs-template');
     testWithType(name, 'multiple-ejs-templates');
     testWithType(name, 'sequelize-model', false);
