Merge pull request #15 from blinkmobile/ON-2254

ON-2254 # Added forms.getForm() function

Author: kizaonline

changelog.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Added
+
+-   `forms.getForm()` function
+
 ## 0.2.2 (2018-09-25)
 
 ### Added

docs/forms.md

@@ -100,6 +100,39 @@ forms.getSubmissionData(formId, submissionId)
 }
 ```
 
+## Get Single Form
+
+### Example
+
+```javascript
+const formId = 1
+forms.getForm(formId)
+  .then((form) => {
+    // Use form here...
+  })
+```
+
+### Parameters
+
+| Parameter | Required | Type | Description
+|---|---|---|---|
+| `formId` | Yes | `number` | The exact id of the form you wish to get |
+
+### Result (Resolved Promise)
+
+```json
+{
+  "id": 1,
+  "name": "testsform",
+  "description": "a form",
+  "organisationId": "0101010101010",
+  "elements": [],
+  "isAuthenticated": false,
+  "isPublished": true,
+  "submissionEvents": []
+}
+```
+
 ## Search Forms
 
 ### Example

lib/forms.js

@@ -3,6 +3,7 @@
 
 /* ::
 import type {
+  Form,
   ConstructorOptions,
   FormsSearchOptions,
   FormsSearchResult,
@@ -105,4 +106,12 @@ module.exports = class Forms extends OneBlinkAPI {
 
     return super.searchRequest(`/forms`, searchParams)
   }
+
+  getForm (formId /* : ?mixed */) /* : Promise<Form> */ {
+    if (typeof formId !== 'number') {
+      return Promise.reject(new TypeError('Must supply "formId" as a number'))
+    }
+
+    return super.getRequest(`/forms/${formId}`)
+  }
 }

tests/lib/forms.test.js

@@ -97,4 +97,19 @@ describe('Forms SDK Class', () => {
       })
     })
   })
+
+  describe('getForm()', () => {
+    const Forms = require('../../lib/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.getForm('123')).rejects.toThrow('Must supply "formId" as a number')
+      })
+    })
+  })
 })