users.go

package asana

import (
	"context"
	"fmt"
)

// User represents an account in Asana that can be given access to various
// workspaces, projects, and tasks.
//
// Like other objects in the system, users are referred to by numerical IDs.
// However, the special string identifier me can be used anywhere a user ID is
// accepted, to refer to the current authenticated user.
type User struct {
	// Read-only. Globally unique ID of the object
	ID string `json:"gid,omitempty"`

	// Read-only. The name of the object.
	Name string `json:"name,omitempty"`

	// Read-only. The user’s email address.
	Email string `json:"email,omitempty"`

	// Read-only. A map of the user’s profile photo in various sizes, or null
	// if no photo is set. Sizes provided are 21, 27, 36, 60, and 128. Images
	// are in PNG format.
	Photo map[string]string `json:"photo,omitempty"`

	// Read-only. Workspaces and organizations this user may access.
	//
	// Note: The API will only return workspaces and organizations that also
	// contain the authenticated user.
	Workspaces []*Workspace `json:"workspaces,omitempty"`
}

// CurrentUser gets the currently authorized user
func (c *Client) CurrentUser(ctx context.Context) (*User, error) {

	result := &User{}

	_, err := c.get(ctx, "/users/me", nil, result)

	return result, err
}

// Fetch loads the full details for this User
func (u *User) Fetch(ctx context.Context, client *Client, options ...*Options) error {
	client.trace("Loading details for user %q", u.ID)

	_, err := client.get(ctx, fmt.Sprintf("/users/%s", u.ID), nil, u, options...)
	return err
}

type TaskList struct {
	ID           string `json:"gid"`
	ResourceType string `json:"resource_type"`
	Name         string `json:"name"`
}

// GetTaskList fetches the task list for this User on a worpkspace
func (u *User) GetTaskList(ctx context.Context, client *Client, workspaceID string, options ...*Options) (*TaskList, error) {
	client.trace("Getting task list for user %q", u.ID)
	var result *TaskList

	workspace := &Options{
		Workspace: workspaceID,
	}

	allOptions := append([]*Options{workspace}, options...)

	_, err := client.get(ctx, fmt.Sprintf("/users/%s/user_task_list", u.ID), nil, &result, allOptions...)
	return result, err
}

// Users returns the compact records for all users in the organization visible to the authorized user
func (w *Workspace) Users(ctx context.Context, client *Client, options ...*Options) ([]*User, *NextPage, error) {
	client.trace("Listing users in workspace %s...\n", w.ID)
	var result []*User

	// Make the request
	queryOptions := append([]*Options{&Options{Workspace: w.ID}}, options...)
	nextPage, err := client.get(ctx, "/users", nil, &result, queryOptions...)
	return result, nextPage, err
}

// AllUsers repeatedly pages through all available users in a workspace
func (w *Workspace) AllUsers(ctx context.Context, client *Client, options ...*Options) ([]*User, error) {
	var allUsers []*User
	nextPage := &NextPage{}

	var users []*User
	var err error

	for nextPage != nil {
		page := &Options{
			Limit:  50,
			Offset: nextPage.Offset,
		}

		allOptions := append([]*Options{page}, options...)
		users, nextPage, err = w.Users(ctx, client, allOptions...)
		if err != nil {
			return nil, err
		}

		allUsers = append(allUsers, users...)
	}
	return allUsers, nil
}