@sockethub/platform-irc 4.0.0-alpha.3

package/index.test.data.js

@@ -0,0 +1,61 @@
+modules.exports = [
+  {
+    "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"
+  },
+]

package/index.test.js

@@ -0,0 +1,204 @@
+const proxyquire = require('proxyquire');
+const chai = require('chai');
+const schemas = require('@sockethub/schemas').default;
+const expect = chai.expect;
+
+const IRCPlatform = require('./index');
+
+proxyquire.noPreserveCache();
+proxyquire.noCallThru();
+
+const actor = {
+  type: 'person',
+  id: 'testingham@irc.example.com',
+  name:'testingham'
+};
+
+const newActor = {
+  type: 'person',
+  id: 'testler@irc.example.com',
+  name:'testler'
+};
+
+const targetRoom = {
+  type: 'room',
+  id: 'irc.example.com/a-room',
+  name: '#a-room'
+};
+
+const validCredentials = {
+  context: 'irc',
+  type: 'credentials',
+  actor: actor,
+  object: {
+    type: 'credentials',
+    nick: 'testingham',
+    server: 'irc.example.com'
+  }
+};
+
+let loadedSchema = false;
+
+describe('Initialize IRC Platform', () => {
+  let platform;
+  beforeEach(() => {
+    platform = new IRCPlatform({
+      debug: function () {},
+      updateActor: function (obj) {}
+    });
+    platform.__connect = function (key, credentials, cb) {
+      cb(null, {
+        end: () => {},
+        on: function () {},
+        raw: () => {}
+      });
+    };
+    if (!loadedSchema) {
+      schemas.addPlatformSchema(platform.schema.credentials, `irc/credentials`);
+      loadedSchema = true;
+    }
+  });
+
+  it('lists required types enum', () => {
+    expect(platform.schema.messages.properties.type.enum).to.eql([
+      'connect', 'update', 'join', 'leave', 'send', 'query', 'announce'
+    ]);
+  });
+
+  it('returns a config object', () => {
+    expect(platform.config).to.eql({
+      persist: true,
+      requireCredentials: ['connect', 'update'],
+      initialized: false
+    });
+  });
+
+  it('schema format validation', () => {
+    expect(schemas.validatePlatformSchema(platform.schema)).to.equal("");
+  });
+
+  describe('credential schema', () => {
+    it('valid credentials', () => {
+      expect(schemas.validateCredentials(validCredentials)).to.equal("");
+    });
+
+    it('invalid credentials type', () => {
+      expect(schemas.validateCredentials({
+        context: 'irc',
+        type: 'credentials',
+        object: {
+          host: 'example.com',
+          port: '6667'
+        }})).to.equal("/object: must have required property 'type'");
+    });
+
+    it('invalid credentials port', () => {
+      expect(schemas.validateCredentials({
+        context: 'irc',
+        type: 'credentials',
+        object: {
+          type: 'credentials',
+          host: 'example.com',
+          port: '6667'
+        }})).to.equal("/object/port: must be number");
+    });
+
+    it('invalid credentials additional prop', () => {
+      expect(schemas.validateCredentials({
+        context: 'irc',
+        type: 'credentials',
+        object: {
+          type: 'credentials',
+          host: 'example.com',
+          port: 6667
+        }})).to.equal("/object: must NOT have additional properties");
+    });
+  });
+
+  describe('platform type methods', () => {
+    beforeEach((done) => {
+      platform.connect({
+        context: 'irc',
+        type: 'connect',
+        actor: actor
+      }, { object: { server: 'a server address' } }, done);
+    });
+
+    describe('after join', () => {
+      beforeEach((done) => {
+        platform.join({
+          context: 'irc',
+          type: 'join',
+          actor: actor,
+          target: targetRoom
+        }, done);
+        platform.__completeJob();
+      });
+
+      it('has join channel registered', () => {
+        expect(platform.__channels.has('#a-room')).to.equal(true);
+      });
+
+      it('leave()', (done) => {
+        platform.leave({
+          context: 'irc',
+          type: 'leave',
+          actor: actor,
+          target: targetRoom
+        }, done);
+        platform.__completeJob();
+      });
+
+      it('send()', (done) => {
+        platform.send({
+          context: 'irc',
+          type: 'send',
+          actor: actor,
+          object: { content: 'har dee dar' },
+          target: targetRoom
+        }, done);
+        platform.__completeJob();
+      });
+
+      it('update() topic', (done) => {
+        platform.update({
+          context: 'irc',
+          type: 'update',
+          actor: actor,
+          object: { type: 'topic', content: 'important details' },
+          target: targetRoom
+        }, validCredentials, done);
+        platform.__completeJob();
+      });
+
+      it('update() nick change', (done) => {
+        platform.update({
+          context: 'irc',
+          type: 'update',
+          actor: actor,
+          object: { type: 'address' },
+          target: newActor
+        }, validCredentials, done);
+        platform.__completeJob();
+      });
+
+      it('query()', (done) => {
+        platform.query({
+          context: 'irc',
+          type: 'query',
+          actor: actor,
+          target: targetRoom,
+          object: { type: 'attendance' },
+        }, done);
+        platform.__completeJob();
+      });
+
+      it('cleanup()', (done) => {
+        platform.cleanup(() => {
+          expect(platform.initialized).to.eql(false);
+          done();
+        });
+      });
+    });
+  });
+});

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@sockethub/platform-irc",
+  "description": "A sockethub platform module implementing IRC functionality",
+  "version": "4.0.0-alpha.3",
+  "private": false,
+  "author": "Nick Jennings <nick@silverbucket.net>",
+  "license": "LGPL-3.0+",
+  "main": "index.js",
+  "keywords": [
+    "sockethub",
+    "messaging",
+    "activitystreams",
+    "activity",
+    "streams",
+    "protocol",
+    "irc"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sockethub/sockethub.git",
+    "directory": "packages/platform-irc"
+  },
+  "homepage": "https://github.com/sockethub/sockethub/tree/master/packages/platform-irc",
+  "dependencies": {
+    "@sockethub/irc2as": "^4.0.0-alpha.3",
+    "irc-socket-sasl": "4.0.0"
+  },
+  "devDependencies": {
+    "@sockethub/schemas": "^3.0.0-alpha.3",
+    "c8": "7.11.0",
+    "chai": "4.3.6",
+    "eslint": "8.9.0",
+    "jsdoc-to-markdown": "7.1.1",
+    "proxyquire": "2.1.3",
+    "sinon": "13.0.1"
+  },
+  "peerDependencies": {
+    "@sockethub/server": ">=5.0.0-alpha.2"
+  },
+  "peerDependenciesMeta": {
+    "@sockethub/server": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "true",
+    "clean": "npx rimraf coverage",
+    "clean:deps": "npx rimraf coverage node_modules",
+    "compliance": "yarn run lint && yarn run test && yarn run coverage",
+    "test": "c8 mocha *.test.js",
+    "coverage": "c8 check-coverage --statements 80 --branches 55 --functions 85 --lines 80",
+    "doc": "jsdoc2md --no-gfm --heading-depth 1 index.js  > API.md",
+    "lint": "eslint \"**/*.js\"",
+    "lint:fix": "eslint --fix \"**/*.js\""
+  },
+  "gitHead": "f02238a478b7ffd3f31d8deea292eb67e630a86b"
+}