platform-samples/github-api/javascript/es2015-nodejs/libs/features/teams.js at cfa2ffd31a193718ea735b4977266b43ebbb3109 · github/platform-samples · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/*
# Teams features

## Setup

```javascript
const GitHubClient = require('../libs/GitHubClient.js').GitHubClient;
const teams = require('../libs/features/teams');


let githubCli = new GitHubClient({
  baseUri: "http://github.at.home/api/v3",
  token: process.env.TOKEN_GHITHUB_ENTERPRISE
}, teams); //<-- add teams features
```
*/

/*
## createTeam

- parameters: `org, name, description, repo_names, privacy, permission`
- return: `Promise`

### Description

`createTeam` creates a team for an organization with permissions on a list of repositories

*/
function createTeam({org, name, description, repo_names, privacy, permission}) {
  return this.postData({path:`/orgs/${org}/teams`, data:{
    name: name,
    description: description,
    repo_names: repo_names,
    privacy: privacy, // secret or closed
    permission: permission // pull, push, admin
  }}).then(response => {
    return response.data;
  });
}

/*
## fetchTeams

- parameters: `org`
- return: `Promise`

### Description

`fetchTeams` gets the list of the teams of the organization

*/
function fetchTeams({org}) {
  return this.getData({path:`/orgs/${org}/teams`})
    .then(response => {
      return response.data;
    });
}

/*
## getTeamByName

- parameters: `org, name`
- return: `Promise`

### Description

`getTeamByName` gets a team by its name

*/
function getTeamByName({org, name}) {
  return this.fetchTeams({org:org})
    .then(teams => {
      return teams.find(team => {
        return team.name == name
      })
    })
}

/*
## updateTeamRepository

- parameters: `teamId, organization, repository, permission`
- return: `Promise`

### Description

`updateTeamRepository` updates permissions of the team on a repository

*/
function updateTeamRepository({teamId, organization, repository, permission}) {
  return this.putData({path:`/teams/${teamId}/repos/${organization}/${repository}`, data:{
    permission: permission
  }}).then(response => {
    return response.data;
  });
}

/*
## addTeamMembership

- parameters: `teamId, userName, role`
- return: `Promise`

### Description

`addTeamMembership` ads role to the team

*/
function addTeamMembership({teamId, userName, role}) {
  return this.putData({path:`/teams/${teamId}/memberships/${userName}`, data:{
    role: role // member, maintener
  }}).then(response => {
    return response.data;
  });
}


module.exports = {
  createTeam: createTeam,
  fetchTeams: fetchTeams,
  getTeamByName: getTeamByName,
  updateTeamRepository: updateTeamRepository,
  addTeamMembership: addTeamMembership
};