Compare commits

...

19 Commits

Author SHA1 Message Date
Bastian de Byl
d56cf589da main correct the output of GetProductById 2023-05-12 03:14:07 -04:00
Bastian de Byl
9e631a91b1 corrected SnipcartProductsResponse, added GetProductById 2023-05-12 00:36:50 -04:00
Bastian de Byl
e575ff03a8 added GetProducts, SnipcartProductsResponse, SnipcartProductVariant 2023-05-12 00:01:55 -04:00
Bastian de Byl
0ec82e6397 modified NewClient to return ptr 2023-05-03 14:22:29 -04:00
Bastian de Byl
687a5df39f added ValidateWebhook(token) func to client 2023-05-03 14:20:15 -04:00
Bastian de Byl
131af89f4f moved enums to enums.go, added SendNotification, Notification structs & enums 2023-04-12 16:56:01 -04:00
Bastian de Byl
b93afeec2f added Created and Modified times to SnipcartOrder 2023-04-09 18:31:53 -04:00
Bastian de Byl
bc56b4d16a 8677r5eju added initial .drone.yml 2023-04-06 23:34:18 -04:00
Bastian de Byl
b08b64f5b2 added SnipcartTax and SnipcartWebhookTaxResponse 2023-04-06 17:59:48 -04:00
Bastian de Byl
ad93704f41 renamed Order.ShippingRate to Order.ShippingRateId 2023-04-03 21:20:22 -04:00
Bastian de Byl
b97ee3132b consolidated webhook order to just order 2023-03-29 13:24:09 -04:00
Bastian de Byl
cfdde462f4 added more order struct details 2023-03-29 13:14:30 -04:00
Bastian de Byl
e039b583e2 fixed Curreny to Currency typo 2023-03-13 00:26:11 -04:00
Bastian de Byl
26571a41fa changed ShippingAddress State to Province 2023-03-13 00:16:22 -04:00
Bastian de Byl
559a100e90 added more missing OrderEventContent fields 2023-03-13 00:14:47 -04:00
Bastian de Byl
6ff851823e added missing OrderEventContent fields 2023-03-13 00:12:11 -04:00
Bastian de Byl
db6e320b7f added webhook specific structs 2023-03-13 00:07:50 -04:00
Bastian de Byl
563e6baeda main added Metadata field to SnipcartOrder struct 2023-03-02 17:19:50 -05:00
Bastian de Byl
e1f7e99027 moved webhook to go-snipcart-webhook repo 2023-02-26 21:23:37 -05:00
9 changed files with 206 additions and 251 deletions

29
go.mod
View File

@@ -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
)

View File

@@ -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"
)

View File

@@ -5,6 +5,8 @@ import (
"encoding/json"
"errors"
"fmt"
"net/http"
"time"
helper "github.com/debyltech/go-helpers/json"
"github.com/skip2/go-qrcode"
@@ -14,10 +16,14 @@ const (
defaultLimit = 50
apiUri = "https://app.snipcart.com"
ordersPath = "/api/orders"
productsPath = "/api/products"
validationPath = "/api/requestvalidation/"
)
var (
orderUri = apiUri + ordersPath
productsUri = apiUri + productsPath
validationUri = apiUri + validationPath
)
type Client struct {
@@ -48,26 +54,33 @@ type SnipcartItem struct {
type SnipcartOrder struct {
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"`
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"`
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 {
@@ -75,6 +88,7 @@ type SnipcartOrderUpdate struct {
PaymentStatus string `json:"paymentStatus,omitempty"`
TrackingNumber string `json:"trackingNumber,omitempty"`
TrackingUrl string `json:"trackingUrl,omitempty"`
ShippingRateId string `json:"shippingRateUserDefinedId,omitempty"`
Metadata any `json:"metadata,omitempty"`
}
@@ -83,8 +97,63 @@ type SnipcartOrders struct {
Items []SnipcartOrder
}
func NewClient(snipcartApiKey string) Client {
return Client{
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"`
}
type SnipcartProductVariant struct {
Stock int `json:"stock"`
Variation []any `json:"variation"`
AllowBackorder bool `json:"allowOutOfStockPurchases"`
}
type SnipcartProduct struct {
Token string `json:"id"`
Id string `json:"userDefinedId"`
Name string `json:"name"`
Stock int `json:"stock"`
TotalStock int `json:"totalStock"`
AllowBackorder bool `json:"allowOutOfStockPurchases"`
Variants []SnipcartProductVariant `json:"variants"`
}
type SnipcartProductsResponse struct {
Keywords string `json:"keywords"`
UserDefinedId string `json:"userDefinedId"`
Archived bool `json:"archived"`
From time.Time `json:"from"`
To time.Time `json:"to"`
OrderBy string `json:"orderBy"`
Paginated bool `json:"hasMoreResults"`
TotalItems int `json:"totalItems"`
Offset int `json:"offset"`
Limit int `json:"limit"`
Sort []any `json:"sort"`
Items []SnipcartProduct `json:"items"`
}
func NewClient(snipcartApiKey string) *Client {
return &Client{
SnipcartKey: snipcartApiKey,
AuthBase64: base64.StdEncoding.EncodeToString([]byte(snipcartApiKey + ":")),
}
@@ -155,7 +224,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 +235,84 @@ 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
}
func (s *Client) ValidateWebhook(token string) error {
validateRequest, err := http.NewRequest("GET", validationUri+token, nil)
if err != nil {
return err
}
client := &http.Client{}
auth := base64.StdEncoding.EncodeToString([]byte(s.SnipcartKey + ":"))
validateRequest.Header.Set("Authorization", fmt.Sprintf("Basic %s", auth))
validateRequest.Header.Set("Accept", "application/json")
validateResponse, err := client.Do(validateRequest)
if err != nil {
return fmt.Errorf("error validating webhook: %s", err.Error())
}
if validateResponse.StatusCode < 200 || validateResponse.StatusCode >= 300 {
return fmt.Errorf("non-2XX status code for validating webhook: %d", validateResponse.StatusCode)
}
return nil
}
func (s *Client) GetProducts(queries map[string]string) (*SnipcartProductsResponse, error) {
response, err := helper.Get(productsUri, "Basic", s.AuthBase64, queries)
if err != nil {
return nil, err
}
if response.StatusCode < 200 && response.StatusCode >= 300 {
return nil, fmt.Errorf("unexpected response received: %s", response.Status)
}
defer response.Body.Close()
var products SnipcartProductsResponse
err = json.NewDecoder(response.Body).Decode(&products)
if err != nil {
return nil, err
}
return &products, nil
}
func (s *Client) GetProductById(id string) (*SnipcartProductsResponse, error) {
response, err := helper.Get(productsUri, "Basic", s.AuthBase64, map[string]string{"userDefinedId": id})
if err != nil {
return nil, err
}
if response.StatusCode < 200 && response.StatusCode >= 300 {
return nil, fmt.Errorf("unexpected response received: %s", response.Status)
}
defer response.Body.Close()
var products SnipcartProductsResponse
err = json.NewDecoder(response.Body).Decode(&products)
if err != nil {
return nil, err
}
return &products, nil
}

21
snipcart/webhook.go Normal file
View File

@@ -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"`
}

View File

@@ -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
}

View File

@@ -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")
}