Merge pull request #56 from apiv/master

Add GitHub Enterprise Support

Author: Ilya Radchenko

README.md

@@ -4,7 +4,7 @@ strider-github
 A provider for strider that integrates with github to provide easy setup of
 your projects. It registers webhooks and sets up ssh keys (if you so choose).
 
-[![NPM](https://nodei.co/npm/strider-github.png)](https://nodei.co/npm/strider-github/)  
+[![NPM](https://nodei.co/npm/strider-github.png)](https://nodei.co/npm/strider-github/)
 [![Build Status](https://travis-ci.org/Strider-CD/strider-github.svg)](https://travis-ci.org/Strider-CD/strider-github)
 
 Note: Supports using '[skip ci]' in your commit message to skip commits triggering a job.
@@ -13,24 +13,48 @@ Note: Supports using '[skip ci]' in your commit message to skip commits triggeri
 
 If you are running on `localhost:3000` the default settings should work just fine.
 
-### Use custom hostname and port
+### Environment Variables
 
-To use a custom hostname and port:
+**`SERVER_NAME`** The url of your strider server. Defaults to `http://localhost:3000`.
 
-- set this environment variables with you hosname/port information
+The following variables only need to be overridden if you are using github enterprise. See 'Enterprise Setup' below.
 
-```
-PORT=9999
-SERVER_NAME="http://your.strider.hostname:9999"
-PLUGIN_GITHUB_APP_ID="hereComesTheId"
-PLUGIN_GITHUB_APP_SECRET="theSecretFromGithub"
-```
+**`PLUGIN_GITHUB_APP_ID`** Defaults to client ID of Strider-CD Github App
 
-- register your own github app [here](https://github.com/settings/applications/new) and set authentication URL your server's hostname:port + `/auth/github/callback`, for example:
+**`PLUGIN_GITHUB_APP_SECRET`** Defaults to client secret of Strider-CD Github App
 
-```
-http://your.strider.hostname:9999/auth/github/callback
-```
+**`PLUGIN_GITHUB_API_DOMAIN`** Defaults to `https://github.com`
 
-- also make sure your github profile has a public email set
+**`PLUGIN_GITHUB_API_ENDPOINT`** Defaults to `https://api.github.com`
+
+### Enterprise Setup
+
+1) You'll need to create an Application on your GitHub Enterprise Server. Log in to GitHub Enterprise and navigate to
+`https://your-github-url.com/settings/applications/new` and set authentication URL to
+`https://your-strider-server:port/auth/github/callback`.
+2) Define the environment variables. Here is an example:
+   ```
+   export SERVER_NAME="http://111.11.11.111:3000"
+   export PLUGIN_GITHUB_APP_ID="a342d32c23c23"
+   export PLUGIN_GITHUB_APP_SECRET="5af64a67af586847afbc6796769769d97a961"
+   export PLUGIN_GITHUB_API_DOMAIN="https://github.my-organization.com"
+   export PLUGIN_GITHUB_API_ENDPOINT="https://github.my-organization.com/api/v3"
+   ```
+   **NOTE** `SERVER_NAME` must be the same exact host that you used for the 'Authentication URL' in step 1. For example,
+   if you used `http://111.11.11.111:3000/auth/guthub/callback` in step 1, your `SERVER_NAME` **must** be
+   `http://111.11.11.111:3000`. Also note that the protocol must be the same between the two (if you used `http://`
+   in step 1, you must use `http://` in `SERVER_NAME` and not `https://`).
+3) Reboot strider and navigate link a github account as normal, you should see your enterprise repos!
+
+#### Known Issues with Enterprise
+
+- If you get 'Error: Could not fetch user profile': Somehow, passport will fail to retrieve the user profile unless all
+of the following are set. On GitHub Enterprise, log in to the profile you are trying to link to, and navigate to
+`/settings/profile`. Make sure the following are defined and set properly.
+   - Public Email
+   - Homepage URL
+
+#### Known Issues with GitHub.com
+
+- Make sure your github profile has a public email set
   * Go to https://github.com/settings/profile and select an email under "Public email".

lib/api.js

@@ -8,6 +8,7 @@ var superagent = require('superagent');
 var url = require('url');
 var util = require('util');
 
+// todo this should use the `appConfig` object from ./webapp.js, but requiring it here would create a cyclical reference
 var GITHUB_API_ENDPOINT = process.env.PLUGIN_GITHUB_API_ENDPOINT || 'https://api.github.com';
 
 module.exports = {
@@ -418,10 +419,10 @@ function getRepos(token, username, callback) {
       var group = this.group();
 
       _.each(results, function (result) {
-        var team_id = result.req.path.split('/');
+        var team_id = result.req.path.match(/teams\/([0-9]*)/i)[1];
         debug("We get the following repo path: " + util.inspect(result.req.path));
-        team_id = team_id[2]; //TODO: add Enterprise support. This might be different for Github Enterprise 
 
+        // todo team_detail is unused
         var team_detail = team_detail_requests[parseInt(team_id, 10)];
         if (result.statusCode === 204) {
           pageinated_api_call('/teams/' + team_id + '/repos', token, group());
@@ -459,7 +460,7 @@ function getRepos(token, username, callback) {
       });
 
       //If the user is a member of a team, we get a repository in repos
-      //as well as team_repos. Thus we need to merge the two and de-dupe 
+      //as well as team_repos. Thus we need to merge the two and de-dupe
       repos = _.uniq(repos.concat(team_repos), false, function (item) {
         return item.id;
       });

lib/webapp.js

@@ -8,13 +8,16 @@ var utils = require('./utils');
 var webhooks = require('./webhooks');
 
 module.exports = {
-  // may be extended by strider, if it receives other config
   appConfig: {
-    hostname: 'http://localhost:3000',
-    appId: 'a3af4568e9d8ca4165fe',
-    appSecret: '18651128b57787a3336094e2ba1af240dfe44f6c',
-    apiDomain: 'https://github.com',
-    apiEndpoint: 'https://api.github.com'
+    hostname:    process.env.SERVER_NAME || 'http://localhost:3000',
+    // you only need to override these if you are connecting to github enterprise
+    // if you are on github enterprise, you'll need to create a new app: http://github.whatever.com/applications/new
+    appId:       process.env.PLUGIN_GITHUB_APP_ID || 'a3af4568e9d8ca4165fe',
+    appSecret:   process.env.PLUGIN_GITHUB_APP_SECRET || '18651128b57787a3336094e2ba1af240dfe44f6c',
+    // used for web auth
+    apiDomain:   process.env.PLUGIN_GITHUB_API_DOMAIN || 'https://github.com',
+    // enterprise endpoint urls end in /api/v3
+    apiEndpoint: process.env.PLUGIN_GITHUB_API_ENDPOINT || 'https://api.github.com'
   },
   fastFile: true,
   getBranches: function (account, config, project, done) {
@@ -57,6 +60,7 @@ module.exports = {
     api.getRepos(account.accessToken, account.login, next);
   },
 
+  // this attempts to connect to the github server with the stored credentials
   auth: function (passport, context) {
     var config = this.appConfig;