moved enums to enums.go, added SendNotification, Notification structs & enums

go.mod

@@ -1,36 +1,9 @@
 module github.com/debyltech/go-snipcart
 
-go 1.20
+go 1.19
 
 require (
 	github.com/debyltech/go-helpers v1.1.0
 	github.com/debyltech/go-shippr v0.1.0
-	github.com/gin-gonic/gin v1.9.0
 	github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
 )
-
-require (
-	github.com/bytedance/sonic v1.8.0 // indirect
-	github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect
-	github.com/gin-contrib/sse v0.1.0 // indirect
-	github.com/go-playground/locales v0.14.1 // indirect
-	github.com/go-playground/universal-translator v0.18.1 // indirect
-	github.com/go-playground/validator/v10 v10.11.2 // indirect
-	github.com/goccy/go-json v0.10.0 // indirect
-	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/klauspost/cpuid/v2 v2.0.9 // indirect
-	github.com/leodido/go-urn v1.2.1 // indirect
-	github.com/mattn/go-isatty v0.0.17 // indirect
-	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
-	github.com/modern-go/reflect2 v1.0.2 // indirect
-	github.com/pelletier/go-toml/v2 v2.0.6 // indirect
-	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
-	github.com/ugorji/go/codec v1.2.9 // indirect
-	golang.org/x/arch v0.0.0-20210923205945-b76863e36670 // indirect
-	golang.org/x/crypto v0.5.0 // indirect
-	golang.org/x/net v0.7.0 // indirect
-	golang.org/x/sys v0.5.0 // indirect
-	golang.org/x/text v0.7.0 // indirect
-	google.golang.org/protobuf v1.28.1 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
-)

snipcart/enums.go

@@ -1,6 +1,7 @@
 package snipcart
 
 type OrderStatus string
+type NotificationType string
 
 const (
 	Processed  OrderStatus = "Processed"
@@ -10,4 +11,10 @@ const (
 	Pending                = "Pending"
 	Cancelled              = "Cancelled"
 	Dispatched             = "Dispatched"
+
+	Comment            NotificationType = "Comment"
+	OrderStatusChanged                  = "OrderStatusChanged"
+	OrderShipped                        = "OrderShipped"
+	TrackingNumber                      = "TrackingNumber"
+	Invoice                             = "Invice"
 )

snipcart/snipcart.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"time"
 
 	helper "github.com/debyltech/go-helpers/json"
 	"github.com/skip2/go-qrcode"
@@ -47,27 +48,34 @@ type SnipcartItem struct {
 }
 
 type SnipcartOrder struct {
-	Token          string         `json:"token"`
-	Invoice        string         `json:"invoiceNumber"`
-	Subtotal       float64        `json:"subtotal,omitempty"`
-	Currency       string         `json:"currency,omitempty"`
-	Total          float64        `json:"grandTotal,omitempty"`
-	Status         string         `json:"status"`
-	TotalWeight    float64        `json:"totalWeight"`
-	Name           string         `json:"shippingAddressName"`
-	Company        string         `json:"shippingAddressCompanyName"`
-	Address1       string         `json:"shippingAddressAddress1"`
-	Address2       string         `json:"shippingAddressAddress2"`
-	City           string         `json:"shippingAddressCity"`
-	Province       string         `json:"shippingAddressProvince"`
-	Country        string         `json:"shippingAddressCountry"`
-	PostalCode     string         `json:"shippingAddressPostalCode"`
-	Phone          string         `json:"shippingAddressPhone,omitempty"`
-	Email          string         `json:"email,omitempty"`
-	TrackingNumber string         `json:"trackingNumber"`
-	TrackingUrl    string         `json:"trackingUrl"`
-	ShippingCost   float64        `json:"shippingFees"`
-	Items          []SnipcartItem `json:"items"`
+	Token            string                  `json:"token"`
+	Created          time.Time               `json:"creationDate"`
+	Modified         time.Time               `json:"modificationDate"`
+	Invoice          string                  `json:"invoiceNumber"`
+	Subtotal         float64                 `json:"subtotal,omitempty"`
+	Currency         string                  `json:"currency,omitempty"`
+	Total            float64                 `json:"grandTotal,omitempty"`
+	Status           string                  `json:"status"`
+	TotalWeight      float64                 `json:"totalWeight"`
+	ShippingAddress  SnipcartShippingAddress `json:"shippingAddress,omitempty"`
+	Name             string                  `json:"shippingAddressName,omitempty"`
+	Company          string                  `json:"shippingAddressCompanyName,omitempty"`
+	Address1         string                  `json:"shippingAddressAddress1,omitempty"`
+	Address2         string                  `json:"shippingAddressAddress2,omitempty"`
+	City             string                  `json:"shippingAddressCity,omitempty"`
+	Province         string                  `json:"shippingAddressProvince,omitempty"`
+	Country          string                  `json:"shippingAddressCountry,omitempty"`
+	PostalCode       string                  `json:"shippingAddressPostalCode,omitempty"`
+	Phone            string                  `json:"shippingAddressPhone,omitempty"`
+	Email            string                  `json:"email,omitempty"`
+	TrackingNumber   string                  `json:"trackingNumber"`
+	TrackingUrl      string                  `json:"trackingUrl"`
+	ShippingCost     float64                 `json:"shippingFees"`
+	ShippingProvider string                  `json:"shippingProvider,omitempty"`
+	ShippingMethod   string                  `json:"shippingMethod,omitempty"`
+	ShippingRateId   string                  `json:"shippingRateUserDefinedId,omitempty"`
+	Items            []SnipcartItem          `json:"items"`
+	Metadata         any                     `json:"metadata"`
 }
 
 type SnipcartOrderUpdate struct {
@@ -83,6 +91,30 @@ type SnipcartOrders struct {
 	Items      []SnipcartOrder
 }
 
+type SnipcartTax struct {
+	Name             string  `json:"name"`
+	Amount           float64 `json:"amount"`
+	NumberForInvoice string  `json:"numberForInvoice"`
+	Rate             float64 `json:"rate"`
+}
+
+type SnipcartNotification struct {
+	Type           NotificationType `json:"type"`
+	DeliveryMethod string           `json:"deliveryMethod"`
+	Message        string           `json:"message,omitempty"`
+}
+
+type SnipcartNotificationResponse struct {
+	Id             string           `json:"id"`
+	Created        time.Time        `json:"creationDate"`
+	Type           NotificationType `json:"type"`
+	DeliveryMethod string           `json:"deliveryMethod"`
+	Body           string           `json:"body"`
+	Message        string           `json:"message"`
+	Subject        string           `json:"subject"`
+	SentOn         time.Time        `json:"sentOn"`
+}
+
 func NewClient(snipcartApiKey string) Client {
 	return Client{
 		SnipcartKey: snipcartApiKey,
@@ -155,7 +187,6 @@ func (s *Client) UpdateOrder(token string, orderUpdate *SnipcartOrderUpdate) (*S
 	if response.StatusCode < 200 && response.StatusCode >= 300 {
 		return nil, fmt.Errorf("unexpected response received: %s", response.Status)
 	}
-	fmt.Println(response.Status)
 
 	defer response.Body.Close()
 
@@ -167,3 +198,20 @@ func (s *Client) UpdateOrder(token string, orderUpdate *SnipcartOrderUpdate) (*S
 
 	return &responseOrder, nil
 }
+
+func (s *Client) SendNotification(token string, notification *SnipcartNotification) (*SnipcartNotificationResponse, error) {
+	response, err := helper.Post(orderUri+"/"+token+"/notifications", "Basic", s.AuthBase64, notification)
+	if err != nil {
+		return nil, err
+	}
+
+	defer response.Body.Close()
+
+	var responseNotification SnipcartNotificationResponse
+	err = json.NewDecoder(response.Body).Decode(&responseNotification)
+	if err != nil {
+		return nil, err
+	}
+
+	return &responseNotification, nil
+}

snipcart/webhook.go

@@ -0,0 +1,21 @@
+package snipcart
+
+type SnipcartShippingAddress struct {
+	FullName    string `json:"fullName"`
+	FirstName   string `json:"firstName"`
+	Name        string `json:"name"`
+	Company     string `json:"company"`
+	Address1    string `json:"address1"`
+	Address2    string `json:"address2"`
+	FullAddress string `json:"fullAddress"`
+	City        string `json:"city"`
+	Country     string `json:"country"`
+	PostalCode  string `json:"postalCode"`
+	Province    string `json:"province"`
+	Phone       string `json:"phone"`
+	VatNumber   string `json:"vatNumber,omitempty"`
+}
+
+type SnipcartWebhookTaxResponse struct {
+	Taxes []SnipcartTax `json:"taxes"`
+}

snipcart/webhook/config.go

@@ -1,33 +0,0 @@
-package webhook
-
-import (
-	"bytes"
-	"encoding/json"
-	"io/ioutil"
-
-	"github.com/debyltech/go-shippr/shippo"
-)
-
-type Config struct {
-	ShippoApiKey       string         `json:"shippo_api_key"`
-	WeightUnit         string         `json:"weight_unit"`
-	DimensionUnit      string         `json:"dimension_unit"`
-	ManufactureCountry string         `json:"manufacture_country"`
-	SenderAddress      shippo.Address `json:"sender_address"`
-	DefaultParcel      shippo.Parcel  `json:"default_parcel"`
-}
-
-func NewConfigFromFile(filePath string) (*Config, error) {
-	configBytes, err := ioutil.ReadFile(filePath)
-	if err != nil {
-		return nil, err
-	}
-
-	var config Config
-	err = json.NewDecoder(bytes.NewBuffer(configBytes)).Decode(&config)
-	if err != nil {
-		return nil, err
-	}
-
-	return &config, nil
-}

webhook.go

@@ -1,162 +0,0 @@
-package main
-
-import (
-	"encoding/json"
-	"errors"
-	"flag"
-	"fmt"
-	"log"
-	"net/http"
-	"strconv"
-	"time"
-
-	"github.com/debyltech/go-shippr/shippo"
-	"github.com/debyltech/go-snipcart/snipcart"
-	"github.com/debyltech/go-snipcart/snipcart/webhook"
-	"github.com/gin-gonic/gin"
-)
-
-const (
-	ValidateUrl string = "https://app.snipcart.com/api/requestvalidation/"
-)
-
-type ShippingWebhookEvent struct {
-	EventName string                 `json:"eventName"`
-	CreatedOn time.Time              `json:"createdOn"`
-	Order     snipcart.SnipcartOrder `json:"content"`
-}
-
-type ShippingRatesResponse struct {
-	Cost         float64 `json:"cost"`
-	Description  string  `json:"description"`
-	DeliveryDays int     `json:"guaranteedDaysToDelivery"`
-}
-
-func ValidateWebhook(token string) error {
-	validateRequest, err := http.Get(ValidateUrl + token)
-	if err != nil {
-		return err
-	}
-
-	if validateRequest.StatusCode < 200 || validateRequest.StatusCode >= 300 {
-		return errors.New("non-2XX response received")
-	}
-
-	return nil
-}
-
-func HandleShippingRates(config *webhook.Config, shippoClient *shippo.Client) gin.HandlerFunc {
-	fn := func(c *gin.Context) {
-		err := ValidateWebhook(c.GetHeader("X-Snipcart-RequestToken"))
-		if err != nil {
-			c.AbortWithError(http.StatusBadRequest, err)
-			return
-		}
-
-		var event ShippingWebhookEvent
-		err = json.NewDecoder(c.Request.Body).Decode(&event)
-		if err != nil {
-			c.AbortWithError(http.StatusInternalServerError, err)
-			return
-		}
-
-		defer c.Request.Body.Close()
-
-		var lineItems []shippo.LineItem
-		for _, v := range event.Order.Items {
-			lineItems = append(lineItems, shippo.LineItem{
-				Quantity:           v.Quantity,
-				TotalPrice:         fmt.Sprintf("%.2f", v.TotalPrice),
-				Currency:           event.Order.Currency,
-				Weight:             fmt.Sprintf("%.2f", v.Weight),
-				WeightUnit:         config.WeightUnit,
-				Title:              v.Name,
-				ManufactureCountry: config.ManufactureCountry,
-				Sku:                v.ID,
-			})
-		}
-
-		parcel := config.DefaultParcel
-		parcel.WeightUnit = config.WeightUnit
-		parcel.DistanceUnit = config.DimensionUnit
-		parcel.Weight = fmt.Sprintf("%.2f", event.Order.TotalWeight)
-
-		rateRequest := shippo.RateRequest{
-			AddressFrom: shippo.Address{
-				Name:       config.SenderAddress.Name,
-				Address1:   config.SenderAddress.Address1,
-				Address2:   config.SenderAddress.Address2,
-				City:       config.SenderAddress.City,
-				State:      config.SenderAddress.State,
-				Country:    config.SenderAddress.Country,
-				PostalCode: config.SenderAddress.PostalCode,
-			},
-			AddressTo: shippo.Address{
-				Name:       event.Order.Name,
-				Company:    event.Order.Company,
-				Address1:   event.Order.Address1,
-				Address2:   event.Order.Address2,
-				City:       event.Order.City,
-				Country:    event.Order.Country,
-				State:      event.Order.Province,
-				PostalCode: event.Order.PostalCode,
-				Phone:      event.Order.Phone,
-				Email:      event.Order.Email,
-			},
-			LineItems: lineItems,
-			Parcel:    parcel,
-		}
-
-		rateResponse, err := shippoClient.GenerateRates(rateRequest)
-		if err != nil {
-			c.AbortWithError(http.StatusBadRequest, err)
-			return
-		}
-
-		var rates []ShippingRatesResponse
-		for _, v := range rateResponse.Rates {
-			cost, err := strconv.ParseFloat(v.Amount, 64)
-			if err != nil {
-				c.AbortWithError(http.StatusInternalServerError, err)
-				return
-			}
-			rates = append(rates, ShippingRatesResponse{
-				Cost:         cost,
-				Description:  v.Title,
-				DeliveryDays: v.EstimatedDays,
-			})
-		}
-
-		c.JSON(http.StatusOK, rates)
-	}
-
-	return fn
-}
-
-func main() {
-	configPath := flag.String("config", "", "path to config.json")
-	flag.Parse()
-
-	if *configPath == "" {
-		log.Fatal("config path not defined")
-	}
-
-	config, err := webhook.NewConfigFromFile(*configPath)
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	shippoClient := shippo.NewClient(config.ShippoApiKey)
-
-	r := gin.Default()
-
-	api := r.Group("/api")
-	{
-		v1 := api.Group("/v1")
-		{
-			v1.POST("/shipping", HandleShippingRates(config, &shippoClient))
-		}
-	}
-
-	r.Run("localhost:8081")
-}