12 Commits

Author SHA1 Message Date
d044085739 3.0.0 2019-09-18 15:11:55 +02:00
3510767a72 BREAKING CHANGE(changed main class to SlackAccount): update 2019-09-18 15:11:55 +02:00
ec17d7835e 2.0.12 2019-09-18 12:28:42 +02:00
cb072d0f6a fix(core): update 2019-09-18 12:28:41 +02:00
1240505227 2.0.11 2019-09-18 12:27:52 +02:00
09c0bc4e6f fix(core): update 2019-09-18 12:27:52 +02:00
41f98b6869 2.0.10 2019-09-18 12:26:32 +02:00
e854a62eae fix(core): update 2019-09-18 12:26:31 +02:00
ec86352b58 2.0.9 2019-09-08 19:37:13 +02:00
47f1e97386 fix(core): update 2019-09-08 19:37:13 +02:00
f7e1df2e64 2.0.8 2019-09-05 13:09:13 +02:00
552d3dc211 fix(core): update 2019-09-05 13:09:13 +02:00
8 changed files with 123 additions and 38 deletions

View File

@ -38,13 +38,25 @@ snyk:
# test stage
# ====================
testLTS:
testStable:
stage: test
script:
- 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 lts
- npmci npm install
- npmci npm test
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
@ -86,7 +98,9 @@ trigger:
- notpriv
pages:
image: hosttoday/ht-docker-node:npmci
image: hosttoday/ht-docker-dbase:npmci
services:
- docker:stable-dind
stage: metadata
script:
- npmci command npm install -g @gitzone/tsdoc

29
.vscode/launch.json vendored Normal file
View File

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

2
package-lock.json generated
View File

@ -1,6 +1,6 @@
{
"name": "@mojoio/slack",
"version": "2.0.7",
"version": "3.0.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {

View File

@ -1,6 +1,6 @@
{
"name": "@mojoio/slack",
"version": "2.0.7",
"version": "3.0.0",
"private": false,
"description": "slack api abstraction for the mojo.io ecosystem",
"main": "dist/index.js",
@ -27,6 +27,7 @@
"ts_web/*",
"dist/*",
"dist_web/*",
"dist_ts_web/*",
"assets/*",
"cli.js",
"npmextra.json",

View File

@ -101,6 +101,6 @@ mySlackMessage.sendToRoom('anotherroom')
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)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
[![repo-footer](https://mojoio.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

View File

@ -5,14 +5,14 @@ let testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit');
import * as slackme from '../ts/index';
let testSlackme: slackme.Slackme;
let testSlackme: slackme.SlackAccount;
let testSlackMessage: slackme.SlackMessage;
tap.test('should create a valid slackme instance', async () => {
testSlackme = new slackme.Slackme(testQenv.getEnvVarOnDemand('SLACK_TOKEN'));
tap.test('should create a valid slackme instance', async (tools) => {
testSlackme = new slackme.SlackAccount(testQenv.getEnvVarOnDemand('SLACK_TOKEN'));
});
tap.test('should send a message to Slack', async () => {
tap.test('should send a message to Slack', async (tools) => {
testSlackMessage = new slackme.SlackMessage({
author_name: 'GitLab CI',
author_link: 'https://gitlab.com/',
@ -29,15 +29,36 @@ tap.test('should send a message to Slack', async () => {
value: 'pushrocks',
short: true
}
],
ts: new Date().getTime() / 1000
]
});
await testSlackme.sendMessage(testSlackMessage.messageOptions, 'random');
await expect(testSlackMessage.sendToRoom('random')).to.eventually.be.rejected;
});
tap.test('should send a message to Slack by directly calling the message', async () => {
testSlackMessage = new slackme.SlackMessage({
tap.test('should send a message to Slack by directly calling the message', async (tools) => {
testSlackMessage = new slackme.SlackMessage(
{
author_name: 'GitLab CI',
author_link: 'https://gitlab.com/',
pretext: '*Good News*: Build successfull!',
color: '#3cb371',
fields: [
{
title: 'Branch',
value: 'Lossless Cloud',
short: true
},
{
title: 'Product ID',
value: 'pushrocks',
short: true
}
]
},
testSlackme
);
await testSlackMessage.sendToRoom('random');
await tools.delayFor(1000);
await testSlackMessage.updateAndSend({
author_name: 'GitLab CI',
author_link: 'https://gitlab.com/',
pretext: '*Good News*: Build successfull!',
@ -45,7 +66,7 @@ tap.test('should send a message to Slack by directly calling the message', async
fields: [
{
title: 'Branch',
value: 'Lossless Cloud',
value: 'Lossless Studio',
short: true
},
{
@ -53,10 +74,8 @@ tap.test('should send a message to Slack by directly calling the message', async
value: 'pushrocks',
short: true
}
],
ts: new Date().getTime() / 1000
}, testSlackme);
await testSlackMessage.sendToRoom('random');
]
})
});
tap.start();

View File

@ -1,19 +1,33 @@
import * as plugins from './slack.plugins';
import { IMessageOptions } from './slack.classes.slackmessage';
export class Slackme {
private baseUrl = 'https://hooks.slack.com/services/';
private postRoute: string;
constructor(postRouteArg: string) {
this.postRoute = postRouteArg;
export class SlackAccount {
private postUrl = 'https://slack.com/api/chat.postMessage';
private updateUrl = 'https://slack.com/api/chat.update';
private slackToken: string;
constructor(slackTokenArg: string) {
this.slackToken = slackTokenArg;
}
async sendMessage(messageOptionsArg: IMessageOptions, channelArg: string = 'general') {
await plugins.smartrequest.postJson(`${this.baseUrl}${this.postRoute}`, {
requestBody: {
channel: channelArg,
attachments: [messageOptionsArg]
async sendMessage(messageOptionsArg: IMessageOptions, channelArg: string = 'status', tsArg?: string) {
let requestBody: any = {
channel: channelArg,
attachments: [messageOptionsArg]
}
let postUrl = this.postUrl;
if (tsArg) {
requestBody = {
...requestBody,
ts: tsArg
}
postUrl = this.updateUrl;
}
const response = await plugins.smartrequest.postJson(postUrl, {
headers: {
'Authorization': `Bearer ${this.slackToken}`
},
requestBody
});
return response;
}
}

View File

@ -1,5 +1,5 @@
import * as plugins from './slack.plugins';
import { Slackme } from './slack.classes.slackme';
import { SlackAccount } from './slack.classes.slackme';
export interface IAttachmentField {
title: string;
@ -49,24 +49,32 @@ export interface IMessageOptions {
thumb_url?: string;
footer?: string;
footer_icon?: string;
/**
* timestamp as epoch time
*/
ts?: number;
}
export class SlackMessage {
slackmeRef: Slackme;
slackmeRef: SlackAccount;
messageOptions: IMessageOptions;
constructor(messageOptionsArg: IMessageOptions, slackmeArg?: Slackme) {
channel: string;
ts: string;
constructor(messageOptionsArg: IMessageOptions, slackmeArg?: SlackAccount) {
if (slackmeArg) {
this.slackmeRef = slackmeArg;
}
this.messageOptions = messageOptionsArg;
}
async updateAndSend(messageOptionsArg: IMessageOptions) {
this.messageOptions = messageOptionsArg;
await this.sendToRoom(this.channel);
}
async sendToRoom(roomNameArg: string) {
this.channel = roomNameArg;
if (this.slackmeRef) {
await this.slackmeRef.sendMessage(this.messageOptions, roomNameArg);
const response = await this.slackmeRef.sendMessage(this.messageOptions, roomNameArg, this.ts);
this.ts = response.body.message.ts;
this.channel = response.body.channel;
} else {
throw new Error('you need to set a slackRef before sending the message!');
}