feat: Add Limit Query Parameter to Get Follower Ids (#363)

* feat: Add limit to query follower ids

* refactor: Extract query bind to bindToQuery func

Author: unnoy

linebot/get_follower_ids.go

@@ -17,6 +17,7 @@ package linebot
 import (
 	"context"
 	"net/url"
+	"strconv"
 )
 
 // GetFollowerIDs method
@@ -34,6 +35,7 @@ type GetFollowerIDsCall struct {
 	ctx context.Context
 
 	continuationToken string
+	limit             uint16
 }
 
 // WithContext method
@@ -42,12 +44,16 @@ func (call *GetFollowerIDsCall) WithContext(ctx context.Context) *GetFollowerIDs
 	return call
 }
 
+// WithLimit will set limit parmeter on query.
+// The limit can be a maximum of 1000 for a single request.
+func (call *GetFollowerIDsCall) WithLimit(limit uint16) *GetFollowerIDsCall {
+	call.bindLimit(limit)
+	return call
+}
+
 // Do method
 func (call *GetFollowerIDsCall) Do() (*UserIDsResponse, error) {
-	var q url.Values
-	if call.continuationToken != "" {
-		q = url.Values{"start": []string{call.continuationToken}}
-	}
+	q := call.bindToQuery()
 	res, err := call.c.get(call.ctx, call.c.endpointBase, APIEndpointGetFollowerIDs, q)
 	if err != nil {
 		return nil, err
@@ -75,6 +81,27 @@ func (call *GetFollowerIDsCall) NewScanner() *UserIDsScanner {
 	}
 }
 
+func (call *GetFollowerIDsCall) bindLimit(limit uint16) {
+	if limit > 1000 {
+		limit = 1000
+	}
+	if limit == 0 {
+		limit = 300
+	}
+	call.limit = limit
+}
+
+func (call *GetFollowerIDsCall) bindToQuery() url.Values {
+	q := make(url.Values)
+	if call.continuationToken != "" {
+		q.Set("start", call.continuationToken)
+	}
+	if call.limit != 0 {
+		q.Set("limit", strconv.FormatUint(uint64(call.limit), 10))
+	}
+	return q
+}
+
 func (call *GetFollowerIDsCall) setContinuationToken(token string) {
 	call.continuationToken = token
 }

linebot/get_follower_ids_test.go

@@ -31,6 +31,7 @@ func TestGetFollowerIDs(t *testing.T) {
 	type want struct {
 		URLPath           string
 		ContinuationToken string
+		Limit             string
 		RequestBody       []byte
 		Response          *UserIDsResponse
 		Error             error
@@ -39,6 +40,7 @@ func TestGetFollowerIDs(t *testing.T) {
 		Label             string
 		GroupID           string
 		ContinuationToken string
+		Limit             uint16
 		ResponseCode      int
 		Response          []byte
 		Want              want
@@ -77,6 +79,24 @@ func TestGetFollowerIDs(t *testing.T) {
 				},
 			},
 		},
+		{
+			Label:        "With Limit",
+			GroupID:      "cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+			Limit:        1,
+			ResponseCode: 200,
+			Response:     []byte(`{"userIds": ["U0047556f2e40dba2456887320ba7c76d"], "next": "xxxxx"}`),
+			Want: want{
+				URLPath:     APIEndpointGetFollowerIDs,
+				Limit:       "1",
+				RequestBody: []byte(""),
+				Response: &UserIDsResponse{
+					UserIDs: []string{
+						"U0047556f2e40dba2456887320ba7c76d",
+					},
+					Next: "xxxxx",
+				},
+			},
+		},
 		{
 			Label:             "Internal server error",
 			GroupID:           "cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
@@ -108,6 +128,9 @@ func TestGetFollowerIDs(t *testing.T) {
 		if start, want := q.Get("start"), tc.Want.ContinuationToken; start != want {
 			t.Errorf("ContinuationToken: %s; want %s", start, want)
 		}
+		if limit, want := q.Get("limit"), tc.Want.Limit; limit != want {
+			t.Errorf("Limit: %s; want %s", limit, want)
+		}
 		body, err := io.ReadAll(r.Body)
 		if err != nil {
 			t.Fatal(err)
@@ -135,7 +158,11 @@ func TestGetFollowerIDs(t *testing.T) {
 	for i, tc := range testCases {
 		currentTestIdx = i
 		t.Run(strconv.Itoa(i)+"/"+tc.Label, func(t *testing.T) {
-			res, err := client.GetFollowerIDs(tc.ContinuationToken).Do()
+			call := client.GetFollowerIDs(tc.ContinuationToken)
+			if tc.Limit != 0 {
+				call.WithLimit(tc.Limit)
+			}
+			res, err := call.Do()
 			if tc.Want.Error != nil {
 				if !reflect.DeepEqual(err, tc.Want.Error) {
 					t.Errorf("Error %v; want %v", err, tc.Want.Error)