Implementing client flow, decopling the flow resolution.

Author: franciscomerdot

source/FlowResultBuilder.ts

@@ -0,0 +1,36 @@
+import { FlowResult } from "./Models/FlowResult";
+import { IFlowResultBuilder } from "./IFlowResultBuilder";
+import { ITokenService } from "./Services/ITokenService";
+import { Token } from "./Models/Persistents/Token";
+
+/**
+ * Represents the a builder to vuild flows results.
+ */
+export class FlowResultBuilder implements IFlowResultBuilder {
+    
+    private _tokenService:ITokenService;
+    
+    /**
+     * Create a new instance of flow result builder.
+     * @param tokenService Represents a token service used to generate tokens.
+     */
+    constructor(tokenService:ITokenService) {
+        
+        this._tokenService = tokenService;
+    }
+
+    /**
+     * Return a builder FlowResult.
+     */
+    public async getResult():Promise<FlowResult> {
+        
+        let token:Token = await this._tokenService.generateToken();
+        let result:FlowResult = new FlowResult();                
+        
+        result.accessToken = token.value;
+        result.expireIn = token.expireIn;
+        result.refreshToken = token.refreshToken ? token.refreshToken.value : null;
+
+        return result;
+    }
+}

source/Flows/BaseFlow.ts

@@ -1,5 +1,7 @@
 import { IFlow } from './IFlow'
 import { IFlowHandler } from '../IFlowHandler'
+import { FlowError } from "../Models/FlowError";
+import { ICLientService } from "../Services/IClientService";
 
 /**
  * Represents a base class for the oAuth flows.
@@ -9,7 +11,7 @@ export abstract class BaseFlow implements IFlow {
      * Construct a new base flow [BaseFP] with the given type.
      * @param type Represents the type of the flow processor.
      */
-    constructor(type:string) {
+    constructor(type:string, clientService:ICLientService) {
         this._type = type;        
     }
 
@@ -26,8 +28,26 @@ export abstract class BaseFlow implements IFlow {
     public clientId: string;
 
     /**
-     * Execute the flow and handle it with the given handler.
-     * @param handler Represents the handler for the flow.
+     * Execute the flow resolution and handle it with the given handler.
+     * @param handle Represents the handler.
      */
-    public abstract execute(handler:IFlowHandler):Promise<void>;
+    public async resolve(handler:IFlowHandler):Promise<boolean> {
+
+        let error:FlowError = await this.validate();
+
+        if (error) {
+            handler.notifyError(error);
+            return true;
+        }
+        else
+            return false;  
+    };
+
+    /**
+     * Return a flow error instance when a error is founded in the evaluated flow.
+     * If return null no error was found.
+     */
+    private async validate():Promise<FlowError> {
+        return null;
+    };
 }

source/Flows/ClientCredetialFlow.ts

@@ -1,12 +1,31 @@
 import { BaseFlow } from './BaseFlow'
 import { IFlowHandler } from '../IFlowHandler'
+import { IClientService } from "../Services/IClientService";
+import { FlowResult } from "../Models/FlowResult";
+import { Token } from "../Models/Persistents/Token";
+import { ITokenService } from "../Services/ITokenService";
+import { IFlowResultBuilder } from "../IFlowResultBuilder";
 
 /**
  * Represents a client credential flow.
  */
 export class ClientCredetialFlow extends BaseFlow {
-    constructor() {
-        super('client_credential')
+
+    private _clientService:IClientService;
+    private _flowResultBuilder:IFlowResultBuilder;
+
+    /**
+     * Create ne instance of client credential flow.
+     * @param clientService Represents a client service to authenticate and validate the client.
+     * @param flowResultBuilder Represents a builder to build results.
+     */
+    constructor(clientService:IClientService
+               ,flowResultBuilder:IFlowResultBuilder) {
+
+        super('client_credential', clientService);
+
+        this._clientService = clientService;
+        this._flowResultBuilder = flowResultBuilder;
     }
 
     /**
@@ -15,11 +34,14 @@ export class ClientCredetialFlow extends BaseFlow {
     public clientSecret:string;
 
     /**
-     * Execute the flow and handle it with the given handler.
-     * @param handler Represents the handler for the flow.
+     * Execute the flow resolution and handle it with the given handler.
+     * @param handle Represents the handler.
      */
-    public execute(handler:IFlowHandler):void {  
-
-       
+    public async resolve(handler:IFlowHandler):Promise<boolean> {
+        if (!super.resolve(handler) && this._clientService.validateCredentials(this.clientId, this.clientSecret)) {
+            handler.returnResult(await this._flowResultBuilder.getResult());
+        }
+        else
+            return false;   
     }
 }

source/Flows/IFlow.ts

@@ -5,7 +5,8 @@ import { IFlowHandler } from '../IFlowHandler'
  */
 export interface IFlow {
     /**
-     * Execute the flow and handle it with the given handler.
+     * Execute the flow resolution and handle it with the given handler.
+     * @param handle Represents the handler.
      */
-    execute(handler:IFlowHandler):Promise<void>;
+    resolve(handler:IFlowHandler):Promise<boolean>;
 }

source/Flows/PasswordFlow.ts

@@ -4,27 +4,35 @@ import { IFlowHandler } from '../IFlowHandler'
 import { Token } from "../Models/Persistents/Token";
 import { ITokenService } from "../Services/ITokenService";
 import { IUserService } from "../Services/IUserService";
+import { FlowError } from "../Models/FlowError";
+import { IFlowResultBuilder } from "../IFlowResultBuilder";
+import { IClientService } from "../Services/IClientService";
 
 
 /**
  * Represents the password flow.
  */
 export class PasswordFlow extends BaseFlow {
 
-    private _userService:IUserService;
-    private _tokenService:ITokenService;
+    private _userService:IUserService;    
+    private _clientService:IClientService;
+    private _flowResultBuilder:IFlowResultBuilder;
+
 
     /**
      * Create a new instance of password flow class.
-     * @param userService Represents a user service.
+     * @param userService Represents a user service used to authenticate the user. 
+     * @param clientService Represents a client service to perform some basic flow validations.
+     * @param flowResultBuilder Represents a builder to build results.
      */
-    constructor(userService:IUserService
-               ,tokenService:ITokenService) {
+    constructor(userService:IUserService               
+               ,clientService:IClientService
+               ,flowResultBuilder:IFlowResultBuilder) {
 
-        super('password');
+        super('password', clientService);
 
         this._userService = userService;
-        this._tokenService = tokenService;
+        this._clientService = clientService;
     }
 
     /**
@@ -37,25 +45,16 @@ export class PasswordFlow extends BaseFlow {
     public password:string;
 
      /**
-     * Execute the flow and handle it with the given handler.
-     * @param handler Represents the handler for the flow.
+     * Execute the flow resolution and handle it with the given handler.
+     * @param handle Represents the handler.
      */
-    public async execute(handler:IFlowHandler):Promise<void> {
-        try
-        {
-            if (await this._userService.validateCredential(this.username, this.password)) {
-                let token:Token = await this._tokenService.generateToken();
-                let result:FlowResult = new FlowResult();                
-                
-                result.accessToken = token.value;
-                result.expireIn = token.expireIn;
-                result.refreshToken = token.refreshToken ? token.refreshToken.value : null;
-
-                handler.returnResult(result);
-            }
-        }
-        catch(ex) {
-            handler.notifyError('');
+    public async resolve(handler:IFlowHandler):Promise<boolean> {
+      
+        if (!super.resolve(handler) && await this._userService.validateCredentials(this.username, this.password)) {
+            handler.returnResult(await this._flowResultBuilder.getResult());
         }
+        else
+            return false;
+
     }
 }

source/IFlowHandler.ts

@@ -1,19 +1,23 @@
 import { FlowResult } from './Models/FlowResult'
+import { FlowError } from "./Models/FlowError";
 
 /**
- * Represent a handler for the flows.
+ * Represents a handler for the flows.
  */
 export interface IFlowHandler {
     /**
      * Redirect the request to another page, usually the authorization page.
+     * @param url Represents the url to redirect.
      */
     redirectToURL(url:string):void
     /**
      * Return the flow result to the requester client.
+     * @param result Represents the result to return.
      */
     returnResult(result:FlowResult):void
     /**
      * Notify an error that may occur.
+     * @param Represents the error that occur.
      */
-    notifyError(error:string):void
+    notifyError(error:FlowError):void
 }

source/IFlowResultBuilder.ts

@@ -0,0 +1,11 @@
+import { FlowResult } from "./Models/FlowResult";
+
+/**
+ * Represents the a builder to vuild flows results.
+ */
+export interface IFlowResultBuilder {
+    /**
+     * Return a builder FlowResult.
+     */
+    getResult():Promise<FlowResult>
+}

source/Models/FlowError.ts

@@ -0,0 +1,28 @@
+/**
+ * Represents a error in a flow validation.
+ */
+export class FlowError {
+
+    private _code:string;
+    private _message:string;
+    
+    /**
+     * Create a new flow error instance with the given code and message.
+     * @param code 
+     * @param message 
+     */
+    constructor(code:string, message:string) {
+        this._code = code;
+        this._message = message;
+    }
+
+    /**
+     * Get the error code.
+     */
+    public get code() { return this._code; }
+
+    /**
+     * Get the error message.
+     */
+    public get message() { return this._message };
+}

source/Models/Persistents/Client.ts

@@ -1,3 +1,19 @@
+/**
+ * Represents a client.
+ */
 export class Client {
-    
+    /**
+     * Get or set the client id.
+     */
+    public clientId:string;
+
+    /**
+     * Get or set the client secret.
+     */
+    public clientSecret:string;
+
+    /**
+     * Get or set the redirect uri fro the client.
+     */
+    public redirectURI:string;
 }

source/Repositories/IClientRepository.ts

@@ -1,14 +1,12 @@
 import { Client } from '../Models/Persistents/Client'
 
+/**
+ * Represents a client repository to persists clients.
+ */
 export interface IClientRepository {
-
-    getAll():Promise<Array<Client>>;
-
-    getList(name:string, limit:number, offset:number):Promise<Array<Client>>;
-    
-    getById(id:string):Promise<Client>;
-
-    save(client:Client):Promise<void>;
-
-    authenticate(clientId:string, clientSecret:string):Promise<boolean>;
+    /**
+     * Return a client instance by the given client id.
+     * @param clientId Represents the id of the client to look for.
+     */
+    getById(clientId:string):Promise<Client>;
 }

source/Repositories/ITokenRepository.ts

@@ -6,7 +6,7 @@ import { Token } from '../Models/Persistents/Token'
 export interface ITokenRepository { 
 
     /**
-     * Get a tokent instance by the given value.
+     * Returns a tokent instance by the given value.
      * @param value Represents the value to look for.
      */ 
     getByValue(value:string):Promise<Token>;

source/Repositories/IUserRepository.ts

@@ -6,7 +6,7 @@ import { User } from '../Models/Persistents/User'
 export interface IUserRepository {
 
     /**
-     * Get an user instance by a given name.
+     * Returns an user instance by a given name.
      * @param username Represent the user name to look for.
      */
     getByName(username:string):Promise<User>;