Skip to content

Commit a84a07e

Browse files
MrBatschnerMrBatschner
committed
fixes from review feedback
1 parent 3bee6e6 commit a84a07e

File tree

3 files changed

+27
-16
lines changed

3 files changed

+27
-16
lines changed

‎src/github3/actions/secrets.py

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,11 @@ class OrganizationSecret(_Secret):
121121
.. attribute:: updated_at
122122

123123
The timestamp of when the secret was last updated
124+
125+
.. attribute:: visibility
126+
127+
Specifies which type of organization repositories have access to
128+
the secret. Can be one of all, private, selected.
124129
"""
125130

126131
class_name = "OrganizationSecret"
@@ -129,7 +134,9 @@ def _update_attributes(self, secret):
129134
super()._update_attributes(secret)
130135
self.visibility = secret["visibility"]
131136
if self.visibility == "selected":
132-
self._selected_repos_url = secret["selected_repositories_url"]
137+
self.selected_repositories_url = secret[
138+
"selected_repositories_url"
139+
]
133140

134141
def selected_repositories(self, number=-1, etag=""):
135142
"""Iterates over all repositories this secret is visible to.
@@ -152,13 +159,13 @@ def selected_repositories(self, number=-1, etag=""):
152159

153160
return self._iter(
154161
int(number),
155-
self._selected_repos_url,
162+
self.selected_repositories_url,
156163
repos.ShortRepository,
157164
etag=etag,
158165
list_key="repositories",
159166
)
160167

161-
def set_selected_repositories(self, repository_ids: typing.List[int]):
168+
def set_selected_repositories(self, repository_ids: typing.Sequence[int]):
162169
"""Sets the selected repositories this secret is visible to.
163170

164171
:param list[int] repository_ids:
@@ -177,7 +184,7 @@ def set_selected_repositories(self, repository_ids: typing.List[int]):
177184
data = {"selected_repository_ids": repository_ids}
178185

179186
return self._boolean(
180-
self._put(self._selected_repos_url, json=data), 204, 404
187+
self._put(self.selected_repositories_url, json=data), 204, 404
181188
)
182189

183190
def add_selected_repository(self, repository_id: int):
@@ -199,10 +206,10 @@ def add_selected_repository(self, repository_id: int):
199206
"cannot add a repository when visibility is not 'selected'"
200207
)
201208

202-
url = "/".join([self._selected_repos_url, str(repository_id)])
209+
url = "/".join([self.selected_repositories_url, str(repository_id)])
203210
return self._boolean(self._put(url), 204, 409)
204211

205-
def delete_selected_repository(self, repository_id: int):
212+
def remove_selected_repository(self, repository_id: int):
206213
"""Deletes a repository from the list of repositories this secret is
207214
visible to.
208215

@@ -222,5 +229,5 @@ def delete_selected_repository(self, repository_id: int):
222229
"cannot delete a repository when visibility is not 'selected'"
223230
)
224231

225-
url = "/".join([self._selected_repos_url, str(repository_id)])
232+
url = "/".join([self.selected_repositories_url, str(repository_id)])
226233
return self._boolean(self._delete(url), 204, 409)

‎tests/integration/test_orgs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,7 @@ def test_delete_repo_from_shared_secret(self):
594594
[shared_repo_id_1, shared_repo_id_2],
595595
)
596596

597-
success = secret.delete_selected_repository(shared_repo_id_2)
597+
success = secret.remove_selected_repository(shared_repo_id_2)
598598
assert success is True
599599

600600
shared_repos = secret.selected_repositories()

‎tests/unit/test_secrets.py

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ def test_set_selected_respositories(self):
4444
"""
4545
self.instance.set_selected_repositories([123])
4646
self.session.put.assert_called_once_with(
47-
self.instance._selected_repos_url,
47+
self.instance.selected_repositories_url,
4848
json={"selected_repository_ids": [123]},
4949
)
5050

@@ -61,17 +61,21 @@ def test_add_selected_repository(self):
6161
"""
6262
Show that adding a selected repository does the proper HTTP request.
6363
"""
64-
add_repo_url = "/".join([self.instance._selected_repos_url, str(123)])
64+
add_repo_url = "/".join(
65+
[self.instance.selected_repositories_url, str(123)]
66+
)
6567
_ = self.instance.add_selected_repository(123)
6668

6769
self.session.put.assert_called_once_with(add_repo_url)
6870

69-
def test_delete_selected_repository(self):
71+
def test_remove_selected_repository(self):
7072
"""
7173
Show that deleting a selected repository does the proper HTTP request.
7274
"""
73-
del_repo_url = "/".join([self.instance._selected_repos_url, str(123)])
74-
_ = self.instance.delete_selected_repository(123)
75+
del_repo_url = "/".join(
76+
[self.instance.selected_repositories_url, str(123)]
77+
)
78+
_ = self.instance.remove_selected_repository(123)
7579

7680
self.session.delete.assert_called_once_with(del_repo_url)
7781

@@ -94,10 +98,10 @@ def test_delete_repository_on_non_selected_visibility(self):
9498
"""
9599
self.instance.visibility = "all"
96100
with pytest.raises(ValueError):
97-
self.instance.delete_selected_repository(123)
101+
self.instance.remove_selected_repository(123)
98102
self.instance.visibility = "private"
99103
with pytest.raises(ValueError):
100-
self.instance.delete_selected_repository(123)
104+
self.instance.remove_selected_repository(123)
101105

102106

103107
class TestOrganizationSecretIterators(helper.UnitIteratorHelper):
@@ -112,7 +116,7 @@ def test_shared_repositories(self):
112116
self.get_next(i)
113117

114118
self.session.get.assert_called_once_with(
115-
self.instance._selected_repos_url,
119+
self.instance.selected_repositories_url,
116120
params={"per_page": 100},
117121
headers={},
118122
)

0 commit comments

Comments
 (0)