feat: Add support for manual orders

Checkpoint

Author: steve-r-west

external/autofill/autofill.go

@@ -1,105 +1,47 @@
 package autofill
 
 import (
-	"fmt"
-	"reflect"
-	"strconv"
 	"strings"
 
-	"github.com/brianvoe/gofakeit/v6"
+	"github.com/elasticpath/epcc-cli/external/faker"
 	"github.com/elasticpath/epcc-cli/external/resources"
-	log "github.com/sirupsen/logrus"
 )
 
-var faker = gofakeit.New(0)
-
-var zeroValue = reflect.Value{}
-
 func GetAutoFillQueryParameters(resourceName string, qps []resources.QueryParameter) []string {
 	args := make([]string, 0)
 
 	for _, v := range qps {
 		key := v.Name
 		autoFill := v.AutoFill
-		args = processAutoFill(resourceName, autoFill, args, key, key)
+		args = processAutoFill(autoFill, args, key)
 	}
 
 	return args
 }
+
 func GetJsonArrayForResource(r *resources.Resource) []string {
 
 	args := make([]string, 0)
 
-	for attributeName, data := range r.Attributes {
+	for _, data := range r.Attributes {
 		key := data.Key
 		key = strings.Replace(key, "data[n]", "data[0]", 1)
 		autofill := data.AutoFill
 
-		args = processAutoFill(r.SingularName, autofill, args, key, attributeName)
+		args = processAutoFill(autofill, args, key)
 
 	}
 	return args
 
 }
 
-func processAutoFill(resourceName string, autofill string, args []string, key string, attributeName string) []string {
+func processAutoFill(autofill string, args []string, key string) []string {
 	if strings.HasPrefix(autofill, "FUNC:") {
 
-		v := reflect.ValueOf(faker)
 		methodName := strings.Trim(autofill[5:], " ")
 
-		var rejectZero = false
-		if strings.HasPrefix(methodName, "NonZero") {
-			methodName = methodName[7:]
-			rejectZero = true
-		}
-
-		method := v.MethodByName(methodName)
-		if method.IsValid() {
-			result := method.Call([]reflect.Value{})
-			if len(result) == 1 {
-
-				var arg string
-
-				switch {
-				case result[0].CanUint():
-					for true {
-						v := result[0].Uint()
-						if v == 0 && rejectZero {
-							result = method.Call([]reflect.Value{})
-							continue
-						}
-						arg = strconv.FormatUint(v, 10)
-						break
-					}
-
-				case result[0].CanInt():
-					for true {
-						v := result[0].Int()
-						if v == 0 && rejectZero {
-							result = method.Call([]reflect.Value{})
-							continue
-						}
-						arg = strconv.FormatInt(v, 10)
-						break
-					}
-				default:
-					arg = result[0].String()
-
-					if _, err := strconv.Atoi(arg); err == nil {
-						// If we get an integer value back, lets just quote it.
-						arg = fmt.Sprintf("\"%s\"", arg)
-					}
-				}
-
-				args = append(args, key, arg)
-			} else {
-				log.Warnf("Got unexpected number of results from calling %s -> %d", methodName, len(result))
-			}
-
-		} else {
-			log.Warnf("Could not find autofill method %s for attribute %s on resource %s", methodName, attributeName, resourceName)
-		}
+		v := faker.CallFakeFunc(methodName)
+		args = append(args, key, v)
 
 	} else if strings.HasPrefix(autofill, "VALUE:") {
 		args = append(args, key, strings.Trim(autofill[6:], " "))

external/completion/completion_test.go

@@ -821,6 +821,35 @@ func TestCompleteAttributeKeyWithWhenAndSatisfiedExistingValuesReturnsSatisfiedC
 	require.Len(t, completions, 9)
 }
 
+// This test might be redundant but regex was broken for this resource at a time
+func TestCompleteAttributeKeyWithEmptyExistingValuesReturnsAllIncludingRegex(t *testing.T) {
+	// Fixture Setup
+	toComplete := ""
+	manualOrder := resources.MustGetResourceByName("manual-order")
+	request := Request{
+		Type:       CompleteAttributeKey,
+		Verb:       Create,
+		ToComplete: toComplete,
+		Resource:   manualOrder,
+		Attributes: map[string]string{
+			"meta.display_price.with_tax.currency":       "USD",
+			"meta.display_price.balance_owing.formatted": "$10.00",
+		},
+	}
+
+	// Exercise SUT
+	completions, compDir := Complete(request)
+
+	// Verify Results
+	require.Equal(t, compDir, cobra.ShellCompDirectiveNoFileComp)
+
+	require.Contains(t, completions, "meta.display_price.with_tax.amount")
+	require.Contains(t, completions, "meta.display_price.balance_owing.currency")
+	require.NotContains(t, completions, "meta.display_price.with_tax.currency")
+	require.NotContains(t, completions, "meta.display_price.balance_owing.formatted")
+	require.Contains(t, completions, "meta.display_price.paid")
+}
+
 func TestCompleteAttributeKeyWithWhenSkippingWhen(t *testing.T) {
 	// Fixture Setup
 	toComplete := ""

external/faker/faker.go

@@ -0,0 +1,75 @@
+package faker
+
+import (
+	"fmt"
+	"reflect"
+	"strconv"
+	"strings"
+
+	"github.com/brianvoe/gofakeit/v6"
+	log "github.com/sirupsen/logrus"
+)
+
+var faker = gofakeit.New(1)
+
+func Seed(n int64) {
+	faker = gofakeit.New(n)
+}
+
+func CallFakeFunc(methodName string) string {
+
+	var arg string
+	v := reflect.ValueOf(faker)
+
+	var rejectZero = false
+	if strings.HasPrefix(methodName, "NonZero") {
+		methodName = methodName[7:]
+		rejectZero = true
+	}
+
+	method := v.MethodByName(methodName)
+	if method.IsValid() {
+		result := method.Call([]reflect.Value{})
+		if len(result) == 1 {
+
+			switch {
+			case result[0].CanUint():
+				for {
+					v := result[0].Uint()
+					if v == 0 && rejectZero {
+						result = method.Call([]reflect.Value{})
+						continue
+					}
+					arg = strconv.FormatUint(v, 10)
+					break
+				}
+
+			case result[0].CanInt():
+				for {
+					v := result[0].Int()
+					if v == 0 && rejectZero {
+						result = method.Call([]reflect.Value{})
+						continue
+					}
+					arg = strconv.FormatInt(v, 10)
+					break
+				}
+			default:
+				arg = result[0].String()
+
+				if _, err := strconv.Atoi(arg); err == nil {
+					// If we get an integer value back, lets just quote it.
+					arg = fmt.Sprintf("\"%s\"", arg)
+				}
+			}
+
+		} else {
+			log.Warnf("Got unexpected number of results from calling %s -> %d", methodName, len(result))
+		}
+
+	} else {
+		log.Warnf("Could not find autofill method %s", methodName)
+	}
+
+	return arg
+}

external/resources/yaml/carts-and-orders.yaml

@@ -387,3 +387,162 @@ order-transaction-refund:
     docs: "https://elasticpath.dev/docs/carts-orders/refund-a-transaction"
     url: "/v2/orders/{orders}/transactions/{order_transactions}/refund"
     openapi-operation-id: refundATransaction
+
+manual-orders:
+  singular-name: "manual-order"
+  json-api-type: order
+  json-api-format: legacy
+  docs: "https://elasticpath.dev/docs/api/carts/orders"
+  create-entity:
+    docs: "https://elasticpath.dev/docs/api/carts/orders"
+    url: "/v2/orders"
+  attributes:
+    id:
+      type: STRING
+      usage: "Optional custom order ID. If not provided, a UUID will be generated."
+    status:
+      type: ENUM:incomplete,processing,cancelled,complete
+      usage: "The status of the order."
+    payment:
+      type: ENUM:paid,unpaid,refunded,partially_authorized,partially_paid
+      usage: "The payment status of the order."
+    shipping:
+      type: ENUM:fulfilled,unfulfilled
+      usage: "The shipping status of the order."
+    anonymized:
+      type: BOOL
+      usage: "Whether the order should be anonymized."
+    account.id:
+      type: RESOURCE_ID:account
+      usage: "The unique identifier of the account."
+    account.member_id:
+      type: RESOURCE_ID:account-member
+      usage: "The unique identifier of the account member."
+    contact.name:
+      type: STRING
+      usage: "Contact name for the order."
+    contact.email:
+      type: STRING
+      usage: "Contact email for the order."
+    customer.id:
+      type: RESOURCE_ID:customer
+      usage: "The unique identifier of the customer."
+      autofill: FUNC:UUID
+    customer.email:
+      type: STRING
+      usage: "Customer email address."
+      autofill: FUNC:Email
+    customer.name:
+      type: STRING
+      usage: "Customer name."
+      autofill: FUNC:Name
+    shipping_address.first_name:
+      type: STRING
+      autofill: FUNC:FirstName
+    shipping_address.last_name:
+      type: STRING
+      autofill: FUNC:LastName
+    shipping_address.company_name:
+      type: STRING
+      autofill: FUNC:Company
+    shipping_address.line_1:
+      type: STRING
+      autofill: FUNC:Street
+    shipping_address.line_2:
+      type: STRING
+    shipping_address.city:
+      type: STRING
+      autofill: FUNC:City
+    shipping_address.county:
+      type: STRING
+    shipping_address.region:
+      type: STRING
+      autofill: FUNC:State
+    shipping_address.postcode:
+      type: STRING
+      autofill: FUNC:Zip
+    shipping_address.country:
+      type: STRING
+      autofill: FUNC:Country
+    billing_address.first_name:
+      type: STRING
+      autofill: FUNC:FirstName
+    billing_address.last_name:
+      type: STRING
+      autofill: FUNC:LastName
+    billing_address.company_name:
+      type: STRING
+      autofill: FUNC:Company
+    billing_address.line_1:
+      type: STRING
+      autofill: FUNC:Street
+    billing_address.line_2:
+      type: STRING
+    billing_address.city:
+      type: STRING
+      autofill: FUNC:City
+    billing_address.county:
+      type: STRING
+    billing_address.region:
+      type: STRING
+      autofill: FUNC:State
+    billing_address.postcode:
+      type: STRING
+      autofill: FUNC:Zip
+    billing_address.country:
+      type: STRING
+      autofill: FUNC:Country
+    ^meta\.display_price\.(with_tax|without_tax|tax|discount|balance_owing|paid|authorized|without_discount|shipping|shipping_discount)\.amount$:
+      type: INT
+      usage: "The amount of the order specified in currency subunits"
+    ^meta\.display_price\.(with_tax|without_tax|tax|discount|balance_owing|paid|authorized|without_discount|shipping|shipping_discount)\.currency$:
+      type: CURRENCY
+      usage: "The currency"
+    ^meta\.display_price\.(with_tax|without_tax|tax|discount|balance_owing|paid|authorized|without_discount|shipping|shipping_discount)\.formatted$:
+      type: STRING
+      usage: "The amount of the order specified as a formatted string"
+    included.items[n].id:
+      type: STRING
+      usage: "The unique identifier of the item."
+    included.items[n].type:
+      type: CONST:order_item
+    included.items[n].quantity:
+      type: INT
+    included.items[n].location:
+      type: STRING
+    included.items[n].product_id:
+      type: RESOURCE_ID:pcm-product
+    included.items[n].subscription_offering_id:
+      type: RESOURCE_ID:subscription-offerings
+    included.items[n].name:
+      type: RESOURCE:STRING
+    included.items[n].sku:
+      type: STRING
+    ^included\.items[n]\.(unit_price|value)\.amount$:
+      type: INT
+      usage: "An amount in currency subunits if applicable (e.g., $100.00 would be 10000)"
+    ^included\.items[n]\.(unit_price|value)\.currency$:
+      type: CURRENCY
+    ^included\.items[n]\.(unit_price|value)\.include_tax$:
+      type: BOOL
+    ^included\.items[n]\.meta\.display_price\.(with_tax|without_tax|tax|discount_without_discount)\.(unit|value)\.amount$:
+      type: INT
+      usage: "An amount in currency subunits if applicable (e.g., $100.00 would be 10000)"
+    ^included\.items[n]\.meta\.display_price\.(with_tax|without_tax|tax|discount_without_discount)\.(unit|value)\.currency$:
+      type: CURRENCY
+    ^included\.items[n]\.meta\.display_price\.(with_tax|without_tax|tax|discount_without_discount)\.(unit|value)\.formatted$:
+      usage: "A formatted amount e.g., $100.00"
+      type: STRING
+    included.items[n].meta.timestamps.created_at:
+      type: STRING
+    included.items[n].meta.timestamps.updated_at:
+      type: STRING
+
+
+
+
+
+
+
+
+