Merge pull request #2 from simonmartyr/fix/delivery-missing-headers

fix: 🐛 support for x-picnic-did and x-picnic-agent headers

Author: simonmartyr

delivery_scenario_test.go

@@ -1,7 +1,9 @@
 package picnic
 
 import (
+	"github.com/joho/godotenv"
 	"net/http"
+	"os"
 	"testing"
 )
 
@@ -39,3 +41,27 @@ func TestGetDeliveryScenario_Error_MissingId(t *testing.T) {
 		t.Error("No error raised")
 	}
 }
+
+func Test_Integration_Deliveries(t *testing.T) {
+	godotenv.Load()
+	c := New(&http.Client{},
+		WithUsername(os.Getenv("USERNAME")),
+		WithHashedPassword(os.Getenv("SECRET")),
+		WithVersion("15"),
+	)
+	authErr := c.Authenticate()
+	if authErr != nil {
+		t.Error("auth failed")
+	}
+	deliveries, dErr := c.GetDeliveries([]DeliveryStatus{COMPLETED, CURRENT})
+	if dErr != nil {
+		t.Error(dErr)
+	}
+	pos, posErr := c.GetDeliveryPosition((*deliveries)[0].DeliveryId)
+	if posErr != nil {
+		t.Fatal(posErr)
+	}
+	if pos == nil {
+		t.Error("invalid pos")
+	}
+}

picnic.go

@@ -15,15 +15,18 @@ import (
 
 // Client the picnic api client it is recommended to use the New method to create a new instance
 type Client struct {
-	http     *http.Client
-	baseURL  string
-	version  string
-	country  string
-	token    string
-	username string
-	secret   string
+	http        *http.Client
+	baseURL     string
+	version     string
+	country     string
+	token       string
+	parsedToken *token
+	username    string
+	secret      string
 }
 
+const appVersion = "1.15.243-18832"
+
 type ClientOption func(client *Client)
 
 // WithVersion specify the particular version of the picnic API you wish to use.
@@ -182,7 +185,13 @@ func (c *Client) get(url string, result interface{}) error {
 	if requestErr != nil {
 		return requestErr
 	}
-	configureHeaders(request, c.token)
+	c.configureHeaders(request)
+	if strings.Contains(url, "deliveries") {
+		headerErr := c.includeAgentHeader(request)
+		if headerErr != nil {
+			return headerErr
+		}
+	}
 	res, httpErr := c.http.Do(request)
 	if httpErr != nil {
 		return httpErr
@@ -207,7 +216,7 @@ func (c *Client) post(url string, body any, result interface{}) error {
 	if requestErr != nil {
 		return requestErr
 	}
-	configureHeaders(request, c.token)
+	c.configureHeaders(request)
 	res, httpErr := c.http.Do(request)
 	if httpErr != nil {
 		return httpErr
@@ -263,7 +272,19 @@ func makeUrl(countryCode string, version string) string {
 	return fmt.Sprintf("https://storefront-prod.%s.picnicinternational.com/api/%s", countryCode, version)
 }
 
-func configureHeaders(request *http.Request, token string) {
-	request.Header.Set("x-picnic-auth", token)
+func (c *Client) configureHeaders(request *http.Request) {
+	request.Header.Set("x-picnic-auth", c.token)
 	request.Header.Set("Content-Type", "application/json")
 }
+
+func (c *Client) includeAgentHeader(request *http.Request) error {
+	if c.parsedToken == nil {
+		err := c.parseJwt()
+		if err != nil {
+			return err
+		}
+	}
+	request.Header.Set("x-picnic-agent", fmt.Sprintf("%d;%s;", c.parsedToken.PcClid, appVersion))
+	request.Header.Set("x-picnic-did", c.parsedToken.PcDid)
+	return nil
+}

picnic_test.go

@@ -9,6 +9,8 @@ import (
 	"testing"
 )
 
+const mockToken = `fakeheader.eyJzdWIiOiI4MDgtODEwLTAzMzkiLCJwYzpjbGlkIjoyMDEwMCwicGM6cHY6ZW5hYmxlZCI6ZmFsc2UsInBjOmxvZ2ludHMiOjE1NjEwNDUyNTYxMDcsImlzcyI6InBpY25pYy1kZXYiLCJwYzpwdjp2ZXJpZmllZCI6dHJ1ZSwicGM6MmZhIjoiTk9UX1JFUVVJUkVEIiwicGM6cm9sZSI6IlNUQU5EQVJEX1VTRVIiLCJwYzpkaWQiOiJCQTAyNjAxOC1GMEVFLTRDOTAtQTFENC00Q0MzNjg3RUE4ODEiLCJleHAiOjE3MjAyNjM5NzgsImlhdCI6MTcwNDcxMTk3OCwianRpIjoiMlJJN0c0UFUifQ.FakeSiganture`
+
 func testClient(code int, body io.Reader, validators ...func(*http.Request)) (*Client, *httptest.Server) {
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		for _, v := range validators {
@@ -24,7 +26,7 @@ func testClient(code int, body io.Reader, validators ...func(*http.Request)) (*C
 	client := &Client{
 		http:    http.DefaultClient,
 		baseURL: server.URL + "/",
-		token:   "mockToken",
+		token:   mockToken,
 	}
 	return client, server
 }
@@ -45,7 +47,7 @@ func testImageClient(code int, body io.Reader, validators ...func(*http.Request)
 	client := &Client{
 		http:    http.DefaultClient,
 		baseURL: server.URL + "/",
-		token:   "mockToken",
+		token:   mockToken,
 	}
 	return client, server
 }
@@ -227,6 +229,13 @@ func Test_Integration(t *testing.T) {
 	if authErr != nil {
 		t.Error("auth failed")
 	}
+	user, userErr := c.GetUser()
+	if userErr != nil {
+		t.Fatal(userErr)
+	}
+	if user == nil {
+		t.Error("invalid user")
+	}
 }
 
 func Test_Logout(t *testing.T) {

token.go

@@ -0,0 +1,32 @@
+package picnic
+
+import (
+	"encoding/base64"
+	"encoding/json"
+	"errors"
+	"strings"
+)
+
+type token struct {
+	Sub    string `json:"sub"`
+	PcClid int    `json:"pc:clid"`
+	PcDid  string `json:"pc:did"`
+}
+
+func (c *Client) parseJwt() error {
+	tokenParts := strings.Split(c.token, ".")
+	if len(tokenParts) != 3 {
+		return errors.New("invalid token structure")
+	}
+	jsonContent, decodeErr := base64.RawStdEncoding.DecodeString(tokenParts[1])
+	if decodeErr != nil {
+		return decodeErr
+	}
+	var toReturn = token{}
+	jsonErr := json.Unmarshal(jsonContent, &toReturn)
+	if jsonErr != nil {
+		return jsonErr
+	}
+	c.parsedToken = &toReturn
+	return nil
+}

token_test.go

@@ -0,0 +1,26 @@
+package picnic
+
+import "testing"
+
+func TestParseJwt(t *testing.T) {
+	client := &Client{
+		token: mockToken,
+	}
+	tokenErr := client.parseJwt()
+	if tokenErr != nil {
+		t.Fatal(tokenErr)
+	}
+	if client.parsedToken.PcDid == "" {
+		t.Error("PcDid invalid")
+	}
+}
+
+func TestParseJwtInvalid(t *testing.T) {
+	client := &Client{
+		token: "fakeboi",
+	}
+	tokenErr := client.parseJwt()
+	if tokenErr == nil {
+		t.Error("token should not parse")
+	}
+}