Merge pull request #9 from PrefectHQ/add_client

Add client

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- `get_client` method and `url` field to `GitLabCredentials` - [#9](https://github.com/PrefectHQ/prefect-gitlab/pull/9)
+
 ### Changed
 
 ### Deprecated
@@ -25,5 +27,5 @@ Released on November 3rd, 2022.
 
 ### Added
 
-- `GitLabRepository` block - [#1](https://github.com/PrefectHQ/prefect-gitlab)
-- `GitLabCredentials` block - [#1](https://github.com/PrefectHQ/prefect-gitlab)
+- `GitLabRepository` block - [#1](https://github.com/PrefectHQ/prefect-gitlab/pull/1)
+- `GitLabCredentials` block - [#1](https://github.com/PrefectHQ/prefect-gitlab/pull/1)

prefect_gitlab/credentials.py

@@ -1,5 +1,6 @@
 """Module used to enable authenticated interactions with GitLab"""
 
+from gitlab import Gitlab
 from prefect.blocks.core import Block
 from pydantic import Field, HttpUrl, SecretStr
 
@@ -10,7 +11,8 @@ class GitLabCredentials(Block):
     repositories.
 
     Attributes:
-        token: personal access token to authenticate with GitLab.
+        token: The personal access token to authenticate with GitLab.
+        url: URL to self-hosted GitLab instances.
 
     Examples:
         Load stored GitLab credentials:
@@ -31,3 +33,18 @@ class GitLabCredentials(Block):
         default=None,
         description="A GitLab Personal Access Token with read_repository scope.",
     )
+    url: str = Field(
+        default=None, title="URL", description="URL to self-hosted GitLab instances."
+    )
+
+    def get_client(self) -> Gitlab:
+        """
+        Gets an authenticated GitLab client.
+
+        Returns:
+            An authenticated GitLab client.
+        """
+        # ref: https://python-gitlab.readthedocs.io/en/stable/
+        gitlab = Gitlab(url=self.url, oauth_token=self.token.get_secret_value())
+        gitlab.auth()
+        return gitlab

requirements.txt

@@ -1,2 +1,2 @@
-prefect>=2.3.0
-pydantic
+prefect>=2.7.0
+python-gitlab>=3.12.0

tests/test_credentials.py

@@ -0,0 +1,17 @@
+from unittest.mock import MagicMock
+
+from prefect_gitlab.credentials import GitLabCredentials
+
+
+def test_gitlab_credentials_get_client(monkeypatch):
+    mock_gitlab = MagicMock()
+    monkeypatch.setattr("prefect_gitlab.credentials.Gitlab", mock_gitlab)
+    gitlab_credentials = GitLabCredentials(
+        url="https://gitlab.example.com", token="my-token"
+    )
+    gitlab_credentials.get_client()
+    mock_gitlab.assert_called_once_with(
+        url=gitlab_credentials.url,
+        oauth_token=gitlab_credentials.token.get_secret_value(),
+    )
+    mock_gitlab.assert_called_once()