Added Rate Limit API

AurelioDeRosa · AurelioDeRosa · commit 045d8b7dfe2d · 2016-02-20T12:59:17.000Z
diff --git a/README.md b/README.md
@@ -426,6 +426,17 @@ search.users(options, function (err, users) {});
 
 Here, we’re looking at users with the name Tom. We’re only interested in those with more than 42 repositories, and only if they have over 1,000 followers.
 
+## Rate Limit API
+
+```js
+var rateLimit = github.getRateLimit();
+```
+
+Get the rate limit.
+
+```js
+rateLimit.getRateLimit(function (err, rateInfo) {});
+```
 
 ## Change Log
 
diff --git a/src/github.js b/src/github.js
@@ -990,6 +990,15 @@
          };
       };
 
+      // Rate Limit API
+      // ==========
+
+      Github.RateLimit = function() {
+         this.getRateLimit = function(cb) {
+            _request('GET', '/rate_limit', null, cb);
+         };
+      }
+
       return Github;
    };
 
@@ -1032,5 +1041,9 @@
       });
    };
 
+   Github.getRateLimit = function() {
+      return new Github.RateLimit();
+   };
+
    return Github;
 }));
diff --git a/test/test.rate-limit.js b/test/test.rate-limit.js
@@ -0,0 +1,30 @@
+'use strict';
+
+var Github = require('../src/github.js');
+var testUser = require('./user.json');
+var github, rateLimit;
+
+describe('Github.RateLimit', function() {
+   before(function() {
+      github = new Github({
+         username: testUser.USERNAME,
+         password: testUser.PASSWORD,
+         auth: 'basic'
+      });
+
+      rateLimit = github.getRateLimit();
+   });
+
+   it('should get rate limit', function(done) {
+      rateLimit.getRateLimit(function(err, rateInfo) {
+         should.not.exist(err);
+         rateInfo.should.be.an('object');
+         rateInfo.should.have.deep.property('rate.limit');
+         rateInfo.rate.limit.should.be.a('number');
+         rateInfo.should.have.deep.property('rate.remaining');
+         rateInfo.rate.remaining.should.be.a('number');
+         rateInfo.rate.remaining.should.be.at.most(rateInfo.rate.limit);
+         done();
+      });
+   });
+});
