feat: 🚧 authorization apps api [CS-35317]

Author: uttamukkoji

lib/app/authorization/index.js

@@ -0,0 +1,107 @@
+import cloneDeep from 'lodash/cloneDeep'
+import error from '../../core/contentstackError'
+
+export function Authorization (http, data, params) {
+  http.defaults.versioningStrategy = undefined
+  this.params = params || {}
+  if (data) {
+    if (data.organization_uid) {
+      this.params = {
+        organization_uid: data.organization_uid
+      }
+    }
+    if (data.app_uid) {
+      this.urlPath = `/manifests/${data.app_uid}/authorizations`
+      /**
+       * @description List all user authorizations made to an authorized app under a particular organization
+       * @memberof Authorization
+       * @func findAll
+       * @returns {Promise<Response>}
+       *
+       * @example
+       * import * as contentstack from '@contentstack/management'
+       * const client = contentstack.client({ authtoken: 'TOKEN'})
+       *
+       * client.organization('organization_uid').app('manifest_uid').authorization().findAll()
+       * .then((response) => console.log(response))
+       */
+      this.findAll = async (param = {}) => {
+        try {
+          const headers = {
+            headers: { ...cloneDeep(this.params) },
+            params: {
+              ...cloneDeep(param)
+            }
+          }
+
+          const response = await http.get(this.urlPath, headers)
+          if (response.data) {
+            return response.data
+          } else {
+            throw error(response)
+          }
+        } catch (err) {
+          throw error(err)
+        }
+      }
+      /**
+       * @description Revoke all users tokens issued to an authorized app for the particular organization
+       * @memberof Authorization
+       * @func revokeAll
+       * @returns {Promise<Response>}
+       *
+       * @example
+       * import * as contentstack from '@contentstack/management'
+       * const client = contentstack.client({ authtoken: 'TOKEN'})
+       *
+       * client.organization('organization_uid').app('manifest_uid').authorization().revokeAll()
+       * .then((response) => console.log(response))
+       */
+      this.revokeAll = async () => {
+        try {
+          const headers = {
+            headers: { ...cloneDeep(this.params) }
+          }
+
+          const response = await http.delete(this.urlPath, headers)
+          if (response.data) {
+            return response.data
+          } else {
+            throw error(response)
+          }
+        } catch (err) {
+          throw error(err)
+        }
+      }
+      /**
+       * @description  Revoke user token issued to an authorized app for the particular organization
+       * @memberof Authorization
+       * @func revoke
+       * @returns {Promise<Response>}
+       *
+       * @example
+       * import * as contentstack from '@contentstack/management'
+       * const client = contentstack.client({ authtoken: 'TOKEN'})
+       *
+       * client.organization('organization_uid').app('manifest_uid').authorization().revoke('authorization_uid')
+       * .then((response) => console.log(response))
+       */
+      this.revoke = async (authorizationUid) => {
+        try {
+          const headers = {
+            headers: { ...cloneDeep(this.params) }
+          }
+
+          const response = await http.delete(`${this.urlPath}/${authorizationUid}`, headers)
+          if (response.data) {
+            return response.data
+          } else {
+            throw error(response)
+          }
+        } catch (err) {
+          throw error(err)
+        }
+      }
+    }
+  }
+}

lib/app/index.js

@@ -1,6 +1,7 @@
 import cloneDeep from 'lodash/cloneDeep'
 import error from '../core/contentstackError'
 import { create, deleteEntity, fetch, fetchAll, update } from '../entity'
+import { Authorization } from './authorization'
 import { Hosting } from './hosting'
 import { Installation } from './installation'
 
@@ -295,6 +296,20 @@ export function App (http, data) {
           throw error(err)
         }
       }
+      /**
+       * @description The Authorization will allow you to get all authorization, revoke specific or all authorization
+       * @memberof App
+       * @func authorization
+       * @returns {Authorization}
+       *
+       * @example
+       * import * as contentstack from '@contentstack/management'
+       * const client = contentstack.client({ authtoken: 'TOKEN'})
+       * client.organization('organization_uid').app('manifest_uid').authorization()
+       */
+      this.authorization = () => {
+        return new Authorization(http, { app_uid: this.uid }, this.params)
+      }
     } else {
       /**
        * @description The create manifest call is used for creating a new app/manifest in your Contentstack organization.

test/api/authorization-test.js

@@ -0,0 +1,46 @@
+import dotenv from 'dotenv'
+import { describe, it, setup } from 'mocha'
+import { jsonReader } from '../utility/fileOperations/readwrite'
+import { contentstackClient } from '../utility/ContentstackClient.js'
+import { expect } from 'chai'
+
+dotenv.config()
+
+const orgID = process.env.ORGANIZATION
+let client = {}
+let apps = {}
+
+describe('Apps api Test', () => {
+  setup(() => {
+    const user = jsonReader('loggedinuser.json')
+    client = contentstackClient(user.authtoken)
+    apps = jsonReader('apps.json')
+  })
+
+  it('fetch all authorization apps test', done => {
+    client.organization(orgID).app(apps.uid).authorization().findAll()
+      .then((response) => {
+        expect(response).to.not.equal(null)
+        done()
+      })
+      .catch(done)
+  })
+
+  it('revoke all authorization apps test', done => {
+    client.organization(orgID).app(apps.uid).authorization().revokeAll()
+      .then((response) => {
+        expect(response).to.not.equal(null)
+        done()
+      })
+      .catch(done)
+  })
+
+  it('revoke all authorization apps test', done => {
+    client.organization(orgID).app(apps.uid).authorization().revoke('uid')
+      .then((response) => {
+        expect(response).to.not.equal(null)
+        done()
+      })
+      .catch(done)
+  })
+})

test/test.js

@@ -3,8 +3,9 @@ require('./api/organization-test')
 require('./api/stack-test')
 require('./api/app-test')
 require('./api/hosting-test')
-require('./api/app-delete-test')
 require('./api/app-request-test')
+require('./api/authorization-test')
+require('./api/app-delete-test')
 require('./api/branch-test')
 require('./api/branchAlias-test')
 require('./api/locale-test')

test/typescript/app-request.ts

@@ -1,6 +1,5 @@
 import { expect } from 'chai'
 import * as dotenv from 'dotenv'
-import { Hosting } from '../../types/app/hosting'
 import { AppRequest } from '../../types/app/request'
 dotenv.config()
 let requestUID = ''

test/typescript/authorization.ts

@@ -0,0 +1,26 @@
+import { expect } from 'chai'
+import * as dotenv from 'dotenv'
+import { Authorization } from '../../types/app/authorization'
+dotenv.config()
+
+
+export function authorization (authorization: Authorization) {
+    describe('Authorization Apps api', () => {
+        test('test get all authorization for apps', done => {
+            authorization.findAll()
+            .then((response) => {
+                expect(response).to.not.equal(undefined)
+                done()
+              })
+              .catch(done)
+        })
+        test('test revoke all authorization for apps', done => {
+            authorization.revokeAll()
+            .then((response) => {
+                expect(response).to.not.equal(undefined)
+                done()
+              })
+              .catch(done)
+        })
+    })
+}

test/typescript/index.test.ts

@@ -15,7 +15,8 @@ import { createDeliveryToken, deleteDeliveryToken, deliveryToken, queryDeliveryT
 import { createRole, findAllRole, getRole, getRoleUid, queryRole } from './role';
 import { createApp, deleteApp, fetchApp, installation, updateApp, updateAuth } from './app';
 import { deployment, hosting } from './hosting';
-import { appRequest, orgAppRequest } from './app-request';
+import { orgAppRequest } from './app-request';
+import { authorization } from './authorization';
 dotenv.config()
 jest.setTimeout(10000);
 
@@ -43,8 +44,9 @@ describe('Typescript API test', () => {
     installation(org)
     hosting(org.app(process.env.APP_UID as string).hosting())
     deployment(org.app(process.env.APP_UID as string).hosting())
-    appRequest(org.app(process.env.APP_UID as string).request())
-    orgAppRequest(org.app().request())
+    orgAppRequest(org.app(process.env.APP_UID as string).request())
+    authorization(org.app(process.env.APP_UID as string).authorization())
+    orgAppRequest(org.request())
     deleteApp(org)
 
     const stack = client.stack({api_key: process.env.APIKEY as string})