diff --git a/lib/notification/adapter/mattermost.js b/lib/notification/adapter/mattermost.js new file mode 100644 index 0000000..b3ed3ff --- /dev/null +++ b/lib/notification/adapter/mattermost.js @@ -0,0 +1,52 @@ +const { markdown2Html } = require('../../services/markdown'); +const { getJob } = require('../../services/storage/jobStorage'); +const axios = require('axios'); + +/** + * sends new listings to mattermost + * @param serviceName e.g immowelt + * @param newListings an array with newly found listings + * @param notificationConfig config of this notification adapter + * @param jobKey name of the current job that is being executed + * @returns {Promise | void} + */ +exports.send = ({ serviceName, newListings, notificationConfig, jobKey }) => { + const { webhook, channel } = notificationConfig.find((adapter) => adapter.id === 'mattermost').fields; + const job = getJob(jobKey); + const jobName = job == null ? jobKey : job.name; + + let message = `### *${jobName}* (${serviceName}) found **${newListings.length}** new listings:\n\n`; + message += `| Title | Address | Size | Price |\n|:----|:----|:----|:----|\n`; + message += newListings.map( + (o) => `| [${o.title}](${o.link}) | ` + [o.address, o.size.replace(/2m/g, '$m^2$'), o.price].join(' | ') + ' |\n' + ); + + return axios.post(`${webhook}`, { + channel: channel, + text: message, + }); +}; + +/** + * exported config is being used in the frontend to generate the fields + * incoming values will be the keys (and values) of the fields + * + */ +exports.config = { + id: __filename.slice(__dirname.length + 1, -3), + name: 'Mattermost', + readme: markdown2Html('lib/notification/adapter/mattermost.md'), + description: 'Fredy will send new listings to your mattermost team chat.', + fields: { + webhook: { + type: 'text', + label: 'Webhook-URL', + description: 'The incoming webhook url', + }, + channel: { + type: 'text', + label: 'Channel', + description: 'The channel where fredy should send notifications to.', + }, + }, +}; diff --git a/lib/notification/adapter/mattermost.md b/lib/notification/adapter/mattermost.md new file mode 100644 index 0000000..8763579 --- /dev/null +++ b/lib/notification/adapter/mattermost.md @@ -0,0 +1,5 @@ +### Mattermost Adapter + +For Mattermost, you need to create a incoming webhook. This is pretty easy. Please visit the steps in the [developer docs](https://docs.mattermost.com/developer/webhooks-incoming.html) and follow the instructions. + +As a result, you get the webhook URL for configuration in fredy. In addition, the target channel must be defined. \ No newline at end of file