Merge pull request #87 from pliancy/enhancement/BILL-14-get-egnyte-pr…

…otect-usage

feat(protect-plan): add methods to get protect plan(s)

src/index.test.ts

@@ -60,4 +60,61 @@ describe('Egnyte', () => {
             })
         })
     })
+
+    describe('public methods', () => {
+        it('returns null given customer does not have egnyte protect', async () => {
+            jest.spyOn(egnyte, '_authenticate' as never).mockResolvedValue({
+                authCookie: 'authCookie',
+                csrfToken: 'csrfToken',
+            } as never)
+            jest.spyOn(egnyte, '_egnyteRequest' as never).mockResolvedValue({
+                data: [
+                    {
+                        protectawesomecustomer: {
+                            storage_stats: {},
+                        },
+                    },
+                ],
+            } as never)
+            await expect(
+                egnyte.getCustomerProtectPlanUsage('SOMEOTHERCUSTOMER'),
+            ).resolves.toBeNull()
+        })
+
+        it('gets protect plan usage', async () => {
+            const storage_stats = { Used: 100, Unused: 200, Available: 100 }
+            jest.spyOn(egnyte, '_authenticate' as never).mockResolvedValue({
+                authCookie: 'authCookie',
+                csrfToken: 'csrfToken',
+            } as never)
+            jest.spyOn(egnyte, '_egnyteRequest' as never).mockResolvedValue({
+                data: [
+                    {
+                        protectawesomecustomer: {
+                            storage_stats,
+                        },
+                    },
+                ],
+            } as never)
+            await expect(egnyte.getCustomerProtectPlanUsage('AWESOMECUSTOMER')).resolves.toEqual(
+                storage_stats,
+            )
+        })
+
+        it('gets all protect plans', async () => {
+            const data = [
+                {
+                    protectawesomecustomer: {
+                        storage_stats: { Used: 100, Unused: 200, Available: 100 },
+                    },
+                },
+            ]
+            jest.spyOn(egnyte, '_authenticate' as never).mockResolvedValue({
+                authCookie: 'authCookie',
+                csrfToken: 'csrfToken',
+            } as never)
+            jest.spyOn(egnyte, '_egnyteRequest' as never).mockResolvedValue({ data } as never)
+            await expect(egnyte.getAllProtectPlans()).resolves.toEqual(data)
+        })
+    })
 })

src/index.ts

@@ -2,7 +2,7 @@ import qs from 'querystring'
 import axios, { AxiosRequestConfig } from 'axios'
 import cheerio from 'cheerio'
 
-interface EgnyteCustomer {
+export interface EgnyteCustomer {
     customerEgnyteId: string
     planId: string
     powerUsers: {
@@ -19,27 +19,37 @@ interface EgnyteCustomer {
     }
 }
 
-interface EgnyteUpdateResponse {
+export interface EgnyteUpdateResponse {
     result: string
     message: string
 }
 
-interface EgnyteConfig {
+export interface StorageStats {
+    Used: number
+    Unused: number
+    Available: number
+}
+
+export interface EgnyteConfig {
     /** the egnyte resellers portal username */
     username: string
     /** the egnyte resellers portal password */
     password: string
+    /**
+     * Protect planId
+     */
+    protectPlanId?: number
     /** timeout threshold in milliseconds */
     timeoutMs?: number
     forceLicenseChange?: boolean
 }
 
-interface UpdateCustomer {
+export interface UpdateCustomer {
     powerUsers?: { total?: number }
     storageGB?: { total?: number }
 }
 
-class Egnyte {
+export default class Egnyte {
     private readonly _config: EgnyteConfig
     private readonly httpConfig: AxiosRequestConfig
     private resellerId: string
@@ -282,6 +292,46 @@ class Egnyte {
         return results
     }
 
+    /**
+     * retrieves protect plan usage for a customer
+     * @returns object containing the available usage data or null if the customer does not have protect
+     */
+    async getCustomerProtectPlanUsage(egnyteTenantId: string): Promise<StorageStats | null> {
+        const { authCookie, csrfToken } = await this._authenticate()
+        const { data: protectUsage } = await this._egnyteRequest(
+            `/msp/usage_stats/${this.resellerId}/${this._config.protectPlanId}/`,
+            {
+                headers: { cookie: authCookie, 'X-CSRFToken': csrfToken },
+            },
+        )
+
+        const id = `protect${egnyteTenantId.toLowerCase()}`
+
+        for (const entry of protectUsage) {
+            if (Object.keys(entry)[0] === id) {
+                return entry[id].storage_stats
+            }
+        }
+
+        return null
+    }
+
+    /**
+     * retrieves all protect plans
+     * @returns array containing the available plans
+     */
+    async getAllProtectPlans(): Promise<StorageStats[]> {
+        const { authCookie, csrfToken } = await this._authenticate()
+        const { data: protectUsage } = await this._egnyteRequest(
+            `/msp/usage_stats/${this.resellerId}/${this._config.protectPlanId}/`,
+            {
+                headers: { cookie: authCookie, 'X-CSRFToken': csrfToken },
+            },
+        )
+
+        return protectUsage
+    }
+
     /**
      * Updates a plan's power user licensing count. This will result in a billing change from egnyte. Must be increased in increments of 5
      * @param planId the planId to update licensing for
@@ -436,5 +486,3 @@ class Egnyte {
         }
     }
 }
-
-export = Egnyte