Merge pull request #7 from cabinetoffice/add-members-per-team-github-…

…method

Add members per team GitHub method

src/api-sdk/github/github.ts

@@ -1,6 +1,6 @@
-import { GitHubRepos, GitHubMembers, GitHubTeams } from './type';
+import { GitHubRepos, GitHubMembers, GitHubTeams, GitHubMembersPerTeam } from './type';
 import { ApiResponse, ApiErrorResponse } from '../response';
-import { reposMapping, membersMapping, teamsMapping } from './mapping';
+import { reposMapping, membersMapping, teamsMapping, membersPerTeamMapping } from './mapping';
 import { HttpRequest } from '../../http-request';
 
 export class Github {
@@ -19,6 +19,10 @@ export class Github {
         return await this.fetchData<GitHubTeams[]>(url, teamsMapping);
     }
 
+    public async getMembersPerTeam(url: string): Promise<ApiResponse<GitHubMembersPerTeam[]> | ApiErrorResponse> {
+        return await this.fetchData<GitHubMembersPerTeam[]>(url, membersPerTeamMapping);
+    }
+
     private async fetchData<T>(
         url: string,
         mappingFunction: (body: any) => T

src/api-sdk/github/mapping.ts

@@ -1,4 +1,4 @@
-import { GitHubMembers, GitHubRepos, GitHubTeams } from './type';
+import { GitHubMembers, GitHubRepos, GitHubTeams, GitHubMembersPerTeam } from './type';
 
 export const reposMapping = (body: any[]): GitHubRepos[] => {
     return body.map((obj) => ({
@@ -31,3 +31,9 @@ export const teamsMapping = (body: any[]): GitHubTeams[] => {
         members_url: obj.members_url
     }));
 };
+
+export const membersPerTeamMapping = (body: any[]): GitHubMembersPerTeam[] => {
+    return body.map((obj) => ({
+        login: obj.login,
+    }));
+};

src/api-sdk/github/type.ts

@@ -23,3 +23,7 @@ export interface GitHubMembers {
     html_url: string;
     repos_url: string;
 }
+
+export interface GitHubMembersPerTeam {
+    login: string;
+}

test/mock/data.mock.ts

@@ -99,6 +99,20 @@ export const MOCK_TEAM_FETCH_RESPONSE = {
     resource: MOCK_TEAMS
 };
 
+export const MOCK_MEMBERS_PER_TEAM = [
+    {
+        login: 'member1',
+    },
+    {
+        login: 'member2',
+    }
+];
+
+export const MOCK_MEMBERS_PER_TEAM_RESPONSE = {
+    httpStatusCode: 200,
+    resource: MOCK_MEMBERS_PER_TEAM
+};
+
 export const MOCK_ERROR = {
     error: 'Error: test error'
 };

test/unit/api-sdk/api-sdk.spec.ts

@@ -1,4 +1,4 @@
-import { jest, beforeEach, afterEach, describe, test, expect } from '@jest/globals';
+import { beforeEach, describe, test, expect } from '@jest/globals';
 
 import ApiSDK from '../../../src/api-sdk/api-sdk';
 import { HttpRequest } from '../../../src/http-request';
@@ -12,7 +12,7 @@ describe('api-sdk test suites', () => {
         apiSdk = new ApiSDK(new HttpRequest(MOCK_HEADERS));
     });
 
-    test('ApiSDK should have a gitHub property which is an instance of Github class', async () => {
+    test('ApiSDK should have a gitHub property which is an instance of Github class', () => {
         expect(apiSdk.gitHub).toBeInstanceOf(Github);
     });
 });

test/unit/api-sdk/github/github.spec.ts

@@ -11,7 +11,9 @@ import {
     MOCK_TEAMS,
     MOCK_ERROR_RESPONSE,
     MOCK_ERROR,
-    MOCK_UNMAPPED_ENTREE_REPO
+    MOCK_UNMAPPED_ENTREE_REPO,
+    MOCK_MEMBERS_PER_TEAM,
+    MOCK_MEMBERS_PER_TEAM_RESPONSE
 } from '../../../mock/data.mock';
 import { HttpResponse } from '../../../../src/http-request/type';
 
@@ -67,6 +69,14 @@ describe('Github sdk module test suites', () => {
         expect(result).toEqual(MOCK_TEAM_FETCH_RESPONSE);
     });
 
+    test('Should return membersPerTeam data as an object', async () => {
+        httpRequestMock.httpGet.mockResolvedValue(createMockHttpResponse(MOCK_MEMBERS_PER_TEAM));
+
+        const url = 'https://api.github.com/organizations/test_org_id/team/test_team_id/members';
+        const result = await github.getMembersPerTeam(url);
+        expect(result).toEqual(MOCK_MEMBERS_PER_TEAM_RESPONSE);
+    });
+
     test('Should return an object with an error property', async () => {
         httpRequestMock.httpGet.mockResolvedValue(createMockHttpResponse(MOCK_TEAMS, 500, MOCK_ERROR));