Merge branch 'master' of https://github.com/ForstaLabs/messaging-bot

Author: mcavoybn

README.md

@@ -2,7 +2,7 @@ Forsta Messaging Bot
 ========
 Secure autonomous message receipt, processing, storage, and/or transmission on the Forsta messaging platform.
 
-[License](https://github.com/ForstaLabs/messaging-bot/blob/master/LICENSE)
+[License](https://github.com/ForstaLabs/forsta-messaging-bot/blob/master/LICENSE)
 
 
 About
@@ -12,10 +12,10 @@ It allows for autonomous receipt, processing, storage, and/or transmission of me
 data to perform some useful task. Please fork it or one of our several projects based 
 off of it!
 
- * [Live Chat Bot](https://github.com/ForstaLabs/live-chat-bot)
- * [Translation Bot](https://github.com/ForstaLabs/translation-bot)
- * [Compliance Monitor](https://github.com/ForstaLabs/compliance-monitor)
- * [Message Vault](https://github.com/ForstaLabs/message-vault)
+ * [Live Chat Bot](https://github.com/ForstaLabs/forsta-live-chat-bot)
+ * [Translation Bot](https://github.com/ForstaLabs/forsta-translation-bot)
+ * [Compliance Monitor](https://github.com/ForstaLabs/forsta-compliance-monitor)
+ * [Message Vault](https://github.com/ForstaLabs/forsta-message-vault)
 
 A Forsta messaging bot can be set up to receive messages sent to a particular user, 
 **or** (if you are an organization administrator) it can be set up as a special 
@@ -61,7 +61,7 @@ Quick Start
 These deployment buttons can be used to validate that this messaging bot
 will meet your organizations needs with as little setup pain as possible. 
 
-[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/ForstaLabs/messaging-bot)
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/ForstaLabs/forsta-messaging-bot)
 
 Install Requirements
 --------
@@ -75,7 +75,7 @@ Developer Install
 If you want to build upon the Forsta Messaging Bot
 you can install and run directly from the source code.
 
- git clone https://github.com/ForstaLabs/messaging-bot.git
+ git clone https://github.com/ForstaLabs/forsta-messaging-bot.git
  cd messaging-bot
  make run
 

app.json

@@ -1,7 +1,7 @@
 {
  "name": "Forsta Messaging Bot",
  "description": "Template for creating bots for the Forsta messaging platform.",
- "repository": "https://github.com/ForstaLabs/messaging-bot.git",
+ "repository": "https://github.com/ForstaLabs/forsta-messaging-bot.git",
  "logo": "https://raw.githubusercontent.com/ForstaLabs/compliance-monitor/master/images/forsta-logo.svg?sanitize=true",
  "keywords": ["forsta", "messaging", "bot", "template"],
  "website": "https://forsta.io",

package.json

@@ -5,17 +5,17 @@
  "engines": {
  "node": "8"
  },
- "repository": "ForstaLabs/messaging-bot",
+ "repository": "ForstaLabs/forsta-messaging-bot",
  "keywords": [
  "forsta",
  "e-discovery",
  "bot"
  ],
  "license": "GPL-3.0",
  "bugs": {
- "url": "https://github.com/ForstaLabs/messaging-bot/issues"
+ "url": "https://github.com/ForstaLabs/forsta-messaging-bot/issues"
  },
- "homepage": "https://github.com/ForstaLabs/messaging-bot#readme",
+ "homepage": "https://github.com/ForstaLabs/forsta-messaging-bot#readme",
  "scripts": {
  "postinstall": "SKIP_PACKAGES=1 make",
  "start": "node server"

server/forsta_bot.js

@@ -55,7 +55,7 @@ class ForstaBot {
  }
 
  async onMessage(ev) {
- //extract the message data from the 'message' event
+ //extract the message data from the message event
  const message = ev.data.message;
  const msgEnvelope = JSON.parse(message.body);
  let msg;
@@ -76,17 +76,16 @@ class ForstaBot {
  return;
  }
 
- //log the message data
- console.log('msg: ');
+ console.log('received message: ');
  console.log(msg);
 
  // determine the incoming messages' distribution (who the message is sent to)
  const dist = await this.resolveTags(msg.distribution.expression);
- // retrieve user data from atlas using the sender's user id
+ // retrieve user data from Atlas using the sender's user id
  const senderUser = (await this.getUsers([msg.sender.userId]))[0];
  // construct a reply message with their first name
  const reply = `Hello, ${senderUser.first_name}!`;
- // send the message to the same users on the same thread that it was recieved from  
+ // send the message 
  this.msgSender.send({
  distribution: dist,
  threadId: msg.threadId,
@@ -95,9 +94,17 @@ class ForstaBot {
  });
  }
 
- fqTag(user) { return `@${user.tag.slug}:${user.org.slug}`; }
- fqName(user) { return [user.first_name, user.middle_name, user.last_name].map(s => (s || '').trim()).filter(s => !!s).join(' '); }
- fqLabel(user) { return `${this.fqTag(user)} (${this.fqName(user)})`; }
+ fqTag(user) { 
+ return `@${user.tag.slug}:${user.org.slug}`; 
+ }
+
+ fqName(user) { 
+ return [user.first_name, user.middle_name, user.last_name].map(s => (s || '').trim()).filter(s => !!s).join(' '); 
+ }
+
+ fqLabel(user) { 
+ return `${this.fqTag(user)} (${this.fqName(user)})`; 
+ }
 
  async getSoloAuthThreadId() {
  let id = await relay.storage.get('authentication', 'soloThreadId');

server/web/api.js

@@ -25,7 +25,7 @@ class APIHandler {
  asyncRoute(fn, requireAuth=true) {
  if (process.env.API_AUTH_OVERRIDE === 'insecure') requireAuth = false;
 
- /* Add error handling for async exceptions. Otherwise the server just hangs
+ /* Adds error handling for async exceptions. Otherwise the server just hangs
  * the request or subclasses have to do this by hand for each async routine. */
  return (req, res, next) => {
  if (requireAuth) {
@@ -94,7 +94,7 @@ class AuthenticationAPIV1 extends APIHandler {
  async onStatusGet(req, res, next) {
  const registered = await BotAtlasClient.onboardComplete();
  res.status(200).json({
- status: registered ? 'complete' : (BotAtlasClient.onboardingCreatedUser ? 'authenticate-admin' : 'authenticate-user')
+ status: registered ? 'complete' : 'authenticate-admin'
  });
  }
 
@@ -114,7 +114,7 @@ class AuthenticationAPIV1 extends APIHandler {
  const admins = await this.server.bot.getAdministrators();
  const isAdmin = admins.filter(a => a.label.split(" ")[0] === "@" + tag);
  if (isAdmin.length === 0) {
- throw { code: '500', json: { "botAdmin": "You need to authorized by the bot owner to manage this bot." } };
+ throw { code: '500', json: { "botAdmin": "You need to be a bot adminstrator." } };
  }
  }
  let result = await BotAtlasClient.requestAuthentication(tag);