appsandbox

package
v1.0.0-beta.201 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 12, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	TargetPaymentStatusMetadataKey = "openmeter.io/sandbox/target-payment-status"

	TargetPaymentStatusPaid           = "paid"
	TargetPaymentStatusFailed         = "failed"
	TargetPaymentStatusUncollectible  = "uncollectible"
	TargetPaymentStatusActionRequired = "action_required"
)

Variables

View Source 
var (
	MarketplaceListing = app.MarketplaceListing{
		Type:        app.AppTypeSandbox,
		Name:        "Sandbox",
		Description: "Sandbox can be used to test OpenMeter without external connections.",
		Capabilities: []app.Capability{
			CollectPaymentCapability,
			CalculateTaxCapability,
			InvoiceCustomerCapability,
		},
	}

	CollectPaymentCapability = app.Capability{
		Type:        app.CapabilityTypeCollectPayments,
		Key:         "sandbox_collect_payment",
		Name:        "Payment",
		Description: "Process payments",
	}

	CalculateTaxCapability = app.Capability{
		Type:        app.CapabilityTypeCalculateTax,
		Key:         "sandbox_calculate_tax",
		Name:        "Calculate Tax",
		Description: "Calculate tax for a payment",
	}

	InvoiceCustomerCapability = app.Capability{
		Type:        app.CapabilityTypeInvoiceCustomers,
		Key:         "sandbox_invoice_customer",
		Name:        "Invoice Customer",
		Description: "Invoice a customer",
	}
)
View Source 
var ErrSimulatedPaymentFailure = billing.NewValidationError("simulated_payment_failure", "simulated payment failure")
View Source 
var (
	InvoiceSequenceNumber = billing.SequenceDefinition{
		Template: "OM-SANDBOX-{{.CustomerPrefix}}-{{.NextSequenceNumber}}",
		Scope:    "invoices/app/sandbox",
	}
)

Functions

func AutoProvision 

func AutoProvision(ctx context.Context, input AutoProvisionInput) (app.App, error)

AutoProvision creates a new default sandbox app if it doesn't exist, otherwise returns the existing one.

We install the sandbox app by default in the system, so that the user can start trying out the system right away.

Types

type App 

type App struct {
	app.AppBase
	// contains filtered or unexported fields
}

func (App) DeleteCustomerData 

func (a App) DeleteCustomerData(ctx context.Context, input app.DeleteAppInstanceCustomerDataInput) error

func (App) DeleteInvoice 

func (a App) DeleteInvoice(ctx context.Context, invoice billing.Invoice) error

func (App) FinalizeInvoice 

func (a App) FinalizeInvoice(ctx context.Context, invoice billing.Invoice) (*billing.FinalizeInvoiceResult, error)

func (App) GetCustomerData 

func (a App) GetCustomerData(ctx context.Context, input app.GetAppInstanceCustomerDataInput) (app.CustomerData, error)

func (App) PostAdvanceInvoiceHook 

func (a App) PostAdvanceInvoiceHook(ctx context.Context, invoice billing.Invoice) (*billing.PostAdvanceHookResult, error)

func (App) UpsertCustomerData 

func (a App) UpsertCustomerData(ctx context.Context, input app.UpsertAppInstanceCustomerDataInput) error

func (App) UpsertInvoice 

func (a App) UpsertInvoice(ctx context.Context, invoice billing.Invoice) (*billing.UpsertInvoiceResult, error)

func (App) ValidateCustomer 

func (a App) ValidateCustomer(ctx context.Context, customer *customer.Customer, capabilities []app.CapabilityType) error

func (App) ValidateInvoice 

func (a App) ValidateInvoice(ctx context.Context, invoice billing.Invoice) error

type AppFactory 

type AppFactory interface {
	NewApp(ctx context.Context, appBase app.AppBase) (app.App, error)
}

type AutoProvisionInput 

type AutoProvisionInput struct {
	Namespace  string
	AppService app.Service
}

func (AutoProvisionInput) Validate 

func (a AutoProvisionInput) Validate() error

type Config 

type Config struct {
	AppService     app.Service
	BillingService billing.Service
}

func (Config) Validate 

func (c Config) Validate() error

type CustomerData 

type CustomerData struct{}

func (CustomerData) Validate 

func (c CustomerData) Validate() error

type Factory 

type Factory struct {
	// contains filtered or unexported fields
}

func NewFactory 

func NewFactory(config Config) (*Factory, error)

func (*Factory) InstallAppWithAPIKey 

func (a *Factory) InstallAppWithAPIKey(ctx context.Context, input app.AppFactoryInstallAppWithAPIKeyInput) (app.App, error)

func (*Factory) NewApp 

func (a *Factory) NewApp(_ context.Context, appBase app.AppBase) (app.App, error)

Factory

func (*Factory) UninstallApp 

func (a *Factory) UninstallApp(ctx context.Context, input app.UninstallAppInput) error

type InvoiceUpsertCallback 

type InvoiceUpsertCallback func(billing.Invoice) *billing.UpsertInvoiceResult

type MockApp 

type MockApp struct {
	// contains filtered or unexported fields
}

func NewMockApp 

func NewMockApp(_ *testing.T) *MockApp

func (*MockApp) AssertExpectations 

func (m *MockApp) AssertExpectations(t *testing.T)

func (*MockApp) DeleteCustomerData 

func (m *MockApp) DeleteCustomerData(ctx context.Context, input app.DeleteAppInstanceCustomerDataInput) error

func (*MockApp) DeleteInvoice 

func (m *MockApp) DeleteInvoice(ctx context.Context, invoice billing.Invoice) error

func (*MockApp) FinalizeInvoice 

func (m *MockApp) FinalizeInvoice(ctx context.Context, invoice billing.Invoice) (*billing.FinalizeInvoiceResult, error)

func (*MockApp) GetCustomerData 

func (m *MockApp) GetCustomerData(ctx context.Context, input app.GetAppInstanceCustomerDataInput) (app.CustomerData, error)

func (*MockApp) NewApp 

func (m *MockApp) NewApp(_ context.Context, app app.AppBase) (app.App, error)

func (*MockApp) OnDeleteInvoice 

func (m *MockApp) OnDeleteInvoice(err error)

func (*MockApp) OnFinalizeInvoice 

func (m *MockApp) OnFinalizeInvoice(result *billing.FinalizeInvoiceResult)

func (*MockApp) OnUpsertInvoice 

func (m *MockApp) OnUpsertInvoice(cb InvoiceUpsertCallback)

func (*MockApp) OnValidateCustomer 

func (m *MockApp) OnValidateCustomer(err error)

func (*MockApp) OnValidateInvoice 

func (m *MockApp) OnValidateInvoice(err error)

func (*MockApp) Reset 

func (m *MockApp) Reset(t *testing.T)

func (*MockApp) UpsertCustomerData 

func (m *MockApp) UpsertCustomerData(ctx context.Context, input app.UpsertAppInstanceCustomerDataInput) error

func (*MockApp) UpsertInvoice 

func (m *MockApp) UpsertInvoice(ctx context.Context, invoice billing.Invoice) (*billing.UpsertInvoiceResult, error)

func (*MockApp) ValidateCustomer 

func (m *MockApp) ValidateCustomer(appID string, customer *customer.Customer, capabilities []app.CapabilityType) error

func (*MockApp) ValidateInvoice 

func (m *MockApp) ValidateInvoice(appID string, invoice billing.Invoice) error

type MockableFactory 

type MockableFactory struct {
	*Factory
	// contains filtered or unexported fields
}

func NewMockableFactory 

func NewMockableFactory(_ *testing.T, config Config) (*MockableFactory, error)

func (*MockableFactory) DisableMock 

func (m *MockableFactory) DisableMock()

func (*MockableFactory) EnableMock 

func (m *MockableFactory) EnableMock(t *testing.T) *MockApp

func (*MockableFactory) NewApp 

func (m *MockableFactory) NewApp(ctx context.Context, appBase app.AppBase) (app.App, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.