Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pre-release renames #128

Merged
merged 2 commits into from
Nov 25, 2024
Merged

Pre-release renames #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d312bb9
refactor: rename TokenScopes to TokenScope
agateau-gg Nov 25, 2024
41d0347
refactor: rename ApiTokens* to APITokens*
agateau-gg Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions pygitguardian/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
IaCScanResult,
)
from .models import (
ApiTokensResponse,
APITokensResponse,
Detail,
Document,
DocumentSchema,
Expand Down Expand Up @@ -355,15 +355,15 @@ def health_check(self) -> HealthCheckResponse:

def api_tokens(
self, token: Optional[str] = None
) -> Union[Detail, ApiTokensResponse]:
) -> Union[Detail, APITokensResponse]:
"""
api_tokens retrieves details of an API token
If no token is passed, the endpoint retrieves details for the current API token.

use Detail.status_code to check the response status code of the API

200 if server is online, return token details
:return: Detail or ApiTokensReponse and status code
:return: Detail or APITokensReponse and status code
"""
try:
if not token:
Expand All @@ -376,7 +376,7 @@ def api_tokens(
result.status_code = 504
else:
if resp.ok:
result = ApiTokensResponse.from_dict(resp.json())
result = APITokensResponse.from_dict(resp.json())
else:
result = load_detail(resp)
result.status_code = resp.status_code
Expand Down
16 changes: 8 additions & 8 deletions pygitguardian/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -767,7 +767,7 @@ class TokenStatus(str, Enum):
REVOKED = "revoked"


class TokenScopes(str, Enum):
class TokenScope(str, Enum):
SCAN = "scan"
INCIDENTS_READ = "incidents:read"
INCIDENTS_WRITE = "incidents:write"
Expand All @@ -788,7 +788,7 @@ class TokenScopes(str, Enum):
NHI_WRITE = "nhi:write"


class ApiTokensResponseSchema(BaseSchema):
class APITokensResponseSchema(BaseSchema):
id = fields.UUID(required=True)
name = fields.String(required=True)
workspace_id = fields.Int(required=True)
Expand All @@ -800,17 +800,17 @@ class ApiTokensResponseSchema(BaseSchema):
revoked_at = fields.AwareDateTime(allow_none=True)
member_id = fields.Int(allow_none=True)
creator_id = fields.Int(allow_none=True)
scopes = fields.List(fields.Enum(TokenScopes, by_value=True), required=False)
scopes = fields.List(fields.Enum(TokenScope, by_value=True), required=False)

@post_load
def make_api_tokens_response(
self, data: Dict[str, Any], **kwargs: Any
) -> "ApiTokensResponse":
return ApiTokensResponse(**data)
) -> "APITokensResponse":
return APITokensResponse(**data)


class ApiTokensResponse(Base, FromDictMixin):
SCHEMA = ApiTokensResponseSchema()
class APITokensResponse(Base, FromDictMixin):
SCHEMA = APITokensResponseSchema()

def __init__(
self,
Expand All @@ -825,7 +825,7 @@ def __init__(
revoked_at: Optional[datetime] = None,
member_id: Optional[int] = None,
creator_id: Optional[int] = None,
scopes: Optional[List[TokenScopes]] = None,
scopes: Optional[List[TokenScope]] = None,
):
self.id = id
self.name = name
Expand Down
4 changes: 2 additions & 2 deletions tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
MULTI_DOCUMENT_LIMIT,
)
from pygitguardian.models import (
ApiTokensResponse,
APITokensResponse,
Detail,
HoneytokenResponse,
HoneytokenWithContextResponse,
Expand Down Expand Up @@ -899,7 +899,7 @@ def test_api_tokens(client: GGClient, token):
result = client.api_tokens(token)

assert mock_response.call_count == 1
assert isinstance(result, ApiTokensResponse)
assert isinstance(result, APITokensResponse)


@responses.activate
Expand Down
8 changes: 4 additions & 4 deletions tests/test_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
import pytest

from pygitguardian.models import (
ApiTokensResponse,
ApiTokensResponseSchema,
APITokensResponse,
APITokensResponseSchema,
Detail,
DetailSchema,
Document,
Expand Down Expand Up @@ -66,8 +66,8 @@ def test_document_handle_surrogates(self):
{"detail": "hello", "status_code": 200},
),
(
ApiTokensResponseSchema,
ApiTokensResponse,
APITokensResponseSchema,
APITokensResponse,
{
"id": "5ddaad0c-5a0c-4674-beb5-1cd198d13360",
"name": "myTokenName",
Expand Down
Loading