3.8.0

Fix mediawiki integration

.github/release-drafter.yml

@@ -0,0 +1,4 @@
+template: |
+  ## Changes
+
+  $CHANGES

README.md

@@ -116,3 +116,29 @@ wiki's API on its own.
 
 [kredits-contracts]: https://github.com/67P/kredits-contracts
 [GitHub OAuth app]: https://developer.github.com/apps/about-apps/#about-oauth-apps
+
+
+### Zoom
+
+The Zoom integration creates contributions for meeting participations.
+
+Every meeting that is longer than 15 minutes and with more than 2 participants will be registered.
+An optional meeting whitelist can be configured to create contributions only for specific meetings.
+
+
+#### Setup
+
+A Zoom JWT app has to be set up and an [event webhook subscription](https://marketplace.zoom.us/docs/api-reference/webhook-reference/meeting-events/meeting-ending")
+on `meeting.ended` has to be configured to the following URL:
+
+    https://your-hubot.example.com/incoming/kredits/zoom/{webhook_token}
+
+#### Config
+
+| Key | Description |
+| --- | --- |
+| `KREDITS_ZOOM_JWT` | The JWT for the Zoom application (required)
+| `KREDITS_ZOOM_MEETING_WHITELIST` | Comma separated list of meeting names for which kredits should be tracked (optional)
+| `KREDITS_ZOOM_CONTRIBUTION_AMOUNT` | The amount of kredits issued for each meeting. (default: 500)
+
+[Zoom apps](https://marketplace.zoom.us/user/build)

index.js

@@ -2,6 +2,7 @@ const fs = require('fs');
 const util = require('util');
 const fetch = require('node-fetch');
 const ethers = require('ethers');
+const NonceManager = require('@ethersproject/experimental').NonceManager;
 const Kredits = require('kredits-contracts');
 
 const walletPath  = process.env.KREDITS_WALLET_PATH || './wallet.json';
@@ -43,7 +44,7 @@ module.exports = async function(robot) {
   } else {
     ethProvider = new ethers.getDefaultProvider('rinkeby');
   }
-  const signer = wallet.connect(ethProvider);
+  const signer = new NonceManager(wallet.connect(ethProvider));
 
   //
   // Kredits contracts setup
@@ -152,6 +153,10 @@ module.exports = async function(robot) {
   require('./integrations/github')(robot, kredits);
   require('./integrations/gitea')(robot, kredits);
 
+  if (typeof process.env.KREDITS_ZOOM_JWT !== 'undefined') {
+    require('./integrations/zoom')(robot, kredits);
+  }
+
   if (typeof process.env.KREDITS_MEDIAWIKI_URL !== 'undefined') {
     require('./integrations/mediawiki')(robot, kredits);
   }

integrations/gitea.js

@@ -1,5 +1,4 @@
 const util = require('util');
-const fetch = require('node-fetch');
 const amountFromLabels = require('./utils/amount-from-labels');
 const kindFromLabels = require('./utils/kind-from-labels');
 
@@ -56,7 +55,7 @@ module.exports = async function(robot, kredits) {
       robot.logger.debug(`[hubot-kredits] contribution attributes:`);
       robot.logger.debug(util.inspect(contributionAttr, { depth: 1, colors: true }));
 
-      return Contribution.addContribution(contributionAttr).catch(error => {
+      return Contribution.add(contributionAttr).catch(error => {
         robot.logger.error(`[hubot-kredits] Error:`, error);
         messageRoom(`I tried to add a contribution for ${giteaUser} for ${url}, but I encountered an error when submitting the tx:`);
         messageRoom(error.message);

integrations/github.js

@@ -61,7 +61,7 @@ module.exports = async function(robot, kredits) {
       robot.logger.debug(`[hubot-kredits] contribution attributes:`);
       robot.logger.debug(util.inspect(contributionAttr, { depth: 1, colors: true }));
 
-      return Contribution.addContribution(contributionAttr).catch(error => {
+      return Contribution.add(contributionAttr).catch(error => {
         robot.logger.error(`[hubot-kredits] Error:`, error);
         messageRoom(`I tried to add a contribution for ${githubUser} for ${url}, but I encountered an error when submitting the tx:`);
         messageRoom(error.message);

integrations/mediawiki.js

@@ -48,7 +48,7 @@ module.exports = async function(robot, kredits) {
         kind: 'docs'
       };
 
-      return Contribution.addContribution(contribution).catch(error => {
+      return Contribution.add(contribution).catch(error => {
         robot.logger.error(`[hubot-kredits] Adding contribution failed:`, error);
       });
     }).catch(() => {
@@ -126,6 +126,7 @@ module.exports = async function(robot, kredits) {
     return [...new Set(changes.map(c => `"${c.title}"`))].join(', ');
   }
 
+  // Currently not used
   function calculateAmountForChanges(details) {
     let amount;
 
@@ -144,9 +145,8 @@ module.exports = async function(robot, kredits) {
     const dateNow = new Date();
     const dateYesterday = dateNow.setDate(dateNow.getDate() - 1);
     const date = (new Date(dateYesterday)).toISOString().split('T')[0];
-
     const details = analyzeUserChanges(user, changes);
-    const amount = calculateAmountForChanges(details);
+    const amount = 500;
 
     let desc = `Added ${details.charsAdded} characters of text.`;
     if (details.pagesChanged.length > 0) {

integrations/zoom.js

@@ -0,0 +1,102 @@
+const fetch = require('node-fetch');
+
+function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+module.exports = async function(robot, kredits) {
+
+  function messageRoom(message) {
+    robot.messageRoom(process.env.KREDITS_ROOM, message);
+  }
+
+  const { Contributor, Contribution } = kredits;
+
+  const kreditsContributionAmount = process.env.KREDITS_ZOOM_CONTRIBUTION_AMOUNT || 500;
+  const kreditsContributionKind = 'community';
+
+  const zoomAccessToken = process.env.KREDITS_ZOOM_JWT;
+
+  async function createContributionFor (displayName, meeting) {
+    const contributor = await getContributorByZoomDisplayName(displayName);
+
+    if (!contributor) {
+      robot.logger.info(`[hubot-kredits] Contributor not found: Zoom display name: ${displayName}`);
+      messageRoom(`I tried to add a contribution for zoom user ${displayName}, but did not find a matching contributor profile.`);
+      return Promise.resolve();
+    }
+
+    const contribution = {
+      contributorId: contributor.id,
+      contributorIpfsHash: contributor.ipfsHash,
+      amount: kreditsContributionAmount,
+      kind: kreditsContributionKind,
+      description: 'Team/Community Call',
+      date: meeting.end_time.split('T')[0],
+      time: meeting.end_time.split('T')[1]
+    }
+
+    return Contribution.add(contribution)
+      .then(tx => {
+        robot.logger.info(`[hubot-kredits] Contribution created: ${tx.hash}`);
+      })
+      .catch(error => {
+        robot.logger.error(`[hubot-kredits] Adding contribution for Zoom call failed:`, error);
+      });
+  }
+
+  function getContributorByZoomDisplayName(displayName) {
+    return Contributor.findByAccount({ site: 'zoom.us', username: displayName });
+  }
+
+  function request(path) {
+    return fetch(
+      `https://api.zoom.us/v2${path}`,
+      {headers: {authorization: `Bearer ${zoomAccessToken}`}}
+    );
+  }
+
+  function getMeetingParticipants(meetingUUID) {
+    return request(`/past_meetings/${meetingUUID}/participants`)
+      .then(response => response.json())
+      .then(json => json.participants)
+  }
+
+  function getMeetingDetails(meetingUUID) {
+    return request(`/past_meetings/${meetingUUID}`)
+      .then(r => r.json());
+  }
+
+  async function handleZoomMeetingEnded(data) {
+    const meetingDetails = await getMeetingDetails(data.uuid);
+    const participants = await getMeetingParticipants(data.uuid);
+    const names = Array.from(new Set(participants.map(p => p.name)));
+
+    if (meetingDetails.duration < 15 || names.length < 3) {
+      robot.logger.info(`[hubot-kredits] Ignoring zoom call ${data.uuid} (duration: ${meetingDetails.duration}, participants_count: ${meetingDetails.participants_count})`);
+      return;
+    }
+
+    for (const displayName of names) {
+      await createContributionFor(displayName, meetingDetails);
+      await sleep(60000); // potentially to prevent too many transactions at the sametime. transactions need to be ordered because of the nonce. not sure though if this is needed.
+    };
+  }
+
+  robot.router.post('/incoming/kredits/zoom/'+process.env.KREDITS_WEBHOOK_TOKEN, (req, res) => {
+    let data = req.body;
+    const eventName = data.event;
+    const payload = data.payload;
+    const object = payload.object;
+
+
+    if (eventName === 'meeting.ended' && (
+        !process.env.KREDITS_ZOOM_MEETING_WHITELIST ||
+          process.env.KREDITS_ZOOM_MEETING_WHITELIST.split(',').includes(object.id)
+      )) {
+      handleZoomMeetingEnded(object);
+    }
+
+    res.sendStatus(200);
+  })
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hubot-kredits",
-  "version": "3.4.1",
+  "version": "3.8.0",
   "description": "Kosmos Kredits functionality for chat bots",
   "main": "index.js",
   "scripts": {
@@ -12,13 +12,14 @@
   "dependencies": {
     "cors": "^2.8.5",
     "eth-provider": "^0.2.2",
-    "ethers": "^4.0.27",
+    "ethers": "^5.0.5",
+    "@ethersproject/experimental": "5.0.0",
     "express": "^4.17.1",
     "express-session": "^1.16.2",
     "grant-express": "^4.6.1",
     "group-array": "^1.0.0",
     "kosmos-schemas": "^1.1.2",
-    "kredits-contracts": "^5.4.0",
+    "kredits-contracts": "^6.0.0",
     "node-cron": "^2.0.3",
     "node-fetch": "^2.3.0",
     "prompt": "^1.0.0"