DEV-170 organization api calls (#21)

* DEV-170 organization api calls

* DEV-170 address pr comments

* DEV-170 lint fixes

* DEV-170 - fix

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

Author: DaleHerring

src/Algorithm.ts

@@ -225,6 +225,20 @@ class Build {
   }
 }
 
+interface Organization {
+  org_contact_name: string;
+  org_email: string;
+  org_label: string;
+  org_name: string;
+  resource_type: string;
+
+  org_url?: string;
+  external_id?: string;
+  external_admin_group_id?: string;
+  external_member_group_id?: string;
+  self_link?: string;
+}
+
 interface AlgorithmVersionsList {
   marker: string;
   next_link: string;
@@ -260,4 +274,5 @@ export {
   AlgorithmVersionsList,
   AlgorithmBuildsList,
   AlgorithmSCMAuthorizationStatus,
+  Organization,
 };

src/AlgorithmiaClient.ts

@@ -2,13 +2,15 @@ import { HttpClient } from './HttpClient';
 import { AlgorithmExecutable } from './AlgorithmExecutable';
 import type { Input } from './ContentTypeHelper';
 import { DataFile, DataDir } from './Data';
+import { URLSearchParams } from 'url';
 
 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 key: string;
   private apiAddress: string;
   private httpClient: HttpClient;
@@ -73,41 +75,20 @@ class AlgorithmiaClient {
     published = true,
     marker?: string
   ) {
-    if (marker == undefined) {
-      return this.httpClient.get(
-        this.apiAddress +
-          this.algorithmsPrefix +
-          '/' +
-          userName +
-          '/' +
-          algoName +
-          '/versions' +
-          '?callable=' +
-          callable +
-          '&limit=' +
-          limit +
-          '&published=' +
-          published
-      );
-    } else {
-      return this.httpClient.get(
-        this.apiAddress +
-          this.algorithmsPrefix +
-          '/' +
-          userName +
-          '/' +
-          algoName +
-          '/versions' +
-          '?callable=' +
-          callable +
-          '&limit=' +
-          limit +
-          '&published=' +
-          published +
-          '&marker=' +
-          marker
-      );
+    const path = `${this.algorithmsPrefix}/${userName}/${algoName}/versions`;
+    const params = new URLSearchParams({
+      callable: callable.toString(),
+      limit: limit.toString(),
+      published: published.toString(),
+    });
+
+    if (marker) {
+      params.set('marker', marker);
     }
+
+    const search = `?${params.toString()}`;
+
+    return this.httpClient.get(`${this.apiAddress}${path}${search}`);
   }
 
   /**
@@ -124,33 +105,18 @@ class AlgorithmiaClient {
     limit = 50,
     marker?: string
   ) {
-    if (marker == undefined) {
-      return this.httpClient.get(
-        this.apiAddress +
-          this.algorithmsPrefix +
-          '/' +
-          userName +
-          '/' +
-          algoName +
-          '/builds' +
-          '?limit=' +
-          limit
-      );
-    } else {
-      return this.httpClient.get(
-        this.apiAddress +
-          this.algorithmsPrefix +
-          '/' +
-          userName +
-          '/' +
-          algoName +
-          '/builds' +
-          '?limit=' +
-          limit +
-          '&marker=' +
-          marker
-      );
+    const path = `${this.algorithmsPrefix}/${userName}/${algoName}/builds`;
+    const params = new URLSearchParams({
+      limit: limit.toString(),
+    });
+
+    if (marker) {
+      params.set('marker', marker);
     }
+
+    const search = `?${params.toString()}`;
+
+    return this.httpClient.get(`${this.apiAddress}${path}${search}`);
   }
 
   /**
@@ -161,17 +127,8 @@ class AlgorithmiaClient {
    * @return a BuildLogs object for the specified algorithm
    */
   getAlgoBuildLogs(userName: string, algoName: string, buildId: string) {
-    return this.httpClient.get(
-      this.apiAddress +
-        this.algorithmsPrefix +
-        '/' +
-        userName +
-        '/' +
-        algoName +
-        '/builds/' +
-        buildId +
-        '/logs'
-    );
+    const path = `${this.algorithmsPrefix}/${userName}/${algoName}/builds/${buildId}/logs`;
+    return this.httpClient.get(`${this.apiAddress}${path}`);
   }
 
   /**
@@ -238,6 +195,44 @@ class AlgorithmiaClient {
       return this.httpClient.post(this.apiAddress + this.scmPrefix + '/' + scmId + '/oauth/revoke', {});
   }*/
 
+  /**
+   * Create an organization from this client
+   * @param requestObject object payload
+   * @return an organization object
+   */
+  createOrganization(requestObject: Input) {
+    const contentType = 'application/json';
+    return this.httpClient.post(
+      this.apiAddress + this.organizationPrefix,
+      requestObject,
+      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
+    );
+  }
+
+  /**
+   * Edit an organization from this client
+   * @param orgName the organization name
+   * @param requestObject payload
+   * @return an empty response
+   */
+  editOrganization(orgName: string, requestObject: Input) {
+    return this.httpClient.put(
+      this.apiAddress + this.organizationPrefix + '/' + orgName,
+      JSON.stringify(requestObject)
+    );
+  }
+
   /**
    * Initialize an DataFile object from this client
    * @param path to a data file, e.g., data://.my/foo/bar.txt

src/HttpClient.ts

@@ -54,6 +54,7 @@ class HttpClient {
   }
 
   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();

test/AlgorithmiaClient.test.ts

@@ -5,6 +5,7 @@ import {
   AlgorithmVersionsList,
   AlgorithmBuildsList,
   AlgorithmSCMAuthorizationStatus,
+  Organization,
 } from '../src/Algorithm';
 
 describe('Localisation initialization', () => {
@@ -139,4 +140,53 @@ describe('Localisation initialization', () => {
             expect(response).toBe('');
         });
     });*/
+
+  describe('organization get organization', () => {
+    it('gets an organization', async () => {
+      const organization: Organization = JSON.parse(
+        await Algorithmia.getClient(
+          process.env.ALGORITHMIA_ADMIN_API_KEY,
+          process.env.ALGORITHMIA_TEST_ADDRESS
+        ).getOrganization('a_myOrg15')
+      );
+
+      expect(organization.org_email).toBe('a_myOrg15@algo.com');
+    });
+  });
+
+  describe('organization edit call', () => {
+    it('edits for organization', async () => {
+      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',
+      });
+      expect(response).toBe('');
+    });
+  });
+
+  describe('organization create call', () => {
+    it('creates for organization', async () => {
+      const testOrganization = {
+        org_contact_name: 'some owner',
+        org_email: 'SomeEmail@Whatsittoyou.com',
+        org_label: 'myLabel',
+        org_name: 'MyOrg' + Date.now(),
+      };
+
+      const organization: Organization = JSON.parse(
+        await Algorithmia.getClient(
+          process.env.ALGORITHMIA_ADMIN_API_KEY,
+          process.env.ALGORITHMIA_TEST_ADDRESS
+        ).createOrganization(testOrganization)
+      );
+      expect(organization.org_name).toBe(testOrganization.org_name);
+    });
+  });
 });