71 lines
2.7 KiB
Go
71 lines
2.7 KiB
Go
// Vikunja is a to-do list application to facilitate your life.
|
|
// Copyright 2018-present Vikunja and contributors. All rights reserved.
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package client
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
|
|
"code.vikunja.io/veans/internal/output"
|
|
)
|
|
|
|
// CreateBotUser provisions a bot user via POST /user/bots. The username must
|
|
// be prefixed `bot-` (Vikunja enforces this). The caller becomes the bot's
|
|
// owner, which is what allows them to mint API tokens for the bot via
|
|
// POST /tokens with owner_id.
|
|
//
|
|
// On Vikunja versions that predate the /user/bots endpoint, the server
|
|
// returns 404, which we surface as BOT_USERS_UNAVAILABLE so init can fail
|
|
// fast with a clear message.
|
|
func (c *Client) CreateBotUser(ctx context.Context, username, name string) (*BotUser, error) {
|
|
var out BotUser
|
|
err := c.Do(ctx, "POST", "/user/bots", nil, &BotUserCreate{Username: username, Name: name}, &out)
|
|
if err != nil {
|
|
var oe *output.Error
|
|
if errors.As(err, &oe) && oe.Code == output.CodeNotFound {
|
|
return nil, output.Wrap(output.CodeBotUsersUnavailable, err,
|
|
"this Vikunja instance does not expose /user/bots — upgrade to a newer version")
|
|
}
|
|
return nil, err
|
|
}
|
|
return &out, nil
|
|
}
|
|
|
|
// ListBotUsers returns all bot users owned by the authenticated user. The v2
|
|
// endpoint is server-paginated (BotUser.ReadAll applies a 50-item page limit),
|
|
// so page through to the end instead of returning only the first page.
|
|
func (c *Client) ListBotUsers(ctx context.Context) ([]*BotUser, error) {
|
|
return doListAll[*BotUser](ctx, c, "/user/bots")
|
|
}
|
|
|
|
// FindMyBotByUsername scans the caller's owned bots for one with the given
|
|
// username and returns it, or nil if no match. Useful for distinguishing
|
|
// "name is taken by someone else" from "name is taken by me" before
|
|
// attempting creation.
|
|
func (c *Client) FindMyBotByUsername(ctx context.Context, username string) (*BotUser, error) {
|
|
bots, err := c.ListBotUsers(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
for _, b := range bots {
|
|
if b != nil && b.Username == username {
|
|
return b, nil
|
|
}
|
|
}
|
|
return nil, nil
|
|
}
|