service

Documentation

Index

• func AwaitTermination(logger log.Logger, terminationListener chan error)
• func NewTerminationListener() chan error
• type Action
  • func (a Action) Context() map[string]log.Valuer
  • func (a *Action) Validate() error
• type Amount
  • func (a *Amount) Empty() bool
• type BindAddress
• type Config
  • func LoadConfig(logger log.Logger) (*Config, error)
  • func (cfg *Config) Validate() error
• type Copy
• type Correction
• type EntryType
• type Environment
  • func NewEnvironment(env *Environment) (*Environment, error)
  • func (env *Environment) RunServers(terminationListener chan error) func()
• type FTPAuth
• type FTPConfig
• type GlobalConfig
  • func (gc *GlobalConfig) Validate() error
• type HTTPConfig
• type Match
  • func (m Match) Context() map[string]log.Valuer
  • func (m Match) Empty() bool
• type Matching
• type Paths
• type Response
  • func (r *Response) Validate() error
• type Return
  • func (r Return) Validate() error
• type ServerConfig

Functions

func AwaitTermination

func AwaitTermination(logger log.Logger, terminationListener chan error)

func NewTerminationListener

func NewTerminationListener() chan error

Types

type Action

type Action struct {
	Delay      *time.Duration // e.g. "12h" or "10s"
	Copy       *Copy
	Correction *Correction
	Return     *Return
}

func (Action) Context

func (a Action) Context() map[string]log.Valuer

func (*Action) Validate

func (a *Action) Validate() error

type Amount

type Amount struct {
	Value int
	Min   int
	Max   int
}

func (*Amount) Empty

func (a *Amount) Empty() bool

type BindAddress

type BindAddress struct {
	Address string
}

BindAddress specifies where the http server should bind to.

type Config

type Config struct {
	Servers   ServerConfig
	Telemetry telemetry.Config

	ValidateOpts *ach.ValidateOpts
	Matching     Matching
	Responses    []Response
}

Config defines all the configuration for the app

func LoadConfig

func LoadConfig(logger log.Logger) (*Config, error)

func (*Config) Validate

func (cfg *Config) Validate() error

type Copy

type Copy struct {
	Path string
}

type Correction

type Correction struct {
	Code string
	Data string
}

type EntryType

type EntryType string

const (
	EntryTypeEmpty   EntryType = ""
	EntryTypeDebit   EntryType = "debit"
	EntryTypeCredit  EntryType = "credit"
	EntryTypePrenote EntryType = "prenote"
)

type Environment

type Environment struct {
	Logger      log.Logger
	Config      *Config
	TimeService stime.TimeService
	Router      *mux.Router

	// ftp or sftp server
	FTPServer *ftp.Server
	Shutdown  func()
}

Environment - Contains everything thats been instantiated for this service.

func NewEnvironment

func NewEnvironment(env *Environment) (*Environment, error)

NewEnvironment - Generates a new default environment. Overrides can be specified via configs.

func (*Environment) RunServers

func (env *Environment) RunServers(terminationListener chan error) func()

RunServers - Boots up all the servers and awaits till they are stopped.

type FTPAuth

type FTPAuth struct {
	Username string
	Password string
}

type FTPConfig

type FTPConfig struct {
	RootPath     string
	Hostname     string
	Auth         FTPAuth
	Port         int
	PassivePorts string
	Paths        Paths
}

FTPConfig configuration for running an FTP server

type GlobalConfig

type GlobalConfig struct {
	ACHTestHarness Config
}

func (*GlobalConfig) Validate

func (gc *GlobalConfig) Validate() error

type HTTPConfig

type HTTPConfig struct {
	Bind BindAddress
}

HTTPConfig configuration for running an http server

type Match

type Match struct {
	AccountNumber  string
	Amount         *Amount
	EntryType      EntryType
	IndividualName string
	RoutingNumber  string
	TraceNumber    string

	CompanyIdentification   string
	CompanyEntryDescription string
}

func (Match) Context

func (m Match) Context() map[string]log.Valuer

func (Match) Empty

func (m Match) Empty() bool

type Matching

type Matching struct {
	Debug bool
}

type Paths

type Paths struct {
	// Incoming Files
	Files string

	// Outgoing Files
	Return string
}

type Response

type Response struct {
	Match  Match
	Not    Match
	Action Action
}

func (*Response) Validate

func (r *Response) Validate() error

type Return

type Return struct {
	Code string
}

func (Return) Validate

func (r Return) Validate() error

type ServerConfig

type ServerConfig struct {
	FTP   *FTPConfig
	Admin HTTPConfig
}

ServerConfig - Groups all the http configs for the servers and ports that get opened.