sockethub 5.0.0-alpha.2 → 5.0.0-alpha.4

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

@@ -1,27 +0,0 @@
-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

@@ -1,72 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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();
-      }
-    });
-  };
-};

package/src/middleware/validate.d.ts

@@ -1 +0,0 @@
-export default function validate(type: any): (next: any, msg: any) => void;

package/src/middleware/validate.test.data.ts

@@ -1,320 +0,0 @@
-export default [
-  {
-    "name": "mismatched types",
-    "valid": false,
-    "type": "credentials",
-    "input":{
-      "id":"blah",
-      "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",
-        "user": 'foo',
-        "pass": 'bar'
-      }
-    },
-    'error': "Error: credential activity streams must have credentials set as type"
-  },
-  {
-    "name": "basic",
-    "valid":true,
-    "type":"credentials",
-    "input":{
-      "id":"blah",
-      "type":"credentials",
-      "context":"dummy",
-      "actor":{
-        "id":"dood@irc.freenode.net",
-        "type":"person",
-        "name":"dood"
-      },
-      "object":{
-        'type': 'credentials',
-        "user": 'foo',
-        "pass": 'bar'
-      }
-    },
-    "output":"same"
-  },
-  {
-    "name":"irc credentials",
-    "valid":true,
-    "type":"credentials",
-    "input":{
-      "context":"irc",
-      "type":"credentials",
-      "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":"bad irc credentials: user/nick host/server",
-    "valid":false,
-    "type":"credentials",
-    "input":{
-      "context":"irc",
-      "type":"credentials",
-      "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",
-        "user":"sh-9K3Vk",
-        "port":6667,
-        "secure":false,
-        "host":"irc.freenode.net"
-      }
-    },
-    "error":
-      "Error: /object: must NOT have additional properties"
-  },
-  {
-    "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: credential activity streams must have credentials set as type"
-  },
-  {
-    "name":"basic person",
-    "type":"activity-object",
-    "valid":true,
-    "input":{
-      "id":"blah",
-      "type":"person",
-      "name":"dood"
-    },
-    "output":"same"
-  },
-  {
-    "name":"person with extras",
-    "valid":true,
-    "type":"activity-object",
-    "input":{
-      "id":"blah",
-      "type":"person",
-      "name":"bob",
-      "hello":"there",
-      "i":[
-        "am",
-        "extras"
-      ]
-    },
-    "output":"same"
-  },
-  {
-    "name":"alone credentials (as activity-object)",
-    "valid":false,
-    "type":"activity-object",
-    "input":{
-      "type":"credentials",
-      "nick":"sh-9K3Vk",
-      "port":6667,
-      "secure":false,
-      "server":"irc.freenode.net"
-    },
-    "error":
-      "Error: /object: must match exactly one schema in oneOf: " +
-      "credentials, feed, message, me, person, room, service, website, " +
-      "attendance, presence, relationship, topic, address"
-  },
-  {
-    "name":"alone credentials (as credentials)",
-    "valid":false,
-    "type":"credentials",
-    "input":{
-      "type":"credentials",
-      "nick":"sh-9K3Vk",
-      "port":6667,
-      "secure":false,
-      "server":"irc.freenode.net"
-    },
-    "error": "Error: platform context undefined not registered with this sockethub instance."
-  },
-  {
-    "name":"new person",
-    "valid":true,
-    "type":"activity-object",
-    "input":{
-      "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"
-    },
-    "output":"same"
-  },
-  {
-    "name":"new person",
-    "valid":true,
-    "type":"activity-object",
-    "input":{
-      "id":"irc://sh-9K3Vk@irc.freenode.net",
-      "type":"person",
-      "name":"sh-9K3Vk",
-      "url":"http://sockethub.org"
-    },
-    "output":"same"
-  },
-  {
-    "name":"bad parent object",
-    "valid":false,
-    "type":"activity-stream",
-    "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: platform context undefined not registered with this sockethub instance."
-  },
-  {
-    "name":"unexpected AS",
-    "valid":false,
-    "type":"message",
-    "input":{
-      "actor":"irc://uuu@localhost",
-      "type":"join",
-      "context":"irc",
-      "target":"irc://irc.dooder.net/a-room"
-    },
-    "error": "Error: /actor: must be object"
-  },
-  {
-    "name":"missing type property",
-    "valid":false,
-    "type":"message",
-    "input":{
-      "actor": { "id": "irc://uuu@localhost", "type": "person" },
-      "context":"irc",
-      "target": { "id": "irc://irc.dooder.net/a-room", "type": "room" }
-    },
-    "error": "Error: activity stream: must have required property \'type\'"
-  },
-  {
-    "name":"invalid context property",
-    "valid":false,
-    "type":"message",
-    "input":{
-      "actor": { "id": "irc://uuu@localhost", "type": "person" },
-      "type":"foo",
-      "context": "foobar",
-      "target": { "id": "irc://irc.dooder.net/a-room", "type": "room" }
-    },
-    "error": "Error: platform context foobar not registered with this sockethub instance."
-  },
-  {
-    "name":"missing actor property",
-    "valid":false,
-    "type":"message",
-    "input":{
-      "type": "foo",
-      "context":"irc",
-      "target": { "id": "irc://irc.dooder.net/a-room", "type": "room" }
-    },
-    "error": "Error: activity stream: must have required property \'actor\'"
-  },
-  {
-    "name":"traditional message",
-    "valid":true,
-    "type":"message",
-    "input":{
-      "type": "update",
-      "context": "irc",
-      "actor": { "id": "irc://uuu@localhost", "type": "person" }
-    }
-  },
-  {
-    "name":"message with wrong type",
-    "valid":false,
-    "type":"message",
-    "input":{
-      "type": "foorg",
-      "context": "irc",
-      "actor": { "id": "irc://uuu@localhost", "type": "person" }
-    },
-    "error": "Error: platform type foorg not supported by irc platform. " +
-      "(types: credentials, connect, update, join, leave, send, query, announce)"
-  }
-];

package/src/middleware/validate.test.ts

@@ -1,47 +0,0 @@
-import { expect } from 'chai';
-import proxyquire from 'proxyquire';
-
-proxyquire.noPreserveCache();
-proxyquire.noCallThru();
-
-// @ts-ignore
-import platformLoad from './../bootstrap/platforms';
-const packageJSON = require('./../../package.json');
-const platforms = platformLoad(Object.keys(packageJSON.dependencies));
-
-const validateMod = proxyquire('./validate', {
-  '../bootstrap/init': {
-    platforms: platforms
-  }
-});
-const validate = validateMod.default;
-
-import asObjects from "./validate.test.data";
-
-describe('Middleware: Validate', () => {
-  describe('AS object validations', () => {
-    asObjects.forEach((obj) => {
-      it(`${obj.type}: ${obj.name}, should ${obj.valid ? 'pass' : 'fail'}`, (done) => {
-        // @ts-ignore
-        validate(obj.type, 'tests')(obj.input, (msg) => {
-          if (obj.output) {
-            if (obj.output === 'same') {
-              expect(msg).to.eql(obj.input);
-            } else {
-              expect(msg).to.eql(obj.output);
-            }
-          }
-          if (obj.valid) {
-            expect(msg).to.not.be.instanceof(Error);
-          } else {
-            expect(msg).to.be.instanceof(Error);
-            if (obj.error) {
-              expect(msg.toString()).to.equal(obj.error);
-            }
-          }
-          done();
-        });
-      });
-    });
-  });
-});

package/src/middleware/validate.ts

@@ -1,49 +0,0 @@
-/**
- * responsible for handling the validation and expansion (when applicable) of all incoming objects
- */
-import debug from 'debug';
-import * as Schemas from 'sockethub-schemas';
-import { ActivityStream } from "../sockethub";
-
-// @ts-ignore
-import init from "../bootstrap/init";
-
-init.platforms.forEach((platform) => {
-  Object.keys(platform.schemas).forEach((key) => {
-    if (! platform.schemas[key]) { return; }
-    Schemas.validator.addPlatformSchema(platform.schemas[key], `${platform.id}/${key}`);
-  });
-});
-
-// called when registered with the middleware function, define the type of validation
-// that will be called when the middleware eventually does.
-export default function validate(type: string, sockethubId: string) {
-  const sessionLog = debug(`sockethub:validate:${sockethubId}`);
-  return (msg: ActivityStream, done: Function) => {
-    sessionLog('applying schema validation for ' + type);
-    if (type === 'activity-object') {
-      const err = Schemas.validator.validateActivityObject(msg);
-      err ? done(new Error(err)) : done(msg);
-    } else if (! init.platforms.has(msg.context)) {
-      return done(
-        new Error(`platform context ${msg.context} not registered with this sockethub instance.`)
-      );
-    } else if (type === 'credentials') {
-      const err = Schemas.validator.validateCredentials(msg);
-      err ? done(new Error(err)) : done(msg);
-    } else {
-      const err = Schemas.validator.validateActivityStream(msg);
-      if (err) {
-        done(new Error(err));
-      } else {
-        const platformMeta = init.platforms.get(msg.context);
-        if (!platformMeta.types.includes(msg.type)) {
-          return done(new Error(`platform type ${msg.type} not supported by ${msg.context} ` +
-            `platform. (types: ${platformMeta.types.join(', ')})`));
-        } else {
-          done(msg);
-        }
-      }
-    }
-  };
-};

package/src/middleware.d.ts

@@ -1,21 +0,0 @@
-/**
- * a very simple middleware handler
- *
- * When initialized, provide a function which will be called if there were any failures during
- * the execution of functions along the chain.
- *
- * Use middleware.chain, passing in a list of functions to call in order. It then returns
- * a function which accepts the message from the input. That function then will
- * call each of the originally passed in functions, in order, with a `next` callback as
- * the first parameter, and any number of originating parameters.
- *
- * As one middleware function is done, they call `next` with the first argument `true`
- * (succeeded, continue) any parameters to pass along.
- *
- * If any of the middleware function calls the `next` handler with `false` as the first param, the
- * execution of the function chain is halted, and the failure callback is called. Again, any
- * number of params passed after the `false` will be passed to the failure callback.
- *
- */
-declare function Middleware(errorHandler: any): void;
-export default Middleware;