amigan/snoobert
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add tests

Browse source 
Signed-off-by: Vartan Benohanian <vartanbeno@gmail.com>
This commit is contained in:
Vartan Benohanian 2020-08-18 23:12:35 -04:00
parent 29fdb0fa19
commit 011cd2a78b
7 changed files with 399 additions and 68 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
comment.go
View file

@ -5,6 +5,7 @@ import (
"errors"
"net/http"
"net/url"
"strings"
)
// CommentService handles communication with the comment
@ -78,19 +79,16 @@ func (s *CommentService) LoadMoreReplies(ctx context.Context, comment *Comment)
postID := comment.PostID
commentIDs := comment.Replies.More.Children
type params struct {
PostID string `url:"link_id"`
IDs []string `url:"children,comma"`
APIType string `url:"api_type"`
}
form := url.Values{}
form.Set("api_type", "json")
form.Set("link_id", postID)
form.Set("children", strings.Join(commentIDs, ","))
path := "api/morechildren"
path, err := addOptions(path, params{postID, commentIDs, "json"})
if err != nil {
return nil, err
}
req, err := s.client.NewRequest(http.MethodGet, path, nil)
// This was originally a GET, but with POST you can send a bigger payload
// since it's in the body and not the URI.
req, err := s.client.NewRequestWithForm(http.MethodPost, path, form)
if err != nil {
return nil, err
}

46
comment_test.go
View file

@ -301,3 +301,49 @@ func TestCommentService_RemoveVote(t *testing.T) {
require.NoError(t, err)
require.Equal(t, http.StatusOK, res.StatusCode)
}
func TestCommentService_LoadMoreReplies(t *testing.T) {
setup()
defer teardown()
blob, err := readFileContents("testdata/comment/more.json")
require.NoError(t, err)
mux.HandleFunc("/api/morechildren", func(w http.ResponseWriter, r *http.Request) {
require.Equal(t, http.MethodPost, r.Method)
form := url.Values{}
form.Set("link_id", "t3_123")
form.Set("children", "def,ghi,jkl")
form.Set("api_type", "json")
err := r.ParseForm()
require.NoError(t, err)
require.Equal(t, form, r.PostForm)
fmt.Fprint(w, blob)
})
_, err = client.Comment.LoadMoreReplies(ctx, nil)
require.EqualError(t, err, "comment: cannot be nil")
resp, err := client.Comment.LoadMoreReplies(ctx, &Comment{})
require.Nil(t, resp)
require.Nil(t, err)
comment := &Comment{
FullID: "t1_abc",
PostID: "t3_123",
Replies: Replies{
More: &More{
Children: []string{"def", "ghi", "jkl"},
},
},
}
_, err = client.Comment.LoadMoreReplies(ctx, comment)
require.Nil(t, err)
require.False(t, comment.HasMore())
require.Len(t, comment.Replies.Comments, 2)
require.Len(t, comment.Replies.Comments[0].Replies.Comments, 1)
}

4
post.go
View file

@ -471,7 +471,7 @@ func (s *PostService) LoadMoreComments(ctx context.Context, pc *PostAndComments)
}
postID := pc.Post.FullID
commentIDs := pc.MoreComments.Children
commentIDs := pc.More.Children
form := url.Values{}
form.Set("api_type", "json")
@ -515,7 +515,7 @@ func (s *PostService) LoadMoreComments(ctx context.Context, pc *PostAndComments)
}
if noMore {
pc.MoreComments = nil
pc.More = nil
}
return resp, nil

73
post_test.go
View file

@ -820,72 +820,56 @@ func TestPostService_DisableContestMode(t *testing.T) {
require.Equal(t, http.StatusOK, res.StatusCode)
}
func TestPostService_More(t *testing.T) {
func TestPostService_LoadMoreReplies(t *testing.T) {
setup()
defer teardown()
parentComment := &Comment{
FullID: "t1_abc",
ParentID: "t3_123",
PostID: "t3_123",
Replies: Replies{
More: &More{
Children: []string{"def,ghi"},
},
},
}
blob, err := readFileContents("testdata/post/more.json")
require.NoError(t, err)
mux.HandleFunc("/api/morechildren", func(w http.ResponseWriter, r *http.Request) {
require.Equal(t, http.MethodGet, r.Method)
require.Equal(t, http.MethodPost, r.Method)
form := url.Values{}
form.Set("link_id", "t3_123")
form.Set("children", "def,ghi")
form.Set("children", "def,ghi,jkl")
form.Set("api_type", "json")
err := r.ParseForm()
require.NoError(t, err)
require.Equal(t, form, r.Form)
require.Equal(t, form, r.PostForm)
fmt.Fprint(w, blob)
})
_, err = client.Comment.LoadMoreReplies(ctx, parentComment)
require.NoError(t, err)
require.Nil(t, parentComment.Replies.More)
require.Len(t, parentComment.Replies.Comments, 1)
require.Len(t, parentComment.Replies.Comments[0].Replies.Comments, 1)
}
_, err = client.Post.LoadMoreComments(ctx, nil)
require.EqualError(t, err, "pc: cannot be nil")
func TestPostService_MoreNil(t *testing.T) {
setup()
defer teardown()
resp, err := client.Post.LoadMoreComments(ctx, &PostAndComments{})
require.Nil(t, resp)
require.Nil(t, err)
_, err := client.Comment.LoadMoreReplies(ctx, nil)
require.EqualError(t, err, "comment: cannot be nil")
parentComment := &Comment{
Replies: Replies{
More: nil,
pc := &PostAndComments{
Post: &Post{
FullID: "t3_123",
},
Comments: []*Comment{
{
FullID: "t1_abc",
},
},
More: &More{
Children: []string{"def", "ghi", "jkl"},
},
}
// should return nil, nil since comment does not have More struct
resp, err := client.Comment.LoadMoreReplies(ctx, parentComment)
_, err = client.Post.LoadMoreComments(ctx, pc)
require.NoError(t, err)
require.Nil(t, resp)
parentComment.Replies.More = &More{
Children: []string{},
}
// should return nil, nil since comment's More struct has 0 children
resp, err = client.Comment.LoadMoreReplies(ctx, parentComment)
require.NoError(t, err)
require.Nil(t, resp)
require.False(t, pc.HasMore())
require.Len(t, pc.Comments, 2)
require.True(t, pc.Comments[1].HasMore())
require.Len(t, pc.Comments[0].Replies.Comments, 1)
require.Len(t, pc.Comments[0].Replies.Comments[0].Replies.Comments, 1)
}
func TestPostService_RandomFromSubreddits(t *testing.T) {
@ -1162,6 +1146,9 @@ func TestPostService_MarkVisited(t *testing.T) {
require.Equal(t, form, r.PostForm)
})
_, err := client.Post.MarkVisited(ctx, "t3_test1", "t3_test2", "t3_test3")
_, err := client.Post.MarkVisited(ctx)
require.EqualError(t, err, "must provide at least 1 id")
_, err = client.Post.MarkVisited(ctx, "t3_test1", "t3_test2", "t3_test3")
require.NoError(t, err)
}

222
testdata/comment/more.json vendored Normal file
View file

@ -0,0 +1,222 @@
{
"json": {
"errors": [],
"data": {
"things": [
{
"kind": "t1",
"data": {
"total_awards_received": 0,
"approved_at_utc": null,
"edited": false,
"mod_reason_by": null,
"banned_by": null,
"author_flair_type": "text",
"removal_reason": null,
"link_id": "t3_123",
"author_flair_template_id": null,
"likes": null,
"replies": "",
"user_reports": [],
"saved": false,
"id": "def",
"banned_at_utc": null,
"mod_reason_title": null,
"gilded": 0,
"archived": false,
"no_follow": false,
"author": "testuser1",
"can_mod_post": false,
"send_replies": true,
"parent_id": "t1_abc",
"score": 5,
"author_fullname": "t2_user1",
"approved_by": null,
"mod_note": null,
"all_awardings": [],
"subreddit_id": "t5_2qh1i",
"body": "Wow, I came here to say exactly this and figured it would be buried. Pleasantly shocked to see your comment as the top comment! So. Good. Thanks, random internet friend!",
"awarders": [],
"downs": 0,
"author_flair_css_class": null,
"name": "t1_def",
"author_patreon_flair": false,
"collapsed": false,
"author_flair_richtext": [],
"is_submitter": false,
"body_html": "&lt;div class=\"md\"&gt;&lt;p&gt;Wow, I came here to say exactly this and figured it would be buried. Pleasantly shocked to see your comment as the top comment! So. Good. Thanks, random internet friend!&lt;/p&gt;\n&lt;/div&gt;",
"gildings": {},
"collapsed_reason": null,
"distinguished": null,
"associated_award": null,
"stickied": false,
"author_premium": false,
"can_gild": true,
"top_awarded_type": null,
"author_flair_text_color": null,
"score_hidden": false,
"permalink": "/r/AskReddit/comments/123/which_scene_from_an_animated_film_will_always_be/def/",
"num_reports": null,
"locked": false,
"report_reasons": null,
"created": 1595301409.0,
"subreddit": "AskReddit",
"author_flair_text": null,
"treatment_tags": [],
"created_utc": 1595272609.0,
"subreddit_name_prefixed": "r/AskReddit",
"controversiality": 0,
"depth": 1,
"author_flair_background_color": null,
"collapsed_because_crowd_control": null,
"mod_reports": [],
"subreddit_type": "public",
"ups": 5
}
},
{
"kind": "t1",
"data": {
"total_awards_received": 0,
"approved_at_utc": null,
"edited": false,
"mod_reason_by": null,
"banned_by": null,
"author_flair_type": "text",
"removal_reason": null,
"link_id": "t3_123",
"author_flair_template_id": null,
"likes": null,
"replies": "",
"user_reports": [],
"saved": false,
"id": "ghi",
"banned_at_utc": null,
"mod_reason_title": null,
"gilded": 0,
"archived": false,
"no_follow": true,
"author": "testuser2",
"can_mod_post": false,
"send_replies": true,
"parent_id": "t1_abc",
"score": 1,
"author_fullname": "t2_user2",
"approved_by": null,
"mod_note": null,
"all_awardings": [],
"subreddit_id": "t5_2qh1i",
"body": "Oh my god yes best movie ever love that scene",
"awarders": [],
"downs": 0,
"author_flair_css_class": null,
"name": "t1_ghi",
"author_patreon_flair": false,
"collapsed": false,
"author_flair_richtext": [],
"is_submitter": false,
"body_html": "&lt;div class=\"md\"&gt;&lt;p&gt;Oh my god yes best movie ever love that scene&lt;/p&gt;\n&lt;/div&gt;",
"gildings": {},
"collapsed_reason": null,
"distinguished": null,
"associated_award": null,
"stickied": false,
"author_premium": false,
"can_gild": true,
"top_awarded_type": null,
"author_flair_text_color": null,
"score_hidden": false,
"permalink": "/r/AskReddit/comments/123/which_scene_from_an_animated_film_will_always_be/ghi/",
"num_reports": null,
"locked": false,
"report_reasons": null,
"created": 1595308578.0,
"subreddit": "AskReddit",
"author_flair_text": null,
"treatment_tags": [],
"created_utc": 1595279778.0,
"subreddit_name_prefixed": "r/AskReddit",
"controversiality": 0,
"depth": 1,
"author_flair_background_color": null,
"collapsed_because_crowd_control": null,
"mod_reports": [],
"subreddit_type": "public",
"ups": 1
}
},
{
"kind": "t1",
"data": {
"total_awards_received": 0,
"approved_at_utc": null,
"edited": false,
"mod_reason_by": null,
"banned_by": null,
"author_flair_type": "text",
"removal_reason": null,
"link_id": "t3_123",
"author_flair_template_id": null,
"likes": null,
"replies": "",
"user_reports": [],
"saved": false,
"id": "jkl",
"banned_at_utc": null,
"mod_reason_title": null,
"gilded": 0,
"archived": false,
"no_follow": true,
"author": "testuser2",
"can_mod_post": false,
"send_replies": true,
"parent_id": "t1_def",
"score": 1,
"author_fullname": "t2_user2",
"approved_by": null,
"mod_note": null,
"all_awardings": [],
"subreddit_id": "t5_2qh1i",
"body": "Hello this is a test",
"awarders": [],
"downs": 0,
"author_flair_css_class": null,
"name": "t1_jkl",
"author_patreon_flair": false,
"collapsed": false,
"author_flair_richtext": [],
"is_submitter": false,
"body_html": "&lt;div class=\"md\"&gt;&lt;p&gt;Hello this is a test&lt;/p&gt;\n&lt;/div&gt;",
"gildings": {},
"collapsed_reason": null,
"distinguished": null,
"associated_award": null,
"stickied": false,
"author_premium": false,
"can_gild": true,
"top_awarded_type": null,
"author_flair_text_color": null,
"score_hidden": false,
"permalink": "/r/AskReddit/comments/123/which_scene_from_an_animated_film_will_always_be/ghi/",
"num_reports": null,
"locked": false,
"report_reasons": null,
"created": 1595308578.0,
"subreddit": "AskReddit",
"author_flair_text": null,
"treatment_tags": [],
"created_utc": 1595279778.0,
"subreddit_name_prefixed": "r/AskReddit",
"controversiality": 0,
"depth": 1,
"author_flair_background_color": null,
"collapsed_because_crowd_control": null,
"mod_reports": [],
"subreddit_type": "public",
"ups": 1
}
}
]
}
}
}

82
testdata/post/more.json vendored
View file

@ -144,6 +144,88 @@
"subreddit_type": "public",
"ups": 1
}
},
{
"kind": "t1",
"data": {
"total_awards_received": 0,
"approved_at_utc": null,
"edited": false,
"mod_reason_by": null,
"banned_by": null,
"author_flair_type": "text",
"removal_reason": null,
"link_id": "t3_123",
"author_flair_template_id": null,
"likes": null,
"replies": "",
"user_reports": [],
"saved": false,
"id": "jkl",
"banned_at_utc": null,
"mod_reason_title": null,
"gilded": 0,
"archived": false,
"no_follow": true,
"author": "testuser2",
"can_mod_post": false,
"send_replies": true,
"parent_id": "t3_123",
"score": 1,
"author_fullname": "t2_user2",
"approved_by": null,
"mod_note": null,
"all_awardings": [],
"subreddit_id": "t5_2qh1i",
"body": "Hello this is a test",
"awarders": [],
"downs": 0,
"author_flair_css_class": null,
"name": "t1_jkl",
"author_patreon_flair": false,
"collapsed": false,
"author_flair_richtext": [],
"is_submitter": false,
"body_html": "&lt;div class=\"md\"&gt;&lt;p&gt;Hello this is a test&lt;/p&gt;\n&lt;/div&gt;",
"gildings": {},
"collapsed_reason": null,
"distinguished": null,
"associated_award": null,
"stickied": false,
"author_premium": false,
"can_gild": true,
"top_awarded_type": null,
"author_flair_text_color": null,
"score_hidden": false,
"permalink": "/r/AskReddit/comments/123/which_scene_from_an_animated_film_will_always_be/ghi/",
"num_reports": null,
"locked": false,
"report_reasons": null,
"created": 1595308578.0,
"subreddit": "AskReddit",
"author_flair_text": null,
"treatment_tags": [],
"created_utc": 1595279778.0,
"subreddit_name_prefixed": "r/AskReddit",
"controversiality": 0,
"depth": 1,
"author_flair_background_color": null,
"collapsed_because_crowd_control": null,
"mod_reports": [],
"subreddit_type": "public",
"ups": 1
}
},
{
"kind": "more",
"data": {
"count": 1,
"name": "t1_fye3844",
"id": "fye3844",
"parent_id": "t1_jkl",
"depth": 6,
"children": ["fye3844"]
}
}
]
}

22
things.go
View file

@ -221,7 +221,7 @@ func (r *Replies) UnmarshalJSON(data []byte) error {
}
r.Comments = root.Data.Things.Comments
r.More = root.getFirstMoreComments()
r.More = root.getFirstMore()
return nil
}
@ -311,11 +311,7 @@ func (l *rootListing) getComments() *Comments {
}
}
func (l *rootListing) getMoreComments() []*More {
return l.Data.Things.Mores
}
func (l *rootListing) getFirstMoreComments() *More {
func (l *rootListing) getFirstMore() *More {
if len(l.Data.Things.Mores) == 0 {
return nil
}
@ -391,9 +387,9 @@ type ModActions struct {
// PostAndComments is a post and its comments.
type PostAndComments struct {
Post *Post `json:"post"`
Comments []*Comment `json:"comments"`
MoreComments *More `json:"-"`
Post *Post `json:"post"`
Comments []*Comment `json:"comments"`
More *More `json:"-"`
}
// UnmarshalJSON implements the json.Unmarshaler interface.
@ -410,18 +406,18 @@ func (pc *PostAndComments) UnmarshalJSON(data []byte) error {
post := l[0].getPosts().Posts[0]
comments := l[1].getComments().Comments
moreComments := l[1].getFirstMoreComments()
moreComments := l[1].getFirstMore()
pc.Post = post
pc.Comments = comments
pc.MoreComments = moreComments
pc.More = moreComments
return nil
}
// HasMore determines whether the post has more replies to load in its reply tree.
func (pc *PostAndComments) HasMore() bool {
return pc.MoreComments != nil && len(pc.MoreComments.Children) > 0
return pc.More != nil && len(pc.More.Children) > 0
}
func (pc *PostAndComments) addCommentToTree(comment *Comment) {
@ -437,7 +433,7 @@ func (pc *PostAndComments) addCommentToTree(comment *Comment) {
func (pc *PostAndComments) addMoreToTree(more *More) {
if pc.Post.FullID == more.ParentID {
pc.MoreComments = more
pc.More = more
}
for _, reply := range pc.Comments {