slack-objects 0.0.9__tar.gz → 0.1.0__tar.gz

{slack_objects-0.0.9 → slack_objects-0.1.0}/.gitignore

@@ -29,4 +29,7 @@ src/slack_objects/_version.py
 /tests/Examples/__pycache__
 
 # Examples config (contains Key Vault / secret names)
-/tests/Examples/examples_config.json
+/tests/Examples/examples_config.json
+/.vs/slnx.sqlite
+/.vs/VSWorkspaceState.json
+/src/slack_objects/.vs

{slack_objects-0.0.9 → slack_objects-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: slack-objects
-Version: 0.0.9
+Version: 0.1.0
 Summary: Opinionated, testable Python wrappers for Slack’s Web, Admin, and SCIM APIs, organized by object domain (users, conversations, messages, files, workspaces, and IdP groups). Designed for automation and administration workflows.
 Author-email: "Marcos E. Mercado" <marcos_elias@hotmail.com>
 Keywords: slack,objects,classes,slack objects,utilities,slack utilities,slack object types,slack types,types

{slack_objects-0.0.9 → slack_objects-0.1.0}/src/slack_objects/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.9'
-__version_tuple__ = version_tuple = (0, 0, 9)
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
 
-__commit_id__ = commit_id = 'g82c79f1f4'
+__commit_id__ = commit_id = 'gf712fe717'

{slack_objects-0.0.9 → slack_objects-0.1.0}/src/slack_objects/users.py

@@ -646,6 +646,51 @@ class Users(ScimMixin, SlackObjectBase):
 
         return self._scim_request(path=f"Users/{user_id}", method="PATCH", payload=payload)
 
+    def scim_update_email(
+        self,
+        *,
+        user_id: Optional[str] = None,
+        new_email: str,
+    ) -> ScimResponse:
+        """Update a user's primary email address via SCIM PATCH.
+
+        This is intentionally separate from :meth:`scim_update_user_attribute`
+        because email updates require a structurally different payload in both
+        SCIM versions (value-filter path in v2, typed email array in v1).
+
+        Accepts a plain email-address string and builds the version-correct
+        payload automatically:
+        - v2: value-filter path ``emails[primary eq true].value`` to avoid
+              the "more than one primary element" conflict.
+        - v1: wraps the address in the standard SCIM email array.
+        """
+        uid = user_id or self.user_id
+        if not uid:
+            raise ValueError("scim_update_email requires user_id (passed or bound)")
+        validate_scim_id(uid, "user_id")
+
+        scim_version = self.cfg.scim_version
+        if scim_version == "v2":
+            payload = {
+                "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
+                "Operations": [
+                    {
+                        "op": "replace",
+                        "path": "emails[primary eq true].value",
+                        "value": new_email,
+                    }
+                ],
+            }
+        elif scim_version == "v1":
+            payload = {
+                "schemas": ["urn:scim:schemas:core:1.0"],
+                "emails": [{"value": new_email, "type": "work", "primary": True}],
+            }
+        else:
+            raise NotImplementedError(f"Invalid SCIM version: {scim_version}")
+
+        return self._scim_request(path=f"Users/{uid}", method="PATCH", payload=payload)
+
     def make_multi_channel_guest(self, user_id: Optional[str] = None) -> ScimResponse:
         """Convert a user to a multi-channel guest via SCIM PATCH."""
         uid = user_id or self.user_id

{slack_objects-0.0.9 → slack_objects-0.1.0}/src/slack_objects.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: slack-objects
-Version: 0.0.9
+Version: 0.1.0
 Summary: Opinionated, testable Python wrappers for Slack’s Web, Admin, and SCIM APIs, organized by object domain (users, conversations, messages, files, workspaces, and IdP groups). Designed for automation and administration workflows.
 Author-email: "Marcos E. Mercado" <marcos_elias@hotmail.com>
 Keywords: slack,objects,classes,slack objects,utilities,slack utilities,slack object types,slack types,types

{slack_objects-0.0.9 → slack_objects-0.1.0}/src/slack_objects.egg-info/SOURCES.txt

@@ -7,8 +7,6 @@ pytest.ini
 .github/workflows/ci.yml
 .github/workflows/publish-pypi.yml
 .github/workflows/publish-testpypi.yml
-.vs/VSWorkspaceState.json
-.vs/slnx.sqlite
 src/slack_objects/__init__.py
 src/slack_objects/_version.py
 src/slack_objects/api_caller.py
@@ -42,6 +40,7 @@ tests/SCIM/test_scim_users_input_validation_live.py
 tests/SCIM/test_scim_users_make_guest_live.py
 tests/SCIM/test_scim_users_reactivate_live.py
 tests/SCIM/test_scim_users_update_attribute_live.py
+tests/SCIM/test_scim_users_update_email_live.py
 tests/Smoke/_smoke_harness.py
 tests/Smoke/api_caller_smoke_test.py
 tests/Smoke/conversations_smoke_test.py

{slack_objects-0.0.9 → slack_objects-0.1.0}/tests/SCIM/conftest_live.py

@@ -7,8 +7,8 @@ Test-user IDs and other identifiers are loaded from a JSON file.
 Setup
 -----
 1.  Store your Slack tokens in Azure Key Vault:
-        Bot-token-SB         – xoxb-... bot token with users:read and users:read.email scopes
-        User-token-SB        – xoxp-... user token with admin scope (org-level admin + SCIM provisioning)
+        Bot-token-TEST         – xoxb-... bot token with users:read and users:read.email scopes
+        User-token-TEST        – xoxp-... user token with admin scope (org-level admin + SCIM provisioning)
 
 2.  Set the ``_KEYVAULT_NAME`` constant in this file to your Azure Key Vault name.
 
@@ -51,9 +51,9 @@ _DEFAULT_CONFIG_PATH = _HERE.parent / "live_test_config.json"
 _KEYVAULT_NAME = "Slack-AI-assistant-KV"
 
 # Key Vault secret names
-_SECRET_BOT_TOKEN = "Bot-token-SB"
-_SECRET_USER_TOKEN = "User-token-SB"
-_SECRET_SCIM_TOKEN = "User-token-SB"
+_SECRET_BOT_TOKEN = "Bot-token-TEST"
+_SECRET_USER_TOKEN = "User-token-TEST"
+_SECRET_SCIM_TOKEN = "User-token-TEST"
 
 
 # ---------------------------------------------------------------------------

{slack_objects-0.0.9 → slack_objects-0.1.0}/tests/SCIM/run_all_scim_users_live_tests.py

@@ -25,6 +25,7 @@ _TEST_FILES = [
     "test_scim_users_input_validation_live.py",   # no API calls
     "test_scim_users_reactivate_live.py",          # read-mostly (no-ops on active users)
     "test_scim_users_update_attribute_live.py",    # mutating, reversible
+    "test_scim_users_update_email_live.py",        # mutating, reversible
     "test_scim_users_create_live.py",              # self-contained (create + delete)
     "test_scim_users_deactivate_live.py",          # mutating, reversible (strips workspaces)
     "test_scim_users_make_guest_live.py",          # DESTRUCTIVE (disposable users only)

{slack_objects-0.0.9 → slack_objects-0.1.0}/tests/SCIM/test_scim_users_input_validation_live.py

@@ -99,4 +99,18 @@ class TestScimInputValidation:
         with patch.object(users, "_scim_request", wraps=users._scim_request) as spy:
             with pytest.raises(ValueError):
                 users.make_multi_channel_guest(bad_id)
+            spy.assert_not_called()
+
+    @pytest.mark.parametrize("bad_id", [
+        "../traversal",
+        "",
+        "id with spaces",
+    ])
+    def test_update_email_rejects_bad_ids(self, users, bad_id):
+        with patch.object(users, "_scim_request", wraps=users._scim_request) as spy:
+            with pytest.raises(ValueError):
+                users.scim_update_email(
+                    user_id=bad_id,
+                    new_email="test@example.com",
+                )
             spy.assert_not_called()

slack_objects-0.1.0/tests/SCIM/test_scim_users_update_email_live.py

@@ -0,0 +1,160 @@
+"""
+Live integration tests for scim_update_email.
+
+MUTATING but REVERSIBLE — every email change is followed by a restore
+to the original email in teardown.
+"""
+
+from __future__ import annotations
+
+import time
+from typing import Any, Dict, Optional
+
+import pytest
+import requests
+
+from slack_objects.users import Users
+
+from conftest_live import LiveTestContext, build_live_context
+
+# ---------------------------------------------------------------------------
+# Fixtures
+# ---------------------------------------------------------------------------
+
+_ctx: Optional[LiveTestContext] = None
+
+
+def _get_ctx() -> LiveTestContext:
+    global _ctx
+    if _ctx is None:
+        _ctx = build_live_context()
+    return _ctx
+
+
+@pytest.fixture(scope="module")
+def ctx() -> LiveTestContext:
+    return _get_ctx()
+
+
+@pytest.fixture(scope="module")
+def users(ctx: LiveTestContext) -> Users:
+    return ctx.slack.users()
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+_SCIM_PAUSE = 4.0
+
+
+def _pause():
+    time.sleep(_SCIM_PAUSE)
+
+
+def _scim_get_user(users: Users, user_id: str) -> Dict[str, Any]:
+    resp = users._scim_request(path=f"Users/{user_id}", method="GET")
+    assert resp.ok, f"SCIM GET Users/{user_id} failed: {resp.data}"
+    return resp.data
+
+
+def _get_primary_email(scim_data: Dict[str, Any]) -> str:
+    """Extract the primary email from a SCIM user resource."""
+    for email in scim_data.get("emails", []):
+        if email.get("primary", False):
+            return email.get("value", "")
+    return ""
+
+
+# ---------------------------------------------------------------------------
+# Tests
+# ---------------------------------------------------------------------------
+
+class TestScimUpdateEmail:
+    """scim_update_email — identifier × type matrix."""
+
+    # ----- active member -----
+
+    def test_update_email_active_member(self, ctx, users):
+        """Update primary email on an active member, verify, then restore."""
+        original_data = _scim_get_user(users, ctx.active_member_id)
+        original_email = _get_primary_email(original_data)
+        assert original_email, "Could not determine original email"
+        _pause()
+
+        new_email = f"scim-test-{int(time.time())}@example.com"
+        resp = users.scim_update_email(
+            user_id=ctx.active_member_id,
+            new_email=new_email,
+        )
+        assert resp.ok, f"Expected ok: {resp.data}"
+        _pause()
+
+        updated = _scim_get_user(users, ctx.active_member_id)
+        assert _get_primary_email(updated) == new_email
+        _pause()
+
+        # Teardown: restore original email
+        users.scim_update_email(
+            user_id=ctx.active_member_id,
+            new_email=original_email,
+        )
+        _pause()
+
+    # ----- active admin -----
+
+    def test_update_email_active_admin(self, ctx, users):
+        """Update primary email on an admin, verify, then restore."""
+        original_data = _scim_get_user(users, ctx.active_admin_id)
+        original_email = _get_primary_email(original_data)
+        assert original_email, "Could not determine original email"
+        _pause()
+
+        new_email = f"scim-admin-test-{int(time.time())}@example.com"
+        resp = users.scim_update_email(
+            user_id=ctx.active_admin_id,
+            new_email=new_email,
+        )
+        assert resp.ok, f"Expected ok for admin: {resp.data}"
+        _pause()
+
+        # Teardown: restore
+        users.scim_update_email(
+            user_id=ctx.active_admin_id,
+            new_email=original_email,
+        )
+        _pause()
+
+    # ----- bound user_id (no explicit user_id) -----
+
+    def test_update_email_bound_user(self, ctx, users):
+        """Update email using bound user_id (no explicit user_id arg)."""
+        bound = users.with_user(ctx.active_member_id)
+        original_data = _scim_get_user(bound, ctx.active_member_id)
+        original_email = _get_primary_email(original_data)
+        assert original_email, "Could not determine original email"
+        _pause()
+
+        new_email = f"scim-bound-test-{int(time.time())}@example.com"
+        resp = bound.scim_update_email(new_email=new_email)
+        assert resp.ok, f"Expected ok for bound user: {resp.data}"
+        _pause()
+
+        # Teardown: restore
+        bound.scim_update_email(new_email=original_email)
+        _pause()
+
+    # ----- deactivated user -----
+
+    def test_update_email_deactivated_user(self, ctx, users):
+        """Updating email on a deactivated user should fail or be a no-op."""
+        try:
+            resp = users.scim_update_email(
+                user_id=ctx.deactivated_user_id,
+                new_email="should-not-apply@example.com",
+            )
+        except requests.HTTPError as exc:
+            assert exc.response.status_code in (400, 403, 404), (
+                f"Unexpected status for deactivated user: {exc.response.status_code}"
+            )
+        _pause()

{slack_objects-0.0.9 → slack_objects-0.1.0}/tests/Smoke/users_smoke_test.py

@@ -161,6 +161,14 @@ def main() -> None:
             "scim_update_user_attribute()",
             lambda: bound.scim_update_user_attribute(user_id="U1", attribute="active", new_value=False),
         ),
+        CallSpec(
+            "scim_update_email(by id)",
+            lambda: bound.scim_update_email(user_id="U1", new_email="newemail@example.com"),
+        ),
+        CallSpec(
+            "scim_update_email(bound)",
+            lambda: bound.scim_update_email(new_email="newemail@example.com"),
+        ),
         CallSpec("make_multi_channel_guest()", lambda: bound.make_multi_channel_guest()),
 
         # SCIM search primitives

{slack_objects-0.0.9 → slack_objects-0.1.0}/tests/UnitTests/users_unit_test.py

@@ -479,3 +479,97 @@ class TestIsActiveWithUserId:
         bound.get_user_info = MagicMock()
         assert bound.is_active(user_id="U123") is True
         bound.get_user_info.assert_not_called()
+
+
+# ═══════════════════════════════════════════════════════════════════════════
+# scim_update_email
+# ═══════════════════════════════════════════════════════════════════════════
+
+class TestScimUpdateEmail:
+    """scim_update_email — version-aware SCIM PATCH for primary email."""
+
+    def test_v2_payload_uses_value_filter_path(self):
+        """v2 uses emails[primary eq true].value to avoid multi-primary conflict."""
+        users = _make_users()
+        bound = users.with_user("U1")
+        bound._scim_request = MagicMock(
+            return_value=ScimResponse(ok=True, status_code=200, data={}, text=""),
+        )
+        bound.scim_update_email(user_id="U1", new_email="new@example.com")
+
+        bound._scim_request.assert_called_once()
+        _, kwargs = bound._scim_request.call_args
+        op = kwargs["payload"]["Operations"][0]
+        assert op["op"] == "replace"
+        assert op["path"] == "emails[primary eq true].value"
+        assert op["value"] == "new@example.com"
+
+    def test_v1_payload_uses_email_array(self):
+        """v1 wraps address in standard SCIM email array with primary+type."""
+        users = _make_users()
+        bound = users.with_user("U1")
+        object.__setattr__(bound.cfg, "scim_version", "v1")
+        bound._scim_request = MagicMock(
+            return_value=ScimResponse(ok=True, status_code=200, data={}, text=""),
+        )
+        bound.scim_update_email(user_id="U1", new_email="new@example.com")
+
+        bound._scim_request.assert_called_once()
+        _, kwargs = bound._scim_request.call_args
+        emails = kwargs["payload"]["emails"]
+        assert len(emails) == 1
+        assert emails[0]["value"] == "new@example.com"
+        assert emails[0]["primary"] is True
+        assert emails[0]["type"] == "work"
+
+    def test_falls_back_to_bound_user_id(self):
+        """Omitting user_id uses self.user_id."""
+        users = _make_users()
+        bound = users.with_user("U1")
+        bound._scim_request = MagicMock(
+            return_value=ScimResponse(ok=True, status_code=200, data={}, text=""),
+        )
+        bound.scim_update_email(new_email="new@example.com")
+
+        bound._scim_request.assert_called_once()
+        _, kwargs = bound._scim_request.call_args
+        assert kwargs["path"] == "Users/U1"
+
+    def test_explicit_user_id_overrides_bound(self):
+        """Passing user_id explicitly takes precedence over bound user_id."""
+        users = _make_users()
+        bound = users.with_user("U_IGNORED")
+        bound._scim_request = MagicMock(
+            return_value=ScimResponse(ok=True, status_code=200, data={}, text=""),
+        )
+        bound.scim_update_email(user_id="U_OTHER", new_email="new@example.com")
+
+        bound._scim_request.assert_called_once()
+        _, kwargs = bound._scim_request.call_args
+        assert kwargs["path"] == "Users/U_OTHER"
+
+    def test_no_user_id_raises(self):
+        """Unbound instance with no user_id raises ValueError."""
+        users = _make_users()
+        with pytest.raises(ValueError, match="requires user_id"):
+            users.scim_update_email(new_email="x@example.com")
+
+    def test_invalid_scim_version_raises(self):
+        """Unsupported scim_version raises NotImplementedError."""
+        users = _make_users()
+        bound = users.with_user("U1")
+        object.__setattr__(bound.cfg, "scim_version", "v99")
+        with pytest.raises(NotImplementedError, match="Invalid SCIM version"):
+            bound.scim_update_email(new_email="x@example.com")
+
+    def test_invalid_user_id_raises(self):
+        """Path-traversal user_id is rejected by validate_scim_id."""
+        users = _make_users()
+        with pytest.raises(ValueError):
+            users.scim_update_email(user_id="../../bad", new_email="x@example.com")
+
+    def test_empty_user_id_raises(self):
+        """Empty user_id is rejected by validate_scim_id."""
+        users = _make_users()
+        with pytest.raises(ValueError):
+            users.scim_update_email(user_id="", new_email="x@example.com")

{slack_objects-0.0.9 → slack_objects-0.1.0}/tests/Users/conftest_live.py

@@ -7,8 +7,8 @@ Test-user IDs and other identifiers are loaded from a JSON file.
 Setup
 -----
 1.  Store your Slack tokens in Azure Key Vault:
-        Bot-token-SB         – xoxb-... bot token with users:read and users:read.email scopes
-        User-token-SB        – xoxp-... user token with admin scope
+        Bot-token-TEST         – xoxb-... bot token with users:read and users:read.email scopes
+        User-token-TEST        – xoxp-... user token with admin scope
 
 2.  Set the ``_KEYVAULT_NAME`` constant in this file to your Azure Key Vault name.
 
@@ -48,9 +48,9 @@ _DEFAULT_CONFIG_PATH = _HERE.parent / "live_test_config.json"
 _KEYVAULT_NAME = "Slack-AI-assistant-KV"
 
 # Key Vault secret names
-_SECRET_BOT_TOKEN = "Bot-token-SB"
-_SECRET_USER_TOKEN = "User-token-SB"
-_SECRET_SCIM_TOKEN = "User-token-SB" # There's no separate SCIM token at the moment
+_SECRET_BOT_TOKEN = "Bot-token-TEST"
+_SECRET_USER_TOKEN = "User-token-TEST"
+_SECRET_SCIM_TOKEN = "User-token-TEST" # There's no separate SCIM token at the moment
 
 
 # ---------------------------------------------------------------------------

slack_objects-0.0.9/.vs/VSWorkspaceState.json

@@ -1,8 +0,0 @@
-{
-  "ExpandedNodes": [
-    "",
-    "\\src",
-    "\\src\\slack-objects"
-  ],
-  "PreviewInSolutionExplorer": false
-}