Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions erclient/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -1054,6 +1054,48 @@ def get_sources(self, page_size=100):
def get_users(self):
return self._get('users')

# -- User / Account Methods --

def get_user(self, user_id):
"""
Get a single user by ID (or 'me' for the authenticated user).
:param user_id: User UUID or 'me'
:return: User data
"""
return self._get(f'user/{user_id}')

def patch_user(self, user_id, data):
"""
Update a user with partial data.
:param user_id: User UUID or 'me'
:param data: Partial user data (e.g., {"first_name": "New"})
:return: Updated user data
"""
self.logger.debug(f'Patching user {user_id}: {data}')
return self._patch(f'user/{user_id}', payload=data)

def get_user_profiles(self, user_id):
"""
Get profiles for a user.
:param user_id: User UUID
:return: List of user profiles
"""
return self._get(f'user/{user_id}/profiles')

def get_eula(self):
"""
Get the active End-User License Agreement.
:return: EULA data
"""
return self._get('user/eula')

def accept_eula(self):
"""
Accept the active End-User License Agreement.
:return: Acceptance confirmation
"""
return self._post('user/eula/accept', payload={})


class AsyncERClient(object):
"""
Expand Down Expand Up @@ -1410,6 +1452,52 @@ async def login(self):
async def get_me(self):
return await self._get('user/me')

# -- User / Account Methods --

async def get_users(self):
"""Get a list of users."""
return await self._get('users')

async def get_user(self, user_id):
"""
Get a single user by ID (or 'me' for the authenticated user).
:param user_id: User UUID or 'me'
:return: User data
"""
return await self._get(f'user/{user_id}')

async def patch_user(self, user_id, data):
"""
Update a user with partial data.
:param user_id: User UUID or 'me'
:param data: Partial user data (e.g., {"first_name": "New"})
:return: Updated user data
"""
self.logger.debug(f'Patching user {user_id}: {data}')
return await self._patch(f'user/{user_id}', payload=data)

async def get_user_profiles(self, user_id):
"""
Get profiles for a user.
:param user_id: User UUID
:return: List of user profiles
"""
return await self._get(f'user/{user_id}/profiles')

async def get_eula(self):
"""
Get the active End-User License Agreement.
:return: EULA data
"""
return await self._get('user/eula')

async def accept_eula(self):
"""
Accept the active End-User License Agreement.
:return: Acceptance confirmation
"""
return await self._post('user/eula/accept', payload={})

async def _token_request(self, payload):
response = await self._http_session.post(self.token_url, data=payload)

Expand Down
193 changes: 193 additions & 0 deletions tests/async_client/test_accounts.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
import httpx
import pytest
import respx

from erclient import ERClientNotFound, ERClientPermissionDenied


# -- Fixtures --

@pytest.fixture
def user_response():
return {
"id": "c925e69e-51cf-43d0-b659-2000ae023664",
"username": "ranger01",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@example.org",
"is_active": True,
}


@pytest.fixture
def users_list_response(user_response):
return [user_response]


@pytest.fixture
def user_profiles_response():
return [
{
"id": "prof-001",
"user": "c925e69e-51cf-43d0-b659-2000ae023664",
"role": "ranger",
}
]


@pytest.fixture
def eula_response():
return {
"id": "eula-001",
"version": "2.0",
"eula_url": "https://example.org/eula",
"active": True,
}


@pytest.fixture
def eula_accept_response():
return {
"accepted": True,
"eula": "eula-001",
}


# -- get_users --

@pytest.mark.asyncio
async def test_get_users(er_client, users_list_response):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.get("users")
route.return_value = httpx.Response(httpx.codes.OK, json={"data": users_list_response})
result = await er_client.get_users()
assert route.called
assert result == users_list_response
await er_client.close()


# -- get_user --

@pytest.mark.asyncio
async def test_get_user(er_client, user_response):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.get("user/c925e69e-51cf-43d0-b659-2000ae023664")
route.return_value = httpx.Response(httpx.codes.OK, json={"data": user_response})
result = await er_client.get_user("c925e69e-51cf-43d0-b659-2000ae023664")
assert route.called
assert result == user_response
await er_client.close()


@pytest.mark.asyncio
async def test_get_user_me(er_client, user_response):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.get("user/me")
route.return_value = httpx.Response(httpx.codes.OK, json={"data": user_response})
result = await er_client.get_user("me")
assert route.called
assert result == user_response
await er_client.close()


@pytest.mark.asyncio
async def test_get_user_not_found(er_client):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.get("user/nonexistent")
route.return_value = httpx.Response(httpx.codes.NOT_FOUND, json={"status": {"code": 404}})
with pytest.raises(ERClientNotFound):
await er_client.get_user("nonexistent")
await er_client.close()


# -- patch_user --

@pytest.mark.asyncio
async def test_patch_user(er_client, user_response):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.patch("user/c925e69e-51cf-43d0-b659-2000ae023664")
updated = {**user_response, "first_name": "Updated"}
route.return_value = httpx.Response(httpx.codes.OK, json={"data": updated})
result = await er_client.patch_user("c925e69e-51cf-43d0-b659-2000ae023664", {"first_name": "Updated"})
assert route.called
assert result["first_name"] == "Updated"
await er_client.close()


@pytest.mark.asyncio
async def test_patch_user_forbidden(er_client):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.patch("user/c925e69e-51cf-43d0-b659-2000ae023664")
route.return_value = httpx.Response(httpx.codes.FORBIDDEN, json={"status": {"code": 403}})
with pytest.raises(ERClientPermissionDenied):
await er_client.patch_user("c925e69e-51cf-43d0-b659-2000ae023664", {"first_name": "x"})
await er_client.close()


@pytest.mark.asyncio
async def test_patch_user_not_found(er_client):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.patch("user/nonexistent")
route.return_value = httpx.Response(httpx.codes.NOT_FOUND, json={"status": {"code": 404}})
with pytest.raises(ERClientNotFound):
await er_client.patch_user("nonexistent", {"first_name": "x"})
await er_client.close()


# -- get_user_profiles --

@pytest.mark.asyncio
async def test_get_user_profiles(er_client, user_profiles_response):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.get("user/c925e69e-51cf-43d0-b659-2000ae023664/profiles")
route.return_value = httpx.Response(httpx.codes.OK, json={"data": user_profiles_response})
result = await er_client.get_user_profiles("c925e69e-51cf-43d0-b659-2000ae023664")
assert route.called
assert result == user_profiles_response
await er_client.close()


@pytest.mark.asyncio
async def test_get_user_profiles_not_found(er_client):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.get("user/nonexistent/profiles")
route.return_value = httpx.Response(httpx.codes.NOT_FOUND, json={"status": {"code": 404}})
with pytest.raises(ERClientNotFound):
await er_client.get_user_profiles("nonexistent")
await er_client.close()


# -- get_eula --

@pytest.mark.asyncio
async def test_get_eula(er_client, eula_response):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.get("user/eula")
route.return_value = httpx.Response(httpx.codes.OK, json={"data": eula_response})
result = await er_client.get_eula()
assert route.called
assert result == eula_response
await er_client.close()


# -- accept_eula --

@pytest.mark.asyncio
async def test_accept_eula(er_client, eula_accept_response):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.post("user/eula/accept")
route.return_value = httpx.Response(httpx.codes.CREATED, json={"data": eula_accept_response})
result = await er_client.accept_eula()
assert route.called
assert result == eula_accept_response
Comment on lines +176 to +182
await er_client.close()


@pytest.mark.asyncio
async def test_accept_eula_forbidden(er_client):
async with respx.mock(base_url=er_client._api_root("v1.0"), assert_all_called=False) as m:
route = m.post("user/eula/accept")
route.return_value = httpx.Response(httpx.codes.FORBIDDEN, json={"status": {"code": 403}})
with pytest.raises(ERClientPermissionDenied):
await er_client.accept_eula()
await er_client.close()
Loading
Loading