1.0.46

.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,40 @@
 {
   "name": "@pushrocks/smartuniverse",
-  "version": "1.0.14",
+  "version": "1.0.46",
+  "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/)",
+    "testManual": "(tsrun test/test.ts)",
+    "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.7",
+    "tslint": "^5.16.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.19",
+    "@pushrocks/smartfile": "^7.0.2",
+    "@pushrocks/smarthash": "^2.0.4",
+    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartrequest": "^1.1.15",
+    "@pushrocks/smartrx": "^2.0.3",
+    "@pushrocks/smartsocket": "^1.1.35",
+    "@pushrocks/smarttime": "^3.0.7",
+    "@pushrocks/smartunique": "^3.0.1"
   }
 }

readme.md

@@ -1,33 +1,55 @@
-# 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 is 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)
+### Server side
+
+every universe has a server that manages messages.  
+Think Kafka, but without Kafka.
+
+```typescript
+import * as smartuniverse from '@pushrocks/smartuniverse';
+
+const myUniverse = new smartuniverse.Universe({
+  messageExpiryInMilliseconds: 60000 // the standard time in milliseconds until a message expires
+});
+
+// create as many channels as you like
+myUniverse.addChannel('awesomeChannel', 'awesomeChannelPass');
+myUniverse.addChannel('awesomeChannel2', 'jhkjhfsdf87eerkjslkfja9');
+
+myUniverse.start(8765); // start the server and provide the port on which to listen on
+```
+
+### Client side
+
+All your microservices represents clients in the universe that may talk to each other using the universe server.
+
+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,22 @@
 // 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 testClientUniverse: smartuniverse.ClientUniverse;
+let testClientUniverse2: smartuniverse.ClientUniverse;
+let testClientChannel: smartuniverse.ClientUniverseChannel;
+
+const testServerData = {
+  serverAddress: 'http://localhost:8765'
+};
+
+const testChannelData = {
+  channelName: 'awesomeTestChannel',
+  channelPass: 'awesomeChannelPAss'
+};
 
 tap.test('first test', async () => {
   testUniverse = new smartuniverse.Universe({
@@ -15,31 +25,53 @@ tap.test('first test', async () => {
 });
 
 tap.test('add a message to the SmartUniverse', async () => {
-  await testUniverse.initServer(8765);
+  await testUniverse.start(8765);
 });
 
 // testing message handling
 tap.test('create smartuniverse client', async () => {
-  testUniverseClient = new smartuniverse.UniverseClient({
-    serverAddress: 'http://localhost:8765'
+  testClientUniverse = new smartuniverse.ClientUniverse({
+    serverAddress: testServerData.serverAddress
   });
-  expect(testUniverseClient).to.be.instanceof(smartuniverse.UniverseClient);
+  expect(testClientUniverse).to.be.instanceof(smartuniverse.ClientUniverse);
 });
 
-tap.test('should send a message correctly', async () => {
-  await testUniverseClient.sendMessage('greeting', {
-    anyBool: true
-  });
+tap.test('should add a channel to the universe', async () => {
+  await testUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
+});
+
+tap.test('should add the same channel to the client universe in the same way', async () => {
+  await testClientUniverse.addChannel(testChannelData.channelName, testChannelData.channelPass);
 });
 
 tap.test('should get a observable correctly', async () => {
-  testMessageObservable = testUniverseClient.getMessageObservable();
+  testClientChannel = await testClientUniverse.getChannel(testChannelData.channelName);
+  expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
+});
+
+tap.test('should send a message correctly', async () => {
+  await testClientUniverse.sendMessage({
+    messageText: 'hello',
+    targetChannelName: testChannelData.channelName
+  });
+});
+
+tap.test('universe should contain the sent message', async () => {
+  expect(testUniverse.universeCache.messageMap.getArray()[0].messageText).to.equal('hello');
+});
+
+tap.test('a second client should be able to subscibe', async () => {
+  testClientUniverse2 = new smartuniverse.ClientUniverse({
+    serverAddress: testServerData.serverAddress
+  });
+
+  testClientUniverse2.addChannel(testChannelData.channelName, testChannelData.channelPass);
 });
 
 tap.test('should receive a message correctly', async () => {});
 
 tap.test('should disconnect the client correctly', async () => {
-  testUniverseClient.close();
+  testClientUniverse.close();
 });
 
 tap.test('should end the server correctly', async tools => {

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,4 @@
+export * from './http.interfaces';
+export * from './universechannel.interfaces';
+export * from './universemessage.interfaces';
+export * from './universeactions.interfaces';

ts/interfaces/universeactions.interfaces.ts

@@ -0,0 +1,13 @@
+export type IServerCallActions = 'subscribe' | 'sendmessage' | 'unsubscribe';
+
+/**
+ * the interface for a subscription
+ */
+export interface IServerCallSubscribeActionPayload {
+  name: string;
+  passphrase: string;
+}
+
+export interface IServerUnsubscribeActionPayload {
+  name: string;
+}

ts/interfaces/universechannel.interfaces.ts

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

ts/interfaces/universemessage.interfaces.ts

@@ -0,0 +1,15 @@
+export interface IMessageCreator {
+  messageText: string;
+  payload?: string | number | any;
+  payloadStringType?: 'Buffer' | 'string' | 'object';
+  targetChannelName: string;
+}
+
+export interface IUniverseMessage extends IMessageCreator {
+  id: string;
+  /**
+   * time of creation
+   */
+  timestamp: number;
+  passphrase: string;
+}

ts/smartuniverse.classes.clientuniverse.ts

@@ -0,0 +1,142 @@
+import * as plugins from './smartuniverse.plugins';
+
+import { Objectmap } from '@pushrocks/lik';
+import { Observable } from 'rxjs';
+import { Smartsocket, SmartsocketClient } from '@pushrocks/smartsocket';
+import * as url from 'url';
+
+import * as interfaces from './interfaces';
+
+import { ClientUniverseChannel, UniverseMessage } from './';
+import {
+  ClientUniverseCache
+} from './smartuniverse.classes.clientuniversecache';
+
+export interface IClientOptions {
+  serverAddress: string;
+}
+
+/**
+ * this class is for client side only!!!
+ * allows connecting to a universe server
+ */
+export class ClientUniverse {
+  public options;
+  public smartsocketClient: plugins.smartsocket.SmartsocketClient;
+  public observableIntake: plugins.smartrx.ObservableIntake<UniverseMessage>;
+
+  public channelStore = new Objectmap<ClientUniverseChannel>();
+  public clientUniverseCache = new ClientUniverseCache();
+
+  constructor(optionsArg: IClientOptions) {
+    this.options = optionsArg;
+  }
+
+  /**
+   * adds a channel to the channelcache
+   * TODO: verify channel before adding it to the channel cache
+   */
+  public async addChannel(channelNameArg: string, passphraseArg: string) {
+    const existingChannel = await this.getChannel(channelNameArg);
+
+    if (existingChannel) {
+      throw new Error('channel exists');
+    }
+
+    // lets create the channel
+    ClientUniverseChannel.createClientUniverseChannel(this, channelNameArg, passphraseArg);
+  }
+
+  /**
+   * gets a channel from the channelcache
+   * @param channelName
+   * @param passphraseArg
+   */
+  public async getChannel(channelName: string): Promise<ClientUniverseChannel> {
+    await this.checkConnection();
+    const clientUniverseChannel = this.channelStore.find(channel => {
+      return channel.name === channelName;
+    });
+    return clientUniverseChannel;
+  }
+
+  /**
+   * remove a a achannel
+   * @param messageArg
+   */
+  public removeChannel(channelNameArg, notifyServer = true) {
+    const clientUniverseChannel = this.channelStore.findOneAndRemove(channelItemArg => {
+      return channelItemArg.name === channelNameArg;
+    });
+  }
+
+
+  /**
+   * sends a message towards the server
+   * @param messageArg 
+   */
+  public async sendMessage(messageArg: interfaces.IMessageCreator) {
+    await this.checkConnection();
+    const requestBody: interfaces.IUniverseMessage = {
+      id: plugins.smartunique.shortId(),
+      timestamp: Date.now(),
+      passphrase: (await this.getChannel(messageArg.targetChannelName)).passphrase,
+      ...messageArg
+    };
+    // TODO: User websocket connection if available
+    const response = await plugins.smartrequest.postJson(
+      `${this.options.serverAddress}/sendmessage`,
+      {
+        requestBody
+      }
+    );
+  }
+
+  public close() {
+    this.smartsocketClient.disconnect();
+  }
+
+  /**
+   * checks the connection towards a universe server
+   * since password validation is done through other means, a connection should always be possible
+   */
+  private async checkConnection(): Promise<void> {
+    if (!this.smartsocketClient && !this.observableIntake) {
+      const parsedURL = url.parse(this.options.serverAddress);
+      const socketConfig: plugins.smartsocket.ISmartsocketClientOptions = {
+        alias: process.env.SOCKET_ALIAS || 'someclient',
+        password: 'UniverseClient',
+        port: parseInt(parsedURL.port, 10),
+        role: 'UniverseClient',
+        url: parsedURL.protocol + '//' + parsedURL.hostname
+      };
+      console.log(socketConfig);
+      this.smartsocketClient = new SmartsocketClient(socketConfig);
+      this.observableIntake = new plugins.smartrx.ObservableIntake();
+
+      // lets define some basic actions
+
+      /**
+       * should handle a forced unsubscription by the server
+       */
+      const unsubscribe = new plugins.smartsocket.SocketFunction({
+        funcName: 'unsubscribe',
+        allowedRoles: [],
+        funcDef: async (data: interfaces.IServerUnsubscribeActionPayload) => {
+          
+        },
+      });
+
+      /**
+       * should handle a message reception
+       */
+      const receiveMessage = async () => {
+
+      };
+
+      
+
+      await this.smartsocketClient.connect();
+    }
+  }
+}

ts/smartuniverse.classes.clientuniversecache.ts

@@ -0,0 +1,8 @@
+import * as plugins from './smartuniverse.plugins';
+
+/**
+ * a cache for clients
+ */
+export class ClientUniverseCache {
+  
+}

ts/smartuniverse.classes.clientuniversechannel.ts

@@ -0,0 +1,60 @@
+import * as plugins from './smartuniverse.plugins';
+import * as interfaces from './interfaces';
+
+import { ClientUniverse } from './';
+
+export class ClientUniverseChannel implements interfaces.IUniverseChannel {
+  // ======
+  // STATIC
+  // ======
+  /**
+   * creates a channel and adds it to the cache of clientUniverseArg
+   * @param clientUniverseArg
+   * @param channelNameArg
+   * @param passphraseArg
+   */
+  public static async createClientUniverseChannel(
+    clientUniverseArg: ClientUniverse,
+    channelNameArg: string,
+    passphraseArg: string
+  ): Promise<ClientUniverseChannel> {
+    const clientChannel = new ClientUniverseChannel(
+      clientUniverseArg,
+      channelNameArg,
+      passphraseArg
+    );
+    clientUniverseArg.channelStore.add(clientChannel);
+    await clientChannel.subscribe();
+    return clientChannel;
+  }
+
+  // ========
+  // INSTANCE
+  // ========
+
+  // properties
+  public name: string;
+  public passphrase: string;
+
+  // refs
+  public clientUniverse: ClientUniverse;
+
+  constructor(clientUniverseArg: ClientUniverse, nameArg: string, passphraseArg: string) {
+    this.clientUniverse = clientUniverseArg;
+    this.name = nameArg;
+    this.passphrase = passphraseArg;
+  }
+
+  /**
+   * subscribes to a channel
+   * tells the universe about this instances interest into a channel
+   */
+  public async subscribe() {
+    const serverCallActionName: interfaces.IServerCallActions = 'subscribe';
+    const serverCallActionPayload: interfaces.IServerCallSubscribeActionPayload = {
+      name: this.name,
+      passphrase: this.passphrase
+    };
+    this.clientUniverse.smartsocketClient.serverCall(serverCallActionName, serverCallActionPayload);
+  }
+}

ts/smartuniverse.classes.clientuniversemessage.ts

@@ -0,0 +1,34 @@
+import * as plugins from './smartuniverse.plugins';
+
+import * as interfaces from './interfaces';
+import { IUniverseMessage } from './interfaces';
+
+export class ClientUniverseMessage implements interfaces.IUniverseMessage {
+  // ======
+  // STATIC
+  // ======
+  public static createMessageFromPayload(messageDescriptor: interfaces.IUniverseMessage) {}
+
+  // ========
+  // INSTANCE
+  // ========
+
+  // properties
+  public id: string;
+
+  public timestamp: number;
+  public smartTimestamp: plugins.smarttime.TimeStamp;
+  public messageText: string;
+  public passphrase: string;
+  public payload: any;
+  public payloadStringType;
+  public targetChannelName: string;
+
+  constructor(messageArg: IUniverseMessage, payloadArg) {
+    for (const key of Object.keys(messageArg)) {
+      this[key] = messageArg[key];
+    }
+  }
+
+  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,36 @@
 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 +40,85 @@ 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) {
+  public async start(portArg: number) {
+    // 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;
-    });
+    // lets create the http request route
+    this.smartexpressServer.addRoute(
+      '/sendmessage',
+      new Handler('POST', async (req, res) => {
+        const universeMessageInstance: UniverseMessage = new UniverseMessage(req.body);
+        this.universeCache.addMessage(universeMessageInstance);
         
-    // 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
+        res.status(200);
+        res.end();
+      })
+    );
 
     // add websocket upgrade
-    this.smartsocket = new plugins.smartsocket.Smartsocket({
-      port: 12345 // fix this within smartsocket
+    this.smartsocket = new plugins.smartsocket.Smartsocket({});
+
+    // add a role for the clients
+    const ClientRole = new plugins.smartsocket.SocketRole({
+      name: 'UniverseClient',
+      passwordHash: plugins.smarthash.sha256FromStringSync('UniverseClient') // authentication happens on another level
     });
 
-    this.smartsocket.setExternalServer('express', this.smartexpressServer as any); // should work with express as well
-    this.smartsocket.start();
+    // 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('smartexpress', this.smartexpressServer as any);
+    // start everything
     await this.smartexpressServer.start();
+    await this.smartsocket.start();
+    console.log('started universe');
+    
   }
 
+  /**
+   * 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, channelName?: string): Observable<UniverseMessage> {
+    const messageObservable = from(this.messageMap.getArray()).pipe(
+      filter(messageArg => {
+        return messageArg.smartTimestamp.isYoungerThanMilliSeconds(this.destructionTime);
+      })
+    );
+    return messageObservable;
+  }
+}

ts/smartuniverse.classes.universechannel.ts

@@ -1,32 +1,94 @@
 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.targetChannelName &&
+      this.passphrase === universeMessageArg.passphrase
+    );
+  }
+
+  public pushToClients(messageArg: UniverseMessage) {
+    
+  }
 }

ts/smartuniverse.classes.universeclient.ts

@@ -1,60 +0,0 @@
-import * as plugins from './smartuniverse.plugins';
-
-import { Observable } from 'rxjs';
-import { Smartsocket, SmartsocketClient } from 'smartsocket';
-import * as url from 'url';
-
-import {
-  IServerGetMessagesRequestBody,
-  IServerPutMessageRequestBody
-} from './smartuniverse.classes.universe';
-import { UniverseMessage } from './smartuniverse.classes.universemessage';
-
-export interface IClientOptions {
-  serverAddress: string;
-}
-
-/**
- * this class is for client side only!!!
- * allows connecting to a universe server
- */
-export class UniverseClient {
-  public options;
-  private socketClient: plugins.smartsocket.SmartsocketClient;
-  private observableIntake: plugins.smartrx.ObservableIntake<UniverseMessage>;
-
-  constructor(optionsArg: IClientOptions) {
-    this.options = optionsArg;
-  }
-
-  public async sendMessage(messageArg, payloadArg) {
-    const requestBody = {
-      message: messageArg,
-      payload: payloadArg
-    };
-    // TODO: User websocket connection if available
-    await plugins.smartrequest.post(this.options.serverAddress, {
-      requestBody
-    });
-  }
-
-  public getMessageObservable() {
-    if (!this.socketClient && !this.observableIntake) {
-      const parsedURL = url.parse(this.options.serverAddress);
-      this.socketClient = new SmartsocketClient({
-        alias: process.env.SOCKET_ALIAS || 'someclient',
-        password: 'UniverseClient',
-        port: parseInt(parsedURL.port, 10),
-        role: 'UniverseClient',
-        url: parsedURL.hostname
-      });
-      this.observableIntake = new plugins.smartrx.ObservableIntake();
-      this.socketClient.connect();
-    }
-    return this.observableIntake.observable;
-  }
-
-  public close() {
-    this.socketClient.disconnect();
-  }
-}

ts/smartuniverse.classes.universemessage.ts

@@ -1,49 +1,98 @@
 import * as plugins from './smartuniverse.plugins';
+import * as interfaces from './interfaces';
 
-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';
+import { IUniverseMessage } from './interfaces';
 
 /**
  * represents a message within a universe
+ * acts as a container to save message states like authentication status
  */
-export class UniverseMessage {
+export class UniverseMessage implements interfaces.IUniverseMessage {
+  public id: string;
+
+  public timestamp: number;
+  public smartTimestamp: TimeStamp;
+
+  public messageText: string;
+  public passphrase: string;
+  public payload: any;
+  public payloadStringType;
+  public targetChannelName: string;
+
   /**
-   * public and unique id
-   * numeric ascending
-   * adheres to time in milliseconds
-   * avoids duplications though
+   * the UniverseCache the message is attached to
+   */
+  public universeCache: UniverseCache;
+
+  /**
+   * enables unprotected grouping of messages for efficiency purposes.
+   */
+  public universeChannelList = new Objectmap<UniverseChannel>();
+
+  /**
+   * wether the message is authenticated
+   */
+  public authenticated: boolean = null;
+
+  /**
+   * a destruction timer for this message
    */
-  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.
   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 
    */
-  constructor(
-    parentUniverseStore: UniverseStore,
-    messageArg: string,
-    attachedPayloadArg: any,
-    selfdestructAfterArg: number
-  ) {
-    this.universeStore = parentUniverseStore;
-    this.timestamp = new TimeStamp();
-    this.message = messageArg;
-    this.attachedPayload = attachedPayloadArg;
+  constructor(messageDescriptor: IUniverseMessage) {
+    this.smartTimestamp = new TimeStamp(this.timestamp);
+    this.messageText = messageDescriptor.messageText;
+    this.targetChannelName = messageDescriptor.targetChannelName;
+    this.passphrase = messageDescriptor.passphrase;
+    this.payload = messageDescriptor.payload;
+    // prevent memory issues
+    this.fallBackDestruction();
+  }
+
+  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 messageStore
+      // set up self destruction by removing this from the parent messageCache
       this.destructionTimer.completed.then(async () => {
-      this.universeStore.messageStore.remove(this);
+        this.universeCache.messageMap.remove(this);
+      });
+    } else {
+      this.fallBackDestruction();
+    }
+  }
+
+  /**
+   * handles bad messages for further analysis
+   */
+  public 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.classes.universesubscription.ts

@@ -0,0 +1,20 @@
+import * as plugins from './smartuniverse.plugins';
+import { UniverseChannel } from './smartuniverse.classes.universechannel';
+
+
+
+/**
+ * represents a subscription into a specific topic
+ */
+export class UniverseConnection {
+  /**
+   * the socketClient to ping
+   */
+  socketclient: plugins.smartsocket.SmartsocketClient;
+  subscribedChannels: UniverseChannel[] = [];
+  authenticatedChannels: UniverseChannel[] = [];
+
+  constructor() {
+
+  }
+}

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,23 +1,31 @@
-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';
+import * as smartunique from '@pushrocks/smartunique';
 
 export {
   lik,
-  path,
-  smartcli,
+  smarthash,
+  smartdelay,
   smartexpress,
   smartfile,
-  smartq,
+  smartpromise,
   smartrx,
   smartrequest,
   smartsocket,
-  smarttime
+  smarttime,
+  smartunique
 };

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"
 }