sockethub 4.0.0 → 5.0.0-alpha.0

package/dist/validate.js

@@ -1,157 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * responsible for handling the validation and expansion (when applicable) of all incoming objects
- */
-const tv4_1 = __importDefault(require("tv4"));
-const debug_1 = __importDefault(require("debug"));
-const urijs_1 = __importDefault(require("urijs"));
-const activity_streams_1 = __importDefault(require("activity-streams"));
-const SockethubSchemas = __importStar(require("sockethub-schemas"));
-const init_1 = __importDefault(require("./bootstrap/init"));
-const config_1 = __importDefault(require("./config"));
-const activity = activity_streams_1.default(config_1.default.get('activity-streams:opts'));
-// load sockethub-activity-stream schema and register it with tv4
-// http://sockethub.org/schemas/v0/activity-stream#
-tv4_1.default.addSchema(SockethubSchemas.ActivityStream.id, SockethubSchemas.ActivityStream);
-// load sockethub-activity-object schema and register it with tv4
-// http://sockethub.org/schemas/v0/activity-object#
-tv4_1.default.addSchema(SockethubSchemas.ActivityObject.id, SockethubSchemas.ActivityObject);
-// educated guess on what the displayName is, if it's not defined
-// since we know the @id is a URI, we prioritize by username, then fragment (no case yet for path)
-function ensureDisplayName(msg) {
-    if ((msg['@id']) && (!msg.displayName)) {
-        const uri = new urijs_1.default(msg['@id']);
-        return uri.username() || getUriFragment(uri) || uri.path();
-    }
-    return msg.displayName;
-}
-function ensureObject(msg) {
-    return !((typeof msg !== 'object') || (Array.isArray(msg)));
-}
-function errorHandler(type, msg, next) {
-    return (err) => {
-        return next(false, err, type, msg);
-    };
-}
-// expand given prop to full object if they are just strings
-// FIXME are we sure this works? What's propName for?
-function expandProp(propName, prop) {
-    return (typeof prop === 'string') ? activity.Object.get(prop, true) : prop;
-}
-function expandStream(msg) {
-    msg.actor.displayName = ensureDisplayName(msg.actor);
-    if (msg.target) {
-        msg.target.displayName = ensureDisplayName(msg.target);
-    }
-    return msg;
-}
-function getUriFragment(uri) {
-    const frag = uri.fragment();
-    return (frag) ? '#' + frag : undefined;
-}
-function processActivityObject(msg, error, next) {
-    if (!validateActivityObject(msg)) {
-        return error(`activity-object schema validation failed: ${tv4_1.default.error.dataPath} = ${tv4_1.default.error.message}`);
-    }
-    msg.displayName = ensureDisplayName(msg);
-    return next(true, msg); // passed validation, on to next handler in middleware chain
-}
-function processActivityStream(msg, error, next) {
-    let stream;
-    try { // expands the AS object to a full object with the expected properties
-        stream = activity.Stream(msg);
-    }
-    catch (e) {
-        return error(e);
-    }
-    msg = stream; // overwrite message with expanded as object stream
-    if (!validateActivityStream(msg)) {
-        return error(`actvity-stream schema validation failed: ${tv4_1.default.error.dataPath}: ${tv4_1.default.error.message}`);
-    }
-    // passed validation, on to next handler in middleware chain
-    return next(true, expandStream(msg));
-}
-function processCredentials(msg, error, next) {
-    msg.actor = expandProp('actor', msg.actor);
-    msg.target = expandProp('target', msg.target);
-    let credentialsSchema = tv4_1.default.getSchema(`http://sockethub.org/schemas/v0/context/${msg.context}/credentials`);
-    if (!credentialsSchema) {
-        return error(`no credentials schema found for ${msg.context} context`);
-    }
-    if (!validateCredentials(msg, credentialsSchema)) {
-        return error(`credentials schema validation failed: ${tv4_1.default.error.dataPath} = ${tv4_1.default.error.message}`);
-    }
-    // passed validation, on to next handler in middleware chain
-    return next(true, expandStream(msg));
-}
-function validateActivityObject(msg) {
-    return tv4_1.default.validate({ object: msg }, SockethubSchemas.ActivityObject);
-}
-function validateCredentials(msg, schema) {
-    return tv4_1.default.validate(msg, schema);
-}
-function validateActivityStream(msg) {
-    // TODO figure out a way to allow for special objects from platforms, without
-    // ignoring failed activity stream schema checks
-    if (!tv4_1.default.validate(msg, SockethubSchemas.ActivityStream)) {
-        return tv4_1.default.getSchema(`http://sockethub.org/schemas/v0/context/${msg.context}/messages`);
-    }
-    return true;
-}
-// called when registered with the middleware function, define the type of validation
-// that will be called when the middleware eventually does.
-function validate(type, sockethubId) {
-    const sessionLog = debug_1.default(`sockethub:validate:${sockethubId}`);
-    // called by the middleware with the message and the next (callback) in the chain
-    return (next, msg) => {
-        sessionLog('applying schema validation for ' + type);
-        const error = errorHandler(type, msg, next);
-        if (!ensureObject(msg)) {
-            error(`message received is not an object.`);
-        }
-        else if (type === 'activity-object') {
-            processActivityObject(msg, error, next);
-        }
-        else if (typeof msg.context !== 'string') {
-            error('message must contain a context property');
-        }
-        else if (!init_1.default.platforms.has(msg.context)) {
-            error(`platform context ${msg.context} not registered with this sockethub instance.`);
-        }
-        else if ((type === 'message') && (typeof msg['@type'] !== 'string')) {
-            error('message must contain a @type property.');
-        }
-        else if (type === 'credentials') {
-            processCredentials(msg, error, next);
-        }
-        else {
-            processActivityStream(msg, error, next);
-        }
-    };
-}
-exports.default = validate;
-;
-//# sourceMappingURL=validate.js.map

package/dist/validate.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate.js","sourceRoot":"","sources":["../src/validate.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA;;GAEG;AACH,8CAAsB;AACtB,kDAA0B;AAC1B,kDAAwB;AACxB,wEAA+C;AAC/C,oEAAsD;AAEtD,4DAAoC;AACpC,sDAA8B;AAE9B,MAAM,QAAQ,GAAG,0BAAe,CAAC,gBAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC;AAEtE,iEAAiE;AACjE,mDAAmD;AACnD,aAAG,CAAC,SAAS,CAAC,gBAAgB,CAAC,cAAc,CAAC,EAAE,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;AACnF,iEAAiE;AACjE,mDAAmD;AACnD,aAAG,CAAC,SAAS,CAAC,gBAAgB,CAAC,cAAc,CAAC,EAAE,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;AAEnF,iEAAiE;AACjE,kGAAkG;AAClG,SAAS,iBAAiB,CAAC,GAAQ;IACjC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAE,GAAG,CAAC,WAAW,CAAC,EAAE;QACvC,MAAM,GAAG,GAAG,IAAI,eAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;QAChC,OAAO,GAAG,CAAC,QAAQ,EAAE,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;KAC5D;IACD,OAAO,GAAG,CAAC,WAAW,CAAC;AACzB,CAAC;AAED,SAAS,YAAY,CAAC,GAAQ;IAC5B,OAAO,CAAC,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,YAAY,CAAC,IAAS,EAAE,GAAQ,EAAE,IAAS;IAClD,OAAO,CAAC,GAAG,EAAE,EAAE;QACb,OAAO,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACrC,CAAC,CAAC;AACJ,CAAC;AAED,4DAA4D;AAC5D,qDAAqD;AACrD,SAAS,UAAU,CAAC,QAAQ,EAAE,IAAI;IAChC,OAAO,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7E,CAAC;AAED,SAAS,YAAY,CAAC,GAAG;IACvB,GAAG,CAAC,KAAK,CAAC,WAAW,GAAG,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACrD,IAAI,GAAG,CAAC,MAAM,EAAE;QACd,GAAG,CAAC,MAAM,CAAC,WAAW,GAAG,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;KACxD;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,cAAc,CAAC,GAAQ;IAC9B,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;IAC5B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;AACzC,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAQ,EAAE,KAAU,EAAE,IAAS;IAC5D,IAAI,CAAE,sBAAsB,CAAC,GAAG,CAAC,EAAE;QACjC,OAAO,KAAK,CACV,6CAA6C,aAAG,CAAC,KAAK,CAAC,QAAQ,MAAM,aAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CACzF,CAAC;KACH;IACD,GAAG,CAAC,WAAW,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACzC,OAAO,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,4DAA4D;AACtF,CAAC;AAED,SAAS,qBAAqB,CAAC,GAAQ,EAAE,KAAU,EAAE,IAAS;IAC5D,IAAI,MAAM,CAAC;IACX,IAAI,EAAE,sEAAsE;QAC1E,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;KAC/B;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;KACjB;IACD,GAAG,GAAG,MAAM,CAAC,CAAC,mDAAmD;IAEjE,IAAI,CAAE,sBAAsB,CAAC,GAAG,CAAC,EAAE;QACjC,OAAO,KAAK,CACV,4CAA4C,aAAG,CAAC,KAAK,CAAC,QAAQ,KAAK,aAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;KAC3F;IACD,4DAA4D;IAC5D,OAAO,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAQ,EAAE,KAAU,EAAE,IAAS;IACzD,GAAG,CAAC,KAAK,GAAG,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IAC3C,GAAG,CAAC,MAAM,GAAG,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9C,IAAI,iBAAiB,GAAG,aAAG,CAAC,SAAS,CACnC,2CAA2C,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC;IACxE,IAAI,CAAE,iBAAiB,EAAE;QACvB,OAAO,KAAK,CAAC,mCAAmC,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC;KACxE;IAED,IAAI,CAAE,mBAAmB,CAAC,GAAG,EAAE,iBAAiB,CAAC,EAAE;QACjD,OAAO,KAAK,CACV,yCAAyC,aAAG,CAAC,KAAK,CAAC,QAAQ,MAAM,aAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;KACzF;IACD,4DAA4D;IAC5D,OAAO,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,SAAS,sBAAsB,CAAC,GAAQ;IACtC,OAAO,aAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;AACxE,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAQ,EAAE,MAAW;IAChD,OAAO,aAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,sBAAsB,CAAC,GAAQ;IACtC,6EAA6E;IAC7E,gDAAgD;IAChD,IAAI,CAAE,aAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,gBAAgB,CAAC,cAAc,CAAC,EAAE;QACxD,OAAO,aAAG,CAAC,SAAS,CAAC,2CAA2C,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC;KACzF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,qFAAqF;AACrF,2DAA2D;AAC3D,SAAwB,QAAQ,CAAC,IAAY,EAAE,WAAmB;IAChE,MAAM,UAAU,GAAG,eAAK,CAAC,sBAAsB,WAAW,EAAE,CAAC,CAAC;IAC9D,iFAAiF;IACjF,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QACnB,UAAU,CAAC,iCAAiC,GAAG,IAAI,CAAC,CAAC;QACrD,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAE5C,IAAI,CAAE,YAAY,CAAC,GAAG,CAAC,EAAE;YACvB,KAAK,CAAC,oCAAoC,CAAC,CAAC;SAC7C;aAAM,IAAI,IAAI,KAAK,iBAAiB,EAAE;YACrC,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;SACzC;aAAM,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ,EAAE;YAC1C,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAClD;aAAM,IAAI,CAAE,cAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YAC5C,KAAK,CAAC,oBAAoB,GAAG,CAAC,OAAO,+CAA+C,CAAC,CAAC;SACvF;aAAM,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAAE;YACrE,KAAK,CAAC,wCAAwC,CAAC,CAAC;SACjD;aAAM,IAAI,IAAI,KAAK,aAAa,EAAE;YACjC,kBAAkB,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;SACtC;aAAM;YACL,qBAAqB,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;SACzC;IACH,CAAC,CAAC;AACJ,CAAC;AAvBD,2BAuBC;AAAA,CAAC"}

package/jest.config.js

@@ -1,18 +0,0 @@
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  coverageThreshold: {
-    global: {
-      branches: 75,
-      functions: 80,
-      lines: 90,
-      statements: 90,
-    },
-  },
-  coverageReporters: [
-    'json',
-    'lcov',
-    'text',
-    'clover',
-  ]
-};

package/src/js/client.js

@@ -1,190 +0,0 @@
-(function (global, factory) {
-
-  if ( typeof module === 'object' && typeof module.exports === 'object' ) {
-    let ASFactory = require('activity-streams');
-    module.exports = (global.document) ? factory(global, ASFactory) : factory({}, ASFactory);
-  } else {
-    // @ts-ignore
-    if (! global.ASFactory) {
-      throw new Error('sockethub-client.js depends on the activity-streams module.');
-    }
-    // @ts-ignore
-    factory(global, global.ASFactory);
-  }
-
-}((typeof window !== 'undefined') ? window : this, function (scope, ASFactory) {
-
-  function SockethubClient(socket) {
-    this.socket = socket;
-    this.ActivityStreams = ASFactory({specialObjs: ['credentials']});
-    this.online = false;
-    this.debug = false;
-
-    this.__registerSocketIOHandlers();
-
-    this.ActivityStreams.on('activity-object-create', (obj) => {
-      socket.emit('activity-object', obj);
-    });
-
-    socket.on('activity-object', (obj) => {
-      this.ActivityStreams.Object.create(obj);
-    });
-  }
-
-  SockethubClient.prototype.log = function (msg, obj) {
-    if (this.debug) {
-      console.log(msg, obj);
-    }
-  };
-
-  SockethubClient.prototype.__handlers = {
-    // wrapping the `on` method in order to automatically unpack Activity Streams objects
-    // that come in on the 'messages' channel, so that app developers don't need to.
-    message: function (msg) {
-      console.warn(`message event received with no handler registered: `, msg);
-    },
-    completed: function (msg) {
-      console.warn('completed event received with no handler registered: ', msg);
-    },
-    failed: function (msg) {
-      console.warn('failed event received with no handler registered: ', msg);
-    },
-    reconnecting: function (msg) {
-      console.warn('reconnecting: ', msg);
-    },
-    reconnect_failed: function (msg) {
-      console.warn('reconnect failed: ', msg);
-    },
-    connect: function () {
-      console.warn('connected.');
-    },
-    reconnect: function (msg) {
-      console.warn('reconnected: ', msg);
-    },
-    disconnect: function (msg) {
-      console.warn('disconnected: ', msg);
-    }
-  };
-
-  SockethubClient.prototype.__registerSocketIOHandlers = function () {
-    let storedCredentials     = new Map(),
-        storedActivityObjects = new Map(),
-        storedConnects        = new Map(),
-        storedJoins           = new Map();
-
-    // middleware for events which don't deal in AS objects
-    const callHandler = (event) => {
-      return (obj) => {
-        if (event === 'reconnect') {
-          this.online = true;
-          this.__replay('activity-object', storedActivityObjects);
-          this.__replay('credentials', storedCredentials);
-          this.__replay('message', storedConnects);
-          this.__replay('message', storedJoins);
-        } else if (event === 'connect') {
-          this.online = true;
-        } else if (event === 'disconnect') {
-          this.online = false;
-        }
-        this.__handlers[event](obj);
-      };
-    };
-
-    // register for events that give us information on connection status
-    this.socket.on('reconnecting', callHandler('reconnecting'));
-    this.socket.on('reconnect_failed', callHandler('reconnect_failed'));
-    this.socket.on('connect', callHandler('connect'));
-    this.socket.on('reconnect', callHandler('reconnect'));
-    this.socket.on('disconnect', callHandler('disconnect'));
-
-    // do our middle-ware stuff then call the stored handler
-    this.socket.on('message', this.__unpackAndCallHandler('message'));
-    this.socket.on('completed', this.__unpackAndCallHandler('completed'));
-    this.socket.on('failed', this.__unpackAndCallHandler('failed'));
-
-    // we over-ride socketIO's emit method in order to catch credentials, activity-objects,
-    // and joins, and store them for replay if we connect.
-    // joins are only stored until confirmation is received that it was sent, then we remove it
-    // from the map.
-    this.socket._emit = this.socket.emit;
-    this.socket.emit = (channel, content) => {
-      if (typeof channel !== 'string') {
-        throw new Error('emit function requires a channel name [string] to be specified as the'
-          + ' first parameter.');
-      }
-      switch (channel) {
-        case 'credentials':
-          if ((content.object) && (content.object['@type'] === 'credentials')) {
-            storedCredentials.set(content.actor['@id'] || content.actor, content);
-          }
-          break;
-        case 'activity-object':
-          if (content['@id']) {
-            storedActivityObjects.set(content['@id'], content);
-          }
-          break;
-        case 'message':
-          if (this.online) {
-            // either store or delete the specified content onto the storedJoins map,
-            // for reply once we're back online.
-            if (content['@type'] === 'join') {
-              storedJoins['set'](this.__getKey(content), content);
-            } else if (content['@type'] === 'leave') {
-              storedJoins['delete'](this.__getKey(content), content);
-            } if (content['@type'] === 'connect') {
-              storedConnects['set'](this.__getKey(content), content);
-            } else if (content['@type'] === 'disconnect') {
-              storedConnects['delete'](this.__getKey(content), content);
-            }
-          } else {
-            // reject message if we're not online
-            this.socket._emit('failed', content);
-          }
-          break;
-      }
-      this.socket._emit(channel, content);
-    };
-
-    this.socket._on = this.socket.on;
-    this.socket.on = (event, cb) => {
-      if (Object.keys(this.__handlers).includes(event)) {
-        // store the desired message channel callback, because we use our own first
-        this.__handlers[event] = cb;
-      } else {
-        // pass on any other handlers
-        this.socket._on(event, cb);
-      }
-    };
-  };
-
-  SockethubClient.prototype.__replay = function (name, asMap) {
-    asMap.forEach((obj) => {
-      this.log(`replaying ${name}`, obj);
-      this.socket._emit(name, obj);
-    });
-  };
-
-  // use as a middleware to receive incoming Sockethub messages and unpack them
-  // using the ActivityStreams library before passing them along to the app.
-  SockethubClient.prototype.__unpackAndCallHandler = function (event) {
-    return (obj) => {
-      let unpackedObject = this.ActivityStreams.Stream(obj);
-      this.__handlers[event](unpackedObject);
-    };
-  };
-
-  SockethubClient.prototype.__getKey = function (content) {
-    let actor = content.actor['@id'] || content.actor;
-    let target = content.target ? content.target['@id'] || content.target : '';
-    return actor + '-' + target;
-  };
-
-  if ( typeof define === 'function' && define.amd ) {
-    define([], function () {
-      return SockethubClient;
-    });
-  }
-
-  scope.SockethubClient = SockethubClient;
-  return SockethubClient;
-}));

package/src/validate.ts

@@ -1,147 +0,0 @@
-/**
- * responsible for handling the validation and expansion (when applicable) of all incoming objects
- */
-import tv4 from 'tv4';
-import debug from 'debug';
-import URI from 'urijs';
-import ActivityStreams from 'activity-streams';
-import * as SockethubSchemas from 'sockethub-schemas';
-
-import init from './bootstrap/init';
-import config from './config';
-
-const activity = ActivityStreams(config.get('activity-streams:opts'));
-
-// load sockethub-activity-stream schema and register it with tv4
-// http://sockethub.org/schemas/v0/activity-stream#
-tv4.addSchema(SockethubSchemas.ActivityStream.id, SockethubSchemas.ActivityStream);
-// load sockethub-activity-object schema and register it with tv4
-// http://sockethub.org/schemas/v0/activity-object#
-tv4.addSchema(SockethubSchemas.ActivityObject.id, SockethubSchemas.ActivityObject);
-
-// educated guess on what the displayName is, if it's not defined
-// since we know the @id is a URI, we prioritize by username, then fragment (no case yet for path)
-function ensureDisplayName(msg: any) {
-  if ((msg['@id']) && (! msg.displayName)) {
-    const uri = new URI(msg['@id']);
-    return uri.username() || getUriFragment(uri) || uri.path();
-  }
-  return msg.displayName;
-}
-
-function ensureObject(msg: any) {
-  return !((typeof msg !== 'object') || (Array.isArray(msg)));
-}
-
-function errorHandler(type: any, msg: any, next: any) {
-  return (err) => {
-    return next(false, err, type, msg);
-  };
-}
-
-// expand given prop to full object if they are just strings
-// FIXME are we sure this works? What's propName for?
-function expandProp(propName, prop) {
-  return (typeof prop === 'string') ? activity.Object.get(prop, true) : prop;
-}
-
-function expandStream(msg) {
-  msg.actor.displayName = ensureDisplayName(msg.actor);
-  if (msg.target) {
-    msg.target.displayName = ensureDisplayName(msg.target);
-  }
-  return msg;
-}
-
-function getUriFragment(uri: any) {
-  const frag = uri.fragment();
-  return (frag) ? '#' + frag : undefined;
-}
-
-function processActivityObject(msg: any, error: any, next: any) {
-  if (! validateActivityObject(msg)) {
-    return error(
-      `activity-object schema validation failed: ${tv4.error.dataPath} = ${tv4.error.message}`
-    );
-  }
-  msg.displayName = ensureDisplayName(msg);
-  return next(true, msg); // passed validation, on to next handler in middleware chain
-}
-
-function processActivityStream(msg: any, error: any, next: any) {
-  let stream;
-  try { // expands the AS object to a full object with the expected properties
-    stream = activity.Stream(msg);
-  } catch (e) {
-    return error(e);
-  }
-  msg = stream; // overwrite message with expanded as object stream
-
-  if (! validateActivityStream(msg)) {
-    return error(
-      `actvity-stream schema validation failed: ${tv4.error.dataPath}: ${tv4.error.message}`);
-  }
-  // passed validation, on to next handler in middleware chain
-  return next(true, expandStream(msg));
-}
-
-function processCredentials(msg: any, error: any, next: any) {
-  msg.actor = expandProp('actor', msg.actor);
-  msg.target = expandProp('target', msg.target);
-  let credentialsSchema = tv4.getSchema(
-    `http://sockethub.org/schemas/v0/context/${msg.context}/credentials`);
-  if (! credentialsSchema) {
-    return error(`no credentials schema found for ${msg.context} context`);
-  }
-
-  if (! validateCredentials(msg, credentialsSchema)) {
-    return error(
-      `credentials schema validation failed: ${tv4.error.dataPath} = ${tv4.error.message}`);
-  }
-  // passed validation, on to next handler in middleware chain
-  return next(true, expandStream(msg));
-}
-
-function validateActivityObject(msg: any) {
-  return tv4.validate({ object: msg }, SockethubSchemas.ActivityObject);
-}
-
-function validateCredentials(msg: any, schema: any) {
-  return tv4.validate(msg, schema);
-}
-
-function validateActivityStream(msg: any) {
-  // TODO figure out a way to allow for special objects from platforms, without
-  // ignoring failed activity stream schema checks
-  if (! tv4.validate(msg, SockethubSchemas.ActivityStream)) {
-    return tv4.getSchema(`http://sockethub.org/schemas/v0/context/${msg.context}/messages`);
-  }
-  return true;
-}
-
-// 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}`);
-  // called by the middleware with the message and the next (callback) in the chain
-  return (next, msg) => {
-    sessionLog('applying schema validation for ' + type);
-    const error = errorHandler(type, msg, next);
-
-    if (! ensureObject(msg)) {
-      error(`message received is not an object.`);
-    } else if (type === 'activity-object') {
-      processActivityObject(msg, error, next);
-    } else if (typeof msg.context !== 'string') {
-      error('message must contain a context property');
-    } else if (! init.platforms.has(msg.context)) {
-      error(`platform context ${msg.context} not registered with this sockethub instance.`);
-    } else if ((type === 'message') && (typeof msg['@type'] !== 'string')) {
-      error('message must contain a @type property.');
-    } else if (type === 'credentials') {
-      processCredentials(msg, error, next);
-    } else {
-      processActivityStream(msg, error, next);
-    }
-  };
-};

package/test/middleware-suite.js

@@ -1,101 +0,0 @@
-if (typeof define !== 'function') {
-  let define = require('amdefine')(module);
-}
-define(['require', '../dist/middleware'], function (require, Middleware) {
-  return [
-    {
-      desc: 'src/middleware',
-      abortOnFail: true,
-      beforeEach: function (env, test) {
-        env.middleware = new Middleware.default((...params) => {
-          this.fail(params);
-        });
-        test.done();
-      },
-      tests: [
-        {
-          desc: 'basic 1 input param',
-          run: function (env, test) {
-            test.assertType(env.middleware.chain, 'function');
-            const m = env.middleware.chain((next, input) => {
-              next(true, input);
-            }, (input) => {
-              test.assert(input, 'alacadabra');
-            });
-            m('alacadabra');
-          }
-        },
-
-        {
-          desc: 'basic 1 input param with error',
-          run: function (env, test) {
-            const middleware = new Middleware.default((err, input) => {
-              test.assertAnd(err, 'incorrect input');
-              test.assert(input, 'foobar');
-            });
-            const m = middleware.chain((next, input) => {
-              next(false, 'incorrect input', input);
-            }, (input) => {
-              test.fail('should not reach final function in chain');
-            });
-            m('foobar');
-          }
-        },
-
-        {
-          desc: 'basic 1 input param, 5 funcs',
-          run: function (env, test) {
-
-            const m = env.middleware.chain((next, input) => {
-              next(true, ++input);
-            }, (next, input) => {
-              next(true, ++input);
-            }, (next, input) => {
-              next(true, ++input);
-            }, (next, input) => {
-              next(true, ++input);
-            }, (input) => {
-              test.assert(input, 4);
-            });
-            m(0);
-          }
-        },
-
-        {
-          desc: 'basic 2 inputs param, 2 funcs',
-          run: function (env, test) {
-            const cb = function () {
-              test.done();
-            };
-            const m = env.middleware.chain((next, input, cb) => {
-              next(true, ++input, cb);
-            }, (input, cb) => {
-              test.assertAnd(input, 1);
-              cb();
-            });
-            m(0, cb);
-          }
-        },
-
-        {
-          desc: 'basic 4 input params, 5 funcs',
-          run: function (env, test) {
-
-            const m = env.middleware.chain((next, input1, input2, input3, input4) => {
-              next(true, ++input1, input2, input3, input4);
-            }, (next, input1, input2, input3, input4) => {
-              next(true, input1, ++input2, input3, input4);
-            }, (next, input1, input2, input3, input4) => {
-              next(true, input1, input2, ++input3, input4);
-            }, (next, input1, input2, input3, input4) => {
-              next(true, input1, input2, input3, ++input4);
-            }, (input1, input2, input3, input4) => {
-              test.assert([input1, input2, input3, input4], [1, 1, 4, 6]);
-            });
-            m(0, 0, 2, 5);
-          }
-        }
-      ]
-    }
-  ];
-});