transaction

Documentation

Index

• Constants
• Variables
• func ExtractInstrumentNameFromIcon(src string) (string, error)
• func ParseFloatWithComma(src string, isNegative bool) (float64, error)
• func ParseFloatWithPeriod(src string) (float64, error)
• type Builder
  • func NewBuilder(resolver TypeResolver, logger *log.Logger) Builder
  • func (b Builder) Build(transactionType string, response details.Response) (Model, error)
  • func (b Builder) BuildDocuments(response details.Response) ([]Document, error)
  • func (b Builder) FromResponse(response details.Response) (Model, error)
  • func (b Builder) GetHeaderData(response details.Response) (string, string, time.Time, error)
  • func (b Builder) GetOverviewData(response details.Response) (string, error)
  • func (b Builder) GetPerformanceData(response details.Response) (float64, float64, error)
  • func (b Builder) GetTransactionData(response details.Response) (float64, float64, float64, float64, error)
• type BuilderInterface
• type CSVEntryFactory
  • func NewCSVEntryFactory(logger *log.Logger) CSVEntryFactory
  • func (f CSVEntryFactory) Make(transaction Model) (filesystem.CSVEntry, error)
• type Document
  • func CreateDocumentsFromResponse(resp details.Response) ([]Document, error)
  • func NewDocument(id, url, date, title string) Document
• type Instrument
  • func NewInstrument(isin, name string) Instrument
  • func (i Instrument) Type() string
• type InstrumentRepositoryInterface
• type Model
  • func NewTransaction(uuid, transactionType, status string, ...) Model
  • func (Model) TableName() string
• type Processor
  • func NewProcessor(builder BuilderInterface, transactionRepo RepositoryInterface, ...) Processor
  • func (p Processor) Process(response details.Response) error
• type RepositoryInterface
• type Type
• type TypeResolver
  • func NewTypeResolver(logger *log.Logger) TypeResolver
  • func (r TypeResolver) Resolve(response details.Response) (Type, error)

Constants

const (
	TypePurchase       = "Purchase"
	TypeSale           = "Sale"
	TypeDividendPayout = "Dividends"
	TypeRoundUp        = "Round up"
	TypeSaveback       = "Saveback"

	InstrumentTypeStocks         = "Stocks"
	InstrumentTypeETF            = "ETF"
	InstrumentTypeCryptocurrency = "Cryptocurrency"
	InstrumentTypeLending        = "Lending"
	InstrumentTypeOther          = "Other"
)

Variables

var ErrNoMatch = errors.New("value did not match the pattern")

var ErrUnsupportedResponse = errors.New("unsupported response")

Functions

func ExtractInstrumentNameFromIcon

func ExtractInstrumentNameFromIcon(src string) (string, error)

func ParseFloatWithComma

func ParseFloatWithComma(src string, isNegative bool) (float64, error)

func ParseFloatWithPeriod

func ParseFloatWithPeriod(src string) (float64, error)

Types

type Builder

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

func NewBuilder

func NewBuilder(resolver TypeResolver, logger *log.Logger) Builder

func (Builder) Build

func (b Builder) Build(transactionType string, response details.Response) (Model, error)

func (Builder) BuildDocuments

func (b Builder) BuildDocuments(response details.Response) ([]Document, error)

func (Builder) FromResponse

func (b Builder) FromResponse(response details.Response) (Model, error)

func (Builder) GetHeaderData

func (b Builder) GetHeaderData(response details.Response) (string, string, time.Time, error)

Returns Status, ISIN, Timestamp and error.

func (Builder) GetOverviewData

func (b Builder) GetOverviewData(response details.Response) (string, error)

Returns Instrument name and error.

func (Builder) GetPerformanceData

func (b Builder) GetPerformanceData(response details.Response) (float64, float64, error)

Returns Yield, Profit and error.

func (Builder) GetTransactionData

func (b Builder) GetTransactionData(response details.Response) (float64, float64, float64, float64, error)

Returns Shares, Rate, Commission, Total and error.

type BuilderInterface

type BuilderInterface interface {
	FromResponse(response details.Response) (Model, error)
}

type CSVEntryFactory

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

func NewCSVEntryFactory

func NewCSVEntryFactory(logger *log.Logger) CSVEntryFactory

func (CSVEntryFactory) Make

func (f CSVEntryFactory) Make(transaction Model) (filesystem.CSVEntry, error)

type Document

type Document struct {
	ID    string
	URL   string
	Date  string
	Title string
}

func CreateDocumentsFromResponse

func CreateDocumentsFromResponse(resp details.Response) ([]Document, error)

func NewDocument

func NewDocument(id, url, date, title string) Document

type Instrument

type Instrument struct {
	ISIN string `gorm:"primaryKey"`
	Name string
}

func NewInstrument

func NewInstrument(isin, name string) Instrument

func (Instrument) Type

func (i Instrument) Type() string

type InstrumentRepositoryInterface

type InstrumentRepositoryInterface interface {
	database.RepositoryInterface[*Instrument]
}

type Model

type Model struct {
	UUID string `gorm:"primaryKey"`

	InstrumentISIN string
	Instrument     Instrument
	Documents      []Document `gorm:"-"`

	Type       string    `gorm:"index"`
	Timestamp  time.Time `gorm:"index"`
	Status     string
	Yield      float64
	Profit     float64
	Shares     float64
	Rate       float64
	Commission float64
	Total      float64
	CreatedAt  time.Time `gorm:"index"`
	UpdatedAt  time.Time `gorm:"index"`
}

func NewTransaction

func NewTransaction(
	uuid, transactionType, status string,
	yield, profit, shares, rate, commission, total float64,
	timestamp time.Time,
	instrument Instrument,
	documents []Document,
) Model

func (Model) TableName

func (Model) TableName() string

type Processor

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

func NewProcessor

func NewProcessor(
	builder BuilderInterface,
	transactionRepo RepositoryInterface,
	factory CSVEntryFactory,
	csvReader filesystem.CSVReader,
	csvWriter filesystem.CSVWriter,
	logger *log.Logger,
) Processor

func (Processor) Process

func (p Processor) Process(response details.Response) error

type RepositoryInterface

type RepositoryInterface interface {
	database.RepositoryInterface[*Model]
}

type Type

type Type int

const (
	TypeUnsupported Type = iota
	TypeSaleTransaction
	TypePurchaseTransaction
	TypeDividendPayoutTransaction
	TypeRoundUpTransaction
	TypeSavebackTransaction
	TypeCardPaymentTransaction
)

type TypeResolver

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

func NewTypeResolver

func NewTypeResolver(logger *log.Logger) TypeResolver

func (TypeResolver) Resolve

func (r TypeResolver) Resolve(response details.Response) (Type, error)