Merge pull request #19 from blinkmobile/ON-2307

ON-2307 # Added check for minimum expiry in seconds

Author: kizaonline

classes/Forms.js

@@ -80,6 +80,9 @@ module.exports = class Forms extends OneBlinkAPI {
     if (typeof expiryInSeconds !== 'number') {
       return Promise.reject(new TypeError('Must supply "expiryInSeconds" as a number'))
     }
+    if (expiryInSeconds < 900) {
+      return Promise.reject(new TypeError('"expiryInSeconds" must be greater than or equal to 900'))
+    }
 
     return super.postRequest(`/forms/${formId}/retrieval-url/${submissionId}?expirySeconds=${expiryInSeconds}`)
   }

docs/forms.md

@@ -61,7 +61,7 @@ forms.generateFormUrl(formId, externalId, preFilledData)
 ```javascript
 const formId = 1
 const submissionId = 'c1f0f27b-4289-4ce5-9807-bf84971991aa'
-const expiryInSeconds = 300
+const expiryInSeconds = 900
 forms.generateSubmissionDataUrl(formId, submissionId, expiryInSeconds)
   .then((result) => {
     const submissionDataUrl = result.url
@@ -75,7 +75,7 @@ forms.generateSubmissionDataUrl(formId, submissionId, expiryInSeconds)
 |---|---|---|---|
 | `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 |
+| `expiryInSeconds` | Yes | `number` | The number of seconds the signed URL should be valid for, must be greater than or equal to `900` |
 
 ### Result (Resolved Promise)
 

tests/lib/forms.test.js

@@ -118,6 +118,10 @@ describe('Forms SDK Class', () => {
       test('"expiryInSeconds"', () => {
         return expect(forms.generateSubmissionDataUrl(1, '123')).rejects.toThrow('Must supply "expiryInSeconds" as a number')
       })
+
+      test('minimum "expiryInSeconds"', () => {
+        return expect(forms.generateSubmissionDataUrl(1, '123', 600)).rejects.toThrow('"expiryInSeconds" must be greater than or equal to 900')
+      })
     })
   })