feat(client): add a helper function to get paper ID from paper title

Author: kkweon

client.go

@@ -3,13 +3,17 @@ package paperswithcode_go
 import (
 	"github.com/codingpot/paperswithcode-go/internal/transport"
 	"net/http"
+	"regexp"
+	"strings"
 	"time"
 )
 
 const (
 	BaseURL = "https://paperswithcode.com/api/v1"
 )
 
+var whiteSpaceRegexp = regexp.MustCompile("\\s+")
+
 // ClientOption can be used to swap the default http client or swap the API key
 type ClientOption func(*Client)
 
@@ -42,3 +46,7 @@ type Client struct {
 	HTTPClient *http.Client
 	apiToken   string
 }
+
+func GetPaperIDFromPaperTitle(paperTitle string) string {
+	return strings.ToLower(whiteSpaceRegexp.ReplaceAllString(paperTitle, "-"))
+}

client_test.go

@@ -1,6 +1,7 @@
 package paperswithcode_go
 
 import (
+	"fmt"
 	"github.com/codingpot/paperswithcode-go/internal/testutils"
 	"net/http"
 	"net/http/httptest"
@@ -36,3 +37,35 @@ func TestTransportIsNotProvidedWhenNoAPIIsProvided(t *testing.T) {
 	c := NewClient()
 	assert.Nil(t, c.HTTPClient.Transport)
 }
+
+func ExampleGetPaperIDFromPaperTitle() {
+	paperTitle := "Generative Adversarial Networks"
+	fmt.Println(GetPaperIDFromPaperTitle(paperTitle))
+	// Output: generative-adversarial-networks
+}
+
+func TestGetPaperIDFromPaperTitle(t *testing.T) {
+	tests := []struct {
+		paperTitle  string
+		wantPaperID string
+	}{
+		{
+			paperTitle:  "This Is Paper",
+			wantPaperID: "this-is-paper",
+		},
+		{
+			paperTitle:  "This        Is Paper",
+			wantPaperID: "this-is-paper",
+		},
+		{
+			paperTitle:  "This-Is-Paper",
+			wantPaperID: "this-is-paper",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(fmt.Sprintf("The ID of %s should be %s", tt.paperTitle, tt.wantPaperID),
+			func(t *testing.T) {
+				assert.Equal(t, tt.wantPaperID, GetPaperIDFromPaperTitle(tt.paperTitle))
+			})
+	}
+}

paper_result_list_test.go

@@ -49,4 +49,4 @@ func TestClient_PaperResultList(t *testing.T) {
 	}
 
 	assert.Equal(t, expected, got)
-}
+}