Support for a personal Akismet API key and site

README.md

@@ -1,6 +1,6 @@
 <img src="logo.png" width="300">
 
-# Staticman [![coverage](https://img.shields.io/badge/coverage-55%25-red.svg?style=flat?style=flat-square)](https://github.com/eduardoboucas/staticman) [![Build Status](https://travis-ci.org/eduardoboucas/staticman.svg?branch=master)](https://travis-ci.org/eduardoboucas/staticman) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+# Staticman [![coverage](https://img.shields.io/badge/coverage-55%2525-red.svg?style=flat?style=flat-square)](https://github.com/eduardoboucas/staticman) [![Build Status](https://travis-ci.org/eduardoboucas/staticman.svg?branch=master)](https://travis-ci.org/eduardoboucas/staticman) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
 > Static sites with superpowers
 

lib/Staticman.js

@@ -73,6 +73,11 @@ Staticman.prototype._applyGeneratedFields = function (data) {
 
           break
 
+        case 'ip':
+          data[field] = this.ip
+
+          break
+
         case 'slugify':
           if (typeof options.field === 'string') {
             data[field] = slugify(data[options.field]).toLowerCase()
@@ -115,13 +120,14 @@ Staticman.prototype._checkForSpam = function (fields) {
 
   return new Promise((resolve, reject) => {
     const akismet = akismetApi.client({
-      apiKey: config.get('akismet.apiKey'),
-      blog: config.get('akismet.site')
+      apiKey: this.siteConfig.get('akismet.apiKey') || config.get('akismet.apiKey'),
+      blog: this.siteConfig.get('akismet.site') || config.get('akismet.site')
     })
 
     akismet.checkSpam({
       user_ip: this.ip,
       user_agent: this.userAgent,
+      permalink: this.options && this.options.origin,
       comment_type: this.siteConfig.get('akismet.type'),
       comment_author: fields[this.siteConfig.get('akismet.author')],
       comment_author_email: fields[this.siteConfig.get('akismet.authorEmail')],

server.js

@@ -38,8 +38,15 @@ StaticmanAPI.prototype.initialiseBruteforceProtection = function () {
 
 StaticmanAPI.prototype.initialiseCORS = function () {
   this.server.use((req, res, next) => {
-    res.header('Access-Control-Allow-Origin', '*')
+    res.header('Access-Control-Allow-Origin', req.headers.origin || '*')
     res.header('Access-Control-Allow-Headers', 'Origin, X-Requested-With, Content-Type, Accept')
+    res.header('Access-Control-Allow-Credentials', 'true')
+    res.header('Access-Control-Allow-Methods', 'GET, POST')
+
+    if (req.query.__amp_source_origin) {
+      res.header('AMP-Access-Control-Allow-Source-Origin', req.query.__amp_source_origin)
+      res.header('Access-Control-Expose-Headers', 'AMP-Access-Control-Allow-Source-Origin')
+    }
 
     next()
   })

siteConfig.js

@@ -15,6 +15,17 @@ const schema = {
       format: Boolean,
       default: false
     },
+    site: {
+      doc: 'URL of an Akismet account used for spam checking.',
+      docExample: 'http://yourdomain.com',
+      format: String,
+      default: ''
+    },
+    apiKey: {
+      doc: 'API key to be used with Akismet.',
+      format: 'EncryptedString',
+      default: ''
+    },
     author: {
       doc: 'Name of the field to be used as the entry\'s author in Akistmet',
       format: String,

test/unit/lib/Staticman.test.js

@@ -1,5 +1,6 @@
 const config = require('./../../../config')
 const errorHandler = require('./../../../lib/ErrorHandler')
+const RSA = require('./../../../lib/RSA')
 const frontMatter = require('front-matter')
 const md5 = require('md5')
 const moment = require('moment')
@@ -245,6 +246,10 @@ describe('Staticman interface', () => {
 
     test('makes a request to the Akismet API sending the correct data', () => {
       const fields = mockHelpers.getFields()
+      const options = {
+        origin: 'http://testsite.com'
+      }
+
       const mockCheckSpamFn = jest.fn((options, callback) => {
         callback(null, false)
       })
@@ -264,6 +269,7 @@ describe('Staticman interface', () => {
       mockConfig.set('akismet.authorEmail', 'email')
       mockConfig.set('akismet.authorUrl', 'url')
       mockConfig.set('akismet.content', 'message')
+      staticman.options = options
       staticman.siteConfig = mockConfig
 
       return staticman._checkForSpam(fields).then(response => {
@@ -277,6 +283,7 @@ describe('Staticman interface', () => {
 
         expect(mockCheckSpamFn).toHaveBeenCalledTimes(1)
         expect(mockCheckSpamFn.mock.calls[0][0]).toEqual({
+          permalink: options.origin,
           comment_type: 'comment',
           comment_author: fields.name,
           comment_author_email: fields.email,
@@ -287,6 +294,37 @@ describe('Staticman interface', () => {
       })
     })
 
+    test('overrides Akismet apiKey and site if they exist in site config', () => {
+      const fields = mockHelpers.getFields()
+      const mockCheckSpamFn = jest.fn((options, callback) => {
+        callback(null, false)
+      })
+      const mockClientFn = jest.fn(options => ({
+        checkSpam: mockCheckSpamFn
+      }))
+
+      jest.mock('akismet', () => ({
+        client: mockClientFn
+      }))
+
+      const Staticman = require('./../../../lib/Staticman')
+      const staticman = new Staticman(mockParameters)
+
+      const akismetApiKey = '123456789'
+
+      mockConfig.set('akismet.enabled', true)
+      mockConfig.set('akismet.apiKey', RSA.encrypt(akismetApiKey))
+      mockConfig.set('akismet.site', 'http://mytestsite.com')
+      staticman.siteConfig = mockConfig
+
+      return staticman._checkForSpam(fields).then(response => {
+        expect(mockClientFn.mock.calls[0][0]).toEqual({
+          apiKey: akismetApiKey,
+          blog: mockConfig.get('akismet.site')
+        })
+      })
+    })
+
     test('throws an error if the Akismet API call fails', () => {
       const akismetError = new Error('Akismet error')
       const fields = mockHelpers.getFields()