Initial commit

Author: idchlife

Diff for: .eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "airbnb",
+  "rules": {
+    "comma-dangle": 0
+  }
+}

Diff for: .gitignore

@@ -0,0 +1,2 @@
+node_modules
+.idea

Diff for: README.md

@@ -0,0 +1 @@
+# node-telegram-bot-api-middleware

Diff for: bot-test.js

@@ -0,0 +1,5 @@
+const TelegramBot = require('node-telegram-bot-api');
+
+const bot = new TelegramBot('93111836:AAFAO-7dFnbDwuUnQENy-GXl7RgSCSp7etY', {
+  polling: true
+});

Diff for: index.js

@@ -0,0 +1,94 @@
+const co = require('co');
+
+/**
+ * Default context object to start with
+ *
+ * @type {{middlewares: Array}}
+ */
+const propertiesObject = {
+  middlewares: []
+};
+
+function defaultMiddleware(msg) {
+  this.msg = msg;
+  this.shouldStop = false;
+
+  this.stop = () => {
+    this.shouldStop = true;
+  };
+}
+
+const botCallback = function botCallback() {
+  const args = arguments;
+
+  // Check if there is msg.chat.id so caller is message to bot
+  if (!args.length) {
+    console.error(
+      '[node-telegram-bot-api-middleware]: No arguments passed ' +
+      'to a function used in bot event callback'
+    );
+    return;
+  }
+
+  if (typeof args[0].chat === 'undefined') {
+    console.error(
+      '[node-telegram-bot-api-middleware]: Chat id not ' +
+      'defined in arguments. Not executing middlewares'
+    );
+
+    return;
+  }
+
+  if (typeof args[0].chat.id === 'undefined') {
+    console.error(
+      '[node-telegram-bot-api-middleware]: There is no ' +
+      'visible chat id in chat in arguments. Not executing middlewares'
+    );
+    return;
+  }
+
+  const context = {
+    msg: args[0]
+  };
+
+  this.middlewares.unshift(defaultMiddleware);
+
+  return co(function* executeMiddlewares() {
+    for (let i = 0, size = this.middlewares.length; i < size; i++) {
+      if (context.shouldStop) {
+        return;
+      }
+
+      const middleware = co.wrap(this.middlewares[i]);
+
+      yield middleware.apply(context, args);
+    }
+  }.bind(this));
+};
+
+function copyContextWithConcatenation(oldContext) {
+  return {
+    middlewares: oldContext.middlewares.slice()
+  };
+}
+
+/**
+ * @param middleware
+ * @returns {function(this:{middlewares})}
+ */
+const use = function use(middleware) {
+  /**
+   * @type {Object} [middlewares]
+   */
+  const copy = copyContextWithConcatenation(this);
+
+  copy.middlewares.push(middleware);
+
+  const callback = botCallback.bind(copy);
+
+  callback.use = use.bind(copy);
+
+  return callback;
+}.bind(propertiesObject);
+
+exports.use = use;

Diff for: package.json

@@ -0,0 +1,25 @@
+{
+  "name": "node-telegram-bot-api-middleware",
+  "version": "0.1.0",
+  "description": "Package that helps using middleware with generators in node-telegram-bot-api",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "co-mocha": "^1.1.2",
+    "eslint": "^2.10.2",
+    "eslint-config-airbnb": "^9.0.1",
+    "eslint-plugin-import": "^1.8.0",
+    "eslint-plugin-jsx-a11y": "^1.2.0",
+    "eslint-plugin-react": "^5.1.1",
+    "mocha": "^2.4.5",
+    "node-telegram-bot-api": "^0.21.1"
+  },
+  "dependencies": {
+    "co": "^4.6.0"
+  }
+}

Diff for: tests.js

@@ -0,0 +1,71 @@
+const expect = require('chai').expect;
+const use = require('./index').use;
+require('co-mocha');
+
+const botArgumentsMock = {
+  chat: {
+    id: 1
+  }
+};
+
+describe('basic middleware usage', () => {
+  it('should return function', () => {
+    expect(use(() => {})).to.be.a('function');
+  });
+
+  const integratedValues = [];
+
+  it('should execute middlewares in proper order', function* () {
+    yield use(() => {
+      integratedValues.push('A');
+    }).use(() => {
+      integratedValues.push('B');
+    }).use(function* gen1() {
+      integratedValues.push('C');
+    }).use(function* gen2() {
+      integratedValues.push('D');
+    })(botArgumentsMock);
+
+    expect(integratedValues.join('')).to.equal('ABCD');
+  });
+
+  it('should have properties from default middleware', function* () {
+    let thereIsMsg = false;
+    yield use(function () {
+      thereIsMsg = typeof this.msg !== 'undefined';
+    })(botArgumentsMock);
+
+    expect(thereIsMsg).to.equal(true);
+  });
+
+  it('should have new middlewares and not have old used, when using use() from scratch', function* () {
+    yield use(() => {
+      integratedValues.push('E');
+    })(botArgumentsMock);
+
+    // If test result would be false - value would be ABCDABCDE
+    expect(integratedValues.join('')).to.equal('ABCDE');
+  });
+
+  it('should stop executing middleware when .stop() is used', function* () {
+    const values = [];
+
+    yield use(function() {
+      this.stop();
+    }).use(() => {
+      values.push('A');
+    })(botArgumentsMock);
+
+    expect(values).to.be.empty;
+
+    yield use(function() {
+      values.push('A');
+    }).use(function() {
+      this.stop();
+    }).use(function() {
+      values.push('B');
+    })(botArgumentsMock);
+
+    expect(values.join('')).to.equal('A');
+  });
+});