Add message buttons

Procfile

@@ -1 +1,2 @@
+web: npm run web
 worker: npm start

adapter-repl.js

@@ -0,0 +1,10 @@
+var conf = require('./config');
+
+var SlackAdapter = require('./src/slack-adapter');
+
+var SlackClient = require('slack-client');
+
+var client = new SlackClient(conf.get('slackToken'));
+var adapter = new SlackAdapter(client);
+
+module.exports = adapter;

attributes/manness.json

@@ -1,6 +1,24 @@
 {
   "name": "manness",
+  "interviewQuestion": "Are you a man?",
   "values": [
+    {
+      "value": "a man",
+      "matcherSets": [
+        [{"matches": "true"}],
+        [{"matches": "man"}, {"doesNotMatch": "not"}, {"doesNotMatch": "woman"}],
+        [{"matches": "woman"}, {"matches": "not"}]
+      ],
+      "texts": {
+        "information": "you are a man",
+        "update": "Okay, we have noted that you are a man. ",
+        "wrong": "If I got it wrong, try saying “I am *not* a man!”",
+        "statistics": "men",
+        "table": "men",
+        "short": "M",
+        "interviewAnswer": "Yes"
+      }
+    },
     {
       "value": "not a man",
       "matcherSets": [
@@ -10,26 +28,13 @@
       ],
       "texts": {
         "information": "you are not a man",
-        "update": "Okay, we have noted that you are not a man. If I got it wrong, try saying “I am a man”.",
+        "update": "Okay, we have noted that you are not a man.",
+        "wrong": "If I got it wrong, try saying “I am a man”.",
         "statistics": "notMen",
         "table": "not-men",
         "terse": "not-men",
-        "short": "NM"
-      }
-    },
-    {
-      "value": "a man",
-      "matcherSets": [
-        [{"matches": "true"}],
-        [{"matches": "man"}, {"doesNotMatch": "not"}, {"doesNotMatch": "woman"}],
-        [{"matches": "woman"}, {"matches": "not"}]
-      ],
-      "texts": {
-        "information": "you are a man",
-        "update": "Okay, we have noted that you are a man. If I got it wrong, try saying “I am *not* a man!”",
-        "statistics": "men",
-        "table": "men",
-        "short": "M"
+        "short": "NM",
+        "interviewAnswer": "No"
       }
     },
     {
@@ -43,7 +48,8 @@
         "update": "We have noted that it’s complicated whether you are a man. If I got it wrong, try saying “I am not a man.”",
         "statistics": "complicated",
         "table": "complicated",
-        "short": "‽"
+        "short": "‽",
+        "interviewAnswer": "It’s complicated"
       }
     },
     {
@@ -57,7 +63,8 @@
         "update": "Okay, we have erased our record of whether you are a man.",
         "statistics": "unknown",
         "table": "unknown",
-        "short": "?"
+        "short": "?",
+        "interviewAnswer": "Decline"
       }
     }
   ],

attributes/pocness.json

@@ -1,5 +1,6 @@
 {
   "name": "pocness",
+  "interviewQuestion": "Are you a person of colour?",
   "values": [
     {
       "value": "a PoC",
@@ -9,11 +10,13 @@
       ],
       "texts": {
         "information": "you are a person of colour",
-        "update": "We have noted that you are a person of colour. If I got it wrong, try saying “I am not a person of colour”",
+        "update": "We have noted that you are a person of colour.",
+        "wrong": "If I got it wrong, try saying “I am not a person of colour”",
         "statistics": "peopleOfColour",
         "table": "PoC",
         "terse": "people of colour",
-        "short": "PoC"
+        "short": "PoC",
+        "interviewAnswer": "Yes"
       }
     },
     {
@@ -24,10 +27,12 @@
       ],
       "texts": {
         "information": "you are not a person of colour",
-        "update": "We have noted that you are not a person of colour. If I got it wrong, try saying “I am a person of colour”",
+        "update": "We have noted that you are not a person of colour.",
+        "wrong": "If I got it wrong, try saying “I am a person of colour”",
         "statistics": "nonPeopleOfColour",
         "table": "not-PoC",
-        "short": "N"
+        "short": "N",
+        "interviewAnswer": "No"
       }
     },
     {
@@ -38,10 +43,12 @@
       ],
       "texts": {
         "information": "it’s complicated whether you are a person of colour",
-        "update": "We have noted that it’s complicated whether you are a person of colour. If I got it wrong, try saying “I am a person of colour”",
+        "update": "We have noted that it’s complicated whether you are a person of colour.",
+        "wrong": "If I got it wrong, try saying “I am a person of colour”",
         "statistics": "complicated",
         "table": "complicated",
-        "short": "‽"
+        "short": "‽",
+        "interviewAnswer": "It’s complicated"
       }
     },
     {
@@ -55,7 +62,8 @@
         "update": "We have erased our record of whether you are a person of colour.",
         "statistics": "unknown",
         "table": "unknown",
-        "short": "?"
+        "short": "?",
+        "interviewAnswer": "Decline"
       }
     }
   ],

package.json

@@ -6,7 +6,8 @@
   "scripts": {
     "start": "node --use-strict index.js",
     "debug": "node debug --use-strict index.js",
-    "test": "tap --strict test/*"
+    "test": "tap --strict test/*",
+    "web": "node --use-strict web.js"
   },
   "repository": {
     "type": "git",
@@ -26,14 +27,19 @@
   "devDependencies": {
     "grunt": "^0.4.5",
     "grunt-tape": "0.0.2",
+    "nock": "^8.0.0",
     "require-subvert": "^0.1.0",
     "sinon": "^1.12.2",
+    "supertest-koa-agent": "^0.2.1",
     "tape": "^3.4.0"
   },
   "dependencies": {
     "cli-table": "^0.3.1",
     "convict": "^0.6.1",
     "cron-parser": "^0.6.1",
+    "koa": "^1.2.0",
+    "koa-body": "^1.4.0",
+    "koa-router": "^5.4.0",
     "lodash.every": "^3.2.0",
     "lodash.find": "^3.2.0",
     "lodash.map": "^3.1.4",
@@ -46,6 +52,7 @@
     "sequelize": "^3.21.0",
     "sequelize-cli": "1.1.0",
     "slack-client": "^1.3.1",
+    "superagent": "^2.1.0",
     "tap": "^0.5.0",
     "validator": "^3.28.0"
   },

src/direct-message-handler.js

@@ -1,12 +1,12 @@
 // TODO this should probably be further decomposed
 // Also should maybe just return a reply which the bot actually sends?
 
-var every = require('lodash.every');
 var find = require('lodash.find');
 
 var UpdateParser = require('./update-parser');
 
 var attributeConfigurations = require('./attribute-configurations');
+var userInformation = require('./reports/user-information');
 
 class DirectMessageHandler {
   constructor({userRepository, channelRepository, adapter}) {
@@ -20,11 +20,39 @@ class DirectMessageHandler {
 
   handle(channel, message) {
     if (!message.text || message.subtype === 'bot_message') return;
-    var text = message.text.toLowerCase();
+    var text = message.text.toLowerCase().trim();
 
     var user = this.adapter.getUser(message.user);
 
-    if (text === 'info') {
+    // TODO replace the self-identification request with this
+    if (text === 'interview') {
+      channel.postMessage({
+        text: DirectMessageHandler.INTERVIEW_INTRODUCTION,
+        attachments: [{
+          title: 'Would you like to self-identify?',
+          callback_id: 'initial',
+          attachment_type: 'default',
+          actions: [
+            {
+              name: 'yes',
+              text: 'Yes',
+              type: 'button',
+              value: 'yes'
+            }, {
+              name: 'no',
+              text: 'No',
+              type: 'button',
+              value: 'no'
+            }, {
+              name: 'more',
+              text: 'Tell me more',
+              type: 'button',
+              value: 'more'
+            }
+          ]
+        }]
+      });
+    } else if (text === 'info') {
       this.handleInformationRequest(channel, message);
     } else if (text === 'help') {
       this.handleHelpRequest(channel, message);
@@ -40,34 +68,11 @@ class DirectMessageHandler {
   }
 
   handleInformationRequest(channel, message) {
-    // FIXME fetch the entire user rather than run multiple queries
-    Promise.all(this.attributeConfigurations.map(function(configuration) {
-      return this.userRepository.retrieveAttribute(message.user, configuration.name);
-    }.bind(this))).then(function(values) {
-      var reply;
-
-      if (every(values, function(value) {return value == null || value == undefined})) {
-        reply = `We don’t have you on record! ${DirectMessageHandler.HELP_MESSAGE}`;
-      } else {
-        reply = 'Our records indicate that:\n\n';
-
-        this.attributeConfigurations.forEach(function(attributeConfiguration, index) {
-          var value = values[index];
-
-          var valueConfiguration = find(attributeConfiguration.values, function(valueConfiguration) {
-            return valueConfiguration.value == value;
-          });
-
-          if (valueConfiguration) {
-            reply += `* ${valueConfiguration.texts.information}\n`;
-          } else {
-            reply += `* ${attributeConfiguration.unknownValue.texts.information}\n`;
-          }
-        });
-      }
-
-      channel.send(reply);
-    }.bind(this));
+    userInformation(message.user, {
+      userRepository: this.userRepository,
+      helpMessage: DirectMessageHandler.HELP_MESSAGE,
+      attributeConfigurations: this.attributeConfigurations
+    }).then(reply => channel.send(reply));
   }
 
   handleInformationUpdate(channel, message) {
@@ -102,7 +107,7 @@ class DirectMessageHandler {
     });
 
     if (matchingValue) {
-      reply = matchingValue.texts.update;
+      reply = `${matchingValue.texts.update} ${matchingValue.texts.wrong || ''}`;
     }
 
     channel.send(reply);
@@ -179,6 +184,7 @@ class DirectMessageHandler {
 // TODO maybe messages should be collected somewhere central, and parameterised
 
 DirectMessageHandler.HELP_MESSAGE = 'You can let me know “I’m not a man”, “I am a person of colour”, “it’s complicated whether I am white” and other such variations, or ask for my current information on you with “info”. To erase what you’ve previously told me, say “It is unknown whether I am a man”, “it is unknown whether I am white”, and so on. View my source at https://github.com/backspace/slack-statsbot';
-DirectMessageHandler.VERBOSE_HELP_MESSAGE = `Hey, I’m a bot that collects statistics on who is taking up space in the channels I’m in. For now, I only track whether or not a participant is a man and/or a person of colour. ${DirectMessageHandler.HELP_MESSAGE}. Please note that, while I won’t directly reveal the answers you provide, it is sometimes possible to deduce them from the statistics I provide and channel logs.`;
+DirectMessageHandler.INTERVIEW_INTRODUCTION = 'Hey, I’m a bot that collects statistics on who is taking up space in the channels I’m in. For now, I only track whether or not a participant is a man and/or a person of colour. If you feel comfortable answering questions about this, we can continue.';
+DirectMessageHandler.VERBOSE_HELP_MESSAGE = `${DirectMessageHandler.INTERVIEW_INTRODUCTION} ${DirectMessageHandler.HELP_MESSAGE}`;
 
 module.exports = DirectMessageHandler;

src/message-buttons/question-for-attribute-configuration.js

@@ -0,0 +1,16 @@
+
+module.exports = function questionForAttributeConfiguration(attributeConfiguration) {
+  return {
+    title: attributeConfiguration.interviewQuestion,
+    callback_id: attributeConfiguration.name,
+    attachment_type: 'default',
+    actions: attributeConfiguration.values.map(value => {
+      return {
+        name: attributeConfiguration.name,
+        text: value.texts.interviewAnswer,
+        type: 'button',
+        value: value.value || 'decline'
+      };
+    })
+  };
+}