API endpoints for stars #100
Conversation
Current coverage is 3.03% (diff: 0.00%)@@ master #100 diff @@
========================================
Files 33 33
Lines 8096 8106 +10
Methods 0 0
Messages 0 0
Branches 0 0
========================================
Hits 246 246
- Misses 7830 7840 +10
Partials 20 20
|
| @@ -1121,3 +1121,22 @@ func UnfollowUser(userID, followID int64) (err error) { | |||
| } | |||
| return sess.Commit() | |||
| } | |||
|
|
|||
| func GetStarredRepos(userID int64) ([]*Repository, error) { | |||
There was a problem hiding this comment.
Please add comments too for linting
lunny
added
the
type/feature
|
Unit tests would be needed for the new APIs |
| @@ -238,7 +238,7 @@ func Migrate(ctx *context.APIContext, form auth.MigrateRepoForm) { | |||
| ctx.JSON(201, repo.APIFormat(&api.Permission{true, true, true})) | |||
| } | |||
|
|
|||
| func parseOwnerAndRepo(ctx *context.APIContext) (*models.User, *models.Repository) { | |||
| func ParseOwnerAndRepo(ctx *context.APIContext) (*models.User, *models.Repository) { | |||
There was a problem hiding this comment.
This should be moved to a middleware instead.
There was a problem hiding this comment.
Also I don't think "Parse" is the correct word for what it does either :)
There was a problem hiding this comment.
Please add comments for the function for linting
|
|
||
| "github.com/go-gitea/gitea/modules/context" | ||
| "github.com/go-gitea/gitea/models" | ||
| "github.com/go-gitea/gitea/routers/api/v1/repo" |
| @@ -1121,3 +1121,22 @@ func UnfollowUser(userID, followID int64) (err error) { | |||
| } | |||
| return sess.Commit() | |||
| } | |||
|
|
|||
| func GetStarredRepos(userID int64) ([]*Repository, error) { | |||
There was a problem hiding this comment.
Please add comments too for linting
| @@ -238,7 +238,7 @@ func Migrate(ctx *context.APIContext, form auth.MigrateRepoForm) { | |||
| ctx.JSON(201, repo.APIFormat(&api.Permission{true, true, true})) | |||
| } | |||
|
|
|||
| func parseOwnerAndRepo(ctx *context.APIContext) (*models.User, *models.Repository) { | |||
| func ParseOwnerAndRepo(ctx *context.APIContext) (*models.User, *models.Repository) { | |||
There was a problem hiding this comment.
Please add comments for the function for linting
| "github.com/go-gitea/gitea/routers/api/v1/repo" | ||
| ) | ||
|
|
||
| func getStarredRepos(userID int64) ([]*api.Repository, error) { |
There was a problem hiding this comment.
Since you are at it, please add comments for linting.
| return repos, nil | ||
| } | ||
|
|
||
| func GetStarredRepos(ctx *context.APIContext) { |
There was a problem hiding this comment.
Since you are at it, please add comments for linting.
| ctx.JSON(200, &repos) | ||
| } | ||
|
|
||
| func GetMyStarredRepos(ctx *context.APIContext) { |
There was a problem hiding this comment.
Since you are at it, please add comments for linting.
| ctx.JSON(200, &repos) | ||
| } | ||
|
|
||
| func IsStarring(ctx *context.APIContext) { |
There was a problem hiding this comment.
Since you are at it, please add comments for linting.
| } | ||
| } | ||
|
|
||
| func Star(ctx *context.APIContext) { |
There was a problem hiding this comment.
Since you are at it, please add comments for linting.
| ctx.Status(204) | ||
| } | ||
|
|
||
| func Unstar(ctx *context.APIContext) { |
There was a problem hiding this comment.
Since you are at it, please add comments for linting.
ethantkoenig
force-pushed
the
develop
branch
from
89fb055 to
25f63a9
Compare
| // Get the repos starred by a particular user | ||
| func GetStarredRepos(userID int64) ([]*Repository, error) { | ||
| sess := x.Where("star.uid=?", userID) | ||
| if setting.UsePostgreSQL { |
There was a problem hiding this comment.
please remove database condition, just use
sess.Join("LEFT", "star", "`repository`.id=star.uid")is OK.
There was a problem hiding this comment.
I don't understand. repository.id is a repo id, and star.uid is a user id; why are we comparing them? I thought that repo ids and user ids were different things. It also seems that your suggestion ignores the userID variable, which doesn't seem right.
Please correct me if I'm wrong.
There was a problem hiding this comment.
sess.Join("LEFT", "star", "`repository`.id=star. repo_id")mistake. I mean we don't need if setting.UsePostgreSQL
|
Great work! For unit test with database. I think that should be next work. |
ethantkoenig
force-pushed
the
develop
branch
from
25f63a9 to
399e6c1
Compare
|
@lunny Fixed |
| sess = sess.Join("LEFT", "star", `"repository".id=star.repo_id`) | ||
| repos := make([]*Repository, 0, 10) | ||
| err := sess.Find(&repos) | ||
| if err != nil { |
There was a problem hiding this comment.
I think it could be simpler
repos := make([]*Repository, 0, 10)
err := x.Where("star.uid=?", userID).
Join("LEFT", "star", `"repository".id=star.repo_id`).
Find(&repos)
ethantkoenig
force-pushed
the
develop
branch
3 times, most recently
from
cf3fd36 to
9debb0b
Compare
| func GetStarredRepos(userID int64) ([]*Repository, error) { | ||
| repos := make([]*Repository, 0, 10) | ||
| err := x.Where("star.uid=?", userID). | ||
| Join("LEFT", "star", `"repository".id=star.repo_id`). |
There was a problem hiding this comment.
this line should be
Join("LEFT", "star", "`repository`.id=`star`.repo_id").
ethantkoenig
force-pushed
the
develop
branch
from
9debb0b to
218454f
Compare
|
LGTM |
| func GetStarredRepos(userID int64) ([]*Repository, error) { | ||
| repos := make([]*Repository, 0, 10) | ||
| err := x.Where("star.uid=?", userID). | ||
| Join("LEFT", "star", "`repository`.id=`star`.repo_id"). |
There was a problem hiding this comment.
Does this quoting work for all 3 databases?
There was a problem hiding this comment.
According to @lunny's comment from earlier today, yes.
|
LGTM |
There was a problem hiding this comment.
Please read this: https://blog.golang.org/godoc-documenting-go-code especially this:
Notice this comment is a complete sentence that begins with the name of the element it describes. This important convention allows us to generate documentation in a variety of formats, from plain text to HTML to UNIX man pages, and makes it read better when tools truncate it for brevity, such as when they extract the first line or sentence.
| @@ -70,3 +71,29 @@ func APIContexter() macaron.Handler { | |||
| c.Map(ctx) | |||
| } | |||
| } | |||
|
|
|||
| // Extracts the owner and repo from an APIContext, or issues an error status | |||
There was a problem hiding this comment.
Needs to start with ExtractOwnerAndRepo 😒
| return repos, nil | ||
| } | ||
|
|
||
| // Returns the repos that the user specified by the APIContext has starred |
| ctx.JSON(200, &repos) | ||
| } | ||
|
|
||
| // Returns the repos that the authenticated user has starred |
| ctx.JSON(200, &repos) | ||
| } | ||
|
|
||
| // Returns whether the authenticated is starring the repo |
| "code.gitea.io/gitea/models" | ||
| ) | ||
|
|
||
| // Returns the repos that the user with the specified userID has starred |
There was a problem hiding this comment.
While this function isn't exported (therefore doesn't need a lint-comment), it would be nice to follow conventions everywhere :)
| return nil, nil | ||
| } | ||
|
|
||
| return owner, repo |
There was a problem hiding this comment.
Preferably, a middleware injects this into ctx.Data["Owner"], ctx.Data["Repo"] and returns nothing. Then it can be used as follows:
m.Group("/starred", context.ExtractOwnerAndRepo(), func() {
m.Get("", user.GetMyStarredRepos)
m.Group("/:username/:reponame", func() {
m.Get("", user.IsStarring)
m.Put("", user.Star)
m.Delete("", user.Unstar)
})
})
see context.RepoRef() for reference 🙂
There was a problem hiding this comment.
@bkcsoft Would be appropriate to use context.RepoAssignment() for populating ctx.Repo.Owner and ctx.Repo.Repository? It seems to already do what we need ExtractRepoAndOwner() to do. This way, we could get rid of ExtractRepoAndOwner() completely.
bkcsoft
added
issue/needs-feedback
ethantkoenig
force-pushed
the
develop
branch
from
218454f to
656f605
Compare
|
@bkcsoft Unfortunately, Regardless, I've updated |
ethantkoenig
force-pushed
the
develop
branch
2 times, most recently
from
3522337 to
197b958
Compare
| @@ -8,6 +8,7 @@ import ( | |||
| "fmt" | |||
| "strings" | |||
|
|
|||
| "code.gitea.io/gitea/models" | |||
There was a problem hiding this comment.
this line isn't gofmt. I would merge anyway, as this is minor and we can update with another PR. Probably there's more like that anyway which we can push all together.
There was a problem hiding this comment.
Good catch! I've fixed several gofmt issues (mostly spaces vs. tabs)
ethantkoenig
force-pushed
the
develop
branch
from
197b958 to
f216e32
Compare
| @@ -1179,3 +1179,15 @@ func UnfollowUser(userID, followID int64) (err error) { | |||
| } | |||
| return sess.Commit() | |||
| } | |||
|
|
|||
| // GetStarredRepos returns the repos starred by a particular user | |||
| func GetStarredRepos(userID int64) ([]*Repository, error) { | |||
There was a problem hiding this comment.
This function should return only stars of public repos by default, unless the user is the logged in user.
See #181 as example
There was a problem hiding this comment.
Fixed, thanks for the heads up!
ethantkoenig
force-pushed
the
develop
branch
from
f216e32 to
0834e49
Compare
|
LGTM |
andreynering
added
lgtm/done
andreynering
removed
the
lgtm/done
tboerger
added
the
lgtm/done
This pull request adds the following API endpoints:
GET /users/:username/starred: List repositories starred by a userGET /user/starred: List repositories starred by authenticated userGET /user/starred/:owner/:repo: If authenticated user is starring a repositoryPUT /user/starred/:owner/:repo: Star a repository (as authenticated user)DELETE /user/starred/:owner/:repo: Unstar a repository (as authenticated user)Each of these endpoints already exists in the Github API.