1.0.5

.gitlab-ci.yml

@@ -1,5 +1,5 @@
 # gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
@@ -50,13 +50,13 @@ testLTS:
   - docker
   - notpriv
 
-testSTABLE:
+testBuild:
   stage: test
   script:
   - npmci npm prepare
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm install
-  - npmci npm test
+  - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
@@ -65,7 +65,7 @@ testSTABLE:
 release:
   stage: release
   script:
-  - npmci node install stable
+  - npmci node install lts
   - npmci npm publish
   only:
   - tags
@@ -98,7 +98,9 @@ trigger:
   - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:18-dind
   stage: metadata
   script:
     - npmci command npm install -g @gitzone/tsdoc

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartguard",
-  "version": "1.0.2",
+  "version": "1.0.5",
   "private": false,
   "description": "smart guards for validations",
   "main": "dist/index.js",
@@ -15,10 +15,25 @@
   "devDependencies": {
     "@gitzone/tsbuild": "^2.0.22",
     "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.7",
-    "tslint": "^5.11.0",
+    "@pushrocks/smartexpress": "^3.0.35",
+    "@pushrocks/tapbundle": "^3.0.11",
+    "@types/node": "^12.7.0",
+    "tslint": "^5.18.0",
     "tslint-config-prettier": "^1.15.0"
   },
-  "dependencies": {}
+  "dependencies": {
+    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartrequest": "^1.1.16"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,26 @@
+# @pushrocks/smartguard
+smart guards for validations
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartguard)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartguard)
+* [github.com (source mirror)](https://github.com/pushrocks/smartguard)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartguard/)
+
+## Status for master
+[![build status](https://gitlab.com/pushrocks/smartguard/badges/master/build.svg)](https://gitlab.com/pushrocks/smartguard/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartguard/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartguard/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartguard.svg)](https://www.npmjs.com/package/@pushrocks/smartguard)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartguard/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartguard)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+## Usage
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,8 +1,65 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartguard from '../ts/index'
+import * as smartguard from '../ts/index';
+import * as smartexpress from '@pushrocks/smartexpress';
+import * as smartrequest from '@pushrocks/smartrequest';
 
-tap.test('first test', async () => {
-  console.log(smartguard.standardExport)
+let smartexpressInstance: smartexpress.Server;
+
+tap.test('should create a demo smartexpress instance', async () => {
+  smartexpressInstance = new smartexpress.Server({
+    cors: true,
+    forceSsl: false,
+    defaultAnswer: async () => 'hi there',
+    port: 3211
+  });
+});
+
+tap.test('should be able to create smartguards for a request', async () => {
+  interface IRequestGuardData {
+    req: smartexpress.Request;
+    res: smartexpress.Response;
+  }
+  const ipGuard = new smartguard.Guard<IRequestGuardData>(async dataArg => {
+    console.log('executing ip guard');
+    if (dataArg) {
+      console.log('ip guard succeeded');
+      return true;
+    } else {
+      console.log('ip guard failed!');
+      return false;
+    }
+  });
+
+  smartexpressInstance.addRoute(
+    '/testroute',
+    new smartexpress.Handler('ALL', async (req, res) => {
+      await smartguard.passGuards(
+        {
+          req,
+          res
+        },
+        [ipGuard]
+      );
+      console.log('ip guard said ok');
+      res.status(200);
+      res.send('hi');
     })
+  );
+  console.log('Got here ok');
+});
 
-tap.start()
+tap.test('should start server with guards in place', async () => {
+  await smartexpressInstance.start();
+});
+
+tap.test('should execute a request', async () => {
+  const response = await smartrequest.request('http://localhost:3211/testroute', {
+    method: 'GET'
+  });
+});
+
+tap.test('should end the demo smartexpress instance', async () => {
+  await smartexpressInstance.stop();
+});
+
+tap.start();

ts/index.ts

@@ -1,3 +1,18 @@
 import * as plugins from './smartguard.plugins';
+import { Guard } from './smartguard.classes.guard';
+import { GuardSet } from './smartguard.classes.guardset';
+export * from './smartguard.classes.guard';
 
-export let standardExport = 'Hi there! :) This is an exported string';
+export const passGuards = async <T>(dataArg: T, guards: Array<Guard<T>>) => {
+  const done = plugins.smartpromise.defer();
+  const guardSet = new GuardSet<T>(guards);
+  const results = await guardSet.executeGuardsWithData(dataArg);
+  for (const result of results) {
+    if (!result) {
+      return;
+    }
+  }
+  done.resolve();
+  await done.promise;
+  return;
+};

ts/smartguard.classes.blockhandler.ts

@@ -0,0 +1,6 @@
+import * as plugins from './smartguard.plugins';
+
+/**
+ * a block handler is used
+ */
+export class BlockHandler {}

ts/smartguard.classes.guard.ts

@@ -0,0 +1,19 @@
+import * as plugins from './smartguard.plugins';
+
+export type TGuardFunction<T> = (dataArg: T) => Promise<boolean>;
+
+export class Guard<T> {
+  private guardFunction: TGuardFunction<T>;
+  constructor(guardFunctionArg: TGuardFunction<T>) {
+    this.guardFunction = guardFunctionArg;
+  }
+
+  /**
+   * executes the guard against a data argument;
+   * @param dataArg
+   */
+  public async executeGuardWithData(dataArg: T) {
+    const result = await this.guardFunction(dataArg);
+    return result;
+  }
+}

ts/smartguard.classes.guardset.ts

@@ -0,0 +1,23 @@
+import * as plugins from './smartguard.plugins';
+import { Guard } from './smartguard.classes.guard';
+
+/**
+ * a guardSet is a set of guards that need to be fulfilled
+ */
+export class GuardSet<T> {
+  public guards: Array<Guard<T>>;
+  public passed: boolean;
+  constructor(guardsArrayArg: Array<Guard<T>>) {
+    this.guards = guardsArrayArg;
+  }
+
+  public async executeGuardsWithData(dataArg: T) {
+    const resultPromises: Array<Promise<boolean>> = [];
+    for (const guard of this.guards) {
+      const resultPromise = guard.executeGuardWithData(dataArg);
+      resultPromises.push(resultPromise);
+    }
+    const results = Promise.all(resultPromises);
+    return results;
+  }
+}

ts/smartguard.plugins.ts

@@ -1,4 +1,4 @@
-const removeme = {};
-export {
-  removeme
-}
+import * as smartpromise from '@pushrocks/smartpromise';
+
+// pushrocks scope
+export { smartpromise };