fix(core): update

2019-07-18 11:51:56 +02:00 · 2019-07-18 11:51:56 +02:00 · 8a4126a49c
commit 8a4126a49c
parent b86391ca00
14 changed files with 1351 additions and 377 deletions
--- a/.gitignore
+++ b/.gitignore
@ -1,6 +1,22 @@
+.nogit/
+
+# artifacts
 coverage/
-docs/
+public/
+pages/
+
+# installs
 node_modules/

-.nogit/
-nogit/
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@ -1,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci

 cache:
  paths:
@ -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
@ -58,13 +49,14 @@ testLTS:
  tags:
  - docker
  - notpriv
-    
-testSTABLE:
+
+testBuild:
  stage: test
  script:
-  - npmci node install stable
+  - npmci npm prepare
+  - npmci node install lts
  - npmci npm install
-  - npmci npm test
+  - npmci command npm run build
  coverage: /\d+.?\d+?\%\s*coverage/
  tags:
  - docker
@ -73,7 +65,7 @@ testSTABLE:
 release:
  stage: release
  script:
-  - npmci node install stable
+  - npmci node install lts
  - npmci npm publish
  only:
  - tags
@ -86,19 +78,11 @@ release:
 # ====================
 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]
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
  tags:
  - docker
  - priv
@ -117,9 +101,10 @@ pages:
  image: hosttoday/ht-docker-node:npmci
  stage: metadata
  script:
-    - npmci command npm install -g typedoc typescript
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
    - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
  tags:
    - docker
    - notpriv
@ -130,13 +115,3 @@ pages:
    paths:
    - public
  allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true
--- a/README.md
+++ b/README.md
@ -1,25 +1,20 @@
-# cflare
-
+# @mojoio/cloudflare
 easy cloudflare management

-## Availabililty
-
-[![npm](https://mojoio.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/cflare)
-[![git](https://mojoio.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/mojoio/cflare)
-[![git](https://mojoio.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/mojoio/cflare)
-[![docs](https://mojoio.gitlab.io/assets/repo-button-docs.svg)](https://mojoio.gitlab.io/cflare/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/cloudflare)
+* [gitlab.com (source)](https://gitlab.com/mojoio/cloudflare)
+* [github.com (source mirror)](https://github.com/mojoio/cloudflare)
+* [docs (typedoc)](https://mojoio.gitlab.io/cloudflare/)

 ## Status for master
-
-[![build status](https://GitLab.com/mojoio/cflare/badges/master/build.svg)](https://GitLab.com/mojoio/cflare/commits/master)
-[![coverage report](https://GitLab.com/mojoio/cflare/badges/master/coverage.svg)](https://GitLab.com/mojoio/cflare/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/cflare.svg)](https://www.npmjs.com/package/cflare)
-[![Dependency Status](https://david-dm.org/mojoio/cflare.svg)](https://david-dm.org/mojoio/cflare)
-[![bitHound Dependencies](https://www.bithound.io/github/mojoio/cflare/badges/dependencies.svg)](https://www.bithound.io/github/mojoio/cflare/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/mojoio/cflare/badges/code.svg)](https://www.bithound.io/github/mojoio/cflare)
-[![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/)
+[![build status](https://gitlab.com/mojoio/cloudflare/badges/master/build.svg)](https://gitlab.com/mojoio/cloudflare/commits/master)
+[![coverage report](https://gitlab.com/mojoio/cloudflare/badges/master/coverage.svg)](https://gitlab.com/mojoio/cloudflare/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/cloudflare.svg)](https://www.npmjs.com/package/@mojoio/cloudflare)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/cloudflare/badge.svg)](https://snyk.io/test/npm/@mojoio/cloudflare)
+[![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

@ -47,8 +42,9 @@ let myAsyncCflareManagement = async () => {
 }
 ```

-For further information read the linked docs at the top of this README.
+For further information read the linked docs at the top of this readme.

 > MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)

-[![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://mojo.io)
+[![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
--- a/npmextra.json
+++ b/npmextra.json
@ -2,5 +2,15 @@
  "npmci": {
    "npmGlobalTools": [],
    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "mojoio",
+      "gitrepo": "cloudflare",
+      "shortDescription": "easy cloudflare management",
+      "npmPackagename": "@mojoio/cloudflare",
+      "license": "MIT"
+    }
  }
 }
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -24,19 +24,32 @@
  },
  "homepage": "https://gitlab.com/pushrocks/cflare#readme",
  "dependencies": {
-    "@pushrocks/smartdelay": "^2.0.2",
-    "@pushrocks/smartlog": "^2.0.1",
-    "@pushrocks/smartpromise": "^2.0.5",
-    "@pushrocks/smartrequest": "^1.1.14",
-    "@pushrocks/smartstring": "^3.0.4",
-    "@tsclass/tsclass": "^1.0.48"
+    "@pushrocks/smartdelay": "^2.0.3",
+    "@pushrocks/smartlog": "^2.0.19",
+    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartrequest": "^1.1.16",
+    "@pushrocks/smartstring": "^3.0.10",
+    "@tsclass/tsclass": "^2.0.1"
  },
  "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.12",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/qenv": "^2.0.2",
-    "@pushrocks/tapbundle": "^3.0.5",
-    "@types/node": "^10.5.8"
-  }
-}
+    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsrun": "^1.2.6",
+    "@gitzone/tstest": "^1.0.24",
+    "@pushrocks/qenv": "^4.0.0",
+    "@pushrocks/tapbundle": "^3.0.11",
+    "@types/node": "^12.6.6",
+    "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"
+  ]
+}
--- a/qenv.yml
+++ b/qenv.yml
@ -1,3 +1,3 @@
-vars:
+required:
  - CF_EMAIL
  - CF_KEY
--- a/test/test.ts
+++ b/test/test.ts
@ -1,19 +1,19 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import cloudflare = require('../ts/index');
 import { Qenv } from '@pushrocks/qenv';
-let testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit');
+const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit');

-let testCloudflareAccount = new cloudflare.CloudflareAccount();
+const testCloudflareAccount = new cloudflare.CloudflareAccount();
 testCloudflareAccount.auth({
-  email: process.env.CF_EMAIL,
-  key: process.env.CF_KEY
+  email: testQenv.getEnvVarOnDemand('CF_EMAIL'),
+  key: testQenv.getEnvVarOnDemand('CF_KEY')
 });

-let randomPrefix = Math.floor(Math.random() * 2000);
+const randomPrefix = Math.floor(Math.random() * 2000);

 tap.skip.test('.listZones() -> should display an entire account', async tools => {
  tools.timeout(600000);
-  let result = await testCloudflareAccount.listZones();
+  const result = await testCloudflareAccount.listZones();
  console.log(result);
 });

@ -42,7 +42,7 @@ tap.test('should create a valid record for a subdomain', async tools => {

 tap.test('should get a record from Cloudflare', async tools => {
  tools.timeout(600000);
-  await testCloudflareAccount.getRecord('bleu.de', 'A').then(function(responseArg) {
+  await testCloudflareAccount.getRecord(`${randomPrefix}subdomain.bleu.de`, 'A').then(responseArg => {
    console.log(responseArg);
  });
 });
--- a/ts/cloudflare.classes.account.ts
+++ b/ts/cloudflare.classes.account.ts
@ -1,17 +1,23 @@
 import plugins = require('./cloudflare.plugins');
-import * as interfaces from './cloudflare.interfaces';
+import * as interfaces from './interfaces/cloudflare.interfaces';

 // interfaces
 import { TDnsRecord } from '@tsclass/tsclass';
+import { WorkerManager } from './cloudflare.classes.workermanager';
+import { ZoneManager } from './cloudflare.classes.zonemanager';

 export class CloudflareAccount {
  private authEmail: string;
  private authKey: string;
+
+  public workerManager = new WorkerManager(this);
+  public zoneManager = new ZoneManager(this);
+
  constructor() {
    // Nothing here
  }

-  auth(optionsArg: { email: string; key: string }) {
+  public auth(optionsArg: { email: string; key: string }) {
    this.authEmail = optionsArg.email;
    this.authKey = optionsArg.key;
  }
@ -20,16 +26,19 @@ export class CloudflareAccount {
   * gets a zone id of a domain from cloudflare
   * @param domainName
   */
-  async getZoneId(domainName: string) {
-    let domain = new plugins.smartstring.Domain(domainName);
-    let zoneArray = await this.listZones(domain.zoneName);
-    let filteredResponse = zoneArray.filter(zoneArg => {
+  public async getZoneId(domainName: string) {
+    const domain = new plugins.smartstring.Domain(domainName);
+    const zoneArray = await this.listZones(domain.zoneName);
+    const filteredResponse = zoneArray.filter(zoneArg => {
      return zoneArg.name === domainName;
    });
    if (filteredResponse.length >= 1) {
      return filteredResponse[0].id;
    } else {
-      plugins.smartlog.defaultLogger.error(`the domain ${domainName} does not appear to be in this account!`);
+      plugins.smartlog.defaultLogger.log(
+        'error',
+        `the domain ${domainName} does not appear to be in this account!`
+      );
      throw new Error(`the domain ${domainName} does not appear to be in this account!`);
    }
  }
@ -37,45 +46,46 @@ export class CloudflareAccount {
  /**
   * gets a record
   * @param domainNameArg
-   * @param typeArg 
+   * @param typeArg
   */
-  async getRecord(domainNameArg: string, typeArg: TDnsRecord): Promise<interfaces.ICflareRecord> {
-    let done = plugins.smartpromise.defer<interfaces.ICflareRecord>();
-    let result: interfaces.ICflareRecord;
-
-    let domain = new plugins.smartstring.Domain(domainNameArg);
-    this.listRecords(domain.zoneName).then(recordArrayArg => {
-      let filteredResponse = recordArrayArg.filter(recordArg => {
-        return recordArg.type === typeArg && recordArg.name === domainNameArg;
-      });
-      done.resolve(filteredResponse[0]);
+  public async getRecord(
+    domainNameArg: string,
+    typeArg: TDnsRecord
+  ): Promise<interfaces.ICflareRecord> {
+    const domain = new plugins.smartstring.Domain(domainNameArg);
+    const recordArrayArg = await this.listRecords(domain.zoneName);
+    const filteredResponse = recordArrayArg.filter(recordArg => {
+      return recordArg.type === typeArg && recordArg.name === domainNameArg;
    });
-    return done.promise;
+    return filteredResponse[0];
  }

-  async createRecord(domainNameArg: string, typeArg: TDnsRecord, contentArg: string) {
-    let done = plugins.smartpromise.defer();
-    let domain = new plugins.smartstring.Domain(domainNameArg);
-    let domainIdArg = await this.getZoneId(domain.zoneName);
-    let dataObject = {
+  public async createRecord(
+    domainNameArg: string,
+    typeArg: TDnsRecord,
+    contentArg: string
+  ): Promise<any> {
+    const domain = new plugins.smartstring.Domain(domainNameArg);
+    const domainIdArg = await this.getZoneId(domain.zoneName);
+    const dataObject = {
      name: domain.fullName,
      type: typeArg,
      content: contentArg
    };
-    this.request('POST', '/zones/' + domainIdArg + '/dns_records', dataObject).then(function(
-      responseArg
-    ) {
-      done.resolve(responseArg);
-    });
-    return done.promise;
+    const response = await this.request(
+      'POST',
+      '/zones/' + domainIdArg + '/dns_records',
+      dataObject
+    );
+    return response;
  }

-  removeRecord(domainNameArg: string, typeArg: TDnsRecord) {
-    let done = plugins.smartpromise.defer();
-    let domain = new plugins.smartstring.Domain(domainNameArg);
+  public removeRecord(domainNameArg: string, typeArg: TDnsRecord) {
+    const done = plugins.smartpromise.defer();
+    const domain = new plugins.smartstring.Domain(domainNameArg);
    this.getRecord(domain.fullName, typeArg).then(responseArg => {
      if (responseArg) {
-        let requestRoute: string =
+        const requestRoute: string =
          '/zones/' + responseArg.zone_id + '/dns_records/' + responseArg.id;
        this.request('DELETE', requestRoute).then(responseArg => {
          done.resolve(responseArg);
@ -87,9 +97,9 @@ export class CloudflareAccount {
    return done.promise;
  }

-  updateRecord(domainNameArg: string, typeArg: string, valueArg) {
-    let done = plugins.smartpromise.defer();
-    let domain = new plugins.smartstring.Domain(domainNameArg);
+  public updateRecord(domainNameArg: string, typeArg: string, valueArg) {
+    const done = plugins.smartpromise.defer();
+    const domain = new plugins.smartstring.Domain(domainNameArg);
    return done.promise;
  }

@ -97,14 +107,14 @@ export class CloudflareAccount {
   * list all records of a specified domain name
   * @param domainNameArg - the domain name that you want to get the records from
   */
-  async listRecords(domainNameArg: string): Promise<interfaces.ICflareRecord[]> {
-    let domain = new plugins.smartstring.Domain(domainNameArg);
-    let domainId = await this.getZoneId(domain.zoneName);
-    let responseArg: any = await this.request(
+  public async listRecords(domainNameArg: string): Promise<interfaces.ICflareRecord[]> {
+    const domain = new plugins.smartstring.Domain(domainNameArg);
+    const domainId = await this.getZoneId(domain.zoneName);
+    const responseArg: any = await this.request(
      'GET',
      '/zones/' + domainId + '/dns_records?per_page=100'
    );
-    let result: interfaces.ICflareRecord[] = responseArg.result;
+    const result: interfaces.ICflareRecord[] = responseArg.result;
    return result;
  }

@ -112,7 +122,7 @@ export class CloudflareAccount {
   * list all zones in the associated authenticated account
   * @param domainName
   */
-  async listZones(domainName?: string): Promise<interfaces.ICflareZone[]> {
+  public async listZones(domainName?: string): Promise<interfaces.ICflareZone[]> {
    // TODO: handle pagination
    let requestRoute = `/zones?per_page=50`;

@ -121,24 +131,24 @@ export class CloudflareAccount {
      requestRoute = `${requestRoute}&name=${domainName}`;
    }

-    let response: any = await this.request('GET', requestRoute);
-    let result = response.result;
+    const response: any = await this.request('GET', requestRoute);
+    const result = response.result;
    return result;
  }

-  async purgeZone(domainName: string) {
-    let domain = new plugins.smartstring.Domain(domainName);
-    let domainId = await this.getZoneId(domain.zoneName);
-    let requestUrl = `/zones/${domainId}/purge_cache`;
-    let payload = {
+  public async purgeZone(domainName: string) {
+    const domain = new plugins.smartstring.Domain(domainName);
+    const domainId = await this.getZoneId(domain.zoneName);
+    const requestUrl = `/zones/${domainId}/purge_cache`;
+    const payload = {
      purge_everything: true
    };
-    let respone = await this.request('DELETE', requestUrl, payload);
+    const respone = await this.request('DELETE', requestUrl, payload);
  }

-  request(methodArg: string, routeArg: string, dataArg = {}) {
-    let done = plugins.smartpromise.defer();
-    let options: plugins.smartrequest.ISmartRequestOptions = {
+  public request(methodArg: string, routeArg: string, dataArg = {}) {
+    const done = plugins.smartpromise.defer();
+    const options: plugins.smartrequest.ISmartRequestOptions = {
      method: methodArg,
      headers: {
        'Content-Type': 'application/json',
@ -151,8 +161,8 @@ export class CloudflareAccount {

    let retryCount = 0; // count the amount of retries

-    let makeRequest = async () => {
-      let response: any = await plugins.smartrequest.request(
+    const makeRequest = async () => {
+      const response: any = await plugins.smartrequest.request(
        `https://api.cloudflare.com/client/v4${routeArg}`,
        options
      );
@ -169,7 +179,9 @@ export class CloudflareAccount {
        done.reject(new Error('request failed'));
      }
    };
-    let retryRequest = async (delayTimeArg = Math.floor(Math.random() * (60000 - 8000) + 8000)) => {
+    const retryRequest = async (
+      delayTimeArg = Math.floor(Math.random() * (60000 - 8000) + 8000)
+    ) => {
      console.log(`retry started and waiting for ${delayTimeArg} ms`);
      await plugins.smartdelay.delayFor(delayTimeArg);
      if (retryCount < 10) {
--- a/ts/cloudflare.classes.workermanager.ts
+++ b/ts/cloudflare.classes.workermanager.ts
@ -0,0 +1,10 @@
+import * as plugins from './cloudflare.plugins';
+import { CloudflareAccount } from './cloudflare.classes.account';
+
+export class WorkerManager {
+  public cfAccount: CloudflareAccount;
+
+  constructor(cfAccountArg: CloudflareAccount) {
+    this.cfAccount = cfAccountArg;
+  }
+}
--- a/ts/cloudflare.classes.zonemanager.ts
+++ b/ts/cloudflare.classes.zonemanager.ts
@ -0,0 +1,11 @@
+import * as plugins from './cloudflare.plugins';
+import { CloudflareAccount } from './cloudflare.classes.account';
+
+export class ZoneManager {
+  public cfAccount: CloudflareAccount;
+  public zoneName: string;
+
+  constructor(cfAccountArg: CloudflareAccount) {
+    this.cfAccount = cfAccountArg;
+  }
+}
--- a/ts/interfaces/cloudflare.interfaces.ts
+++ b/ts/interfaces/cloudflare.interfaces.ts
@ -1,4 +1,4 @@
-import * as plugins from './cloudflare.plugins';
+import * as plugins from '../cloudflare.plugins';

 export interface ICflareZone {
  id: string;
--- a/ts/interfaces/index.ts
+++ b/ts/interfaces/index.ts
@ -0,0 +1 @@
+export * from './cloudflare.interfaces';
--- a/tslint.json
+++ b/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"
 }