Merge pull request #47 from conekta/feature/checkout

Adding Additional Checkout Objects

Author: leofischer

checkout.go

@@ -0,0 +1,59 @@
+package conekta
+
+// CheckoutRefundParams returns api response object filled
+type CheckoutRefundParams struct {
+	Reason string `json:"reason,omitempty"`
+	Amount int64  `json:"amount,omitempty"`
+}
+
+//CheckoutParams returns api response object filled
+type CheckoutParams struct {
+	AllowedPaymentMethods      []string     `json:"allowed_payment_methods,omitempty"`
+	ExpiredAt                  int64        `json:"expired_at,omitempty"`
+	FailureUrl                 string       `json:"failure_url,omitempty"`
+	PaymentsLimitCount         int64        `json:"payments_limit_count"`
+	MultifactorAuthentication  bool         `json:"multifactor_autentication"`
+	MonthlyInstallmentsEnabled bool         `json:"monthly_installments_enabled"`
+	MonthlyInstallmentsOptions []int64      `json:"monthly_installments_options,omitempty"`
+	Name                       string       `json:"name,omitempty"`
+	NeedsShippingContact       bool         `json:"needs_shipping_contact"`
+	OrderTemplate              *OrderParams `json:"order_template,omitempty"`
+	OnDemandEnabled            bool         `json:"on_demand_enabled"`
+	Recurrent                  bool         `json:"recurrent"`
+	SuccessUrl                 string       `json:"success_url,omitempty"`
+	Type                       string       `json:"type,omitempty"`
+}
+
+// Checkout should be a struct of the api response
+type Checkout struct {
+	AllowedInstallmentOptions  []int64  `json:"allowed_installment_options,omitempty"`
+	AllowedPaymentMethods      []string `json:"allowed_payment_methods,omitempty"`
+	EmailsSent                 int64    `json:"emails_sent,omitempty"`
+	ExpiredAt                  int64    `json:"expired_at,omitempty"`
+	ExpiresAt                  int64    `json:"expires_at,omitempty"`
+	Force3dsFlow               bool     `json:"force_3ds_flow,omitempty"`
+	ID                         string   `json:"id,omitempty"`
+	Livemode                   bool     `json:"livemode,omitempty"`
+	MonthlyInstallmentsEnabled bool     `json:"monthl_installments_enabled,omitempty"`
+	Name                       string   `json:"name,omitempty"`
+	NeedsShippingContact       bool     `json:"needs_shipping_contact,omitempty"`
+	Object                     string   `json:"object,omitempty"`
+	PaidPaymentsCount          int64    `json:"paid_payments_count,omitempty"`
+	Recurrent                  bool     `json:"recurrent,omitempty"`
+	Slug                       string   `json:"slug,omitempty"`
+	SmsSent                    int64    `json:"sms_sent,omitempty"`
+	Status                     string   `json:"status,omitempty"`
+	Type                       string   `json:"type,omitempty"`
+	Url                        string   `json:"url,omitempty"`
+}
+
+// CheckoutList is a list of shippingLines
+type CheckoutList struct {
+	ListMeta
+	Data []*Checkout `json:"data,omitempty"`
+}
+
+// Bytes converts a ChargeParams to []byte
+func (c *CheckoutParams) Bytes() []byte {
+	return paramsToBytes(c)
+}

checkout/checkout_test.go

@@ -0,0 +1,93 @@
+package checkout
+
+import (
+	"testing"
+
+	conekta "github.com/conekta/conekta-go"
+	"github.com/stretchr/testify/assert"
+)
+
+func init() {
+	conekta.APIKey = conekta.TestKey
+}
+
+type Query struct {
+	Currency string `url:"currency,omitempty"`
+}
+
+func TestCreate(t *testing.T) {
+	op := (&conekta.CheckoutParams{}).Mock()
+	checkoutResponse, err := Create(op)
+
+	assert.Equal(t, op.AllowedPaymentMethods, checkoutResponse.AllowedPaymentMethods)
+	assert.Equal(t, op.ExpiredAt, checkoutResponse.ExpiredAt)
+	assert.Equal(t, op.MonthlyInstallmentsEnabled, checkoutResponse.MonthlyInstallmentsEnabled)
+	assert.Equal(t, []int64(nil), checkoutResponse.AllowedInstallmentOptions)
+	assert.Equal(t, op.Name, checkoutResponse.Name)
+	assert.Equal(t, op.NeedsShippingContact, checkoutResponse.NeedsShippingContact)
+	assert.Equal(t, op.Recurrent, checkoutResponse.Recurrent)
+	assert.Equal(t, op.Type, checkoutResponse.Type)
+	assert.Equal(t, int64(0), checkoutResponse.EmailsSent)
+	assert.Equal(t, int64(0), checkoutResponse.SmsSent)
+	assert.Nil(t, err)
+}
+
+func TestCreateValidationError(t *testing.T) {
+	op := (&conekta.CheckoutParams{}).Mock()
+	op.ExpiredAt = 0
+	_, err := Create(op)
+	assert.NotNil(t, err)
+	assert.NotNil(t, err.(conekta.Error).ErrorType, "parameter_validation_error")
+}
+
+func TestWhere(t *testing.T) {
+	op := &Query{}
+
+	res, err := Where(op)
+
+	assert.Nil(t, err)
+	assert.NotZero(t, len(res.Data))
+	assert.True(t, res.HasMore)
+	assert.Equal(t, "list", res.Object)
+
+}
+
+func TestFind(t *testing.T) {
+	op := (&conekta.CheckoutParams{}).Mock()
+	checkout, err := Create(op)
+	res, err := Find(checkout.ID)
+	assert.Equal(t, checkout.ID, res.ID)
+	assert.Nil(t, err)
+}
+
+func TestCancel(t *testing.T) {
+	op := (&conekta.CheckoutParams{}).Mock()
+	checkout, _ := Create(op)
+	res, err := Cancel(checkout.ID)
+
+	assert.NotNil(t, res.ID)
+	assert.Equal(t, res.ID, checkout.ID)
+	assert.Equal(t, res.Status, "Cancelled")
+	assert.Nil(t, err)
+
+}
+
+func TestSendEmail(t *testing.T) {
+	op := (&conekta.CheckoutParams{}).Mock()
+	checkout, _ := Create(op)
+	res, err := SendEmail(checkout.ID, "[email protected]")
+
+	assert.Equal(t, res.ID, checkout.ID)
+	assert.Equal(t, res.EmailsSent, int64(1))
+	assert.Nil(t, err)
+}
+func TestSendSms(t *testing.T) {
+	op := (&conekta.CheckoutParams{}).Mock()
+
+	checkout, _ := Create(op)
+	res, err := SendSms(checkout.ID, "[email protected]")
+
+	assert.Equal(t, res.ID, checkout.ID)
+	assert.Equal(t, res.SmsSent, int64(1))
+	assert.Nil(t, err)
+}

checkout/client.go

@@ -0,0 +1,79 @@
+package checkout
+
+import (
+	"encoding/json"
+	"fmt"
+
+	conekta "github.com/conekta/conekta-go"
+	"github.com/google/go-querystring/query"
+)
+
+type sendEmailParams struct {
+	Email string `json:"email,omitempty"`
+}
+
+// Bytes converts a ChargeParams to []byte
+func (c *sendEmailParams) Bytes() []byte {
+	r, err := json.Marshal(c)
+	if err != nil {
+		return []byte{}
+	}
+	return r
+}
+
+type sendSmsParams struct {
+	Phone string `json:"sms,omitempty"`
+}
+
+// Bytes converts a ChargeParams to []byte
+func (c *sendSmsParams) Bytes() []byte {
+	r, err := json.Marshal(c)
+	if err != nil {
+		return []byte{}
+	}
+	return r
+}
+
+// Create creates a new checkout
+func Create(p *conekta.CheckoutParams, customHeaders ...interface{}) (*conekta.Checkout, error) {
+	checkout := &conekta.Checkout{}
+	err := conekta.MakeRequest("POST", "/checkouts", p, checkout, customHeaders...)
+	return checkout, err
+}
+
+// Cancel cancels only a oxxo Checkout
+func Cancel(checkoutID string) (*conekta.Checkout, error) {
+	checkout := &conekta.Checkout{}
+	err := conekta.MakeRequest("PUT", fmt.Sprintf("/checkouts/%v/cancel", checkoutID), &conekta.EmptyParams{}, checkout)
+	return checkout, err
+}
+
+// Find gets a checkout by id
+func Find(id string) (*conekta.Checkout, error) {
+	checkout := &conekta.Checkout{}
+	err := conekta.MakeRequest("GET", fmt.Sprintf("/checkouts/%v", id), &conekta.EmptyParams{}, checkout)
+	return checkout, err
+}
+
+// Where gets a checkout by querying parameter
+func Where(params interface{}) (*conekta.CheckoutList, error) {
+	checkout := &conekta.CheckoutList{}
+	v, _ := query.Values(params)
+	err := conekta.MakeRequest("GET", fmt.Sprintf("/checkouts?%v", v.Encode()), &conekta.EmptyParams{}, checkout)
+	return checkout, err
+}
+
+// Sends an email
+func SendEmail(checkoutID string, email string) (*conekta.Checkout, error) {
+	checkout := &conekta.Checkout{}
+
+	err := conekta.MakeRequest("POST", fmt.Sprintf("/checkouts/%v/email", checkoutID), &sendEmailParams{Email: email}, checkout)
+	return checkout, err
+}
+
+// Sends an SMS
+func SendSms(checkoutID string, phone string) (*conekta.Checkout, error) {
+	checkout := &conekta.Checkout{}
+	err := conekta.MakeRequest("POST", fmt.Sprintf("/checkouts/%v/sms", checkoutID), &sendSmsParams{Phone: phone}, checkout)
+	return checkout, err
+}

go.mod

@@ -0,0 +1,8 @@
+module github.com/conekta/conekta-go
+
+go 1.15
+
+require (
+	github.com/google/go-querystring v1.0.0
+	github.com/stretchr/testify v1.7.0
+)

go.sum

@@ -0,0 +1,12 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/go-querystring v1.0.0 h1:Xkwi/a1rcvNg1PPYe5vI8GbeBY/jrVuDX5ASuANWTrk=
+github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

mocks.go

@@ -1,6 +1,7 @@
 package conekta
 
 import (
+	"math/rand"
 	"time"
 )
 
@@ -119,6 +120,33 @@ func (p *ShippingLinesParams) Mock() *ShippingLinesParams {
 	return p
 }
 
+func (p *CheckoutParams) Mock() *CheckoutParams {
+	p.Name = "Payment Link Name"
+	p.Type = "PaymentLink"
+	p.Recurrent = false
+	p.ExpiredAt = time.Now().Unix() + int64(259200) + int64(rand.Float64()*3600)
+	p.AllowedPaymentMethods = []string{"cash", "card", "bank_transfer"}
+	p.NeedsShippingContact = true
+	p.MonthlyInstallmentsEnabled = false
+	p.MonthlyInstallmentsOptions = []int64{3, 6, 9, 12}
+	p.OrderTemplate = &OrderParams{}
+	p.OrderTemplate.Currency = "MXN"
+	p.OrderTemplate.LineItems = []*LineItemsParams{
+		{
+			Name:      "Red Wine",
+			UnitPrice: 1000,
+			Quantity:  10,
+		},
+	}
+	p.OrderTemplate.CustomerInfo = &CustomerParams{
+		Name:  "Juan Perez",
+		Email: "[email protected]",
+		Phone: "5566982090",
+	}
+
+	return p
+}
+
 // Mock fills OrderParams with dummy data
 func (p *OrderParams) Mock() *OrderParams {
 	cp := &CustomerParams{}
@@ -140,6 +168,26 @@ func (p *OrderParams) Mock() *OrderParams {
 	return p
 }
 
+// Mock fills OrderParams with dummy data
+func (p *OrderParams) MockWithCheckout(customerID string) *OrderParams {
+	p.Currency = "MXN"
+	p.CustomerInfo = &CustomerParams{
+		ID: customerID,
+	}
+	p.LineItems = []*LineItemsParams{
+		{
+			Name:      "Box of Cohiba S1s",
+			UnitPrice: 35000,
+			Quantity:  1,
+		},
+	}
+	p.Checkout = &OrderCheckoutParams{
+		ExpiresAt:             time.Now().Unix() + int64(259200) + int64(rand.Float64()*3600),
+		AllowedPaymentMethods: []string{"cash", "card", "bank_transfer"},
+	}
+	return p
+}
+
 // MockWithoutCharges fills OrderParams with dummy data
 func (p *OrderParams) MockWithoutCharges() *OrderParams {
 	cp := &CustomerParams{}
@@ -314,4 +362,4 @@ func (p *SubscriptionParams) MockSubCreate() *SubscriptionParams {
 	p.CardID = c.DefaultPaymentSourceID
 	return p
 }
-*/
+*/

order.go

@@ -31,6 +31,7 @@ type OrderParams struct {
 	ShippingLines   []*ShippingLinesParams `json:"shipping_lines,omitempty"`
 	Metadata        struct{}               `json:"metadata,omitempty"`
 	Charges         []*ChargeParams        `json:"charges,omitempty"`
+	Checkout        *OrderCheckoutParams   `json:"checkout,omitempty"`
 }
 
 // Order should be a struct of the api response
@@ -53,6 +54,27 @@ type Order struct {
 	ShippingLines   *ShippingLinesList `json:"shipping_lines,omitempty"`
 	DiscountLines   *DiscountLinesList `json:"discount_lines,omitempty"`
 	Charges         *ChargesList       `json:"charges,omitempty"`
+	Checkout        *Checkout          `json:"checkout,omitempty"`
+}
+
+type OrderCheckoutParams struct {
+	Name                       string   `json:"name,omitempty"`
+	Type                       string   `json:"type,omitempty"`
+	Recurrent                  bool     `json:"recurrent,omitempty"`
+	ExpiresAt                  int64    `json:"expires_at,omitempty"`
+	AllowedPaymentMethods      []string `json:"allowed_payment_methods,omitempty"`
+	NeedsShippingContact       bool     `json:"needs_shipping_contact,omitempty"`
+	MonthlyInstallmentsEnabled bool     `json:"monthly_installments_enabled,omitempty"`
+	MonthlyInstallmentsOptions []int64  `json:"monthly_installments_options,omitempty"`
+}
+
+// CustomerInfo describes customer info
+type OrderCustomerInfoParams struct {
+	CustomerID string `json:"customer_id,omitempty"`
+	Name       string `json:"name,omitempty"`
+	Phone      string `json:"phone,omitempty"`
+	Email      string `json:"email,omitempty"`
+	Corporate  bool   `json:"corporate,omitempty"`
 }
 
 // CustomerInfo describes customer info

order/client.go

@@ -1,15 +1,17 @@
 package order
 
 import (
+	"encoding/json"
+
 	conekta "github.com/conekta/conekta-go"
 	"github.com/google/go-querystring/query"
-	"encoding/json"
 )
 
 // Create creates a new order
 func Create(p *conekta.OrderParams, customHeaders ...interface{}) (*conekta.Order, error) {
 	ord := &conekta.Order{}
 	err := conekta.MakeRequest("POST", "/orders", p, ord, customHeaders...)
+
 	if err != nil && err.(conekta.Error).ErrorType == "processing_error" {
 		json.Unmarshal(err.(conekta.Error).Data, ord)
 		return ord, nil