Feat: add draft for data module

src/api/config/index.ts

@@ -0,0 +1,23 @@
+import type { Grade } from "../type";
+import type { Config } from "./type";
+
+export const CONFIG: Config = {
+  study: {
+    organization: "DaleStudy",
+    repository: "leetcode-study",
+    branchName: "main",
+    teamPrefix: "leetcode",
+    totalProblemCount: 75,
+    gradeThresholds: [
+      ["BIG_TREE", 70],
+      ["SMALL_TREE", 60],
+      ["SPROUT", 50],
+      ["SEED", 0],
+    ] as [Grade, number][],
+  },
+  gitHub: {
+    baseUrl: "https://api.github.com",
+    mediaType: "application/vnd.github+json",
+    token: process.env.GITHUB_TOKEN ?? "",
+  },
+} as const;

src/api/config/type.ts

@@ -0,0 +1,21 @@
+import { Grade } from "../type";
+
+export type StudyConfig = {
+  organization: string;
+  repository: string;
+  branchName: string;
+  teamPrefix: string;
+  totalProblemCount: number;
+  gradeThresholds: [Grade, number][];
+};
+
+export type GitHubConfig = {
+  baseUrl: string;
+  mediaType: string;
+  token: string;
+};
+
+export type Config = {
+  study: StudyConfig;
+  gitHub: GitHubConfig;
+};

src/api/index.ts

@@ -0,0 +1,9 @@
+import { CONFIG } from "./config";
+import { createStoreService } from "./services/store/storeService";
+
+export const leaderBoardStore = await createStoreService(CONFIG);
+
+console.log(await leaderBoardStore.getData());
+console.log(await leaderBoardStore.getMemberById("hc"));
+console.log(await leaderBoardStore.getMemberByCohort(1));
+console.log(await leaderBoardStore.getMemberByGrade("SEED"));

src/api/infra/gitHub/fixtures.ts

@@ -0,0 +1,98 @@
+import type { GitHubTeam, GitHubMember, GitHubTree } from "./types";
+
+export const mockGitHubTeams: GitHubTeam[] = [
+  {
+    name: "leetcode01",
+    id: 1,
+    node_id: "T",
+    slug: "leetcode01",
+    description: "리트코드 스터디",
+    privacy: "closed",
+    notification_setting: "notifications_enabled",
+    url: "some-url",
+    html_url: "some-url",
+    members_url: "members-url",
+    repositories_url: "repositories-url",
+    permission: "pull",
+    parent: null,
+  },
+  {
+    name: "leetcode02",
+    id: 2,
+    node_id: "D",
+    slug: "leetcode",
+    description: "리트코드 스터디",
+    privacy: "closed",
+    notification_setting: "notifications_enabled",
+    url: "some-url",
+    html_url: "some-url",
+    members_url: "members-url",
+    repositories_url: "repositories-url",
+    permission: "pull",
+    parent: null,
+  },
+];
+
+export const mockGitHubMembers: GitHubMember[] = [
+  {
+    login: "D",
+    id: 1,
+    node_id: "M",
+    avatar_url: "avatar-url",
+    gravatar_id: "",
+    url: "some-url",
+    html_url: "some-url",
+    followers_url: "some-url",
+    following_url: "some-url",
+    gists_url: "some-url",
+    starred_url: "some-url",
+    subscriptions_url: "some-url",
+    organizations_url: "some-url",
+    repos_url: "some-url",
+    events_url: "some-url",
+    received_events_url: "some-url",
+    type: "User",
+    user_view_type: "public",
+    site_admin: false,
+  },
+  {
+    login: "S",
+    id: 2,
+    node_id: "E",
+    avatar_url: "avatar-url",
+    gravatar_id: "",
+    url: "some-url",
+    html_url: "some-url",
+    followers_url: "some-url",
+    following_url: "some-url",
+    gists_url: "some-url",
+    starred_url: "some-url",
+    subscriptions_url: "some-url",
+    organizations_url: "some-url",
+    repos_url: "some-url",
+    events_url: "some-url",
+    received_events_url: "some-url",
+    type: "User",
+    user_view_type: "public",
+    site_admin: false,
+  },
+];
+
+export const mockGitHubTree: GitHubTree[] = [
+  {
+    path: "best-time-to-buy-and-sell-stock/test.java",
+    type: "blob",
+    mode: "100644",
+    sha: "1",
+    size: 0,
+    url: "some-url",
+  },
+  {
+    path: "best-time-to-buy-and-sell-stock/test2.java",
+    type: "blob",
+    mode: "100644",
+    sha: "2",
+    size: 0,
+    url: "some-url",
+  },
+];

src/api/infra/gitHub/gitHubClient.test.ts

@@ -0,0 +1,122 @@
+import { test, expect, beforeEach, vi } from "vitest";
+import { createGitHubClient } from "./gitHubClient";
+import { CONFIG } from "../../config";
+import { mockGitHubTeams, mockGitHubMembers, mockGitHubTree } from "./fixtures";
+
+const mockConfig = {
+  ...CONFIG.gitHub,
+  token: "test-token",
+};
+
+const mockFetch = vi.fn();
+global.fetch = mockFetch;
+
+beforeEach(() => {
+  mockFetch.mockClear();
+});
+
+test("getTeamNames should fetch and return team names", async () => {
+  // Arrange
+  mockFetch.mockResolvedValue({
+    ok: true,
+    json: () => Promise.resolve(mockGitHubTeams),
+  });
+  const client = createGitHubClient(mockConfig);
+  const expectedUrl = `${mockConfig.baseUrl}/orgs/test-org/teams`;
+  const expectedHeaders = {
+    Accept: mockConfig.mediaType,
+    Authorization: `token ${mockConfig.token}`,
+  };
+
+  // Act
+  const result = await client.getTeamNames("test-org");
+
+  // Assert
+  expect(mockFetch).toHaveBeenCalledWith(expectedUrl, {
+    headers: expectedHeaders,
+  });
+  expect(result).toEqual(["leetcode01", "leetcode02"]);
+});
+
+test("getTeamNames should throw error when fetch fails", async () => {
+  // Arrange
+  mockFetch.mockResolvedValue({
+    ok: false,
+    status: 404,
+    statusText: "Not Found",
+  });
+  const client = createGitHubClient(mockConfig);
+
+  // Act & Assert
+  await expect(client.getTeamNames("test-org")).rejects.toThrow(
+    "Failed to fetch url",
+  );
+});
+
+test("getTeamMembers should fetch and return team members", async () => {
+  // Arrange
+  mockFetch.mockResolvedValue({
+    ok: true,
+    json: () => Promise.resolve(mockGitHubMembers),
+  });
+  const client = createGitHubClient(mockConfig);
+  const expectedUrl = `${mockConfig.baseUrl}/orgs/test-org/teams/test-team/members`;
+  const expectedHeaders = {
+    Accept: mockConfig.mediaType,
+    Authorization: `token ${mockConfig.token}`,
+  };
+
+  // Act
+  const result = await client.getTeamMembers("test-org", "test-team");
+
+  // Assert
+  expect(mockFetch).toHaveBeenCalledWith(expectedUrl, {
+    headers: expectedHeaders,
+  });
+  expect(result).toEqual(mockGitHubMembers);
+});
+
+test("getDirectoryTree should fetch and return directory tree", async () => {
+  // Arrange
+  mockFetch.mockResolvedValue({
+    ok: true,
+    json: () => Promise.resolve({ tree: mockGitHubTree }),
+  });
+  const client = createGitHubClient(mockConfig);
+  const expectedUrl = `${mockConfig.baseUrl}/repos/test-owner/test-repo/git/trees/main?recursive=1`;
+  const expectedHeaders = {
+    Accept: mockConfig.mediaType,
+    Authorization: `token ${mockConfig.token}`,
+  };
+
+  // Act
+  const result = await client.getDirectoryTree(
+    "test-owner",
+    "test-repo",
+    "main",
+  );
+
+  // Assert
+  expect(mockFetch).toHaveBeenCalledWith(expectedUrl, {
+    headers: expectedHeaders,
+  });
+  expect(result).toEqual(mockGitHubTree);
+});
+
+test("error should include detailed information", async () => {
+  // Arrange
+  const status = 403;
+  const statusText = "Forbidden";
+  mockFetch.mockResolvedValue({
+    ok: false,
+    status,
+    statusText,
+  });
+  const client = createGitHubClient(mockConfig);
+  const expectedErrorMessage = `Failed to fetch url: ${mockConfig.baseUrl}/orgs/test-org/teams, status: ${status}, statusText: ${statusText}`;
+
+  // Act & Assert
+  await expect(client.getTeamNames("test-org")).rejects.toThrow(
+    expectedErrorMessage,
+  );
+});

src/api/infra/gitHub/gitHubClient.ts

@@ -0,0 +1,54 @@
+import type { GitHubConfig } from "../../config/type";
+import type {
+  GitHubMember,
+  GitHubTeam,
+  GitHubTree,
+  GitHubTreeResponse,
+} from "./types";
+
+export const createGitHubClient = (config: GitHubConfig) => {
+  const request = async (url: string, token: string): Promise<unknown> => {
+    const response = await fetch(url, {
+      headers: {
+        Accept: config.mediaType,
+        Authorization: `token ${token}`,
+      },
+    });
+
+    if (!response.ok) {
+      throw new Error(
+        `Failed to fetch url: ${url}, status: ${response.status}, statusText: ${response.statusText}`,
+      );
+    }
+
+    return response.json();
+  };
+
+  return {
+    getTeamNames: async (organization: string): Promise<string[]> =>
+      request(
+        `${config.baseUrl}/orgs/${organization}/teams`,
+        config.token,
+      ).then((response) => (response as GitHubTeam[]).map((team) => team.name)),
+
+    getTeamMembers: async (
+      organization: string,
+      teamName: string,
+    ): Promise<GitHubMember[]> =>
+      request(
+        `${config.baseUrl}/orgs/${organization}/teams/${teamName}/members`,
+        config.token,
+      ).then((response) => response as GitHubMember[]),
+
+    getDirectoryTree: async (
+      owner: string,
+      repo: string,
+      treeSha: string,
+      recursive = 1,
+    ): Promise<GitHubTree[]> =>
+      request(
+        `${config.baseUrl}/repos/${owner}/${repo}/git/trees/${treeSha}?recursive=${recursive}`,
+        config.token,
+      ).then((response) => (response as GitHubTreeResponse).tree),
+  };
+};

src/api/infra/gitHub/types.ts

@@ -0,0 +1,52 @@
+export type GitHubTeam = {
+  name: string;
+  id: number;
+  node_id: string;
+  slug: string;
+  description: string;
+  privacy: string;
+  notification_setting: string;
+  url: string;
+  html_url: string;
+  members_url: string;
+  repositories_url: string;
+  permission: string;
+  parent: null;
+};
+
+export type GitHubMember = {
+  login: string;
+  id: number;
+  node_id: string;
+  avatar_url: string;
+  gravatar_id: string;
+  url: string;
+  html_url: string;
+  followers_url: string;
+  following_url: string;
+  gists_url: string;
+  starred_url: string;
+  subscriptions_url: string;
+  organizations_url: string;
+  repos_url: string;
+  events_url: string;
+  received_events_url: string;
+  type: string;
+  user_view_type: string;
+  site_admin: boolean;
+};
+
+export type GitHubTreeResponse = {
+  sha: string;
+  url: string;
+  tree: GitHubTree[];
+};
+
+export type GitHubTree = {
+  path: string;
+  mode: string;
+  type: string;
+  size: number;
+  sha: string;
+  url: string;
+};