fix: use value as a return type

Author: kkweon

client.go

@@ -27,24 +27,24 @@ func WithAPIToken(apiToken string) ClientOption {
 }
 
 // NewClient creates a Client object.
-func NewClient(opts ...ClientOption) *Client {
-	defaultClient := &Client{
+func NewClient(opts ...ClientOption) Client {
+	defaultClient := Client{
 		baseURL: BaseURL,
-		httpClient: &http.Client{
+		httpClient: http.Client{
 			Timeout: time.Minute,
 		},
 	}
 
 	for _, opt := range opts {
-		opt(defaultClient)
+		opt(&defaultClient)
 	}
 
 	return defaultClient
 }
 
 type Client struct {
 	baseURL    string
-	httpClient *http.Client
+	httpClient http.Client
 	apiToken   string
 }
 

client_example_test.go

@@ -13,10 +13,8 @@ func Example() {
 
 	gan, _ := c.PaperGet(paperswithcode_go.GetPaperIDFromPaperTitle("Generative Adversarial Networks"))
 	fmt.Println(gan.Title)
-	fmt.Println(gan.Authors)
 
 	// Output:
 	// 50
 	// Generative Adversarial Networks
-	// [Ian J. Goodfellow Jean Pouget-Abadie Mehdi Mirza Bing Xu David Warde-Farley Sherjil Ozair Aaron Courville Yoshua Bengio]
 }

method_get.go

@@ -6,9 +6,9 @@ import (
 
 // MethodGet returns a method in a paper.
 // See https://paperswithcode-client.readthedocs.io/en/latest/api/client.html#paperswithcode.client.PapersWithCodeClient.method_list
-func (c *Client) MethodGet(methodID string) (*models.Method, error) {
+func (c *Client) MethodGet(methodID string) (models.Method, error) {
 	url := c.baseURL + "/methods/" + methodID
 	var result models.Method
 	err := c.sendGetRequest(url, &result)
-	return &result, err
+	return result, err
 }

method_get_test.go

@@ -11,13 +11,13 @@ func TestClient_MethodGet(t *testing.T) {
 	tests := []struct {
 		name     string
 		methodID string
-		want     *models.Method
+		want     models.Method
 		wantErr  bool
 	}{
 		{
 			name:     "With a correct methodID, it returns a method",
 			methodID: "multi-head-attention",
-			want: &models.Method{
+			want: models.Method{
 				ID:          "multi-head-attention",
 				Name:        "Multi-Head Attention",
 				FullName:    "Multi-Head Attention",

method_list.go

@@ -23,9 +23,9 @@ func (m MethodListParams) Build() string {
 }
 
 // MethodList fetches a list of "methods" that can be used in research papers.
-func (c *Client) MethodList(params MethodListParams) (*models.MethodList, error) {
+func (c *Client) MethodList(params MethodListParams) (models.MethodList, error) {
 	u := c.baseURL + "/methods?" + params.Build()
 	var listResult models.MethodList
 	err := c.sendGetRequest(u, &listResult)
-	return &listResult, err
+	return listResult, err
 }

method_list_test.go

@@ -10,7 +10,7 @@ func TestClient_MethodList(t *testing.T) {
 	tests := []struct {
 		name    string
 		params  MethodListParams
-		want    *models.MethodList
+		want    models.MethodList
 		wantErr bool
 	}{
 		{
@@ -19,10 +19,10 @@ func TestClient_MethodList(t *testing.T) {
 				Page:         1,
 				ItemsPerPage: 2,
 			},
-			want: &models.MethodList{
+			want: models.MethodList{
 				Next:     toPtr("https://paperswithcode.com/api/v1/methods/?items_per_page=2&page=2"),
 				Previous: nil,
-				Results: []*models.Method{
+				Results: []models.Method{
 					{
 						ID:          "1cycle",
 						Name:        "1cycle",

models/methods.go

@@ -10,8 +10,8 @@ type Method struct {
 
 // MethodList represents methods used in the paper.
 type MethodList struct {
-	Count    int       `json:"count"`
-	Next     *string   `json:"next"`
-	Previous *string   `json:"previous"`
-	Results  []*Method `json:"results"`
+	Count    int      `json:"count"`
+	Next     *string  `json:"next"`
+	Previous *string  `json:"previous"`
+	Results  []Method `json:"results"`
 }

models/results.go

@@ -18,5 +18,5 @@ type ResultList struct {
 	Count    int     `json:"count"`
 	Next     *string `json:"next"`
 	Previous *string `json:"previous"`
-	Results  []*Result
+	Results  []Result
 }

models/tasks.go

@@ -11,5 +11,5 @@ type TaskList struct {
 	Count    int     `json:"count"`
 	Next     *string `json:"next"`
 	Previous *string `json:"previous"`
-	Results  []*Task `json:"results"`
+	Results  []Task  `json:"results"`
 }

paper_get.go

@@ -6,9 +6,9 @@ import (
 )
 
 // PaperGet returns a single paper. Note that paperID is hyphen cased (e.g., generative-adversarial-networks).
-func (c *Client) PaperGet(paperID string) (*models.Paper, error) {
+func (c *Client) PaperGet(paperID string) (models.Paper, error) {
 	paperGetURL := fmt.Sprintf("%s/papers/%s/", c.baseURL, paperID)
 	var paperGetResult models.Paper
 	err := c.sendGetRequest(paperGetURL, &paperGetResult)
-	return &paperGetResult, err
+	return paperGetResult, err
 }

paper_list.go

@@ -7,11 +7,11 @@ import (
 )
 
 // PaperList returns multiple papers.
-func (c *Client) PaperList(params PaperListParams) (*models.PaperList, error) {
+func (c *Client) PaperList(params PaperListParams) (models.PaperList, error) {
 	papersListURL := c.baseURL + "/papers?" + params.Build()
 	var paperListResult models.PaperList
 	err := c.sendGetRequest(papersListURL, &paperListResult)
-	return &paperListResult, err
+	return paperListResult, err
 }
 
 // PaperListParams is the parameter for PaperList method.

paper_method_list.go

@@ -7,9 +7,9 @@ import (
 )
 
 // PaperMethodList returns the methods used in the given paper.
-func (c *Client) PaperMethodList(paperID string) (*models.MethodList, error) {
+func (c *Client) PaperMethodList(paperID string) (models.MethodList, error) {
 	pURL := fmt.Sprintf("%s/papers/%s/methods", c.baseURL, url.QueryEscape(paperID))
 	var methodList models.MethodList
 	err := c.sendGetRequest(pURL, &methodList)
-	return &methodList, err
+	return methodList, err
 }

paper_method_list_test.go

@@ -12,11 +12,11 @@ func TestClient_PaperMethodList(t *testing.T) {
 	got, err := c.PaperMethodList(paperID)
 	assert.NoError(t, err)
 
-	expected := &models.MethodList{
+	expected := models.MethodList{
 		Count:    2,
 		Next:     nil,
 		Previous: nil,
-		Results: []*models.Method{
+		Results: []models.Method{
 			{
 				ID:          "gan",
 				Name:        "GAN",

paper_repository_list.go

@@ -7,9 +7,9 @@ import (
 )
 
 // PaperRepositoryList returns repositories related to the given paper.
-func (c *Client) PaperRepositoryList(paperID string) (*models.RepositoryList, error) {
+func (c *Client) PaperRepositoryList(paperID string) (models.RepositoryList, error) {
 	paperURL := fmt.Sprintf("%s/papers/%s/repositories", c.baseURL, url.QueryEscape(paperID))
 	var repoList models.RepositoryList
 	err := c.sendGetRequest(paperURL, &repoList)
-	return &repoList, err
+	return repoList, err
 }

paper_result_list.go

@@ -7,9 +7,9 @@ import (
 )
 
 // PaperResultList returns the evaluation results of the paper.
-func (c *Client) PaperResultList(paperID string) (*models.ResultList, error) {
+func (c *Client) PaperResultList(paperID string) (models.ResultList, error) {
 	pURL := fmt.Sprintf("%s/papers/%s/results", c.baseURL, url.QueryEscape(paperID))
 	var paperResultList models.ResultList
 	err := c.sendGetRequest(pURL, &paperResultList)
-	return &paperResultList, err
+	return paperResultList, err
 }

paper_task_list.go

@@ -7,9 +7,9 @@ import (
 )
 
 // PaperTaskList returns tasks (an area of research) for the given paper.
-func (c *Client) PaperTaskList(paperID string) (*models.TaskList, error) {
+func (c *Client) PaperTaskList(paperID string) (models.TaskList, error) {
 	pURL := fmt.Sprintf("%s/papers/%s/tasks/", c.baseURL, url.QueryEscape(paperID))
 	var taskList models.TaskList
 	err := c.sendGetRequest(pURL, &taskList)
-	return &taskList, err
+	return taskList, err
 }

paper_task_list_test.go

@@ -11,11 +11,11 @@ func TestClient_PaperTaskList(t *testing.T) {
 	got, err := c.PaperTaskList("generative-adversarial-networks")
 	assert.NoError(t, err)
 
-	expected := &models.TaskList{
+	expected := models.TaskList{
 		Count:    0,
 		Next:     nil,
 		Previous: nil,
-		Results:  []*models.Task{},
+		Results:  []models.Task{},
 	}
 	assert.Equal(t, expected, got)
 }