Merge pull request #14 from blinkmobile/ON-2066

ON-2066 # Added Organisations and Keys classes

Author: kizaonline

changelog.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+### Added
+
+-   `Organisations` classes
+-   `Keys` class
+
 ## 0.2.1 (2018-09-04)
 
 ### Added

docs/README.md

@@ -3,3 +3,7 @@
 ## Classes
 
 -   [Forms](./forms.md)
+
+-   [Keys](./keys.md)
+
+-   [Organisations](./organisations.md)

docs/keys.md

@@ -0,0 +1,56 @@
+# OneBlink SDK | Keys Class
+
+## Constructor
+
+| Parameter | Required | Type | Description
+|---|---|---|---|
+| `options.accessKey` | Yes | `string` | Access key provided by OneBlink. |
+| `options.secretKey` | Yes | `string` | Secret key provided by OneBlink. |
+
+### Example
+
+```javascript
+const OneBlink = require('@oneblink/sdk')
+
+const options = {
+  accessKey: '123455678901ABCDEFGHIJKL',
+  secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL'
+}
+const keys = new OneBlink.Keys(options)
+```
+
+## Get Single Key
+
+### Example
+
+```javascript
+const keyId = '123455678901ABCDEFGHIJKL'
+keys.getKey(keyId)
+  .then((key) => {
+    // Use key here...
+  })
+```
+
+### Parameters
+
+| Parameter | Required | Type | Description
+|---|---|---|---|
+| `keyId` | Yes | `string` | The exact id of the key you wish to get |
+
+### Result (Resolved Promise)
+
+```json
+{
+  "id": "123455678901ABCDEFGHIJKL",
+  "name": "API Key",
+  "privilege": {
+    "API HOSTING": "DEPLOYMENT",
+    "FORMS": "FaaS",
+    "PDF": "BUILDER",
+    "WEB APP HOSTING": "DEPLOYMENT"
+  },
+  "links": {
+    "organisations": "ABCDEFGHIJKL123455678901"
+  }
+}
+```

docs/organisations.md

@@ -0,0 +1,58 @@
+# OneBlink SDK | Organisations Class
+
+## Constructor
+
+| Parameter | Required | Type | Description
+|---|---|---|---|
+| `options.accessKey` | Yes | `string` | Access key provided by OneBlink. |
+| `options.secretKey` | Yes | `string` | Secret key provided by OneBlink. |
+
+### Example
+
+```javascript
+const OneBlink = require('@oneblink/sdk')
+
+const options = {
+  accessKey: '123455678901ABCDEFGHIJKL',
+  secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL'
+}
+const organisations = new OneBlink.Organisations(options)
+```
+
+## Get Single Organisation
+
+### Example
+
+```javascript
+const organisationId = 'ABCDEFGHIJKL123455678901'
+organisations.getOrganisations(organisationId)
+  .then((organisation) => {
+    // Use organisation here...
+  })
+```
+
+### Parameters
+
+| Parameter | Required | Type | Description
+|---|---|---|---|
+| `organisationId` | Yes | `string` | The exact id of the organisation you wish to get |
+
+### Result (Resolved Promise)
+
+```json
+{
+  "id": "ABCDEFGHIJKL123455678901",
+  "name": "Organisation Name",
+  "createdAt": "2017-09-28T05:28:43.000Z",
+  "links": {
+    "awsAccounts": [
+      "ABCDEFG55678901HIJKL1234"
+    ]
+  },
+  "tags": [
+    "Organisation Tag"
+  ],
+  "formsHostname": "example.forms.oneblink.io",
+  "beeFormsCustomer": false
+}
+```

index.js

@@ -2,7 +2,11 @@
 'use strict'
 
 const Forms = require('./lib/forms.js')
+const Keys = require('./lib/keys.js')
+const Organisations = require('./lib/organisations.js')
 
 module.exports = {
-  Forms
+  Forms,
+  Keys,
+  Organisations
 }

lib/keys.js

@@ -0,0 +1,32 @@
+// @flow
+'use strict'
+
+/* ::
+import type {
+  ConstructorOptions,
+  Key
+} from '../types.js'
+*/
+
+const OneBlinkAPI = require('./one-blink-api.js')
+
+module.exports = class Keys extends OneBlinkAPI {
+  constructor (
+    options /* : ConstructorOptions */
+  ) {
+    options = options || {}
+    super(
+      options.oneBlinkAPIOrigin,
+      options.accessKey,
+      options.secretKey
+    )
+  }
+
+  getKey (keyId /* : ?mixed */) /* : Promise<Key> */ {
+    if (typeof keyId !== 'string') {
+      return Promise.reject(new TypeError('Must supply "keyId" as a string'))
+    }
+
+    return super.getRequest(`/keys/${keyId}`)
+  }
+}

lib/organisations.js

@@ -0,0 +1,32 @@
+// @flow
+'use strict'
+
+/* ::
+import type {
+  ConstructorOptions,
+  Organisation
+} from '../types.js'
+*/
+
+const OneBlinkAPI = require('./one-blink-api.js')
+
+module.exports = class Organisations extends OneBlinkAPI {
+  constructor (
+    options /* : ConstructorOptions */
+  ) {
+    options = options || {}
+    super(
+      options.oneBlinkAPIOrigin,
+      options.accessKey,
+      options.secretKey
+    )
+  }
+
+  getOrganisation (organisationId /* : ?mixed */) /* : Promise<Organisation> */ {
+    if (typeof organisationId !== 'string') {
+      return Promise.reject(new TypeError('Must supply "organisationId" as a string'))
+    }
+
+    return super.getRequest(`/organisations/${organisationId}`)
+  }
+}

tests/lib/keys.test.js

@@ -0,0 +1,15 @@
+
+// @flow
+'use strict'
+
+describe('Keys SDK Class', () => {
+  const Keys = require('../../lib/keys.js')
+  const keys = new Keys({
+    accessKey: '123',
+    secretKey: 'abc'
+  })
+
+  test('should reject with correct validation errors for "keyId"', () => {
+    return expect(keys.getKey()).rejects.toThrow('Must supply "keyId" as a string')
+  })
+})

tests/lib/organisations.test.js

@@ -0,0 +1,15 @@
+
+// @flow
+'use strict'
+
+describe('Organisations SDK Class', () => {
+  const Organisations = require('../../lib/organisations.js')
+  const organisations = new Organisations({
+    accessKey: '123',
+    secretKey: 'abc'
+  })
+
+  test('should reject with correct validation errors for "organisationId"', () => {
+    return expect(organisations.getOrganisation()).rejects.toThrow('Must supply "organisationId" as a string')
+  })
+})

types.js

@@ -103,4 +103,32 @@ export type S3SubmissionData = {
   definition: Form,
   submissionTimestamp: string
 }
+
+export type Key = {
+  id: string,
+  secret: string | void,
+  name: string,
+  privilege: {
+    'API HOSTING'?: 'DEPLOYMENT',
+    'PDF'?: 'BUILDER',
+    'WEB APP HOSTING'?: 'DEPLOYMENT',
+    'FORMS'?: 'FaaS'
+  },
+  links: {
+    organisations: string
+  }
+}
+
+export type Organisation = {
+  id: string,
+  name: string,
+  formsHostname: string,
+  formsCloudFrontDistributionOrigin?: string,
+  beeFormsCustomer: boolean,
+  createdAt: string,
+  tags: string[],
+  links: {
+    awsAccounts: string[]
+  }
+}
 */