@withjoy/limiter 0.1.0 → 0.1.1

package/README.md

@@ -1,16 +1,37 @@
-### A wrapper for limitd-redis
+# limiter
 
-##### Why ?
+A wrapper for limitd-redis.
+
+
+## Why ?
 
 Provides utilities and rollback functionality for our clients.
 
-### Testing:
+This module was  originally built to work with `limitd`.
+The prior solution -- and most of the documentation surrounding our standard rate-limiting Buckets --
+can be found in [joylife/limitd](https://bitbucket.org/joylife/limitd/src/master/).
+That solution is now **deprecated**.
+
+
+## Buckets
+
+Each client must define the set of rate-limit Buckets that intends to use.
+
+The set of `defaultBuckets` defines the standard set of ones that we've historically determined that we need.
+[This list](https://github.com/joylifeinc/limiter/blob/4183c8ca0f5db7392846dc291e481dd307f985f7/limiter.js#L5-L16) may be old, but that's the general idea.
+Your client can use any subset of these Buckets, but when it does, the Best Practice is to use the exact definition(s) here.
+
+However, for flexibility reasons, this is not strictly enforced.
+
+
+## Testing:
 
 `npm run test` will run offline tests using a mock.
 `npm run sanity-check` will run against a limitd service configured to run with the test buckets.
 
+
 ## Quick Test
+
 ```bash
 node tests/performTestWithTestPerMinute.js
-
 ```

package/limiter.js

@@ -38,6 +38,9 @@ class Operation {
 let connection = null;
 
 class Limiter {
+	// static defaultBuckets;
+	// static pickDefaultBuckets(keys) { ... };
+
 	constructor(config) {
 		this._console = config.console;
 		this._config = config;
@@ -163,4 +166,19 @@ class Limiter {
 	}
 }
 
+// 'Class static' syntax in Node 10 is not mature
+//   and we don't want to upgrade Node at this point due to backwards compat
+Limiter.defaultBuckets = defaultBuckets;
+Limiter.pickDefaultBuckets = function pickDefaultBuckets(keyArray) {
+	const buckets = {};
+	for (const key of keyArray) {
+		const bucket = defaultBuckets[key];
+		if (! bucket) {
+			throw new Error(`Limiter.pickDefaultBuckets: no such bucket; "${key}"`);
+		}
+		buckets[key] = defaultBuckets[key];
+	}
+	return buckets;
+}
+
 module.exports = Limiter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@withjoy/limiter",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Api Rate limiter",
   "main": "limiter.js",
   "scripts": {