pyattackforge 0.2.2__tar.gz → 0.2.3__tar.gz

{pyattackforge-0.2.2 → pyattackforge-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyattackforge
-Version: 0.2.2
+Version: 0.2.3
 Summary: Python SDK for the AttackForge SSAPI
 Author: hackman238
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -812,6 +812,25 @@ with AttackForgeClient() as client:
     client.link_vulnerability_to_testcases("project_id", "vuln_id", ["testcase_id"])
 ```
 
+Group management (examples):
+
+```python
+from pyattackforge import AttackForgeClient
+
+with AttackForgeClient() as client:
+    group = client.groups.create_group({
+        "name": "SDK Group",
+        "group_owner": "Owner Name",
+        "primary_contact_name": "Owner Name",
+        "primary_contact_email": "owner@example.com",
+        "primary_contact_number": "0000000000",
+    })
+    group_id = group.get("group_id") or group.get("id")
+    client.projects.add_project_to_group("project_id", group_id)
+    client.groups.get_group_projects(group_id)
+    client.groups.get_group_vulnerabilities(group_id)
+```
+
 ## Testing
 
 Unit tests:

{pyattackforge-0.2.2 → pyattackforge-0.2.3}/README.md

@@ -127,6 +127,25 @@ with AttackForgeClient() as client:
     client.link_vulnerability_to_testcases("project_id", "vuln_id", ["testcase_id"])
 ```
 
+Group management (examples):
+
+```python
+from pyattackforge import AttackForgeClient
+
+with AttackForgeClient() as client:
+    group = client.groups.create_group({
+        "name": "SDK Group",
+        "group_owner": "Owner Name",
+        "primary_contact_name": "Owner Name",
+        "primary_contact_email": "owner@example.com",
+        "primary_contact_number": "0000000000",
+    })
+    group_id = group.get("group_id") or group.get("id")
+    client.projects.add_project_to_group("project_id", group_id)
+    client.groups.get_group_projects(group_id)
+    client.groups.get_group_vulnerabilities(group_id)
+```
+
 ## Testing
 
 Unit tests:

{pyattackforge-0.2.2 → pyattackforge-0.2.3}/pyattackforge/config.py

@@ -16,7 +16,7 @@ class ClientConfig:
     timeout: float = 30.0
     max_retries: int = 3
     backoff_factor: float = 0.5
-    user_agent: str = "pyattackforge/0.2.2"
+    user_agent: str = "pyattackforge/0.2.3"
     http2: bool = True
     # Default visibility for newly created findings. False = pending/hidden.
     default_findings_visible: bool = False

{pyattackforge-0.2.2 → pyattackforge-0.2.3}/pyattackforge/resources/findings.py

@@ -36,6 +36,9 @@ class FindingsResource(BaseResource):
     def get_vulnerability(self, vulnerability_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
         return self._get(f"/api/ss/vulnerability/{vulnerability_id}", params=params)
 
+    def get_vulnerabilities_by_group(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get(f"/api/ss/groups/{group_id}/vulnerabilities", params=params)
+
     def get_project_vulnerabilities(self, project_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
         return self._get(f"/api/ss/project/{project_id}/vulnerabilities", params=params)
 

pyattackforge-0.2.3/pyattackforge/resources/groups.py

@@ -0,0 +1,35 @@
+"""Resource: groups."""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from .base import BaseResource
+
+
+class GroupsResource(BaseResource):
+    """Groups API resource wrapper."""
+
+    def create_group(self, payload: Dict[str, Any]) -> Any:
+        return self._post("/api/ss/group", json=payload)
+
+    def get_groups(self, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get("/api/ss/groups", params=params)
+
+    def get_group(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get(f"/api/ss/group/{group_id}", params=params)
+
+    def update_group(self, group_id: str, payload: Dict[str, Any]) -> Any:
+        return self._put(f"/api/ss/group/{group_id}", json=payload)
+
+    def archive_group(self, group_id: str) -> Any:
+        return self._put(f"/api/ss/group/{group_id}/archive")
+
+    def restore_group(self, group_id: str) -> Any:
+        return self._put(f"/api/ss/group/{group_id}/restore")
+
+    def get_group_projects(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get(f"/api/ss/groups/{group_id}/projects", params=params)
+
+    def get_group_vulnerabilities(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get(f"/api/ss/groups/{group_id}/vulnerabilities", params=params)

{pyattackforge-0.2.2 → pyattackforge-0.2.3}/pyattackforge/resources/projects.py

@@ -33,6 +33,9 @@ class ProjectsResource(BaseResource):
     def get_projects(self, params: Optional[Dict[str, Any]] = None) -> Any:
         return self._get("/api/ss/projects", params=params)
 
+    def get_projects_by_group(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get(f"/api/ss/groups/{group_id}/projects", params=params)
+
     def get_projects_and_vulnerabilities(self, params: Optional[Dict[str, Any]] = None) -> Any:
         return self._get("/api/ss/projects-and-vulnerabilities", params=params)
 
@@ -148,6 +151,8 @@ class ProjectsResource(BaseResource):
             project = project["data"]
         if isinstance(project, dict) and isinstance(project.get("project"), dict):
             project = project["project"]
+        if not isinstance(project, dict):
+            raise ValueError("Project response is not a dict; cannot resolve groups")
         groups = project.get("groups") or project.get("project_groups") or []
         group_ids: List[str] = []
         if isinstance(groups, list):

{pyattackforge-0.2.2 → pyattackforge-0.2.3}/pyattackforge.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyattackforge
-Version: 0.2.2
+Version: 0.2.3
 Summary: Python SDK for the AttackForge SSAPI
 Author: hackman238
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -812,6 +812,25 @@ with AttackForgeClient() as client:
     client.link_vulnerability_to_testcases("project_id", "vuln_id", ["testcase_id"])
 ```
 
+Group management (examples):
+
+```python
+from pyattackforge import AttackForgeClient
+
+with AttackForgeClient() as client:
+    group = client.groups.create_group({
+        "name": "SDK Group",
+        "group_owner": "Owner Name",
+        "primary_contact_name": "Owner Name",
+        "primary_contact_email": "owner@example.com",
+        "primary_contact_number": "0000000000",
+    })
+    group_id = group.get("group_id") or group.get("id")
+    client.projects.add_project_to_group("project_id", group_id)
+    client.groups.get_group_projects(group_id)
+    client.groups.get_group_vulnerabilities(group_id)
+```
+
 ## Testing
 
 Unit tests:

{pyattackforge-0.2.2 → pyattackforge-0.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyattackforge"
-version = "0.2.2"
+version = "0.2.3"
 description = "Python SDK for the AttackForge SSAPI"
 readme = "README.md"
 license = {file = "LICENSE"}

pyattackforge-0.2.2/pyattackforge/resources/groups.py

@@ -1,20 +0,0 @@
-"""Resource: groups."""
-
-from __future__ import annotations
-
-from typing import Any, Dict, Optional
-
-from .base import BaseResource
-
-
-class GroupsResource(BaseResource):
-    """Groups API resource wrapper."""
-
-    def create_group(self, payload: Dict[str, Any]) -> Any:
-        return self._post("/api/ss/group", json=payload)
-
-    def get_groups(self, params: Optional[Dict[str, Any]] = None) -> Any:
-        return self._get("/api/ss/groups", params=params)
-
-    def get_group(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
-        return self._get(f"/api/ss/group/{group_id}", params=params)