fixes from review feedback

MrBatschner · MrBatschner · commit a84a07e210c4 · 2024-05-13T22:24:26.000+02:00
diff --git a/src/github3/actions/secrets.py b/src/github3/actions/secrets.py
@@ -121,6 +121,11 @@ class OrganizationSecret(_Secret):
     .. attribute:: updated_at
 
         The timestamp of when the secret was last updated
+
+    .. attribute:: visibility
+
+        Specifies which type of organization repositories have access to
+        the secret. Can be one of all, private, selected.
     """
 
     class_name = "OrganizationSecret"
@@ -129,7 +134,9 @@ def _update_attributes(self, secret):
         super()._update_attributes(secret)
         self.visibility = secret["visibility"]
         if self.visibility == "selected":
-            self._selected_repos_url = secret["selected_repositories_url"]
+            self.selected_repositories_url = secret[
+                "selected_repositories_url"
+            ]
 
     def selected_repositories(self, number=-1, etag=""):
         """Iterates over all repositories this secret is visible to.
@@ -152,13 +159,13 @@ def selected_repositories(self, number=-1, etag=""):
 
         return self._iter(
             int(number),
-            self._selected_repos_url,
+            self.selected_repositories_url,
             repos.ShortRepository,
             etag=etag,
             list_key="repositories",
         )
 
-    def set_selected_repositories(self, repository_ids: typing.List[int]):
+    def set_selected_repositories(self, repository_ids: typing.Sequence[int]):
         """Sets the selected repositories this secret is visible to.
 
         :param list[int] repository_ids:
@@ -177,7 +184,7 @@ def set_selected_repositories(self, repository_ids: typing.List[int]):
         data = {"selected_repository_ids": repository_ids}
 
         return self._boolean(
-            self._put(self._selected_repos_url, json=data), 204, 404
+            self._put(self.selected_repositories_url, json=data), 204, 404
         )
 
     def add_selected_repository(self, repository_id: int):
@@ -199,10 +206,10 @@ def add_selected_repository(self, repository_id: int):
                 "cannot add a repository when visibility is not 'selected'"
             )
 
-        url = "/".join([self._selected_repos_url, str(repository_id)])
+        url = "/".join([self.selected_repositories_url, str(repository_id)])
         return self._boolean(self._put(url), 204, 409)
 
-    def delete_selected_repository(self, repository_id: int):
+    def remove_selected_repository(self, repository_id: int):
         """Deletes a repository from the list of repositories this secret is
         visible to.
 
@@ -222,5 +229,5 @@ def delete_selected_repository(self, repository_id: int):
                 "cannot delete a repository when visibility is not 'selected'"
             )
 
-        url = "/".join([self._selected_repos_url, str(repository_id)])
+        url = "/".join([self.selected_repositories_url, str(repository_id)])
         return self._boolean(self._delete(url), 204, 409)
diff --git a/tests/integration/test_orgs.py b/tests/integration/test_orgs.py
@@ -594,7 +594,7 @@ def test_delete_repo_from_shared_secret(self):
                 [shared_repo_id_1, shared_repo_id_2],
             )
 
-            success = secret.delete_selected_repository(shared_repo_id_2)
+            success = secret.remove_selected_repository(shared_repo_id_2)
             assert success is True
 
             shared_repos = secret.selected_repositories()
diff --git a/tests/unit/test_secrets.py b/tests/unit/test_secrets.py
@@ -44,7 +44,7 @@ def test_set_selected_respositories(self):
         """
         self.instance.set_selected_repositories([123])
         self.session.put.assert_called_once_with(
-            self.instance._selected_repos_url,
+            self.instance.selected_repositories_url,
             json={"selected_repository_ids": [123]},
         )
 
@@ -61,17 +61,21 @@ def test_add_selected_repository(self):
         """
         Show that adding a selected repository does the proper HTTP request.
         """
-        add_repo_url = "/".join([self.instance._selected_repos_url, str(123)])
+        add_repo_url = "/".join(
+            [self.instance.selected_repositories_url, str(123)]
+        )
         _ = self.instance.add_selected_repository(123)
 
         self.session.put.assert_called_once_with(add_repo_url)
 
-    def test_delete_selected_repository(self):
+    def test_remove_selected_repository(self):
         """
         Show that deleting a selected repository does the proper HTTP request.
         """
-        del_repo_url = "/".join([self.instance._selected_repos_url, str(123)])
-        _ = self.instance.delete_selected_repository(123)
+        del_repo_url = "/".join(
+            [self.instance.selected_repositories_url, str(123)]
+        )
+        _ = self.instance.remove_selected_repository(123)
 
         self.session.delete.assert_called_once_with(del_repo_url)
 
@@ -94,10 +98,10 @@ def test_delete_repository_on_non_selected_visibility(self):
         """
         self.instance.visibility = "all"
         with pytest.raises(ValueError):
-            self.instance.delete_selected_repository(123)
+            self.instance.remove_selected_repository(123)
         self.instance.visibility = "private"
         with pytest.raises(ValueError):
-            self.instance.delete_selected_repository(123)
+            self.instance.remove_selected_repository(123)
 
 
 class TestOrganizationSecretIterators(helper.UnitIteratorHelper):
@@ -112,7 +116,7 @@ def test_shared_repositories(self):
         self.get_next(i)
 
         self.session.get.assert_called_once_with(
-            self.instance._selected_repos_url,
+            self.instance.selected_repositories_url,
             params={"per_page": 100},
             headers={},
         )

Original file line number	Diff line number	Diff line change
`@@ -594,7 +594,7 @@ def test_delete_repo_from_shared_secret(self):`
`594`	`594`	`[shared_repo_id_1, shared_repo_id_2],`
`595`	`595`	`)`
`596`	`596`
`597`		`- success = secret.delete_selected_repository(shared_repo_id_2)`
	`597`	`+ success = secret.remove_selected_repository(shared_repo_id_2)`
`598`	`598`	`assert success is True`
`599`	`599`
`600`	`600`	`shared_repos = secret.selected_repositories()`