Initial commit

Author: evanhuang8

index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/toureiro.js');

lib/models/job.js

@@ -0,0 +1,79 @@
+var _ = require('lodash');
+var client = require('../redis');
+var queue = require('./queue');
+
+module.exports = {
+
+  /**
+   * Get a job by id
+   * @param {string} qName Queue name
+   * @param {string} id Job id
+   */
+  get: function(qName, id) {
+    var q = queue.get(qName);
+    return q.getJob(id);
+  },
+
+  /**
+   * Remove a job by id
+   * @param {string} qName Queue name
+   * @param {string} id Job id
+   */
+  remove: function(qName, id) {
+    var q = queue.get(qName);
+    return q.getJob(id).then(function(job) {
+      return job.remove();
+    });
+  },
+
+  /**
+   * Get the total number of jobs of type
+   * @param {string} qName Queue name
+   * @param {string} type Job type: {wait|active|delayed|completed|failed}
+   * @returns {number} Total number of jobs
+   */
+  total: function(qName, type) {
+    var key = 'bull:' + qName + ':' + type;
+    if (type === 'wait' || type === 'active') {
+      return client.llenAsync(key);
+    } else if (type === 'delayed') {
+      return client.zcardAsync(key);
+    } else if (type === 'completed' || type === 'failed') {
+      return client.scardAsync(key);
+    }
+    throw new Error('You must provide a valid job type.');
+  },
+
+  /**
+   * Fetch a number of jobs of certain type
+   * @param {string} qName Queue name
+   * @param {string} type Job type: {wait|active|delayed|completed|failed}
+   * @param {number} offset Index offset (optional)
+   * @param {number} limit Limit of the number of jobs returned (optional)
+   * @returns {Promise} A promise that resolves to an array of jobs
+   */
+  fetch: function(qName, type, offset, limit) {
+    var q = queue.get(qName);
+    if (!(offset >= 0)) {
+      offset = 0;
+    }
+    if (!(limit >= 0)) {
+      limit = 30;
+    }
+    if (type === 'wait' || type === 'active') {
+      return q.getJobs(type, 'LIST', offset, offset + limit - 1);
+    } else if (type === 'delayed') {
+      return q.getJobs(type, 'ZSET', offset, offset + limit - 1);
+    } else if (type === 'completed' || type === 'failed') {
+      var key = 'bull:' + qName + ':' + type;
+      return client.smembersAsync(key).then(function(ids) {
+        var _ids = ids.slice(offset, offset + limit);
+        return Promise.all(_.map(_ids, function(id) {
+          return q.getJob(id);
+        }));
+      });
+    }
+    throw new Error('You must provide a valid job type.');
+  }
+
+};

lib/models/queue.js

@@ -0,0 +1,67 @@
+var _ = require('lodash');
+var bull = require('bull');
+var client = require('../redis');
+
+module.exports = {
+
+  /**
+   * Internal Queue instance
+   * since each queue creates separate connections to redis, 
+   * we want to store an instance of the client here for reuse
+   */
+  _q: {
+    name: undefined,
+    instance: undefined
+  },
+
+  /**
+   * List all queues
+   * @returns {Promise} A promise that resolves to the keys of all queues
+   */
+  list: function() {
+    return client.keysAsync('bull:*:id').then(function(keys) {
+      return _.map(keys, function(key) {
+        return key.slice(5, -3);
+      });
+    });
+  },
+
+  /**
+   * Get total number of jobs
+   * @param {string} qName Queue name
+   * @returns {Promise} A promise that resovles to the total number of jobs
+   */
+  total: function(qName) {
+    return client.getAsync('bull:' + qName + ':id')
+  },
+
+  /**
+   * Delete all data of a queue
+   * @param {string} qName Queue name
+   * @returns {Promise} A promise when all data of the queue is deleted 
+   */
+  remove: function(qName) {
+    if (!qName || qName.length === 0) {
+      throw new Error('You must specify a queue name.');
+    }
+    return client.keysAsync('bull:' + qName + ':*').then(function(keys) {
+      if (keys.length) {
+        return client.del(keys);
+      }
+    });
+  },
+
+  /**
+   * Get a queue by name
+   * @param {string} qName Queue name
+   * @returns {Object} An instance of the queue
+   */
+  get: function(qName) {
+    if (this._q.name !== qName) {
+      this._q.name = qName;
+      this._q.instance = new bull(qName);
+    }
+    return this._q.instance;
+  }
+
+};

lib/redis.js

@@ -0,0 +1,6 @@
+var Promise = require('bluebird');
+var redis = require('redis');
+
+var client = redis.createClient();
+
+module.exports = Promise.promisifyAll(client);

lib/toureiro.js

@@ -0,0 +1 @@
+var express = require('express');

package.json

@@ -0,0 +1,37 @@
+{
+  "name": "toureiro",
+  "version": "0.1.0",
+  "description": "A graphic interface for bull.",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha tests/test_*"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/evanhuang8/Toureiro.git"
+  },
+  "keywords": [
+    "bull",
+    "distributed",
+    "queue",
+    "ui"
+  ],
+  "author": "Evan Huang <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/evanhuang8/Toureiro/issues"
+  },
+  "homepage": "https://github.com/evanhuang8/Toureiro#readme",
+  "dependencies": {
+    "bluebird": "2.10.x",
+    "bull": "0.6.x",
+    "express": "4.13.x",
+    "lodash": "3.10.x",
+    "redis": "2.1.x"
+  },
+  "devDependencies": {
+    "chai": "3.3.x",
+    "mocha": "2.3.x",
+    "node-uuid": "1.4.x"
+  }
+}