Fix GitHub auth, upgrade GitHub API module, allow test suite to execu…

…te. (#319)

This is a large change meant to restore the repo to a functioning state. The GitHub library was reworked to use the lastest version of the GitHub API module and changes were made to support authentication as a GitHub application.

Instructions for creating a private instance hosted on the free tier of
Heroku have been added and all references to the public instance have
been removed. Heroku hosting is intended to provide users with a more
reliable alternative to the public instance, which we will be dropping
support for.

.gitignore

@@ -1,4 +1,5 @@
 .idea/
+.vscode/
 *.iml
 
 config.json

README.md

@@ -10,7 +10,9 @@ Staticman is a Node.js application that receives user-generated content and uplo
 
 It consists of a small web service that handles the `POST` requests from your forms, runs various forms of validation and manipulation defined by you and finally pushes them to your repository as data files. You can choose to enable moderation, which means files will be pushed to a separate branch and a pull request will be created for your approval, or disable it completely, meaning that files will be pushed to the main branch automatically.
 
-You can download and run the Staticman API on your own infrastructure, or you can simply use the public instance of the Staticman API for free. If using the public instance, you can skip to *[Setting up repository](#setting-up-a-repository)*.
+You can download and run the Staticman API on your own infrastructure. The easiest way to get a personal Staticman API instance up and running is to use the free tier of Heroku. If deploying to Heroku you can simply click the button below.
+
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
 
 ## Requirements
 
@@ -57,8 +59,6 @@ To add Staticman to a repository, you need to add the bot as a collaborator with
 http://your-staticman-url/v2/connect/GITHUB-USERNAME/GITHUB-REPOSITORY
 ```
 
-If you're using the public instance, the account you want to add is [staticmanapp](https://github.com/staticmanapp) and the URL is https://api.staticman.net/v2/connect/GITHUB-USERNAME/GITHUB-REPOSITORY.
-
 ## Site configuration
 
 Staticman will look for a config file. For the deprecated `v1` endpoints, this is a  `_config.yml` with a `staticman` property inside; for `v2` endpoints, Staticman looks for a `staticman.yml` file at the root of the repository.

app.json

@@ -0,0 +1,8 @@
+{
+    "name": "Staticman",
+    "description": "A Node.js application that enables dynamic content as part of a fully static website.",
+    "repository": "https://github.com/eduardoboucas/staticman/",
+    "logo": "https://staticman.net/assets/images/staticman-avatar.png",
+    "keywords": ["node", "express", "static", "staticman", "github-pages"]
+  }
+

controllers/auth.js

@@ -5,8 +5,8 @@ const oauth = require('../lib/OAuth')
 const RSA = require('../lib/RSA')
 const Staticman = require('../lib/Staticman')
 
-module.exports = (req, res) => {
-  const staticman = new Staticman(req.params)
+module.exports = async (req, res) => {
+  const staticman = await new Staticman(req.params)
   staticman.setConfigPath()
 
   let requestAccessToken
@@ -33,8 +33,8 @@ module.exports = (req, res) => {
 
   return staticman.getSiteConfig()
     .then(requestAccessToken)
-    .then((accessToken) => {
-      const git = gitFactory.create(req.params.service, {
+    .then(async (accessToken) => {
+      const git = await gitFactory.create(req.params.service, {
         oauthToken: accessToken,
         version: req.params.version
       })

controllers/connect.js

@@ -4,19 +4,26 @@ const path = require('path')
 const config = require(path.join(__dirname, '/../config'))
 const GitHub = require(path.join(__dirname, '/../lib/GitHub'))
 
-module.exports = (req, res) => {
+module.exports = async (req, res) => {
   const ua = config.get('analytics.uaTrackingId')
     ? require('universal-analytics')(config.get('analytics.uaTrackingId'))
     : null
 
-  const github = new GitHub({
+  const github = await new GitHub({
     username: req.params.username,
     repository: req.params.repository,
     branch: req.params.branch,
-    token: config.get('githubToken')
+    token: config.get('githubToken'),
+    version: req.params.version
   })
 
-  return github.api.repos.listInvitationsForAuthenticatedUser({}).then(({data}) => {
+  const isAppAuth = config.get('githubAppID') && config.get('githubPrivateKey')
+
+  if (isAppAuth) {
+    return res.send('OK!')
+  }
+
+  return github.api.repos.listInvitationsForAuthenticatedUser({}).then(({ data }) => {
     let invitationId = null
 
     const invitation = Array.isArray(data) && data.some(invitation => {

controllers/handlePR.js

@@ -4,7 +4,7 @@ const config = require('../config')
 const GitHub = require('../lib/GitHub')
 const Staticman = require('../lib/Staticman')
 
-module.exports = (repo, data) => {
+module.exports = async (repo, data) => {
   const ua = config.get('analytics.uaTrackingId')
     ? require('universal-analytics')(config.get('analytics.uaTrackingId'))
     : null
@@ -13,13 +13,13 @@ module.exports = (repo, data) => {
     return
   }
 
-  const github = new GitHub({
+  const github = await new GitHub({
     username: data.repository.owner.login,
     repository: data.repository.name,
     token: config.get('githubToken')
   })
 
-  return github.getReview(data.number).then((review) => {
+  return github.getReview(data.number).then(async (review) => {
     if (review.sourceBranch.indexOf('staticman_')) {
       return null
     }
@@ -34,7 +34,7 @@ module.exports = (repo, data) => {
       if (bodyMatch && (bodyMatch.length === 2)) {
         try {
           const parsedBody = JSON.parse(bodyMatch[1])
-          const staticman = new Staticman(parsedBody.parameters)
+          const staticman = await new Staticman(parsedBody.parameters)
 
           staticman.setConfigPath(parsedBody.configPath)
           staticman.processMerge(parsedBody.fields, parsedBody.options)

controllers/process.js

@@ -122,8 +122,8 @@ function sendResponse (res, data) {
   res.status(statusCode).send(payload)
 }
 
-module.exports = (req, res, next) => {
-  const staticman = new Staticman(req.params)
+module.exports = async (req, res, next) => {
+  const staticman = await new Staticman(req.params)
 
   staticman.setConfigPath()
   staticman.setIp(req.headers['x-forwarded-for'] || req.connection.remoteAddress)

index.js

@@ -1,7 +1,12 @@
-const StaticmanAPI = require('./server')
+(async () => {
+  try {
+    const StaticmanAPI = require('./server')
+    const api = await new StaticmanAPI()
 
-const api = new StaticmanAPI()
-
-api.start(port => {
-  console.log('Staticman API running on port', port)
-})
+    api.start(port => {
+      console.log('Staticman API running on port', port)
+    })
+  } catch (e) {
+    console.error(e)
+  }
+})()