coins

README

Coins

This is generic Wallet service with a RESTful API. Users can send money from their wallets to another.

Set up

Requires Docker.

	docker-compose up -d

Tests

make runtests to run a unit-tests.

cd tests/ && make test to run integrations tests into docker container.

If you want to write new tests - you can call make up to set up services from docker-compose.yml and call make runtests to run local tests.

API

Please see API: Payments, Accounts.

Godocs

[GoDoc](https://godoc.org/github.com/krpst/coins)

Contributing

Please see CONTRIBUTING.md.

Documentation

Index

• Variables
• type Account
  • func (from *Account) Transfer(to *Account, sum decimal.Decimal) (*Payment, error)
• type AccountID
  • func (a AccountID) String() string
• type AccountRepository
• type Payment
• type PaymentRepository

Variables

var (
	ErrNotEnoughMoney    = errors.New("you don't have enough money")
	ErrDifferentCurrency = errors.New("receiver has a different currency")
)

Types

type Account

type Account struct {
	AccountID AccountID
	Balance   decimal.Decimal
	Currency  string
}

Account represents user account.

func (*Account) Transfer

func (from *Account) Transfer(to *Account, sum decimal.Decimal) (*Payment, error)

type AccountID

type AccountID string

func (AccountID) String

func (a AccountID) String() string

type AccountRepository

type AccountRepository interface {
	Add(account *Account, tx transactions.ITransaction) error
	Get() ([]*Account, error)
	GetWithLock(id AccountID, tx transactions.ITransaction) (*Account, error)
	Update(account *Account, tx transactions.ITransaction) error
}

AccountRepository provides access to account.

type Payment

type Payment struct {
	ID            int
	FromAccountID AccountID
	ToAccountID   AccountID
	Sum           decimal.Decimal
}

Payment represents history of payments.

type PaymentRepository

type PaymentRepository interface {
	Add(payment *Payment, tx transactions.ITransaction) error
	Get() ([]*Payment, error)
}

PaymentRepository provides access to payments.