Adding and implementing services, models and flows.

Author: franciscomerdot

package.json

@@ -28,5 +28,8 @@
     "gulp": "^3.9.1",
     "gulp-typescript": "^3.1.5",
     "typescript": "^2.2.1"
+  },
+  "dependencies": {
+    "randomstring": "^1.1.5"
   }
 }

source/FlowFactory.ts

@@ -13,25 +13,29 @@ class FlowFactory {
     private _flowTypeMapList:FlowTypeMap[];
 
     /**
-     * 
+     * Get a new flow instance builded with the given type and data.
+     * @param type Represents the type of flow to instantiate.
+     * @param data Represents the data to deserialize into the flow.
      */
     public getFlow(type:string, data:any):IFlow {
 
         let map:FlowTypeMap = this._flowTypeMapList.find(function(map) { return map.type == type });
 
         if (!map)
-            throw new Error(`The type [{type}] dont have any asociated build function in the factory.`);
+            throw new Error('The type [' + type + '] dont have any asociated build function in the factory.');
 
         return map.buildFunction(data);
     }
 
     /**
-     * 
+     * Set the given build function as a builder for the given type. 
+     * @param type Represents the type to assing the builder function.
+     * @param buildFunction  Represents the function the build the flow of the given type.
      */
-    public addCustomFlow(type:string,  buildFunction:(data:any) => IFlow):void {
+    public setFlowTypeBuilder(type:string,  buildFunction:(data:any) => IFlow):void {
 
         if (this._flowTypeMapList.find(function(map) { return map.type == type }))
-            throw new Error(`The type [{type}] already has a asociated build function in the factory.`);
+            throw new Error('The type [' + type + '] already has a asociated build function in the factory.');
 
 
         this._flowTypeMapList.push({
@@ -41,6 +45,4 @@ class FlowFactory {
     }
 }
 
-let factoryInstance = new FlowFactory();
-
-export = factoryInstance;
+export = new FlowFactory();

source/Flows/IFlow.ts

@@ -7,5 +7,5 @@ export interface IFlow {
     /**
      * Execute the flow and handle it with the given handler.
      */
-    execute(handler:IFlowHandler):void
+    execute(handler:IFlowHandler):Promise<void>
 }

source/Flows/PasswordFlow.ts

@@ -1,12 +1,30 @@
 import { BaseFlow } from './BaseFlow'
+import { FlowResult } from '../Models/FlowResult'
 import { IFlowHandler } from '../IFlowHandler'
+import { Token } from "../Models/Persistents/Token";
+import { ITokenService } from "../Services/ITokenService";
+import { IUserService } from "../Services/IUserService";
+
 
 /**
  * Represents the password flow.
  */
 export class PasswordFlow extends BaseFlow {
-    constructor() {
-        super('password')
+
+    private _userService:IUserService;
+    private _tokenService:ITokenService;
+
+    /**
+     * Create a new instance of password flow class.
+     * @param userService Represents a user service.
+     */
+    constructor(userService:IUserService
+               ,tokenService:ITokenService) {
+
+        super('password');
+
+        this._userService = userService;
+        this._tokenService = tokenService;
     }
 
     /**
@@ -22,8 +40,22 @@ export class PasswordFlow extends BaseFlow {
      * Execute the flow and handle it with the given handler.
      * @param handler Represents the handler for the flow.
      */
-    public execute(handler:IFlowHandler):void {  
+    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('');
+        }
     }
 }

source/IFlowHandler.ts

@@ -7,11 +7,11 @@ export interface IFlowHandler {
     /**
      * Redirect the request to another page, usually the authorization page.
      */
-    redirect(url:string):void
+    redirectToURL(url:string):void
     /**
      * Return the flow result to the requester client.
      */
-    return(result:FlowResult):void
+    returnResult(result:FlowResult):void
     /**
      * Notify an error that may occur.
      */

source/Models/Persistents/BaseToken.ts

@@ -0,0 +1,15 @@
+/**
+ * Represents a base token.
+ */
+export abstract class BaseToken {
+    
+    /**
+     * Get or set the value of the token.
+     */
+    public value:string;
+
+    /**
+     * The time in seconds to the token expiration.
+     */
+    public expireIn:number;
+}

source/Models/Persistents/RefreshToken.ts

@@ -0,0 +1,8 @@
+import { BaseToken } from './BaseToken'
+
+/**
+ * Represents a refresh token.
+ */
+export class RefreshToken extends BaseToken {
+
+}

source/Models/Persistents/Token.ts

@@ -1,3 +1,12 @@
-export class Token {
+import { BaseToken } from './BaseToken'
+
+/**
+ * Represents a token.
+ */
+export class Token extends BaseToken {
 
+    /**
+     * Get or set the refresh token information.
+     */
+    public refreshToken:BaseToken;
 }

source/Models/Persistents/User.ts

@@ -1,3 +1,15 @@
+/**
+ * Represents an user.
+ */
 export class User {
 
+    /**
+     * Get or set the user name.
+     */
+    public name:string;
+
+    /**
+     * Get or set the user password.
+     */
+    public password:string;
 }

source/OAuthContext.ts

@@ -0,0 +1,29 @@
+import { OAuthContextConfiguration } from './OAuthContextConfiguration'
+
+/**
+ * Represents an OAuth context.
+ */
+export class OAuthContext {
+
+    private _configuration:OAuthContextConfiguration;
+
+    /**
+     * Create a new instance of the OAuth context with a default configuration.
+     */
+    constructor() {
+        this.loadConfiguration();        
+    }
+
+    /**
+     * Get the context configuration.
+     */
+    public get configuration() { return this._configuration; }
+
+    private loadConfiguration() {
+        this._configuration = new OAuthContextConfiguration();
+        this._configuration.tokenExpirationTime = null;
+        this._configuration.refreshTokenExpirationTime = null;
+        this._configuration.authorizationCodeExpirationTime = 30;
+        this._configuration.mustGenerateRefreshToken = false;
+    }
+}

source/OAuthContextConfiguration.ts

@@ -0,0 +1,25 @@
+/**
+ * Represents a set of configurations for an OAuth context;
+ */
+export class OAuthContextConfiguration {
+
+    /**
+     * Get or set the amount of time in second for a token to expire;
+     */
+    public tokenExpirationTime:number;
+
+    /**
+     * Get or set the amount of time in second for a refresh token to expire;
+     */
+    public refreshTokenExpirationTime:number;
+
+     /**
+     * Get or set the amount of time in second for an authorization code to expire;
+     */
+    public authorizationCodeExpirationTime:number;
+
+    /**
+     * Get or set a boolean value specifying if the token generation process must create an refresh token;
+     */
+    public mustGenerateRefreshToken:boolean;
+}

source/Repositories/ITokenRepository.ts

@@ -1,12 +1,19 @@
 import { Token } from '../Models/Persistents/Token'
 
-export interface IUserRepository {
+/**
+ * Represents a token repository to persists tokens.
+ */
+export interface ITokenRepository { 
 
-    getAll():Promise<Array<Token>>;
+    /**
+     * Get a tokent instance by the given value.
+     * @param value Represents the value to look for.
+     */ 
+    getByValue(value:string):Promise<Token>;
 
-    getList(name:string, limit:number, offset:number):Promise<Array<Token>>;
-    
-    getById(id:string):Promise<Token>;
-
-    save(client:Token):Promise<void>;
+    /**
+     * Save or update the token instance;
+     * @param token The token instance to persist.
+     */
+    save(token:Token):Promise<void>;
 }

source/Repositories/IUserRepository.ts

@@ -1,12 +1,13 @@
 import { User } from '../Models/Persistents/User'
 
+/**
+ * Represents an user repository to persists users.
+ */
 export interface IUserRepository {
-
-    getAll():Promise<Array<User>>;
-
-    getList(name:string, limit:number, offset:number):Promise<Array<User>>;
 
-    getById(id:string):Promise<User>;
-
-    save(client:User):Promise<void>;
+    /**
+     * Get an user instance by a given name.
+     * @param username Represent the user name to look for.
+     */
+    getByName(username:string):Promise<User>;
 }

source/Services/ITokenGenerationService.ts

@@ -0,0 +1,10 @@
+/**
+ * Represents a token generation service to generate tokens.
+ */
+export interface ITokenGenerationService {
+
+    /**
+     * Get a new ramdom token value;
+     */
+    getTokenValue():Promise<string>;
+}

source/Services/ITokenService.ts

@@ -0,0 +1,18 @@
+import { Token } from '../Models/Persistents/Token'
+
+/**
+ * Represents a token service.
+ */
+export interface ITokenService {    
+
+    /**
+     * Get a token intance by the given value.
+     * @param tokenValue Represents the token value to look for.
+     */
+    getByValue(tokenValue:string):Promise<Token>;
+
+    /**
+     * Get a new generated token.
+     */
+    generateToken():Promise<Token>;    
+}

source/Services/IUserService.ts

@@ -0,0 +1,11 @@
+/**
+ * Represent an user service.
+ */
+export interface IUserService {
+    /**
+     * Get a boolean value specifying if the user credential are valid.
+     * @param username Represents the user name.
+     * @param password Represents the user password.
+     */ 
+    validateCredential(username:string, password:string):Promise<boolean>;
+}

source/Services/TokenGenerationService.ts

@@ -0,0 +1,14 @@
+import { ITokenGenerationService } from './ITokenGenerationService' 
+
+/**
+ * Represents a token generation service to generate tokens.
+ */
+export class TokenGenerationService implements ITokenGenerationService {
+
+    /**
+     * Get a new ramdom token value;
+     */
+    public async getTokenValue():Promise<string> {
+        return 'sdhbfhksbdjkfbsbgbsjfkabghkbf';
+    }
+}