DEV-188 - create/edit organization fixes to support type id (#22)

* DEV-188 - create/edit organization fixes to support type id

* DEV-188 code clean up for pr comments

* DEV-188 - cache org types call

* DEV-188 - rename prefixes and update error msg

* DEV-188 - move parse for orgtypes

* DEV-188 - add dev-tech as code owners

* DEV-188 - changes to create/edit organization endpoints

* DEV-188 - addressing type changes from an ever changing backend

* DEV-188 - clone fix

* DEV-188 - add interpreter, fix tests

Co-authored-by: Dale Herring <dale.herring@ruralsourcing.com>

Author: DaleHerring

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changlog
 
+## v2.0.0 - 02/23/2021
+
+----------------
+
+### Changes
+
+- Create organization endpoint now takes in second parameter for user-friendly type name
+- org_url is required
+
+
 ## v1.0.0 - 01/08/2021
 
 -----------------

src/Algorithm.ts

@@ -231,14 +231,26 @@ interface Organization {
   org_label: string;
   org_name: string;
   resource_type: string;
+  type_id: string;
+  org_url: string;
 
-  org_url?: string;
   external_id?: string;
   external_admin_group_id?: string;
   external_member_group_id?: string;
   self_link?: string;
 }
 
+interface OrgTypes {
+  id: string;
+  name: string;
+}
+
+enum OrgType {
+  Basic = 'basic',
+  Legacy = 'legacy',
+  Pro = 'pro'
+}
+
 interface AlgorithmVersionsList {
   marker: string;
   next_link: string;
@@ -275,4 +287,6 @@ export {
   AlgorithmBuildsList,
   AlgorithmSCMAuthorizationStatus,
   Organization,
+  OrgTypes,
+  OrgType
 };

src/AlgorithmiaClient.ts

@@ -3,14 +3,17 @@ import { AlgorithmExecutable } from './AlgorithmExecutable';
 import type { Input } from './ContentTypeHelper';
 import { DataFile, DataDir } from './Data';
 import { URLSearchParams } from 'url';
+import { Organization, OrgType, OrgTypes } from './Algorithm';
 
 class AlgorithmiaClient {
   private defaultApiAddress = 'https://api.algorithmia.com';
   private algoPrefix = '/v1/algo';
   private algorithmsPrefix = '/v1/algorithms';
   private dataPrefix = '/v1/data';
   private scmPrefix = '/v1/scms';
-  private organizationPrefix = '/v1/organizations';
+  private organizationTypePrefix = '/v1/organization';
+  private organizationsPrefix = '/v1/organizations';
+  private typesMapList: OrgTypes[] = [];
   private key: string;
   private apiAddress: string;
   private httpClient: HttpClient;
@@ -200,24 +203,25 @@ class AlgorithmiaClient {
    * @param requestObject object payload
    * @return an organization object
    */
-  createOrganization(requestObject: Input) {
+  async createOrganization(requestObject: Input, type: OrgType) {
     const contentType = 'application/json';
     return this.httpClient.post(
-      this.apiAddress + this.organizationPrefix,
-      requestObject,
+      `${this.apiAddress}${this.organizationsPrefix}`,
+      JSON.stringify(await this.organizationTypeIdChanger(requestObject, type)),
       contentType
-    );
+      );
   }
 
   /**
    * Get an organization from this client
    * @param orgName the organization name
    * @return an organization object
    */
-  getOrganization(orgName: string) {
-    return this.httpClient.get(
-      this.apiAddress + this.organizationPrefix + '/' + orgName
-    );
+  async getOrganization(orgName: string) : Promise<Organization> {
+    const organization: Organization = JSON.parse(await this.httpClient.get(
+        `${this.apiAddress}${this.organizationsPrefix}/${orgName}`
+      ));
+      return organization;
   }
 
   /**
@@ -228,11 +232,44 @@ class AlgorithmiaClient {
    */
   editOrganization(orgName: string, requestObject: Input) {
     return this.httpClient.put(
-      this.apiAddress + this.organizationPrefix + '/' + orgName,
-      JSON.stringify(requestObject)
+      `${this.apiAddress}${this.organizationsPrefix}/${orgName}`, 
+       requestObject
     );
   }
 
+  clone(obj: Input) {
+    return JSON.parse(JSON.stringify(obj));
+  }
+ 
+  /**
+   * Helper for swapping out the type_id value
+   */
+  async organizationTypeIdChanger(requestObject: Input, type: OrgType) {
+    const editedOrganization: Organization = this.clone(requestObject);
+    let isSet = false;
+    if (!this.typesMapList.length) {
+      this.typesMapList = await this.getOrgTypes();
+    }
+    for (var typesMapObject of this.typesMapList) {
+      if(type === typesMapObject.name) {
+        editedOrganization.type_id = typesMapObject.id;
+        isSet = true;
+        break;
+      };
+    }
+    if (!isSet) {
+      throw new Error("No matching organization type found, should be one of 'legacy', 'basic', 'pro'");
+    }
+    return editedOrganization;
+  }
+
+  /**
+   * Get types uuid endpoint
+   */
+  async getOrgTypes() {
+    return JSON.parse(await this.httpClient.get(`${this.apiAddress}${this.organizationTypePrefix}/types`));
+  }
+
   /**
    * Initialize an DataFile object from this client
    * @param path to a data file, e.g., data://.my/foo/bar.txt

src/HttpClient.ts

@@ -34,15 +34,29 @@ class HttpClient {
 
   async post(path: string, data: Input, contentType: string) {
     this.headers['Content-Type'] = contentType;
+    const toString = (data: unknown) =>
+    typeof data === 'string' ? data : JSON.stringify(data, null, 2)
     const response = await this.httpClient.post(
       path,
-      JSON.stringify(data),
+      toString(data),
       this.headers
     );
 
     return response.readBody();
   }
 
+  async put(path: string, data: Input) {
+    this.headers['Content-Type'] = 'application/json';
+    const toString = (data: unknown) =>
+    typeof data === 'string' ? data : JSON.stringify(data, null, 2)
+    const response = await this.httpClient.put(
+      path, 
+      toString(data),
+      this.headers);
+
+    return response.readBody();
+  }
+
   async putJson(path: string, data: Json) {
     const response = await this.httpClient.put(
       path,
@@ -53,13 +67,6 @@ class HttpClient {
     return response.readBody();
   }
 
-  async put(path: string, data: string) {
-    this.headers['Content-Type'] = 'application/json';
-    const response = await this.httpClient.put(path, data, this.headers);
-
-    return response.readBody();
-  }
-
   async delete(path: string) {
     const response = await this.httpClient.del(path, this.headers);
 

test/AlgorithmExecutable.test.ts

@@ -14,7 +14,7 @@ describe('Localisation initialization', () => {
         .algo('nlb/Hello/1.0.0')
         .pipe('foo');
 
-      expect(result).toBe('Hello "foo"');
+      expect(result).toBe('Hello foo');
     });
   });
 });

test/AlgorithmiaClient.test.ts

@@ -6,6 +6,7 @@ import {
   AlgorithmBuildsList,
   AlgorithmSCMAuthorizationStatus,
   Organization,
+  OrgType
 } from '../src/Algorithm';
 
 describe('Localisation initialization', () => {
@@ -143,30 +144,28 @@ describe('Localisation initialization', () => {
 
   describe('organization get organization', () => {
     it('gets an organization', async () => {
-      const organization: Organization = JSON.parse(
+      const organization: Organization = 
         await Algorithmia.getClient(
           process.env.ALGORITHMIA_ADMIN_API_KEY,
           process.env.ALGORITHMIA_TEST_ADDRESS
-        ).getOrganization('a_myOrg15')
-      );
+        ).getOrganization('MyOrg1614039696593');
 
-      expect(organization.org_email).toBe('a_myOrg15@algo.com');
+      expect(organization.org_name).toBe('MyOrg1614039696593');
     });
   });
 
   describe('organization edit call', () => {
     it('edits for organization', async () => {
+      const organization: Organization = 
+        await Algorithmia.getClient(
+          process.env.ALGORITHMIA_ADMIN_API_KEY,
+          process.env.ALGORITHMIA_TEST_ADDRESS
+        ).getOrganization('MyOrg1614118479820');
+      organization.org_email = 'SomeOtherEmail@HowDoYouEven.com'
       const response = await Algorithmia.getClient(
         process.env.ALGORITHMIA_ADMIN_API_KEY,
         process.env.ALGORITHMIA_TEST_ADDRESS
-      ).editOrganization('MyOrg1606332498213', {
-        org_contact_name: 'some owner',
-        org_email: 'SomeEmail@Whatsittoyou.com',
-        org_label: 'myLabel',
-        type_id: '3d40e3b0-d82a-11ea-9a3c-0ee5e2d35097',
-        resource_type: 'organization',
-        id: '3d9a9f41-d82a-11ea-9a3c-0ee5e2d35097',
-      });
+      ).editOrganization(organization.org_name, JSON.stringify(organization));
       expect(response).toBe('');
     });
   });
@@ -178,13 +177,15 @@ describe('Localisation initialization', () => {
         org_email: 'SomeEmail@Whatsittoyou.com',
         org_label: 'myLabel',
         org_name: 'MyOrg' + Date.now(),
+        org_url: 'https://algorithmia.com',
+        resource_type: 'organization'
       };
 
       const organization: Organization = JSON.parse(
         await Algorithmia.getClient(
           process.env.ALGORITHMIA_ADMIN_API_KEY,
           process.env.ALGORITHMIA_TEST_ADDRESS
-        ).createOrganization(testOrganization)
+        ).createOrganization(testOrganization, OrgType.Legacy)
       );
       expect(organization.org_name).toBe(testOrganization.org_name);
     });