1.0.36

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartuniverse",
-  "version": "1.0.29",
+  "version": "1.0.36",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartuniverse",
-  "version": "1.0.29",
+  "version": "1.0.36",
   "private": false,
   "description": "messaging service for your micro services",
   "main": "dist/index.js",

readme.md

@@ -1,13 +1,16 @@
 # @pushrocks/smartuniverse
+
 messaging service for micro services
 
 ## 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/)
+
+- [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)
 [![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartuniverse.svg)](https://www.npmjs.com/package/@pushrocks/smartuniverse)
@@ -20,9 +23,34 @@ messaging service for micro services
 
 Use TypeScript for best in class instellisense.
 
+### What is smartuniverse all about?
+
+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**.
+
+### 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)
+> | 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

@@ -8,6 +8,11 @@ let testUniverse: smartuniverse.Universe;
 let testUniverseClient: smartuniverse.ClientUniverse;
 let testClientChannel: smartuniverse.ClientUniverseChannel;
 
+const testChannelData = {
+  channelName: 'awesomeTestChannel',
+  channelPass: 'awesomeChannelPAss'
+}
+
 tap.test('first test', async () => {
   testUniverse = new smartuniverse.Universe({
     messageExpiryInMilliseconds: 1000
@@ -15,7 +20,7 @@ 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
@@ -31,7 +36,7 @@ tap.test('should add a channel to the universe', async () => {
 });
 
 tap.test('should get a observable correctly', async () => {
-  testClientChannel = await testUniverseClient.getChannel('testChannel');
+  testClientChannel = await testUniverseClient.getChannel(testChannelData.channelName, testChannelData.channelPass);
   expect(testClientChannel).to.be.instanceof(smartuniverse.ClientUniverseChannel);
 });
 

ts/index.ts

@@ -7,4 +7,5 @@ export * from './smartuniverse.classes.universe';
 export * from './smartuniverse.classes.universecache';
 export * from './smartuniverse.classes.universechannel';
 export * from './smartuniverse.classes.universemessage';
-export * from './smartuniverse.interfaces';
+
+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,7 @@
+export interface IUniverseMessage {
+  messageText: string;
+  targetChannelName: string;
+  passphrase: string;
+  payload?: string | number | any;
+  payloadStringType?: 'Buffer' | 'string' | 'object';
+}

ts/smartuniverse.classes.clientuniverse.ts

@@ -5,10 +5,10 @@ import { Observable } from 'rxjs';
 import { Smartsocket, SmartsocketClient } from '@pushrocks/smartsocket';
 import * as url from 'url';
 
+import * as interfaces from './interfaces';
+
 import {
   ClientUniverseChannel,
-  IServerGetMessagesRequestBody,
-  IServerPutMessageRequestBody,
   UniverseMessage
 } from './';
 
@@ -31,18 +31,16 @@ export class ClientUniverse {
     this.options = optionsArg;
   }
 
-  public async sendMessage(messageArg, payloadArg) {
-    const requestBody = {
-      message: messageArg,
-      payload: payloadArg
-    };
+  public async sendMessage(messageArg: interfaces.IUniverseMessage) {
+    const requestBody: interfaces.IUniverseMessage = messageArg;
+    const requestBodyString = JSON.stringify(requestBody);
     // TODO: User websocket connection if available
-    await plugins.smartrequest.postJson(this.options.serverAddress, {
-      requestBody
+    const response = await plugins.smartrequest.postJson(`${this.options.serverAddress}/sendmessage` , {
+      requestBody: requestBodyString
     });
   }
 
-  public async getChannel(channelName: string): Promise<ClientUniverseChannel> {
+  public async getChannel(channelName: string, passphrase): Promise<ClientUniverseChannel> {
     await this.checkConnection();
     const clientUniverseChannel = await ClientUniverseChannel.createClientUniverseChannel(
       this,

ts/smartuniverse.classes.clientuniversechannel.ts

@@ -1,8 +1,9 @@
 import * as plugins from './smartuniverse.plugins';
+import * as interfaces from './interfaces';
 
-import { ClientUniverse, IUniverseChannel } from './';
+import { ClientUniverse } from './';
 
-export class ClientUniverseChannel implements IUniverseChannel {
+export class ClientUniverseChannel implements interfaces.IUniverseChannel {
   // ======
   // STATIC
   // ======

ts/smartuniverse.classes.clientuniversemessage.ts

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

ts/smartuniverse.classes.universe.ts

@@ -5,25 +5,13 @@ 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;
-}
 
-/**
- * the interface for a standard request
- */
-export interface IServerPutMessageRequestBody {
-  channel: string;
-  passphrase: string;
-  message: string;
-  payload: any;
-}
 
 /**
  * main class that setsup a Universe
@@ -35,9 +23,16 @@ export class Universe {
   // 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 {
@@ -47,7 +42,14 @@ export class Universe {
     }
   }
 
+  /**
+   * the smartexpress server used
+   */
   private smartexpressServer: plugins.smartexpress.Server;
+
+  /**
+   * the smartsocket used
+   */
   private smartsocket: plugins.smartsocket.Smartsocket;
 
   constructor(optionsArg: ISmartUniverseConstructorOptions) {
@@ -59,14 +61,14 @@ export class Universe {
    * adds a channel to the Universe
    */
   public async addChannel(nameArg: string, passphraseArg: string) {
-    const newChannel = new UniverseChannel(this.universeCache, nameArg, passphraseArg);
-    this.universeCache.channelMap.add(newChannel);
+    const newChannel = UniverseChannel.createChannel(this.universeCache, nameArg, passphraseArg);
   }
 
   /**
    * initiates a server
    */
-  public async initServer(portArg: number | string) {
+  public async start(portArg: number | string) {
+    // lets create the base smartexpress server
     this.smartexpressServer = new plugins.smartexpress.Server({
       cors: true,
       defaultAnswer: async () => {
@@ -76,31 +78,44 @@ export class Universe {
       port: portArg
     });
 
+    // 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
     });
 
+    // 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: () => {}
+      funcDef: () => {} // TODO: implement an action upon connection of clients
     });
 
+    // add smartsocket to the running smartexpress app
     this.smartsocket.setExternalServer('express', this.smartexpressServer as any);
-    // should work with express as well
+
+    // 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

@@ -39,7 +39,7 @@ export class UniverseCache {
   }
 
   /**
-   * add a message to the UniverseStore
+   * add a message to the UniverseCache
    * @param messageArg
    * @param attachedPayloadArg
    */
@@ -50,7 +50,7 @@ export class UniverseCache {
   }
 
   /**
-   * Read a message from the UniverseStore
+   * Read a message from the UniverseCache
    */
   public readMessagesYoungerThan(unixTimeArg?: number): Observable<UniverseMessage> {
     const messageObservable = from(this.messageMap.getArray()).pipe(

ts/smartuniverse.classes.universechannel.ts

@@ -23,6 +23,7 @@ export class UniverseChannel {
     passphraseArg: string
   ) {
     const newChannel = new UniverseChannel(universeCacheArg, channelNameArg, passphraseArg);
+    universeCacheArg.channelMap.add(newChannel);
     return newChannel;
   }
 

ts/smartuniverse.classes.universemessage.ts

@@ -1,4 +1,5 @@
 import * as plugins from './smartuniverse.plugins';
+import * as interfaces from './interfaces';
 
 import { Objectmap } from '@pushrocks/lik';
 
@@ -11,12 +12,15 @@ 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 {
+export class UniverseMessage implements interfaces.IUniverseMessage {
   /**
    * public and unique id
    * numeric ascending
    * adheres to time in milliseconds
-   * avoids duplications though
+   *   -> meaning it describes the time of arrival
+   *   -> two messages received at the same time will count up the second one
+   *   -> avoids duplications of messages
+   *   -> may be changed to nanoseconds to ensure higher throughput
    */
   public id: number;
 

ts/smartuniverse.interfaces.ts

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