[API] extend StopWatch (#9196)
* squash api-stopwatch * fix prepair logic! + add Tests * fix lint * more robust time compare * delete responce 202 -> 204 * change http responce in test too
This commit is contained in:
6543
techknowlogick
parent
382936a668
commit
aceb1085c7
9 changed files with 482 additions and 141 deletions
|
|
@ -584,6 +584,8 @@ func RegisterRoutes(m *macaron.Macaron) {
|
|||
})
|
||||
m.Get("/times", repo.ListMyTrackedTimes)
|
||||
|
||||
m.Get("/stopwatches", repo.GetStopwatches)
|
||||
|
||||
m.Get("/subscriptions", user.GetMyWatchedRepos)
|
||||
|
||||
m.Get("/teams", org.ListUserTeams)
|
||||
|
|
@ -691,6 +693,7 @@ func RegisterRoutes(m *macaron.Macaron) {
|
|||
m.Group("/stopwatch", func() {
|
||||
m.Post("/start", reqToken(), repo.StartIssueStopwatch)
|
||||
m.Post("/stop", reqToken(), repo.StopIssueStopwatch)
|
||||
m.Delete("/delete", reqToken(), repo.DeleteIssueStopwatch)
|
||||
})
|
||||
m.Group("/subscriptions", func() {
|
||||
m.Get("", repo.GetIssueSubscribers)
|
||||
|
|
|
|||
|
|
@ -598,141 +598,3 @@ func UpdateIssueDeadline(ctx *context.APIContext, form api.EditDeadlineOption) {
|
|||
|
||||
ctx.JSON(201, api.IssueDeadline{Deadline: &deadline})
|
||||
}
|
||||
|
||||
// StartIssueStopwatch creates a stopwatch for the given issue.
|
||||
func StartIssueStopwatch(ctx *context.APIContext) {
|
||||
// swagger:operation POST /repos/{owner}/{repo}/issues/{index}/stopwatch/start issue issueStartStopWatch
|
||||
// ---
|
||||
// summary: Start stopwatch on an issue.
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: name of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: index
|
||||
// in: path
|
||||
// description: index of the issue to create the stopwatch on
|
||||
// type: integer
|
||||
// format: int64
|
||||
// required: true
|
||||
// responses:
|
||||
// "201":
|
||||
// "$ref": "#/responses/empty"
|
||||
// "403":
|
||||
// description: Not repo writer, user does not have rights to toggle stopwatch
|
||||
// "404":
|
||||
// description: Issue not found
|
||||
// "409":
|
||||
// description: Cannot start a stopwatch again if it already exists
|
||||
issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
|
||||
if err != nil {
|
||||
if models.IsErrIssueNotExist(err) {
|
||||
ctx.NotFound()
|
||||
} else {
|
||||
ctx.Error(500, "GetIssueByIndex", err)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
if !ctx.Repo.CanWrite(models.UnitTypeIssues) {
|
||||
ctx.Status(403)
|
||||
return
|
||||
}
|
||||
|
||||
if !ctx.Repo.CanUseTimetracker(issue, ctx.User) {
|
||||
ctx.Status(403)
|
||||
return
|
||||
}
|
||||
|
||||
if models.StopwatchExists(ctx.User.ID, issue.ID) {
|
||||
ctx.Error(409, "StopwatchExists", "a stopwatch has already been started for this issue")
|
||||
return
|
||||
}
|
||||
|
||||
if err := models.CreateOrStopIssueStopwatch(ctx.User, issue); err != nil {
|
||||
ctx.Error(500, "CreateOrStopIssueStopwatch", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.Status(201)
|
||||
}
|
||||
|
||||
// StopIssueStopwatch stops a stopwatch for the given issue.
|
||||
func StopIssueStopwatch(ctx *context.APIContext) {
|
||||
// swagger:operation POST /repos/{owner}/{repo}/issues/{index}/stopwatch/stop issue issueStopWatch
|
||||
// ---
|
||||
// summary: Stop an issue's existing stopwatch.
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: name of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: index
|
||||
// in: path
|
||||
// description: index of the issue to stop the stopwatch on
|
||||
// type: integer
|
||||
// format: int64
|
||||
// required: true
|
||||
// responses:
|
||||
// "201":
|
||||
// "$ref": "#/responses/empty"
|
||||
// "403":
|
||||
// description: Not repo writer, user does not have rights to toggle stopwatch
|
||||
// "404":
|
||||
// description: Issue not found
|
||||
// "409":
|
||||
// description: Cannot stop a non existent stopwatch
|
||||
issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
|
||||
if err != nil {
|
||||
if models.IsErrIssueNotExist(err) {
|
||||
ctx.NotFound()
|
||||
} else {
|
||||
ctx.Error(500, "GetIssueByIndex", err)
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
if !ctx.Repo.CanWrite(models.UnitTypeIssues) {
|
||||
ctx.Status(403)
|
||||
return
|
||||
}
|
||||
|
||||
if !ctx.Repo.CanUseTimetracker(issue, ctx.User) {
|
||||
ctx.Status(403)
|
||||
return
|
||||
}
|
||||
|
||||
if !models.StopwatchExists(ctx.User.ID, issue.ID) {
|
||||
ctx.Error(409, "StopwatchExists", "cannot stop a non existent stopwatch")
|
||||
return
|
||||
}
|
||||
|
||||
if err := models.CreateOrStopIssueStopwatch(ctx.User, issue); err != nil {
|
||||
ctx.Error(500, "CreateOrStopIssueStopwatch", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.Status(201)
|
||||
}
|
||||
|
|
|
|||
216
routers/api/v1/repo/issue_stopwatch.go
Normal file
216
routers/api/v1/repo/issue_stopwatch.go
Normal file
|
|
@ -0,0 +1,216 @@
|
|||
// Copyright 2019 The Gitea Authors. All rights reserved.
|
||||
// Use of this source code is governed by a MIT-style
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
package repo
|
||||
|
||||
import (
|
||||
"code.gitea.io/gitea/models"
|
||||
"code.gitea.io/gitea/modules/context"
|
||||
)
|
||||
|
||||
// StartIssueStopwatch creates a stopwatch for the given issue.
|
||||
func StartIssueStopwatch(ctx *context.APIContext) {
|
||||
// swagger:operation POST /repos/{owner}/{repo}/issues/{index}/stopwatch/start issue issueStartStopWatch
|
||||
// ---
|
||||
// summary: Start stopwatch on an issue.
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: name of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: index
|
||||
// in: path
|
||||
// description: index of the issue to create the stopwatch on
|
||||
// type: integer
|
||||
// format: int64
|
||||
// required: true
|
||||
// responses:
|
||||
// "201":
|
||||
// "$ref": "#/responses/empty"
|
||||
// "403":
|
||||
// description: Not repo writer, user does not have rights to toggle stopwatch
|
||||
// "404":
|
||||
// description: Issue not found
|
||||
// "409":
|
||||
// description: Cannot start a stopwatch again if it already exists
|
||||
issue, err := prepareIssueStopwatch(ctx, false)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if err := models.CreateOrStopIssueStopwatch(ctx.User, issue); err != nil {
|
||||
ctx.Error(500, "CreateOrStopIssueStopwatch", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.Status(201)
|
||||
}
|
||||
|
||||
// StopIssueStopwatch stops a stopwatch for the given issue.
|
||||
func StopIssueStopwatch(ctx *context.APIContext) {
|
||||
// swagger:operation POST /repos/{owner}/{repo}/issues/{index}/stopwatch/stop issue issueStopStopWatch
|
||||
// ---
|
||||
// summary: Stop an issue's existing stopwatch.
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: name of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: index
|
||||
// in: path
|
||||
// description: index of the issue to stop the stopwatch on
|
||||
// type: integer
|
||||
// format: int64
|
||||
// required: true
|
||||
// responses:
|
||||
// "201":
|
||||
// "$ref": "#/responses/empty"
|
||||
// "403":
|
||||
// description: Not repo writer, user does not have rights to toggle stopwatch
|
||||
// "404":
|
||||
// description: Issue not found
|
||||
// "409":
|
||||
// description: Cannot stop a non existent stopwatch
|
||||
issue, err := prepareIssueStopwatch(ctx, true)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if err := models.CreateOrStopIssueStopwatch(ctx.User, issue); err != nil {
|
||||
ctx.Error(500, "CreateOrStopIssueStopwatch", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.Status(201)
|
||||
}
|
||||
|
||||
// DeleteIssueStopwatch delete a specific stopwatch
|
||||
func DeleteIssueStopwatch(ctx *context.APIContext) {
|
||||
// swagger:operation DELETE /repos/{owner}/{repo}/issues/{index}/stopwatch/delete issue issueDeleteStopWatch
|
||||
// ---
|
||||
// summary: Delete an issue's existing stopwatch.
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: name of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: index
|
||||
// in: path
|
||||
// description: index of the issue to stop the stopwatch on
|
||||
// type: integer
|
||||
// format: int64
|
||||
// required: true
|
||||
// responses:
|
||||
// "204":
|
||||
// "$ref": "#/responses/empty"
|
||||
// "403":
|
||||
// description: Not repo writer, user does not have rights to toggle stopwatch
|
||||
// "404":
|
||||
// description: Issue not found
|
||||
// "409":
|
||||
// description: Cannot cancel a non existent stopwatch
|
||||
issue, err := prepareIssueStopwatch(ctx, true)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if err := models.CancelStopwatch(ctx.User, issue); err != nil {
|
||||
ctx.Error(500, "CancelStopwatch", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.Status(204)
|
||||
}
|
||||
|
||||
func prepareIssueStopwatch(ctx *context.APIContext, shouldExist bool) (*models.Issue, error) {
|
||||
issue, err := models.GetIssueByIndex(ctx.Repo.Repository.ID, ctx.ParamsInt64(":index"))
|
||||
if err != nil {
|
||||
if models.IsErrIssueNotExist(err) {
|
||||
ctx.NotFound()
|
||||
} else {
|
||||
ctx.Error(500, "GetIssueByIndex", err)
|
||||
}
|
||||
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if !ctx.Repo.CanWrite(models.UnitTypeIssues) {
|
||||
ctx.Status(403)
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if !ctx.Repo.CanUseTimetracker(issue, ctx.User) {
|
||||
ctx.Status(403)
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if models.StopwatchExists(ctx.User.ID, issue.ID) != shouldExist {
|
||||
if shouldExist {
|
||||
ctx.Error(409, "StopwatchExists", "cannot stop/cancel a non existent stopwatch")
|
||||
} else {
|
||||
ctx.Error(409, "StopwatchExists", "cannot start a stopwatch again if it already exists")
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return issue, nil
|
||||
}
|
||||
|
||||
// GetStopwatches get all stopwatches
|
||||
func GetStopwatches(ctx *context.APIContext) {
|
||||
// swagger:operation GET /user/stopwatches user userGetStopWatches
|
||||
// ---
|
||||
// summary: Get list of all existing stopwatches
|
||||
// consumes:
|
||||
// - application/json
|
||||
// produces:
|
||||
// - application/json
|
||||
// responses:
|
||||
// "200":
|
||||
// "$ref": "#/responses/StopWatchList"
|
||||
|
||||
sws, err := models.GetUserStopwatches(ctx.User.ID)
|
||||
if err != nil {
|
||||
ctx.Error(500, "GetUserStopwatches", err)
|
||||
return
|
||||
}
|
||||
|
||||
apiSWs, err := sws.APIFormat()
|
||||
if err != nil {
|
||||
ctx.Error(500, "APIFormat", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.JSON(200, apiSWs)
|
||||
}
|
||||
|
|
@ -85,6 +85,20 @@ type swaggerIssueDeadline struct {
|
|||
Body api.IssueDeadline `json:"body"`
|
||||
}
|
||||
|
||||
// StopWatch
|
||||
// swagger:response StopWatch
|
||||
type swaggerResponseStopWatch struct {
|
||||
// in:body
|
||||
Body api.StopWatch `json:"body"`
|
||||
}
|
||||
|
||||
// StopWatchList
|
||||
// swagger:response StopWatchList
|
||||
type swaggerResponseStopWatchList struct {
|
||||
// in:body
|
||||
Body []api.StopWatch `json:"body"`
|
||||
}
|
||||
|
||||
// EditReactionOption
|
||||
// swagger:response EditReactionOption
|
||||
type swaggerEditReactionOption struct {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue