1.0.32

.gitlab-ci.yml

@@ -3,93 +3,123 @@ image: hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .yarn/
+  - .npmci_cache/
   key: "$CI_BUILD_STAGE"
 
 stages:
 - security
 - test
 - release
-- trigger
-- pages
+- metadata
 
+# ====================
+# security stage
+# ====================
 mirror:
   stage: security
   script:
   - npmci git mirror
   tags:
   - docker
+  - notpriv
 
 snyk:
   stage: security
   script:
-    - npmci command yarn global add snyk
-    - npmci command yarn install --ignore-scripts
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
   - docker
+  - notpriv
 
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  allow_failure: true
+# ====================
+# test stage
+# ====================
 
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
     
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - notpriv
 
 release:
   stage: release
   script:
-  - npmci npm prepare
+  - npmci node install stable
   - npmci npm publish
   only:
   - tags
   tags:
   - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  image: docker:stable
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SOURCE_CODE="$PWD"
+        --volume "$PWD":/code
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
+  artifacts:
+    paths: [codeclimate.json]
+  tags:
+  - docker
+  - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
   - npmci trigger
   only:
   - tags
   tags:
   - docker
+  - notpriv
 
 pages:
   image: hosttoday/ht-docker-node:npmci
-  stage: pages
+  stage: metadata
   script:
-    - npmci command yarn global add npmpage
-    - npmci command npmpage
+    - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
     - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true

license

@@ -0,0 +1,19 @@
+Copyright (c) 2018 Lossless GmbH (hello@lossless.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

npmextra.json

@@ -1,9 +1,17 @@
 {
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartuniverse",
+      "shortDescription": "messaging service for micro services",
+      "npmPackagename": "@pushrocks/smartuniverse",
+      "license": "MIT",
+      "projectDomain": "push.rocks"
+    }
+  },
   "npmci": {
-    "npmGlobalTools": [
-      "@gitzone/npmts",
-      "ts-node"
-    ],
+    "npmGlobalTools": [],
     "npmAccessLevel": "public"
   }
-}
+}

package.json

@@ -1,30 +1,38 @@
 {
   "name": "@pushrocks/smartuniverse",
-  "version": "1.0.14",
+  "version": "1.0.32",
+  "private": false,
   "description": "messaging service for your micro services",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
-    "test": "(ts-node -O '{\"lib\": [ \"es2015\" ]}' test/test.ts)",
-    "build": "(npmts)",
+    "test": "(tstest test/)",
+    "build": "(tsbuild)",
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@types/node": "^9.6.0",
-    "tapbundle": "^2.0.0"
+    "@gitzone/tsbuild": "^2.1.8",
+    "@gitzone/tstest": "^1.0.20",
+    "@pushrocks/tapbundle": "^3.0.9",
+    "@types/node": "^11.13.4",
+    "tslint": "^5.15.0",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "peerDependencies": {
+    "rxjs": "*"
   },
   "dependencies": {
-    "lik": "^2.0.5",
-    "rxjs": "^5.5.8",
-    "smartcli": "^2.0.12",
-    "smartexpress": "^1.0.21",
-    "smartfile": "^4.2.28",
-    "smartq": "^1.1.8",
-    "smartrequest": "^1.0.8",
-    "smartrx": "^1.0.5",
-    "smartsocket": "^1.1.19",
-    "smarttime": "^2.0.0"
+    "@pushrocks/lik": "^3.0.5",
+    "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartexpress": "^3.0.18",
+    "@pushrocks/smartfile": "^7.0.2",
+    "@pushrocks/smarthash": "^2.0.4",
+    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartrequest": "^1.1.14",
+    "@pushrocks/smartrx": "^2.0.3",
+    "@pushrocks/smartsocket": "^1.1.27",
+    "@pushrocks/smarttime": "^3.0.7"
   }
 }

readme.md

@@ -1,33 +1,32 @@
-# smartuniverse
+# @pushrocks/smartuniverse
+messaging service for micro services
 
-messaging service for your micro services
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartuniverse)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartuniverse)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartuniverse/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartuniverse)
+* [github.com (source mirror)](https://github.com/pushrocks/smartuniverse)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartuniverse/)
 
 ## Status for master
-
-[![build status](https://GitLab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://GitLab.com/pushrocks/smartuniverse/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartuniverse/commits/master)
+[![build status](https://gitlab.com/pushrocks/smartuniverse/badges/master/build.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartuniverse/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartuniverse/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartuniverse.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartuniverse/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartuniverse/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartuniverse/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartuniverse)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartuniverse/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartuniverse)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+[![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
 
 Use TypeScript for best in class instellisense.
 
-For further information read the linked docs at the top of this README.
+### What does smartuniverse all about?
 
-> licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+Think WhatsApp, but for your microservices architecture. It allows your services to securely talk to each other in private, shielded channels without having to expose anything to the outside world. This allows the use of reactive programming across your entire stack.
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+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,12 +1,12 @@
 // tslint:disable-next-line:no-implicit-dependencies
-import { expect, tap } from 'tapbundle';
+import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartuniverse from '../ts/index';
 
 import { Observable } from 'rxjs';
 
 let testUniverse: smartuniverse.Universe;
-let testUniverseClient: smartuniverse.UniverseClient;
-let testMessageObservable: Observable<smartuniverse.UniverseMessage>;
+let testUniverseClient: smartuniverse.ClientUniverse;
+let testClientChannel: smartuniverse.ClientUniverseChannel;
 
 tap.test('first test', async () => {
   testUniverse = new smartuniverse.Universe({
@@ -20,10 +20,19 @@ tap.test('add a message to the SmartUniverse', async () => {
 
 // testing message handling
 tap.test('create smartuniverse client', async () => {
-  testUniverseClient = new smartuniverse.UniverseClient({
+  testUniverseClient = new smartuniverse.ClientUniverse({
     serverAddress: 'http://localhost:8765'
   });
-  expect(testUniverseClient).to.be.instanceof(smartuniverse.UniverseClient);
+  expect(testUniverseClient).to.be.instanceof(smartuniverse.ClientUniverse);
+});
+
+tap.test('should add a channel to the universe', async () => {
+  await testUniverse.addChannel('testChannel', 'testPassword');
+});
+
+tap.test('should get a observable correctly', async () => {
+  testClientChannel = await testUniverseClient.getChannel('testChannel');
+  expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
 });
 
 tap.test('should send a message correctly', async () => {
@@ -32,10 +41,6 @@ tap.test('should send a message correctly', async () => {
   });
 });
 
-tap.test('should get a observable correctly', async () => {
-  testMessageObservable = testUniverseClient.getMessageObservable();
-});
-
 tap.test('should receive a message correctly', async () => {});
 
 tap.test('should disconnect the client correctly', async () => {

ts/index.ts

@@ -1,3 +1,11 @@
+// Client classes
+export * from './smartuniverse.classes.clientuniverse';
+export * from './smartuniverse.classes.clientuniversechannel';
+
+// Server classes
 export * from './smartuniverse.classes.universe';
-export * from './smartuniverse.classes.universeclient';
+export * from './smartuniverse.classes.universecache';
+export * from './smartuniverse.classes.universechannel';
 export * from './smartuniverse.classes.universemessage';
+
+export * from './interfaces';

ts/interfaces/http.interfaces.ts

@@ -0,0 +1,15 @@
+export interface IServerGetMessagesRequestBody {
+  channel: string;
+  topic?: string;
+  youngerThan: number;
+}
+
+/**
+ * the interface for a standard request
+ */
+export interface IServerPutMessageRequestBody {
+  channel: string;
+  passphrase: string;
+  message: string;
+  payload: any;
+}

ts/interfaces/index.ts

@@ -0,0 +1,3 @@
+export * from './http.interfaces';
+export * from './universechannel.interfaces';
+export * from './universemessage.interfaces';

ts/interfaces/universechannel.interfaces.ts

@@ -0,0 +1 @@
+export interface IUniverseChannel {}

ts/interfaces/universemessage.interfaces.ts

@@ -0,0 +1 @@
+export interface IUniverseMessage {}

ts/smartuniverse.classes.clientuniverse.ts

@@ -1,14 +1,16 @@
 import * as plugins from './smartuniverse.plugins';
 
+import { Objectmap } from '@pushrocks/lik';
 import { Observable } from 'rxjs';
-import { Smartsocket, SmartsocketClient } from 'smartsocket';
+import { Smartsocket, SmartsocketClient } from '@pushrocks/smartsocket';
 import * as url from 'url';
 
+import * as interfaces from './interfaces';
+
 import {
-  IServerGetMessagesRequestBody,
-  IServerPutMessageRequestBody
-} from './smartuniverse.classes.universe';
-import { UniverseMessage } from './smartuniverse.classes.universemessage';
+  ClientUniverseChannel,
+  UniverseMessage
+} from './';
 
 export interface IClientOptions {
   serverAddress: string;
@@ -18,27 +20,44 @@ export interface IClientOptions {
  * this class is for client side only!!!
  * allows connecting to a universe server
  */
-export class UniverseClient {
+export class ClientUniverse {
   public options;
-  private socketClient: plugins.smartsocket.SmartsocketClient;
-  private observableIntake: plugins.smartrx.ObservableIntake<UniverseMessage>;
+  public socketClient: plugins.smartsocket.SmartsocketClient;
+  public observableIntake: plugins.smartrx.ObservableIntake<UniverseMessage>;
+
+  public channelCache = new Objectmap<ClientUniverseChannel>();
 
   constructor(optionsArg: IClientOptions) {
     this.options = optionsArg;
   }
 
   public async sendMessage(messageArg, payloadArg) {
-    const requestBody = {
+    const requestBody: interfaces.IUniverseMessage = {
       message: messageArg,
       payload: payloadArg
     };
+    const requestBodyString = JSON.stringify(requestBody);
     // TODO: User websocket connection if available
-    await plugins.smartrequest.post(this.options.serverAddress, {
-      requestBody
+    const response = await plugins.smartrequest.postJson(`${this.options.serverAddress}/sendmessage` , {
+      requestBody: requestBodyString
     });
   }
 
-  public getMessageObservable() {
+  public async getChannel(channelName: string, passphrase): Promise<ClientUniverseChannel> {
+    await this.checkConnection();
+    const clientUniverseChannel = await ClientUniverseChannel.createClientUniverseChannel(
+      this,
+      channelName
+    );
+    this.channelCache.add(clientUniverseChannel);
+    return clientUniverseChannel;
+  }
+
+  public close() {
+    this.socketClient.disconnect();
+  }
+
+  private async checkConnection() {
     if (!this.socketClient && !this.observableIntake) {
       const parsedURL = url.parse(this.options.serverAddress);
       this.socketClient = new SmartsocketClient({
@@ -51,10 +70,5 @@ export class UniverseClient {
       this.observableIntake = new plugins.smartrx.ObservableIntake();
       this.socketClient.connect();
     }
-    return this.observableIntake.observable;
-  }
-
-  public close() {
-    this.socketClient.disconnect();
   }
 }

ts/smartuniverse.classes.clientuniversechannel.ts

@@ -0,0 +1,35 @@
+import * as plugins from './smartuniverse.plugins';
+import * as interfaces from './interfaces';
+
+import { ClientUniverse } from './';
+
+export class ClientUniverseChannel implements interfaces.IUniverseChannel {
+  // ======
+  // STATIC
+  // ======
+  public static async createClientUniverseChannel(
+    clientUniverseArg: ClientUniverse,
+    channelName: string
+  ): Promise<ClientUniverseChannel> {
+    const clientChannel = new ClientUniverseChannel(clientUniverseArg);
+    await clientChannel.transmitSubscription();
+    return clientChannel;
+  }
+
+  // ========
+  // INSTANCE
+  // ========
+
+  public clientUniverse: ClientUniverse;
+
+  constructor(clientUniverseArg: ClientUniverse) {
+    this.clientUniverse = clientUniverseArg;
+  }
+
+  /**
+   * tells the universe about this instances interest into a channel
+   */
+  public async transmitSubscription() {
+    this.clientUniverse.socketClient;
+  }
+}

ts/smartuniverse.classes.clientuniversemessage.ts

@@ -0,0 +1,21 @@
+import * as plugins from './smartuniverse.plugins';
+
+import * as interfaces from './interfaces';
+
+export class ClientUniverseMessage implements interfaces.IUniverseMessage {
+  // ======
+  // STATIC
+  // ======
+  public static createMessageFromPayload(messageArg: string, payloadArg: any) {
+
+  };
+
+  // ========
+  // INSTANCE
+  // ========
+  constructor(messageArg, payloadArg) {}
+
+  getAsJsonForPayload () {
+
+  }
+}

ts/smartuniverse.classes.manager.ts

@@ -1,22 +0,0 @@
-import * as plugins from './smartuniverse.plugins';
-
-import { Objectmap } from 'lik';
-import { UniverseChannel } from './smartuniverse.classes.universechannel';
-
-export class UniverseManager {
-  public channelStore = new Objectmap<UniverseChannel>();
-
-  /**
-   * register a new member
-   */
-  public async registerMember() {}
-
-  /**
-   * register a new channel within the universe
-   * @param channelName the name of the channel
-   * @param authSecret the secret against which to verify members of the channel
-   */
-  public async registerChannel(channelName: string, authSecret: string) {
-    
-  }
-}

ts/smartuniverse.classes.universe.ts

@@ -1,40 +1,38 @@
 import * as plugins from './smartuniverse.plugins';
 
-import { Handler, Route, Server } from 'smartexpress';
-
-import { UniverseManager } from './smartuniverse.classes.manager';
-import { UniverseChannel } from './smartuniverse.classes.universechannel';
-import { UniverseMessage } from './smartuniverse.classes.universemessage';
-import { UniverseStore } from './smartuniverse.classes.universestore';
+import { Handler, Route, Server } from '@pushrocks/smartexpress';
+import { UniverseCache, UniverseChannel, UniverseMessage } from './';
 
 import * as paths from './smartuniverse.paths';
 
+import * as interfaces from './interfaces';
+
 export interface ISmartUniverseConstructorOptions {
   messageExpiryInMilliseconds: number;
 }
 
-export interface IServerGetMessagesRequestBody {
-  channel: string;
-  topic?: string;
-  youngerThan: number;
-}
 
-export interface IServerPutMessageRequestBody {
-  message: string;
-  payload: any;
-}
 
+/**
+ * main class that setsup a Universe
+ */
 export class Universe {
   // subinstances
-  public universeStore: UniverseStore;
-  public universeManager: UniverseManager;
+  public universeCache: UniverseCache;
 
   // options
   private options: ISmartUniverseConstructorOptions;
 
-  // Store version handling
+  /**
+   * stores the version of the universe server running
+   * this is done since the version is exposed through the api and multiple fs actions are avoided this way.
+   */
   private universeVersionStore: string;
-  private get universeVersion() {
+
+  /**
+   * get the currently running version of smartuniverse
+   */
+  public get universeVersion() {
     if (this.universeVersionStore) {
       return this.universeVersionStore;
     } else {
@@ -44,65 +42,80 @@ export class Universe {
     }
   }
 
+  /**
+   * the smartexpress server used
+   */
   private smartexpressServer: plugins.smartexpress.Server;
+
+  /**
+   * the smartsocket used
+   */
   private smartsocket: plugins.smartsocket.Smartsocket;
 
   constructor(optionsArg: ISmartUniverseConstructorOptions) {
     this.options = optionsArg;
-    this.universeStore = new UniverseStore(this.options.messageExpiryInMilliseconds);
-    this.universeManager = new UniverseManager();
+    this.universeCache = new UniverseCache(this.options.messageExpiryInMilliseconds);
+  }
+
+  /**
+   * adds a channel to the Universe
+   */
+  public async addChannel(nameArg: string, passphraseArg: string) {
+    const newChannel = UniverseChannel.createChannel(this.universeCache, nameArg, passphraseArg);
   }
 
   /**
    * initiates a server
    */
   public async initServer(portArg: number | string) {
+    // lets create the base smartexpress server
     this.smartexpressServer = new plugins.smartexpress.Server({
       cors: true,
-      defaultAnswer: `smartuniverse server ${this.universeVersion}`,
+      defaultAnswer: async () => {
+        return `smartuniverse server ${this.universeVersion}`;
+      },
       forceSsl: false,
       port: portArg
     });
 
-    // message handling
-    // adds messages
-    const addMessageHandler = new Handler('PUT', request => {
-      const requestBody = request.body;
-      this.universeStore.addMessage(requestBody.message, requestBody.payload);
-      console.log(requestBody);
-      return true;
-    });
-
-    // gets messages
-    const readMessageHandler = new Handler('GET', request => {
-      const done = plugins.smartq.defer<UniverseMessage[]>();
-      const requestBody = request.body;
-      const messageObservable = this.universeStore.readMessagesYoungerThan(requestBody.since);
-      messageObservable.toArray().subscribe(universeMessageArrayArg => {
-        done.resolve(universeMessageArrayArg);
-      });
-      return done.promise;
-    });
-
-    // create new Route for messages
-    const messageRoute = new Route(this.smartexpressServer, 'message');
-    messageRoute.addHandler(addMessageHandler);
-    messageRoute.addHandler(readMessageHandler);
-
-    const leaderElectionRoute = new Route(this.smartexpressServer, 'leadelection');
-    // TODO: implement Handlers for leader election
+    // lets create the http request route
+    this.smartexpressServer.addRoute('/sendmessage', new Handler('POST', async (req, res) => {
+      this.universeCache.addMessage(req.body);
+    }));
 
     // add websocket upgrade
     this.smartsocket = new plugins.smartsocket.Smartsocket({
       port: 12345 // fix this within smartsocket
     });
 
-    this.smartsocket.setExternalServer('express', this.smartexpressServer as any); // should work with express as well
+    // add a role for the clients
+    const ClientRole = new plugins.smartsocket.SocketRole({
+      name: 'clientuniverse',
+      passwordHash: 'clientuniverse' // authentication happens on another level
+    });
+
+    // add the role to smartsocket
+    this.smartsocket.addSocketRoles([ClientRole]);
+
+    const SubscriptionSocketFunction = new plugins.smartsocket.SocketFunction({
+      allowedRoles: [ClientRole],
+      funcName: 'channelSubscription',
+      funcDef: () => {} // TODO: implement an action upon connection of clients
+    });
+
+    // add smartsocket to the running smartexpress app
+    this.smartsocket.setExternalServer('express', this.smartexpressServer as any);
+
+    // start the socket
     this.smartsocket.start();
 
+    // start the smartexpress instance
     await this.smartexpressServer.start();
   }
 
+  /**
+   * stop everything
+   */
   public async stopServer() {
     await this.smartsocket.stop();
     await this.smartexpressServer.stop();

ts/smartuniverse.classes.universecache.ts

@@ -0,0 +1,63 @@
+import * as plugins from './smartuniverse.plugins';
+
+import { UniverseChannel } from './smartuniverse.classes.universechannel';
+import { UniverseMessage } from './smartuniverse.classes.universemessage';
+
+import { Objectmap } from '@pushrocks/lik';
+
+import { Observable, from } from 'rxjs';
+import { filter } from 'rxjs/operators';
+import { rxjs } from '@pushrocks/smartrx';
+
+/**
+ * universe store handles the creation, storage and retrieval of messages.
+ */
+export class UniverseCache {
+  // ========
+  // INSTANCE
+  // ========
+  public standardMessageExpiry: number;
+  public destructionTime: number = 60000;
+
+  /**
+   * stores messages for this instance
+   */
+  public messageMap = new Objectmap<UniverseMessage>();
+
+  /**
+   * stores the channels that are available within the universe
+   */
+  public channelMap = new Objectmap<UniverseChannel>();
+
+  /**
+   * allows messages to be processed in a blacklist mode for further analysis
+   */
+  public blackListChannel = new UniverseChannel(this, 'blacklist', 'nada');
+
+  constructor(standardMessageExpiryArg: number) {
+    this.standardMessageExpiry = standardMessageExpiryArg;
+  }
+
+  /**
+   * add a message to the UniverseCache
+   * @param messageArg
+   * @param attachedPayloadArg
+   */
+  public async addMessage(messageArg: UniverseMessage) {
+    messageArg.setUniverseCache(this);
+    UniverseChannel.authorizeAMessageForAChannel(this, messageArg);
+    this.messageMap.add(messageArg);
+  }
+
+  /**
+   * Read a message from the UniverseCache
+   */
+  public readMessagesYoungerThan(unixTimeArg?: number): Observable<UniverseMessage> {
+    const messageObservable = from(this.messageMap.getArray()).pipe(
+      filter(messageArg => {
+        return messageArg.timestamp.isYoungerThanMilliSeconds(this.destructionTime);
+      })
+    );
+    return messageObservable;
+  }
+}

ts/smartuniverse.classes.universechannel.ts

@@ -1,32 +1,92 @@
 import * as plugins from './smartuniverse.plugins';
 
-import { Objectmap } from 'lik';
+import { Objectmap } from '@pushrocks/lik';
+import { UniverseCache } from './smartuniverse.classes.universecache';
+import { UniverseMessage } from './smartuniverse.classes.universemessage';
 
 /**
  * enables messages to stay within a certain scope.
  */
 export class UniverseChannel {
-  /**
-   * stores the channels that are available within the universe
-   */
-  public static channelStore = new Objectmap();
+  // ======
+  // STATIC
+  // ======
 
   /**
    * creates new channels
    * @param channelArg the name of the topic
-   * @param secretArg the secret thats used for a certain topic.
+   * @param passphraseArg the secret thats used for a certain topic.
    */
-  public static createChannel = (channelArg: string, secretArg: string) => {
-
+  public static createChannel(
+    universeCacheArg: UniverseCache,
+    channelNameArg: string,
+    passphraseArg: string
+  ) {
+    const newChannel = new UniverseChannel(universeCacheArg, channelNameArg, passphraseArg);
+    universeCacheArg.channelMap.add(newChannel);
+    return newChannel;
   }
 
-  credentials: {
-    user: string;
-    password: string;
-  };
+  /**
+   * returns boolean wether certain channel exists
+   */
+  public static async doesChannelExists(universeCacheArg: UniverseCache, channelNameArg: string) {
+    const channel = universeCacheArg.channelMap.find(channelArg => {
+      return channelArg.name === channelNameArg;
+    });
+    if (channel) {
+      return true;
+    } else {
+      return false;
+    }
+  }
+
+  public static authorizeAMessageForAChannel(
+    universeCacheArg: UniverseCache,
+    universeMessageArg: UniverseMessage
+  ) {
+    const foundChannel = universeCacheArg.channelMap.find(universeChannel => {
+      const result = universeChannel.authenticate(universeMessageArg);
+      return result;
+    });
+    if (foundChannel) {
+      universeMessageArg.authenticated = true;
+      universeMessageArg.universeChannelList.add(foundChannel);
+      return foundChannel;
+    } else {
+      universeMessageArg.authenticated = false;
+      universeMessageArg.universeChannelList.add(universeCacheArg.blackListChannel);
+    }
+  }
+
+  // ========
+  // INSTANCE
+  // ========
+  /**
+   * the name of the channel
+   */
+  public name: string;
+  public universeCacheInstance: UniverseCache;
+
+  /**
+   * the passphrase for the channel
+   */
+  public passphrase: string;
+
+  constructor(universeCacheArg: UniverseCache, channelNameArg: string, passphraseArg: string) {
+    this.name = channelNameArg;
+    this.passphrase = passphraseArg;
+  }
 
   /**
    * authenticates a client on the server side
    */
-  async authenticateClient() {}
+  public authenticate(universeMessageArg: UniverseMessage): boolean {
+    return (
+      this.name === universeMessageArg.requestedChannelName &&
+      this.passphrase === universeMessageArg.requestedChannelPassphrase
+    );
+  }
+
+  public pushToClients(messageArg: UniverseMessage) {}
 }

ts/smartuniverse.classes.universemessage.ts

@@ -1,10 +1,15 @@
 import * as plugins from './smartuniverse.plugins';
 
-import { Timer, TimeStamp } from 'smarttime';
-import { UniverseStore } from './smartuniverse.classes.universestore';
+import { Objectmap } from '@pushrocks/lik';
+
+import { Timer, TimeStamp } from '@pushrocks/smarttime';
+import { Universe } from './smartuniverse.classes.universe';
+import { UniverseChannel } from './smartuniverse.classes.universechannel';
+import { UniverseCache } from './smartuniverse.classes.universecache';
 
 /**
  * represents a message within a universe
+ * acts as a container to save message states like authentication status
  */
 export class UniverseMessage {
   /**
@@ -14,36 +19,97 @@ export class UniverseMessage {
    * avoids duplications though
    */
   public id: number;
-  public universeStore: UniverseStore;
-  public timestamp: TimeStamp; // when has this message been created
-  public topic: string; // enables unprotected grouping of messages for efficiency purposes.
-  public message: string; // the actual message
-  public attachedPayload: any; // any attached payloads. Can be of binary format.
+
+  /**
+   * the UniverseCache the message is attached to
+   */
+  public universeCache: UniverseCache;
+
+  /**
+   * requestedChannelName
+   */
+  public requestedChannelName: string;
+  public requestedChannelPassphrase: string;
+
+  /**
+   * enables unprotected grouping of messages for efficiency purposes.
+   */
+  public universeChannelList = new Objectmap<UniverseChannel>();
+
+  /**
+   * wether the message is authenticated
+   */
+  public authenticated: boolean = null;
+
+  /**
+   * time of creation
+   */
+  public timestamp: TimeStamp;
+
+  /**
+   * the actual message
+   */
+  public message: string;
+
+  /**
+   * any attached payloads. Can be of binary format.
+   */
+  public attachedPayload: any;
   public destructionTimer: Timer; // a timer to take care of message destruction
 
   /**
    * the constructor to create a universe message
-   * @param parentUniverseStore
-   * @param messageArg 
-   * @param attachedPayloadArg 
-   * @param selfdestructAfterArg 
+   * @param messageArg
+   * @param attachedPayloadArg
    */
   constructor(
-    parentUniverseStore: UniverseStore,
     messageArg: string,
-    attachedPayloadArg: any,
-    selfdestructAfterArg: number
+    requestedChannelNameArg: string,
+    passphraseArg: string,
+    attachedPayloadArg: any
   ) {
-    this.universeStore = parentUniverseStore;
     this.timestamp = new TimeStamp();
     this.message = messageArg;
+    this.requestedChannelName = requestedChannelNameArg;
+    this.requestedChannelPassphrase = passphraseArg;
     this.attachedPayload = attachedPayloadArg;
-    this.destructionTimer = new Timer(selfdestructAfterArg);
-    this.destructionTimer.start();
+    // prevent memory issues
+    this.fallBackDestruction();
+  }
 
-    // set up self destruction by removing this from the parent messageStore
-    this.destructionTimer.completed.then(async () => {
-      this.universeStore.messageStore.remove(this);
+  public setUniverseCache(universeCacheArg: UniverseCache) {
+    this.universeCache = universeCacheArg;
+  }
+
+  public setDestructionTimer(selfdestructAfterArg: number) {
+    if (selfdestructAfterArg) {
+      this.destructionTimer = new Timer(selfdestructAfterArg);
+      this.destructionTimer.start();
+
+      // set up self destruction by removing this from the parent messageCache
+      this.destructionTimer.completed.then(async () => {
+        this.universeCache.messageMap.remove(this);
+      });
+    } else {
+      this.fallBackDestruction();
+    }
+  }
+
+  /**
+   * handles bad messages for further analysis
+   */
+  handleAsBadMessage() {
+    console.log('received a bad message');
+  }
+
+  /**
+   * prevents memory leaks if channels have no default
+   */
+  private fallBackDestruction() {
+    plugins.smartdelay.delayFor(1000).then(() => {
+      if (!this.destructionTimer) {
+        this.setDestructionTimer(6000);
+      }
     });
   }
 }

ts/smartuniverse.classes.universestore.ts

@@ -1,45 +0,0 @@
-import * as plugins from './smartuniverse.plugins';
-
-import { UniverseMessage } from './smartuniverse.classes.universemessage';
-
-import { Objectmap } from 'lik';
-
-import { Observable } from 'rxjs';
-import { rxjs } from 'smartrx';
-
-/**
- * universe store handles the creation, storage and retrieval of messages.
- */
-export class UniverseStore {
-  public standardMessageExpiry: number;
-  public destructionTime: number = 60000;
-  public messageStore = new Objectmap<UniverseMessage>();
-  private lastId: number = 0; // stores the last id
-
-  constructor(standardMessageExpiryArg: number) {
-    this.standardMessageExpiry = standardMessageExpiryArg;
-  }
-
-  /**
-   * add a message to the UniverseStore
-   * @param messageArg
-   * @param attachedPayloadArg
-   */
-  public addMessage(messageArg, attachedPayloadArg) {
-    this.messageStore.add(
-      new UniverseMessage(this, messageArg, attachedPayloadArg, this.destructionTime)
-    );
-  }
-
-  /**
-   * Read a message from the UniverseStore
-   */
-  public readMessagesYoungerThan(unixTimeArg?: number): Observable<UniverseMessage> {
-    const messageObservable = rxjs.Observable.from(this.messageStore.getArray()).filter(
-      messageArg => {
-        return messageArg.timestamp.isYoungerThanMilliSeconds(this.destructionTime);
-      }
-    );
-    return messageObservable;
-  }
-}

ts/smartuniverse.cli.ts

@@ -1,14 +0,0 @@
-import * as plugins from './smartuniverse.plugins';
-
-import { Universe } from './index';
-
-process.env.CLI = 'true';
-
-const universeCli = new plugins.smartcli.Smartcli();
-
-universeCli.standardTask().then(async argvArg => {
-  const standardUniverse = new Universe({
-    messageExpiryInMilliseconds: 60000
-  });
-  await standardUniverse.initServer(8765);
-});

ts/smartuniverse.plugins.ts

@@ -1,21 +1,27 @@
-import * as lik from 'lik';
+// node native
 import * as path from 'path';
-import * as smartcli from 'smartcli';
-import * as smartexpress from 'smartexpress';
-import * as smartfile from 'smartfile';
-import * as smartq from 'smartq';
-import * as smartrequest from 'smartrequest';
-import * as smartrx from 'smartrx';
-import * as smartsocket from 'smartsocket';
-import * as smarttime from 'smarttime';
+
+export { path };
+
+// pushrocks scope
+import * as lik from '@pushrocks/lik';
+import * as smarthash from '@pushrocks/smarthash';
+import * as smartdelay from '@pushrocks/smartdelay';
+import * as smartexpress from '@pushrocks/smartexpress';
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartrx from '@pushrocks/smartrx';
+import * as smartsocket from '@pushrocks/smartsocket';
+import * as smarttime from '@pushrocks/smarttime';
 
 export {
   lik,
-  path,
-  smartcli,
+  smarthash,
+  smartdelay,
   smartexpress,
   smartfile,
-  smartq,
+  smartpromise,
   smartrx,
   smartrequest,
   smartsocket,

tslint.json

@@ -1,12 +1,17 @@
 {
-  "extends": [
-    "tslint:latest",
-    "tslint-config-prettier"
-  ],
+  "extends": ["tslint:latest", "tslint-config-prettier"],
   "rules": {
-    "semicolon": [
-      true,
-      "always"
-    ]
-  }
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
 }