Enable PaperList() method as a reference

- Keep the same names in Python (`paper_list` -> `PaperList`)
- Create a correct type for `PaperListResult`
- Add YYYY-MM-DD date type

Author: kkweon

client.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"github.com/codingpot/paperswithcode-go/models"
 	"net/http"
 	"net/url"
 	"time"
@@ -177,45 +178,47 @@ func (c *Client) sendRequest(req *http.Request, v interface{}) error {
 	return nil
 }
 
-/*
-	GetPapers API is currently broken. need to wait until it gets fixed
-*/
-
-// type PaperList struct {
-// 	Count    int    `json:"count"`
-// 	NextPage string `json:"next,omitempty"`
-// 	PrePage  string `json:"previous,omitempty"`
-// 	Results  []struct {
-// 		ID               string   `json:"id"`
-// 		ArxivID          []string `json:"arxiv_id,omitempty"`
-// 		NipsID           []string `json:"nips_id,omitempty"`
-// 		URLAbs           string   `json:"url_abs"`
-// 		URLPdf           string   `json:"url_pdf"`
-// 		Title            string   `json:"title"`
-// 		Abstract         string   `json:"abstract"`
-// 		Authors          []string `json:"authors"`
-// 		Published        string   `json:"published"`
-// 		Conference       []string `json:"conference,omitempty"`
-// 		ConferenceURLAbs []string `json:"conference_url_abs,omitempty"`
-// 		ConferenceURLPdf []string `json:"conference_url_pdf,omitempty"`
-// 		Proceeding       []string `json:"proceeding,omitempty"`
-// 	} `json:"results"`
-// }
-
-// func (c *Client) GetPapers(ctx context.Context, query string, page int, limit int) (*PaperList, error) {
-// 	url := fmt.Sprintf("%s/papers?q=%s&items_per_page=%d&page=%d", c.BaseURL, url.QueryEscape(query), limit, page)
-// 	req, err := http.NewRequest("GET", url, nil)
-
-// 	if err != nil {
-// 		return nil, err
-// 	}
-
-// 	req = req.WithContext(ctx)
-
-// 	res := PaperList{}
-// 	if err := c.sendRequest(req, &res); err != nil {
-// 		return nil, err
-// 	}
-
-// 	return &res, nil
-// }
+type PaperListParams struct {
+	Query string
+	Page  int
+	Limit int
+}
+
+func (p PaperListParams) Build() string {
+	if p.Query == "" {
+		return fmt.Sprintf("items_per_page=%d&page=%d", p.Limit, p.Page)
+	}
+	return fmt.Sprintf("q=%s&items_per_page=%d&page=%d", url.QueryEscape(p.Query), p.Limit, p.Page)
+}
+
+func (c *Client) PaperList(params PaperListParams) (*models.PaperListResult, error) {
+	papersListURL := c.BaseURL + "/papers?" + params.Build()
+
+	request, err := http.NewRequest(http.MethodGet, papersListURL /*body=*/, nil)
+	if err != nil {
+		return nil, err
+	}
+	request.Header.Set("Authorization", "Token "+c.apiToken)
+
+	response, err := c.HTTPClient.Get(papersListURL)
+	if err != nil {
+		return nil, err
+	}
+
+	var paperListResult models.PaperListResult
+
+	err = json.NewDecoder(response.Body).Decode(&paperListResult)
+	if err != nil {
+		return nil, err
+	}
+
+	return &paperListResult, nil
+}
+
+func PaperListParamsDefault() PaperListParams {
+	return PaperListParams{
+		Query: "",
+		Page:  1,
+		Limit: 50,
+	}
+}

client_test.go

@@ -0,0 +1,25 @@
+package paperswithcode_go
+
+import (
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+var apiToken string
+
+func init() {
+	var ok bool
+	apiToken, ok = os.LookupEnv("PAPERSWITHCODE_API_TOKEN")
+
+	if !ok {
+		panic("expected PAPERSWITHCODE_API_TOKEN environment variable")
+	}
+}
+
+func TestClient_PaperList(t *testing.T) {
+	client := NewClient(WithAPIToken(apiToken))
+	_, err := client.PaperList(PaperListParamsDefault())
+	assert.NoError(t, err)
+}

dummy/paper_list_response.json

@@ -1,3 +1,5 @@
 module github.com/codingpot/paperswithcode-go
 
-go 1.16
+go 1.16
+
+require github.com/stretchr/testify v1.7.0

go.mod

@@ -0,0 +1,11 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

go.sum

@@ -0,0 +1,25 @@
+package models
+
+// PaperListResult is the result of PaperListResult() function.
+type PaperListResult struct {
+	Count    int64                 `json:"count"`
+	Next     *string               `json:"next"`
+	Previous *string               `json:"previous"`
+	Results  []PaperListResultItem `json:"results"`
+}
+
+type PaperListResultItem struct {
+	ID               string   `json:"id"`
+	ArxivID          *string  `json:"arxiv_id"`
+	NipsID           *string  `json:"nips_id"`
+	URLAbs           string   `json:"url_abs"`
+	URLPDF           string   `json:"url_pdf"`
+	Title            string   `json:"title"`
+	Abstract         string   `json:"abstract"`
+	Authors          []string `json:"authors"`
+	Published        YyyyMmDdDashed   `json:"published"`
+	Conference       *string  `json:"conference"`
+	ConferenceURLAbs *string  `json:"conference_url_abs"`
+	ConferenceURLPDF *string  `json:"conference_url_pdf"`
+	Proceeding       *string  `json:"proceeding"`
+}

models/paper_list_result.go

@@ -0,0 +1,23 @@
+package models
+
+import (
+	"encoding/json"
+	"strings"
+	"time"
+)
+
+type YyyyMmDdDashed time.Time
+
+func (y *YyyyMmDdDashed) UnmarshalJSON(bytes []byte) error {
+	cleanString := strings.Trim(string(bytes), `"`)
+	parsedTime, err := time.Parse("2006-01-02", cleanString)
+	if err != nil {
+		return err
+	}
+	*y = YyyyMmDdDashed(parsedTime)
+	return nil
+}
+
+func (y YyyyMmDdDashed) MarshalJSON() ([]byte, error) {
+	return json.Marshal(y)
+}

models/yyyymmdd.go

@@ -0,0 +1,42 @@
+package models
+
+import (
+	"testing"
+	"time"
+)
+
+func TestYyyyMmDdDashed_UnmarshalJSON(t *testing.T) {
+	type args struct {
+		inputDateString string
+	}
+	tests := []struct {
+		name     string
+		expected YyyyMmDdDashed
+		args     args
+		wantErr  bool
+	}{
+		{
+			name:     "2021-05-01 is a valid YyyyMmDdDashed type",
+			expected: YyyyMmDdDashed(time.Date(2021, 5, 1, 0, 0, 0, 0, time.UTC)),
+			args: args{
+				inputDateString: "2021-05-01",
+			},
+			wantErr: false,
+		},
+		{
+			name:     "20210501 is NOT a valid YyyyMmDdDashed type",
+			expected: YyyyMmDdDashed(time.Date(2021, 5, 1, 0, 0, 0, 0, time.UTC)),
+			args: args{
+				inputDateString: "20210501",
+			},
+			wantErr: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if err := tt.expected.UnmarshalJSON([]byte(tt.args.inputDateString)); (err != nil) != tt.wantErr {
+				t.Errorf("UnmarshalJSON() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}