Add workspace param support (#68)

* Add workspace to FullScanParams for API support

Signed-off-by: lelia <lelia@socket.dev>

* Add test to verify that workspace is included in query string on FullScanParams

Signed-off-by: lelia <lelia@socket.dev>

* Update README to document workspace parameter

Signed-off-by: lelia <lelia@socket.dev>

* Increment version number

Signed-off-by: lelia <lelia@socket.dev>

* Update tests to use generic data

Signed-off-by: lelia <lelia@socket.dev>

* Bump version again

Signed-off-by: lelia <lelia@socket.dev>

* Update pyproject classifiers

Signed-off-by: lelia <lelia@socket.dev>

* Pin python and virutalenv versions for workflows

Signed-off-by: lelia <lelia@socket.dev>

---------

Signed-off-by: lelia <lelia@socket.dev>

Author: lelia

.github/workflows/pr-preview.yml

@@ -16,12 +16,13 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3
         with:
-          python-version: '3.x'
+          python-version: '3.13'
 
       # Install all dependencies from pyproject.toml
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
+          pip install "virtualenv<20.36"
           pip install hatchling==1.27.0
           pip install hatch==1.14.0
 

.github/workflows/release.yml

@@ -15,12 +15,13 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3
         with:
-          python-version: '3.x'
+          python-version: '3.13'
 
       # Install all dependencies from pyproject.toml
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
+          pip install "virtualenv<20.36"
           pip install hatchling==1.27.0
           pip install hatch==1.14.0
           

README.rst

@@ -184,6 +184,7 @@ Create a full scan from a set of package manifest files. Returns a full scan inc
     params = FullScanParams(
         org_slug="org_name",
         repo="TestRepo",
+        workspace="my-workspace",
         branch="main",
         commit_message="Test Commit Message",
         commit_hash="abc123def456",
@@ -223,6 +224,8 @@ Create a full scan from a set of package manifest files. Returns a full scan inc
 +------------------------+------------+-------------------------------------------------------------------------------+
 | tmp                    | False      | Boolean temporary flag                                                        |
 +------------------------+------------+-------------------------------------------------------------------------------+
+| workspace              | False      | The workspace of the repository to associate the full-scan with.              |
++------------------------+------------+-------------------------------------------------------------------------------+
 | integration_type       | False      | IntegrationType enum value (e.g., "api", "github")                            |
 +------------------------+------------+-------------------------------------------------------------------------------+
 | integration_org_slug   | False      | Organization slug for integration                                             |

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "socketdev"
-version = "3.0.29"
+version = "3.0.31"
 requires-python = ">= 3.9"
 dependencies = [
     'requests',
@@ -23,7 +23,6 @@ maintainers = [
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",

socketdev/fullscans/__init__.py

@@ -106,6 +106,7 @@ class FullScanParams:
     set_as_pending_head: Optional[bool] = None
     tmp: Optional[bool] = None
     scan_type: Optional[ScanType] = None
+    workspace: Optional[str] = None
 
     def __getitem__(self, key):
         return getattr(self, key)
@@ -131,6 +132,7 @@ def from_dict(cls, data: dict) -> "FullScanParams":
             set_as_pending_head=data.get("set_as_pending_head"),
             tmp=data.get("tmp"),
             scan_type=ScanType(scan_type) if scan_type is not None else None,
+            workspace=data.get("workspace"),
         )
 
 

socketdev/version.py

@@ -1 +1 @@
-__version__ = "3.0.29"
+__version__ = "3.0.31"

tests/unit/test_working_endpoints_unit.py

@@ -203,6 +203,38 @@ def test_fullscans_post_unit(self):
             finally:
                 os.unlink(f.name)
 
+    def test_fullscans_post_with_workspace_unit(self):
+        """Test that workspace is included in the query string when set on FullScanParams."""
+        expected_data = {"id": "new-scan"}
+        self._mock_response(expected_data, 201)
+
+        params = FullScanParams(
+            repo="test-repo",
+            org_slug="test-org",
+            branch="main",
+            workspace="test-workspace",
+        )
+
+        with tempfile.NamedTemporaryFile(mode='w', suffix='.json', delete=False) as f:
+            json.dump({"name": "test", "version": "1.0.0"}, f)
+            f.flush()
+
+            try:
+                with open(f.name, "rb") as file_obj:
+                    files = [("file", ("package.json", file_obj))]
+                    result = self.sdk.fullscans.post(files, params)
+
+                self.assertEqual(result, expected_data)
+                call_args = self.mock_requests.request.call_args
+                self.assertEqual(call_args[0][0], "POST")
+                # Confirm workspace landed in the request URL query string
+                request_url = call_args[0][1]
+                self.assertIn("workspace=test-workspace", request_url)
+                self.assertIn("repo=test-repo", request_url)
+
+            finally:
+                os.unlink(f.name)
+
     def test_triage_list_alert_triage_unit(self):
         """Test triage list alerts - WORKING."""
         expected_data = {"alerts": []}