Merge pull request #5 from codingpot/refactor-1

Implement PaperGet() method

Author: deep-diver

.gitignore

@@ -14,3 +14,4 @@
 # Dependency directories (remove the comment below to include it)
 # vendor/
 /.idea/
+/.env

client.go

@@ -5,7 +5,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"github.com/codingpot/paperswithcode-go/models"
+	"github.com/codingpot/paperswithcode-go/internal/transport"
 	"net/http"
 	"net/url"
 	"time"
@@ -22,6 +22,7 @@ type ClientOption func(*Client)
 func WithAPIToken(apiToken string) ClientOption {
 	return func(client *Client) {
 		client.apiToken = apiToken
+		client.HTTPClient.Transport = transport.NewTransportWithAuthHeader(apiToken)
 	}
 }
 
@@ -52,37 +53,6 @@ type errorResponse struct {
 	Message string `json:"message"`
 }
 
-// Paper represents a specific Paper's Information by the title
-type Paper struct {
-	ID        string   `json:"id"`
-	ArxivID   string   `json:"arxiv_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"`
-}
-
-func (c *Client) GetPaper(ctx context.Context, id string) (*Paper, error) {
-	fmt.Println(id)
-	url := fmt.Sprintf("%s/papers/%s/", c.BaseURL, url.QueryEscape(id))
-	req, err := http.NewRequest("GET", url, nil)
-
-	if err != nil {
-		return nil, err
-	}
-
-	req = req.WithContext(ctx)
-
-	res := Paper{}
-	if err := c.sendRequest(req, &res); err != nil {
-		return nil, err
-	}
-
-	return &res, nil
-}
-
 // Method list used by Paper's ID
 type MethodList struct {
 	Count   int      `json:"count"`
@@ -101,7 +71,6 @@ func (c *Client) GetMethodList(ctx context.Context, id string) (*MethodList, err
 	fmt.Println(id)
 	url := fmt.Sprintf("%s/papers/%s/methods", c.BaseURL, url.QueryEscape(id))
 	req, err := http.NewRequest("GET", url, nil)
-
 	if err != nil {
 		return nil, err
 	}
@@ -177,48 +146,3 @@ func (c *Client) sendRequest(req *http.Request, v interface{}) error {
 
 	return 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, nil /*body*/)
-	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

@@ -1,7 +1,9 @@
 package paperswithcode_go
 
 import (
-	"os"
+	"github.com/codingpot/paperswithcode-go/internal/testutils"
+	"net/http"
+	"net/http/httptest"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -10,16 +12,27 @@ import (
 var apiToken string
 
 func init() {
-	var ok bool
-	apiToken, ok = os.LookupEnv("PAPERSWITHCODE_API_TOKEN")
-
-	if !ok {
-		panic("expected PAPERSWITHCODE_API_TOKEN environment variable")
-	}
+	apiToken = testutils.MustExtractAPITokenFromEnv()
 }
 
-func TestClient_PaperList(t *testing.T) {
-	client := NewClient(WithAPIToken(apiToken))
-	_, err := client.PaperList(PaperListParamsDefault())
+func TestWithAPIToken(t *testing.T) {
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
+		w.WriteHeader(http.StatusOK)
+		_, err := w.Write([]byte("ok"))
+		assert.NoError(t, err)
+	}))
+	defer server.Close()
+
+	c := NewClient(WithAPIToken("MY_TOKEN"))
+	emptyRequest, err := http.NewRequest(http.MethodGet, server.URL, nil)
+
 	assert.NoError(t, err)
+	_, err = c.HTTPClient.Transport.RoundTrip(emptyRequest)
+	assert.NoError(t, err)
+	assert.Equal(t, "Token MY_TOKEN", emptyRequest.Header.Get("Authorization"))
+}
+
+func TestTransportIsNotProvidedWhenNoAPIIsProvided(t *testing.T) {
+	c := NewClient()
+	assert.Nil(t, c.HTTPClient.Transport)
 }

cmd/client/main.go

@@ -19,7 +19,7 @@ func main() {
 	paper := "generative adversarial networks"
 	paper = strings.ReplaceAll(paper, " ", "-")
 
-	paperList, _ := c.GetPaper(ctx, paper)
+	paperList, _ := c.PaperGet(paper)
 	fmt.Println(paperList)
 	fmt.Println()
 	fmt.Println()

dummy/paper_get_response.json

@@ -0,0 +1,24 @@
+{
+  "id": "generative-adversarial-networks",
+  "arxiv_id": "1406.2661",
+  "nips_id": null,
+  "url_abs": "https://arxiv.org/abs/1406.2661v1",
+  "url_pdf": "https://arxiv.org/pdf/1406.2661v1.pdf",
+  "title": "Generative Adversarial Networks",
+  "abstract": "We propose a new framework for estimating generative models via an adversarial process, in which we simultaneously train two models: a generative model G that captures the data distribution, and a discriminative model D that estimates the probability that a sample came from the training data rather than G. The training procedure for G is to maximize the probability of D making a mistake. This framework corresponds to a minimax two-player game. In the space of arbitrary functions G and D, a unique solution exists, with G recovering the training data distribution and D equal to 1/2 everywhere. In the case where G and D are defined by multilayer perceptrons, the entire system can be trained with backpropagation. There is no need for any Markov chains or unrolled approximate inference networks during either training or generation of samples. Experiments demonstrate the potential of the framework through qualitative and quantitative evaluation of the generated samples.",
+  "authors": [
+    "Ian J. Goodfellow",
+    "Jean Pouget-Abadie",
+    "Mehdi Mirza",
+    "Bing Xu",
+    "David Warde-Farley",
+    "Sherjil Ozair",
+    "Aaron Courville",
+    "Yoshua Bengio"
+  ],
+  "published": "2014-06-10",
+  "conference": "generative-adversarial-networks-1",
+  "conference_url_abs": null,
+  "conference_url_pdf": null,
+  "proceeding": "proceedings-of-the-27th-international"
+}

internal/testutils/testutils.go

@@ -0,0 +1,12 @@
+package testutils
+
+import "os"
+
+func MustExtractAPITokenFromEnv() string {
+	apiToken, ok := os.LookupEnv("PAPERSWITHCODE_API_TOKEN")
+
+	if !ok {
+		panic("expected PAPERSWITHCODE_API_TOKEN environment variable")
+	}
+	return apiToken
+}

internal/transport/transport.go

@@ -0,0 +1,22 @@
+package transport
+
+import "net/http"
+
+type transportWithAuthHeader struct {
+	r     http.RoundTripper
+	token string
+}
+
+var _ http.RoundTripper = transportWithAuthHeader{}
+
+func (t transportWithAuthHeader) RoundTrip(request *http.Request) (*http.Response, error) {
+	request.Header.Set("Authorization", "Token "+t.token)
+	return t.r.RoundTrip(request)
+}
+
+func NewTransportWithAuthHeader(token string) http.RoundTripper {
+	return transportWithAuthHeader{
+		r:     http.DefaultTransport,
+		token: token,
+	}
+}

paperget.go

@@ -0,0 +1,25 @@
+package paperswithcode_go
+
+import (
+	"encoding/json"
+	"fmt"
+	"github.com/codingpot/paperswithcode-go/models"
+	"net/url"
+)
+
+// PaperGet returns a single paper. Note that paperID is hyphen cased (e.g., generative-adversarial-networks).
+func (c *Client) PaperGet(paperID string) (*models.PaperListResultItem, error) {
+	paperGetURL := fmt.Sprintf("%s/papers/%s/", c.BaseURL, url.QueryEscape(paperID))
+	response, err := c.HTTPClient.Get(paperGetURL)
+	if err != nil {
+		return nil, err
+	}
+
+	var paperGetResult models.PaperListResultItem
+	err = json.NewDecoder(response.Body).Decode(&paperGetResult)
+	if err != nil {
+		return nil, err
+	}
+
+	return &paperGetResult, nil
+}

paperget_test.go

@@ -0,0 +1,13 @@
+package paperswithcode_go
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestClient_PaperGet(t *testing.T) {
+	c := NewClient(WithAPIToken(apiToken))
+	got, err := c.PaperGet("generative-adversarial-networks")
+	assert.NoError(t, err)
+	assert.Equal(t, "generative-adversarial-networks", got.ID)
+}

paperlist.go

@@ -0,0 +1,47 @@
+package paperswithcode_go
+
+import (
+	"encoding/json"
+	"fmt"
+	"github.com/codingpot/paperswithcode-go/models"
+	"net/url"
+)
+
+func (c *Client) PaperList(params PaperListParams) (*models.PaperListResult, error) {
+	papersListURL := c.BaseURL + "/papers?" + params.Build()
+
+	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
+}
+
+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 PaperListParamsDefault() PaperListParams {
+	return PaperListParams{
+		Query: "",
+		Page:  1,
+		Limit: 50,
+	}
+}