feat: ✨ Add basic GitHub auth API

The api can now get user data and primary email.

Author: OnCloud125252

_module/DefaultFallback/default-fallback.controller.ts

@@ -1,6 +1,6 @@
 import { All, Controller, HttpCode } from "@nestjs/common";
 
-import { HttpStatus } from "../../_StatusCode/HTTP";
+import { HttpStatus } from "../../_status-code/HTTP";
 
 
 @Controller("*")

_StatusCode/Custom.ts _status-code/Custom.ts

@@ -1,4 +1,4 @@
-export class GitHubEmailApiResponseDto {
+export class GithubEmailApiResponseDto {
   email: string;
   verified: boolean;
   primary: boolean;

_StatusCode/HTTP.ts _status-code/HTTP.ts

@@ -1,4 +1,4 @@
-export class GitHubUserDataApiResponseDto {
+export class GithubUserDataApiResponseDto {
   login: string;
   id: number;
   node_id: string;

_types/GitHub/email-api-response.dto.ts _types/Github/email-api-response.dto.ts

@@ -0,0 +1,7 @@
+import { GithubEmailApiResponseDto } from "./Github/email-api-response.dto";
+import { GithubUserDataApiResponseDto } from "./Github/user-data-api-response.dto";
+
+
+export class GithubAccountDataDto extends GithubUserDataApiResponseDto {
+  primary_email: GithubEmailApiResponseDto;
+}

_types/GitHub/user-data-api-response.dto.ts _types/Github/user-data-api-response.dto.ts

@@ -0,0 +1,3 @@
+export class GithubAuthCodeDto {
+  code: string;
+}

_types/github-account-data.dto.ts

@@ -1,4 +1,9 @@
-import { Module } from '@nestjs/common';
+import { Module } from "@nestjs/common";
 
-@Module({})
+import { GithubModule } from "./github/github.module";
+
+
+@Module({
+  imports: [GithubModule]
+})
 export class AuthModule {}

_types/github-auth-code.dto.ts

@@ -0,0 +1,20 @@
+import { Test, TestingModule } from "@nestjs/testing";
+
+import { GithubController } from "./github.controller";
+
+
+describe("GithubController", () => {
+  let controller: GithubController;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [GithubController]
+    }).compile();
+
+    controller = module.get<GithubController>(GithubController);
+  });
+
+  it("should be defined", () => {
+    expect(controller).toBeDefined();
+  });
+});

_types/github-code.dto.ts

@@ -0,0 +1,33 @@
+import { Body, Controller, Post, Res } from "@nestjs/common";
+import { Response } from "express";
+
+import { HttpStatus } from "_status-code/HTTP";
+import { GithubAuthCodeDto } from "_types/github-auth-code.dto";
+import { GithubService } from "./github.service";
+
+
+@Controller("auth/github")
+export class GithubController {
+  constructor(private githubService: GithubService) {}
+
+  @Post()
+  async getGitHubAccountData(
+    @Body() data: GithubAuthCodeDto,
+    @Res() res: Response,
+  ) {
+    try {
+      const accountData = await this.githubService.getGitHubAccountData(
+        data.code,
+      );
+
+      return res.status(HttpStatus.OK).json({
+        account_data: accountData
+      });
+    }
+    catch (error) {
+      return res.status(HttpStatus.UNAUTHORIZED).json({
+        error: "Please provide a valid authentication code"
+      });
+    }
+  }
+}

src/auth/auth.module.ts

@@ -0,0 +1,11 @@
+import { Module } from "@nestjs/common";
+
+import { GithubController } from "./github.controller";
+import { GithubService } from "./github.service";
+
+
+@Module({
+  controllers: [GithubController],
+  providers: [GithubService]
+})
+export class GithubModule {}

src/auth/github/github.controller.spec.ts

@@ -0,0 +1,19 @@
+import { Test, TestingModule } from "@nestjs/testing";
+import { GithubService } from "./github.service";
+
+
+describe("GithubService", () => {
+  let service: GithubService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [GithubService]
+    }).compile();
+
+    service = module.get<GithubService>(GithubService);
+  });
+
+  it("should be defined", () => {
+    expect(service).toBeDefined();
+  });
+});

src/auth/github/github.controller.ts

@@ -1,26 +1,29 @@
+import { Injectable } from "@nestjs/common";
 import axios from "axios";
 
-import { GitHubEmailApiResponseDto } from "_types/GitHub/email-api-response.dto";
-import { GitHubUserDataApiResponseDto } from "_types/GitHub/user-data-api-response.dto";
+import { GithubEmailApiResponseDto } from "_types/Github/email-api-response.dto";
+import { GithubUserDataApiResponseDto } from "_types/Github/user-data-api-response.dto";
+import { GithubAccountDataDto } from "_types/github-account-data.dto";
 
 
 const GITHUB_ACCESS_TOKEN_API = "https://github.com/login/oauth/access_token";
 const GITHUB_USER_DATA_API = "https://api.github.com/user";
 const GITHUB_EMAIL_DATA_API = "https://api.github.com/user/emails";
 
-export async function getGitHubAccountData(code: string) {
-  try {
-    const accessToken = await getAccessToken(code);
-    if (!accessToken) {
-      throw new Error("Error while getting access token");
-    }
+@Injectable()
+export class GithubService {
+  async getGitHubAccountData(
+    code: string,
+  ): Promise<GithubAccountDataDto | null> {
+    try {
+      const accessToken = await getAccessToken(code);
+      const accountData = await getAccountData(accessToken);
 
-    const accountData = await getAccountData(accessToken);
-    return accountData;
-  }
-  catch (error) {
-    console.error(error.message);
-    return null;
+      return accountData;
+    }
+    catch (error) {
+      throw new Error("Error while getting GitHub account data");
+    }
   }
 }
 
@@ -48,19 +51,20 @@ async function getAccessToken(code: string): Promise<string | null> {
     return accessToken;
   }
   catch (error) {
-    console.error(error.message);
-    return null;
+    throw new Error("Error while getting access token");
   }
 }
 
-async function getAccountData(accessToken: string): Promise<any | null> {
+async function getAccountData(
+  accessToken: string,
+): Promise<GithubAccountDataDto | null> {
   try {
     const userDataResponse = await axios.get(GITHUB_USER_DATA_API, {
       headers: {
         Authorization: `Bearer ${accessToken}`
       }
     });
-    const userData: GitHubUserDataApiResponseDto | null =
+    const userData: GithubUserDataApiResponseDto | null =
       await userDataResponse.data;
     if (!userData) {
       throw new Error("User data not found");
@@ -71,17 +75,20 @@ async function getAccountData(accessToken: string): Promise<any | null> {
         Authorization: `Bearer ${accessToken}`
       }
     });
-    const userEmails: [GitHubEmailApiResponseDto] | null =
+    const userEmails: [GithubEmailApiResponseDto] | null =
       await userEmailsResponse.data;
     if (!userEmails) {
       throw new Error("User emails not found");
     }
-    const primaryEmail = userEmails.filter((email) => email.primary)[0];
+
+    const primaryEmail = userEmails.find((email) => email.primary);
+    if (!primaryEmail) {
+      throw new Error("Primary email not found");
+    }
 
     return { ...userData, primary_email: primaryEmail };
   }
   catch (error) {
-    console.error(error.message);
-    return null;
+    throw new Error("Error while getting account data");
   }
 }

src/auth/github/github.module.ts

@@ -1,7 +1,4 @@
-import { Body, Controller, Get, Post } from "@nestjs/common";
-
-import { getGitHubAccountData } from "_module/GetGitHubAccountData";
-import { GithubCodeDto } from "_types/github-code.dto";
+import { Controller, Get } from "@nestjs/common";
 
 
 @Controller("test")
@@ -12,10 +9,4 @@ export class TestController {
       message: "test route"
     };
   }
-
-  @Post()
-  async postTest(@Body() GithubCodeDto: GithubCodeDto) {
-    const accountData = await getGitHubAccountData(GithubCodeDto.code);
-    return { data: accountData };
-  }
 }