guy176251/reddit-go
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Get wiki page, get wiki page discussions

Browse Source 
Signed-off-by: Vartan Benohanian <vartanbeno@gmail.com>
This commit is contained in:
Vartan Benohanian
2020-09-04 23:42:24 -04:00
parent 9d5132f15c
commit a9e42b21b1
5 changed files with 499 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
reddit/things.go
+8
View File
@@ -19,6 +19,7 @@ const (
kindMore = "more"
kindModAction = "modaction"
kindMulti = "LabeledMulti"
kindWikiPage = "wikipage"
kindWikiPageListing = "wikipagelisting"
kindWikiPageSettings = "wikipagesettings"
)
@@ -96,6 +97,8 @@ func (t *thing) UnmarshalJSON(b []byte) error {
v = new(trophyList)
case kindKarmaList:
v = new([]*SubredditKarma)
case kindWikiPage:
v = new(WikiPage)
case kindWikiPageListing:
v = new([]string)
case kindWikiPageSettings:
@@ -174,6 +177,11 @@ func (t *thing) Karma() ([]*SubredditKarma, bool) {
return *v, ok
}
func (t *thing) WikiPage() (v *WikiPage, ok bool) {
v, ok = t.Data.(*WikiPage)
return
}
func (t *thing) WikiPages() ([]string, bool) {
v, ok := t.Data.(*[]string)
if !ok {
reddit/wiki.go
+86 -2
View File
@@ -19,6 +19,48 @@ type WikiService struct {
client *Client
}
// WikiPage is a wiki page in a subreddit.
type WikiPage struct {
Content string `json:"content_md,omitempty"`
Reason string `json:"reason,omitempty"`
MayRevise bool `json:"may_revise"`
RevisionID string `json:"revision_id,omitempty"`
RevisionDate *Timestamp `json:"revision_date,omitempty"`
RevisionBy *User `json:"revision_by,omitempty"`
}
// UnmarshalJSON implements the json.Unmarshaler interface.
func (p *WikiPage) UnmarshalJSON(b []byte) error {
root := new(struct {
Content string `json:"content_md,omitempty"`
Reason string `json:"reason,omitempty"`
MayRevise bool `json:"may_revise"`
RevisionID string `json:"revision_id,omitempty"`
RevisionDate *Timestamp `json:"revision_date,omitempty"`
RevisionBy thing `json:"revision_by,omitempty"`
})
err := json.Unmarshal(b, root)
if err != nil {
return err
}
p.Content = root.Content
p.Reason = root.Reason
p.MayRevise = root.MayRevise
p.RevisionID = root.RevisionID
p.RevisionDate = root.RevisionDate
if user, ok := root.RevisionBy.User(); ok {
p.RevisionBy = user
}
return nil
}
// WikiPagePermissionLevel defines who can edit a specific wiki page in a subreddit.
type WikiPagePermissionLevel int
@@ -71,6 +113,25 @@ func (s *WikiPageSettings) UnmarshalJSON(b []byte) error {
return nil
}
// Page gets a wiki page.
func (s *WikiService) Page(ctx context.Context, subreddit, page string) (*WikiPage, *Response, error) {
path := fmt.Sprintf("r/%s/wiki/%s", subreddit, page)
req, err := s.client.NewRequest(http.MethodGet, path, nil)
if err != nil {
return nil, nil, err
}
root := new(thing)
resp, err := s.client.Do(ctx, req, root)
if err != nil {
return nil, resp, err
}
wikiPage, _ := root.WikiPage()
return wikiPage, resp, nil
}
// Pages retrieves a list of wiki pages in the subreddit.
// Returns 403 Forbidden if the wiki is disabled.
func (s *WikiService) Pages(ctx context.Context, subreddit string) ([]string, *Response, error) {
@@ -87,8 +148,8 @@ func (s *WikiService) Pages(ctx context.Context, subreddit string) ([]string, *R
return nil, resp, err
}
pages, _ := root.WikiPages()
return pages, resp, nil
wikiPages, _ := root.WikiPages()
return wikiPages, resp, nil
}
// Settings gets the subreddit's wiki page's settings.
@@ -168,3 +229,26 @@ func (s *WikiService) Deny(ctx context.Context, subreddit, page, username string
return s.client.Do(ctx, req, nil)
}
// Discussions gets a list of discussions (posts) about the wiki page.
func (s *WikiService) Discussions(ctx context.Context, subreddit, page string, opts *ListOptions) ([]*Post, *Response, error) {
path := fmt.Sprintf("r/%s/wiki/discussions/%s", subreddit, page)
path, err := addOptions(path, opts)
if err != nil {
return nil, nil, err
}
req, err := s.client.NewRequest(http.MethodGet, path, nil)
if err != nil {
return nil, nil, err
}
root := new(thing)
resp, err := s.client.Do(ctx, req, root)
if err != nil {
return nil, resp, err
}
listing, _ := root.Listing()
return listing.Posts(), resp, nil
}
reddit/wiki_test.go
+87 -6
View File
@@ -10,6 +10,26 @@ import (
"github.com/stretchr/testify/require"
)
var expectedWikiPage = &WikiPage{
Content: "test reason",
Reason: "this is a reason!",
MayRevise: true,
RevisionID: "3c4e9fab-ef2c-11ea-90b6-0e9189256887",
RevisionDate: &Timestamp{time.Date(2020, 9, 5, 3, 59, 45, 0, time.UTC)},
RevisionBy: &User{
ID: "164ab8",
Name: "v_95",
Created: &Timestamp{time.Date(2017, 3, 12, 4, 56, 47, 0, time.UTC)},
PostKarma: 691,
CommentKarma: 22235,
HasVerifiedEmail: true,
NSFW: true,
},
}
var expectedWikiPageSettings = &WikiPageSettings{
PermissionLevel: PermissionSubredditWikiPermissions,
Listed: true,
@@ -28,6 +48,50 @@ var expectedWikiPageSettings = &WikiPageSettings{
},
}
var expectedWikiPageDiscussions = []*Post{
{
ID: "imj8g5",
FullID: "t3_imj8g5",
Created: &Timestamp{time.Date(2020, 9, 4, 16, 33, 33, 0, time.UTC)},
Edited: &Timestamp{time.Date(1, 1, 1, 0, 0, 0, 0, time.UTC)},
Permalink: "/r/helloworldtestt/comments/imj8g5/test/",
URL: "https://www.reddit.com/r/helloworldtestt/wiki/index",
Title: "test",
Likes: Bool(true),
Score: 1,
UpvoteRatio: 1,
NumberOfComments: 0,
SubredditName: "helloworldtestt",
SubredditNamePrefixed: "r/helloworldtestt",
SubredditID: "t5_2uquw1",
Author: "v_95",
AuthorID: "t2_164ab8",
},
}
func TestWikiService_Page(t *testing.T) {
client, mux, teardown := setup()
defer teardown()
blob, err := readFileContents("../testdata/wiki/page.json")
require.NoError(t, err)
mux.HandleFunc("/r/testsubreddit/wiki/testpage", func(w http.ResponseWriter, r *http.Request) {
require.Equal(t, http.MethodGet, r.Method)
fmt.Fprint(w, blob)
})
wikiPage, _, err := client.Wiki.Page(ctx, "testsubreddit", "testpage")
require.NoError(t, err)
require.Equal(t, expectedWikiPage, wikiPage)
}
func TestWikiService_Pages(t *testing.T) {
client, mux, teardown := setup()
defer teardown()
@@ -43,9 +107,9 @@ func TestWikiService_Pages(t *testing.T) {
}`)
})
pages, _, err := client.Wiki.Pages(ctx, "testsubreddit")
wikiPages, _, err := client.Wiki.Pages(ctx, "testsubreddit")
require.NoError(t, err)
require.Equal(t, []string{"faq", "index"}, pages)
require.Equal(t, []string{"faq", "index"}, wikiPages)
}
func TestWikiService_Settings(t *testing.T) {
@@ -60,9 +124,9 @@ func TestWikiService_Settings(t *testing.T) {
fmt.Fprint(w, blob)
})
settings, _, err := client.Wiki.Settings(ctx, "testsubreddit", "testpage")
wikiPageSettings, _, err := client.Wiki.Settings(ctx, "testsubreddit", "testpage")
require.NoError(t, err)
require.Equal(t, expectedWikiPageSettings, settings)
require.Equal(t, expectedWikiPageSettings, wikiPageSettings)
}
func TestWikiService_UpdateSettings(t *testing.T) {
@@ -89,12 +153,12 @@ func TestWikiService_UpdateSettings(t *testing.T) {
_, _, err = client.Wiki.UpdateSettings(ctx, "testsubreddit", "testpage", nil)
require.EqualError(t, err, "updateRequest: cannot be nil")
settings, _, err := client.Wiki.UpdateSettings(ctx, "testsubreddit", "testpage", &WikiPageSettingsUpdateRequest{
wikiPageSettings, _, err := client.Wiki.UpdateSettings(ctx, "testsubreddit", "testpage", &WikiPageSettingsUpdateRequest{
Listed: Bool(false),
PermissionLevel: PermissionApprovedContributorsOnly,
})
require.NoError(t, err)
require.Equal(t, expectedWikiPageSettings, settings)
require.Equal(t, expectedWikiPageSettings, wikiPageSettings)
}
func TestWikiService_Allow(t *testing.T) {
@@ -136,3 +200,20 @@ func TestWikiService_Deny(t *testing.T) {
_, err := client.Wiki.Deny(ctx, "testsubreddit", "testpage", "testusername")
require.NoError(t, err)
}
func TestWikiService_Discussions(t *testing.T) {
client, mux, teardown := setup()
defer teardown()
blob, err := readFileContents("../testdata/wiki/discussions.json")
require.NoError(t, err)
mux.HandleFunc("/r/testsubreddit/wiki/discussions/testpage", func(w http.ResponseWriter, r *http.Request) {
require.Equal(t, http.MethodGet, r.Method)
fmt.Fprint(w, blob)
})
wikiPageDiscussions, _, err := client.Wiki.Discussions(ctx, "testsubreddit", "testpage", nil)
require.NoError(t, err)
require.Equal(t, expectedWikiPageDiscussions, wikiPageDiscussions)
}