Merge pull request #18 from blinkmobile/ON-2282

ON-2282 # Added generateSubmissionDataUrl function to Forms class

Author: kizaonline

.vscode/settings.json

@@ -1,2 +1,3 @@
 {
+  "javascript.format.insertSpaceBeforeFunctionParenthesis": true
 }

changelog.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Added
+
+-   `forms.generateSubmissionDataUrl()` function
+
 ## 0.2.3 (2018-10-17)
 
 ### Added

lib/forms.js renamed to classes/Forms.js

@@ -11,11 +11,11 @@ import type {
 } from '../types.js'
 */
 
-const generateFormUrl = require('./generate-form-url.js')
-const generateJWT = require('./generate-jwt.js')
-const submissionData = require('./retrieve-submission-data.js')
-const OneBlinkAPI = require('./one-blink-api.js')
-const setPreFillData = require('./pre-fill-data')
+const generateFormUrl = require('../lib/generate-form-url.js')
+const generateJWT = require('../lib/generate-jwt.js')
+const submissionData = require('../lib/retrieve-submission-data.js')
+const OneBlinkAPI = require('../lib/one-blink-api.js')
+const setPreFillData = require('../lib/pre-fill-data')
 
 module.exports = class Forms extends OneBlinkAPI {
   constructor (
@@ -47,7 +47,7 @@ module.exports = class Forms extends OneBlinkAPI {
 
     let preFillFormDataId
     if (preFillData) {
-      const preFillMeta = await super.getRequest(`/forms/${formId}/pre-fill-credentials`)
+      const preFillMeta = await super.postRequest(`/forms/${formId}/pre-fill-credentials`)
       await setPreFillData(preFillMeta, preFillData)
       preFillFormDataId = preFillMeta.preFillFormDataId
     }
@@ -66,6 +66,24 @@ module.exports = class Forms extends OneBlinkAPI {
     }
   }
 
+  async generateSubmissionDataUrl (
+    formId /* : ?mixed */,
+    submissionId /* : ?mixed */,
+    expiryInSeconds /* : ?mixed */
+  ) /* : Promise<{ url: string }> */ {
+    if (typeof formId !== 'number') {
+      return Promise.reject(new TypeError('Must supply "formId" as a number'))
+    }
+    if (typeof submissionId !== 'string') {
+      return Promise.reject(new TypeError('Must supply "submissionId" as a string'))
+    }
+    if (typeof expiryInSeconds !== 'number') {
+      return Promise.reject(new TypeError('Must supply "expiryInSeconds" as a number'))
+    }
+
+    return super.postRequest(`/forms/${formId}/retrieval-url/${submissionId}?expirySeconds=${expiryInSeconds}`)
+  }
+
   getSubmissionData (
     formId /* : ?mixed */,
     submissionId /* : ?mixed */
@@ -77,7 +95,7 @@ module.exports = class Forms extends OneBlinkAPI {
       return Promise.reject(new TypeError('Must supply "submissionId" as a string'))
     }
 
-    return super.getRequest(`/forms/${formId}/retrieval-credentials/${submissionId}`)
+    return super.postRequest(`/forms/${formId}/retrieval-credentials/${submissionId}`)
       .then((credentials) => submissionData.getSubmissionData(credentials))
   }
 

lib/keys.js renamed to classes/Keys.js

@@ -8,7 +8,7 @@ import type {
 } from '../types.js'
 */
 
-const OneBlinkAPI = require('./one-blink-api.js')
+const OneBlinkAPI = require('../lib/one-blink-api.js')
 
 module.exports = class Keys extends OneBlinkAPI {
   constructor (

lib/organisations.js renamed to classes/Organisations.js

@@ -8,7 +8,7 @@ import type {
 } from '../types.js'
 */
 
-const OneBlinkAPI = require('./one-blink-api.js')
+const OneBlinkAPI = require('../lib/one-blink-api.js')
 
 module.exports = class Organisations extends OneBlinkAPI {
   constructor (

docs/forms.md

@@ -54,6 +54,37 @@ forms.generateFormUrl(formId, externalId, preFilledData)
 }
 ```
 
+## Generate Submission Data URL
+
+### Example
+
+```javascript
+const formId = 1
+const submissionId = 'c1f0f27b-4289-4ce5-9807-bf84971991aa'
+const expiryInSeconds = 300
+forms.generateSubmissionDataUrl(formId, submissionId, expiryInSeconds)
+  .then((result) => {
+    const submissionDataUrl = result.url
+    // Use URL here...
+  })
+```
+
+### Parameters
+
+| Parameter | Required | Type | Description
+|---|---|---|---|
+| `formId` | Yes | `number` | The exact id of the form you wish to generate a URL for |
+| `submissionId` | Yes | `string` | The submission identifier generated after a successful form submission, this will be return to you after a successful forms submission via a callback URL |
+| `expiryInSeconds` | Yes | `number` | The number of seconds the signed URL should be valid for |
+
+### Result (Resolved Promise)
+
+```json
+{
+  "url": "https://domain.io/path?query=string",
+}
+```
+
 ## Get Submission Data
 
 ### Example
@@ -75,7 +106,7 @@ forms.getSubmissionData(formId, submissionId)
 
 | Parameter | Required | Type | Description
 |---|---|---|---|
-| `formId` | Yes | `number` | The exact id of the form you wish to generate a URL for |
+| `formId` | Yes | `number` | The exact id of the form you wish to get submission data for |
 | `submissionId` | Yes | `string` | The submission identifier generated after a successful form submission, this will be return to you after a successful forms submission via a callback URL |
 
 ### Result (Resolved Promise)

index.js

@@ -1,9 +1,9 @@
 // @flow
 'use strict'
 
-const Forms = require('./lib/forms.js')
-const Keys = require('./lib/keys.js')
-const Organisations = require('./lib/organisations.js')
+const Forms = require('./classes/Forms.js')
+const Keys = require('./classes/Keys.js')
+const Organisations = require('./classes/Organisations.js')
 
 module.exports = {
   Forms,

lib/one-blink-api.js

@@ -3,7 +3,8 @@
 
 /* ::
 import type {
-  Axios
+  Axios,
+  $AxiosError
 } from 'axios'
 */
 
@@ -13,6 +14,27 @@ const axios = require('axios')
 
 const generateJWT = require('./generate-jwt.js')
 
+function errorHandler (
+  error /* : $AxiosError<{
+    error: string,
+    message: string,
+    statusCode: number
+  }> */
+) {
+  if (error.response) {
+    // The request was made and the server responded with a status code
+    // that falls out of the range of 2xx
+    error.response.data = error.response.data || {
+      message: 'OneBlink API Internal Server Error'
+    }
+    const err = new Error(error.response.data.message)
+    err.name = 'OneBlinkAPIError'
+    throw err
+  }
+
+  throw error
+}
+
 module.exports = class OneBlinkAPI {
   /* ::
   oneBlinkAPI: Axios
@@ -50,20 +72,7 @@ module.exports = class OneBlinkAPI {
       }
     })
       .then((response) => response.data)
-      .catch((error) => {
-        if (error.response) {
-          // The request was made and the server responded with a status code
-          // that falls out of the range of 2xx
-          error.response.data = error.response.data || {
-            message: 'OneBlink API Internal Server Error'
-          }
-          const err = new Error(error.response.data.message)
-          err.name = 'OneBlinkAPIError'
-          throw err
-        }
-
-        throw error
-      })
+      .catch(errorHandler)
   }
 
   searchRequest (
@@ -73,4 +82,20 @@ module.exports = class OneBlinkAPI {
     const search = querystring.stringify(searchParams || {})
     return this.getRequest(`${path}?${search}`)
   }
+
+  postRequest (
+    path /* : string */,
+    body /* : ?mixed */
+  ) /* Promise<Object> */ {
+    // 5 minute expiry
+    const jwtExpiry = 300
+
+    return this.oneBlinkAPI.post(path, body, {
+      headers: {
+        'Authorization': `Bearer ${generateJWT(this.accessKey, this.secretKey, jwtExpiry)}`
+      }
+    })
+      .then((response) => response.data)
+      .catch(errorHandler)
+  }
 }

package.json

@@ -35,6 +35,7 @@
   },
   "files": [
     "lib",
+    "classes",
     "index.js",
     "types.js"
   ],

tests/lib/forms.test.js

@@ -32,7 +32,7 @@ describe('Forms SDK Class', () => {
       }
     })
 
-    const Forms = require('../../lib/forms.js')
+    const Forms = require('../../classes/Forms.js')
     const forms = new Forms({
       accessKey: '123',
       secretKey: 'abc'
@@ -80,7 +80,7 @@ describe('Forms SDK Class', () => {
   })
 
   describe('getSubmissionData()', () => {
-    const Forms = require('../../lib/forms.js')
+    const Forms = require('../../classes/Forms.js')
     const forms = new Forms({
       accessKey: '123',
       secretKey: 'abc',
@@ -98,8 +98,31 @@ describe('Forms SDK Class', () => {
     })
   })
 
+  describe('generateSubmissionDataUrl()', () => {
+    const Forms = require('../../classes/Forms.js')
+    const forms = new Forms({
+      accessKey: '123',
+      secretKey: 'abc',
+      oneBlinkAPIOrigin: 'https://domain.api.com'
+    })
+
+    describe('should reject with correct validation errors for', () => {
+      test('"formId"', () => {
+        return expect(forms.generateSubmissionDataUrl()).rejects.toThrow('Must supply "formId" as a number')
+      })
+
+      test('"submissionId"', () => {
+        return expect(forms.generateSubmissionDataUrl(1)).rejects.toThrow('Must supply "submissionId" as a string')
+      })
+
+      test('"expiryInSeconds"', () => {
+        return expect(forms.generateSubmissionDataUrl(1, '123')).rejects.toThrow('Must supply "expiryInSeconds" as a number')
+      })
+    })
+  })
+
   describe('getForm()', () => {
-    const Forms = require('../../lib/forms.js')
+    const Forms = require('../../classes/Forms.js')
     const forms = new Forms({
       accessKey: '123',
       secretKey: 'abc',