feat: Add chat/workspaces with discord map

grid/chat/workspaces/maps/__snapshots__/discord.test.ts.snap

@@ -0,0 +1,23 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`chat/workspaces/discord GetWorkspaces performs correctly 1`] = `
+Ok {
+  "value": Object {
+    "rateLimit": Object {
+      "bucket": "2a0617accf8bb8625c43e2ffeb5b8d5b",
+      "remainingRequests": 0,
+      "remainingRequestsPercentage": 0,
+      "resetAfter": 1,
+      "resetTimestamp": 1645700687000,
+      "totalRequests": 1,
+    },
+    "workspaces": Array [
+      Object {
+        "createdAt": 1643221182610,
+        "id": "935962220104396881",
+        "name": "test server",
+      },
+    ],
+  },
+}
+`;

grid/chat/workspaces/maps/discord.suma

@@ -0,0 +1,180 @@
+profile = "chat/[email protected]"
+provider = "discord"
+
+"""
+GetWorkspaces map
+"""
+map GetWorkspaces {
+  http GET "/users/@me/guilds" {
+    request "application/json" {
+      headers {
+        "Authorization" = `${input.asBot ? 'Bot' : 'Bearer'} ${parameters.accessToken}`
+      }
+    }
+
+    response 200 "application/json" {
+      workspaces = call MapWorkspaces(workspaces = body)
+      rateLimit = call MapRateLimitDetails(headers = headers)
+
+      map result {
+        workspaces = workspaces
+        rateLimit = rateLimit
+      }
+    }
+
+    response {
+      error = call MapDiscordError(
+        statusCode = statusCode,
+        error = body,
+        headers = headers,
+      )
+
+      map error error
+    }
+  }
+}
+
+operation MapWorkspaces {
+  workspaces = args.workspaces.map(workspace => {
+    /**
+     * Returns UNIX timestamp from specified discord snowflake id
+     * More about snowflakes: https://discord.com/developers/docs/reference#snowflakes
+     */
+    const discordEpoch = 1420070400000;
+    const getTimestamp = (snowflake) => Number(BigInt(snowflake) >> BigInt(22)) + discordEpoch;
+
+    const resultWorkspace = {
+      id: workspace.id,
+      createdAt: getTimestamp(workspace.id),
+      name: workspace.name,
+    };
+
+    if (workspace.member_count) {
+      resultWorkspace.membersCount = workspace.member_count;
+    }
+
+    if (workspace.icon) {
+      resultWorkspace.icon = workspace.icon;
+    }
+
+    if (workspace.description) {
+      resultWorkspace.description = workspace.description;
+    }
+
+    return resultWorkspace;
+  });
+
+  return workspaces
+}
+
+
+"""
+Operation MapRateLimitDetails
+Returns object mapping rate limit details specified in received headers
+"""
+operation MapRateLimitDetails {
+  headers = args.headers
+  details = {}
+
+  bucket = headers['x-ratelimit-bucket']
+  totalRequests = parseInt(headers['x-ratelimit-limit'])
+  remainingRequests = parseInt(headers['x-ratelimit-remaining'])
+  resetTimestamp = parseFloat(headers['x-ratelimit-reset'])
+  resetAfter = parseInt(headers['x-ratelimit-reset-after'])
+  retryAfter = parseInt(headers['Retry-After'])
+
+  set if (bucket) {
+    details.bucket = bucket
+  }
+
+  set if (!isNaN(totalRequests)) {
+    details.totalRequests = totalRequests
+  }
+
+  set if (!isNaN(remainingRequests)) {
+    details.remainingRequests = remainingRequests
+  }
+
+  set if (!isNaN(resetAfter)) {
+    details.resetAfter = resetAfter
+  }
+
+  set if (!isNaN(resetTimestamp)) {
+    details.resetTimestamp = resetTimestamp * 1000
+  }
+
+  set if (!isNaN(retryAfter)) {
+    details.retryAfter = retryAfter
+  }
+
+  set if (details.remainingRequests !== undefined && details.totalRequests) {
+    details.remainingRequestsPercentage = (details.remainingRequests / details.totalRequests) * 100
+  }
+
+  set if (Object.keys(details).length === 0) {
+    details = undefined
+  }
+
+  return details
+}
+
+"""
+Operation Map Discord Error
+Returns error object based on error body, statusCode and headers.
+"""
+operation MapDiscordError {
+  statusCode = args.statusCode
+  discordError = args.error
+  headers = args.headers
+
+  rateLimit = call MapRateLimitDetails(headers = headers)
+  detail = discordError.message
+
+  return if (statusCode === 400) {
+    title = 'Bad request'
+    detail = discordError
+    rateLimit = rateLimit
+  }
+
+  return if (statusCode === 401) {
+    title = 'Unauthorized'
+    detail = detail
+    rateLimit = rateLimit
+  }
+
+  return if (statusCode === 403) {
+    title = 'Forbidden'
+    detail = detail
+    rateLimit = rateLimit
+  }
+
+  return if (statusCode === 404) {
+    title = 'Not found'
+    detail = detail
+    rateLimit = rateLimit
+  }
+
+  return if (statusCode === 405) {
+    title = 'Method not allowed'
+    detail = detail
+    rateLimit = rateLimit
+  }
+
+  return if (statusCode === 429) {
+    title = 'Too Many Requests'
+    detail = `${detail} Retry after ${discordError.retry_after} seconds`
+    rateLimit = rateLimit
+  }
+
+  return if (statusCode === 502) {
+    title = 'Bad gateway'
+    detail = detail
+    rateLimit = rateLimit
+  }
+
+  return {
+    title = 'Unknown error'
+    detail = `Unknown error occurred. Status: ${statusCode}. Message: ${detail}.`
+    rateLimit = rateLimit
+  }
+}

grid/chat/workspaces/maps/discord.test.ts

@@ -0,0 +1,3 @@
+import { getWorkspacesTest } from './workspaces';
+
+getWorkspacesTest('discord');

grid/chat/workspaces/maps/mock.suma

@@ -0,0 +1,25 @@
+profile = "chat/[email protected]"
+provider = "mock"
+
+"""
+GetWorkspaces map
+"""
+map GetWorkspaces {
+  map result {
+    workspaces = [
+      {
+        id: '1',
+        createdAt: 1643798532134.069,
+        name: 'workspace',
+        membersCount: 100,
+      },
+      {
+        id: '2',
+        createdAt: 1643216443234.079,
+        name: 'workspace 2',
+        membersCount: 4,
+        description: 'Test workspace',
+      }
+    ]
+  }
+}

grid/chat/workspaces/maps/mock.test.ts

@@ -0,0 +1,21 @@
+import { SuperfaceClient } from '@superfaceai/one-sdk';
+
+describe('chat/workspaces/mock', () => {
+  describe('GetWorkspaces', () => {
+    it('performs correctly', async () => {
+      const client = new SuperfaceClient();
+      const profile = await client.getProfile('chat/workspaces');
+      const provider = await client.getProvider('mock');
+      const usecase = profile.getUseCase('GetWorkspaces');
+
+      expect(provider).not.toBeUndefined();
+      expect(usecase).not.toBeUndefined();
+
+      const result = await usecase.perform({}, { provider });
+
+      expect(result.isOk() && (result.value as any).workspaces.length).toEqual(
+        2
+      );
+    });
+  });
+});

grid/chat/workspaces/maps/workspaces.ts

@@ -0,0 +1,36 @@
+/* eslint-disable jest/no-export */
+
+import { RecordingProcessOptions, SuperfaceTest } from '@superfaceai/testing';
+
+export const getWorkspacesTest = (
+  provider: string,
+  options?: RecordingProcessOptions
+): void => {
+  describe(`chat/workspaces/${provider}`, () => {
+    let superface: SuperfaceTest;
+
+    describe('GetWorkspaces', () => {
+      beforeAll(() => {
+        superface = new SuperfaceTest({
+          profile: 'chat/workspaces',
+          provider,
+          useCase: 'GetWorkspaces',
+          testInstance: expect,
+        });
+      });
+
+      it('performs correctly', async () => {
+        await expect(
+          superface.run(
+            {
+              input: {
+                asBot: true,
+              },
+            },
+            options
+          )
+        ).resolves.toMatchSnapshot();
+      });
+    });
+  });
+};