1.0.8

.gitignore

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

.gitlab-ci.yml

@@ -1,59 +1,118 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
-- trigger
-- pages
+- metadata
 
-testLEGACY:
-  stage: test
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+  - npmci git mirror
   tags:
   - docker
-  allow_failure: true
+  - notpriv
 
-testLTS:
-  stage: test
+snyk:
+  stage: security
   script:
-    - npmci test lts
+    - npmci npm prepare
+    - npmci command npm install -g snyk
+    - npmci command npm install --ignore-scripts
+    - npmci command snyk test
   tags:
   - docker
+  - notpriv
 
-testSTABLE:
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test stable
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
   - docker
+  - priv
+
+testBuild:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
+  - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+  - npmci node install stable
+  - npmci npm publish
   only:
   - tags
   tags:
   - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - 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:
   - docker
+  - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
-  stage: pages
+  stage: metadata
   script:
-    - npmci command npmpage --publish gitlab
+    - npmci node install lts
+    - 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"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone"
+          }
+        }
+      }
+    }
+  ]
+}

license

@@ -0,0 +1,19 @@
+Copyright (c) 2019 Lossless GmbH (hello@lossless.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

npmextra.json

@@ -0,0 +1,17 @@
+{
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "mojoio",
+      "gitrepo": "mailgun",
+      "shortDescription": "an api abstraction package for mailgun",
+      "npmPackagename": "@mojoio/mailgun",
+      "license": "MIT",
+      "projectDomain": "mojo.io"
+    }
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  }
+}

package.json

@@ -1,23 +1,40 @@
 {
-  "name": "mgun",
-  "version": "1.0.2",
-  "description": "easy mailgun API wrapper",
+  "name": "@mojoio/mailgun",
+  "version": "1.0.8",
+  "private": false,
+  "description": "an api abstraction package for mailgun",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
-  "scripts": {
-    "test": "(npmts)"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@gitlab.com/mojoio/mgun.git"
-  },
-  "keywords": [
-    "mailgun"
-  ],
   "author": "Lossless GmbH",
   "license": "MIT",
-  "bugs": {
-    "url": "https://gitlab.com/mojoio/mgun/issues"
+  "scripts": {
+    "test": "(tstest test/)",
+    "build": "(tsbuild)",
+    "format": "(gitzone format)"
   },
-  "homepage": "https://gitlab.com/mojoio/mgun#README"
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tstest": "^1.0.15",
+    "@pushrocks/qenv": "^4.0.6",
+    "@pushrocks/tapbundle": "^3.0.7",
+    "@types/node": "^12.11.7",
+    "tslint": "^5.11.0",
+    "tslint-config-prettier": "^1.15.0"
+  },
+  "dependencies": {
+    "@pushrocks/smartmail": "^1.0.6",
+    "@pushrocks/smartrequest": "^1.1.41",
+    "@pushrocks/smartstring": "^3.0.14"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

qenv.yml

@@ -0,0 +1,2 @@
+required:
+  - MAILGUN_API_TOKEN

readme.md

@@ -0,0 +1,26 @@
+# @mojoio/mailgun
+an api abstraction package for mailgun
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@mojoio/mailgun)
+* [gitlab.com (source)](https://gitlab.com/mojoio/mailgun)
+* [github.com (source mirror)](https://github.com/mojoio/mailgun)
+* [docs (typedoc)](https://mojoio.gitlab.io/mailgun/)
+
+## Status for master
+[![build status](https://gitlab.com/mojoio/mailgun/badges/master/build.svg)](https://gitlab.com/mojoio/mailgun/commits/master)
+[![coverage report](https://gitlab.com/mojoio/mailgun/badges/master/coverage.svg)](https://gitlab.com/mojoio/mailgun/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@mojoio/mailgun.svg)](https://www.npmjs.com/package/@mojoio/mailgun)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/mailgun/badge.svg)](https://snyk.io/test/npm/@mojoio/mailgun)
+[![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
+
+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)

test/test.ts

@@ -0,0 +1,31 @@
+import { expect, tap } from '@pushrocks/tapbundle';
+import { Qenv } from '@pushrocks/qenv';
+import * as smartmail from '@pushrocks/smartmail';
+
+const testQenv = new Qenv('./', './.nogit');
+
+import * as mailgun from '../ts/index';
+
+
+let testMailgunAccount: mailgun.MailgunAccount;
+let testSmartmail: smartmail.Smartmail;
+
+tap.test('first test', async () => {
+  testMailgunAccount = new mailgun.MailgunAccount(testQenv.getEnvVarOnDemand('MAILGUN_API_TOKEN'));
+  expect(testMailgunAccount).to.be.instanceOf(mailgun.MailgunAccount);
+});
+
+tap.test('should create a smartmail', async () => {
+  testSmartmail = new smartmail.Smartmail({
+    body: 'hi there. This is the body.',
+    from: 'noreply@mail.lossless.com',
+    subject: 'hi there. This is the subject'
+  });
+  return testSmartmail;
+});
+
+tap.test('should send a smartmail', async () => {
+  testMailgunAccount.sendSmartMail(testSmartmail, 'phil@lossless.com');
+});
+
+tap.start();

ts/index.ts

@@ -0,0 +1 @@
+export * from './mailgun.classes.account';

ts/mailgun.classes.account.ts

@@ -0,0 +1,80 @@
+import * as plugins from './mailgun.plugins';
+
+export class MailgunAccount {
+  public baseUrl = 'https://api.mailgun.net/v3';
+  public apiToken: string;
+
+  constructor(apiTokenArg: string) {
+    this.apiToken = apiTokenArg;
+  }
+
+  public getRequest(routeArg: string) {
+    const requestUrl = `${this.baseUrl}${routeArg}`; // TODO;
+    const response = plugins.smartrequest.request(routeArg, {
+      method: 'GET',
+      headers: {
+        Authorization: `Basic ${plugins.smartstring.base64.encode(
+          this.apiToken
+        )}`,
+        'Content-Type': 'application/json'
+      }
+    });
+  }
+
+  public async postFormData(routeArg: string, formFields: plugins.smartrequest.IFormField[]) {
+    const requestUrl = `${this.baseUrl}${routeArg}`; // TODO;
+    const response = await plugins.smartrequest.postFormData(
+      requestUrl,
+      {
+        headers: {
+          Authorization: `Basic ${plugins.smartstring.base64.encode(
+            `api:key-a049e048b7029b9621c41b5682fadee9`
+          )}`
+        }
+      },
+      formFields
+    );
+    return response;
+  }
+
+  /**
+   * sends a SmartMail
+   */
+  public async sendSmartMail(smartmailArg: plugins.smartmail.Smartmail, toArg: string, dataArg = {}) {
+    const domain = smartmailArg.options.from.split('@')[1];
+    const formFields: plugins.smartrequest.IFormField[] = [
+      {
+        name: 'from',
+        type: 'string',
+        payload: smartmailArg.options.from
+      },
+      {
+        name: 'to',
+        type: 'string',
+        payload: toArg
+      },
+      {
+        name: 'subject',
+        type: 'string',
+        payload: smartmailArg.getSubject(dataArg)
+      },
+      {
+        name: 'html',
+        type: 'string',
+        payload: smartmailArg.getBody(dataArg)
+      }
+    ];
+
+    for (const attachment of smartmailArg.attachments) {
+      formFields.push({
+        name: 'attachment',
+        type: 'Buffer',
+        payload: attachment.contentBuffer,
+        fileName: attachment.parsedPath.base
+      });
+    }
+
+    const response = await this.postFormData(`/${domain}/messages`, formFields);
+    console.log(response);
+  }
+}

ts/mailgun.plugins.ts

@@ -0,0 +1,6 @@
+// @pushrocks scope
+import * as smartmail from '@pushrocks/smartmail';
+import * as smartrequest from '@pushrocks/smartrequest';
+import * as smartstring from '@pushrocks/smartstring';
+
+export { smartmail, smartrequest, smartstring };

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