Merge pull request #86 from bksh05/feature/endpoint-to-fetch-role-id

[Feature] Add APIs for fetching role information

Author: sahsisunny

src/constants/responses.ts

@@ -27,3 +27,10 @@ export const ROLE_ADDED = "Role added successfully";
 export const NAME_CHANGED = "User nickname changed successfully";
 
 export const ROLE_REMOVED = "Role Removed successfully";
+
+export const ROLE_FETCH_FAILED =
+  "Oops! We are experiencing an issue fetching roles.";
+
+export const BAD_REQUEST = {
+  error: "Oops! This is not a proper request.",
+};

src/controllers/guildRoleHandler.ts

@@ -6,6 +6,8 @@ import {
   addGroupRole,
   createGuildRole,
   removeGuildRole,
+  getGuildRoleByName,
+  getGuildRoles,
 } from "../utils/guildRole";
 import {
   createNewRole,
@@ -68,3 +70,74 @@ export async function removeGuildRoleHandler(request: IRequest, env: env) {
     });
   }
 }
+export async function getGuildRolesHandler(request: IRequest, env: env) {
+  const authHeader = request.headers.get("Authorization");
+
+  if (!authHeader) {
+    return new JSONResponse(response.BAD_SIGNATURE, { status: 401 });
+  }
+  try {
+    await verifyAuthToken(authHeader, env);
+    const roles = await getGuildRoles(env);
+    return new JSONResponse({ roles });
+  } catch (err: any) {
+    const error =
+      err?.message === response.ROLE_FETCH_FAILED
+        ? response.ROLE_FETCH_FAILED
+        : response.INTERNAL_SERVER_ERROR;
+    return new JSONResponse(
+      {
+        error,
+      },
+      {
+        status: 500,
+        headers: {
+          "content-type": "application/json;charset=UTF-8",
+        },
+      }
+    );
+  }
+}
+
+export async function getGuildRoleByRoleNameHandler(
+  request: IRequest,
+  env: env
+) {
+  const authHeader = request.headers.get("Authorization");
+  const roleName = decodeURI(request.params?.roleName ?? "");
+
+  if (!authHeader) {
+    return new JSONResponse(response.BAD_SIGNATURE, { status: 401 });
+  }
+
+  if (!roleName) {
+    return new JSONResponse(response.BAD_REQUEST, { status: 404 });
+  }
+  try {
+    await verifyAuthToken(authHeader, env);
+    const role = await getGuildRoleByName(roleName, env);
+    if (!role) {
+      return new JSONResponse(response.NOT_FOUND, {
+        status: 404,
+        headers: {
+          "content-type": "application/json;charset=UTF-8",
+        },
+      });
+    }
+    return new JSONResponse(role);
+  } catch (err: any) {
+    const error =
+      err?.message === response.ROLE_FETCH_FAILED
+        ? response.ROLE_FETCH_FAILED
+        : response.INTERNAL_SERVER_ERROR;
+    return new JSONResponse(
+      { error },
+      {
+        status: 500,
+        headers: {
+          "content-type": "application/json;charset=UTF-8",
+        },
+      }
+    );
+  }
+}

src/index.ts

@@ -10,6 +10,8 @@ import {
   addGroupRoleHandler,
   createGuildRoleHandler,
   removeGuildRoleHandler,
+  getGuildRoleByRoleNameHandler,
+  getGuildRolesHandler,
 } from "./controllers/guildRoleHandler";
 import { getMembersInServerHandler } from "./controllers/getMembersInServer";
 import { changeNickname } from "./controllers/changeNickname";
@@ -31,6 +33,10 @@ router.put("/roles/add", addGroupRoleHandler);
 
 router.delete("/roles", removeGuildRoleHandler);
 
+router.get("/roles", getGuildRolesHandler);
+
+router.get("/roles/:roleName", getGuildRoleByRoleNameHandler);
+
 router.get("/discord-members", getMembersInServerHandler);
 
 router.get("/member/:id", getGuildMemberDetailsHandler);

src/typeDefinitions/role.types.d.ts

@@ -0,0 +1,12 @@
+export type GuildRole = {
+  id: string;
+  name: string;
+  color: string;
+  hoist: boolean;
+  icon?: string;
+  position?: integer;
+  managed?: boolean;
+  mentionable?: boolean;
+};
+
+export type Role = Pick<GuildRole, "id" | "name">;

src/utils/guildRole.ts

@@ -1,6 +1,7 @@
 import {
   INTERNAL_SERVER_ERROR,
   ROLE_ADDED,
+  ROLE_FETCH_FAILED,
   ROLE_REMOVED,
 } from "../constants/responses";
 import { DISCORD_BASE_URL } from "../constants/urls";
@@ -10,6 +11,7 @@ import {
   guildRoleResponse,
   memberGroupRole,
 } from "../typeDefinitions/discordMessage.types";
+import { GuildRole, Role } from "../typeDefinitions/role.types";
 
 export async function createGuildRole(
   body: createNewRole,
@@ -84,3 +86,38 @@ export async function removeGuildRole(details: memberGroupRole, env: env) {
     return INTERNAL_SERVER_ERROR;
   }
 }
+
+export async function getGuildRoles(env: env): Promise<Array<Role>> {
+  const guildRolesUrl = `${DISCORD_BASE_URL}/guilds/${env.DISCORD_GUILD_ID}/roles`;
+
+  try {
+    const response = await fetch(guildRolesUrl, {
+      method: "GET",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bot ${env.DISCORD_TOKEN}`,
+      },
+    });
+
+    if (!response.ok) {
+      throw new Error(ROLE_FETCH_FAILED);
+    }
+
+    const guildRoles: Array<GuildRole> = await response.json();
+
+    return guildRoles.map((role) => ({
+      id: role.id,
+      name: role.name,
+    }));
+  } catch (err) {
+    throw new Error(ROLE_FETCH_FAILED);
+  }
+}
+
+export async function getGuildRoleByName(
+  roleName: string,
+  env: env
+): Promise<Role | undefined> {
+  const roles = await getGuildRoles(env);
+  return roles?.find((role) => role.name === roleName);
+}

tests/fixtures/fixture.ts

@@ -1,3 +1,4 @@
+import { IRequest } from "itty-router";
 import {
   createNewRole,
   discordMessageRequest,
@@ -95,3 +96,42 @@ export const onlyRoleToBeTagged = {
     value: "1118201414078976192",
   },
 };
+
+export const generateDummyRequestObject = ({
+  url,
+  method,
+  params,
+  query,
+  headers, // Object of key value pair
+}: Partial<IRequest>): IRequest => {
+  return {
+    method: method ?? "GET",
+    url: url ?? "/roles",
+    params: params ?? {},
+    query: query ?? {},
+    headers: new Map(Object.entries(headers ?? {})),
+  };
+};
+
+export const rolesMock = [
+  {
+    id: "1234567889",
+    name: "@everyone",
+    permissions: "",
+    position: 2,
+    color: 2,
+    hoist: true,
+    managed: true,
+    mentionable: true,
+  },
+  {
+    id: "12344567",
+    name: "bot one",
+    permissions: "",
+    position: 2,
+    color: 2,
+    hoist: true,
+    managed: true,
+    mentionable: true,
+  },
+];