sockethub 4.0.1 → 5.0.0-alpha.1

package/src/middleware/expand-activity-stream.test.data.ts

@@ -0,0 +1,365 @@
+export default [
+  {
+    "name": "not an object",
+    "valid": false,
+    "type": "message",
+    "input": "hello world",
+    "error": "Error: message received is not an object."
+  },
+  {
+    "name": "basic invalid type",
+    "valid":true,
+    "type":"credentials",
+    "input":{
+      "id":"foo",
+      "type":"send",
+      "context":"dummy",
+      "actor":{
+        "id":"dood@irc.freenode.net",
+        "type":"person",
+        "name":"dood"
+      },
+      "target":{
+        "id":"irc.freenode.net/sockethub",
+        "type":"person",
+        "name":"sockethub"
+      },
+      "object":{
+        "type":"credentials"
+      }
+    },
+    "output": "same"
+  },
+  {
+    "name": "basic valid type",
+    "valid":true,
+    "type":"credentials",
+    "input":{
+      "id":"foo",
+      "type":"credentials",
+      "context":"dummy",
+      "actor":{
+        "id":"dood@irc.freenode.net",
+        "type":"person",
+        "name":"dood"
+      },
+      "target":{
+        "id":"irc.freenode.net/sockethub",
+        "type":"person",
+        "name":"sockethub"
+      },
+      "object":{
+        "type":"credentials"
+      }
+    },
+    "output":"same"
+  },
+  {
+    "name":"new format",
+    "valid":true,
+    "type":"credentials",
+    "input":{
+      "type":"credentials",
+      "context":"irc",
+      "actor":{
+        "id":"sh-9K3Vk@irc.freenode.net",
+        "type":"person",
+        "name":"sh-9K3Vk",
+        "image":{
+          "height":250,
+          "mediaType":"image/jpeg",
+          "url":"http://example.org/image.jpg",
+          "width":250
+        },
+        "url":"http://sockethub.org"
+      },
+      "object":{
+        "type":"credentials",
+        "nick":"sh-9K3Vk",
+        "port":6667,
+        "secure":false,
+        "server":"irc.freenode.net"
+      }
+    },
+    "output":"same"
+  },
+  {
+    "name":"no type specified",
+    "valid":false,
+    "type":"credentials",
+    "input":{
+      "actor":"hyper_rau@localhost",
+      "context":"xmpp",
+      "object":{
+        "username":"hyper_rau",
+        "password":"123",
+        "server":"localhost",
+        "port":5222,
+        "resource":"laptop"
+      }
+    },
+    "error": "Error: activity stream must contain a type property."
+  },
+  {
+    "name": "expand unknown actor",
+    "type": "message",
+    "valid": "true",
+    "input": {
+      "context": "foo",
+      "type": "bar",
+      "actor": "foo@bar",
+      "object": {
+        "content": "bar"
+      }
+    },
+    "output": {
+      "context": "foo",
+      "type": "bar",
+      "actor": {
+        "id": "foo@bar"
+      },
+      "object": {
+        "content": "bar"
+      }
+    }
+  },
+  {
+    "name": "expand unknown actor 2",
+    "type": "message",
+    "valid": "true",
+    "input": {
+      "context": "foo",
+      "type": "bar",
+      "actor": "someone@example.org/resource",
+      "object": {
+        "content": "bar"
+      }
+    },
+    "output": {
+      "context": "foo",
+      "type": "bar",
+      "actor": {
+        "id": "someone@example.org/resource"
+      },
+      "object": {
+        "content": "bar"
+      }
+    }
+  },
+  {
+    "name": "expand unknown actor 2",
+    "type": "message",
+    "valid": "true",
+    "input": {
+      "context": "foo",
+      "type": "bar",
+      "actor": "xmpp:someone@example.org/resource",
+      "object": {
+        "content": "bar"
+      }
+    },
+    "output": {
+      "context": "foo",
+      "type": "bar",
+      "actor": {
+        "id": "xmpp:someone@example.org/resource"
+      },
+      "object": {
+        "content": "bar"
+      }
+    }
+  },
+  {
+    "name":"person",
+    "type":"message",
+    "valid":true,
+    "input":{
+      "context": "some context",
+      "type": "some type",
+      "actor": "blah",
+      "object": {}
+    },
+    "output": {
+      "context": "some context",
+      "type": "some type",
+      "actor": {
+        "id":"blah",
+        "type":"person",
+        "name":"dood"
+      },
+      "object": {}
+    }
+  },
+  {
+    "name":"person with extras",
+    "valid":true,
+    "type":"message",
+    "input": {
+      "context": "some context",
+      "type": "some type",
+      "actor": "blah2",
+      "object": {}
+    },
+    "output": {
+      "context": "some context",
+      "type": "some type",
+      "actor": {
+        "id":"blah2",
+        "type":"person",
+        "name":"bob",
+        "hello":"there",
+        "i":[
+          "am",
+          "extras"
+        ]
+      },
+      "object": {}
+    }
+  },
+  {
+    "name":"bad parent object",
+    "valid":false,
+    "type":"message",
+    "input":{
+      "string":"this is a string",
+      "array":[
+        "this",
+        "is",
+        {
+          "an":"array"
+        }
+      ],
+      "as":{
+        "id":"blah",
+        "type":"send",
+        "context":"hello",
+        "actor":{
+          "name":"dood"
+        },
+        "target":{
+          "type":"person",
+          "name":"bob"
+        },
+        "object":{
+          "type":"credentials"
+        }
+      },
+      "noId":{
+        "name":"dood"
+      },
+      "noId2":{
+        "type":"person",
+        "name":"bob"
+      },
+      "noDisplayName":{
+        "id":"larg"
+      }
+    },
+    "error": "Error: activity stream must contain a context property"
+  },
+  {
+    "name":"no actor specified",
+    "valid":false,
+    "type":"message",
+    "input":{
+      "type": "some type",
+      "context":"xmpp",
+      "object":{
+        "type": "error",
+        "content": "error message"
+      }
+    },
+    "error": "Error: activity stream must contain an actor property."
+  },
+  {
+    "name":"expand actor and target of unknowns",
+    "valid":true,
+    "type":"message",
+    "input":{
+      "actor":"irc://uuu@localhost",
+      "type":"join",
+      "context":"irc",
+      "target":"irc://irc.dooder.net/a-room"
+    },
+    "output":{
+      "actor":{
+        "id":"irc://uuu@localhost"
+      },
+      "type":"join",
+      "context":"irc",
+      "target":{
+        "id":"irc://irc.dooder.net/a-room"
+      }
+    }
+  },
+  {
+    "name":"expand actor and target of unknowns",
+    "valid":true,
+    "type":"message",
+    "input":{
+      "actor":"hyper_rau@localhost",
+      "type":"join",
+      "context":"xmpp",
+      "object":{
+
+      },
+      "target":"dooder"
+    },
+    "output":{
+      "actor":{
+        "id":"hyper_rau@localhost"
+      },
+      "type":"join",
+      "context":"xmpp",
+      "object":{
+
+      },
+      "target":{
+        "id":"dooder"
+      }
+    }
+  },
+  {
+    "name":"expand known person",
+    "valid":true,
+    "type":"message",
+    "input":{
+      "actor":"sh-9K3Vk@irc.freenode.net",
+      "target":"blah3",
+      "type":"send",
+      "context":"irc",
+      "object":{
+
+      }
+    },
+    "output":{
+      "actor":{
+        "id":"sh-9K3Vk@irc.freenode.net",
+        "type":"person",
+        "name":"sh-9K3Vk",
+        "image":{
+          "height":250,
+          "mediaType":"image/jpeg",
+          "url":"http://example.org/image.jpg",
+          "width":250
+        },
+        "url":"http://sockethub.org"
+      },
+      "target":{
+        "id":"blah3",
+        "type":"person",
+        "name":"bob",
+        "hello":"there",
+        "i":[
+          "am",
+          "extras"
+        ]
+      },
+      "type":"send",
+      "context":"irc",
+      "object":{
+
+      }
+    }
+  }
+];

package/src/middleware/expand-activity-stream.test.ts

@@ -0,0 +1,78 @@
+import { expect } from 'chai';
+
+import expandActivityStream from "./expand-activity-stream";
+
+import asObjects from "./expand-activity-stream.test.data";
+import ActivityStreams from 'activity-streams';
+
+const activity = ActivityStreams();
+// register known activity objects
+[
+  {
+    "id":"blah",
+    "type":"person",
+    "name":"dood"
+  },
+  {
+    "id":"blah2",
+    "type":"person",
+    "name":"bob",
+    "hello":"there",
+    "i":[
+      "am",
+      "extras"
+    ]
+  },
+  {
+    "id":"sh-9K3Vk@irc.freenode.net",
+    "type":"person",
+    "name":"sh-9K3Vk",
+    "image":{
+      "height":250,
+      "mediaType":"image/jpeg",
+      "url":"http://example.org/image.jpg",
+      "width":250
+    },
+    "url":"http://sockethub.org"
+  },
+  {
+    "id":"blah3",
+    "type":"person",
+    "name":"bob",
+    "hello":"there",
+    "i":[
+      "am",
+      "extras"
+    ]
+  }
+].forEach((obj) => {
+  activity.Object.create(obj);
+});
+
+describe('Middleware: Expand Activity Stream', () => {
+  describe('AS object expansion', () => {
+    asObjects.forEach((obj) => {
+      it(`${obj.type}: ${obj.name}, should ${obj.valid ? 'pass' : 'fail'}`, (done) => {
+        // @ts-ignore
+        expandActivityStream(obj.input, (msg) => {
+          if (obj.output) {
+            if (obj.output === 'same') {
+              expect(obj.input).to.eql(msg);
+            } else {
+              expect(obj.output).to.eql(msg);
+            }
+          }
+          if (obj.valid) {
+            expect(msg instanceof Error).to.be.false;
+          } else {
+            expect(msg instanceof Error).to.be.true;
+            if (obj.error) {
+              expect(obj.error).to.equal(msg.toString());
+            }
+          }
+          done();
+        });
+      });
+    });
+  });
+});

package/src/middleware/expand-activity-stream.ts

@@ -0,0 +1,27 @@
+import ActivityStreams from 'activity-streams';
+
+import config from "../config";
+import { ActivityStream } from "../sockethub";
+
+const activity = ActivityStreams(config.get('activity-streams:opts'));
+
+function ensureObject(msg: any) {
+  return !((typeof msg !== 'object') || (Array.isArray(msg)));
+}
+
+export default function expandActivityStream(msg: ActivityStream, done: Function) {
+  if (! ensureObject(msg)) {
+    done(new Error(`message received is not an object.`));
+  } else if (typeof msg.context !== 'string') {
+    done(new Error('activity stream must contain a context property'));
+  }  else if (typeof msg.type !== 'string') {
+    done(new Error('activity stream must contain a type property.'));
+  } else {
+    msg = activity.Stream(msg);
+    if (! msg.actor) {
+      done(new Error('activity stream must contain an actor property.'));
+    } else {
+      done(msg);
+    }
+  }
+}

package/src/middleware/store-credentials.test.ts

@@ -0,0 +1,72 @@
+import { expect } from 'chai';
+import * as sinon from 'sinon';
+
+import storeCredentials from "./store-credentials";
+
+const creds = {
+  "id":"blah",
+  "type":"credentials",
+  "context":"dummy",
+  "actor":{
+    "id":"dood@irc.freenode.net",
+    "type":"person",
+    "name":"dood"
+  },
+  "target":{
+    "id":"irc.freenode.net/sockethub",
+    "type":"person",
+    "name":"sockethub"
+  },
+  "object":{
+    "type":"credentials"
+  }
+};
+
+describe('Middleware: storeCredentials', () => {
+  let storeSuccess, storeError, saveErrorFake, saveSuccessFake, sessionLogStub;
+
+  beforeEach(() => {
+    storeSuccess = {
+      save: (id, creds, cb) => {
+        cb();
+      }
+    };
+    storeError = {
+      save: (id, creds, cb) => {
+        cb('some error');
+      }
+    };
+    saveSuccessFake = sinon.replace(storeSuccess, 'save', sinon.fake(storeSuccess.save));
+    saveErrorFake = sinon.replace(storeError, 'save', sinon.fake(storeError.save));
+    sessionLogStub = sinon.stub();
+  });
+
+  afterEach(() => {
+    sinon.reset();
+  });
+
+  it('returns a middleware handler', () => {
+    const sc = storeCredentials(storeSuccess, sessionLogStub);
+    expect(typeof sc).to.equal('function');
+    expect(saveSuccessFake.callCount).to.equal(0);
+    expect(sessionLogStub.callCount).to.equal(0);
+  });
+
+  it('successfully store credentials', () => {
+    const sc = storeCredentials(storeSuccess, sessionLogStub);
+    sc(creds, (err) => {
+      expect(saveSuccessFake.callCount).to.equal(1);
+      expect(saveSuccessFake.firstArg).to.equal(creds.actor.id);
+      expect(err).to.be.undefined;
+    });
+  });
+
+  it('handle error while storing credentials', () => {
+    const sc = storeCredentials(storeError, sessionLogStub);
+    sc(creds, (err) => {
+      expect(saveErrorFake.callCount).to.equal(1);
+      expect(saveErrorFake.firstArg).to.equal(creds.actor.id);
+      expect(err).to.eql('some error');
+    });
+  });
+});

package/src/middleware/store-credentials.ts

@@ -0,0 +1,16 @@
+import { ISecureStoreInstance } from "../store";
+import { ActivityStream } from "../sockethub";
+
+export default function storeCredentials(store: ISecureStoreInstance, sessionLog: Function) {
+  return (creds: ActivityStream, done: Function) => {
+    store.save(creds.actor.id, creds, (err) => {
+      if (err) {
+        sessionLog('error saving credentials to store ' + err);
+        done(err);
+      } else {
+        sessionLog('credentials encrypted and saved');
+        done();
+      }
+    });
+  };
+};