Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Task*Api as interfaces #88

Merged
merged 3 commits into from
Nov 4, 2024
Merged

Task*Api as interfaces #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
311b0e0
Extract Tasks*Api as interfaces to ease testing of consumer layers wi…
opatry Nov 4, 2024
594d3b1
Add in-memory implementations of Task*Api
opatry Nov 4, 2024
37f24c2
Use in-memory implementation of Task*Api in TaskRepository*Test
opatry Nov 4, 2024
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
108 changes: 61 additions & 47 deletions google/tasks/src/commonMain/kotlin/net/opatry/google/tasks/TaskListsApi.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,67 @@ import net.opatry.google.tasks.model.TaskList
/**
* Service for interacting with the [Google Task Lists REST API](https://developers.google.com/tasks/reference/rest/v1/tasklists).
*/
class TaskListsApi(
private val httpClient: HttpClient
) {
interface TaskListsApi {
/**
* [Deletes the authenticated user's specified task list](https://developers.google.com/tasks/reference/rest/v1/tasklists/delete). If the list contains assigned tasks, both the assigned tasks and the original tasks in the assignment surface (Docs, Chat Spaces) are deleted.
*
* @param taskListId Task list identifier.
*/
suspend fun delete(taskListId: String) {
suspend fun delete(taskListId: String)

/**
* [Returns the authenticated user's specified task list](https://developers.google.com/tasks/reference/rest/v1/tasklists/get).
*
* @param taskListId Task list identifier.
*
* @return an instance of [TaskList].
*/
suspend fun get(taskListId: String): TaskList

/**
* [Creates a new task list](https://developers.google.com/tasks/reference/rest/v1/tasklists/insert) and adds it to the authenticated user's task lists. A user can have up to 2000 lists at a time.
*
* @param taskList the task list to insert.
*
* @return a newly created instance of [TaskList].
*/
suspend fun insert(taskList: TaskList): TaskList

/**
* [Returns all the authenticated user's task lists](https://developers.google.com/tasks/reference/rest/v1/tasklists/list). A user can have up to 2000 lists at a time.
*
* @param maxResults Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100).
* @param pageToken Token specifying the result page to return. Optional.
*
* @return an instance of [ResourceListResponse] of type [TaskList], whose type is always [ResourceType.TaskLists].
*/
suspend fun list(maxResults: Int = 20, pageToken: String? = null): ResourceListResponse<TaskList>

/**
* [Updates the authenticated user's specified task list](https://developers.google.com/tasks/reference/rest/v1/tasklists/patch). This method supports patch semantics.
*
* @param taskListId Task list identifier.
* @param taskList the task list to patch.
*
* @return an instance of [TaskList].
*/
suspend fun patch(taskListId: String, taskList: TaskList): TaskList

/**
* [Updates the authenticated user's specified task list](https://developers.google.com/tasks/reference/rest/v1/tasklists/update).
*
* @param taskListId Task list identifier.
* @param taskList the task list to update.
*
* @return an instance of [TaskList].
*/
suspend fun update(taskListId: String, taskList: TaskList): TaskList
}

class HttpTaskListsApi(
private val httpClient: HttpClient
) : TaskListsApi {
override suspend fun delete(taskListId: String) {
val response = httpClient.delete("tasks/v1/users/@me/lists/${taskListId}")

if (response.status.isSuccess()) {
Expand All @@ -61,14 +113,7 @@ class TaskListsApi(
}
}

/**
* [Returns the authenticated user's specified task list](https://developers.google.com/tasks/reference/rest/v1/tasklists/get).
*
* @param taskListId Task list identifier.
*
* @return an instance of [TaskList].
*/
suspend fun get(taskListId: String): TaskList {
override suspend fun get(taskListId: String): TaskList {
val response = httpClient.get("tasks/v1/users/@me/lists/${taskListId}")

if (response.status.isSuccess()) {
Expand All @@ -78,14 +123,7 @@ class TaskListsApi(
}
}

/**
* [Creates a new task list](https://developers.google.com/tasks/reference/rest/v1/tasklists/insert) and adds it to the authenticated user's task lists. A user can have up to 2000 lists at a time.
*
* @param taskList the task list to insert.
*
* @return a newly created instance of [TaskList].
*/
suspend fun insert(taskList: TaskList): TaskList {
override suspend fun insert(taskList: TaskList): TaskList {
val response = httpClient.post("tasks/v1/users/@me/lists") {
contentType(ContentType.Application.Json)
setBody(taskList)
Expand All @@ -98,15 +136,7 @@ class TaskListsApi(
}
}

/**
* [Returns all the authenticated user's task lists](https://developers.google.com/tasks/reference/rest/v1/tasklists/list). A user can have up to 2000 lists at a time.
*
* @param maxResults Maximum number of task lists returned on one page. Optional. The default is 20 (max allowed: 100).
* @param pageToken Token specifying the result page to return. Optional.
*
* @return an instance of [ResourceListResponse] of type [TaskList], whose type is always [ResourceType.TaskLists].
*/
suspend fun list(maxResults: Int = 20, pageToken: String? = null): ResourceListResponse<TaskList> {
override suspend fun list(maxResults: Int, pageToken: String?): ResourceListResponse<TaskList> {
val response = httpClient.get("tasks/v1/users/@me/lists") {
parameter("maxResults", maxResults.coerceIn(0, 100))
if (pageToken != null) {
Expand All @@ -120,15 +150,7 @@ class TaskListsApi(
}
}

/**
* [Updates the authenticated user's specified task list](https://developers.google.com/tasks/reference/rest/v1/tasklists/patch). This method supports patch semantics.
*
* @param taskListId Task list identifier.
* @param taskList the task list to patch.
*
* @return an instance of [TaskList].
*/
suspend fun patch(taskListId: String, taskList: TaskList): TaskList {
override suspend fun patch(taskListId: String, taskList: TaskList): TaskList {
val response = httpClient.patch("tasks/v1/users/@me/lists/${taskListId}") {
contentType(ContentType.Application.Json)
setBody(taskList)
Expand All @@ -141,15 +163,7 @@ class TaskListsApi(
}
}

/**
* [Updates the authenticated user's specified task list](https://developers.google.com/tasks/reference/rest/v1/tasklists/update).
*
* @param taskListId Task list identifier.
* @param taskList the task list to update.
*
* @return an instance of [TaskList].
*/
suspend fun update(taskListId: String, taskList: TaskList): TaskList {
override suspend fun update(taskListId: String, taskList: TaskList): TaskList {
val response = httpClient.put("tasks/v1/users/@me/lists/${taskListId}") {
contentType(ContentType.Application.Json)
setBody(taskList)
Expand Down
Loading