refactor(requestable): fix error handling to allow for either an axios response or an Error

* Add request/response fixture data for rate limit
* Add tests for exhausted rate limit
* Add status code and text to request error messages
* Check created milestone ID before other tests
* Fix ResponseError handling
* Improve successCallback error handling
* Add fixture data to replace live search API

Author: divergentdave

lib/Requestable.js

@@ -276,10 +276,16 @@ function getNextPage(linksHeader = '') {
 }
 
 function callbackErrorOrThrow(cb, path) {
-   return function handler(response) {
-      let message = `error making request ${response.config.method} ${response.config.url}`;
-      let error = new ResponseError(message, path, response);
-      log(`${message} ${JSON.stringify(response.data)}`);
+   return function handler(object) {
+      let error;
+      if (object.hasOwnProperty('config')) {
+         const {status, statusText, config: {method, url}} = object;
+         let message = (`${status} error making request ${method} ${url}: "${statusText}"`);
+         error = new ResponseError(message, path, object);
+         log(`${message} ${JSON.stringify(object.data)}`);
+      } else {
+         error = object;
+      }
       if (cb) {
          log('going to error callback');
          cb(error);

package.json

@@ -74,6 +74,7 @@
     "minami": "^1.1.1",
     "mocha": "^2.3.4",
     "must": "^0.13.1",
+    "nock": "^8.0.0",
     "vinyl-buffer": "^1.0.0",
     "vinyl-source-stream": "^1.1.0"
   },

test/error.spec.js

@@ -0,0 +1,83 @@
+import assert from 'assert';
+import expect from 'must';
+import nock from 'nock';
+
+import Github from '../lib/GitHub';
+import testUser from './fixtures/user.json';
+import {assertSuccessful, assertFailure} from './helpers/callbacks';
+import fixtureExhausted from './fixtures/repos-ratelimit-exhausted.js';
+import fixtureOk from './fixtures/repos-ratelimit-ok.js';
+
+describe('Rate limit error', function() {
+   let github;
+   let user;
+   let scope;
+
+   before(function() {
+      github = new Github();
+      user = github.getUser(testUser.USERNAME);
+   });
+
+   beforeEach(function() {
+      scope = fixtureExhausted();
+   });
+
+   it('should reject promise with 403 error', function() {
+      return user.listRepos().then(function() {
+         assert.fail(undefined, undefined, 'Promise was resolved instead of rejected');
+      }, function(error) {
+         expect(error).to.be.an.error();
+         expect(error).to.have.own('response');
+         expect(error.response).to.have.own('status');
+         expect(error.response.status).to.be(403);
+      });
+   });
+
+   it('should call callback', function(done) {
+      user.listRepos(assertFailure(done, function(error) {
+         expect(error).to.be.an.error();
+         expect(error).to.have.own('response');
+         expect(error.response).to.have.own('status');
+         expect(error.response.status).to.be(403);
+         done();
+      }));
+   });
+
+   afterEach(function() {
+      scope.done();
+      nock.cleanAll();
+   });
+});
+
+describe('Rate limit OK', function() {
+   let github;
+   let user;
+   let scope;
+
+   before(function() {
+      github = new Github();
+      user = github.getUser(testUser.USERNAME);
+   });
+
+   beforeEach(function() {
+      scope = fixtureOk();
+   });
+
+   it('should resolve promise', function() {
+      return expect(user.listRepos()).to.resolve.to.object();
+   });
+
+   it('should call callback with array of results', function(done) {
+      user.listRepos(assertSuccessful(done, function(error, result) {
+         expect(error).is.not.an.error();
+         expect(error).is.not.truthy();
+         expect(result).is.array();
+         done();
+      }));
+   });
+
+   afterEach(function() {
+      scope.done();
+      nock.cleanAll();
+   });
+});

test/fixtures/record.js

@@ -0,0 +1,34 @@
+import fs from 'fs';
+import nock from 'nock';
+import path from 'path';
+import GitHub from '../../lib/GitHub';
+import testUser from './user.json';
+
+const gh = new GitHub();
+
+let fileName;
+gh.getRateLimit().getRateLimit()
+   .then((resp) => {
+      if (resp.data.rate.remaining === 0) {
+         fileName = 'repos-ratelimit-exhausted.js';
+      } else {
+         fileName = 'repos-ratelimit-ok.js';
+      }
+      nock.recorder.rec({
+         dont_print: true
+      });
+      gh.getUser(testUser.USERNAME).listRepos();
+      setTimeout(() => {
+         const fixtures = nock.recorder.play();
+         const filePath = path.join(__dirname, fileName);
+         const text = ('/* eslint-disable */\n' +
+                       'import nock from \'nock\';\n' +
+                       'export default function fixture() {\n' +
+                       '   let scope;\n' +
+                       '   scope = ' + fixtures.join('\nscope = ').trim().replace(/\n/g, '\n   ') + '\n' +
+                       '   return scope;\n' +
+                       '}\n');
+         fs.writeFileSync(filePath, text);
+         console.log('Wrote fixture data to', fileName);
+      }, 10000);
+   }).catch(console.error);

test/fixtures/repos-ratelimit-exhausted.js

@@ -0,0 +1,27 @@
+/* eslint-disable */
+import nock from 'nock';
+export default function fixture() {
+   let scope;
+   scope = nock('https://api.github.com:443', {"encodedQueryParams":true})
+     .get('/users/mikedeboertest/repos')
+     .query({"type":"all","sort":"updated","per_page":"100"})
+     .reply(403, {"message":"API rate limit exceeded for 174.20.8.171. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)","documentation_url":"https://developer.github.com/v3/#rate-limiting"}, { server: 'GitHub.com',
+     date: 'Sat, 18 Jun 2016 11:50:00 GMT',
+     'content-type': 'application/json; charset=utf-8',
+     'content-length': '246',
+     connection: 'close',
+     status: '403 Forbidden',
+     'x-ratelimit-limit': '60',
+     'x-ratelimit-remaining': '0',
+     'x-ratelimit-reset': '1466253529',
+     'x-github-media-type': 'github.v3; format=json',
+     'access-control-expose-headers': 'ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval',
+     'access-control-allow-origin': '*',
+     'content-security-policy': 'default-src \'none\'',
+     'strict-transport-security': 'max-age=31536000; includeSubdomains; preload',
+     'x-content-type-options': 'nosniff',
+     'x-frame-options': 'deny',
+     'x-xss-protection': '1; mode=block',
+     'x-github-request-id': 'AE1408AB:EA59:14F2183:57653568' });
+   return scope;
+}