chyz 1.0.12-rc.14

package/README.md

@@ -0,0 +1,218 @@
+Hızlı şekilde microservis hazırlama için geliştirmeye başladım<br>
+
+Temel olarak yii2 php framework'ten örnekler alındı<br>
+
+Temel olarak basit bir Controller geliştirildi, ayrıca authentication geliştirildi.<br>
+
+Klasör Yapısı<br>
+*---Controllers  <br>
+*---Models<br>
+*---Log<br>
+*---Framework<br>
+index.ts<br>
+
+`##Başlangıç<br>
+yarn start
+
+## index.ts alanlar düzenlenmeli.
+
+```js
+let config = {
+    components: {
+        db: {
+            class: DbConnection,
+            database: process.env.DBDATABASE,
+            username: process.env.DBUSER,
+            password: process.env.DBPASS,
+            options: {
+                host: process.env.DBHOST,
+                dialect: 'postgres',  /* one of 'mysql' | 'mariadb' | 'postgres' | 'mssql' */
+                // disable logging; default: console.log
+                logging: false
+            }
+        },
+        user: {
+            'class': User,
+            'identityClass': Identity
+        }
+    }
+}
+Chyz.app(config).Start();
+```
+
+## Create Model
+
+Veritabanı işlemleri için model oluşturma, sequelize desteklidir.
+
+```js
+import {Model, DataTypes} from "chyz/base/Model";
+
+export class Customer extends Model {
+    public tableName() {
+        return 'customer';
+    }
+
+    public attributes() {
+        return {
+            username: {
+                type: DataTypes.STRING,
+                allowNull: false,
+                validate: {
+                    notEmpty: true,
+                    len: [4, 255],
+                }
+            },
+            email: {
+                type: DataTypes.STRING,
+                validate: {
+                    isEmail: true
+                }
+            },
+            firstname: {
+                type: DataTypes.STRING,
+                allowNull: false
+            },
+            lastname: {
+                type: DataTypes.STRING,
+            },
+        }
+    }
+
+}
+```
+## Http POST ve GET verilerini model'e yükleme
+````js
+
+    /**
+     * post data
+     *  {
+     *      "Customer":{
+     *          "firstname":"cihan",
+     *          "lastname":"ozturk"
+     *          ....
+     *      }
+     *  }
+     * @type {Customer}
+     */
+
+    //Customer Model Create
+    let customer: Customer = new Customer();
+    customer.load(req.body, "Customer");//load customer data
+    let cus: any = await customer.save();
+        
+        
+        
+
+````
+## Transaction
+Transaction oluşturma
+
+
+```js
+    let transaction
+    try {
+        // get transaction
+        transaction = await BaseChyz.getComponent("db").transaction();
+        //Customer Model Create
+        let customer: Customer = new Customer();
+        customer.load(data, "Customer");//load customer data
+        let cus: any = await customer.save({}, {transaction});
+        if (!cus) {
+            throw new ValidationHttpException(customer.errors);
+        }
+    } catch (e) {
+        if (transaction) {
+            await transaction.rollback();
+            BaseChyz.warn("Rollback transaction")
+        }
+        ...
+    }
+```
+
+## Yetkilendirme için kullanıcı modeli
+
+```js
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+import {IdentityInterface} from "chyz/web/IdentityInterface";
+// @ts-ignore
+import {DataTypes} from "chyz/base";
+import {Model} from "chyz/base";
+import BaseChyz from "chyz/BaseChyz";
+
+const bcrypt = require('bcrypt');
+const JsonWebToken = require("jsonwebtoken");
+
+export class User extends Model implements IdentityInterface {
+    public tableName() {
+        return 'users';
+    }
+    findIdentity(id: number) {
+        throw new Error("Method not implemented.");
+    }
+
+    getId(): number {
+        throw new Error("Method not implemented.");
+    }
+
+    getAuthKey(): string {
+        throw new Error("Method not implemented.");
+    }
+
+    validateAuthKey(authKey: string): boolean {
+        throw new Error("Method not implemented.");
+    }
+
+    public attributes() {
+        return {
+            // Model attributes are defined here
+            username: {
+                type: DataTypes.STRING,
+                allowNull: false
+            },
+            password: {
+                type: DataTypes.STRING,
+                allowNull: false
+            },
+            user_role: {
+                type: DataTypes.STRING,
+                allowNull: false
+            },
+            salt_text: {
+                type: DataTypes.STRING
+                // allowNull defaults to true
+            }
+        }
+    }
+
+    async findIdentityByAccessToken(token, type) {
+        let decoded = JsonWebToken.decode(token, {complete: true})
+        let identity = await this.findOne({where: {id: parseInt(decoded.payload.user)}});
+        if(identity){
+            BaseChyz.debug("Find Identity By AccessToken: User Found", decoded.payload)
+            try {
+                JsonWebToken.verify(token, identity.salt_text);
+                BaseChyz.debug("Find Identity By AccessToken: User Verify Success")
+                return identity;
+            } catch(err) {
+                BaseChyz.debug("Find Identity By AccessToken: User Verify Failed")
+                return null;
+            }
+        }
+        BaseChyz.debug("Find Identity By AccessToken: User Verify Failed")
+        return null;
+    }
+
+
+}
+
+
+
+
+
+
+```

package/base/ActionFilter.ts

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+// @ts-ignore
+import {NextFunction, Request, Response} from "express";
+import Utils from "../requiments/Utils";
+import {Behavior} from "./Behavior";
+
+export class ActionFilter extends Behavior {
+
+    public only: any;
+
+    /**
+     * @var array list of action IDs that this filter should not apply to.
+     * @see only
+     */
+    public except = [];
+
+
+    public init() {
+
+    }
+
+    public async beforeFilter(route: any, req: Request, res: Response) {
+        if (!this.isActive(route.id)) {
+            return;
+        }
+
+        await this.beforeAction(route, req, res)
+    }
+
+    protected isActive(action: any) {
+        let id = action.id;
+        let onlyMatch: boolean = false;
+        let exceptMatch: boolean = false;
+        if (Utils.isEmpty(this.only)) {
+            onlyMatch = true;
+        } else {
+            onlyMatch = false;
+            for (const onlyKey of this.only) {
+                if (Utils.matchWildcard(action, onlyKey)) {
+                    onlyMatch = true;
+                    break;
+                }
+            }
+        }
+
+        for (const exceptKey in this.except) {
+            let pattern = this.except[exceptKey];
+            let match = id.match(pattern)
+            if (match.length > 0) {
+                exceptMatch = true;
+            }
+        }
+
+        return !exceptMatch && onlyMatch;
+    }
+
+    /**
+     * This method is invoked right before an action is to be executed (after all possible filters.)
+     * You may override this method to do last-minute preparation for the action.
+     * @param Action $action the action to be executed.
+     * @return bool whether the action should continue to be executed.
+     */
+    public async beforeAction(route: any, req: Request, res: Response) {
+        return true;
+    }
+}

package/base/BaseError.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+
+export class BaseError extends Error {
+    private statusCode: number;
+
+    constructor(message: string) {
+        super(message);
+        this.message=message;
+        this.name = this.constructor.name // good practice
+        this.statusCode = 500 // error code for responding to client
+        Error.captureStackTrace(this)
+    }
+
+    toString(){
+        return `${this.name}[${this.statusCode}] ${this.message}`
+    }
+    toJSON(){
+        return {code: this?.statusCode, name: this.name, message: this.message}
+    }
+}
+

package/base/BaseObject.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+
+import {Configurable} from "./Configurable";
+import BaseChyz from "../BaseChyz";
+
+export class BaseObject implements Configurable {
+
+
+    public init() {
+
+        BaseChyz.debug("BaseObject init.....",)
+
+    }
+}

package/base/Behavior.ts

@@ -0,0 +1,6 @@
+import {BaseObject} from "./BaseObject";
+
+export class Behavior extends BaseObject
+{
+
+}

package/base/Component.ts

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+
+import {BaseObject} from "./BaseObject";
+import {ActionFilter} from "./ActionFilter";
+import Utils from "../requiments/Utils";
+
+export class Component extends BaseObject {
+
+    /**
+     * @var array the attached event handlers (event name => handlers)
+     */
+    private _events = [];
+
+
+    /**
+     * @var Behavior[]|null the attached behaviors (behavior name => behavior). This is `null` when not initialized.
+     */
+
+    private _behaviors: Array<ActionFilter> = [];
+
+
+    /**
+     *  Returns a list of behaviors that this component should behave as.
+     */
+    public behaviors() {
+        return [];
+    }
+
+
+    get getBehaviors(): any {
+        return this._behaviors;
+    }
+
+    /**
+     * Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
+     */
+    public ensureBehaviors() {
+        if (this._behaviors.length == 0) {
+            this._behaviors = [];
+            if (this.behaviors().length > 0) {
+                this.behaviors().forEach(behavior => {
+                    Object.keys(behavior).forEach((name: string) => {
+                        this.attachBehaviorInternal(name, behavior)
+                    });
+                })
+            }
+
+        }
+    }
+
+
+    private attachBehaviorInternal(name: any, behavior: any) {
+        if (!this._behaviors.hasOwnProperty(name)) {
+            let beh = Utils.createObject(new behavior[name].class, behavior[name])
+            beh.init()
+            this._behaviors[name] = beh;
+        }
+        return behavior;
+    }
+
+}

package/base/Configurable.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+
+export interface Configurable{
+
+}

package/base/Controller.ts

@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+
+import {Component} from "./Component";
+import {RouteDefinition} from "../model/RouteDefinition";
+import {Request, Response} from "express";
+
+export class Controller extends Component {
+
+
+    /**
+     * @var string the ID of this controller.
+     */
+    public id: string;
+    public defaultAction = 'index';
+
+    constructor(config: any) {
+        super();
+        this.id = this.constructor.name.replace("Controller", "").toLowerCase();
+    }
+
+    public init() {
+        super.init();
+    }
+
+
+    /**
+     * This method is invoked right before an action is executed.
+     * @param $action
+     */
+    public async beforeAction(route: RouteDefinition, req: Request, res: Response) {
+        if (route.id == "" || route.id == "/")
+            this.id = this.defaultAction
+
+        this.ensureBehaviors()
+        for (const name of Object.keys(this.getBehaviors)) {
+            await this.getBehaviors[name].beforeFilter(route, req, res);
+        }
+
+    }
+
+    /**
+     * This method is invoked right after an action is executed.
+     * @param action
+     */
+    public afterAction(action: any, req: Request, res: Response) {
+
+    }
+
+    /**
+     *
+
+     Checks the privilege of the current user.
+
+     This method should be overridden to check whether the current user has the privilege to run the specified action against the specified data model. If the user does not have access, a yii\web\ForbiddenHttpException should be thrown.
+
+     */
+    public checkAccess(action: any, model = null, params: any = []) {
+
+    }
+
+    /**
+     * Send data formatted as JSON.
+
+     This method is a shortcut for sending data formatted as JSON. It will return the response application component after configuring the format and setting the data that should be formatted. A common usage will b
+     */
+    asJson(data: any) {
+
+    }
+
+    /**
+     * Send data formatted as XML.
+
+     This method is a shortcut for sending data formatted as XML. It will return the response application component after configuring the format and setting the data that should be formatted. A common usage will be:
+     */
+    asXml(data: any) {
+
+    }
+
+}

package/base/DataErrorDbException.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+
+
+
+import {BaseError} from "./BaseError";
+
+export class DataErrorDbException extends BaseError {
+    constructor ( public message: string) {
+        super(message);
+    }
+}

package/base/DbConnection.ts

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+// @ts-ignore
+const {Sequelize} = require("sequelize");
+import {Component} from "./Component";
+import BaseChyz from "../BaseChyz";
+
+export class DbConnection extends Component {
+
+    public database!: string;
+    public username!: string
+    public password!: string
+    public options?: object
+    public _transaction:any;
+
+    private _db: any
+
+    async init() {
+        const sequelize = new Sequelize(this.database, this.username, this.password, this.options);
+        this._db = sequelize;
+        sequelize
+            .authenticate()
+            .then(() => {
+                BaseChyz.info('Connection has been established successfully.');
+            })
+            .catch((err: any) => {
+                BaseChyz.error('Unable to connect to the database:', err);
+
+            });
+
+        // await this.connect();
+    }
+
+
+    get db(): any {
+        return this._db;
+    }
+
+    set db(value: any) {
+        this._db = value;
+    }
+
+    public transaction(){
+        return this.db.transaction();
+    }
+
+}

package/base/ForbiddenHttpException.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+
+import {BaseError} from "./BaseError";
+export class ForbiddenHttpException extends BaseError {
+    constructor ( message: string) {
+        super(message);
+    }
+}
+
+

package/base/InvalidConfigException.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2021. Chy Bilgisayar Bilisim
+ * Author: Cihan Ozturk
+ * E-mail: cihan@chy.com.tr
+ * Github:https://github.com/cihan53/
+ */
+
+
+
+import {BaseError} from "./BaseError";
+
+export class InvalidConfigException extends BaseError {
+    constructor ( public message: string) {
+        super(message);
+    }
+}