1.0.41

.gitignore

@@ -1,3 +1,22 @@
-docs/
+.nogit/
+
+# artifacts
 coverage/
+public/
+pages/
+
+# installs
 node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,53 +1,119 @@
-image: hosttoday/ht-docker-dbase
+# gitzone ci_default
-services:
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
-  - docker:dind
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
 
 stages:
-  - build
+- security
 - test
 - release
-  - trigger
+- metadata
 
-before_script:
+# ====================
-  - npmci prepare docker-gitlab
+# security stage
-
+# ====================
-
+mirror:
-build:
+  stage: security
-  stage: build
   script:
-    - npm install
+  - npmci git mirror
-    - npm test
-    - npmci build docker
   tags:
-    - lossless
+  - docker
-    - priv
+  - notpriv
 
+snyk:
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
+  tags:
+  - docker
+  - notpriv
 
-test:
+# ====================
+# test stage
+# ====================
+
+testLTS:
   stage: test
   script:
-    - npmci test docker
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
+  - docker
-    - priv
+  - notpriv
+
+testBuild:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
+  - notpriv
 
 release:
-  image: hosttoday/ht-docker-node:npmts
   stage: release
   script:
-    - npmci publish npm
+  - npmci node install lts
+  - npmci npm publish
   only:
   - tags
   tags:
-    - lossless
+  - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+  - docker
   - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
   - npmci trigger
   only:
   - tags
   tags:
-    - lossless
+  - docker
-    - priv
+  - notpriv
+
+pages:
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:18-dind
+  stage: metadata
+  script:
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - docker
+    - notpriv
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+    - public
+  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

Dockerfile

@@ -1,6 +0,0 @@
-FROM hosttoday/ht-docker-node:npmts
-RUN mkdir app-node
-COPY ./ /app-node/
-WORKDIR /app-node
-ENV CI true
-CMD ["npmts"]

README.md

@@ -1,28 +1,38 @@
-# dockersock
+# @mojoio/docker
-easy communication with docker from node, TypeScript ready
+unofficial docker engine api abstraction package written in TypeScript
 
-## Status
+## Availabililty and Links
-[![build status](https://gitlab.com/pushrocks/dockersock/badges/master/build.svg)](https://gitlab.com/pushrocks/dockersock/commits/master)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/docker)
+* [gitlab.com (source)](https://gitlab.com/mojoio/docker)
+* [github.com (source mirror)](https://github.com/mojoio/docker)
+* [docs (typedoc)](https://mojoio.gitlab.io/docker/)
+
+## Status for master
+[![build status](https://gitlab.com/mojoio/docker/badges/master/build.svg)](https://gitlab.com/mojoio/docker/commits/master)
+[![coverage report](https://gitlab.com/mojoio/docker/badges/master/coverage.svg)](https://gitlab.com/mojoio/docker/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/docker.svg)](https://www.npmjs.com/package/@mojoio/docker)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/docker/badge.svg)](https://snyk.io/test/npm/@mojoio/docker)
+[![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
-We recommend the use of TypeScript for best Intellisense.
 
-```TypeScript
+Use TypeScript for best in class instellisense.
-import {Dockersock} from "dockersock"; // require Dockersock class
 
-let myDockersock = new Dockersock(); // optional: you can pass a domain to the contructor, defaults to  /var/run/docker.sock
+```typescript
+import { DockerHost } from '@mojoio/docker'; // require Dockersock class
 
-myDockersock.listContainers() // promise, resolve gets container data
+const run = async () => {
-myDockersock.listContainersDetailed() // promise, resolve gets more detailed container data (by combining several requests internally)
+  const myDockerHost = new DockerHost(); // optional: you can pass a domain to the contructor, defaults to  /var/run/docker.sock
-myDockersock.listContainersRunning() // promise, resolve gets container data for currently running containers
-myDockersock.listContainersStopped() // promise, resolve gets container data for stopped containers
-
-myDockersock.startContainer({ // starts a already present container
-    name: "somecontainername"
-})
-
-myDockersock.newContainer({ // start new Container, equals "docker run" shell command
-    image: "someimagetag"
-})
 
+  const containers = await myDockerHost.getContainers(); // promise, resolve with an array of DockerContainers
+};
 ```
+
+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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

dist/dockersock.classes.dockersock.d.ts

@@ -1,26 +0,0 @@
-/// <reference types="q" />
-import "typings-global";
-import * as plugins from "./dockersock.plugins";
-import { Observable } from "rxjs";
-export declare class Dockersock {
-    sockPath: string;
-    constructor(pathArg?: string);
-    auth(userArg: string, passArg: string): plugins.q.Promise<{}>;
-    listContainers(): plugins.q.Promise<{}>;
-    listContainersDetailed(): plugins.q.Promise<{}>;
-    listContainersRunning(): plugins.q.Promise<{}>;
-    listContainersStopped(): plugins.q.Promise<{}>;
-    listImages(): plugins.q.Promise<{}>;
-    listImagesDangling(): plugins.q.Promise<{}>;
-    pullImage(imageLabelArg: string): plugins.q.Promise<{}>;
-    createContainer(optionsArg: any, pullFirstArg?: boolean): plugins.q.Promise<{}>;
-    getContainerId(): void;
-    startContainer(containerNameArg: any): plugins.q.Promise<{}>;
-    stopContainer(containerNameArg: any): plugins.q.Promise<{}>;
-    removeContainer(containerNameArg: any): plugins.q.Promise<{}>;
-    clean(): plugins.q.Promise<{}>;
-    callOnChange(cb: Function): void;
-    getChangeObservable(): Observable<{}>;
-    request(methodArg: string, routeArg: string, queryArg?: string, dataArg?: {}): plugins.q.Promise<{}>;
-    requestStream(methodArg: string, routeArg: string, queryArg?: string, dataArg?: {}): plugins.q.Promise<{}>;
-}

dist/dockersock.plugins.d.ts

@@ -1,5 +0,0 @@
-import "typings-global";
-export import beautylog = require("beautylog");
-export import q = require("q");
-export import request = require("request");
-export import rxjs = require("rxjs");

dist/dockersock.plugins.js

@@ -1,7 +0,0 @@
-"use strict";
-require("typings-global");
-exports.beautylog = require("beautylog");
-exports.q = require("q");
-exports.request = require("request");
-exports.rxjs = require("rxjs");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZG9ja2Vyc29jay5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvZG9ja2Vyc29jay5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFDVixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ2pDLFNBQUMsV0FBVyxHQUFHLENBQUMsQ0FBQztBQUNqQixlQUFPLFdBQVcsU0FBUyxDQUFDLENBQUM7QUFDN0IsWUFBSSxXQUFXLE1BQU0sQ0FBQyxDQUFDIn0=

dist/index.d.ts

@@ -1,2 +0,0 @@
-import "typings-global";
-export { Dockersock } from "./dockersock.classes.dockersock";

dist/index.js

@@ -1,5 +0,0 @@
-"use strict";
-require("typings-global");
-var dockersock_classes_dockersock_1 = require("./dockersock.classes.dockersock");
-exports.Dockersock = dockersock_classes_dockersock_1.Dockersock;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFBZ0IsQ0FBQyxDQUFBO0FBQ3hCLDhDQUF5QixpQ0FBaUMsQ0FBQztBQUFuRCxnRUFBbUQifQ==

docker-compose.yml

@@ -1,18 +1,18 @@
 nginx1 :
   image: "nginx"
   environment:
-      VIRTUAL_HOST: "test100.labkomp.de"
+      VIRTUAL_HOST: "test100.bleu.de"
   restart: always
   container_name: nginx1
 nginx2:
   image: nginx
   environment:
-    VIRTUAL_HOST: "test101.labkomp.de"
+    VIRTUAL_HOST: "test101.bleu.de"
   restart: always
   container_name: nginx2
-npmts-test-container:
+nginx3:
-  image: "npmts-test-image"
+  image: nginx
-  volumes:
+  environment:
-    - "/var/run/docker.sock:/var/run/docker.sock"
+    VIRTUAL_HOST: "test101.bleu.de"
   restart: always
-  container_name: npmts-test-container
+  container_name: nginx3

npmextra.json

@@ -1,6 +1,22 @@
 {
-    "npmts":{
+  "npmdocker": {
-        "mode":"default",
+    "baseImage": "hosttoday/ht-docker-node:npmci",
-        "coverageTreshold":10
+    "command": "(ls -a && rm -r node_modules && yarn global add npmts && yarn install && npmts)",
+    "dockerSock": true
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public",
+    "npmRegistryUrl": "registry.npmjs.org"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "mojoio",
+      "gitrepo": "docker",
+      "shortDescription": "unofficial docker engine api abstraction package written in TypeScript",
+      "npmPackagename": "@mojoio/docker",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,14 +1,13 @@
 {
-  "name": "dockersock",
+  "name": "@mojoio/docker",
-  "version": "1.0.14",
+  "version": "1.0.41",
-  "description": "easy communication with docker from node, TypeScript ready",
+  "description": "easy communication with docker remote api from node, TypeScript ready",
+  "private": false,
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "npmts --notest && npm run build && npm run startdocker && npm run cleanup",
+    "test": "tstest test/",
-    "build": "docker build -t npmts-test-image .",
+    "build": "tsbuild"
-    "startdocker": "docker run -v /var/run/docker.sock:/var/run/docker.sock --name npmts-test-container npmts-test-image",
-    "cleanup": "docker rm npmts-test-container && docker rmi npmts-test-image"
   },
   "repository": {
     "type": "git",
@@ -28,16 +27,30 @@
   },
   "homepage": "https://gitlab.com/pushrocks/dockersock#README",
   "dependencies": {
-    "@types/q": "*",
+    "@pushrocks/lik": "^3.0.10",
-    "beautylog": "^5.0.14",
+    "@pushrocks/smartlog": "^2.0.19",
-    "q": "^1.4.1",
+    "@pushrocks/smartpromise": "^3.0.2",
-    "request": "^2.73.0",
+    "@pushrocks/smartrequest": "^1.1.16",
-    "rxjs": "^5.0.0-beta.10",
+    "rxjs": "^6.5.2"
-    "typings-global": "^1.0.6"
   },
   "devDependencies": {
-    "npmts-g": "^5.2.6",
+    "@gitzone/tsbuild": "^2.1.11",
-    "should": "^9.0.2",
+    "@gitzone/tsrun": "^1.2.8",
-    "typings-test": "^1.0.1"
+    "@gitzone/tstest": "^1.0.24",
-  }
+    "@pushrocks/tapbundle": "^3.0.11",
+    "@types/node": "^12.7.1",
+    "tslint": "^5.18.0",
+    "tslint-config-prettier": "^1.18.0"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.d.ts

@@ -1,2 +0,0 @@
-import "typings-test";
-import "should";

test/test.js

@@ -1,36 +0,0 @@
-"use strict";
-require("typings-test");
-require("should");
-const index_1 = require("../dist/index");
-describe("dockersock", function () {
-    describe(".Dockersock()", function () {
-        let testDockersock;
-        it("should create a new Dockersock instance", function () {
-            testDockersock = new index_1.Dockersock();
-            testDockersock.should.be.instanceof(index_1.Dockersock);
-        });
-        it("should list containers", function (done) {
-            testDockersock.listContainers()
-                .then((dataArg) => {
-                console.log(dataArg);
-                done();
-            });
-        });
-        it("should list detailed containers", function (done) {
-            this.timeout(5000);
-            testDockersock.listContainersDetailed()
-                .then((dataArg) => {
-                console.log(dataArg);
-                done();
-            });
-        });
-        it("should pull an image from imagetag", function (done) {
-            this.timeout(60000);
-            testDockersock.pullImage("hosttoday/ht-docker-dbase")
-                .then((dataArg) => {
-                done();
-            }, done);
-        });
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUVoQix3QkFBeUIsZUFFekIsQ0FBQyxDQUZ1QztBQUV4QyxRQUFRLENBQUMsWUFBWSxFQUFDO0lBQ2xCLFFBQVEsQ0FBQyxlQUFlLEVBQUM7UUFDckIsSUFBSSxjQUF5QixDQUFDO1FBQzlCLEVBQUUsQ0FBQyx5Q0FBeUMsRUFBQztZQUN6QyxjQUFjLEdBQUcsSUFBSSxrQkFBVSxFQUFFLENBQUM7WUFDbEMsY0FBYyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLGtCQUFVLENBQUMsQ0FBQztRQUNwRCxDQUFDLENBQUMsQ0FBQztRQUNILEVBQUUsQ0FBQyx3QkFBd0IsRUFBQyxVQUFTLElBQUk7WUFDckMsY0FBYyxDQUFDLGNBQWMsRUFBRTtpQkFDMUIsSUFBSSxDQUFDLENBQUMsT0FBTztnQkFDVixPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxDQUFDO2dCQUNyQixJQUFJLEVBQUUsQ0FBQztZQUNYLENBQUMsQ0FBQyxDQUFDO1FBQ1gsQ0FBQyxDQUFDLENBQUM7UUFDSCxFQUFFLENBQUMsaUNBQWlDLEVBQUMsVUFBUyxJQUFJO1lBQzlDLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7WUFDbkIsY0FBYyxDQUFDLHNCQUFzQixFQUFFO2lCQUNsQyxJQUFJLENBQUMsQ0FBQyxPQUFPO2dCQUNWLE9BQU8sQ0FBQyxHQUFHLENBQUMsT0FBTyxDQUFDLENBQUM7Z0JBQ3JCLElBQUksRUFBRSxDQUFDO1lBQ1gsQ0FBQyxDQUFDLENBQUM7UUFDWCxDQUFDLENBQUMsQ0FBQztRQUNILEVBQUUsQ0FBQyxvQ0FBb0MsRUFBQyxVQUFTLElBQUk7WUFDakQsSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQztZQUNwQixjQUFjLENBQUMsU0FBUyxDQUFDLDJCQUEyQixDQUFDO2lCQUNoRCxJQUFJLENBQUMsQ0FBQyxPQUFPO2dCQUNWLElBQUksRUFBRSxDQUFDO1lBQ1gsQ0FBQyxFQUFDLElBQUksQ0FBQyxDQUFDO1FBQ2hCLENBQUMsQ0FBQyxDQUFBO0lBQ04sQ0FBQyxDQUFDLENBQUM7QUFDUCxDQUFDLENBQUMsQ0FBQyJ9

test/test.ts

@@ -1,36 +1,55 @@
-import "typings-test";
+import { expect, tap } from '@pushrocks/tapbundle';
-import "should";
+import * as docker from '../ts/index';
 
-import {Dockersock} from "../dist/index"
+let testDockerHost: docker.DockerHost;
 
-describe("dockersock",function(){
+tap.test('should create a new Dockersock instance', async () => {
-    describe(".Dockersock()",function(){
+  testDockerHost = new docker.DockerHost();
-        let testDockersock:Dockersock;
+  return expect(testDockerHost).to.be.instanceof(docker.DockerHost);
-        it("should create a new Dockersock instance",function(){
-            testDockersock = new Dockersock();
-            testDockersock.should.be.instanceof(Dockersock);
 });
-        it("should list containers",function(done){
+
-            testDockersock.listContainers()
+// Containers
-                .then((dataArg)=>{
+tap.test('should list containers', async () => {
-                    console.log(dataArg);
+  const containers = await testDockerHost.getContainers();
-                    done();
+  console.log(containers);
 });
+
+// Networks
+tap.test('should list networks', async () => {
+  const networks = await testDockerHost.getNetworks();
+  console.log(networks);
 });
-        it("should list detailed containers",function(done){
+
-            this.timeout(5000);
+tap.test('should create a network', async () => {
-            testDockersock.listContainersDetailed()
+  const newNetwork = await docker.DockerNetwork.createNetwork(testDockerHost, {
-                .then((dataArg)=>{
+    Name: 'webgateway'
-                    console.log(dataArg);
-                    done();
   });
+  expect(newNetwork).to.be.instanceOf(docker.DockerNetwork);
+  expect(newNetwork.Name).to.equal('webgateway');
 });
-        it("should pull an image from imagetag",function(done){
+
-            this.timeout(60000);
+tap.test('should remove a network', async () => {
-            testDockersock.pullImage("hosttoday/ht-docker-dbase")
+  const webgateway = await docker.DockerNetwork.getNetworkByName(testDockerHost, 'webgateway');
-                .then((dataArg)=>{
+  await webgateway.remove();
-                    done();
-                },done);
-        })
 });
+
+// Images
+tap.test('should pull an image from imagetag', async () => {
+  const image = await docker.DockerImage.createFromRegistry(testDockerHost, {
+    imageUrl: 'hosttoday/ht-docker-node',
+    tag: 'alpine'
   });
+  expect(image).to.be.instanceOf(docker.DockerImage);
+  console.log(image);
+});
+
+tap.test('should return a change Observable', async tools => {
+  const testObservable = await testDockerHost.getEventObservable();
+  const subscription = testObservable.subscribe(changeObject => {
+    console.log(changeObject);
+  });
+  await tools.delayFor(2000);
+  subscription.unsubscribe();
+});
+
+tap.start();

ts/docker.classes.container.ts

@@ -0,0 +1,98 @@
+import * as plugins from './docker.plugins';
+import * as interfaces from './interfaces';
+
+import { DockerHost } from './docker.classes.host';
+
+export class DockerContainer {
+  // STATIC
+
+  /**
+   * get all containers
+   */
+  public static async getContainers(dockerHostArg: DockerHost): Promise<DockerContainer[]> {
+    const result: DockerContainer[] = [];
+    const response = await dockerHostArg.request('GET', '/containers/json');
+
+    // TODO: Think about getting the config by inpsecting the container
+    for (const containerResult of response.body) {
+      result.push(new DockerContainer(dockerHostArg, containerResult));
+    }
+    return result;
+  }
+
+  /**
+   * gets an container by Id
+   * @param containerId
+   */
+  public static async getContainerById(containerId: string) {
+    // TODO: implement get container by id
+  }
+
+  /**
+   * create a container
+   */
+  public static async create(
+    dockerHost: DockerHost,
+    containerCreationDescriptor: interfaces.IContainerCreationDescriptor
+  ) {
+    // check for unique hostname
+    const existingContainers = await DockerContainer.getContainers(dockerHost);
+    const sameHostNameContainer = existingContainers.find(container => {
+      // TODO implement HostName Detection;
+      return false;
+    });
+    const response = await dockerHost.request('POST', '/containers/create', {
+      Hostname: containerCreationDescriptor.Hostname,
+      Domainname: containerCreationDescriptor.Domainname,
+      User: 'root'
+    });
+    if (response.statusCode < 300) {
+      plugins.smartlog.defaultLogger.log('info', 'Container created successfully');
+    } else {
+      plugins.smartlog.defaultLogger.log('error', 'There has been a problem when creating the container');
+    }
+  }
+
+  // INSTANCE
+  // references
+  public dockerHost: DockerHost;
+
+  // properties
+  public Id: string;
+  public Names: string[];
+  public Image: string;
+  public ImageID: string;
+  public Command: string;
+  public Created: number;
+  public Ports: interfaces.TPorts;
+  public Labels: interfaces.TLabels;
+  public State: string;
+  public Status: string;
+  public HostConfig: any;
+  public NetworkSettings: {
+    Networks: {
+      [key: string]: {
+        IPAMConfig: any;
+        Links: any;
+        Aliases: any;
+        NetworkID: string;
+        EndpointID: string;
+        Gateway: string;
+        IPAddress: string;
+        IPPrefixLen: number;
+        IPv6Gateway: string;
+        GlobalIPv6Address: string;
+        GlobalIPv6PrefixLen: number;
+        MacAddress: string;
+        DriverOpts: any;
+      };
+    };
+  };
+  public Mounts: any;
+  constructor(dockerHostArg: DockerHost, dockerContainerObjectArg: any) {
+    this.dockerHost = dockerHostArg;
+    Object.keys(dockerContainerObjectArg).forEach(keyArg => {
+      this[keyArg] = dockerContainerObjectArg[keyArg];
+    });
+  }
+}

ts/docker.classes.host.ts

@@ -0,0 +1,121 @@
+import * as plugins from './docker.plugins';
+import { DockerContainer } from './docker.classes.container';
+import { DockerNetwork } from './docker.classes.network';
+
+export class DockerHost {
+  /**
+   * the path where the docker sock can be found
+   */
+  public socketPath: string;
+
+  /**
+   * the constructor to instantiate a new docker sock instance
+   * @param pathArg
+   */
+  constructor(pathArg: string = 'http://unix:/var/run/docker.sock:') {
+    this.socketPath = pathArg;
+  }
+
+  /**
+   * authenticate against a registry
+   * @param userArg
+   * @param passArg
+   */
+  public async auth(registryArg: string, userArg: string, passArg: string) {
+    // TODO: implement Docker Registry authentication
+    await this.request('POST', '');
+  }
+
+  /**
+   * gets all networks
+   */
+  public async getNetworks() {
+    return await DockerNetwork.getNetworks(this);
+  }
+
+  /**
+   * gets all containers
+   */
+  public async getContainers() {
+    const containerArray = await DockerContainer.getContainers(this);
+    return containerArray;
+  }
+
+  /**
+   *
+   */
+  public async getEventObservable(): Promise<plugins.rxjs.Observable<any>> {
+    const response = await this.requestStreaming('GET', '/events');
+    return plugins.rxjs.Observable.create(observer => {
+      response.on('data', data => {
+        const eventString = data.toString();
+        try {
+          const eventObject = JSON.parse(eventString);
+          observer.next(eventObject);
+        } catch (e) {
+          console.log(e);
+        }
+      });
+      return () => {
+        response.emit('end');
+      };
+    });
+  }
+
+  /**
+   * activates docker swarm
+   */
+  public async activateSwarm(addvertisementIpArg: string) {
+    const response = await this.request('POST', '/swarm/init', {
+      ListenAddr: '0.0.0.0:2377',
+      AdvertiseAddr: `${addvertisementIpArg}:2377`,
+      DataPathPort: 4789,
+      DefaultAddrPool: ['10.10.0.0/8', '20.20.0.0/8'],
+      SubnetSize: 24,
+      ForceNewCluster: false
+    });
+    if (response.statusCode === 200) {
+      plugins.smartlog.defaultLogger.log('info', 'created Swam succesfully');
+    } else {
+      plugins.smartlog.defaultLogger.log('error', 'could not initiate swarm');
+    }
+  }
+
+  /**
+   * fire a request
+   */
+  public async request(methodArg: string, routeArg: string, dataArg = {}) {
+    const requestUrl = `${this.socketPath}${routeArg}`;
+    const response = await plugins.smartrequest.request(requestUrl, {
+      method: methodArg,
+      headers: {
+        'Content-Type': 'application/json',
+        Host: 'docker.sock'
+      },
+      requestBody: dataArg
+    });
+    if (response.statusCode !== 200) {
+      console.log(response.body);
+    }
+    return response;
+  }
+
+  public async requestStreaming(methodArg: string, routeArg: string, dataArg = {}) {
+    const requestUrl = `${this.socketPath}${routeArg}`;
+    const response = await plugins.smartrequest.request(
+      requestUrl,
+      {
+        method: methodArg,
+        headers: {
+          // 'Content-Type': 'application/json',
+          Host: 'docker.sock'
+        },
+        requestBody: null
+      },
+      true
+    );
+    console.log(response.statusCode);
+    console.log(response.body);
+    return response;
+  }
+}

ts/docker.classes.image.ts

@@ -0,0 +1,116 @@
+import * as plugins from './docker.plugins';
+import * as interfaces from './interfaces';
+import { DockerHost } from './docker.classes.host';
+
+export class DockerImage {
+  // STATIC
+  public static async getImages(dockerHost: DockerHost) {
+    const images: DockerImage[] = [];
+    const response = await dockerHost.request('GET', '/images/json');
+    for (const imageObject of response.body) {
+      images.push(new DockerImage(dockerHost, imageObject));
+    }
+    return images;
+  }
+
+  public static async findImageByName (dockerHost: DockerHost, imageNameArg: string) {
+    const images = await this.getImages(dockerHost);
+    return images.find(image => {
+      return image.RepoTags.includes(imageNameArg);
+    });
+  }
+
+  public static async createFromRegistry(
+    dockerHostArg: DockerHost,
+    creationObject: interfaces.IImageCreationDescriptor
+  ): Promise<DockerImage> {
+    const response = await dockerHostArg.request(
+      'POST',
+      `/images/create?fromImage=${encodeURIComponent(
+        creationObject.imageUrl
+      )}&tag=${encodeURIComponent(creationObject.tag)}`
+    );
+    if (response.statusCode < 300) {
+      plugins.smartlog.defaultLogger.log(
+        'info',
+        `Successfully pulled image ${creationObject.imageUrl} from the registry`
+      );
+      const originTag = `${creationObject.imageUrl}:${creationObject.tag}`;
+      console.log(originTag)
+      const image = await DockerImage.findImageByName(dockerHostArg, originTag);
+      return image;
+    } else {
+      plugins.smartlog.defaultLogger.log('error', `Failed at the attempt of creating a new image`);
+    }
+  }
+
+  public static async tagImageByIdOrName(
+    dockerHost: DockerHost,
+    idOrNameArg: string,
+    newTagArg: string
+  ) {
+    const response = await dockerHost.request(
+      'POST',
+      `/images/${encodeURIComponent(idOrNameArg)}/${encodeURIComponent(newTagArg)}`
+    );
+  }
+
+  public static async buildImage(dockerHostArg: DockerHost, dockerImageTag) {
+    // TODO: implement building an image
+  }
+
+  // INSTANCE
+  // references
+  public dockerHost: DockerHost;
+
+  // properties
+  /**
+   * the tags for an image
+   */
+  public Containers: number;
+  public Created: number;
+  public Id: string;
+  public Labels: interfaces.TLabels;
+  public ParentId: string;
+  public RepoDigests: string[];
+  public RepoTags: string[];
+  public SharedSize: number;
+  public Size: number;
+  public VirtualSize: number;
+
+  constructor(dockerHostArg, dockerImageObjectArg: any) {
+    this.dockerHost = dockerHostArg;
+    Object.keys(dockerImageObjectArg).forEach(keyArg => {
+      this[keyArg] = dockerImageObjectArg[keyArg];
+    });
+  }
+
+  /**
+   * returns a boolean wether the image has a upstream image
+   */
+  public isUpstreamImage(): boolean {
+    // TODO: implement isUpastreamImage
+    return this.RepoTags.length > 0;
+  }
+
+  public tagImage(newTag) {
+
+  }
+
+  /**
+   * pulls the latest version from the registry
+   */
+  public async pullLatestImageFromRegistry(): Promise<boolean> {
+    const dockerImageUrl = this.RepoTags[0].split(':')[0];
+    const dockerImageTag = this.RepoTags[0].split(':')[1];
+    const updatedImage = await DockerImage.createFromRegistry(this.dockerHost, {
+      imageUrl: dockerImageUrl,
+      tag: dockerImageTag
+    });
+    Object.assign(this, updatedImage);
+    // TODO: Compare image digists before and after
+    return true;
+  }
+
+
+}

ts/docker.classes.network.ts

@@ -0,0 +1,91 @@
+import * as plugins from './docker.plugins';
+import * as interfaces from './interfaces';
+
+import { DockerHost } from './docker.classes.host';
+
+export class DockerNetwork {
+  public static async getNetworks(dockerHost: DockerHost): Promise<DockerNetwork[]> {
+    const dockerNetworks: DockerNetwork[] = [];
+    const response = await dockerHost.request('GET', '/networks');
+    for (const networkObject of response.body) {
+      dockerNetworks.push(new DockerNetwork(dockerHost, networkObject));
+    }
+    return dockerNetworks;
+  }
+
+  public static async getNetworkByName(dockerHost: DockerHost, dockerNetworkNameArg: string) {
+    const networks = await DockerNetwork.getNetworks(dockerHost);
+    return networks.find(dockerNetwork => dockerNetwork.Name === dockerNetworkNameArg);
+  }
+
+  public static async createNetwork(
+    dockerHost: DockerHost,
+    networkCreationDescriptor: interfaces.INetworkCreationDescriptor
+  ): Promise<DockerNetwork> {
+    const response = await dockerHost.request('POST', '/networks/create', {
+      Name: networkCreationDescriptor.Name,
+      CheckDuplicate: true,
+      Driver: 'overlay',
+      EnableIPv6: false,
+      IPAM: {
+        Driver: 'default',
+        Config: [
+          {
+            Subnet: '172.20.10.0/16',
+            IPRange: '172.20.10.0/24',
+            Gateway: '172.20.10.11'
+          }
+        ]
+      },
+      Internal: true,
+      Attachable: true,
+      Ingress: false
+    });
+    if (response.statusCode < 300 ) {
+      plugins.smartlog.defaultLogger.log('info', 'Created network successfully');
+      return await DockerNetwork.getNetworkByName(dockerHost, networkCreationDescriptor.Name);
+    } else {
+      plugins.smartlog.defaultLogger.log('error', 'There has been an error creating the wanted network');
+      return null
+    }
+  }
+
+  // INSTANCE
+  // references
+  public dockerHost: DockerHost;
+
+  // properties
+  public Name: string;
+  public Id: string;
+  public Created: string;
+  public Scope: string;
+  public Driver: string;
+  public EnableIPv6: boolean;
+  public Internal: boolean;
+  public Attachable: boolean;
+  public Ingress: false;
+  public IPAM: {
+    Driver: 'default' | 'bridge' | 'overlay';
+    Config: [
+      {
+        Subnet: string;
+        IPRange: string;
+        Gateway: string;
+      }
+    ];
+  };
+
+  constructor(dockerHostArg: DockerHost, dockerNetworkObjectArg: any) {
+    this.dockerHost = dockerHostArg;
+    Object.keys(dockerNetworkObjectArg).forEach(keyArg => {
+      this[keyArg] = dockerNetworkObjectArg[keyArg];
+    });
+  }
+
+  /**
+   * removes the network
+   */
+  public async remove() {
+    const response = await this.dockerHost.request('DELETE', `/networks/${this.Id}`);
+  }
+}

ts/docker.classes.service.ts

@@ -0,0 +1,6 @@
+import * as plugins from './docker.plugins';
+import * as interfaces from './interfaces';
+
+import { DockerHost } from './docker.classes.host';
+
+export class DockerService {}

ts/docker.plugins.ts

@@ -0,0 +1,14 @@
+// @pushrocks scope
+import * as lik from '@pushrocks/lik';
+import * as smartlog from '@pushrocks/smartlog';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartrequest from '@pushrocks/smartrequest';
+
+smartlog.defaultLogger.enableConsole();
+
+export { lik, smartlog, smartpromise, smartrequest };
+
+// third party
+import * as rxjs from 'rxjs';
+
+export { rxjs };

ts/dockersock.classes.dockersock.ts

@@ -1,202 +0,0 @@
-import "typings-global"
-import * as plugins from "./dockersock.plugins";
-import {Observable} from "rxjs";
-
-export class Dockersock {
-    sockPath:string;
-    constructor(pathArg:string = "http://unix:/var/run/docker.sock:"){
-        this.sockPath = pathArg;
-    }
-
-    // methods
-    auth(userArg:string,passArg:string){
-        let done = plugins.q.defer();
-        this.request("POST","");
-        return done.promise;
-    }
-    listContainers() {
-        let done = plugins.q.defer();
-        this.request("GET","/containers")
-            .then(done.resolve);
-        return done.promise;
-    };
-    listContainersDetailed() {
-        let done = plugins.q.defer();
-        let detailedDataObject = [];
-        this.listContainers()
-            .then((dataArg) => {
-                let recursiveCounter = 0;
-                let makeDetailed = () => {
-                    if(typeof dataArg[recursiveCounter] != "undefined"){
-                        this.request("GET","/containers/" + dataArg[recursiveCounter].Id)
-                            .then((dataArg2) => {
-                                detailedDataObject.push(dataArg2);
-                                recursiveCounter++;
-                                // recursive call
-                                makeDetailed();
-                            });
-                    } else {
-                        done.resolve(detailedDataObject);
-                    }
-                };
-                makeDetailed();
-            });
-        return done.promise;
-    };
-    listContainersRunning() {
-        let done = plugins.q.defer();
-        return done.promise;
-    }
-    listContainersStopped() {
-        let done = plugins.q.defer();
-        return done.promise;
-    }
-    listImages() {
-        return this.request("GET","/images","?all=true");
-    }
-    listImagesDangling(){
-        return this.request("GET","/images","?dangling=true");
-    }
-    pullImage(imageLabelArg:string){
-        let imageLabel = encodeURI(imageLabelArg);
-        return this.requestStream("POST","/images/create?fromImage=" + imageLabel);
-    };
-    createContainer(optionsArg,pullFirstArg:boolean = true){
-        let done = plugins.q.defer();
-        let create = () => {
-            return this.request("POST","/containers/create","",optionsArg);
-        }
-        if(pullFirstArg){
-            this.pullImage(optionsArg.Image)
-                .then(create)
-                .then(done.resolve);
-        } else {
-            create()
-                .then(done.resolve)
-        }
-        return done.promise;
-    };
-    getContainerId(){
-
-    };
-    startContainer(containerNameArg){
-        return this.request("POST","/containers/"+ containerNameArg +"/start");
-    };
-    stopContainer(containerNameArg){
-        return this.request("POST","/containers/"+ containerNameArg +"/stop");
-    };
-    removeContainer(containerNameArg){
-        return this.request("DELETE","/containers/" + containerNameArg + "?v=1");
-    };
-    clean() {
-        let done = plugins.q.defer();
-        return done.promise;
-    };
-    callOnChange(cb:Function){
-        let cbPromise;
-        let changeBuffered:boolean = false; // when cb is running then buffer any consequent change
-        let requestStream = plugins.request.get(this.sockPath + "/events");
-        requestStream.on("response",(response) => {
-                if(response.statusCode == 200){
-                    plugins.beautylog.ok("request returned status 200, so we are good!");
-                } else {
-                    plugins.beautylog.error("request returned error: " + response.statusCode);
-                }
-            });
-        requestStream.on("data",(data:Buffer) => {
-            let status = JSON.parse(data.toString()).status;
-            plugins.beautylog.logReduced(status);
-            if(typeof cbPromise == "undefined" || cbPromise.state == "pending"){
-                cbPromise = cb();
-            } else if (changeBuffered) {
-                changeBuffered = true;
-                cbPromise.then(() => {
-                    changeBuffered = false;
-                    cbPromise = cb();
-                });
-            }
-        });
-        requestStream.on("end",()=> {
-            
-        });         
-    };
-    getChangeObservable(){
-        let requestStream = plugins.request.get(this.sockPath + "/events");
-        requestStream.on("response",(response) => {
-                if(response.statusCode == 200){
-                    plugins.beautylog.ok("request returned status 200, so we are good!");
-                } else {
-                    plugins.beautylog.error("request returned error: " + response.statusCode);
-                }
-            });
-        let changeObservable = Observable.fromEvent(requestStream,"data");
-        requestStream.on("end",()=> {
-            
-        });
-        return changeObservable;
-    }
-    request(methodArg:string,routeArg:string,queryArg:string = "", dataArg = {}){
-        let done = plugins.q.defer();
-        let jsonArg:string = JSON.stringify(dataArg);
-        let suffix:string = "";
-        if(methodArg == "GET") suffix = "/json";
-        let options = {
-            method:methodArg,
-            url:this.sockPath + routeArg + suffix + queryArg,
-            headers:{
-                "Content-Type":"application/json",
-                "Host":"docker.sock"
-            },
-            body:jsonArg
-        };
-        //console.log(options);
-        plugins.request(options,(err, res, body) => {
-            if (!err && res.statusCode == 200) {
-                var responseObj = JSON.parse(body);
-                done.resolve(responseObj);
-            } else {
-                console.log(err);
-                console.log(res);
-                done.reject(err);
-            };
-        });
-        return done.promise;
-    }
-    requestStream(methodArg:string,routeArg:string,queryArg:string = "", dataArg = {}){
-        let done = plugins.q.defer();
-        let jsonArg:string = JSON.stringify(dataArg);
-        let suffix:string = "";
-        let options = {
-            method:methodArg,
-            url:this.sockPath + routeArg + suffix + queryArg,
-            headers:{
-                "Content-Type":"application/json",
-                "Host":"docker.sock"
-            },
-            body:jsonArg
-        };
-        let requestStream = plugins.request(options,(err, res, body) => {
-            if (!err && res.statusCode == 200) {
-                done.resolve();
-            } else {
-                console.log(err);
-                console.log(res);
-                done.reject(err);
-            };
-        });
-        requestStream.on("response",(response) => {
-                if(response.statusCode == 200){
-                    plugins.beautylog.ok("request returned status 200, so we are good!");
-                } else {
-                    plugins.beautylog.error("request returned error: " + response.statusCode);
-                    done.reject(response);
-                }
-            });
-        requestStream.on("data",(data:Buffer) => {
-            let status;
-            status = JSON.parse(data.toString()).status;
-            plugins.beautylog.logReduced(status);
-        });
-        return done.promise;
-    }
-}

ts/dockersock.plugins.ts

@@ -1,5 +0,0 @@
-import "typings-global";
-export import beautylog = require("beautylog");
-export import q = require("q");
-export import request = require("request");
-export import rxjs = require("rxjs");

ts/index.ts

@@ -1,2 +1,5 @@
-import "typings-global";
+export * from './docker.classes.host';
-export {Dockersock} from "./dockersock.classes.dockersock";
+export * from './docker.classes.container';
+export * from './docker.classes.image';
+export * from './docker.classes.network';
+export * from './docker.classes.service';

ts/interfaces/container.ts

@@ -0,0 +1,7 @@
+import { DockerNetwork } from '../docker.classes.network';
+
+export interface IContainerCreationDescriptor {
+  Hostname: string;
+  Domainname: string;
+  networks?: DockerNetwork[];
+}

ts/interfaces/image.ts

@@ -0,0 +1,4 @@
+export interface IImageCreationDescriptor {
+  imageUrl: string;
+  tag: string;
+}

ts/interfaces/index.ts

@@ -0,0 +1,5 @@
+export * from './container';
+export * from './image';
+export * from './label';
+export * from './network';
+export * from './port';

ts/interfaces/label.ts

@@ -0,0 +1,2 @@
+// tslint:disable-next-line: interface-over-type-literal
+export type TLabels = { [key: string]: string };

ts/interfaces/network.ts

@@ -0,0 +1,6 @@
+/**
+ * creates a new Network
+ */
+export interface INetworkCreationDescriptor {
+  Name: string;
+}

ts/interfaces/port.ts

@@ -0,0 +1,6 @@
+export interface IPort {
+  PrivatePort: 80;
+  Type: 'tcp';
+}
+
+export type TPorts = IPort[];

tslint.json

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