1.1.15

.gitlab-ci.yml

@@ -26,6 +26,7 @@ mirror:
 snyk:
   stage: security
   script:
+    - npmci npm prepare
     - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
@@ -36,21 +37,11 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install lts
   - npmci npm install
   - npmci npm test
@@ -62,6 +53,7 @@ testLTS:
 testSTABLE:
   stage: test
   script:
+  - npmci npm prepare
   - npmci node install stable
   - npmci npm install
   - npmci npm test
@@ -117,8 +109,10 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g npmpage
+    - npmci command npm install -g typedoc typescript
-    - npmci command npmpage
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
   tags:
     - docker
     - notpriv
@@ -128,3 +122,4 @@ pages:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true

README.md

@@ -1,25 +1,20 @@
-# smartrequest
+# @pushrocks/smartrequest
-
 dropin replacement for request
 
-## Availabililty
+## Availabililty and Links
-
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartrequest)
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartrequest)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartrequest)
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartrequest)
+* [github.com (source mirror)](https://github.com/pushrocks/smartrequest)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartrequest)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartrequest/)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartrequest/)
 
 ## Status for master
-
+[![build status](https://gitlab.com/pushrocks/smartrequest/badges/master/build.svg)](https://gitlab.com/pushrocks/smartrequest/commits/master)
-[![build status](https://GitLab.com/pushrocks/smartrequest/badges/master/build.svg)](https://GitLab.com/pushrocks/smartrequest/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartrequest/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartrequest/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/smartrequest/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartrequest/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartrequest.svg)](https://www.npmjs.com/package/@pushrocks/smartrequest)
-[![npm downloads per month](https://img.shields.io/npm/dm/smartrequest.svg)](https://www.npmjs.com/package/smartrequest)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartrequest/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartrequest)
-[![Dependency Status](https://david-dm.org/pushrocks/smartrequest.svg)](https://david-dm.org/pushrocks/smartrequest)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartrequest/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartrequest/master/dependencies/npm)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartrequest/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartrequest)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-[![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/)
 
 ## Usage
 
@@ -66,4 +61,9 @@ smartrequest.get('https://example.com/bigfile.mp4', optionsArg, true).then(res =
 })
 ```
 
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

dist/index.d.ts

@@ -1,9 +0,0 @@
-import * as interfaces from './smartrequest.interfaces';
-import { extendedIncomingMessage } from './smartrequest.request';
-export { request, extendedIncomingMessage } from './smartrequest.request';
-export { ISmartRequestOptions } from './smartrequest.interfaces';
-export declare let get: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions) => Promise<extendedIncomingMessage>;
-export declare let getBinary: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions) => Promise<extendedIncomingMessage>;
-export declare let post: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions) => Promise<extendedIncomingMessage>;
-export declare let put: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions) => Promise<extendedIncomingMessage>;
-export declare let del: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions) => Promise<extendedIncomingMessage>;

dist/index.js

@@ -1,63 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const plugins = require("./smartrequest.plugins");
-const smartrequest_request_1 = require("./smartrequest.request");
-var smartrequest_request_2 = require("./smartrequest.request");
-exports.request = smartrequest_request_2.request;
-exports.get = (domainArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
-    optionsArg.method = 'GET';
-    let response = yield smartrequest_request_1.request(domainArg, optionsArg);
-    return response;
-});
-exports.getBinary = (domainArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
-    const done = plugins.smartq.defer();
-    const response = yield smartrequest_request_1.request(domainArg, optionsArg, true);
-    var data = [];
-    response.on('data', function (chunk) {
-        data.push(chunk);
-    }).on('end', function () {
-        //at this point data is an array of Buffers
-        //so Buffer.concat() can make us a new Buffer
-        //of all of them together
-        const buffer = Buffer.concat(data);
-        response.body = buffer.toString('binary');
-        done.resolve();
-    });
-    yield done.promise;
-    return response;
-});
-exports.post = (domainArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
-    optionsArg.method = 'POST';
-    if (typeof optionsArg.requestBody === 'object' &&
-        (!optionsArg.headers || !optionsArg.headers['Content-Type'])) {
-        // make sure headers exist
-        if (!optionsArg.headers) {
-            optionsArg.headers = {};
-        }
-        // assign the right Content-Type, leaving all other headers in place
-        Object.assign(optionsArg.headers, {
-            'Content-Type': 'application/json'
-        });
-    }
-    let response = yield smartrequest_request_1.request(domainArg, optionsArg);
-    return response;
-});
-exports.put = (domainArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
-    optionsArg.method = 'PUT';
-    let response = yield smartrequest_request_1.request(domainArg, optionsArg);
-    return response;
-});
-exports.del = (domainArg, optionsArg = {}) => __awaiter(this, void 0, void 0, function* () {
-    optionsArg.method = 'DELETE';
-    let response = yield smartrequest_request_1.request(domainArg, optionsArg);
-    return response;
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBRUEsa0RBQWtEO0FBR2xELGlFQUEwRTtBQUUxRSwrREFBMEU7QUFBakUseUNBQUEsT0FBTyxDQUFBO0FBR0wsUUFBQSxHQUFHLEdBQUcsQ0FBTyxTQUFpQixFQUFFLGFBQThDLEVBQUUsRUFBRSxFQUFFO0lBQzdGLFVBQVUsQ0FBQyxNQUFNLEdBQUcsS0FBSyxDQUFDO0lBQzFCLElBQUksUUFBUSxHQUFHLE1BQU0sOEJBQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLENBQUM7SUFDcEQsT0FBTyxRQUFRLENBQUM7QUFDbEIsQ0FBQyxDQUFBLENBQUM7QUFFUyxRQUFBLFNBQVMsR0FBRyxDQUFPLFNBQWlCLEVBQUUsYUFBOEMsRUFBRSxFQUFFLEVBQUU7SUFDbkcsTUFBTSxJQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUNwQyxNQUFNLFFBQVEsR0FBRyxNQUFNLDhCQUFPLENBQUMsU0FBUyxFQUFFLFVBQVUsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUM1RCxJQUFJLElBQUksR0FBRyxFQUFFLENBQUM7SUFFZCxRQUFRLENBQUMsRUFBRSxDQUFDLE1BQU0sRUFBRSxVQUFTLEtBQUs7UUFDOUIsSUFBSSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUNyQixDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFO1FBQ1QsMkNBQTJDO1FBQzNDLDZDQUE2QztRQUM3Qyx5QkFBeUI7UUFDekIsTUFBTSxNQUFNLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNuQyxRQUFRLENBQUMsSUFBSSxHQUFHLE1BQU0sQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDMUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDO0lBQ25CLENBQUMsQ0FBQyxDQUFDO0lBQ0gsTUFBTSxJQUFJLENBQUMsT0FBTyxDQUFDO0lBQ25CLE9BQU8sUUFBUSxDQUFDO0FBQ2xCLENBQUMsQ0FBQSxDQUFBO0FBRVUsUUFBQSxJQUFJLEdBQUcsQ0FBTyxTQUFpQixFQUFFLGFBQThDLEVBQUUsRUFBRSxFQUFFO0lBQzlGLFVBQVUsQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDO0lBQzNCLElBQ0UsT0FBTyxVQUFVLENBQUMsV0FBVyxLQUFLLFFBQVE7UUFDMUMsQ0FBQyxDQUFDLFVBQVUsQ0FBQyxPQUFPLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQyxDQUFDLEVBQzVEO1FBQ0EsMEJBQTBCO1FBQzFCLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxFQUFFO1lBQ3ZCLFVBQVUsQ0FBQyxPQUFPLEdBQUcsRUFBRSxDQUFDO1NBQ3pCO1FBRUQsb0VBQW9FO1FBQ3BFLE1BQU0sQ0FBQyxNQUFNLENBQUMsVUFBVSxDQUFDLE9BQU8sRUFBRTtZQUNoQyxjQUFjLEVBQUUsa0JBQWtCO1NBQ25DLENBQUMsQ0FBQztLQUNKO0lBQ0QsSUFBSSxRQUFRLEdBQUcsTUFBTSw4QkFBTyxDQUFDLFNBQVMsRUFBRSxVQUFVLENBQUMsQ0FBQztJQUNwRCxPQUFPLFFBQVEsQ0FBQztBQUNsQixDQUFDLENBQUEsQ0FBQztBQUVTLFFBQUEsR0FBRyxHQUFHLENBQU8sU0FBaUIsRUFBRSxhQUE4QyxFQUFFLEVBQUUsRUFBRTtJQUM3RixVQUFVLENBQUMsTUFBTSxHQUFHLEtBQUssQ0FBQztJQUMxQixJQUFJLFFBQVEsR0FBRyxNQUFNLDhCQUFPLENBQUMsU0FBUyxFQUFFLFVBQVUsQ0FBQyxDQUFDO0lBQ3BELE9BQU8sUUFBUSxDQUFDO0FBQ2xCLENBQUMsQ0FBQSxDQUFDO0FBRVMsUUFBQSxHQUFHLEdBQUcsQ0FBTyxTQUFpQixFQUFFLGFBQThDLEVBQUUsRUFBRSxFQUFFO0lBQzdGLFVBQVUsQ0FBQyxNQUFNLEdBQUcsUUFBUSxDQUFDO0lBQzdCLElBQUksUUFBUSxHQUFHLE1BQU0sOEJBQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDLENBQUM7SUFDcEQsT0FBTyxRQUFRLENBQUM7QUFDbEIsQ0FBQyxDQUFBLENBQUMifQ==

dist/smartrequest.interfaces.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="node" />
-import * as https from 'https';
-export interface ISmartRequestOptions extends https.RequestOptions {
-    requestBody?: any;
-}

dist/smartrequest.interfaces.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRyZXF1ZXN0LmludGVyZmFjZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHJlcXVlc3QuaW50ZXJmYWNlcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=

dist/smartrequest.plugins.d.ts

@@ -1,5 +0,0 @@
-import * as url from 'url';
-import * as http from 'http';
-import * as https from 'https';
-import * as smartq from 'smartq';
-export { url, http, https, smartq };

dist/smartrequest.plugins.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const url = require("url");
-exports.url = url;
-const http = require("http");
-exports.http = http;
-const https = require("https");
-exports.https = https;
-const smartq = require("smartq");
-exports.smartq = smartq;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRyZXF1ZXN0LnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHJlcXVlc3QucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLDJCQUEyQjtBQU1sQixrQkFBRztBQUxaLDZCQUE2QjtBQUtmLG9CQUFJO0FBSmxCLCtCQUErQjtBQUlYLHNCQUFLO0FBRnpCLGlDQUFpQztBQUVOLHdCQUFNIn0=

dist/smartrequest.request.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="node" />
-import * as interfaces from './smartrequest.interfaces';
-import { IncomingMessage } from 'http';
-export interface extendedIncomingMessage extends IncomingMessage {
-    body: any;
-}
-export declare let request: (domainArg: string, optionsArg?: interfaces.ISmartRequestOptions, streamArg?: boolean) => Promise<extendedIncomingMessage>;

dist/smartrequest.request.js

@@ -1,87 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const plugins = require("./smartrequest.plugins");
-;
-let buildResponse = (incomingMessageArg) => {
-    let done = plugins.smartq.defer();
-    // Continuously update stream with data
-    let body = '';
-    incomingMessageArg.on('data', function (chunkArg) {
-        body += chunkArg;
-    });
-    incomingMessageArg.on('end', function () {
-        try {
-            incomingMessageArg.body = JSON.parse(body);
-        }
-        catch (err) {
-            incomingMessageArg.body = body;
-        }
-        done.resolve(incomingMessageArg);
-    });
-    return done.promise;
-};
-exports.request = (domainArg, optionsArg = {}, streamArg = false) => __awaiter(this, void 0, void 0, function* () {
-    let done = plugins.smartq.defer();
-    let parsedUrl;
-    if (domainArg) {
-        parsedUrl = plugins.url.parse(domainArg);
-        optionsArg.hostname = parsedUrl.hostname;
-        if (parsedUrl.port) {
-            optionsArg.port = parseInt(parsedUrl.port);
-        }
-        optionsArg.path = parsedUrl.path;
-    }
-    if (!parsedUrl || parsedUrl.protocol === 'https:') {
-        let request = plugins.https.request(optionsArg, response => {
-            if (streamArg) {
-                done.resolve(response);
-            }
-            else {
-                buildResponse(response).then(done.resolve);
-            }
-        });
-        if (optionsArg.requestBody) {
-            if (typeof optionsArg.requestBody !== 'string') {
-                optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
-            }
-            request.write(optionsArg.requestBody);
-        }
-        request.on('error', e => {
-            console.error(e);
-        });
-        request.end();
-    }
-    else if (parsedUrl.protocol === 'http:') {
-        let request = plugins.http.request(optionsArg, response => {
-            if (streamArg) {
-                done.resolve(response);
-            }
-            else {
-                buildResponse(response).then(done.resolve);
-            }
-        });
-        if (optionsArg.requestBody) {
-            if (typeof optionsArg.requestBody !== 'string') {
-                optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
-            }
-            request.write(optionsArg.requestBody);
-        }
-        request.on('error', e => {
-            console.error(e);
-        });
-        request.end();
-    }
-    else {
-        throw new Error(`unsupported protocol: ${parsedUrl.protocol}`);
-    }
-    return done.promise;
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRyZXF1ZXN0LnJlcXVlc3QuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHJlcXVlc3QucmVxdWVzdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBQ0Esa0RBQWtEO0FBT2pELENBQUM7QUFFRixJQUFJLGFBQWEsR0FBRyxDQUFDLGtCQUFtQyxFQUFvQyxFQUFFO0lBQzVGLElBQUksSUFBSSxHQUFHLE9BQU8sQ0FBQyxNQUFNLENBQUMsS0FBSyxFQUEyQixDQUFDO0lBQzNELHVDQUF1QztJQUN2QyxJQUFJLElBQUksR0FBRyxFQUFFLENBQUM7SUFDZCxrQkFBa0IsQ0FBQyxFQUFFLENBQUMsTUFBTSxFQUFFLFVBQVMsUUFBUTtRQUM3QyxJQUFJLElBQUksUUFBUSxDQUFDO0lBQ25CLENBQUMsQ0FBQyxDQUFDO0lBRUgsa0JBQWtCLENBQUMsRUFBRSxDQUFDLEtBQUssRUFBRTtRQUMzQixJQUFJO1lBQ0Qsa0JBQThDLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUM7U0FDekU7UUFBQyxPQUFPLEdBQUcsRUFBRTtZQUNYLGtCQUE4QyxDQUFDLElBQUksR0FBRyxJQUFJLENBQUM7U0FDN0Q7UUFDRCxJQUFJLENBQUMsT0FBTyxDQUFDLGtCQUE2QyxDQUFDLENBQUM7SUFDOUQsQ0FBQyxDQUFDLENBQUM7SUFDSCxPQUFPLElBQUksQ0FBQyxPQUFPLENBQUM7QUFDdEIsQ0FBQyxDQUFDO0FBRVMsUUFBQSxPQUFPLEdBQUcsQ0FDbkIsU0FBaUIsRUFDakIsYUFBOEMsRUFBRSxFQUNoRCxZQUFxQixLQUFLLEVBQ1EsRUFBRTtJQUNwQyxJQUFJLElBQUksR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssRUFBTyxDQUFDO0lBQ3ZDLElBQUksU0FBMEIsQ0FBQztJQUMvQixJQUFJLFNBQVMsRUFBRTtRQUNiLFNBQVMsR0FBRyxPQUFPLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQztRQUN6QyxVQUFVLENBQUMsUUFBUSxHQUFHLFNBQVMsQ0FBQyxRQUFRLENBQUM7UUFDekMsSUFBSSxTQUFTLENBQUMsSUFBSSxFQUFFO1lBQ2xCLFVBQVUsQ0FBQyxJQUFJLEdBQUcsUUFBUSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUM1QztRQUNELFVBQVUsQ0FBQyxJQUFJLEdBQUcsU0FBUyxDQUFDLElBQUksQ0FBQztLQUNsQztJQUNELElBQUksQ0FBQyxTQUFTLElBQUksU0FBUyxDQUFDLFFBQVEsS0FBSyxRQUFRLEVBQUU7UUFDakQsSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsVUFBVSxFQUFFLFFBQVEsQ0FBQyxFQUFFO1lBQ3pELElBQUksU0FBUyxFQUFFO2dCQUNiLElBQUksQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7YUFDeEI7aUJBQU07Z0JBQ0wsYUFBYSxDQUFDLFFBQVEsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7YUFDNUM7UUFDSCxDQUFDLENBQUMsQ0FBQztRQUNILElBQUksVUFBVSxDQUFDLFdBQVcsRUFBRTtZQUMxQixJQUFJLE9BQU8sVUFBVSxDQUFDLFdBQVcsS0FBSyxRQUFRLEVBQUU7Z0JBQzlDLFVBQVUsQ0FBQyxXQUFXLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLENBQUM7YUFDakU7WUFDRCxPQUFPLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxXQUFXLENBQUMsQ0FBQztTQUN2QztRQUNELE9BQU8sQ0FBQyxFQUFFLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQyxFQUFFO1lBQ3RCLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDbkIsQ0FBQyxDQUFDLENBQUM7UUFDSCxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUM7S0FDZjtTQUFNLElBQUksU0FBUyxDQUFDLFFBQVEsS0FBSyxPQUFPLEVBQUU7UUFDekMsSUFBSSxPQUFPLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsVUFBVSxFQUFFLFFBQVEsQ0FBQyxFQUFFO1lBQ3hELElBQUksU0FBUyxFQUFFO2dCQUNiLElBQUksQ0FBQyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7YUFDeEI7aUJBQU07Z0JBQ0wsYUFBYSxDQUFDLFFBQVEsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7YUFDNUM7UUFDSCxDQUFDLENBQUMsQ0FBQztRQUNILElBQUksVUFBVSxDQUFDLFdBQVcsRUFBRTtZQUMxQixJQUFJLE9BQU8sVUFBVSxDQUFDLFdBQVcsS0FBSyxRQUFRLEVBQUU7Z0JBQzlDLFVBQVUsQ0FBQyxXQUFXLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxVQUFVLENBQUMsV0FBVyxDQUFDLENBQUM7YUFDakU7WUFDRCxPQUFPLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxXQUFXLENBQUMsQ0FBQztTQUN2QztRQUNELE9BQU8sQ0FBQyxFQUFFLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQyxFQUFFO1lBQ3RCLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDbkIsQ0FBQyxDQUFDLENBQUM7UUFDSCxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUM7S0FDZjtTQUFNO1FBQ0wsTUFBTSxJQUFJLEtBQUssQ0FBQyx5QkFBeUIsU0FBUyxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7S0FDaEU7SUFDRCxPQUFPLElBQUksQ0FBQyxPQUFPLENBQUM7QUFDdEIsQ0FBQyxDQUFBLENBQUMifQ==

npmextra.json

@@ -1,11 +1,19 @@
 {
   "npmts": {
-    "coverageTreshold": 60
+    "coverageTreshold": 50
   },
   "npmci": {
-    "npmGlobalTools": [
+    "npmGlobalTools": [],
-      "npmts"
-    ],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartrequest",
+      "shortDescription": "dropin replacement for request",
+      "npmPackagename": "@pushrocks/smartrequest",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,13 +1,13 @@
 {
-  "name": "smartrequest",
+  "name": "@pushrocks/smartrequest",
-  "version": "1.0.13",
+  "version": "1.1.15",
   "private": false,
   "description": "dropin replacement for request",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)",
+    "test": "(tstest test/)",
-    "build": "echo \"Not needed for now\""
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -23,11 +23,15 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartrequest#README",
   "dependencies": {
-    "smartq": "^1.1.1"
+    "@pushrocks/smartpromise": "^3.0.2",
+    "@types/form-data": "^2.2.1",
+    "form-data": "^2.3.3"
   },
   "devDependencies": {
-    "@types/node": "^10.3.3",
+    "@gitzone/tsbuild": "^2.1.8",
-    "tapbundle": "^2.0.0",
+    "@gitzone/tsrun": "^1.2.5",
-    "typings-test": "^1.0.3"
+    "@gitzone/tstest": "^1.0.20",
+    "@pushrocks/tapbundle": "^3.0.9",
+    "@types/node": "^11.13.6"
   }
 }

test/test.ts

@@ -1,27 +1,40 @@
-import 'typings-test';
+import { tap, expect } from '@pushrocks/tapbundle';
-
-import { tap, expect } from 'tapbundle';
 
 import * as smartrequest from '../ts/index';
 
 tap.test('should request a html document over https', async () => {
-  await expect(smartrequest.get('https://encrypted.google.com/'))
+  await expect(smartrequest.getJson('https://encrypted.google.com/'))
     .to.eventually.property('body')
     .be.a('string');
 });
 
 tap.test('should request a JSON document over https', async () => {
-  await expect(smartrequest.get('https://jsonplaceholder.typicode.com/posts/1'))
+  await expect(smartrequest.getJson('https://jsonplaceholder.typicode.com/posts/1'))
     .to.eventually.property('body')
     .property('id')
     .equal(1);
 });
 
 tap.test('should post a JSON document over http', async () => {
-  await expect(smartrequest.post('http://md5.jsontest.com/?text=example_text'))
+  await expect(smartrequest.postJson('http://md5.jsontest.com/?text=example_text'))
     .to.eventually.property('body')
     .property('md5')
     .equal('fa4c6baa0812e5b5c80ed8885e55a8a6');
 });
 
+tap.skip.test('should deal with unix socks', async () => {
+  const socketResponse = await smartrequest.request(
+    'http://unix:/var/run/docker.sock:/containers/json',
+    {
+      headers: {
+        'Content-Type': 'application/json',
+        Host: 'docker.sock'
+      }
+    }
+  );
+  console.log(socketResponse.body);
+});
+
+tap.skip.test('should correctly upload a file using formData', async () => {});
+
 tap.start();

ts/index.ts

@@ -1,66 +1,6 @@
-import * as https from 'https';
+export { request, IExtendedIncomingMessage } from './smartrequest.request';
-
-import * as plugins from './smartrequest.plugins';
-import * as interfaces from './smartrequest.interfaces';
-
-import { request, extendedIncomingMessage } from './smartrequest.request';
-
-export { request, extendedIncomingMessage } from './smartrequest.request';
 export { ISmartRequestOptions } from './smartrequest.interfaces';
 
-export let get = async (domainArg: string, optionsArg: interfaces.ISmartRequestOptions = {}) => {
+export * from './smartrequest.jsonrest';
-  optionsArg.method = 'GET';
+export * from './smartrequest.binaryrest';
-  let response = await request(domainArg, optionsArg);
+export * from './smartrequest.formdata';
-  return response;
-};
-
-export let getBinary = async (domainArg: string, optionsArg: interfaces.ISmartRequestOptions = {}) => {
-  const done = plugins.smartq.defer();
-  const response = await request(domainArg, optionsArg, true);
-  var data = [];
-
-  response.on('data', function(chunk) {
-      data.push(chunk);
-  }).on('end', function() {
-      //at this point data is an array of Buffers
-      //so Buffer.concat() can make us a new Buffer
-      //of all of them together
-      const buffer = Buffer.concat(data);
-      response.body = buffer.toString('binary');
-      done.resolve();
-  });
-  await done.promise;
-  return response;
-}
-
-export let post = async (domainArg: string, optionsArg: interfaces.ISmartRequestOptions = {}) => {
-  optionsArg.method = 'POST';
-  if (
-    typeof optionsArg.requestBody === 'object' &&
-    (!optionsArg.headers || !optionsArg.headers['Content-Type'])
-  ) {
-    // make sure headers exist
-    if (!optionsArg.headers) {
-      optionsArg.headers = {};
-    }
-
-    // assign the right Content-Type, leaving all other headers in place
-    Object.assign(optionsArg.headers, {
-      'Content-Type': 'application/json'
-    });
-  }
-  let response = await request(domainArg, optionsArg);
-  return response;
-};
-
-export let put = async (domainArg: string, optionsArg: interfaces.ISmartRequestOptions = {}) => {
-  optionsArg.method = 'PUT';
-  let response = await request(domainArg, optionsArg);
-  return response;
-};
-
-export let del = async (domainArg: string, optionsArg: interfaces.ISmartRequestOptions = {}) => {
-  optionsArg.method = 'DELETE';
-  let response = await request(domainArg, optionsArg);
-  return response;
-};

ts/smartrequest.binaryrest.ts

@@ -0,0 +1,29 @@
+// this file implements methods to get and post binary data.
+import * as interfaces from './smartrequest.interfaces';
+import { request } from './smartrequest.request';
+
+import * as plugins from './smartrequest.plugins';
+
+export const getBinary = async (
+  domainArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+) => {
+  const done = plugins.smartpromise.defer();
+  const response = await request(domainArg, optionsArg, true);
+  const data = [];
+
+  response
+    .on('data', function(chunk) {
+      data.push(chunk);
+    })
+    .on('end', function() {
+      //at this point data is an array of Buffers
+      //so Buffer.concat() can make us a new Buffer
+      //of all of them together
+      const buffer = Buffer.concat(data);
+      response.body = buffer.toString('binary');
+      done.resolve();
+    });
+  await done.promise;
+  return response;
+};

ts/smartrequest.formdata.ts

@@ -0,0 +1,45 @@
+import * as plugins from './smartrequest.plugins';
+import * as interfaces from './smartrequest.interfaces';
+import { request } from './smartrequest.request';
+
+/**
+ * the interfae for FormFieldData
+ */
+export interface IFormField {
+  name: string;
+  type: 'string' | 'filePath' | 'Buffer';
+  payload: string;
+}
+
+const appendFormField = async (formDataArg: plugins.formData, formDataField: IFormField) => {
+  if (formDataField.type === 'filePath') {
+    let fileData = plugins.fs.readFileSync(plugins.path.join(process.cwd(), formDataField.payload));
+    formDataArg.append('file', fileData, {
+      filename: 'upload.pdf',
+      contentType: 'application/pdf'
+    });
+  }
+};
+
+export const postFormData = async (
+  urlArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {},
+  payloadArg: IFormField[]
+) => {
+  const form = new plugins.formData();
+  for (const formField of payloadArg) {
+    await appendFormField(form, formField);
+  }
+  const requestOptions = Object.assign({}, optionsArg, {
+    method: 'POST',
+    headers: {
+      ...optionsArg.headers,
+      ...form.getHeaders()
+    },
+    requestBody: form
+  });
+
+  // lets fire the actual request for sending the formdata
+  const response = await request(urlArg, requestOptions);
+  return response;
+};

ts/smartrequest.jsonrest.ts

@@ -0,0 +1,63 @@
+// This file implements methods to get and post JSON in a simple manner.
+
+import * as interfaces from './smartrequest.interfaces';
+import { request } from './smartrequest.request';
+
+/**
+ * gets Json and puts the right headers + handles response aggregation
+ * @param domainArg
+ * @param optionsArg
+ */
+export const getJson = async (
+  domainArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+) => {
+  optionsArg.method = 'GET';
+  optionsArg.headers = {
+    ...optionsArg.headers
+  };
+  let response = await request(domainArg, optionsArg);
+  return response;
+};
+
+export const postJson = async (
+  domainArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+) => {
+  optionsArg.method = 'POST';
+  if (
+    typeof optionsArg.requestBody === 'object' &&
+    (!optionsArg.headers || !optionsArg.headers['Content-Type'])
+  ) {
+    // make sure headers exist
+    if (!optionsArg.headers) {
+      optionsArg.headers = {};
+    }
+
+    // assign the right Content-Type, leaving all other headers in place
+    optionsArg.headers = {
+      ...optionsArg.headers,
+      'Content-Type': 'application/json'
+    };
+  }
+  let response = await request(domainArg, optionsArg);
+  return response;
+};
+
+export const putJson = async (
+  domainArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+) => {
+  optionsArg.method = 'PUT';
+  let response = await request(domainArg, optionsArg);
+  return response;
+};
+
+export const delJson = async (
+  domainArg: string,
+  optionsArg: interfaces.ISmartRequestOptions = {}
+) => {
+  optionsArg.method = 'DELETE';
+  let response = await request(domainArg, optionsArg);
+  return response;
+};

ts/smartrequest.plugins.ts

@@ -1,7 +1,10 @@
-import * as url from 'url';
+import * as formData from 'form-data';
+import * as fs from 'fs';
 import * as http from 'http';
 import * as https from 'https';
+import * as path from 'path';
+import * as url from 'url';
 
-import * as smartq from 'smartq';
+import * as smartpromise from '@pushrocks/smartpromise';
 
-export { url, http, https, smartq };
+export { formData, http, https, fs, path, url, smartpromise };

ts/smartrequest.request.ts

@@ -4,12 +4,14 @@ import * as interfaces from './smartrequest.interfaces';
 
 import { IncomingMessage } from 'http';
 
-export interface extendedIncomingMessage extends IncomingMessage {
+export interface IExtendedIncomingMessage extends IncomingMessage {
-  body: any
+  body: any;
-};
+}
 
-let buildResponse = (incomingMessageArg: IncomingMessage): Promise<extendedIncomingMessage> => {
+const buildUtf8Response = (
-  let done = plugins.smartq.defer<extendedIncomingMessage>();
+  incomingMessageArg: IncomingMessage
+): Promise<IExtendedIncomingMessage> => {
+  let done = plugins.smartpromise.defer<IExtendedIncomingMessage>();
   // Continuously update stream with data
   let body = '';
   incomingMessageArg.on('data', function(chunkArg) {
@@ -18,68 +20,105 @@ let buildResponse = (incomingMessageArg: IncomingMessage): Promise<extendedIncom
 
   incomingMessageArg.on('end', function() {
     try {
-      (incomingMessageArg as extendedIncomingMessage).body = JSON.parse(body);
+      (incomingMessageArg as IExtendedIncomingMessage).body = JSON.parse(body);
     } catch (err) {
-      (incomingMessageArg as extendedIncomingMessage).body = body;
+      (incomingMessageArg as IExtendedIncomingMessage).body = body;
     }
-    done.resolve(incomingMessageArg as extendedIncomingMessage);
+    done.resolve(incomingMessageArg as IExtendedIncomingMessage);
   });
   return done.promise;
 };
 
+/**
+ * determine wether a url is a unix sock
+ * @param urlArg
+ */
+const testForUnixSock = (urlArg: string): boolean => {
+  const unixRegex = /^(http:\/\/|https:\/\/|)unix:/;
+  return unixRegex.test(urlArg);
+};
+
+/**
+ * determine socketPath and path for unixsock
+ */
+const parseSocketPathAndRoute = (stringToParseArg: string) => {
+  const parseRegex = /(.*):(.*)/;
+  const result = parseRegex.exec(stringToParseArg);
+  return {
+    socketPath: result[1],
+    path: result[2]
+  };
+};
+
 export let request = async (
   domainArg: string,
   optionsArg: interfaces.ISmartRequestOptions = {},
   streamArg: boolean = false
-): Promise<extendedIncomingMessage> => {
+): Promise<IExtendedIncomingMessage> => {
-  let done = plugins.smartq.defer<any>();
+  let done = plugins.smartpromise.defer<any>();
+
+  // parse url
   let parsedUrl: plugins.url.Url;
-  if (domainArg) {
   parsedUrl = plugins.url.parse(domainArg);
   optionsArg.hostname = parsedUrl.hostname;
   if (parsedUrl.port) {
     optionsArg.port = parseInt(parsedUrl.port);
   }
   optionsArg.path = parsedUrl.path;
+
+  // determine if unixsock
+  if (testForUnixSock(domainArg)) {
+    const detailedUnixPath = parseSocketPathAndRoute(optionsArg.path);
+    optionsArg.socketPath = detailedUnixPath.socketPath;
+    optionsArg.path = detailedUnixPath.path;
   }
-  if (!parsedUrl || parsedUrl.protocol === 'https:') {
+
-    let request = plugins.https.request(optionsArg, response => {
+  // lets determine the request module to use
-      if (streamArg) {
+  const requestModule = (() => {
-        done.resolve(response);
+    if (parsedUrl.protocol === 'https:') {
-      } else {
+      return plugins.https;
-        buildResponse(response).then(done.resolve);
-      }
-    });
-    if (optionsArg.requestBody) {
-      if (typeof optionsArg.requestBody !== 'string') {
-        optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
-      }
-      request.write(optionsArg.requestBody);
-    }
-    request.on('error', e => {
-      console.error(e);
-    });
-    request.end();
     } else if (parsedUrl.protocol === 'http:') {
-    let request = plugins.http.request(optionsArg, response => {
+      return plugins.http;
-      if (streamArg) {
-        done.resolve(response);
-      } else {
-        buildResponse(response).then(done.resolve);
-      }
-    });
-    if (optionsArg.requestBody) {
-      if (typeof optionsArg.requestBody !== 'string') {
-        optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
-      }
-      request.write(optionsArg.requestBody);
-    }
-    request.on('error', e => {
-      console.error(e);
-    });
-    request.end();
     } else {
       throw new Error(`unsupported protocol: ${parsedUrl.protocol}`);
     }
-  return done.promise;
+  })() as typeof plugins.https;
+
+  // lets perform the actual request
+  let request = requestModule.request(optionsArg);
+
+  // lets write the requestBody
+  if (optionsArg.requestBody) {
+    if (!(optionsArg.requestBody instanceof plugins.formData)) {
+      if (typeof optionsArg.requestBody !== 'string') {
+        optionsArg.requestBody = JSON.stringify(optionsArg.requestBody);
+      }
+      request.write(optionsArg.requestBody);
+      request.end();
+    } else if (optionsArg.requestBody instanceof plugins.formData) {
+      optionsArg.requestBody.pipe(request).on('finish', event => {
+        request.end();
+      });
+    }
+  } else {
+    request.end();
+  }
+
+  // lets handle an error
+  request.on('error', e => {
+    console.error(e);
+  });
+
+  // lets handle the response
+  request.on('response', async response => {
+    if (streamArg) {
+      done.resolve(response);
+    } else {
+      const builtResponse = await buildUtf8Response(response);
+      done.resolve(builtResponse);
+    }
+  });
+
+  const result = await done.promise;
+  return result;
 };

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }