fix: fixed tests and onLimited functionality (per #69)

Author: titanism

README.md

@@ -56,6 +56,9 @@ app.use(ratelimit({
   },
   blacklist: (ctx) => {
     // some logic that returns a boolean
+  },
+  onLimited: (ctx) => {
+    // optional function to run when a user is rate limited
   }
 }));
 

index.js

@@ -46,7 +46,7 @@ module.exports = function ratelimit(opts = {}) {
       reset: 'X-RateLimit-Reset',
       total: 'X-RateLimit-Limit'
     },
-    onLimit: undefined
+    onLimited: undefined
   };
 
   opts = { ...defaultOpts, ...opts };
@@ -64,7 +64,6 @@ module.exports = function ratelimit(opts = {}) {
       typeof opts.whitelist === 'function' && (await opts.whitelist(ctx));
     const blacklisted =
       typeof opts.blacklist === 'function' && (await opts.blacklist(ctx));
-    const { onLimited } = opts;
 
     if (blacklisted) {
       ctx.throw(403, 'Forbidden');
@@ -119,7 +118,7 @@ module.exports = function ratelimit(opts = {}) {
     ctx.state.rateLimit = { after, headers, id, message };
     ctx.status = opts.status || 429;
 
-    if (onLimited) onLimited(ctx);
+    if (opts.onLimited) opts.onLimited(ctx);
 
     if (opts.throw) {
       headers['Retry-After'] = after;

test/memory.spec.js

@@ -408,8 +408,8 @@ describe('ratelimit middleware with memory driver', () => {
     });
   });
 
-  describe('onLimit', async () => {
-    it('should allow specifying an onLimit callback', async () => {
+  describe('onLimited', async () => {
+    it('should allow specifying an onLimited callback', async () => {
       const app = new Koa();
       let testValue = 0;
 
@@ -418,7 +418,7 @@ describe('ratelimit middleware with memory driver', () => {
           driver: 'memory',
           db,
           max: 0,
-          onLimit(ctx) {
+          onLimited(ctx) {
             testValue = 1;
           }
         })
@@ -427,7 +427,8 @@ describe('ratelimit middleware with memory driver', () => {
       await request(app.listen())
         .get('/')
         .set('foo', 'bar')
-        .expect(testValue, 1);
+        .expect(429)
+        .expect(() => testValue.should.equal(1));
     });
   });
 });