refactor: use url.Values to correctly parse path params

Author: kkweon

client_test.go

@@ -2,20 +2,13 @@ package paperswithcode_go
 
 import (
 	"fmt"
-	"github.com/codingpot/paperswithcode-go/v2/internal/testutils"
 	"net/http"
 	"net/http/httptest"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 )
 
-var apiToken string
-
-func init() {
-	apiToken = testutils.MustExtractAPITokenFromEnv()
-}
-
 func TestWithAPIToken(t *testing.T) {
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 		w.WriteHeader(http.StatusOK)

method_list.go

@@ -1,24 +1,31 @@
 package paperswithcode_go
 
 import (
-	"fmt"
 	"github.com/codingpot/paperswithcode-go/v2/models"
+	"net/url"
+	"strconv"
 )
 
+// MethodListParams is an argument object to MethodList.
 type MethodListParams struct {
 	// Page (default: 1)
 	Page int
 	// ItemsPerPage (default: 50)
 	ItemsPerPage int
 }
 
-func (m MethodListParams) String() string {
-	return fmt.Sprintf("page=%d&items_per_page=%d", m.Page, m.ItemsPerPage)
+// Build used to expand `MethodListParams` to URL path params.
+func (m MethodListParams) Build() string {
+	return url.Values{
+		"page":           []string{strconv.Itoa(m.Page)},
+		"items_per_page": []string{strconv.Itoa(m.ItemsPerPage)},
+	}.Encode()
 }
 
+// MethodList fetches a list of "methods" that can be used in research papers.
 func (c *Client) MethodList(params MethodListParams) (*models.MethodList, error) {
-	url := c.baseURL + "/methods?" + params.String()
+	u := c.baseURL + "/methods?" + params.Build()
 	var listResult models.MethodList
-	err := c.sendGetRequest(url, &listResult)
+	err := c.sendGetRequest(u, &listResult)
 	return &listResult, err
 }

method_list_test.go

@@ -66,3 +66,41 @@ func TestClient_MethodList(t *testing.T) {
 func toPtr(s string) *string {
 	return &s
 }
+
+func TestMethodListParams_Build(t *testing.T) {
+	type fields struct {
+		Page         int
+		ItemsPerPage int
+	}
+	tests := []struct {
+		name   string
+		fields fields
+		want   string
+	}{
+		{
+			name: "default values are parsed as URL params",
+			fields: fields{
+				Page:         0,
+				ItemsPerPage: 0,
+			},
+			want: "items_per_page=0&page=0",
+		},
+		{
+			name: "some values are parsed as URL params",
+			fields: fields{
+				Page:         1,
+				ItemsPerPage: 1234,
+			},
+			want: "items_per_page=1234&page=1",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			m := MethodListParams{
+				Page:         tt.fields.Page,
+				ItemsPerPage: tt.fields.ItemsPerPage,
+			}
+			assert.Equal(t, tt.want, m.Build())
+		})
+	}
+}

paper_list.go

@@ -1,10 +1,9 @@
 package paperswithcode_go
 
 import (
-	"fmt"
-	"strings"
-
 	"github.com/codingpot/paperswithcode-go/v2/models"
+	"net/url"
+	"strconv"
 )
 
 // PaperList returns multiple papers.
@@ -30,20 +29,21 @@ type PaperListParams struct {
 }
 
 func (p PaperListParams) Build() string {
-	var b strings.Builder
-	b.WriteString(fmt.Sprintf("page=%d&items_per_page=%d", p.Page, p.ItemsPerPage))
+	b := url.Values{}
+	b.Set("page", strconv.Itoa(p.Page))
+	b.Set("items_per_page", strconv.Itoa(p.ItemsPerPage))
 
-	addParamsIfValid(&b, "q", p.Q)
-	addParamsIfValid(&b, "arxiv_id", p.ArxivID)
-	addParamsIfValid(&b, "title", p.Title)
-	addParamsIfValid(&b, "abstract", p.Abstract)
+	addParamsIfValid(b, "q", p.Q)
+	addParamsIfValid(b, "arxiv_id", p.ArxivID)
+	addParamsIfValid(b, "title", p.Title)
+	addParamsIfValid(b, "abstract", p.Abstract)
 
-	return b.String()
+	return b.Encode()
 }
 
-func addParamsIfValid(b *strings.Builder, key string, value string) {
+func addParamsIfValid(b url.Values, key string, value string) {
 	if value != "" {
-		b.WriteString(fmt.Sprintf("&%s=%s", key, value))
+		b.Set(key, value)
 	}
 }
 

paper_list_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 func TestClient_PaperList(t *testing.T) {
-	client := NewClient(WithAPIToken(apiToken))
+	client := NewClient()
 	_, err := client.PaperList(PaperListParamsDefault())
 	assert.NoError(t, err)
 }
@@ -33,20 +33,20 @@ func TestPaperListParams_Build(t *testing.T) {
 				Page:         1,
 				ItemsPerPage: 50,
 			},
-			want: "page=1&items_per_page=50&q=wow",
+			want: "items_per_page=50&page=1&q=wow",
 		},
 		{
 			name: "Q is not given, it shouldn't add Q param",
 			fields: fields{
 				Page:         1,
 				ItemsPerPage: 50,
 			},
-			want: "page=1&items_per_page=50",
+			want: "items_per_page=50&page=1",
 		},
 		{
 			name:   "Default Param is valid",
 			fields: fields(PaperListParamsDefault()),
-			want:   "page=1&items_per_page=50",
+			want:   "items_per_page=50&page=1",
 		},
 	}
 	for _, tt := range tests {