updated refs to github repos

Multiple responses to relationship questions

README.md

@@ -4,7 +4,7 @@ A pure JavaScript implementation of the ITA project's CEStore - called CENode. C
 
 Please visit the project's [home page](http://cenode.io) for more information and for documentation.
 
-**We recommend beginners check out the [Getting Started Guide](https://github.com/flyingsparx/CENode/wiki/Getting-Started-Guide) before continuing.**
+**We recommend beginners check out the [Getting Started Guide](https://github.com/willwebberley/CENode/wiki/Getting-Started-Guide) before continuing.**
 
 ## Getting started
 
@@ -33,13 +33,13 @@ const CEModels = require('cenode/models'); // if requred
 const node = new CENode(CEModels.core);
 ```
 
-See the [Wiki](https://github.com/flyingsparx/CENode/wiki) for further guides and the API reference.
+See the [Wiki](https://github.com/willwebberley/CENode/wiki) for further guides and the API reference.
 
 ## Testing
 
 Clone the repository
 ```
-git clone git@github.com:flyingsparx/CENode.git
+git clone git@github.com:willwebberley/CENode.git
 ```
 
 Install the necessary dev dependencies.
@@ -54,7 +54,7 @@ npm test
 
 ## More Information
 
-See the CENode [Wiki](https://github.com/flyingsparx/CENode/wiki) for more information, guides, and the API reference.
+See the CENode [Wiki](https://github.com/willwebberley/CENode/wiki) for more information, guides, and the API reference.
 
 
 ## Licence

models/core.js

@@ -18,6 +18,7 @@ module.exports = [
   "conceptualise a ~ policy ~ P that is an entity and has the value V as ~ enabled ~ and has the agent A as ~ target ~",
   "conceptualise a ~ tell policy ~ P that is a policy",
   "conceptualise an ~ ask policy ~ P that is a policy",
+  "conceptualise a ~ gist policy ~ P that is a policy",
   "conceptualise a ~ listen policy ~ P that is a policy",
   "conceptualise a ~ listen onbehalfof policy ~ P that is a policy",
   "conceptualise a ~ forwardall policy ~ P that is a policy and has the timestamp T as ~ start time ~ and has the value V as ~ all agents ~",

package.json

@@ -1,13 +1,13 @@
 {
   "name": "cenode",
-  "version": "3.0.8",
+  "version": "3.0.12",
   "description": "A pure JavaScript implementation of the ITA project's CEStore - called CENode. CENode is able to understand the basic sentence types parsed by the CEStore, such as conceptualising and instance creation and modification.",
   "homepage": "http://cenode.io",
   "license": "Apache-2.0",
   "author": "Will Webberley & Alun Preece",
   "repository": {
     "type": "git",
-    "url": "https://github.com/flyingsparx/CENode"
+    "url": "https://github.com/willwebberley/CENode"
   },
   "files": [
     "src",

src/CENode.js

@@ -137,12 +137,12 @@ class CENode {
    */
   addSentence(sentence, source) {
     const ceResult = this.addCE(sentence, false, source);
-    if (ceResult.success) {
+    if (!ceResult.error) {
       return ceResult;
     }
 
     const questionResult = this.askQuestion(sentence);
-    if (questionResult.success) {
+    if (!questionResult.error) {
       return questionResult;
     }
 
@@ -170,13 +170,7 @@ class CENode {
    * Returns: {success: bool, type: str, data: str}
    */
   addCE(sentence, source) {
-    const success = this.ceParser.parse(sentence.trim().replace('{now}', new Date().getTime()).replace('{uid}', this.newCardId()), source);
-    return {
-      success: success[0],
-      type: 'gist',
-      data: success[1],
-      result: success[2] || undefined,
-    };
+    return this.ceParser.parse(sentence.trim().replace('{now}', new Date().getTime()).replace('{uid}', this.newCardId()), source);
   }
 
   /*
@@ -186,12 +180,7 @@ class CENode {
    * Returns: {success: bool, type: str, data: str}
    */
   askQuestion(sentence) {
-    const success = this.questionParser.parse(sentence);
-    return {
-      success: success[0],
-      type: success[0] ? 'gist' : undefined,
-      data: success[0] ? success[1] : undefined,
-    };
+    return this.questionParser.parse(sentence);
   }
 
   /*
@@ -201,11 +190,7 @@ class CENode {
    * Returns: {type: str, data: str}
    */
   addNL(sentence) {
-    const success = this.nlParser.parse(sentence);
-    return {
-      type: success[0] ? 'confirm' : 'gist',
-      data: success[1],
-    };
+    return this.nlParser.parse(sentence);
   }
 
   /*

src/CEParser.js

@@ -30,6 +30,14 @@ const quotes = {
 
 class CEParser {
 
+  static error(message, concerns) {
+    return { error: true, response: { message, type: 'gist', concerns } };
+  }
+
+  static success(message, concerns) {
+    return { error: false, response: { message, type: 'gist', concerns } };
+  }
+
   /*
    * Submit CE to be processed by node.
    * This may result in
@@ -42,17 +50,22 @@ class CEParser {
    * Returns: [bool, str] (bool = success, str = error or parsed string)
    */
   parse(input, source) {
-    const t = input.replace(/\s+/g, ' ').replace(/\.+$/, '').trim(); // Whitespace -> single space
-    if (t.match(/^conceptualise an?/i)) {
-      return this.newConcept(t, source);
-    } else if (t.match(/^conceptualise the ([a-zA-Z0-9 ]*) ([A-Z0-9]+) (?:has|is|~)/i)) {
-      return this.modifyConcept(t, source);
-    } else if (t.match(/^there is an? ([a-zA-Z0-9 ]*) named/i)) {
-      return this.newInstance(t, source);
-    } else if (t.match(/^the ([a-zA-Z0-9 ]*)/i)) {
-      return this.modifyInstance(t, source);
+    try {
+      // Whitespace -> single space:
+      const t = input.replace(/\s+/g, ' ').replace(/\.+$/, '').trim();
+      if (t.match(/^conceptualise an?/i)) {
+        return this.newConcept(t, source);
+      } else if (t.match(/^conceptualise the ([a-zA-Z0-9 ]*) ([A-Z0-9]+) (?:has|is|~)/i)) {
+        return this.modifyConcept(t, source);
+      } else if (t.match(/^there is an? ([a-zA-Z0-9 ]*) named/i)) {
+        return this.newInstance(t, source);
+      } else if (t.match(/^the ([a-zA-Z0-9 ]*)/i)) {
+        return this.modifyInstance(t, source);
+      }
+      return CEParser.error('Input not a valid CE sentence.');
+    } catch (err) {
+      return CEParser.error(`There was a problem parsing the CE. ${err}.`);
     }
-    return [false, null];
   }
 
   newConcept(t, source) {
@@ -61,7 +74,7 @@ class CEParser {
     const storedConcept = this.node.getConceptByName(conceptName);
     let concept = null;
     if (storedConcept) {
-      return [false, 'This concept already exists.'];
+      return CEParser.error('This concept already exists');
     }
     concept = new CEConcept(this.node, conceptName, source);
 
@@ -70,19 +83,19 @@ class CEParser {
     for (const fact of facts) {
       this.processConceptFact(concept, fact, source);
     }
-    return [true, t, concept];
+    return CEParser.success(t, concept);
   }
 
   modifyConcept(t, source) {
     const conceptInfo = t.match(/^conceptualise the ([a-zA-Z0-9 ]*) ([A-Z0-9]+) (?:has|is|~)/);
     if (!conceptInfo) {
-      return [false, 'Unable to parse sentence'];
+      return CEParser.error('Unable to parse sentence');
     }
     const conceptName = conceptInfo[1];
     const conceptVar = conceptInfo[2];
     const concept = this.node.getConceptByName(conceptName);
     if (!concept) {
-      return [false, `Concept ${conceptInfo[1]} not known.`];
+      return CEParser.error(`Concept ${conceptInfo[1]} not known.`);
     }
 
     const remainderRegex = new RegExp(`^conceptualise the ${conceptName} ${conceptVar}`, 'i');
@@ -91,7 +104,7 @@ class CEParser {
     for (const fact of facts) {
       this.processConceptFact(concept, fact, source);
     }
-    return [true, t, concept];
+    return CEParser.success(t, concept);
   }
 
   processConceptFact(concept, fact, source) {
@@ -135,17 +148,17 @@ class CEParser {
     let names = t.match(/^there is an? ([a-zA-Z0-9 ]*) named '([^'\\]*(?:\\.[^'\\]*)*)'/i);
     if (!names) {
       names = t.match(/^there is an? ([a-zA-Z0-9 ]*) named ([a-zA-Z0-9_]*)/i);
-      if (!names) { return [false, 'Unable to determine name of instance.']; }
+      if (!names) { return CEParser.error('Unable to determine name of instance.'); }
     }
     const conceptName = names[1];
     const instanceName = names[2].replace(/\\/g, '');
     const concept = this.node.getConceptByName(conceptName);
     const currentInstance = this.node.getInstanceByName(instanceName, concept);
     if (!concept) {
-      return [false, `Instance type unknown: ${conceptName}`];
+      return CEParser.error(`Instance type unknown: ${conceptName}`);
     }
     if (currentInstance && currentInstance.type.id === concept.id) {
-      return [false, 'There is already an instance of this type with this name.', currentInstance];
+      return CEParser.error('There is already an instance of this type with this name.', currentInstance);
     }
     const instance = new CEInstance(this.node, concept, instanceName, source);
     instance.sentences.push(t);
@@ -155,7 +168,7 @@ class CEParser {
     for (const fact of facts) {
       this.processInstanceFact(instance, fact, source);
     }
-    return [true, t, instance];
+    return CEParser.success(t, instance);
   }
 
   modifyInstance(t, source) {
@@ -183,7 +196,7 @@ class CEParser {
       }
     }
     if (!concept || !instance) {
-      return [false, `Unknown concept/instance combination in: ${t}`];
+      return CEParser.error(`Unknown concept/instance combination in: ${t}`);
     }
     instance.sentences.push(t);
     const tokens = t.split(' ');
@@ -195,7 +208,7 @@ class CEParser {
         this.processInstanceFact(instance, fact, source);
       }
     }
-    return [true, t, instance];
+    return CEParser.success(t, instance);
   }
 
   processInstanceFact(instance, fact, source) {

src/CEServer.js

@@ -116,14 +116,22 @@ class CEServer {
         },
         '/instance': (request, response) => {
           const idRegex = decodeURIComponent(request.url).match(/id=(.*)/);
-          const id = idRegex ? idRegex[1] : null;
-          const instance = this.node.getInstanceById(id);
+          const nameRegex = decodeURIComponent(request.url).match(/name=(.*)/);
+          const idQuery = idRegex ? idRegex[1] : null;
+          const nameQuery = nameRegex ? nameRegex[1] : null;
+          let instance;
+          if (idQuery) {
+            instance = this.node.getInstanceById(idQuery);
+          } else if (nameQuery) {
+            instance = this.node.getInstanceByName(nameQuery);
+          }
           if (instance) {
             const body = {
               name: instance.name,
               conceptName: instance.concept.name,
               conceptId: instance.concept.id,
               ce: instance.ce,
+              gist: instance.gist,
               synonyms: instance.synonyms,
               subConcepts: [],
               values: [],
@@ -146,7 +154,7 @@ class CEServer {
             return response.end(JSON.stringify(body));
           }
           response.writeHead(404);
-          return response.end('Concept not found');
+          return response.end('Unable to find the instance.');
         },
         '/info': (request, response) => {
           const body = { recentInstances: [], recentConcepts: [], instanceCount: this.node.instances.length, conceptCount: this.node.concepts.length };
@@ -246,7 +254,12 @@ class CEServer {
       if (request.method in this.handlers) {
         const path = request.url.indexOf('?') > 1 ? request.url.slice(0, request.url.indexOf('?')) : request.url;
         if (path in this.handlers[request.method]) {
-          this.handlers[request.method][path](request, response);
+          try {
+            this.handlers[request.method][path](request, response);
+          } catch (err) {
+            response.writeHead(500);
+            response.end(`500: ${err}.`);
+          }
         } else {
           response.writeHead(404);
           response.end(`404: Resource not found for method ${request.method}.`);

src/CardHandler.js

@@ -38,9 +38,9 @@ class CardHandler {
           // Prepare the response 'tell card' and add this back to the node
           let urls;
           let c;
-          if (data.data) {
-            urls = data.data.match(/(https?:\/\/[a-zA-Z0-9./\-+_&=?!%]*)/gi);
-            c = `there is a ${data.type} card named 'msg_{uid}' that is from the agent '${this.agent.name.replace(/'/g, "\\'")}' and has the timestamp '{now}' as timestamp and has '${data.data.replace(/'/g, "\\'")}' as content`;
+          if (data.response.message) {
+            urls = data.response.message.match(/(https?:\/\/[a-zA-Z0-9./\-+_&=?!%]*)/gi);
+            c = `there is a ${data.response.type} card named 'msg_{uid}' that is from the agent '${this.agent.name.replace(/'/g, "\\'")}' and has the timestamp '{now}' as timestamp and has '${data.response.message.replace(/'/g, "\\'")}' as content`;
           } else {
             c = `there is a gist card named 'msg_{uid}' that is from the agent '${this.agent.name.replace(/'/g, "\\'")}' and has the timestamp '{now}' as timestamp and has 'Sorry; your question was not understood.' as content`;
           }
@@ -63,12 +63,12 @@ class CardHandler {
         // Add the CE sentence to the node
         const data = this.node.addCE(card.content, card.is_from && card.is_from.name);
 
-        if (!data.success && card.is_from) {
+        if (data.error && card.is_from) {
           // If unsuccessful, write an error back
           return this.node.addSentence(`there is a gist card named 'msg_{uid}' that is from the agent '${this.agent.name.replace(/'/g, "\\'")}' and is to the ${card.is_from.type.name} '${card.is_from.name.replace(/'/g, "\\'")}' and has the timestamp '{now}' as timestamp and has 'Sorry. Your input was not understood.' as content and is in reply to the card '${card.name}'.`);
         }
 
-        if (data.success === true) {
+        if (!data.error) {
           // Add sentence to any active tell policy queues
           for (const policy of this.node.getInstances('tell policy')) {
             if (policy.enabled === 'true' && policy.target && policy.target.name) {
@@ -86,12 +86,12 @@ class CardHandler {
               const ack = policy.acknowledgement;
               if (policy.target.name.toLowerCase() === card.is_from.name.toLowerCase()) {
                 let c;
-                if (ack === 'basic') { c = 'OK.'; } else if (data.type === 'tell') {
-                  c = `OK. I added this to my knowledge base: ${data.data}`;
-                } else if (data.type === 'ask' || data.type === 'confirm' || data.type === 'gist') {
-                  c = data.data;
+                if (ack === 'basic') { c = 'OK.'; } else if (data.response.type === 'tell') {
+                  c = `OK. I added this to my knowledge base: ${data.response.message}`;
+                } else if (data.response.type === 'ask' || data.response.type === 'confirm' || data.response.type === 'gist') {
+                  c = data.response.message;
                 }
-                return this.node.addSentence(`there is a ${data.type} card named 'msg_{uid}' that is from the agent '${this.agent.name.replace(/'/g, "\\'")}' and is to the ${card.is_from.type.name} '${card.is_from.name.replace(/'/g, "\\'")}' and has the timestamp '{now}' as timestamp and has '${c.replace(/'/g, "\\'")}' as content and is in reply to the card '${card.name}'.`);
+                return this.node.addSentence(`there is a ${data.response.type} card named 'msg_{uid}' that is from the agent '${this.agent.name.replace(/'/g, "\\'")}' and is to the ${card.is_from.type.name} '${card.is_from.name.replace(/'/g, "\\'")}' and has the timestamp '{now}' as timestamp and has '${c.replace(/'/g, "\\'")}' as content and is in reply to the card '${card.name}'.`);
               }
             }
           }
@@ -102,17 +102,28 @@ class CardHandler {
       'nl card': (card) => {
         let data = this.node.addCE(card.content, card.is_from && card.is_from.name);
         // If valid CE, then replicate the nl card as a tell card ('autoconfirm')
-        if (data.success) {
+        if (!data.error) {
           return this.node.addSentence(`there is a tell card named 'msg_{uid}' that is from the ${card.is_from.type.name} '${card.is_from.name.replace(/'/g, "\\'")}' and is to the agent '${this.agent.name.replace(/'/g, "\\'")}' and has the timestamp '{now}' as timestamp and has '${card.content.replace(/'/g, "\\'")}' as content.`);
         }
         data = this.node.askQuestion(card.content);
         // If question was success replicate as ask card ('autoask')
-        if (data.success) {
+        if (!data.error) {
           return this.node.addSentence(`there is an ask card named 'msg_{uid}' that is from the ${card.is_from.type.name} '${card.is_from.name.replace(/'/g, "\\'")}' and is to the agent '${this.agent.name.replace(/'/g, "\\'")}' and has the timestamp '{now}' as timestamp and has '${card.content.replace(/'/g, "\\'")}' as content.`);
         }
         // If question not understood then place the response to the NL card in a new response
         data = this.node.addNL(card.content);
-        return this.node.addSentence(`there is a ${data.type} card named 'msg_{uid}' that is from the agent '${this.agent.name.replace(/'/g, "\\'")}' and is to the ${card.is_from.type.name} '${card.is_from.name.replace(/'/g, "\\'")}' and has the timestamp '{now}' as timestamp and has '${data.data.replace(/'/g, "\\'")}' as content and is in reply to the card '${card.name}'.`);
+        return this.node.addSentence(`there is a ${data.response.type} card named 'msg_{uid}' that is from the agent '${this.agent.name.replace(/'/g, "\\'")}' and is to the ${card.is_from.type.name} '${card.is_from.name.replace(/'/g, "\\'")}' and has the timestamp '{now}' as timestamp and has '${data.response.message.replace(/'/g, "\\'")}' as content and is in reply to the card '${card.name}'.`);
+      },
+
+      'gist card': (card) => {
+        // Add sentence to any active gist policy queues
+        for (const policy of this.node.getInstances('gist policy')) {
+          if (policy.enabled === 'true' && policy.target && policy.target.name) {
+            const targetName = policy.target.name;
+            if (!(targetName in this.agent.policyHandler.unsentGistCards)) { this.agent.policyHandler.unsentGistCards[targetName] = []; }
+            this.agent.policyHandler.unsentGistCards[targetName].push(card);
+          }
+        }
       },
     };
   }

src/NLParser.js

@@ -18,6 +18,14 @@
 
 class NLParser {
 
+  static error(message) {
+    return { error: true, response: { message, type: 'gist' } };
+  }
+
+  static success(message) {
+    return { error: false, response: { message, type: 'confirm' } };
+  }
+
   /*
    * Submit natural language to be processed by node.
    * This results in
@@ -122,7 +130,7 @@ class NLParser {
         }
       }
       if (facts.length > 0) {
-        return [true, ce + facts.join(' and ')];
+        return NLParser.success(ce + facts.join(' and '));
       }
     }
 
@@ -140,12 +148,12 @@ class NLParser {
           }
         }
         if (newInstanceName && newInstanceName.length) {
-          return [true, `there is a ${this.node.concepts[i].name} named '${newInstanceName.trim()}'`];
+          return NLParser.success(`there is a ${this.node.concepts[i].name} named '${newInstanceName.trim()}'`);
         }
-        return [true, `there is a ${this.node.concepts[i].name} named '${this.node.concepts[i].name} ${this.node.instances.length}${1}'`];
+        return NLParser.success(`there is a ${this.node.concepts[i].name} named '${this.node.concepts[i].name} ${this.node.instances.length}${1}'`);
       }
     }
-    return [false, `Un-parseable input: ${t}`];
+    return NLParser.error(`Un-parseable input: ${t}`);
   }
 
   /*

src/PolicyHandler.js

@@ -86,6 +86,7 @@ class PolicyHandler {
     this.node = agent.node;
     this.unsentTellCards = {};
     this.unsentAskCards = {};
+    this.unsentGistCards = {};
     this.lastSuccessfulRequest = 0;
     this.handlers = {
 
@@ -159,6 +160,36 @@ class PolicyHandler {
         }
       },
 
+      'gist policy': (policy) => {
+        // For each gist policy in place, send all currently-untold cards to each target
+        // multiple cards to be sent to one target line-separated
+        if (policy.target && policy.target.name && policy.target.address) {
+          if (!(policy.target.name in this.unsentGistCards)) {
+            this.unsentGistCards[policy.target.name] = [];
+          }
+          let data = '';
+          for (const card of this.unsentGistCards[policy.target.name]) {
+            if (card.is_tos && card.is_from.name.toLowerCase() !== policy.target.name.toLowerCase()) { // Don't send back a card sent from target agent
+              // Make sure target is not already a recipient
+              let inCard = false;
+              for (const to of card.is_tos) {
+                if (to.id === policy.target.id) { inCard = true; break; }
+              }
+              if (!inCard) {
+                card.addRelationship('is to', policy.target);
+              }
+              data += `${card.ce}\n`;
+            }
+          }
+          if (data.length) {
+            net.makeRequest('POST', policy.target.address, POST_SENTENCES_ENDPOINT, data, () => {
+              this.lastSuccessfulRequest = new Date().getTime();
+              this.unsentGistCards[policy.target.name] = [];
+            });
+          }
+        }
+      },
+
       'listen policy': (policy) => {
         // Make request to target to get cards addressed to THIS agent
         if (policy.target && policy.target.address) {

src/QuestionParser.js

@@ -18,6 +18,14 @@
 
 class QuestionParser {
 
+  static error(message) {
+    return { error: true, response: { message, type: 'gist' } };
+  }
+
+  static success(message) {
+    return { error: false, response: { message, type: 'gist' } };
+  }
+
   /*
    * Submit a who/what/where question to be processed by node.
    * This may result in
@@ -28,21 +36,25 @@ class QuestionParser {
    * Returns: [bool, str] (bool = success, str = error or response)
    */
   parse(t) {
-    const input = t.trim();
-    if (t.match(/^where (is|are)/i)) {
-      return this.whereIs(input);
-    } else if (t.match(/^(\bwho\b|\bwhat\b) is(?: \bin?\b | \bon\b | \bat\b)/i)) {
-      return this.whatIsIn(input);
-    } else if (t.match(/^(\bwho\b|\bwhat\b) (?:is|are)/i)) {
-      return this.whatIs(input);
-    } else if (t.match(/^(\bwho\b|\bwhat\b) does/i)) {
-      return this.whatDoes(input);
-    } else if (t.match(/^(\bwho\b|\bwhat\b)/i)) {
-      return this.whatRelationship(input);
-    } else if (t.match(/^list (\ball\b|\binstances\b)/i)) {
-      return this.listInstances(input);
+    try {
+      const input = t.trim();
+      if (t.match(/^where (is|are)/i)) {
+        return this.whereIs(input);
+      } else if (t.match(/^(\bwho\b|\bwhat\b) is(?: \bin?\b | \bon\b | \bat\b)/i)) {
+        return this.whatIsIn(input);
+      } else if (t.match(/^(\bwho\b|\bwhat\b) (?:is|are)/i)) {
+        return this.whatIs(input);
+      } else if (t.match(/^(\bwho\b|\bwhat\b) does/i)) {
+        return this.whatDoes(input);
+      } else if (t.match(/^(\bwho\b|\bwhat\b)/i)) {
+        return this.whatRelationship(input);
+      } else if (t.match(/^list (\ball\b|\binstances\b)/i)) {
+        return this.listInstances(input);
+      }
+      return QuestionParser.error('Input is not a valid question');
+    } catch (err) {
+      return QuestionParser.error(`There was a problem with the question. ${err}.`);
     }
-    return [false, null];
   }
 
   whereIs(t) {
@@ -50,8 +62,7 @@ class QuestionParser {
     const instance = this.node.getInstanceByName(thing);
     let message;
     if (!instance) {
-      message = `I don't know what ${thing} is.`;
-      return [true, message];
+      return QuestionParser.success(`I don't know what ${thing} is.`);
     }
     const locatableInstances = this.node.getInstances('location', true);
     const locatableIds = [];
@@ -80,8 +91,7 @@ class QuestionParser {
       }
     }
     if (!placeFound) {
-      message = `I don't know where ${instance.name} is.`;
-      return [true, message];
+      return QuestionParser.success(`I don't know where ${instance.name} is.`);
     }
     message = instance.name;
     for (const place in places) {
@@ -93,7 +103,7 @@ class QuestionParser {
         message += ' and';
       }
     }
-    return [true, `${message.substring(0, message.length - 4)}.`];
+    return QuestionParser.success(`${message.substring(0, message.length - 4)}.`);
   }
 
   whatIsIn(t) {
@@ -106,7 +116,7 @@ class QuestionParser {
       }
     }
     if (!instance) {
-      return [true, `${thing} is not an instance of type location.`];
+      return QuestionParser.success(`${thing} is not an instance of type location.`);
     }
     const things = {};
     let thingFound = false;
@@ -133,7 +143,7 @@ class QuestionParser {
       }
     }
     if (!thingFound) {
-      return [true, `I don't know what is located in/on/at the ${instance.type.name} ${instance.name}.`];
+      return QuestionParser.success(`I don't know what is located in/on/at the ${instance.type.name} ${instance.name}.`);
     }
 
     let message = '';
@@ -144,7 +154,7 @@ class QuestionParser {
       }
       message += ' and';
     }
-    return [true, `${message.substring(0, message.length - 4)}.`];
+    return QuestionParser.success(`${message.substring(0, message.length - 4)}.`);
   }
 
   whatIs(input) {
@@ -156,7 +166,7 @@ class QuestionParser {
     if (name) {
       instance = this.node.getInstanceByName(name[2]);
       if (instance) {
-        return [true, instance.gist];
+        return QuestionParser.success(instance.gist);
       }
     }
 
@@ -187,44 +197,46 @@ class QuestionParser {
           }
         }
         if (possibilities.length > 0) {
-          return [true, `'${name}' ${possibilities.join(' and ')}.`];
+          return QuestionParser.success(`'${name}' ${possibilities.join(' and ')}.`);
         }
 
         // If nothing found, do fuzzy search
         const searchReturn = this.fuzzySearch(t);
         let fuzzyGist = 'I know about ';
         let fuzzyFound = false;
-        for (const key in searchReturn) {
-          if (searchReturn[key].length > 1) {
-            for (let i = 0; i < searchReturn[key].length; i += 1) {
-              if (i === 0) {
-                if (!fuzzyFound) {
-                  fuzzyGist += `the ${key}s '${searchReturn[key][i]}'`;
+        if (searchReturn) {
+          for (const key in searchReturn) {
+            if (searchReturn[key].length > 1) {
+              for (let i = 0; i < searchReturn[key].length; i += 1) {
+                if (i === 0) {
+                  if (!fuzzyFound) {
+                    fuzzyGist += `the ${key}s '${searchReturn[key][i]}'`;
+                  } else {
+                    fuzzyGist += `The ${key}s '${searchReturn[key][i]}'`;
+                  }
                 } else {
-                  fuzzyGist += `The ${key}s '${searchReturn[key][i]}'`;
+                  fuzzyGist += `, '${searchReturn[key][i]}'`;
+                }
+                if (i === searchReturn[key].length - 1) {
+                  fuzzyGist += '. ';
                 }
-              } else {
-                fuzzyGist += `, '${searchReturn[key][i]}'`;
-              }
-              if (i === searchReturn[key].length - 1) {
-                fuzzyGist += '. ';
               }
+            } else if (!fuzzyFound) {
+              fuzzyGist += `the ${key} '${searchReturn[key][0]}'. `;
+            } else {
+              fuzzyGist += `The ${key} '${searchReturn[key][0]}'. `;
             }
-          } else if (!fuzzyFound) {
-            fuzzyGist += `the ${key} '${searchReturn[key][0]}'. `;
-          } else {
-            fuzzyGist += `The ${key} '${searchReturn[key][0]}'. `;
+            fuzzyFound = true;
           }
-          fuzzyFound = true;
         }
         if (fuzzyFound) {
-          return [true, fuzzyGist];
+          return QuestionParser.success(fuzzyGist);
         }
-        return [true, 'I don\'t know who or what that is.'];
+        return QuestionParser.success('I don\'t know who or what that is.');
       }
-      return [true, concept.gist];
+      return QuestionParser.success(concept.gist);
     }
-    return [true, instance.gist];
+    return QuestionParser.success(instance.gist);
   }
 
   whatDoes(t) {
@@ -256,20 +268,21 @@ class QuestionParser {
           property = instance.property(fixedPropertyName);
         }
         if (property) {
-          return [true, `${instance.name} ${fixedPropertyName} the ${property.type.name} ${property.name}.`];
+          return QuestionParser.success(`${instance.name} ${fixedPropertyName} the ${property.type.name} ${property.name}.`);
         }
-        return [true, `Sorry - I don't know that property about the ${instance.type.name} ${instance.name}.`];
+        return QuestionParser.success(`Sorry - I don't know that property about the ${instance.type.name} ${instance.name}.`);
       }
     } catch (err) {
-      return [false, 'Sorry - I can\'t work out what you\'re asking.'];
+      return QuestionParser.success('Sorry - I can\'t work out what you\'re asking.');
     }
-    return null;
+    return QuestionParser.success('Sorry - I can\'t work out what you\'re asking about.');
   }
 
   whatRelationship(t) {
     const data = t.match(/^(\bwho\b|\bwhat\b) ([a-zA-Z0-9_ ]*)/i);
     const body = data[2].replace(/\ban\b/gi, '').replace(/\bthe\b/gi, '').replace(/\ba\b/gi, '');
     const tokens = body.split(' ');
+    const uniqueResponses = new Set([]);
     let instance;
     for (let i = 0; i < tokens.length; i += 1) {
       const testString = tokens.slice(tokens.length - (i + 1), tokens.length).join(' ').trim();
@@ -283,6 +296,7 @@ class QuestionParser {
         break;
       }
     }
+
     if (instance) {
       const propertyName = tokens.splice(0, tokens.length - instance.name.split(' ').length).join(' ').trim();
       for (let i = 0; i < this.node.instances.length; i += 1) {
@@ -304,12 +318,16 @@ class QuestionParser {
           property = subject.property(fixedPropertyName);
         }
         if (property && property.name === instance.name) {
-          return [true, `${subject.name} ${fixedPropertyName} the ${property.type.name} ${property.name}.`];
+          uniqueResponses.add(`${subject.name} ${fixedPropertyName} the ${property.type.name} ${property.name}.`);
+        }
+        const responsesArray = Array.from(uniqueResponses);
+        if (responsesArray.length > 0 && i === this.node.instances.length - 1) {
+          return QuestionParser.success(responsesArray.join(' '));
         }
       }
-      return [true, `Sorry - I don't know that property about the ${instance.type.name} ${instance.name}.`];
+      return QuestionParser.success(`Sorry - I don't know that property about the ${instance.type.name} ${instance.name}.`);
     }
-    return null;
+    return QuestionParser.success('Sorry - I don\'t know the instance you\'re referring to.');
   }
 
   listInstances(t) {
@@ -328,17 +346,16 @@ class QuestionParser {
       s = 'All instances:';
     }
     if (ins.length === 0) {
-      return [true, 'I could not find any instances matching your query.'];
+      return QuestionParser.success('I could not find any instances matching your query.');
     }
     const names = [];
     for (let i = 0; i < ins.length; i += 1) {
       names.push(ins[i].name);
     }
-    return [true, `${s} ${names.join(', ')}`];
+    return QuestionParser.success(`${s} ${names.join(', ')}`);
   }
 
   /*
-   *
    * Search the knowledge base for an instance name similar to the one asked about.
    */
   fuzzySearch(sentence) {
@@ -348,12 +365,10 @@ class QuestionParser {
     let instancesFiltered = [];
 
     if (searchFor.indexOf(' ')) {
-      // if theres spaces then split
       multipleSearch = searchFor.split(' ');
     }
 
     if (multipleSearch) {
-      // loop through to create return string
       for (let x = 0; x < multipleSearch.length; x += 1) {
         const instancesFilteredTemp = instances.filter((input) => {
           if (input.name.toUpperCase().includes(multipleSearch[x].toUpperCase())) {
@@ -364,7 +379,6 @@ class QuestionParser {
         instancesFiltered = instancesFiltered.concat(instancesFilteredTemp);
       }
     } else {
-      // single search term
       instancesFiltered = instances.filter((input) => {
         if (input.name.toUpperCase().includes(searchFor.toUpperCase())) {
           return input;

test/QuestionParser.js

@@ -0,0 +1,40 @@
+const CENode = require('../src/CENode.js');
+const CEModels = require('../models/index.js');
+const expect = require('expect.js');
+const myName = 'User'
+const PLANETS_MODEL = [
+  "there is a rule named 'r1' that has 'if the planet C ~ orbits ~ the star D then the star D ~ is orbited by ~ the planet C' as instruction.",
+  "there is a rule named 'r2' that has 'if the planet C ~ is orbited by ~ the moon D then the moon D ~ orbits ~ the planet C' as instruction.",
+  "conceptualise a ~ celestial body ~ C.",
+  "conceptualise the celestial body C ~ orbits ~ the celestial body D and ~ is orbited by ~ the celestial body E.",
+  "conceptualise a ~ planet ~ P that is a celestial body and is an imageable thing.",
+  "conceptualise a ~ star ~ S that is a celestial body.",
+  "there is a star named sun.",
+  "there is a planet named Venus that orbits the star 'sun' and has 'media/Venus.jpg' as image.",
+  "there is a planet named Mercury that orbits the star 'sun' and has 'media/Mercury.jpg' as image."
+]
+
+let node;
+describe('CEQuestionParser', function() {
+  describe('What relation questions', function () {
+    this.timeout(2050);
+    before(function() {
+      node = new CENode(CEModels.core, PLANETS_MODEL);
+      node.attachAgent();
+      node.agent.setName('agent1');
+    });
+    it('returns the correct number of responses', (done) => {
+      const message = 'what orbits the sun?';
+      const askCard = "there is a nl card named '{uid}' that is to the agent 'agent1' and is from the individual '" + myName + "' and has the timestamp '{now}' as timestamp and has '" + message.replace(/'/g, "\\'")+"' as content.";
+      
+      node.addSentence(askCard);
+      
+      setTimeout(function() {
+        const cards = node.concepts.card.allInstances;
+        const card = cards[cards.length - 1];
+        expect(card.content).to.equal('Venus orbits the star sun. Mercury orbits the star sun.');
+        done();
+      }, 2000);
+    });
+  });
+});