Compare commits

..

1 Commits

Author SHA1 Message Date
946e862b1c 1.0.18 2020-01-13 14:06:34 +00:00
12 changed files with 542 additions and 495 deletions

4
.gitignore vendored
View File

@ -15,6 +15,8 @@ node_modules/
# builds # builds
dist/ dist/
dist_*/ dist_web/
dist_serve/
dist_ts_web/
# custom # custom

View File

@ -3,14 +3,14 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache: cache:
paths: paths:
- .npmci_cache/ - .npmci_cache/
key: '$CI_BUILD_STAGE' key: "$CI_BUILD_STAGE"
stages: stages:
- security - security
- test - test
- release - release
- metadata - metadata
# ==================== # ====================
# security stage # security stage
@ -18,24 +18,21 @@ stages:
mirror: mirror:
stage: security stage: security
script: script:
- npmci git mirror - npmci git mirror
tags: tags:
- lossless - docker
- docker - notpriv
- notpriv
audit: snyk:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci command npm install -g snyk
- npmci command npm install --ignore-scripts - npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org - npmci command snyk test
- npmci command npm audit --audit-level=high
tags: tags:
- lossless - docker
- docker - notpriv
- notpriv
# ==================== # ====================
# test stage # test stage
@ -44,40 +41,37 @@ audit:
testStable: testStable:
stage: test stage: test
script: script:
- npmci npm prepare - npmci npm prepare
- npmci node install stable - npmci node install stable
- npmci npm install - npmci npm install
- npmci npm test - npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless - docker
- docker - priv
- priv
testBuild: testBuild:
stage: test stage: test
script: script:
- npmci npm prepare - npmci npm prepare
- npmci node install stable - npmci node install stable
- npmci npm install - npmci npm install
- npmci command npm run build - npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless - docker
- docker - notpriv
- notpriv
release: release:
stage: release stage: release
script: script:
- npmci node install stable - npmci node install stable
- npmci npm publish - npmci npm publish
only: only:
- tags - tags
tags: tags:
- lossless - docker
- docker - notpriv
- notpriv
# ==================== # ====================
# metadata stage # metadata stage
@ -91,20 +85,18 @@ codequality:
- npmci npm install - npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts" - npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags: tags:
- lossless - docker
- docker - priv
- priv
trigger: trigger:
stage: metadata stage: metadata
script: script:
- npmci trigger - npmci trigger
only: only:
- tags - tags
tags: tags:
- lossless - docker
- docker - notpriv
- notpriv
pages: pages:
stage: metadata stage: metadata
@ -115,7 +107,6 @@ pages:
- npmci npm install - npmci npm install
- npmci command tsdoc - npmci command tsdoc
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
only: only:
@ -123,5 +114,5 @@ pages:
artifacts: artifacts:
expire_in: 1 week expire_in: 1 week
paths: paths:
- public - public
allow_failure: true allow_failure: true

4
.snyk
View File

@ -1,4 +0,0 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.13.5
ignore: {}
patch: {}

View File

@ -11,13 +11,7 @@
}, },
"gitzone": { "gitzone": {
"type": "object", "type": "object",
"description": "settings for gitzone", "description": "settings for gitzone"
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm"]
}
}
} }
} }
} }

View File

@ -1,6 +1,5 @@
{ {
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "mojoio", "gitscope": "mojoio",

781
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,38 +1,37 @@
{ {
"name": "@mojoio/mailgun", "name": "@mojoio/mailgun",
"version": "1.0.26", "version": "1.0.18",
"private": false, "private": false,
"description": "an api abstraction package for mailgun", "description": "an api abstraction package for mailgun",
"main": "dist_ts/index.js", "main": "dist/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist/index.d.ts",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/)",
"build": "(tsbuild --web)", "build": "(tsbuild)",
"format": "(gitzone format)" "format": "(gitzone format)"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.22", "@gitzone/tsbuild": "^2.0.22",
"@gitzone/tstest": "^1.0.15", "@gitzone/tstest": "^1.0.15",
"@pushrocks/qenv": "^4.0.6", "@pushrocks/qenv": "^4.0.6",
"@pushrocks/tapbundle": "^3.2.1", "@pushrocks/tapbundle": "^3.2.0",
"@types/node": "^13.13.4", "@types/node": "^13.1.6",
"tslint": "^6.1.1", "tslint": "^5.20.1",
"tslint-config-prettier": "^1.15.0" "tslint-config-prettier": "^1.15.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/smartfile": "^7.0.12", "@pushrocks/smartfile": "^7.0.6",
"@pushrocks/smartmail": "^1.0.11", "@pushrocks/smartmail": "^1.0.8",
"@pushrocks/smartrequest": "^1.1.47", "@pushrocks/smartrequest": "^1.1.47",
"@pushrocks/smartstring": "^3.0.18" "@pushrocks/smartstring": "^3.0.17"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
"ts_web/**/*", "ts_web/**/*",
"dist/**/*", "dist/**/*",
"dist_*/**/*", "dist_web/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*", "dist_ts_web/**/*",
"assets/**/*", "assets/**/*",
"cli.js", "cli.js",

View File

@ -8,29 +8,16 @@ an api abstraction package for mailgun
* [docs (typedoc)](https://mojoio.gitlab.io/mailgun/) * [docs (typedoc)](https://mojoio.gitlab.io/mailgun/)
## Status for master ## Status for master
[![build status](https://gitlab.com/mojoio/mailgun/badges/master/build.svg)](https://gitlab.com/mojoio/mailgun/commits/master)
Status Category | Status Badge [![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)
GitLab Pipelines | [![pipeline status](https://gitlab.com/mojoio/mailgun/badges/master/pipeline.svg)](https://lossless.cloud) [![Known Vulnerabilities](https://snyk.io/test/npm/@mojoio/mailgun/badge.svg)](https://snyk.io/test/npm/@mojoio/mailgun)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/mojoio/mailgun/badges/master/coverage.svg)](https://lossless.cloud) [![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@mojoio/mailgun)](https://lossless.cloud) [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/mojoio/mailgun)](https://lossless.cloud) [![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@mojoio/mailgun)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@mojoio/mailgun)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@mojoio/mailgun)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage ## Usage
Use TypeScript for best in class intellisense.
## Contribution
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
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 | **©** [Lossless GmbH](https://lossless.gmbh) > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

View File

@ -5,12 +5,12 @@ import * as smartmail from '@pushrocks/smartmail';
const testQenv = new Qenv('./', './.nogit'); const testQenv = new Qenv('./', './.nogit');
import * as mailgun from '../ts/index'; import * as mailgun from '../ts/index';
import { IMailgunMessage } from '../ts/index';
let testMailgunAccount: mailgun.MailgunAccount; let testMailgunAccount: mailgun.MailgunAccount;
let testSmartmail: smartmail.Smartmail<IMailgunMessage>; let testSmartmail: smartmail.Smartmail;
tap.test('should create a mailgun account', async () => { tap.test('first test', async () => {
testMailgunAccount = new mailgun.MailgunAccount(testQenv.getEnvVarOnDemand('MAILGUN_API_TOKEN')); testMailgunAccount = new mailgun.MailgunAccount(testQenv.getEnvVarOnDemand('MAILGUN_API_TOKEN'));
expect(testMailgunAccount).to.be.instanceOf(mailgun.MailgunAccount); expect(testMailgunAccount).to.be.instanceOf(mailgun.MailgunAccount);
}); });
@ -18,25 +18,21 @@ tap.test('should create a mailgun account', async () => {
tap.test('should create a smartmail', async () => { tap.test('should create a smartmail', async () => {
testSmartmail = new smartmail.Smartmail({ testSmartmail = new smartmail.Smartmail({
body: 'hi there. This is the body.', body: 'hi there. This is the body.',
from: 'Lossless GmbH <noreply@mail.lossless.com>', from: 'noreply@mail.lossless.com',
subject: 'TestMessage from @mojoio/mailgun test' subject: 'hi there. This is the subject'
}); });
return testSmartmail; return testSmartmail;
}); });
tap.test('should send a smartmail', async () => { tap.test('should send a smartmail', async () => {
await testMailgunAccount.sendSmartMail(testSmartmail, 'Sandbox Team <sandbox@mail.git.zone>'); testMailgunAccount.sendSmartMail(testSmartmail, 'sandbox@mail.git.zone');
}); });
tap.test('should retrieve a mail using a retrieval url', async () => { tap.test('should retrieve a mail using a retrieval url', async () => {
const result = await testMailgunAccount.retrieveSmartMailFromMessageUrl( const result = await testMailgunAccount.retrieveSmartMailFromMessageUrl('https://sw.api.mailgun.net/v3/domains/mail.lossless.one/messages/AgMFnnnAKC8xp_dDa79LyoxhloxtaVmnRA==');
'https://sw.api.mailgun.net/v3/domains/mail.lossless.one/messages/AgMFnnnAKC8xp_dDa79LyoxhloxtaVmnRA==' result.options.subject = 'hi there. This is a testmail with attachment';
); result.options.from = 'noreply@mail.lossless.com';
if (result) { testMailgunAccount.sendSmartMail(result, 'sandbox@mail.git.zone');
result.options.subject = 'hi there. This is a testmail with attachment';
result.options.from = 'noreply@mail.lossless.com';
await testMailgunAccount.sendSmartMail(result, 'Sandbox Team <sandbox@mail.git.zone>');
}
}); });
tap.start(); tap.start();

View File

@ -15,14 +15,14 @@ export interface IMailgunMessage {
'X-Gm-Message-State': string; 'X-Gm-Message-State': string;
'body-plain': string; 'body-plain': string;
attachments: Array<{ attachments: Array<{
url: string; url: string,
'content-type': string; 'content-type': string,
name: string; name: string,
size: number; size: number
}>; }>;
'body-html': string; 'body-html': string;
'Mime-Version': string; 'Mime-Version': string;
Date: string; Date: string,
'Message-Id': string; 'Message-Id': string;
'Content-Type': string; 'Content-Type': string;
'X-Google-Smtp-Source': string; 'X-Google-Smtp-Source': string;

View File

@ -6,13 +6,13 @@ export interface IMailgunNotification {
'Received-Spf': string; 'Received-Spf': string;
From: string; From: string;
'Return-Path': string; 'Return-Path': string;
'Arc-Seal': string[]; 'Arc-Seal': string[],
'Delivered-To': string; 'Delivered-To': string;
'X-Google-Dkim-Signature': string; 'X-Google-Dkim-Signature': string;
To: string; To: string;
'Dkim-Signature': string; 'Dkim-Signature': string;
subject: string; subject: 'Booking confirmation (Order 12PN8P)';
from: string; from: 'buchungsbestaetigung@bahn.de';
'X-Received': string[]; 'X-Received': string[];
'Ironport-Sdr': string; 'Ironport-Sdr': string;
'Arc-Authentication-Results': string[]; 'Arc-Authentication-Results': string[];
@ -32,16 +32,13 @@ export interface IMailgunNotification {
'X-Forwarded-For': string; 'X-Forwarded-For': string;
'X-Gm-Message-State': string; 'X-Gm-Message-State': string;
'X-Google-Smtp-Source': string; 'X-Google-Smtp-Source': string;
'X-Envelope-From': string; 'X-Envelope-From': '<phil+caf_=invoiceinbox=mail.lossless.one@lossless.com>';
'Content-Type': string; 'Content-Type': 'multipart/mixed; boundary="----=_Part_220882_156025801.1578848484963"';
'X-Forwarded-To': string; 'X-Forwarded-To': 'invoiceinbox@mail.lossless.one';
Subject: string; Subject: string;
attachments: string; attachments: string;
'body-plain': string; 'body-plain': string;
'stripped-text': string; 'stripped-text': string;
'stripped-html': string; 'stripped-html': string;
'stripped-signature': string; 'stripped-signature': string;
}
// Lossless specific
'X-Lossless-Auth': string;
}

View File

@ -12,12 +12,14 @@ export class MailgunAccount {
public async getRequest(routeArg: string, binaryArg: boolean = false) { public async getRequest(routeArg: string, binaryArg: boolean = false) {
let requestUrl = routeArg; let requestUrl = routeArg;
const needsBaseUrlPrefix = !routeArg.startsWith('https://'); const needsBaseUrlPrefix = !routeArg.startsWith('https://');
needsBaseUrlPrefix ? (requestUrl = `${this.baseUrl}${routeArg}`) : null; needsBaseUrlPrefix ? requestUrl = `${this.baseUrl}${routeArg}` : null;
console.log(requestUrl); console.log(requestUrl);
const requestOptions: plugins.smartrequest.ISmartRequestOptions = { const requestOptions: plugins.smartrequest.ISmartRequestOptions = {
method: 'GET', method: 'GET',
headers: { headers: {
Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}`, Authorization: `Basic ${plugins.smartstring.base64.encode(
`api:${this.apiToken}`
)}`,
'Content-Type': 'application/json' 'Content-Type': 'application/json'
} }
}; };
@ -36,7 +38,9 @@ export class MailgunAccount {
requestUrl, requestUrl,
{ {
headers: { headers: {
Authorization: `Basic ${plugins.smartstring.base64.encode(`api:${this.apiToken}`)}` Authorization: `Basic ${plugins.smartstring.base64.encode(
`api:${this.apiToken}`
)}`
} }
}, },
formFields formFields
@ -47,12 +51,8 @@ export class MailgunAccount {
/** /**
* sends a SmartMail * sends a SmartMail
*/ */
public async sendSmartMail( public async sendSmartMail(smartmailArg: plugins.smartmail.Smartmail, toArg: string, dataArg = {}) {
smartmailArg: plugins.smartmail.Smartmail<interfaces.IMailgunMessage>, const domain = smartmailArg.options.from.split('@')[1];
toArg: string,
dataArg = {}
) {
const domain = smartmailArg.options.from.split('@')[1].replace('>', '');
const formFields: plugins.smartrequest.IFormField[] = [ const formFields: plugins.smartrequest.IFormField[] = [
{ {
name: 'from', name: 'from',
@ -98,36 +98,27 @@ export class MailgunAccount {
public async retrieveSmartMailFromMessageUrl(messageUrlArg: string) { public async retrieveSmartMailFromMessageUrl(messageUrlArg: string) {
const response = await this.getRequest(messageUrlArg); const response = await this.getRequest(messageUrlArg);
if (response.statusCode === 404) {
console.log(response.body.message);
return null;
}
const responseBody: interfaces.IMailgunMessage = response.body; const responseBody: interfaces.IMailgunMessage = response.body;
const smartmail = new plugins.smartmail.Smartmail<interfaces.IMailgunMessage>({ const smartmail = new plugins.smartmail.Smartmail({
from: responseBody.From, from: responseBody.From,
body: responseBody['body-html'], body: responseBody["body-html"],
subject: responseBody.Subject, subject: responseBody.Subject,
creationObjectRef: responseBody
}); });
// lets care about attachments // lets care about attachments
if (responseBody.attachments && responseBody.attachments instanceof Array) { for (const attachmentInfo of responseBody.attachments) {
for (const attachmentInfo of responseBody.attachments) { const attachmentName = attachmentInfo.name;
const attachmentName = attachmentInfo.name; const attachmentContents = await this.getRequest(attachmentInfo.url, true);
const attachmentContents = await this.getRequest(attachmentInfo.url, true); smartmail.addAttachment(new plugins.smartfile.Smartfile({
smartmail.addAttachment( path: `./${attachmentName}`,
new plugins.smartfile.Smartfile({ base: `./${attachmentName}`,
path: `./${attachmentName}`, contentBuffer: attachmentContents.body
base: `./${attachmentName}`, }));
contentBuffer: attachmentContents.body
})
);
}
} }
return smartmail; return smartmail;
} }
public async retrieveSmartMailFromNotifyPayload(notifyPayloadArg: any) { public async retrieveSmartMailFromNotifyPayload(notifyPayloadArg: any) {
return await this.retrieveSmartMailFromMessageUrl(notifyPayloadArg['message-url']); return await this.retrieveSmartMailFromMessageUrl(notifyPayloadArg['message-url']);
} }