Merge pull request 'Propose kredits for PR reviews' (#71) from feature/review-kredits into master

Reviewed-on: #71
Reviewed-by: slvrbckt <slvrbckt@noreply.kosmos.org>

.env.example

@@ -0,0 +1,2 @@
+GITEA_TOKEN=your-token-here
+GITHUB_TOKEN=your-token-here

.github/release-drafter.yml

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

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 wallet.json
+.env

README.md

@@ -1,4 +1,4 @@
-[![npm](https://img.shields.io/npm/v/hubot-kredits.svg)](https://www.npmjs.com/package/hubot-kredits)
+[![npm](https://img.shields.io/npm/v/@kredits/hubot-kredits.svg)](https://www.npmjs.com/package/@kredits/hubot-kredits)
 
 # Hubot Kredits
 
@@ -10,8 +10,33 @@ contributions.
 
 ## Setup
 
-You will need an Ethereum wallet for your bot, so it can interact with the
-Ethereum smart contracts. `npm run create-wallet` will do the job for you.
+### Wallet
+
+You will need a keypair/wallet for your bot, so it can interact with the smart
+contracts. `npm run create-wallet` will do the job for you.
+
+The wallet must be funded with enough native chain tokens to interact with the
+contracts (i.e. it must be able to pay gas/tx fees)
+
+### Contract permissions
+
+**Warning: outdated instructions!**
+
+*TODO adapt instructions for new permission model*
+
+The bot wallet needs the following Aragon contract permissions to interact
+with [kredits-contracts]:
+
+1. `ADD_CONTRIBUTION_ROLE` on the `Contribution` contract
+2. `MANAGE_CONTRIBUTORS_ROLE` on the `Contributor` contract
+
+These permissions can be configured using the [Aragon
+CLI](https://hack.aragon.org/docs/cli-intro.html) (see [kredits-contracts].
+
+    aragon dao acl grant [DAO address] [contribution app address] ADD_CONTRIBUTION_ROLE [bot wallet address]
+    aragon dao acl grant [DAO address] [contributor app address] MANAGE_CONTRIBUTORS_ROLE [bot wallet address]
+
+To get the `Contribution` and `Contributor` app addresses use `aragon dao apps`.
 
 ## Configuration
 
@@ -21,10 +46,13 @@ As usual in Hubot, you can add all config as environment variables.
 | --- | --- |
 | `KREDITS_WEBHOOK_TOKEN` | A string for building your secret webhook URLs |
 | `KREDITS_ROOM` | The bot will talk to you in this room |
-| `KREDITS_WALLET_PATH` | Path to an Etherum wallet JSON file (default: `./wallet.json`) |
+| `KREDITS_WALLET_PATH` | Path to an wallet JSON file (default: `./wallet.json`) |
 | `KREDITS_WALLET_PASSWORD` | Wallet password |
-| `KREDITS_PROVIDER_URL` | Ethereum JSON-RPC URL (default: `http://localhost:7545`) |
-| `KREDITS_NETWORK_ID` | The ethereum network ID to use (default: 100 = local) |
+| `KREDITS_PROVIDER_URL` | JSON-RPC URL of a blockchain node (default: `http://localhost:7545`) |
+| `KREDITS_WEB_URL` | URL of the Kredits Web app (default: `https://kredits.kosmos.org`) |
+| `KREDITS_SESSION_SECRET` | Secret used by [grant](https://www.npmjs.com/package/grant) to sign the session ID |
+| `KREDITS_GRANT_HOST` | Host used by [grant](https://www.npmjs.com/package/grant) to generate OAuth redirect URLs (default: `localhost:8888`) |
+| `KREDITS_GRANT_PROTOCOL` | Protocol (http or https) used by [grant](https://www.npmjs.com/package/grant") to generate the OAuth redirect URLs (default: "http") |
 
 ## Integrations
 
@@ -35,6 +63,12 @@ which carry a kredits label: `kredits-1`, `kredits-2`, `kredits-3` for small,
 medium and large contributions. If there are multiple people assigned, it will
 issue contribution tokens for all of them.
 
+If `KREDITS_GITHUB_KEY` and `KREDITS_GITHUB_SECRET` are set, the bot will also
+expose OAuth endpoints to authenticate new contributors and register new
+contributor profiles on the smart contract. For this feature, a [GitHub OAuth
+app] is required and the [OAuth grant config variables](#Configuration) must be
+set.
+
 #### Setup
 
 Point a GitHub organization webhook to the following URL:
@@ -46,6 +80,27 @@ Point a GitHub organization webhook to the following URL:
 | Key | Description |
 | --- | --- |
 | `KREDITS_GITHUB_REPO_BLACKLIST` | Repos which you do not want to issue kredits for. Format: `orgname/reponame`, e.g. `67P/test-one-two` |
+| `KREDITS_GITHUB_KEY` | Key of the [GitHub OAuth app] used to authenticate contributors |
+| `KREDITS_GITHUB_SECRET` | Secret of the [GitHub OAuth app] used to authenticate contributors |
+
+### Gitea
+
+The Gitea integration will watch for closed issues and merged pull requests,
+which carry a kredits label: `kredits-1`, `kredits-2`, `kredits-3` for small,
+medium and large contributions. If there are multiple people assigned, it will
+issue contribution tokens for all of them.
+
+#### Setup
+
+Point a Gitea organization webhook to the following URL:
+
+    https://your-hubot.example.com/incoming/kredits/gitea/{webhook_token}
+
+#### Config
+
+| Key | Description |
+| --- | --- |
+| `KREDITS_GITEA_REPO_BLACKLIST` | Repos which you do not want to issue kredits for. Format: `orgname/reponame`, e.g. `kosmos/test-one-two` |
 
 ### MediaWiki
 
@@ -62,3 +117,32 @@ wiki's API on its own.
 | Key | Description |
 | --- | --- |
 | `KREDITS_MEDIAWIKI_URL` | Your wiki URL, e.g. `https://wiki.kosmos.org/` |
+
+[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

@@ -1,13 +1,11 @@
 const fs = require('fs');
-const util = require('util');
-const fetch = require('node-fetch');
 const ethers = require('ethers');
-const Kredits = require('kredits-contracts');
+const NonceManager = require('@ethersproject/experimental').NonceManager;
+const Kredits = require('@kredits/contracts');
 
 const walletPath  = process.env.KREDITS_WALLET_PATH || './wallet.json';
 const walletJson  = fs.readFileSync(walletPath);
-const providerUrl = process.env.KREDITS_PROVIDER_URL;
-const networkId = parseInt(process.env.KREDITS_NETWORK_ID || 100);
+const providerUrl = process.env.KREDITS_PROVIDER_URL || 'http://localhost:7545';
 
 const ipfsConfig = {
   host: process.env.IPFS_API_HOST || 'localhost',
@@ -37,32 +35,27 @@ module.exports = async function(robot) {
   // Ethereum provider/node setup
   //
 
-  let ethProvider;
-  if (providerUrl) {
-    ethProvider = new ethers.providers.JsonRpcProvider(providerUrl);
-  } else {
-    ethProvider = new ethers.getDefaultProvider('rinkeby');
-  }
-  const signer = wallet.connect(ethProvider);
+  robot.logger.info('[hubot-kredits] Using blockchain node/API at', providerUrl);
+
+  const ethProvider = new ethers.providers.JsonRpcProvider(providerUrl);
+  const signer = new NonceManager(wallet.connect(ethProvider));
 
   //
   // Kredits contracts setup
   //
 
+  const opts = { ipfsConfig };
   let kredits;
+
   try {
-    kredits = await new Kredits(signer.provider, signer, {
-      // TODO support local devchain custom address
-      apm: 'open.aragonpm.eth',
-      ipfsConfig
-    }).init();
+    kredits = await new Kredits(signer.provider, signer, opts).init();
   } catch(error) {
     robot.logger.warning('[hubot-kredits] Could not set up kredits:', error);
     process.exit(1);
   }
   const Contributor = kredits.Contributor;
-  const Proposal = kredits.Proposal;
   const Contribution = kredits.Contribution;
+  // TODO const Reimbursement = kredits.Reimbursement;
 
   robot.logger.info('[hubot-kredits] Wallet address: ' + wallet.address);
 
@@ -71,9 +64,9 @@ module.exports = async function(robot) {
   //
 
   ethProvider.getBalance(wallet.address).then(balance => {
-    robot.logger.info('[hubot-kredits] Wallet balance: ' + ethers.utils.formatEther(balance) + 'ETH');
+    robot.logger.info('[hubot-kredits] Wallet balance: ' + ethers.utils.formatEther(balance) + ' RBTC');
     if (balance.lt(ethers.utils.parseEther('0.0001'))) {
-      messageRoom(`Yo gang, I\'m broke! Please drop me some ETH to ${wallet.address}. kthxbai.`);
+      messageRoom(`Yo gang, I\'m broke! Please send some RBTC to ${wallet.address}. kthxbai.`);
     }
   });
 
@@ -81,30 +74,9 @@ module.exports = async function(robot) {
   // Robot chat commands/interaction
   //
 
-  robot.respond(/got ETH\??/i, res => {
+  robot.respond(/got RBTC\??/i, res => {
     ethProvider.getBalance(wallet.address).then((balance) => {
-      res.send(`My wallet contains ${ethers.utils.formatEther(balance)} ETH`);
-    });
-  });
-
-  robot.respond(/propose (\d*)\s?\S*\s?to (\S+)(?:\sfor (.*))?$/i, res => {
-    let [_, amount, githubUser, description] = res.match;
-    let url = null;
-    createProposal(githubUser, amount, description, url).then((result) => {
-      messageRoom('Sounds good! Will be listed on https://kredits.kosmos.org in a bit...');
-    });
-  });
-
-  robot.respond(/list open proposals/i, res => {
-    Proposal.all().then((proposals) => {
-      proposals.forEach((proposal) => {
-        if (!proposal.executed) {
-          Contributor.getById(proposal.contributorId).then((contributor) => {
-            messageRoom(`* ${proposal.amount} kredits to ${contributor.name} for ${proposal.description}`);
-          });
-        }
-      });
-      messageRoom('https://kredits.kosmos.org');
+      res.send(`My wallet contains ${ethers.utils.formatEther(balance)} RBTC`);
     });
   });
 
@@ -113,31 +85,23 @@ module.exports = async function(robot) {
   //
 
   function watchContractEvents() {
-    ethProvider.getBlockNumber().then((blockNumber) => {
+    ethProvider.getBlockNumber().then(blockNumber => {
       // current block is the last mined one, thus we check from the next
       // mined one onwards to prevent getting previous events
       let nextBlock = blockNumber + 1;
       robot.logger.debug(`[hubot-kredits] Watching events from block ${nextBlock} onward`);
       ethProvider.resetEventsBlock(nextBlock);
 
-      Proposal.on('ProposalCreated', handleProposalCreated);
+      // TODO handle all known events (that make sense here)
+      // Contribution.on('ContributorAdded', handleContributorAdded);
       Contribution.on('ContributionAdded', handleContributionAdded);
     });
   }
 
-  function handleProposalCreated(proposalId, creatorAccount, contributorId, amount) {
-    Contributor.getById(contributorId).then((contributor) => {
-      Proposal.getById(proposalId).then((proposal) => {
-        robot.logger.debug(`[hubot-kredits] Proposal created (${proposal.description})`);
-        // messageRoom(`Let's give ${contributor.name} some kredits for ${proposal.url} (${proposal.description}): https://kredits.kosmos.org`);
-      });
-    });
-  }
-
   function handleContributionAdded(contributionId, contributorId, amount) {
-    Contributor.getById(contributorId).then((contributor) => {
-      Contribution.getById(contributionId).then((contribution) => {
-        robot.logger.debug(`[hubot-kredits] Contribution #${contribution.id} added (${contribution.description})`);
+    Contributor.getById(contributorId).then(_ => {
+      Contribution.getById(contributionId).then(contribution => {
+        robot.logger.debug(`[hubot-kredits] Contribution #${contribution.id} added (${amount} kredits for "${contribution.description}")`);
       });
     });
   }
@@ -151,6 +115,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,6 @@
 const util = require('util');
-const fetch = require('node-fetch');
+const amountFromLabels = require('./utils/amount-from-labels');
+const kindFromLabels = require('./utils/kind-from-labels');
 
 function sleep(ms) {
   return new Promise(resolve => setTimeout(resolve, ms));
@@ -35,7 +36,7 @@ module.exports = async function(robot, kredits) {
     });
   }
 
-  function createContribution(giteaUser, date, time, amount, description, url, details) {
+  function createContribution(giteaUser, date, time, amount, kind, description, url, details) {
     return getContributorByGiteaUser(giteaUser).then(contributor => {
       robot.logger.debug(`[hubot-kredits] Creating contribution token for ${amount}₭S to ${giteaUser} for ${url}...`);
 
@@ -45,13 +46,16 @@ module.exports = async function(robot, kredits) {
         date,
         time,
         amount,
-        url,
+        kind,
         description,
-        details,
-        kind: 'dev'
+        url,
+        details
       };
 
-      return Contribution.addContribution(contributionAttr).catch(error => {
+      robot.logger.debug(`[hubot-kredits] contribution attributes:`);
+      robot.logger.debug(util.inspect(contributionAttr, { depth: 1, colors: true }));
+
+      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);
@@ -59,35 +63,14 @@ module.exports = async function(robot, kredits) {
     });
   }
 
-  function amountFromLabels(labels) {
-    const kreditsLabel = labels.map(l => l.name)
-                               .filter(n => n.match(/^kredits/))[0];
-    // No label, no kredits
-    if (typeof kreditsLabel === 'undefined') { return 0; }
-
-    // TODO move to config maybe?
-    let amount;
-    switch(kreditsLabel) {
-      case 'kredits-1':
-        amount = 500;
-        break;
-      case 'kredits-2':
-        amount = 1500;
-        break;
-      case 'kredits-3':
-        amount = 5000;
-        break;
-    }
-
-    return amount;
-  }
-
   async function handleGiteaIssueClosed(data) {
     const issue       = data.issue;
     const repoName    = data.repository.full_name;
-    const web_url     = `${data.repository.html_url}/issues/${issue.id}`;
+    const web_url     = `${data.repository.html_url}/issues/${issue.number}`;
     const description = `${repoName}: ${issue.title}`;
-    const amount      = amountFromLabels(issue.labels);
+    const labels      = issue.labels.map(l => l.name);
+    const amount      = amountFromLabels(labels);
+    const kind        = kindFromLabels(labels);
     const assignees   = issue.assignees ? issue.assignees.map(a => a.login) : [];
     [ date, time ]    = issue.closed_at.split('T');
 
@@ -108,7 +91,8 @@ module.exports = async function(robot, kredits) {
 
     for (const recipient of recipients) {
       try {
-        await createContribution(recipient, date, time, amount, description, web_url,
+        await createContribution(recipient, date, time, amount,
+                                 kind, description, web_url,
                                  { issue, repository: data.repository });
         await sleep(60000);
       }
@@ -123,7 +107,9 @@ module.exports = async function(robot, kredits) {
     const repoName     = data.repository.full_name;
     const web_url      = pull_request.html_url;
     const description  = `${repoName}: ${pull_request.title}`;
-    const amount       = amountFromLabels(pull_request.labels);
+    const labels      = pull_request.labels.map(l => l.name);
+    const amount      = amountFromLabels(labels);
+    const kind        = kindFromLabels(labels);
     const assignees    = pull_request.assignees ? pull_request.assignees.map(a => a.login) : [];
     [ date, time ]     = pull_request.merged_at.split('T');
 
@@ -142,10 +128,10 @@ module.exports = async function(robot, kredits) {
       recipients = [pull_request.user.login];
     }
 
-
     for (const recipient of recipients) {
       try {
-        await createContribution(recipient, date, time, amount, description, web_url,
+        await createContribution(recipient, date, time, amount,
+                                 kind, description, web_url,
                                  { pull_request, repository: data.repository });
         await sleep(60000);
       }

integrations/github.js

@@ -1,5 +1,10 @@
 const util = require('util');
 const fetch = require('node-fetch');
+const session = require('express-session');
+const cors = require('cors');
+const grant = require('grant').express();
+const amountFromLabels = require('./utils/amount-from-labels');
+const kindFromLabels = require('./utils/kind-from-labels');
 
 function sleep(ms) {
   return new Promise(resolve => setTimeout(resolve, ms));
@@ -19,6 +24,8 @@ module.exports = async function(robot, kredits) {
     robot.logger.debug('[hubot-kredits] Ignoring GitHub actions from ', util.inspect(repoBlackList));
   }
 
+  const kreditsWebUrl = process.env.KREDITS_WEB_URL || 'https://kredits.kosmos.org';
+
   const Contributor = kredits.Contributor;
   const Contribution = kredits.Contribution;
 
@@ -35,9 +42,9 @@ module.exports = async function(robot, kredits) {
     });
   }
 
-  function createContribution(githubUser, date, time, amount, description, url, details) {
+  function createContribution(githubUser, date, time, amount, kind, description, url, details) {
     return getContributorByGithubUser(githubUser).then(contributor => {
-      robot.logger.debug(`[hubot-kredits] Creating contribution token for ${amount}₭S to ${githubUser} for ${url}...`);
+      robot.logger.info(`[hubot-kredits] Creating contribution token for ${amount}₭S to ${githubUser} for ${url}...`);
 
       const contributionAttr = {
         contributorId: contributor.id,
@@ -45,13 +52,16 @@ module.exports = async function(robot, kredits) {
         date,
         time,
         amount,
-        url,
+        kind,
         description,
-        details,
-        kind: 'dev'
+        url,
+        details
       };
 
-      return Contribution.addContribution(contributionAttr).catch(error => {
+      robot.logger.debug(`[hubot-kredits] contribution attributes:`);
+      robot.logger.debug(util.inspect(contributionAttr, { depth: 1, colors: true }));
+
+      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);
@@ -59,38 +69,17 @@ module.exports = async function(robot, kredits) {
     });
   }
 
-  function amountFromIssueLabels(issue) {
-    const kreditsLabel = issue.labels.map(l => l.name)
-                              .filter(n => n.match(/^kredits/))[0];
-    // No label, no kredits
-    if (typeof kreditsLabel === 'undefined') { return 0; }
-
-    // TODO move to config maybe?
-    let amount;
-    switch(kreditsLabel) {
-      case 'kredits-1':
-        amount = 500;
-        break;
-      case 'kredits-2':
-        amount = 1500;
-        break;
-      case 'kredits-3':
-        amount = 5000;
-        break;
-    }
-
-    return amount;
-  }
-
   async function handleGitHubIssueClosed(data) {
     let recipients;
-    const issue        = data.issue;
-    const assignees    = issue.assignees.map(a => a.login);
-    const web_url      = issue.html_url;
+    const issue       = data.issue;
+    const assignees   = issue.assignees.map(a => a.login);
+    const web_url     = issue.html_url;
 
-    [date, time] = issue.closed_at.split('T');
-    const amount = amountFromIssueLabels(issue);
-    const repoName = issue.repository_url.match(/.*\/(.+\/.+)$/)[1];
+    [date, time]      = issue.closed_at.split('T');
+    const labels      = issue.labels.map(l => l.name);
+    const amount      = amountFromLabels(labels);
+    const kind        = kindFromLabels(labels);
+    const repoName    = issue.repository_url.match(/.*\/(.+\/.+)$/)[1];
     const description = `${repoName}: ${issue.title}`;
 
     if (amount === 0) {
@@ -109,7 +98,7 @@ module.exports = async function(robot, kredits) {
 
     for (const recipient of recipients) {
       try {
-        await createContribution(recipient, date, time, amount, description, web_url, issue);
+        await createContribution(recipient, date, time, amount, kind, description, web_url, issue);
         await sleep(60000);
       }
       catch (err) { robot.logger.error(err); }
@@ -141,8 +130,10 @@ module.exports = async function(robot, kredits) {
         return response.json();
       })
       .then(async (issue) => {
-        const amount = amountFromIssueLabels(issue);
-        const repoName = pull_request.base.repo.full_name;
+        const labels      = issue.labels.map(l => l.name);
+        const amount      = amountFromLabels(labels);
+        const kind        = kindFromLabels(labels);
+        const repoName    = pull_request.base.repo.full_name;
         const description = `${repoName}: ${pull_request.title}`;
 
         if (amount === 0) {
@@ -155,7 +146,7 @@ module.exports = async function(robot, kredits) {
 
         for (const recipient of recipients) {
           try {
-            await createContribution(recipient, date, time, amount, description, web_url, pull_request);
+            await createContribution(recipient, date, time, amount, kind, description, web_url, pull_request);
             await sleep(60000);
           }
           catch (err) { robot.logger.error(err); }
@@ -176,14 +167,110 @@ module.exports = async function(robot, kredits) {
 
     if (evt === 'pull_request' && data.action === 'closed' && data.pull_request.merged) {
       handleGitHubPullRequestClosed(data);
-      res.send(200);
+      res.sendStatus(200);
     }
     else if (evt === 'issues' && data.action === 'closed') {
       handleGitHubIssueClosed(data);
-      res.send(200);
+      res.sendStatus(200);
     } else {
-      res.send(200);
+      res.sendStatus(200);
     }
   });
 
+  //
+  // GitHub signup
+  //
+
+  if (process.env.KREDITS_GITHUB_KEY && process.env.KREDITS_GITHUB_SECRET) {
+    const grantConfig = {
+      defaults: {
+        origin: (process.env.KREDITS_GRANT_ORIGIN || 'http://localhost:8888'),
+        prefix: '/kredits/signup/connect',
+        transport: 'session',
+        response: 'tokens',
+      },
+      github: {
+        key: process.env.KREDITS_GITHUB_KEY,
+        secret: process.env.KREDITS_GITHUB_SECRET,
+        callback: '/kredits/signup/github'
+      }
+    };
+
+    robot.router.use(session({
+      secret: process.env.KREDITS_SESSION_SECRET || 'grant',
+      resave: false,
+      saveUninitialized: false
+    }));
+
+    robot.router.use(grant(grantConfig));
+
+    robot.router.get('/kredits/signup/github', async (req, res) => {
+      const access_token = req.session.grant.response.access_token;
+
+      res.redirect(`${kreditsWebUrl}/signup/github#access_token=${access_token}`);
+    });
+
+    robot.router.options('/kredits/signup/github', cors());
+
+    robot.router.post('/kredits/signup/github', cors(), async (req, res) => {
+      const accessToken = req.body.accessToken;
+      if (!accessToken) {
+        res.status(400).json({});
+        return;
+      }
+      let githubResponse;
+      try {
+        githubResponse = await fetch('https://api.github.com/user', {
+          headers: {
+            'Accept': 'application/vnd.github.v3+json',
+            'Authorization': `token ${accessToken}`
+          }
+        });
+      } catch (error) {
+        robot.logger.error('[hubot-kredits] Fetching user data from GitHub failed:', error);
+        res.status(500).json({ error });
+      };
+
+      if (githubResponse.status >= 300) {
+        res.status(githubResponse.status).json({});
+        return;
+      }
+      const user = await githubResponse.json();
+
+      const contributor = await kredits.Contributor.findByAccount({
+        site: 'github.com',
+        username: user.login
+      });
+
+      if (!contributor) {
+        let contributorAttr = {};
+        contributorAttr.account = req.body.account;
+        contributorAttr.name = user.name || user.login;
+        contributorAttr.kind = "person";
+        contributorAttr.url = user.blog;
+        contributorAttr.github_username = user.login;
+        contributorAttr.github_uid = user.id;
+
+        kredits.Contributor.add(contributorAttr, { gasLimit: 350000 })
+          .then(transaction => {
+            robot.logger.info('[hubot-kredits] Contributor added from GitHub signup', transaction.hash);
+            res.status(201);
+            res.json({
+              transactionHash: transaction.hash,
+              github_username: user.login
+            });
+          }, error => {
+            robot.logger.error(`[hubot-kredits] Adding contributor failed: ${error}`);
+            res.status(422);
+            res.json({ error })
+          });
+      } else {
+        res.json({
+          github_username: user.login
+        });
+      }
+    });
+  } else {
+    robot.logger.warning('[hubot-kredits] No KREDITS_GITHUB_KEY and KREDITS_GITHUB_SECRET configured for OAuth signup');
+  }
 };

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(() => {
@@ -112,25 +112,21 @@ module.exports = async function(robot, kredits) {
   }
 
   async function createContributions (changes) {
-    let promises = [];
-
     for (const user of Object.keys(changes)) {
       await createContributionForUserChanges(user, changes[user]);
       await sleep(60000);
     }
-
-    return Promise.resolve();
   }
 
   function pageTitlesFromChanges(changes) {
     return [...new Set(changes.map(c => `"${c.title}"`))].join(', ');
   }
 
+  // Currently not used
   function calculateAmountForChanges(details) {
     let amount;
 
-    if (details.charsAdded < 280) {
-      // less than a tweet
+    if (details.charsAdded < 500) {
       amount = 500;
     } else if (details.charsAdded < 2000) {
       amount = 1500;
@@ -145,9 +141,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/utils/amount-from-labels.js

@@ -0,0 +1,21 @@
+module.exports = function (labels) {
+  const kreditsLabel = labels.filter(n => n.match(/^kredits/))[0];
+  // No label, no kredits
+  if (typeof kreditsLabel === 'undefined') { return 0; }
+
+  // TODO move amounts to config?
+  let amount;
+  switch(kreditsLabel) {
+    case 'kredits-1':
+      amount = 500;
+      break;
+    case 'kredits-2':
+      amount = 1500;
+      break;
+    case 'kredits-3':
+      amount = 5000;
+      break;
+  }
+
+  return amount;
+};

integrations/utils/kind-from-labels.js

@@ -0,0 +1,18 @@
+module.exports = function (labels) {
+  let kind = 'dev';
+
+  if (labels.find(l => l.match(/ops|operations/)))  {
+    kind = 'ops';
+  }
+  else if (labels.find(l => l.match(/docs|documentation/)))  {
+    kind = 'docs';
+  }
+  else if (labels.find(l => l.match(/design/)))  {
+    kind = 'design';
+  }
+  else if (labels.find(l => l.match(/community/)))  {
+    kind = 'community';
+  }
+
+  return kind;
+};

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,23 +1,32 @@
 {
-  "name": "hubot-kredits",
-  "version": "3.1.2",
+  "name": "@kredits/hubot-kredits",
+  "version": "4.1.0",
   "description": "Kosmos Kredits functionality for chat bots",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "bin": {
-    "create-wallet": "scripts/create-wallet.js"
+    "create-wallet": "scripts/create-wallet.js",
+    "review-kredits": "scripts/review-kredits.js"
   },
   "dependencies": {
-    "eth-provider": "^0.2.2",
-    "ethers": "^4.0.27",
-    "group-array": "^0.3.3",
-    "kosmos-schemas": "^1.1.2",
-    "kredits-contracts": "github:67P/kredits-contracts#feature/gitea_site",
+    "@ethersproject/experimental": "5.7.0",
+    "@kredits/contracts": "^7.3.0",
+    "axios": "^1.7.9",
+    "cors": "^2.8.5",
+    "dotenv": "^16.3.1",
+    "eth-provider": "^0.13.6",
+    "ethers": "^5.0.5",
+    "express": "^4.18.2",
+    "express-session": "^1.17.3",
+    "grant-express": "^5.4.8",
+    "group-array": "^1.0.0",
+    "kosmos-schemas": "^2.2.1",
     "node-cron": "^2.0.3",
-    "node-fetch": "^2.3.0",
-    "prompt": "^1.0.0"
+    "node-fetch": "^2.6.12",
+    "prompt": "^1.3.0",
+    "yargs": "^17.7.2"
   },
   "repository": {
     "type": "git",
@@ -31,7 +40,8 @@
   "author": "Kosmos Developers <mail@kosmos.org>",
   "contributors": [
     "Sebastian Kippe <sebastian@kip.pe>",
-    "Michael Bumann <hello@michaelbumann.com>"
+    "Michael Bumann <hello@michaelbumann.com>",
+    "Garret Alfert <alfert@wevelop.de>"
   ],
   "license": "MIT",
   "bugs": {

scripts/lib/gitea-reviews.js

@@ -0,0 +1,95 @@
+const axios = require('axios');
+
+module.exports = class GiteaReviews {
+
+  client = null;
+  kreditsAmounts = null;
+  pageLimit = 50;
+
+  constructor (token, kreditsAmounts) {
+    this.kreditsAmounts = kreditsAmounts;
+
+    this.client = axios.create({
+      baseURL: 'https://gitea.kosmos.org/api/v1',
+      headers: {
+        'accepts': 'application/json',
+        'Authorization': `token ${token}`
+      }
+    });
+  }
+
+  async getReviewContributions (repos, startDate, endDate) {
+    let pulls = [];
+    let reviewContributions = {}
+
+    await Promise.all(repos.map(async (repo) => {
+      let page = 1;
+      let result;
+
+      do {
+        try {
+          result = await this.client.get(`/repos/${repo}/pulls?state=closed&limit=${this.pageLimit}&page=${page}`);
+        } catch(error) {
+          console.log(`failed to fetch PRs for repo ${repo}:`, error.message);
+          continue;
+        }
+
+        if (!result || !result.data || result.data.length === 0) {
+          continue;
+        }
+
+        let pullRequests = result.data.filter(pr => {
+          if (!pr.merged) return false; // only interested in merged PRs
+
+          // check if the PR has been merged in the given timeframe
+          const mergeDate = new Date(pr.merged_at);
+          if (mergeDate < startDate || mergeDate > endDate) return false;
+
+          // check if the PR has a kredits label
+          return pr.labels.some(label => label.name.match(/kredits-[123]/));
+        });
+
+        await Promise.all(pullRequests.map(async (pr) => {
+          let reviews;
+          try {
+            reviews = await this.client.get(`/repos/${repo}/pulls/${pr.number}/reviews`);
+          } catch(error) {
+            console.log(`failed to fetch reviews for repo ${repo}, PR ${pr.number}:`, error.message);
+            return;
+          }
+
+          if (!reviews || !reviews.data || reviews.data.length === 0) {
+            return;
+          }
+
+          reviews = reviews.data.filter(review => {
+            return ['APPROVED', 'REJECTED'].includes(review.state);
+          });
+
+          reviews.forEach(review => {
+            // console.debug(`Review from /repos/${repo}/pulls/${pr.number}`);
+
+            if (typeof reviewContributions[review.user.login] === 'undefined') {
+              reviewContributions[review.user.login] = [];
+            }
+
+            let kreditsLabel = pr.labels.find(label => label.name.match(/kredits-[123]/));
+
+            reviewContributions[review.user.login].push({
+              pr,
+              prNumber: pr.number,
+              review,
+              reviewState: review.state,
+              kredits: this.kreditsAmounts[kreditsLabel.name]
+            });
+          });
+        }));
+
+        page++;
+      } while (result && result.data && result.data.length > 0);
+    }));
+
+    return reviewContributions;
+  }
+
+}

scripts/lib/github-reviews.js

@@ -0,0 +1,96 @@
+const axios = require('axios');
+
+module.exports = class GithubReviews {
+
+  client = null;
+  kreditsAmounts = null;
+  pageLimit = 100;
+
+  constructor (token, kreditsAmounts) {
+    this.kreditsAmounts = kreditsAmounts;
+
+    this.client = axios.create({
+      baseURL: 'https://api.github.com',
+      headers: {
+        'Accept': 'application/vnd.github.v3+json',
+        'User-Agent': 'Kosmos Kredits for reviews',
+        'Authorization': `token ${token}`
+      }
+    });
+  }
+
+  async getReviewContributions (repos, startDate, endDate) {
+    let pulls = [];
+    let reviewContributions = {}
+
+    await Promise.all(repos.map(async (repo) => {
+      let page = 1;
+      let result;
+
+      do {
+        try {
+          result = await this.client.get(`/repos/${repo}/pulls?state=closed&perPage=${this.pageLimit}&page=${page}`);
+        } catch(error) {
+          console.log(`failed to fetch PRs for repo ${repo}:`, error.message);
+          continue;
+        }
+
+        if (!result || !result.data || result.data.length === 0) {
+          continue;
+        }
+
+        let pullRequests = result.data.filter(pr => {
+          if (!pr.merged_at) return false; // only interested in merged PRs
+
+          // check if the PR has been merged in the given timeframe
+          const mergeDate = new Date(pr.merged_at);
+          if (mergeDate < startDate || mergeDate > endDate) return false;
+
+          // check if the PR has a kredits label
+          return pr.labels.some(label => label.name.match(/kredits-[123]/));
+        });
+
+        await Promise.all(pullRequests.map(async (pr) => {
+          let reviews;
+          try {
+            reviews = await this.client.get(`/repos/${repo}/pulls/${pr.number}/reviews`);
+          } catch(error) {
+            console.log(`failed to fetch reviews for repo ${repo}, PR ${pr.number}:`, error.message);
+            return;
+          }
+
+          if (!reviews || !reviews.data || reviews.data.length === 0) {
+            return;
+          }
+
+          reviews = reviews.data.filter(review => {
+            return ['APPROVED', 'REJECTED'].includes(review.state);
+          });
+
+          reviews.forEach(review => {
+            // console.debug(`Review from /repos/${repo}/pulls/${pr.number}`);
+
+            if (typeof reviewContributions[review.user.login] === 'undefined') {
+              reviewContributions[review.user.login] = [];
+            }
+
+            let kreditsLabel = pr.labels.find(label => label.name.match(/kredits-[123]/));
+
+            reviewContributions[review.user.login].push({
+              pr,
+              prNumber: pr.number,
+              review,
+              reviewState: review.state,
+              kredits: this.kreditsAmounts[kreditsLabel.name]
+            });
+          });
+        }));
+
+        page++;
+      } while (result && result.data && result.data.length > 0);
+    }));
+
+    return reviewContributions;
+  }
+
+}

scripts/repos.json

@@ -0,0 +1,25 @@
+{
+  "github": [
+    "67P/hubot-kredits",
+    "67P/hubot-remotestorage-logger",
+    "67P/hyperchannel",
+    "67P/kredits-signup",
+    "67P/kredits-web",
+    "67P/waves",
+    "sockethub/sockethub"
+  ],
+  "gitea": [
+    "kosmos/akkounts",
+    "kosmos/botka",
+    "kosmos/chef",
+    "kosmos/gitea.kosmos.org",
+    "kosmos/hal8000",
+    "kosmos/ipfs-cookbook",
+    "kosmos/rs-module-kosmos",
+    "kosmos/schemas",
+    "kosmos/website",
+    "kosmos/wormhole",
+    "kredits/contracts",
+    "kredits/ipfs-pinner"
+  ]
+}

scripts/review-kredits.js

@@ -0,0 +1,246 @@
+#!/usr/bin/env node
+
+require('dotenv').config();
+
+const yargs = require('yargs/yargs');
+const { hideBin } = require('yargs/helpers');
+const util = require('util');
+const fs = require('fs');
+
+const GiteaReviews = require('./lib/gitea-reviews');
+const GithubReviews = require('./lib/github-reviews');
+
+const ethers = require('ethers');
+const NonceManager = require('@ethersproject/experimental').NonceManager;
+const Kredits = require('@kredits/contracts');
+
+const walletPath  = process.env.KREDITS_WALLET_PATH || './wallet.json';
+const walletJson  = fs.readFileSync(walletPath);
+const providerUrl = process.env.KREDITS_PROVIDER_URL || 'http://localhost:7545';
+
+const ipfsConfig = {
+  host: process.env.IPFS_API_HOST || 'localhost',
+  port: process.env.IPFS_API_PORT || '5001',
+  protocol: process.env.IPFS_API_PROTOCOL || 'http',
+};
+console.log('ipfsConfig:', ipfsConfig);
+
+const kreditsAmounts = {
+  'kredits-1': 100,
+  'kredits-2': 300,
+  'kredits-3': 1000,
+};
+
+const repos = require('./repos.json');
+
+const argv = yargs(hideBin(process.argv))
+  .option('start', {
+    alias: 's',
+    description: 'Include reviews for PRs merged after this date',
+  })
+  .option('end', {
+    alias: 'e',
+    description: 'Include reviews for PRs merged before this date',
+  })
+  .option('dry', {
+    alias: 'd',
+    type: 'boolean',
+    description: 'Only list contribution details without creating them',
+  })
+  .help()
+  .version()
+  .demandOption('start', 'Please provide a start date')
+  .default('end', function now() {
+    return new Date().toISOString().split('.')[0] + 'Z';
+  })
+  .example([
+    [
+      '$0 --start 2020-11-01 --end 2020-11-30T23:59:59Z',
+      'Create contributions for reviews of pull requests merged in November 2020',
+    ],
+    [
+      '$0 --start 2021-01-01',
+      'Create contributions for reviews of pull requests merged from Januar 2021 until now',
+    ],
+  ]).argv;
+
+const startTimestamp = Date.parse(argv.start);
+const endTimestamp = Date.parse(argv.end);
+
+if (isNaN(startTimestamp)) {
+  console.log('The provided start date is invalid');
+  process.exit(1);
+}
+
+if (isNaN(endTimestamp)) {
+  console.log('The provided end date is invalid');
+  process.exit(1);
+}
+
+const startDate = new Date(startTimestamp);
+const endDate = new Date(endTimestamp);
+
+async function getAllReviews(repos, startDate, endDate) {
+  const githubReviews = new GithubReviews(
+    process.env.GITHUB_TOKEN,
+    kreditsAmounts
+  );
+  const giteaReviews = new GiteaReviews(
+    process.env.GITEA_TOKEN,
+    kreditsAmounts
+  );
+
+  return Promise.all([
+    githubReviews.getReviewContributions(repos.github, startDate, endDate),
+    giteaReviews.getReviewContributions(repos.gitea, startDate, endDate),
+  ]).then((reviews) => {
+    return { github: reviews[0], gitea: reviews[1] };
+  });
+}
+
+async function initializeKredits() {
+  //
+  // Wallet setup
+  //
+
+  let wallet;
+  try {
+    wallet = await ethers.Wallet.fromEncryptedJson(walletJson, process.env.KREDITS_WALLET_PASSWORD);
+  } catch(error) {
+    console.warn('Could not load wallet:', error);
+    process.exit(1);
+  }
+
+  //
+  // Solidity VM provider/node setup
+  //
+
+  console.log('Using blockchain node/API at', providerUrl);
+
+  const ethProvider = new ethers.providers.JsonRpcProvider(providerUrl);
+  const signer = new NonceManager(wallet.connect(ethProvider));
+
+  //
+  // Kredits contracts setup
+  //
+
+  const opts = { ipfsConfig };
+  let kredits;
+
+  try {
+    kredits = await new Kredits(signer.provider, signer, opts).init();
+  } catch(error) {
+    console.warn('Could not set up kredits:', error);
+    process.exit(1);
+  }
+
+  console.log('Wallet address: ' + wallet.address);
+
+  //
+  // Check robot's wallet balance and alert when it's broke
+  //
+
+  ethProvider.getBalance(wallet.address).then(balance => {
+    console.log('Wallet balance: ' + ethers.utils.formatEther(balance) + ' RBTC');
+    if (balance.lt(ethers.utils.parseEther('0.0001'))) {
+      console.warn(`I\'m broke! Please send some RBTC to ${wallet.address} first.`);
+      process.exit(1);
+    }
+  });
+
+  return kredits;
+}
+
+async function generateContributionData(reviews, Contributor) {
+  const contributors = await Contributor.all();
+  const contributionData = {};
+
+  const nextDay = new Date(endDate);
+  nextDay.setUTCDate(nextDay.getUTCDate() + 1);
+  nextDay.setUTCHours(0, 0, 0, 0);
+  const nextDayStr = nextDay.toISOString().split('.')[0] + 'Z';
+  [date, time] = nextDayStr.split('T');
+
+  function addContributionDataForPlatform(platform) {
+    for (const [username, platformReviews] of Object.entries(
+      reviews[platform]
+    )) {
+      const contributor = contributors.find((c) => {
+        return c[`${platform}_username`] === username;
+      });
+
+      if (!contributor) {
+        console.log(
+          `Could not find contributor for ${platform} user "${username}"`
+        );
+        continue;
+      }
+
+      const urls = platformReviews.map((review) => review.pr.html_url);
+      const kreditsAmount = platformReviews.reduce((amount, review) => {
+        return review.kredits + amount;
+      }, 0);
+
+      if (typeof contributionData[contributor.name] !== 'undefined') {
+        contributionData[contributor.name].amount += kreditsAmount;
+        contributionData[contributor.name].details.pullRequests.push(...urls);
+      } else {
+        contributionData[contributor.name] = {
+          contributorId: contributor.id,
+          contributorIpfsHash: contributor.ipfsHash,
+          date,
+          time,
+          amount: kreditsAmount,
+          kind: 'dev',
+          details: {
+            kind: 'review',
+            pullRequests: urls,
+          },
+        };
+      }
+    }
+  }
+
+  addContributionDataForPlatform('gitea');
+  addContributionDataForPlatform('github');
+
+  return contributionData;
+}
+
+Promise.all([
+  initializeKredits(),
+  getAllReviews(repos, startDate, endDate),
+]).then((values) => {
+  const kredits = values[0];
+  const reviews = values[1];
+  const Contributor = kredits.Contributor;
+  const Contribution = kredits.Contribution;
+
+  async function createContribution(nickname, attrs) {
+    console.log(`Creating review contribution for ${nickname}...`);
+    console.log(util.inspect(attrs, { depth: 1, colors: true }));
+
+    return Contribution.add(attrs)
+      .catch(error => {
+        console.error(`Error:`, error.message);
+      });
+  }
+
+  generateContributionData(reviews, Contributor).then(
+    async (contributionData) => {
+      if (argv.dry) {
+        console.log('Contributions:');
+        console.log(util.inspect(contributionData, { depth: 3, colors: true }));
+        return;
+      } else {
+        for (const nickname of Object.keys(contributionData)) {
+          const description = `Reviewed ${contributionData[nickname].details.pullRequests.length} pull requests (from ${startDate.toISOString().split('T')[0]} to ${endDate.toISOString().split('T')[0]})`;
+          await createContribution(nickname, {
+            ...contributionData[nickname],
+            description,
+          });
+        }
+      }
+    }
+  );
+});