nbggovge

Documentation

Overview

Package nbggovge provides functionality for fetching currency rates from nbg.gov.ge API.

Index

• Variables
• type Client
  • func New() Client
  • func NewWithHTTPClient(c HTTPClient) Client
• type Currency
• type HTTPClient
• type Rates
  • func (r Rates) CurrencyByCode(code string) (Currency, error)

Variables

var ErrCodeNotFound = errors.New("code not found in set")

ErrCodeNotFound returned when specified code could not be found in set.

Types

type Client

type Client interface {
	// Rates returns ratesResponse for today by default for a list of currency codes set up by options.
	Rates(ctx context.Context, opts ...option.RatesOption) (Rates, error)
}

Client is a contract for nbg.gov.ge API.

func New

func New() Client

New returns nbg.gov.ge API client.

func NewWithHTTPClient

func NewWithHTTPClient(c HTTPClient) Client

NewWithHTTPClient returns nbg.gov.ge API client with specified http client.

type Currency

type Currency struct {
	Code          string  `json:"code"`
	Quantity      int64   `json:"quantity"`
	RateFormated  string  `json:"rateFormated"`
	DiffFormated  string  `json:"diffFormated"`
	Rate          float64 `json:"rate"`
	Name          string  `json:"name"`
	Diff          float64 `json:"diff"`
	Date          string  `json:"date"`
	ValidFromDate string  `json:"validFromDate"`
}

Currency represents rates for one currency.

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient is and interface for mocking sending http requests.

type Rates

type Rates struct {
	Date       string     `json:"date"`
	Currencies []Currency `json:"currencies"`
}

Rates represents set of rates.

func (Rates) CurrencyByCode

func (r Rates) CurrencyByCode(code string) (Currency, error)

CurrencyByCode returns Currency from set by specified code. When no currency in set - ErrCodeNotFound returned.