Add implementation for Members, Sources and Invitations endpoints

pygitguardian/client.py

@@ -48,14 +48,18 @@
     SecretIncident,
     SecretScanPreferences,
     ServerMetadata,
+    Source,
+    SourceParameters,
     Team,
     TeamInvitation,
     TeamInvitationParameter,
     TeamMember,
     TeamMemberParameter,
+    TeamSourceParameters,
     TeamsParameter,
     UpdateMember,
     UpdateTeam,
+    UpdateTeamSource,
 )
 from .sca_models import (
     ComputeSCAFilesResult,
@@ -1213,3 +1217,64 @@ def delete_team_member(
             return response.status_code
 
         return load_detail(response)
+
+    def list_sources(
+        self,
+        parameters: Optional[SourceParameters] = None,
+        extra_headers: Optional[Dict[str, str]] = None,
+    ) -> Union[Detail, CursorPaginatedResponse[Source]]:
+        response = self.get(
+            endpoint="sources",
+            data=parameters.to_dict() if parameters else {},
+            extra_headers=extra_headers,
+        )
+
+        obj: Union[Detail, CursorPaginatedResponse[Source]]
+        if is_ok(response):
+            obj = CursorPaginatedResponse[Source].from_response(response, Source)
+        else:
+            obj = load_detail(response)
+
+        obj.status_code
+        return obj
+
+    def list_teams_sources(
+        self,
+        team_id: int,
+        parameters: Optional[TeamSourceParameters] = None,
+        extra_headers: Optional[Dict[str, str]] = None,
+    ) -> Union[Detail, CursorPaginatedResponse[Source]]:
+        response = self.get(
+            endpoint=f"teams/{team_id}/sources",
+            data=parameters.to_dict() if parameters else {},
+            extra_headers=extra_headers,
+        )
+
+        obj: Union[Detail, CursorPaginatedResponse[Source]]
+        if is_ok(response):
+            obj = CursorPaginatedResponse[Source].from_response(response, Source)
+        else:
+            obj = load_detail(response)
+
+        obj.status_code
+        return obj
+
+    def update_team_source(
+        self,
+        team_sources: UpdateTeamSource,
+        extra_headers: Optional[Dict[str, str]] = None,
+    ) -> Union[Detail, int]:
+        team_id = team_sources.team_id
+        data = team_sources.to_dict()
+        del data["team_id"]
+
+        response = self.post(
+            endpoint=f"teams/{team_id}/sources",
+            data=data,
+            extra_headers=extra_headers,
+        )
+
+        if response.status_code == 204:
+            return 204
+
+        return load_detail(response)

pygitguardian/config.py

@@ -1,4 +1,4 @@
-DEFAULT_BASE_URI = "http://localhost:3000/exposed"
+DEFAULT_BASE_URI = "https://api.gitguardian.com"
 DEFAULT_API_VERSION = "v1"
 DEFAULT_TIMEOUT = 20.0  # 20s default timeout
 

pygitguardian/models.py

@@ -982,25 +982,70 @@ class Feedback(Base, FromDictMixin):
     answers: List[Answer]
 
 
+@dataclass
+class SecretIncidentStats(Base, FromDictMixin):
+    total: int
+    severity_breakdown: dict[Severity, int]
+
+
+@dataclass
+class SecretIncidentsBreakdown(Base, FromDictMixin):
+    open_secret_incidents: SecretIncidentStats
+    closed_secret_incidents: SecretIncidentStats
+
+
+ScanStatus = Literal[
+    "pending",
+    "running",
+    "canceled",
+    "failed",
+    "too_large",
+    "timeout",
+    "pending_timeout",
+    "finished",
+]
+
+
+@dataclass
+class Scan(Base, FromDictMixin):
+    date: datetime
+    status: ScanStatus
+    failing_reason: str
+    commits_scanned: int
+    branches_scanned: int
+    duration: str
+
+
+SourceHealth = Literal["safe", "unknown", "at_risk"]
+SourceCriticality = Literal["critical", "high", "medium", "low", "unknown"]
+
+
 @dataclass
 class Source(Base, FromDictMixin):
     id: int
     url: str
     type: str
     full_name: str
-    health: Literal["safe", "unknown", "at_risk"]
+    health: SourceHealth
     default_branch: Optional[str]
     default_branch_head: Optional[str]
     open_incidents_count: int
     closed_incidents_count: int
-    secret_incidents_breakdown: Dict[str, Any]  # TODO: add SecretIncidentsBreakdown
+    secret_incidents_breakdown: SecretIncidentsBreakdown
     visibility: Visibility
     external_id: str
-    source_criticality: str
-    last_scan: Optional[Dict[str, Any]]  # TODO: add LastScan
+    source_criticality: SourceCriticality
+    last_scan: Scan
     monitored: bool
 
 
+SourceSchema = cast(
+    Type[BaseSchema],
+    marshmallow_dataclass.class_schema(Source, base_schema=BaseSchema),
+)
+Source.SCHEMA = SourceSchema()
+
+
 @dataclass
 class OccurrenceMatch(Base, FromDictMixin):
     """
@@ -1103,14 +1148,14 @@ class AccessLevel(str, Enum):
     RESTRICTED = "restricted"
 
 
-class PaginationParameter(Base, FromDictMixin):
+class PaginationParameter(ToDictMixin):
     """Pagination mixin used for endpoints that support pagination."""
 
     cursor: str = ""
     per_page: int = 20
 
 
-class SearchParameter(Base, FromDictMixin):
+class SearchParameter(ToDictMixin):
     search: Optional[str] = None
 
 
@@ -1142,7 +1187,7 @@ def from_response(
 
 
 @dataclass
-class MembersParameters(PaginationParameter, SearchParameter, Base, FromDictMixin):
+class MembersParameters(PaginationParameter, SearchParameter, ToDictMixin):
     """
     Members query parameters
     """
@@ -1239,7 +1284,7 @@ class DeleteMember(Base, FromDictMixin):
 DeleteMember.SCHEMA = DeleteMemberSchema()
 
 
-class TeamsParameter(PaginationParameter, SearchParameter, Base, FromDictMixin):
+class TeamsParameter(PaginationParameter, SearchParameter, ToDictMixin):
     is_global: Optional[bool] = None
 
 
@@ -1311,7 +1356,7 @@ class IncidentPermission(str, Enum):
 
 
 @dataclass
-class TeamInvitationParameter(PaginationParameter, Base, FromDictMixin):
+class TeamInvitationParameter(PaginationParameter, ToDictMixin):
     invitation_id: Optional[int] = None
     is_team_leader: Optional[bool] = None
     incident_permission: Optional[IncidentPermission] = None
@@ -1387,7 +1432,7 @@ class Meta:
 CreateTeamInvitation.SCHEMA = CreateTeamInvitationSchema()
 
 
-class TeamMemberParameter(PaginationParameter, SearchParameter, Base, FromDictMixin):
+class TeamMemberParameter(PaginationParameter, SearchParameter, ToDictMixin):
     is_team_leader: Optional[bool] = None
     incident_permission: Optional[IncidentPermission] = None
     member_id: Optional[int] = None
@@ -1440,7 +1485,7 @@ def return_team_membership(self, data: dict[str, Any], **kwargs: dict[str, Any])
 
 
 @dataclass
-class CreateTeamMemberParameter(Base, FromDictMixin):
+class CreateTeamMemberParameter(ToDictMixin):
     send_email: bool
 
 
@@ -1475,3 +1520,48 @@ def return_create_team_membership(
 
 
 CreateTeamMember.SCHEMA = CreateTeamMemberSchema()
+
+
+@dataclass
+class TeamSourceParameters(PaginationParameter, SearchParameter, ToDictMixin):
+    last_scan_status: Optional[ScanStatus] = None
+    type: Optional[str] = None
+    health: Optional[SourceHealth] = None
+    type: Optional[str] = None
+    ordering: Optional[Literal["last_scan_date", "-last_scan_date"]] = None
+    visibility: Optional[Visibility] = None
+    external_id: Optional[str] = None
+
+
+TeamSourceParametersSchema = cast(
+    Type[BaseSchema],
+    marshmallow_dataclass.class_schema(TeamSourceParameters, base_schema=BaseSchema),
+)
+TeamSourceParameters.SCHEMA = TeamSourceParametersSchema()
+
+
+@dataclass
+class UpdateTeamSource(Base, FromDictMixin):
+    team_id: int
+    sources_to_add: list[int]
+    sources_to_remove: list[int]
+
+
+UpdateTeamSourceSchema = cast(
+    Type[BaseSchema],
+    marshmallow_dataclass.class_schema(UpdateTeamSource, base_schema=BaseSchema),
+)
+UpdateTeamSource.SCHEMA = UpdateTeamSourceSchema()
+
+
+@dataclass
+class SourceParameters(TeamSourceParameters):
+    source_criticality: Optional[SourceCriticality] = None
+    monitored: Optional[bool] = None
+
+
+SourceParametersSchema = cast(
+    Type[BaseSchema],
+    marshmallow_dataclass.class_schema(SourceParameters, base_schema=BaseSchema),
+)
+SourceParameters.SCHEMA = SourceParametersSchema()

tests/cassettes/test_add_team_sources.yaml

@@ -0,0 +1,122 @@
+interactions:
+  - request:
+      body: '{"sources_to_add": [126], "sources_to_remove": []}'
+      headers:
+        Accept:
+          - '*/*'
+        Accept-Encoding:
+          - gzip, deflate
+        Connection:
+          - keep-alive
+        Content-Length:
+          - '50'
+        Content-Type:
+          - application/json
+        User-Agent:
+          - pygitguardian/1.18.0 (Darwin;py3.11.8)
+      method: POST
+      uri: https://api.gitguardian.com/v1/teams/9/sources
+    response:
+      body:
+        string: ''
+      headers:
+        Access-Control-Expose-Headers:
+          - X-App-Version
+        Allow:
+          - GET, POST, HEAD, OPTIONS
+        Connection:
+          - keep-alive
+        Content-Length:
+          - '0'
+        Cross-Origin-Opener-Policy:
+          - same-origin
+        Date:
+          - Fri, 06 Dec 2024 12:46:14 GMT
+        Referrer-Policy:
+          - same-origin
+        Server:
+          - nginx/1.24.0
+        Vary:
+          - Cookie
+        X-App-Version:
+          - dev
+        X-Content-Type-Options:
+          - nosniff
+        X-Frame-Options:
+          - DENY
+        X-Request-ID:
+          - 05e58838d26c922add8312a362dba69c
+        X-SCA-Engine-Version:
+          - 2.2.0
+        X-Secrets-Engine-Version:
+          - 2.127.0
+      status:
+        code: 204
+        message: No Content
+  - request:
+      body: type=azure_devops
+      headers:
+        Accept:
+          - '*/*'
+        Accept-Encoding:
+          - gzip, deflate
+        Connection:
+          - keep-alive
+        Content-Length:
+          - '17'
+        Content-Type:
+          - application/x-www-form-urlencoded
+        User-Agent:
+          - pygitguardian/1.18.0 (Darwin;py3.11.8)
+      method: GET
+      uri: https://api.gitguardian.com/v1/teams/9/sources
+    response:
+      body:
+        string: '[{"id":124,"type":"azure_devops","full_name":"gg-integration-test /
+          gg-test / default_branch","health":"at_risk","source_criticality":"unknown","default_branch":"test","default_branch_head":null,"open_incidents_count":19,"closed_incidents_count":0,"last_scan":{"date":"2024-12-06T12:27:52.346395Z","status":"finished","failing_reason":"","commits_scanned":23,"duration":"0.437131","branches_scanned":1,"progress":100},"monitored":true,"visibility":"private","external_id":"05b69081-f346-4022-8784-198f50aed182","secret_incidents_breakdown":{"open_secret_incidents":{"total":19,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":19}},"closed_secret_incidents":{"total":0,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":0}}},"url":"https://dev.azure.com/gg-integration-test/gg-test/_git/default_branch"},{"id":125,"type":"azure_devops","full_name":"gg-integration-test
+          / gg-test / gg-test","health":"at_risk","source_criticality":"unknown","default_branch":"main","default_branch_head":null,"open_incidents_count":19,"closed_incidents_count":0,"last_scan":{"date":"2024-12-06T12:27:52.346418Z","status":"finished","failing_reason":"","commits_scanned":43,"duration":"0.492489","branches_scanned":1,"progress":100},"monitored":true,"visibility":"private","external_id":"7655868e-bb15-47ab-bd62-abd97212e5e8","secret_incidents_breakdown":{"open_secret_incidents":{"total":19,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":19}},"closed_secret_incidents":{"total":0,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":0}}},"url":"https://dev.azure.com/gg-integration-test/gg-test/_git/gg-test"},{"id":126,"type":"azure_devops","full_name":"gg-integration-test
+          / gg-test / huge_repo","health":"safe","source_criticality":"unknown","default_branch":"master","default_branch_head":null,"open_incidents_count":0,"closed_incidents_count":0,"last_scan":{"date":"2024-12-06T12:27:52.346442Z","status":"finished","failing_reason":"","commits_scanned":1007,"duration":"1.102781","branches_scanned":1,"progress":100},"monitored":true,"visibility":"private","external_id":"455c4e0c-6dc3-48ce-a0e7-819d9a8d7523","secret_incidents_breakdown":{"open_secret_incidents":{"total":0,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":0}},"closed_secret_incidents":{"total":0,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":0}}},"url":"https://dev.azure.com/gg-integration-test/gg-test/_git/huge_repo"},{"id":127,"type":"azure_devops","full_name":"gg-integration-test
+          / gg-test / new_repo","health":"safe","source_criticality":"unknown","default_branch":"master","default_branch_head":null,"open_incidents_count":0,"closed_incidents_count":0,"last_scan":{"date":"2024-12-06T12:27:52.346464Z","status":"finished","failing_reason":"","commits_scanned":1,"duration":"0.216094","branches_scanned":1,"progress":100},"monitored":true,"visibility":"private","external_id":"f9b583fb-dcfd-46ec-8938-44b427d3e596","secret_incidents_breakdown":{"open_secret_incidents":{"total":0,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":0}},"closed_secret_incidents":{"total":0,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":0}}},"url":"https://dev.azure.com/gg-integration-test/gg-test/_git/new_repo"},{"id":128,"type":"azure_devops","full_name":"gg-integration-test
+          / gg-test / t e s t i n g","health":"at_risk","source_criticality":"unknown","default_branch":"main","default_branch_head":null,"open_incidents_count":110,"closed_incidents_count":0,"last_scan":{"date":"2024-12-06T12:27:52.346299Z","status":"finished","failing_reason":"","commits_scanned":113,"duration":"7.597231","branches_scanned":2,"progress":100},"monitored":true,"visibility":"private","external_id":"8a132329-0c77-4efc-a18a-882bda6ab28b","secret_incidents_breakdown":{"open_secret_incidents":{"total":110,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":110}},"closed_secret_incidents":{"total":0,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":0}}},"url":"https://dev.azure.com/gg-integration-test/gg-test/_git/t%20e%20s%20t%20i%20n%20g"},{"id":129,"type":"azure_devops","full_name":"gg-integration-test
+          / gg-test / test abc","health":"at_risk","source_criticality":"unknown","default_branch":"main","default_branch_head":null,"open_incidents_count":28,"closed_incidents_count":0,"last_scan":{"date":"2024-12-06T12:27:52.346367Z","status":"finished","failing_reason":"","commits_scanned":55,"duration":"0.623082","branches_scanned":1,"progress":100},"monitored":true,"visibility":"private","external_id":"2aa16b64-2fb2-4639-afeb-70c0c4e8a267","secret_incidents_breakdown":{"open_secret_incidents":{"total":28,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":28}},"closed_secret_incidents":{"total":0,"severity_breakdown":{"critical":0,"high":0,"medium":0,"low":0,"info":0,"unknown":0}}},"url":"https://dev.azure.com/gg-integration-test/gg-test/_git/test%20abc"}]'
+      headers:
+        Access-Control-Expose-Headers:
+          - X-App-Version
+        Allow:
+          - GET, POST, HEAD, OPTIONS
+        Connection:
+          - keep-alive
+        Content-Length:
+          - '5158'
+        Content-Type:
+          - application/json
+        Cross-Origin-Opener-Policy:
+          - same-origin
+        Date:
+          - Fri, 06 Dec 2024 12:46:14 GMT
+        Link:
+          - ''
+        Referrer-Policy:
+          - same-origin
+        Server:
+          - nginx/1.24.0
+        Vary:
+          - Cookie
+        X-App-Version:
+          - dev
+        X-Content-Type-Options:
+          - nosniff
+        X-Frame-Options:
+          - DENY
+        X-Per-Page:
+          - '20'
+        X-Request-ID:
+          - 235112590e3f298f700971bb283acb6c
+        X-SCA-Engine-Version:
+          - 2.2.0
+        X-Secrets-Engine-Version:
+          - 2.127.0
+      status:
+        code: 200
+        message: OK
+version: 1