Merge pull request #8 from joshraphael/issue-2

issue-2 -- add GetUsersIFollow endpoint

Author: joshraphael

README.md

@@ -70,6 +70,7 @@ For convenience, the API docs and examples can be found in the tables below
 |`GetUserSummary()`|Get a user's profile metadata.|[docs](https://api-docs.retroachievements.org/v1/get-user-summary.html) \| [example](examples/user/getusersummary/getusersummary.go)|
 |`GetUserCompletedGames()`|[Deprecated] Get hardcore and softcore completion metadata about games a user has played.|[docs](https://api-docs.retroachievements.org/v1/get-user-completed-games.html) \| [example](examples/user/getusercompletedgames/getusercompletedgames.go)|
 |`GetUserWantToPlayList()`|Get a user's "Want to Play Games" list.|[docs](https://api-docs.retroachievements.org/v1/get-user-want-to-play-list.html) \| [example](examples/user/getuserwanttoplaylist/getuserwanttoplaylist.go)|
+|`GetUsersIFollow()`|Get the caller's "Following" users list.|[docs](https://api-docs.retroachievements.org/v1/get-users-i-follow.html) \| [example](examples/user/getusersifollow/getusersifollow.go)|
 |`GetUserSetRequests()`|Get a user's list of set requests.|[docs](https://api-docs.retroachievements.org/v1/get-user-set-requests.html) \| [example](examples/user/getusersetrequests/getusersetrequests.go)|
 
 <h3>Game</h3>

examples/user/getusersifollow/getusersifollow.go

@@ -0,0 +1,31 @@
+// Package getusersifollow provides an example for the caller's "Following" users list.
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/joshraphael/go-retroachievements"
+	"github.com/joshraphael/go-retroachievements/models"
+)
+
+/*
+Test script, add RA_API_KEY to your env and use `go run getusersifollow.go`
+*/
+func main() {
+	secret := os.Getenv("RA_API_KEY")
+
+	client := retroachievements.NewClient(secret)
+
+	count := 1
+	offset := 1
+	resp, err := client.GetUsersIFollow(models.GetUsersIFollowParameters{
+		Count:  &count,
+		Offset: &offset,
+	})
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Printf("%+v\n", resp)
+}

models/user.go

@@ -605,6 +605,27 @@ type GetUserWantToPlayListResult struct {
 	AchievementsPublished int    `json:"AchievementsPublished"`
 }
 
+type GetUsersIFollowParameters struct {
+	// [Optional] The number of records to return (default: 100, max: 500).
+	Count *int
+
+	// [Optional] The number of entries to skip (default: 0).
+	Offset *int
+}
+
+type GetUsersIFollow struct {
+	Count   int                     `json:"Count"`
+	Total   int                     `json:"Total"`
+	Results []GetUsersIFollowResult `json:"Results"`
+}
+
+type GetUsersIFollowResult struct {
+	User           string `json:"User"`
+	Points         int    `json:"Points"`
+	PointsSoftcore int    `json:"PointsSoftcore"`
+	IsFollowingMe  bool   `json:"IsFollowingMe"`
+}
+
 type GetUserSetRequestsParameters struct {
 	// The target username.
 	Username string

user.go

@@ -338,6 +338,31 @@ func (c *Client) GetUserWantToPlayList(params models.GetUserWantToPlayListParame
 	return resp, nil
 }
 
+// GetUsersIFollow gets the caller's "Following" users list.
+func (c *Client) GetUsersIFollow(params models.GetUsersIFollowParameters) (*models.GetUsersIFollow, error) {
+	details := []raHttp.RequestDetail{
+		raHttp.Method(http.MethodGet),
+		raHttp.UserAgent(c.UserAgent),
+		raHttp.Path("/API/API_GetUsersIFollow.php"),
+		raHttp.APIToken(c.Secret),
+	}
+	if params.Count != nil {
+		details = append(details, raHttp.C(*params.Count))
+	}
+	if params.Offset != nil {
+		details = append(details, raHttp.O(*params.Offset))
+	}
+	r, err := c.do(details...)
+	if err != nil {
+		return nil, fmt.Errorf("calling endpoint: %w", err)
+	}
+	resp, err := raHttp.ResponseObject[models.GetUsersIFollow](r)
+	if err != nil {
+		return nil, fmt.Errorf("parsing response object: %w", err)
+	}
+	return resp, nil
+}
+
 // GetUserSetRequests gets a user's list of set requests.
 func (c *Client) GetUserSetRequests(params models.GetUserSetRequestsParameters) (*models.GetUserSetRequests, error) {
 	details := []raHttp.RequestDetail{

user_test.go

@@ -2478,6 +2478,138 @@ func TestGetUserWantToPlayList(tt *testing.T) {
 	}
 }
 
+func TestGetUsersIFollow(tt *testing.T) {
+	count := 10
+	offset := 23
+	tests := []struct {
+		name            string
+		params          models.GetUsersIFollowParameters
+		modifyURL       func(url string) string
+		responseCode    int
+		responseMessage models.GetUsersIFollow
+		responseError   models.ErrorResponse
+		response        func(messageBytes []byte, errorBytes []byte) []byte
+		assert          func(t *testing.T, resp *models.GetUsersIFollow, err error)
+	}{
+		{
+			name: "fail to call endpoint",
+			params: models.GetUsersIFollowParameters{
+				Count:  &count,
+				Offset: &offset,
+			},
+			modifyURL: func(url string) string {
+				return ""
+			},
+			responseCode: http.StatusUnauthorized,
+			responseError: models.ErrorResponse{
+				Message: "test",
+				Errors: []models.ErrorDetail{
+					{
+						Status: http.StatusUnauthorized,
+						Code:   "unauthorized",
+						Title:  "Not Authorized",
+					},
+				},
+			},
+			response: func(messageBytes []byte, errorBytes []byte) []byte {
+				return errorBytes
+			},
+			assert: func(t *testing.T, resp *models.GetUsersIFollow, err error) {
+				require.Nil(t, resp)
+				require.EqualError(t, err, "calling endpoint: Get \"/API/API_GetUsersIFollow.php?c=10&o=23&y=some_secret\": unsupported protocol scheme \"\"")
+			},
+		},
+		{
+			name: "error response",
+			params: models.GetUsersIFollowParameters{
+				Count:  &count,
+				Offset: &offset,
+			},
+			modifyURL: func(url string) string {
+				return url
+			},
+			responseCode: http.StatusUnauthorized,
+			responseError: models.ErrorResponse{
+				Message: "test",
+				Errors: []models.ErrorDetail{
+					{
+						Status: http.StatusUnauthorized,
+						Code:   "unauthorized",
+						Title:  "Not Authorized",
+					},
+				},
+			},
+			response: func(messageBytes []byte, errorBytes []byte) []byte {
+				return errorBytes
+			},
+			assert: func(t *testing.T, resp *models.GetUsersIFollow, err error) {
+				require.Nil(t, resp)
+				require.EqualError(t, err, "parsing response object: error code 401 returned: {\"message\":\"test\",\"errors\":[{\"status\":401,\"code\":\"unauthorized\",\"title\":\"Not Authorized\"}]}")
+			},
+		},
+		{
+			name: "success",
+			params: models.GetUsersIFollowParameters{
+				Count:  &count,
+				Offset: &offset,
+			},
+			modifyURL: func(url string) string {
+				return url
+			},
+			responseCode: http.StatusOK,
+			responseMessage: models.GetUsersIFollow{
+				Count: 20,
+				Total: 120,
+				Results: []models.GetUsersIFollowResult{
+					{
+						User:           "zuliman92",
+						Points:         1882,
+						PointsSoftcore: 258,
+						IsFollowingMe:  true,
+					},
+				},
+			},
+			response: func(messageBytes []byte, errorBytes []byte) []byte {
+				return messageBytes
+			},
+			assert: func(t *testing.T, resp *models.GetUsersIFollow, err error) {
+				require.NotNil(t, resp)
+				require.Equal(t, 20, resp.Count)
+				require.Equal(t, 120, resp.Total)
+				require.Len(t, resp.Results, 1)
+				require.Equal(t, "zuliman92", resp.Results[0].User)
+				require.Equal(t, 1882, resp.Results[0].Points)
+				require.Equal(t, 258, resp.Results[0].PointsSoftcore)
+				require.True(t, resp.Results[0].IsFollowingMe)
+				require.NoError(t, err)
+			},
+		},
+	}
+	for _, test := range tests {
+		tt.Run(test.name, func(t *testing.T) {
+			server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				expectedPath := "/API/API_GetUsersIFollow.php"
+				if r.URL.Path != expectedPath {
+					t.Errorf("Expected to request '%s', got: %s", expectedPath, r.URL.Path)
+				}
+				w.WriteHeader(test.responseCode)
+				responseMessage, err := json.Marshal(test.responseMessage)
+				require.NoError(t, err)
+				errBytes, err := json.Marshal(test.responseError)
+				require.NoError(t, err)
+				resp := test.response(responseMessage, errBytes)
+				num, err := w.Write(resp)
+				require.NoError(t, err)
+				require.Equal(t, num, len(resp))
+			}))
+			defer server.Close()
+			client := retroachievements.New(test.modifyURL(server.URL), "go-retroachievements/v0.0.0", "some_secret")
+			resp, err := client.GetUsersIFollow(test.params)
+			test.assert(t, resp, err)
+		})
+	}
+}
+
 func TestGetUserSetRequests(tt *testing.T) {
 	all := true
 	tests := []struct {