feat: error on 304s (#673)

304s are only returned if according headers are sent. Caching has to be handled by user

lib/error.js

@@ -45,6 +45,7 @@ Util.inherits(exports.HttpError, Error);
 }).call(exports.HttpError.prototype)
 
 var statusCodes = {
+  304: 'Not Modified', // See PR #673 (https://github.com/octokit/node-github/pull/673)
   400: 'Bad Request',
   401: 'Unauthorized',
   402: 'Payment Required',

lib/index.js

@@ -739,13 +739,13 @@ var Client = module.exports = function (config) {
           callCallback(err)
         })
         res.on('end', function () {
-          if (res.statusCode >= 301 && res.statusCode <= 307) {
+          if (res.statusCode !== 304 && res.statusCode >= 301 && res.statusCode <= 307) {
             options.path = Url.parse(res.headers.location, true).path
             httpSendRequest()
             return
           }
 
-          if (res.statusCode >= 400 || res.statusCode < 10) {
+          if (res.statusCode === 304 || res.statusCode >= 400 || res.statusCode < 10) {
             callCallback(new error.HttpError(data, res.statusCode, res.headers))
           } else {
             res.data = data

test/integration/conditional-request-test.js

@@ -0,0 +1,42 @@
+const chai = require('chai')
+const nock = require('nock')
+
+const GitHub = require('../../')
+
+const mocha = require('mocha')
+const describe = mocha.describe
+const it = mocha.it
+chai.should()
+
+describe('request 304s', () => {
+  it('304 etag', () => {
+    nock('https://request-errors-test.com')
+      .get('/orgs/myorg')
+      .reply(304, '')
+
+    const github = new GitHub({
+      host: 'request-errors-test.com'
+    })
+
+    return github.orgs.get({org: 'myorg', headers: {'If-None-Match': 'etag'}})
+
+    .catch(exception => {
+      exception.code.should.equal(304)
+    })
+  })
+  it('304 last-modified', () => {
+    nock('https://request-errors-test.com')
+      .get('/orgs/myorg')
+      .reply(304, '')
+
+    const github = new GitHub({
+      host: 'request-errors-test.com'
+    })
+
+    return github.orgs.get({org: 'myorg', headers: {'If-Modified-Since': 'Sun Dec 24 2017 22:00:00 GMT-0600 (CST)'}})
+
+    .catch(exception => {
+      exception.code.should.equal(304)
+    })
+  })
+})