added order: prefix to TokenPNGBase64

example.go

@@ -7,6 +7,10 @@ import (
 	"github.com/debyltech/go-snipcart/snipcart"
 )
 
+const (
+	configFile = "config.json"
+)
+
 func main() {
 	snipcartApiKey := flag.String("key", "", "Snipcart API Key")
 	flag.Parse()
@@ -15,9 +19,9 @@ func main() {
 		log.Fatal("missing -key flag")
 	}
 
-	Client := snipcart.NewClient(*snipcartApiKey)
+	snipcartProvider := snipcart.NewSnipcartProvider(*snipcartApiKey)
 
-	response, err := Client.GetOrdersByStatus(snipcart.Processed)
+	response, err := snipcartProvider.GetOrdersByStatus(snipcart.Processed)
 	if err != nil {
 		log.Fatal(err)
 	}

examples/example_get_order.go

@@ -1,33 +0,0 @@
-package main
-
-import (
-	"encoding/json"
-	"flag"
-	"fmt"
-	"log"
-
-	"github.com/debyltech/go-snipcart/snipcart"
-)
-
-func main() {
-	snipcartApiKey := flag.String("key", "", "Snipcart API Key")
-	flag.Parse()
-
-	if *snipcartApiKey == "" {
-		log.Fatal("missing -key flag")
-	}
-
-	Client := snipcart.NewClient(*snipcartApiKey)
-
-	response, err := Client.GetOrder("b35990df-c0ca-4014-94de-1caa7bd7bb51")
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	byteResponse, err := json.Marshal(response)
-	if err != nil {
-		log.Fatal(err)
-	}
-
-	fmt.Println(string(byteResponse))
-}

go.mod

@@ -1,9 +1,8 @@
 module github.com/debyltech/go-snipcart
 
-go 1.19
+go 1.20
 
 require (
-	github.com/debyltech/go-helpers v1.1.0
+	github.com/debyltech/go-helpers v0.0.0-20230224002154-eb55816c71ec
-	github.com/debyltech/go-shippr v0.1.0
 	github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
 )

snipcart/common.go

@@ -1,45 +0,0 @@
-package snipcart
-
-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 Address 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 Client struct {
-	Key        string
-	AuthBase64 string
-	Limit      int
-}
-
-type CustomField struct {
-	Name     string `json:"name"`
-	Value    string `json:"value"`
-	Type     string `json:"type,omitempty"`
-	Options  string `json:"options,omitempty"`
-	Required bool   `json:"required"`
-}

snipcart/orderstatus.go

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

snipcart/snipcart.go

@@ -5,185 +5,80 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
-	"time"
 
-	helper "github.com/debyltech/go-helpers/json"
+	helper "github.com/debyltech/go-helpers"
 	"github.com/skip2/go-qrcode"
 )
 
-type Item struct {
+const (
+	defaultLimit = 50
+	apiUri       = "https://app.snipcart.com"
+	ordersPath   = "/api/orders"
+)
+
+var (
+	orderUri = apiUri + ordersPath
+)
+
+type SnipcartProvider struct {
+	SnipcartKey string
+	AuthBase64  string
+	Limit       int
+}
+
+type SnipcartItem struct {
 	UUID             string  `json:"uniqueId"`
 	ID               string  `json:"id"`
 	Name             string  `json:"name"`
-	Quantity     int           `json:"quantity"`
+	Quantity         float64 `json:"quantity"`
-	TotalWeight  float64       `json:"totalWeight,omitempty"`
+	Weight           string  `json:"weight"`
-	TotalPrice   float64       `json:"totalPrice,omitempty"`
+	TotalWeight      float64 `json:"totalWeight"`
-	CustomFields []CustomField `json:"customFields"`
+	CustomFieldsJSON string  `json:"customFieldsJson"`
-	Length       float64       `json:"length,omitempty"`
-	Width        float64       `json:"width,omitempty"`
-	Height       float64       `json:"height,omitempty"`
-	Weight       float64       `json:"weight,omitempty"`
-	Shippable    bool          `json:"shippable,omitempty"`
 }
 
-type OrderTax struct {
+type SnipcartOrder struct {
-	Name             string  `json:"taxName"`
-	Rate             float64 `json:"taxRate"`
-	Amount           float64 `json:"amount"`
-	NumberForInvoice string  `json:"numberForInvoice"`
-}
-
-type Order struct {
 	Token          string         `json:"token"`
-	Created          time.Time  `json:"creationDate"`
-	Modified         time.Time  `json:"modificationDate"`
-	Completed        time.Time  `json:"completionDate"`
 	Invoice        string         `json:"invoiceNumber"`
-	Subtotal         float64    `json:"subtotal,omitempty"`
-	Currency         string     `json:"currency,omitempty"`
-	Total            float64    `json:"grandTotal,omitempty"`
-	TotalTaxable     float64    `json:"taxableTotal,omitempty"`
-	TotalTaxes       float64    `json:"taxesTotal,omitempty"`
 	Status         string         `json:"status"`
 	TotalWeight    float64        `json:"totalWeight"`
-	ShippingAddress  Address    `json:"shippingAddress,omitempty"`
+	Email          string         `json:"email"`
-	Name             string     `json:"shippingAddressName,omitempty"`
+	Name           string         `json:"shippingAddressName"`
-	Company          string     `json:"shippingAddressCompanyName,omitempty"`
+	Address1       string         `json:"shippingAddressAddress1"`
-	Address1         string     `json:"shippingAddressAddress1,omitempty"`
+	Address2       string         `json:"shippingAddressAddress2"`
-	Address2         string     `json:"shippingAddressAddress2,omitempty"`
+	City           string         `json:"shippingAddressCity"`
-	City             string     `json:"shippingAddressCity,omitempty"`
+	Province       string         `json:"shippingAddressProvince"`
-	Province         string     `json:"shippingAddressProvince,omitempty"`
+	Country        string         `json:"shippingAddressCountry"`
-	Country          string     `json:"shippingAddressCountry,omitempty"`
+	PostalCode     string         `json:"shippingAddressPostalCode"`
-	PostalCode       string     `json:"shippingAddressPostalCode,omitempty"`
+	Phone          string         `json:"shippingAddressPhone"`
-	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"`
-	ShippingProvider string     `json:"shippingProvider,omitempty"`
-	ShippingMethod   string     `json:"shippingMethod,omitempty"`
-	ShippingRateId   string     `json:"shippingRateUserDefinedId,omitempty"`
-	Items            []Item     `json:"items"`
-	Taxes            []OrderTax `json:"taxes,omitempty"`
-	Metadata         any        `json:"metadata"`
 }
 
-type OrderUpdate struct {
+type SnipcartOrders struct {
-	Status         OrderStatus `json:"status"`
-	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"`
-}
-
-type Orders struct {
 	TotalItems int
-	Offest     int
+	Items      []SnipcartOrder
-	Limit      int
-	Items      []Order
 }
 
-type Notification struct {
+func NewSnipcartProvider(snipcartApiKey string) SnipcartProvider {
-	Type           NotificationType `json:"type"`
+	return SnipcartProvider{
-	DeliveryMethod string           `json:"deliveryMethod"`
+		SnipcartKey: snipcartApiKey,
-	Message        string           `json:"message,omitempty"`
-}
-
-type NotificationResponse 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 ProductVariant struct {
-	Stock          int   `json:"stock"`
-	Variation      []any `json:"variation"`
-	AllowBackorder bool  `json:"allowOutOfStockPurchases"`
-}
-
-type ProductCustomField struct {
-	Name         string   `json:"name"`
-	Placeholder  string   `json:"placeholder"`
-	DisplayValue string   `json:"displayValue"`
-	Type         string   `json:"type"`
-	Options      string   `json:"options"`
-	Required     bool     `json:"required"`
-	Value        string   `json:"value"`
-	Operation    float64  `json:"operation"`
-	OptionsArray []string `json:"optionsArray"`
-}
-
-type Product 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"`
-	CustomFields   []ProductCustomField `json:"customFields"`
-	Variants       []ProductVariant     `json:"variants"`
-}
-
-type ProductsResponse 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         []Product `json:"items"`
-}
-
-func NewClient(snipcartApiKey string) *Client {
-	return &Client{
-		Key:        snipcartApiKey,
 		AuthBase64:  base64.StdEncoding.EncodeToString([]byte(snipcartApiKey + ":")),
 	}
 }
 
-func (s *Client) GetOrder(token string) (*Order, error) {
+func (s *SnipcartProvider) GetOrders(queries map[string]string) (*SnipcartOrders, error) {
-	response, err := helper.Get(orderUri+"/"+token, "Basic", s.AuthBase64, nil)
-	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 order Order
-	err = json.NewDecoder(response.Body).Decode(&order)
-	if err != nil {
-		return nil, err
-	}
-
-	return &order, nil
-}
-
-func (s *Client) GetOrders(queries map[string]string) (*Orders, error) {
 	response, err := helper.Get(orderUri, "Basic", s.AuthBase64, queries)
 	if err != nil {
 		return nil, err
 	}
-	if response.StatusCode < 200 && response.StatusCode >= 300 {
+	if response.Status != "200 OK" {
 		return nil, fmt.Errorf("unexpected response received: %s", response.Status)
 	}
 
 	defer response.Body.Close()
 
-	var orders Orders
+	var orders SnipcartOrders
 	err = json.NewDecoder(response.Body).Decode(&orders)
 	if err != nil {
 		return nil, err
@@ -192,7 +87,7 @@ func (s *Client) GetOrders(queries map[string]string) (*Orders, error) {
 	return &orders, nil
 }
 
-func (s *Client) GetOrdersByStatus(status OrderStatus) (*Orders, error) {
+func (s *SnipcartProvider) GetOrdersByStatus(status OrderStatus) (*SnipcartOrders, error) {
 	if status == "" {
 		return nil, errors.New("status is not set")
 	}
@@ -200,92 +95,11 @@ func (s *Client) GetOrdersByStatus(status OrderStatus) (*Orders, error) {
 	return s.GetOrders(map[string]string{"status": string(status)})
 }
 
-func (o *Order) TokenPNGBase64() (string, error) {
+func (o *SnipcartOrder) TokenPNGBase64() (string, error) {
-	img, err := qrcode.Encode("order:"+o.Token, qrcode.Medium, 128)
+	img, err := qrcode.Encode(o.Token, qrcode.Medium, 128)
 	if err != nil {
 		return "", err
 	}
 
-	return base64.StdEncoding.EncodeToString(img), nil
+	return "order:" + base64.StdEncoding.EncodeToString(img), nil
-}
-
-func (s *Client) UpdateOrder(token string, orderUpdate *OrderUpdate) (*Order, error) {
-	response, err := helper.Put(orderUri+"/"+token, "Basic", s.AuthBase64, orderUpdate)
-	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 responseOrder Order
-	err = json.NewDecoder(response.Body).Decode(&responseOrder)
-	if err != nil {
-		return nil, err
-	}
-
-	return &responseOrder, nil
-}
-
-func (s *Client) SendNotification(token string, notification *Notification) (*NotificationResponse, error) {
-	response, err := helper.Post(orderUri+"/"+token+"/notifications", "Basic", s.AuthBase64, notification)
-	if err != nil {
-		return nil, err
-	}
-
-	defer response.Body.Close()
-
-	var responseNotification NotificationResponse
-	err = json.NewDecoder(response.Body).Decode(&responseNotification)
-	if err != nil {
-		return nil, err
-	}
-
-	return &responseNotification, nil
-}
-
-func (s *Client) GetProducts(queries map[string]string) (*ProductsResponse, 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 ProductsResponse
-	err = json.NewDecoder(response.Body).Decode(&products)
-	if err != nil {
-		return nil, err
-	}
-
-	return &products, nil
-}
-
-func (s *Client) GetProductById(id string) (*Product, 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 ProductsResponse
-	err = json.NewDecoder(response.Body).Decode(&products)
-	if err != nil {
-		return nil, err
-	}
-
-	if len(products.Items) < 1 {
-		return nil, fmt.Errorf("no products with id '%s'", id)
-	}
-
-	return &products.Items[0], nil
 }

snipcart/webhook.go

@@ -1,86 +0,0 @@
-package snipcart
-
-import (
-	"encoding/base64"
-	"fmt"
-	"net/http"
-)
-
-type ShippingError struct {
-	Key     string `json:"key"`
-	Message string `json:"message"`
-}
-
-type ShippingErrors struct {
-	Errors []ShippingError `json:"errors"`
-}
-
-type TaxShippingInfo struct {
-	Fees   float64 `json:"fees"`
-	Method string  `json:"method"`
-}
-
-type TaxContent struct {
-	Created              int             `json:"creationDate"`
-	Modified             int             `json:"modificationDate"`
-	Token                string          `json:"token"`
-	Email                string          `json:"email"`
-	ShipToBillingAddress bool            `json:"shipToBillingAddress"`
-	BillingAddress       Address         `json:"billingAddress"`
-	ShippingAddress      Address         `json:"shippingAddress"`
-	InvoiceNumber        string          `json:"invoiceNumber"`
-	ShippingInformation  TaxShippingInfo `json:"shippingInformation"`
-	Items                []Item          `json:"items"`
-	Discounts            []any           `json:"discounts"`
-	CustomFields         []CustomField   `json:"customFields"`
-	Plans                []any           `json:"plans"`
-	Refunds              []any           `json:"refunds"`
-	Taxes                []any           `json:"taxes"`
-	Currency             string          `json:"currency"`
-	Total                float64         `json:"total"`
-	DiscountsTotal       float64         `json:"discountsTotal"`
-	ItemsTotal           float64         `json:"itemsTotal"`
-	TaxesTotal           float64         `json:"taxesTotal"`
-	PlansTotal           float64         `json:"plansTotal"`
-	TaxProvider          any             `json:"taxProvider"`
-	Metadata             any             `json:"metadata"`
-}
-
-type TaxWebhook struct {
-	Content TaxContent `json:"content"`
-}
-
-type Tax struct {
-	Name             string  `json:"name"`
-	Amount           float64 `json:"amount"`
-	NumberForInvoice string  `json:"numberForInvoice"`
-	Rate             float64 `json:"rate"`
-}
-
-type TaxResponse struct {
-	Taxes []Tax `json:"taxes"`
-}
-
-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.Key + ":"))
-	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
-}