Merge pull request #12 from OrderMyGear/document-uploads

carrier document uploads

Author: ilyutov

.gitignore

@@ -1,3 +1,4 @@
 /pkg/
 /vendor/
-.idea
+.idea
+.tool-versions

VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

client/carrier_account.go

@@ -1,18 +1,26 @@
 package client
 
 import (
+	"bytes"
 	"encoding/json"
 	"errors"
 	"fmt"
+	"io"
+	"mime/multipart"
 	"net/http"
 
 	"github.com/OrderMyGear/go-shippo/models"
 )
 
+var (
+	ErrEmptyObjectID = errors.New("empty object ID")
+	ErrNilInput      = errors.New("nil input")
+)
+
 // CreateCarrierAccount creates a new carrier account object.
 func (c *Client) CreateCarrierAccount(input *models.CarrierAccountInput, shippoSubAccountID string) (*models.CarrierAccount, error) {
 	if input == nil {
-		return nil, errors.New("nil input")
+		return nil, ErrNilInput
 	}
 
 	output := &models.CarrierAccount{}
@@ -22,7 +30,7 @@ func (c *Client) CreateCarrierAccount(input *models.CarrierAccountInput, shippoS
 
 func (c *Client) RegisterCarrierAccount(input *models.CarrierAccountInput, shippoSubAccountID string) (*models.CarrierAccount, error) {
 	if input == nil {
-		return nil, errors.New("nil input")
+		return nil, ErrNilInput
 	}
 
 	output := &models.CarrierAccount{}
@@ -33,7 +41,7 @@ func (c *Client) RegisterCarrierAccount(input *models.CarrierAccountInput, shipp
 // RetrieveCarrierAccount retrieves an existing carrier account by object id.
 func (c *Client) RetrieveCarrierAccount(objectID string, shippoSubAccountID string) (*models.CarrierAccount, error) {
 	if objectID == "" {
-		return nil, errors.New("Empty object ID")
+		return nil, ErrEmptyObjectID
 	}
 
 	output := &models.CarrierAccount{}
@@ -60,10 +68,10 @@ func (c *Client) ListAllCarrierAccounts(shippoSubAccountID string) ([]*models.Ca
 // AccountID and Carrier cannot be updated because they form the unique identifier together.
 func (c *Client) UpdateCarrierAccount(objectID string, input *models.CarrierAccountInput, shippoSubAccountID string) (*models.CarrierAccount, error) {
 	if objectID == "" {
-		return nil, errors.New("Empty object ID")
+		return nil, ErrEmptyObjectID
 	}
 	if input == nil {
-		return nil, errors.New("nil input")
+		return nil, ErrNilInput
 	}
 
 	output := &models.CarrierAccount{}
@@ -73,7 +81,7 @@ func (c *Client) UpdateCarrierAccount(objectID string, input *models.CarrierAcco
 
 func (c *Client) ConnectCarrierAccount(objectID, redirectUrl, state string, shippoSubAccountID string) (string, error) {
 	if objectID == "" {
-		return "", errors.New("Empty object ID")
+		return "", ErrEmptyObjectID
 	}
 
 	url := fmt.Sprintf("/carrier_accounts/%s/signin/initiate?redirect_uri=%s&state=%s&redirect=false", objectID, redirectUrl, state)
@@ -86,3 +94,33 @@ func (c *Client) ConnectCarrierAccount(objectID, redirectUrl, state string, ship
 
 	return output.RedirectUri, nil
 }
+
+func (c *Client) UploadCarrierAccountDocument(objectID string, input *models.CarrierAccountDocumentInput, shippoSubAccountID string) error {
+	if objectID == "" {
+		return ErrEmptyObjectID
+	}
+	if input == nil {
+		return ErrNilInput
+	}
+
+	var buf bytes.Buffer
+	mw := multipart.NewWriter(&buf)
+
+	if err := mw.WriteField("document_type", input.DocumentType); err != nil {
+		return fmt.Errorf("Error writing document_type field: %s", err.Error())
+	}
+
+	fw, err := mw.CreateFormFile("file", input.Filename)
+	if err != nil {
+		return fmt.Errorf("Error creating file field: %s", err.Error())
+	}
+	if _, err := io.Copy(fw, input.File); err != nil {
+		return fmt.Errorf("Error writing file content: %s", err.Error())
+	}
+
+	if err := mw.Close(); err != nil {
+		return fmt.Errorf("Error closing multipart writer: %s", err.Error())
+	}
+
+	return c.doRaw(http.MethodPost, "/carrier_accounts/"+objectID+"/documents", &buf, mw.FormDataContentType(), nil, c.subAccountHeader(shippoSubAccountID))
+}

client/client.go

@@ -69,6 +69,36 @@ func (c *Client) _do(baseUrl, method, path string, input, output interface{}, he
 	return nil
 }
 
+func (c *Client) doRaw(method, path string, body io.Reader, contentType string, output interface{}, headers map[string]string) error {
+	url := shippoAPIBaseURL + path
+
+	req, err := http.NewRequest(method, url, body)
+	if err != nil {
+		return fmt.Errorf("Error creating HTTP request: %s", err.Error())
+	}
+
+	req.Header.Set("Content-Type", contentType)
+	req.Header.Set("Authorization", "ShippoToken "+c.privateToken)
+	if c.apiVersion != "" {
+		req.Header.Set("Shippo-API-Version", c.apiVersion)
+	}
+	req.Header.Set("Connection", "close")
+	req.Close = true
+
+	for k, v := range headers {
+		req.Header.Set(k, v)
+	}
+
+	if err := c.executeRequest(req, output); err != nil {
+		if aerr, ok := err.(*errors.APIError); ok {
+			return aerr
+		}
+		return fmt.Errorf("Error executing request: %s", err.Error())
+	}
+
+	return nil
+}
+
 func (c *Client) doList(method, path string, input interface{}, outputCallback listOutputCallback, headers map[string]string) error {
 	nextURL := shippoAPIBaseURL + path + "?results=25"
 
@@ -161,11 +191,8 @@ func (c *Client) createRequest(method, url string, bodyObject interface{}, heade
 	req.Header.Set("Connection", "close")
 	req.Close = true
 
-	// add any passed in headers
-	if headers != nil {
-		for k, v := range headers {
-			req.Header.Set(k, v)
-		}
+	for k, v := range headers {
+		req.Header.Set(k, v)
 	}
 
 	return req, nil

go.mod

@@ -1,3 +1,3 @@
 module github.com/OrderMyGear/go-shippo
 
-go 1.19
+go 1.24

models/carrier_account.go

@@ -1,5 +1,7 @@
 package models
 
+import "io"
+
 // See https://goshippo.com/docs/reference#carrier-accounts
 type CarrierAccountInput struct {
 	Carrier    string                 `json:"carrier"`
@@ -28,3 +30,9 @@ type Authentication struct {
 type ConnectOauth struct {
 	RedirectUri string `json:"redirect_uri"`
 }
+
+type CarrierAccountDocumentInput struct {
+	DocumentType string
+	Filename     string
+	File         io.Reader
+}