test_api_projects.py

from __future__ import annotations

import json
from typing import TYPE_CHECKING, Any

import pytest

from tests.data.test_defaults import DEFAULT_API_URL, PaginatedResults
from tests.utils.test_utils import api_headers, enumerate_async, mock_route

if TYPE_CHECKING:
    import respx

    from todoist_api_python.api import TodoistAPI
    from todoist_api_python.api_async import TodoistAPIAsync
from todoist_api_python.models import Collaborator, Project


@pytest.mark.asyncio
async def test_get_project(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
    default_project_response: dict[str, Any],
    default_project: Project,
) -> None:
    project_id = "6X7rM8997g3RQmvh"
    endpoint = f"{DEFAULT_API_URL}/projects/{project_id}"

    mock_route(
        respx_mock,
        method="GET",
        url=endpoint,
        request_headers=api_headers(),
        response_json=default_project_response,
        response_status=200,
    )

    project = todoist_api.get_project(project_id)

    assert len(respx_mock.calls) == 1
    assert project == default_project

    project = await todoist_api_async.get_project(project_id)

    assert len(respx_mock.calls) == 2
    assert project == default_project


@pytest.mark.asyncio
async def test_get_projects(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
    default_projects_response: list[PaginatedResults],
    default_projects_list: list[list[Project]],
) -> None:
    endpoint = f"{DEFAULT_API_URL}/projects"

    cursor: str | None = None
    for page in default_projects_response:
        mock_route(
            respx_mock,
            method="GET",
            url=endpoint,
            request_params={"cursor": cursor} if cursor else {},
            request_headers=api_headers(),
            response_json=page,
            response_status=200,
        )
        cursor = page["next_cursor"]

    count = 0

    projects_iter = todoist_api.get_projects()

    for i, projects in enumerate(projects_iter):
        assert len(respx_mock.calls) == count + 1
        assert projects == default_projects_list[i]
        count += 1

    projects_async_iter = await todoist_api_async.get_projects()

    async for i, projects in enumerate_async(projects_async_iter):
        assert len(respx_mock.calls) == count + 1
        assert projects == default_projects_list[i]
        count += 1


@pytest.mark.asyncio
async def test_search_projects(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
    default_projects_response: list[PaginatedResults],
    default_projects_list: list[list[Project]],
) -> None:
    endpoint = f"{DEFAULT_API_URL}/projects/search"
    query = "Inbox"

    cursor: str | None = None
    for page in default_projects_response:
        mock_route(
            respx_mock,
            method="GET",
            url=endpoint,
            request_params={"query": query} | ({"cursor": cursor} if cursor else {}),
            request_headers=api_headers(),
            response_json=page,
            response_status=200,
        )
        cursor = page["next_cursor"]

    count = 0

    projects_iter = todoist_api.search_projects(query)

    for i, projects in enumerate(projects_iter):
        assert len(respx_mock.calls) == count + 1
        assert projects == default_projects_list[i]
        count += 1

    projects_async_iter = await todoist_api_async.search_projects(query)

    async for i, projects in enumerate_async(projects_async_iter):
        assert len(respx_mock.calls) == count + 1
        assert projects == default_projects_list[i]
        count += 1


@pytest.mark.asyncio
async def test_add_project_minimal(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
    default_project_response: dict[str, Any],
    default_project: Project,
) -> None:
    project_name = "A Project"

    mock_route(
        respx_mock,
        method="POST",
        url=f"{DEFAULT_API_URL}/projects",
        request_headers=api_headers(),
        request_json={"name": project_name},
        response_json=default_project_response,
        response_status=200,
    )

    new_project = todoist_api.add_project(name=project_name)

    assert len(respx_mock.calls) == 1
    assert new_project == default_project

    new_project = await todoist_api_async.add_project(name=project_name)

    assert len(respx_mock.calls) == 2
    assert new_project == default_project


@pytest.mark.asyncio
async def test_add_project_full(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
    default_project_response: dict[str, Any],
    default_project: Project,
) -> None:
    project_name = "A Project"
    args: dict[str, Any] = {
        "description": "A project description",
        "parent_id": "3Ty8VQXxpwv28PK3",
        "color": "red",
        "is_favorite": True,
        "view_style": "board",
    }

    mock_route(
        respx_mock,
        method="POST",
        url=f"{DEFAULT_API_URL}/projects",
        request_headers=api_headers(),
        request_json={"name": project_name} | args,
        response_json=default_project_response,
        response_status=200,
    )

    new_project = todoist_api.add_project(name=project_name, **args)

    assert len(respx_mock.calls) == 1
    assert new_project == default_project

    new_project = await todoist_api_async.add_project(name=project_name, **args)

    assert len(respx_mock.calls) == 2
    assert new_project == default_project


@pytest.mark.asyncio
async def test_update_project(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
    default_project: Project,
    default_project_response: dict[str, Any],
) -> None:
    args: dict[str, Any] = {
        "name": "An updated project",
        "color": "red",
        "is_favorite": False,
    }
    updated_project_response = dict(default_project_response) | args

    mock_route(
        respx_mock,
        method="POST",
        url=f"{DEFAULT_API_URL}/projects/{default_project.id}",
        request_headers=api_headers(),
        request_json=args,
        response_json=updated_project_response,
        response_status=200,
    )

    response = todoist_api.update_project(project_id=default_project.id, **args)

    assert len(respx_mock.calls) == 1
    assert response == Project.from_dict(updated_project_response)

    response = await todoist_api_async.update_project(
        project_id=default_project.id, **args
    )

    assert len(respx_mock.calls) == 2
    assert response == Project.from_dict(updated_project_response)


@pytest.mark.asyncio
async def test_update_project_payload_mapping(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
    default_project: Project,
    default_project_response: dict[str, Any],
) -> None:
    args: dict[str, Any] = {
        "order": 3,
        "collapsed": True,
    }
    expected_payload: dict[str, Any] = {
        "child_order": 3,
        "is_collapsed": True,
    }
    updated_project_response = dict(default_project_response) | {
        "child_order": args["order"],
        "is_collapsed": args["collapsed"],
    }

    mock_route(
        respx_mock,
        method="POST",
        url=f"{DEFAULT_API_URL}/projects/{default_project.id}",
        request_headers=api_headers(),
        response_json=updated_project_response,
        response_status=200,
    )

    response = todoist_api.update_project(project_id=default_project.id, **args)

    assert len(respx_mock.calls) == 1
    assert response == Project.from_dict(updated_project_response)
    actual_payload = json.loads(respx_mock.calls[0].request.content)
    assert actual_payload == expected_payload

    response = await todoist_api_async.update_project(
        project_id=default_project.id, **args
    )

    assert len(respx_mock.calls) == 2
    assert response == Project.from_dict(updated_project_response)
    actual_payload = json.loads(respx_mock.calls[1].request.content)
    assert actual_payload == expected_payload


@pytest.mark.asyncio
async def test_archive_project(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
    default_project: Project,
) -> None:
    project_id = default_project.id
    endpoint = f"{DEFAULT_API_URL}/projects/{project_id}/archive"

    archived_project_dict = default_project.to_dict()
    archived_project_dict["is_archived"] = True

    mock_route(
        respx_mock,
        method="POST",
        url=endpoint,
        request_headers=api_headers(),
        response_json=archived_project_dict,
        response_status=200,
    )

    project = todoist_api.archive_project(project_id)

    assert len(respx_mock.calls) == 1
    assert project == Project.from_dict(archived_project_dict)

    project = await todoist_api_async.archive_project(project_id)

    assert len(respx_mock.calls) == 2
    assert project == Project.from_dict(archived_project_dict)


@pytest.mark.asyncio
async def test_unarchive_project(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
    default_project: Project,
) -> None:
    project_id = default_project.id
    endpoint = f"{DEFAULT_API_URL}/projects/{project_id}/unarchive"

    unarchived_project_dict = default_project.to_dict()
    unarchived_project_dict["is_archived"] = False

    mock_route(
        respx_mock,
        method="POST",
        url=endpoint,
        request_headers=api_headers(),
        response_json=unarchived_project_dict,
        response_status=200,
    )

    project = todoist_api.unarchive_project(project_id)

    assert len(respx_mock.calls) == 1
    assert project == Project.from_dict(unarchived_project_dict)

    project = await todoist_api_async.unarchive_project(project_id)

    assert len(respx_mock.calls) == 2
    assert project == Project.from_dict(unarchived_project_dict)


@pytest.mark.asyncio
async def test_delete_project(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
) -> None:
    project_id = "6X7rM8997g3RQmvh"
    endpoint = f"{DEFAULT_API_URL}/projects/{project_id}"

    mock_route(
        respx_mock,
        method="DELETE",
        url=endpoint,
        request_headers=api_headers(),
        response_status=204,
    )

    response = todoist_api.delete_project(project_id)

    assert len(respx_mock.calls) == 1
    assert response is True

    response = await todoist_api_async.delete_project(project_id)

    assert len(respx_mock.calls) == 2
    assert response is True


@pytest.mark.asyncio
async def test_get_collaborators(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
    default_collaborators_response: list[PaginatedResults],
    default_collaborators_list: list[list[Collaborator]],
) -> None:
    project_id = "6X7rM8997g3RQmvh"
    endpoint = f"{DEFAULT_API_URL}/projects/{project_id}/collaborators"

    cursor: str | None = None
    for page in default_collaborators_response:
        mock_route(
            respx_mock,
            method="GET",
            url=endpoint,
            request_params={"cursor": cursor} if cursor else {},
            request_headers=api_headers(),
            response_json=page,
            response_status=200,
        )
        cursor = page["next_cursor"]

    count = 0

    collaborators_iter = todoist_api.get_collaborators(project_id)

    for i, collaborators in enumerate(collaborators_iter):
        assert len(respx_mock.calls) == count + 1
        assert collaborators == default_collaborators_list[i]
        count += 1

    collaborators_async_iter = await todoist_api_async.get_collaborators(project_id)

    async for i, collaborators in enumerate_async(collaborators_async_iter):
        assert len(respx_mock.calls) == count + 1
        assert collaborators == default_collaborators_list[i]
        count += 1


@pytest.mark.asyncio
async def test_get_collaborators_accepts_hidden_email(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    respx_mock: respx.MockRouter,
) -> None:
    project_id = "6X7rM8997g3RQmvh"
    endpoint = f"{DEFAULT_API_URL}/projects/{project_id}/collaborators"
    response: PaginatedResults = {
        "results": [{"id": "123", "name": "Alice D.", "email": None}],
        "next_cursor": None,
    }

    mock_route(
        respx_mock,
        method="GET",
        url=endpoint,
        request_headers=api_headers(),
        response_json=response,
        response_status=200,
    )

    collaborators = next(todoist_api.get_collaborators(project_id))

    assert collaborators == [Collaborator(id="123", name="Alice D.", email=None)]

    collaborators_async_iter = await todoist_api_async.get_collaborators(project_id)

    async for collaborators in collaborators_async_iter:
        assert collaborators == [Collaborator(id="123", name="Alice D.", email=None)]