From 8a4161c72335900407b8f111027ad9ed53c0b631 Mon Sep 17 00:00:00 2001 From: Ethan Koenig Date: Fri, 23 Dec 2016 20:53:11 -0500 Subject: [PATCH] API Endpoint for watching (#191) --- models/user.go | 15 +++++ routers/api/v1/api.go | 9 +++ routers/api/v1/user/watch.go | 123 +++++++++++++++++++++++++++++++++++ 3 files changed, 147 insertions(+) create mode 100644 routers/api/v1/user/watch.go diff --git a/models/user.go b/models/user.go index 1b8ebce43..1b645a528 100644 --- a/models/user.go +++ b/models/user.go @@ -1241,3 +1241,18 @@ func GetStarredRepos(userID int64, private bool) ([]*Repository, error) { } return repos, nil } + +// GetWatchedRepos returns the repos watched by a particular user +func GetWatchedRepos(userID int64, private bool) ([]*Repository, error) { + sess := x.Where("watch.user_id=?", userID). + Join("LEFT", "watch", "`repository`.id=`watch`.repo_id") + if !private { + sess = sess.And("is_private=?", false) + } + repos := make([]*Repository, 0, 10) + err := sess.Find(&repos) + if err != nil { + return nil, err + } + return repos, nil +} diff --git a/routers/api/v1/api.go b/routers/api/v1/api.go index 9943b97f7..11adfa5c5 100644 --- a/routers/api/v1/api.go +++ b/routers/api/v1/api.go @@ -209,6 +209,8 @@ func RegisterRoutes(m *macaron.Macaron) { }) m.Get("/starred", user.GetStarredRepos) + + m.Get("/subscriptions", user.GetWatchedRepos) }) }, reqToken()) @@ -239,6 +241,8 @@ func RegisterRoutes(m *macaron.Macaron) { m.Delete("", user.Unstar) }, context.ExtractOwnerAndRepo()) }) + + m.Get("/subscriptions", user.GetMyWatchedRepos) }, reqToken()) // Repositories @@ -316,6 +320,11 @@ func RegisterRoutes(m *macaron.Macaron) { Patch(reqRepoWriter(), bind(api.EditMilestoneOption{}), repo.EditMilestone). Delete(reqRepoWriter(), repo.DeleteMilestone) }) + m.Group("/subscription", func() { + m.Get("", user.IsWatching) + m.Put("", user.Watch) + m.Delete("", user.Unwatch) + }, context.ExtractOwnerAndRepo()) m.Get("/editorconfig/:filename", context.RepoRef(), repo.GetEditorconfig) m.Group("/pulls", func() { m.Combo("").Get(bind(api.ListPullRequestsOptions{}), repo.ListPullRequests).Post(reqRepoWriter(), bind(api.CreatePullRequestOption{}), repo.CreatePullRequest) diff --git a/routers/api/v1/user/watch.go b/routers/api/v1/user/watch.go new file mode 100644 index 000000000..6a9ad670d --- /dev/null +++ b/routers/api/v1/user/watch.go @@ -0,0 +1,123 @@ +// Copyright 2016 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 user + +import ( + "time" + + api "code.gitea.io/sdk/gitea" + + "code.gitea.io/gitea/models" + "code.gitea.io/gitea/modules/context" + "code.gitea.io/gitea/modules/setting" +) + +// WatchInfo contains information about a watched repository +type WatchInfo struct { + Subscribed bool `json:"subscribed"` + Ignored bool `json:"ignored"` + Reason interface{} `json:"reason"` + CreatedAt time.Time `json:"created_at"` + URL string `json:"url"` + RepositoryURL string `json:"repository_url"` +} + +// getWatchedRepos returns the repos that the user with the specified userID is +// watching +func getWatchedRepos(userID int64, private bool) ([]*api.Repository, error) { + watchedRepos, err := models.GetWatchedRepos(userID, private) + if err != nil { + return nil, err + } + user, err := models.GetUserByID(userID) + if err != nil { + return nil, err + } + + repos := make([]*api.Repository, len(watchedRepos)) + for i, watched := range watchedRepos { + access, err := models.AccessLevel(user, watched) + if err != nil { + return nil, err + } + repos[i] = watched.APIFormat(access) + } + return repos, nil +} + +// GetWatchedRepos returns the repos that the user specified in ctx is watching +func GetWatchedRepos(ctx *context.APIContext) { + user := GetUserByParams(ctx) + private := user.ID == ctx.User.ID + repos, err := getWatchedRepos(user.ID, private) + if err != nil { + ctx.Error(500, "getWatchedRepos", err) + } + ctx.JSON(200, &repos) +} + +// GetMyWatchedRepos returns the repos that the authenticated user is watching +func GetMyWatchedRepos(ctx *context.APIContext) { + repos, err := getWatchedRepos(ctx.User.ID, true) + if err != nil { + ctx.Error(500, "getWatchedRepos", err) + } + ctx.JSON(200, &repos) +} + +// IsWatching returns whether the authenticated user is watching the repo +// specified in ctx +func IsWatching(ctx *context.APIContext) { + if models.IsWatching(ctx.User.ID, ctx.Repo.Repository.ID) { + ctx.JSON(200, WatchInfo{ + Subscribed: true, + Ignored: false, + Reason: nil, + CreatedAt: ctx.Repo.Repository.Created, + URL: subscriptionURL(ctx.Repo.Repository), + RepositoryURL: repositoryURL(ctx.Repo.Repository), + }) + } else { + ctx.Status(404) + } +} + +// Watch the repo specified in ctx, as the authenticated user +func Watch(ctx *context.APIContext) { + err := models.WatchRepo(ctx.User.ID, ctx.Repo.Repository.ID, true) + if err != nil { + ctx.Error(500, "WatchRepo", err) + return + } + ctx.JSON(200, WatchInfo{ + Subscribed: true, + Ignored: false, + Reason: nil, + CreatedAt: ctx.Repo.Repository.Created, + URL: subscriptionURL(ctx.Repo.Repository), + RepositoryURL: repositoryURL(ctx.Repo.Repository), + }) + +} + +// Unwatch the repo specified in ctx, as the authenticated user +func Unwatch(ctx *context.APIContext) { + err := models.WatchRepo(ctx.User.ID, ctx.Repo.Repository.ID, false) + if err != nil { + ctx.Error(500, "UnwatchRepo", err) + return + } + ctx.Status(204) +} + +// subscriptionURL returns the URL of the subscription API endpoint of a repo +func subscriptionURL(repo *models.Repository) string { + return repositoryURL(repo) + "/subscription" +} + +// repositoryURL returns the URL of the API endpoint of a repo +func repositoryURL(repo *models.Repository) string { + return setting.AppURL + "api/v1/" + repo.FullName() +}