From e18363f0812b61cbbb6bc0e022daba4cd997dea0 Mon Sep 17 00:00:00 2001
From: Jake Bolam <jake.bolam@gmail.com>
Date: Sun, 23 Dec 2018 11:24:29 +0800
Subject: [PATCH] feat: way to avoid github API limit (#122)

<!--
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!

Please make sure that you are familiar with and follow the Code of Conduct for
this project (found in the CODE_OF_CONDUCT.md file).

Also, please make sure you're familiar with and follow the instructions in the
contributing guidelines (found in the CONTRIBUTING.md file).

If you're new to contributing to open source projects, you might find this free
video course helpful: http://kcd.im/pull-request

Please fill out the information below to expedite the review and (hopefully)
merge of your pull request!
-->

<!-- What changes are being made? (What feature/bug is being fixed here?) -->
**What**:
Add a way to avoid GITHUB API LIMIT by supplying an optional GITHUB_AUTH token to increase github rate limiting from 50 requests to 5000 (and limited by user, not IP)

<!-- Why are these changes necessary? -->
**Why**:
To address: #121

<!-- How were these changes implemented? -->
**How**:
By Me

<!-- Have you done all of these things?  -->
**Checklist**:
<!-- add "N/A" to the end of each line that's irrelevant to your changes -->
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" -->
- [ ] Documentation
- [ ] Tests
- [ ] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? -->
- [ ] Added myself to contributors table <!-- this is optional, see the contributing guidelines for instructions -->

<!-- feel free to add additional comments -->
---
 src/repo/github.js | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/src/repo/github.js b/src/repo/github.js
index 3a51788..0c49f7e 100644
--- a/src/repo/github.js
+++ b/src/repo/github.js
@@ -1,6 +1,19 @@
 const pify = require('pify')
 const request = pify(require('request'))
 
+function getRequestHeaders() {
+  const requestHeaders = {
+    'User-Agent': 'request',
+  }
+  
+  const optionalAuthToken = process.env.GITHUB_TOKEN
+  if (optionalAuthToken) {
+    requestHeaders.Authorization = `token ${optionalAuthToken}`
+  }
+
+  return requestHeaders
+}
+
 function getNextLink(link) {
   if (!link) {
     return null
@@ -19,9 +32,7 @@ function getContributorsPage(url) {
   return request
     .get({
       url,
-      headers: {
-        'User-Agent': 'request',
-      },
+      headers: getRequestHeaders(),
     })
     .then(res => {
       const body = JSON.parse(res.body)
@@ -54,9 +65,7 @@ const getUserInfo = function(username, hostname) {
   return request
     .get({
       url: `${root}/users/${username}`,
-      headers: {
-        'User-Agent': 'request',
-      },
+      headers: getRequestHeaders(),
     })
     .then(res => {
       const body = JSON.parse(res.body)