forked from InterativaDigital/bitbucket-bulk-add-webhook
/
Privileges.php
156 lines (139 loc) · 4.73 KB
/
Privileges.php
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<?php
/**
* This file is part of the bitbucket-api package.
*
* (c) Alexandru G. <alex@gentle.ro>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Bitbucket\API;
use Buzz\Message\MessageInterface;
/**
* Manage the user privileges (permissions) of your repositories. It allows you
* to grant specific users access to read, write and or administer your repositories.
*
* @author Alexandru G. <alex@gentle.ro>
*/
class Privileges extends Api
{
/**
* Get a list of user privileges granted on a repository.
*
* @access public
* @param string $account Owner of the repository.
* @param string $repo Repository identifier.
* @param string $privilege Filters for a particular privilege.
* @return MessageInterface
*
* @throws \InvalidArgumentException
*/
public function repository($account, $repo, $privilege = null)
{
return $this->requestGet(
sprintf('privileges/%s/%s', $account, $repo),
$this->getRepoParams($privilege)
);
}
/**
* Get privileges for an individual.
*
* @access public
* @param string $owner Owner of the repository.
* @param string $repo Repository identifier.
* @param string $account The account to list privileges for.
* @return MessageInterface
*/
public function account($owner, $repo, $account)
{
return $this->requestGet(
sprintf('privileges/%s/%s/%s', $owner, $repo, $account)
);
}
/**
* Get a list of all privileges across all an account's repositories.
*
* If a repository has no individual users with privileges, it does not appear in this list.
*
* @access public
* @param string $account Owner of the repository.
* @param string $privilege Filters for a particular privilege.
* @return MessageInterface
*
* @throws \InvalidArgumentException
*/
public function repositories($account, $privilege = null)
{
return $this->requestGet(
sprintf('privileges/%s', $account),
$this->getRepoParams($privilege)
);
}
/**
* Grants an account a privilege on a repository.
*
* @access public
* @param string $owner Owner of the repository.
* @param string $repo Repository identifier.
* @param string $account The account to list privileges for.
* @param string $privilege The privilege to assign.
* @return MessageInterface
*
* @throws \InvalidArgumentException
*/
public function grant($owner, $repo, $account, $privilege)
{
if (!in_array($privilege, array('read', 'write', 'admin'))) {
throw new \InvalidArgumentException("Invalid privilege provided.");
}
return $this->requestPut(
sprintf('privileges/%s/%s/%s', $owner, $repo, $account),
$privilege
);
}
/**
* Delete account privileges from a repository
*
* if `$account` is specified, then all account privileges will be deleted from repository.
* If `$account` is not specified, then all privileges from repository will be deleted.
* If `repo` is not specified, then all privileges from all repositories will be deleted.
*
* @access public
* @param string $owner Owner of the repository.
* @param string $repo Repository identifier.
* @param string $account The account to list privileges for.
* @return MessageInterface
*
* @throws \InvalidArgumentException
*/
public function delete($owner, $repo = null, $account = null)
{
if (!is_null($account) && is_null($repo)) {
throw new \InvalidArgumentException("To delete an account privileges, you need to specify a repository.");
}
$endpoint = sprintf('privileges/%s', $owner);
if (!is_null($repo)) {
$endpoint .= '/'.$repo;
}
if (!is_null($account)) {
$endpoint .= '/'.$account;
}
return $this->requestDelete($endpoint);
}
/**
* @access public
* @param string $privilege
* @return array
*/
private function getRepoParams($privilege)
{
$params = array();
if (!is_null($privilege)) {
if (!in_array($privilege, array('read', 'write', 'admin'))) {
throw new \InvalidArgumentException("Invalid privilege provided.");
}
$params['filter'] = $privilege;
}
return $params;
}
}