Skip to content

Commit bf46665

Browse files
authored
Merge pull request #128 from GitGuardian/agateau/renames
Pre-release renames
2 parents df41f12 + 41d0347 commit bf46665

File tree

4 files changed

+18
-18
lines changed

4 files changed

+18
-18
lines changed

pygitguardian/client.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
IaCScanResult,
2626
)
2727
from .models import (
28-
ApiTokensResponse,
28+
APITokensResponse,
2929
Detail,
3030
Document,
3131
DocumentSchema,
@@ -355,15 +355,15 @@ def health_check(self) -> HealthCheckResponse:
355355

356356
def api_tokens(
357357
self, token: Optional[str] = None
358-
) -> Union[Detail, ApiTokensResponse]:
358+
) -> Union[Detail, APITokensResponse]:
359359
"""
360360
api_tokens retrieves details of an API token
361361
If no token is passed, the endpoint retrieves details for the current API token.
362362
363363
use Detail.status_code to check the response status code of the API
364364
365365
200 if server is online, return token details
366-
:return: Detail or ApiTokensReponse and status code
366+
:return: Detail or APITokensReponse and status code
367367
"""
368368
try:
369369
if not token:
@@ -376,7 +376,7 @@ def api_tokens(
376376
result.status_code = 504
377377
else:
378378
if resp.ok:
379-
result = ApiTokensResponse.from_dict(resp.json())
379+
result = APITokensResponse.from_dict(resp.json())
380380
else:
381381
result = load_detail(resp)
382382
result.status_code = resp.status_code

pygitguardian/models.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -767,7 +767,7 @@ class TokenStatus(str, Enum):
767767
REVOKED = "revoked"
768768

769769

770-
class TokenScopes(str, Enum):
770+
class TokenScope(str, Enum):
771771
SCAN = "scan"
772772
INCIDENTS_READ = "incidents:read"
773773
INCIDENTS_WRITE = "incidents:write"
@@ -788,7 +788,7 @@ class TokenScopes(str, Enum):
788788
NHI_WRITE = "nhi:write"
789789

790790

791-
class ApiTokensResponseSchema(BaseSchema):
791+
class APITokensResponseSchema(BaseSchema):
792792
id = fields.UUID(required=True)
793793
name = fields.String(required=True)
794794
workspace_id = fields.Int(required=True)
@@ -800,17 +800,17 @@ class ApiTokensResponseSchema(BaseSchema):
800800
revoked_at = fields.AwareDateTime(allow_none=True)
801801
member_id = fields.Int(allow_none=True)
802802
creator_id = fields.Int(allow_none=True)
803-
scopes = fields.List(fields.Enum(TokenScopes, by_value=True), required=False)
803+
scopes = fields.List(fields.Enum(TokenScope, by_value=True), required=False)
804804

805805
@post_load
806806
def make_api_tokens_response(
807807
self, data: Dict[str, Any], **kwargs: Any
808-
) -> "ApiTokensResponse":
809-
return ApiTokensResponse(**data)
808+
) -> "APITokensResponse":
809+
return APITokensResponse(**data)
810810

811811

812-
class ApiTokensResponse(Base, FromDictMixin):
813-
SCHEMA = ApiTokensResponseSchema()
812+
class APITokensResponse(Base, FromDictMixin):
813+
SCHEMA = APITokensResponseSchema()
814814

815815
def __init__(
816816
self,
@@ -825,7 +825,7 @@ def __init__(
825825
revoked_at: Optional[datetime] = None,
826826
member_id: Optional[int] = None,
827827
creator_id: Optional[int] = None,
828-
scopes: Optional[List[TokenScopes]] = None,
828+
scopes: Optional[List[TokenScope]] = None,
829829
):
830830
self.id = id
831831
self.name = name

tests/test_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
MULTI_DOCUMENT_LIMIT,
2424
)
2525
from pygitguardian.models import (
26-
ApiTokensResponse,
26+
APITokensResponse,
2727
Detail,
2828
HoneytokenResponse,
2929
HoneytokenWithContextResponse,
@@ -899,7 +899,7 @@ def test_api_tokens(client: GGClient, token):
899899
result = client.api_tokens(token)
900900

901901
assert mock_response.call_count == 1
902-
assert isinstance(result, ApiTokensResponse)
902+
assert isinstance(result, APITokensResponse)
903903

904904

905905
@responses.activate

tests/test_models.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
import pytest
44

55
from pygitguardian.models import (
6-
ApiTokensResponse,
7-
ApiTokensResponseSchema,
6+
APITokensResponse,
7+
APITokensResponseSchema,
88
Detail,
99
DetailSchema,
1010
Document,
@@ -66,8 +66,8 @@ def test_document_handle_surrogates(self):
6666
{"detail": "hello", "status_code": 200},
6767
),
6868
(
69-
ApiTokensResponseSchema,
70-
ApiTokensResponse,
69+
APITokensResponseSchema,
70+
APITokensResponse,
7171
{
7272
"id": "5ddaad0c-5a0c-4674-beb5-1cd198d13360",
7373
"name": "myTokenName",

0 commit comments

Comments
 (0)