Flattened history

Author: Cristiano Betta

.env.example

@@ -0,0 +1 @@
+SURVEY_MONKEY_ACCESS_TOKEN=

.gitignore

@@ -0,0 +1,12 @@
+# package directories
+node_modules
+jspm_packages
+
+# Serverless directories
+.serverless
+
+# yarn incidentals
+yarn-error.log
+
+# secrets
+.env

.nvmrc

@@ -0,0 +1 @@
+8.10

.travis.yml

@@ -0,0 +1,18 @@
+language: node_js
+cache: yarn
+node_js:
+  - 8.10
+script:
+  - yarn test
+before_deploy: 
+  - npm install serverless -g
+  - sls config credentials -p aws -k $AWS_KEY -s $AWS_SECRET -o
+deploy:
+  - provider: script
+    script: yarn deploy:prod
+    on:
+      branch: master
+  - provider: script
+    script: yarn deploy:dev
+    on:
+      branch: develop

README.md

@@ -0,0 +1,53 @@
+# Serverless Feedback Component for SurveyMonkey
+
+### Prerequisites
+
+Install Node 8.10 and yarn:
+
+```sh
+nvm install 8.10
+nvm use 8.10
+npm install -g yarn
+yarn install
+```
+
+Install serverless CLI:
+
+```sh
+npm install -g serverless
+sls login
+sls config credentials --provider aws --key [AWS_KEY] --secret [AWS_SECRET] -o
+```
+
+### Deployment
+
+#### Production
+
+Production is pushed to AWS using Travis.
+
+#### "Staging"
+
+You can test a staging environment by deploying the dev stage to AWS.
+
+```sh
+yarn deploy # deploys to AWS using the DEV stage
+```
+
+This will output a URL in the form of:
+
+```sh
+https://[ID].execute-api.us-east-1.amazonaws.com/[env]/feedback
+```
+
+### Testing locally
+
+This does post to an actual response!
+
+```sh
+yarn invoke:local:short # writes a short yes/no response
+
+# for the next two, you will need to update the short.update.json
+# and long.json samples with the ID from the response above
+yarn invoke:local:update # updates the yes/no response
+yarn invoke:local:long # updates the yes/no response with name, email, and note
+```

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "documentation-feedback-serverless",
+  "version": "1.0.0",
+  "description": "Serverless component for our feedback widget",
+  "main": "handler.js",
+  "scripts": {
+    "deploy:dev": "sls deploy -s dev",
+    "deploy:prod": "sls deploy -s prod",
+    "deploy": "yarn deploy:dev",
+    "invoke:short": "sls invoke -f short -p samples/short.json -s dev",
+    "invoke:update": "sls invoke -f short -p samples/short.update.json -s dev",
+    "invoke:long": "sls invoke -f long -p samples/long.json -s dev",
+    "invoke:local:short": "SLS_DEBUG=* sls invoke local -f short -p samples/short.json -s dev",
+    "invoke:local:update": "SLS_DEBUG=* sls invoke local -f short -p samples/short.update.json -s dev",
+    "invoke:local:long": "SLS_DEBUG=* sls invoke local -f long -p samples/long.json -s dev",
+    "test": "jest",
+    "pretest": "yarn lint",
+    "lint": "standard"
+  },
+  "author": "Cristiano Betta <cbetta@box.com>",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "jest": "^23.6.0",
+    "serverless": "^1.32.0",
+    "standard": "^12.0.1"
+  },
+  "dependencies": {
+    "dotenv": "^6.1.0",
+    "node-fetch": "^2.2.0"
+  },
+  "standard": {
+    "env": [
+      "jest"
+    ]
+  }
+}

samples/long.json

@@ -0,0 +1,8 @@
+{
+  "useful": true,
+  "url": "http://google.com",
+  "name": "Cristiano",
+  "email": "",
+  "note": "Test",
+  "id": "10299904370"
+}

samples/short.json

@@ -0,0 +1,4 @@
+{
+  "useful": true,
+  "url": "http://google.com"
+}

samples/short.update.json

@@ -0,0 +1,5 @@
+{
+  "id": "10299774573",
+  "useful": false,
+  "url": "http://google.com"
+}

serverless.yml

@@ -0,0 +1,34 @@
+app: documentation
+service: feedback
+tenant: boxdev
+
+custom:
+  stage: ${opt:stage, self:provider.stage}
+  env:
+    SM_PRODUCTION:
+      prod: "true"
+      dev: ""
+
+provider:
+  name: aws
+  runtime: nodejs8.10
+  environment:
+    SM_ACCESS_TOKEN: ${file(./src/utils/dotenv.js):vars.sm_access_token}
+    SM_PRODUCTION: ${self:custom.env.SM_PRODUCTION.${self:custom.stage}}
+
+functions:
+  short:
+    handler: src/handlers/short.handler
+    events:
+      - http:
+         path: feedback/short
+         method: post
+         cors: true
+
+  long:
+    handler: src/handlers/long.handler
+    events:
+      - http:
+          path: feedback/long
+          method: post
+          cors: true

src/handlers/long.js

@@ -0,0 +1,30 @@
+const Template = require('../utils/template').default
+const HTTP = require('../utils/http').default
+
+class Handler {
+  constructor () {
+    this.template = new Template()
+    this.http = new HTTP()
+  }
+
+  async handle (event) {
+    let data = event.body ? JSON.parse(event.body) : event
+    let response = await this.submitLong(data)
+
+    return {
+      statusCode: 201,
+      body: JSON.stringify({ id: response.id }),
+      headers: HTTP.corsHeaders()
+    }
+  }
+
+  async submitLong (data) {
+    let answer = this.template.renderLong(data)
+    return this.http.putResponse(data.id, answer)
+  }
+}
+
+exports.default = Handler
+exports.handler = (event) => {
+  return new Handler().handle(event)
+}

src/handlers/short.js

@@ -0,0 +1,39 @@
+const Template = require('../utils/template').default
+const HTTP = require('../utils/http').default
+
+class Handler {
+  constructor () {
+    this.template = new Template()
+    this.http = new HTTP()
+  }
+
+  async handle (event) {
+    let data = event.body ? JSON.parse(event.body) : event
+    let response = data.id
+      ? (await this.updateShort(data))
+      : (await this.submitShort(data))
+
+    return {
+      statusCode: 201,
+      body: JSON.stringify({ id: response.id }),
+      headers: HTTP.corsHeaders()
+    }
+  }
+
+  // Submits the feedback to SurveyMonkey
+  async submitShort (data) {
+    let answer = this.template.renderShort(data)
+    return this.http.postResponse(answer)
+  }
+
+  // Updates a short feedback to SurveyMonkey
+  async updateShort (data) {
+    let answer = this.template.renderShort(data)
+    return this.http.putResponse(data.id, answer)
+  }
+}
+
+exports.default = Handler
+exports.handler = (event) => {
+  return new Handler().handle(event)
+}

src/utils/dotenv.js

@@ -0,0 +1,7 @@
+const dotenv = require('dotenv')
+
+dotenv.config()
+
+module.exports.vars = () => ({
+  sm_access_token: process.env.SURVEY_MONKEY_ACCESS_TOKEN
+})

src/utils/http.js

@@ -0,0 +1,52 @@
+const fetch = require('node-fetch')
+
+const BASE_URL = 'https://api.surveymonkey.com'
+
+exports.default = class HTTP {
+  constructor () {
+    this.fetch = fetch
+
+    this.SURVEY_COLLECTOR_ID = process.env.SM_PRODUCTION ? '219155553' : '219156108'
+    this.SURVEY_MONKEY_ACCESS_TOKEN = process.env.SM_ACCESS_TOKEN
+  }
+
+  // POST a new short response
+  postResponse (data) {
+    let url = `${BASE_URL}/v3/collectors/${this.SURVEY_COLLECTOR_ID}/responses`
+    return this.fetch(url, this.options('POST', data))
+      .then(res => res.json())
+      .catch(console.error)
+  }
+
+  // PUT an update to a response
+  putResponse (id, data) {
+    let url = `${BASE_URL}/v3/collectors/${this.SURVEY_COLLECTOR_ID}/responses/${id}`
+    return this.fetch(url, this.options('PUT', data))
+      .then(res => res.json())
+      .catch(console.error)
+  }
+
+  // Determines the CORS headers for this environment
+  static corsHeaders () {
+    let origin = (process.env.SM_PRODUCTION ? 'https://developer.box.com' : '*')
+
+    return {
+      'Access-Control-Allow-Origin': origin,
+      'Access-Control-Allow-Credentials': true
+    }
+  }
+
+  // PRIVATE
+
+  options (method, data) {
+    return {
+      method: method,
+      mode: 'cors',
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${this.SURVEY_MONKEY_ACCESS_TOKEN}`
+      },
+      body: JSON.stringify(data)
+    }
+  }
+}

src/utils/template.js

@@ -0,0 +1,64 @@
+exports.default = class Template {
+  constructor () {
+    this.responseTemplate = {
+      pages: [
+        {
+          id: (process.env.SM_PRODUCTION ? '47128554' : '47129534'),
+          questions: [
+            // URL
+            { id: (process.env.SM_PRODUCTION ? '164337216' : '164341787'), answers: [{}] },
+            // yes/no
+            { id: (process.env.SM_PRODUCTION ? '' : '164341788'), answers: [{}] }
+          ]
+        }
+      ]
+    }
+
+    this.nameTemplate = { id: (process.env.SM_PRODUCTION ? '164337973' : '164341789'), answers: [{}] }
+    this.emailTemplate = { id: (process.env.SM_PRODUCTION ? '164338049' : '164341790'), answers: [{}] }
+    this.noteTemplate = { id: (process.env.SM_PRODUCTION ? '164338156' : '164341791'), answers: [{}] }
+
+    // The ID's of the answers to the question "Was this page useful?"
+    this.usefulAnswerID = (process.env.SM_PRODUCTION ? '1155084831' : '1155115696')
+    this.notUsefulAnswerID = (process.env.SM_PRODUCTION ? '1155084834' : '1155115697')
+  }
+
+  // Turns a simple feedback into a SurveyMonkey
+  // compatible format
+  renderShort (feedback) {
+    this.responseTemplate.response_status = 'partial'
+    // Extract the URL
+    this.responseTemplate.pages[0].questions[0].answers[0].text = feedback.url
+    // Extract if the feedback was positive
+    this.responseTemplate.pages[0].questions[1].answers[0].choice_id = feedback.useful
+      ? this.usefulAnswerID
+      : this.notUsefulAnswerID
+    return this.responseTemplate
+  }
+
+  renderLong (feedback) {
+    this.responseTemplate.response_status = 'completed'
+    // Extract the URL
+    this.responseTemplate.pages[0].questions[0].answers[0].text = feedback.url
+    // Extract if the feedback was positive
+    this.responseTemplate.pages[0].questions[1].answers[0].choice_id = feedback.useful
+      ? this.usefulAnswerID
+      : this.notUsefulAnswerID
+
+    // Extract the email
+    if (feedback.email) {
+      this.emailTemplate.answers[0].text = feedback.email
+      this.responseTemplate.pages[0].questions.push(this.emailTemplate)
+    }
+    // Extract the name
+    if (feedback.name) {
+      this.nameTemplate.answers[0].text = feedback.name
+      this.responseTemplate.pages[0].questions.push(this.nameTemplate)
+    }
+
+    // Extract the note
+    this.noteTemplate.answers[0].text = feedback.note
+    this.responseTemplate.pages[0].questions.push(this.noteTemplate)
+    return this.responseTemplate
+  }
+}