Add proper query string for listing endpoints

Author: epels

conversation/api.go

@@ -3,6 +3,8 @@ package conversation
 import (
 	"encoding/json"
 	"fmt"
+	"net/url"
+	"strconv"
 	"time"
 
 	messagebird "github.com/messagebird/go-rest-api"
@@ -206,6 +208,15 @@ func request(c *messagebird.Client, v interface{}, method, path string, data int
 	return c.Request(v, method, fmt.Sprintf("%s/%s", apiRoot, path), data)
 }
 
+// paginationQuery builds the query string for paginated endpoints.
+func paginationQuery(options *ListOptions) string {
+	query := url.Values{}
+	query.Set("limit", strconv.Itoa(options.Limit))
+	query.Set("offset", strconv.Itoa(options.Offset))
+
+	return query.Encode()
+}
+
 // UnmarshalJSON is used to unmarshal the MSISDN to a string rather than an
 // int64. The API returns integers, but this client always uses strings.
 // Exposing a json.Number doesn't seem nice.

conversation/conversation.go

@@ -29,8 +29,10 @@ var DefaultListOptions = &ListOptions{10, 0}
 
 // List gets a collection of Conversations. Pagination can be set in options.
 func List(c *messagebird.Client, options *ListOptions) (*ConversationList, error) {
+	query := paginationQuery(options)
+
 	convList := &ConversationList{}
-	if err := request(c, convList, http.MethodGet, path, options); err != nil {
+	if err := request(c, convList, http.MethodGet, path+"?"+query, nil); err != nil {
 		return nil, err
 	}
 

conversation/conversation_test.go

@@ -30,6 +30,10 @@ func TestList(t *testing.T) {
 	}
 
 	mbtest.AssertEndpointCalled(t, http.MethodGet, "/v1/conversations")
+
+	if query := mbtest.Request.URL.RawQuery; query != "limit=10&offset=20" {
+		t.Fatalf("got %s, expected limit=10&offset=20", query)
+	}
 }
 
 func TestRead(t *testing.T) {

conversation/message.go

@@ -29,10 +29,11 @@ func CreateMessage(c *messagebird.Client, conversationID string, req *MessageCre
 // ListMessages gets a collection of messages from a conversation. Pagination
 // can be set in the options.
 func ListMessages(c *messagebird.Client, conversationID string, options *ListOptions) (*MessageList, error) {
-	uri := fmt.Sprintf("%s/%s/%s", path, conversationID, messagesPath)
+	query := paginationQuery(options)
+	uri := fmt.Sprintf("%s/%s/%s?%s", path, conversationID, messagesPath, query)
 
 	messageList := &MessageList{}
-	if err := request(c, messageList, http.MethodGet, uri, options); err != nil {
+	if err := request(c, messageList, http.MethodGet, uri, nil); err != nil {
 		return nil, err
 	}
 

conversation/message_test.go

@@ -48,6 +48,10 @@ func TestListMessages(t *testing.T) {
 	}
 
 	mbtest.AssertEndpointCalled(t, http.MethodGet, "/v1/conversations/convid/messages")
+
+	if query := mbtest.Request.URL.RawQuery; query != "limit=10&offset=0" {
+		t.Fatalf("got %s, expected limit=10&offset=0", query)
+	}
 }
 
 func TestReadMessage(t *testing.T) {

conversation/webhook.go

@@ -31,8 +31,10 @@ func DeleteWebhook(c *messagebird.Client, id string) error {
 
 // ListWebhooks gets a collection of webhooks. Pagination can be set in options.
 func ListWebhooks(c *messagebird.Client, options *ListOptions) (*WebhookList, error) {
+	query := paginationQuery(options)
+
 	webhookList := &WebhookList{}
-	if err := request(c, webhookList, http.MethodGet, webhooksPath, options); err != nil {
+	if err := request(c, webhookList, http.MethodGet, webhooksPath+"?"+query, nil); err != nil {
 		return nil, err
 	}
 

conversation/webhook_test.go

@@ -60,6 +60,10 @@ func TestListWebhooks(t *testing.T) {
 	}
 
 	mbtest.AssertEndpointCalled(t, http.MethodGet, "/v1/webhooks")
+
+	if query := mbtest.Request.URL.RawQuery; query != "limit=10&offset=0" {
+		t.Fatalf("got %s, expected limit=10&offset=0", query)
+	}
 }
 
 func TestReadWebhook(t *testing.T) {