From 10e0972d798b1578a55d27281d72c383cab6a211 Mon Sep 17 00:00:00 2001 From: MaysWind Date: Sat, 16 Nov 2024 23:28:19 +0800 Subject: [PATCH] add Norges Bank exchange rates data source --- conf/ezbookkeeping.ini | 1 + .../exchange_rates_datasource_container.go | 3 + pkg/exchangerates/norges_bank_datasource.go | 178 +++++++++++++++ .../norges_bank_datasource_test.go | 211 ++++++++++++++++++ pkg/settings/setting.go | 2 + 5 files changed, 395 insertions(+) create mode 100644 pkg/exchangerates/norges_bank_datasource.go create mode 100644 pkg/exchangerates/norges_bank_datasource_test.go diff --git a/conf/ezbookkeeping.ini b/conf/ezbookkeeping.ini index 69ac2605..84d2c25f 100644 --- a/conf/ezbookkeeping.ini +++ b/conf/ezbookkeeping.ini @@ -347,6 +347,7 @@ custom_map_tile_server_default_zoom_level = 14 # "euro_central_bank": https://www.ecb.europa.eu/stats/policy_and_exchange_rates/euro_reference_exchange_rates/html/index.en.html # "national_bank_of_georgia": https://nbg.gov.ge/en/monetary-policy/currency # "bank_of_israel": https://www.boi.org.il/en/economic-roles/financial-markets/exchange-rates/ +# "norges_bank": https://www.norges-bank.no/en/topics/Statistics/exchange_rates/ # "national_bank_of_poland": https://nbp.pl/en/statistic-and-financial-reporting/rates/ # "national_bank_of_romania": https://www.bnr.ro/Exchange-rates-1224.aspx # "swiss_national_bank": https://www.snb.ch/en/the-snb/mandates-goals/statistics/statistics-pub/current_interest_exchange_rates diff --git a/pkg/exchangerates/exchange_rates_datasource_container.go b/pkg/exchangerates/exchange_rates_datasource_container.go index a4aa5b19..3b598b81 100644 --- a/pkg/exchangerates/exchange_rates_datasource_container.go +++ b/pkg/exchangerates/exchange_rates_datasource_container.go @@ -38,6 +38,9 @@ func InitializeExchangeRatesDataSource(config *settings.Config) error { } else if config.ExchangeRatesDataSource == settings.BankOfIsraelDataSource { Container.Current = &BankOfIsraelDataSource{} return nil + } else if config.ExchangeRatesDataSource == settings.NorgesBankDataSource { + Container.Current = &NorgesBankDataSource{} + return nil } else if config.ExchangeRatesDataSource == settings.NationalBankOfPolandDataSource { Container.Current = &NationalBankOfPolandDataSource{} return nil diff --git a/pkg/exchangerates/norges_bank_datasource.go b/pkg/exchangerates/norges_bank_datasource.go new file mode 100644 index 00000000..37cac009 --- /dev/null +++ b/pkg/exchangerates/norges_bank_datasource.go @@ -0,0 +1,178 @@ +package exchangerates + +import ( + "encoding/xml" + "math" + "time" + + "github.com/mayswind/ezbookkeeping/pkg/core" + "github.com/mayswind/ezbookkeeping/pkg/errs" + "github.com/mayswind/ezbookkeeping/pkg/log" + "github.com/mayswind/ezbookkeeping/pkg/models" + "github.com/mayswind/ezbookkeeping/pkg/utils" + "github.com/mayswind/ezbookkeeping/pkg/validators" +) + +const norgesBankExchangeRateUrl = "https://data.norges-bank.no/api/data/EXR/B..NOK.SP?format=sdmx-compact-2.1&lastNObservations=1" +const norgesBankExchangeRateReferenceUrl = "https://www.norges-bank.no/en/topics/Statistics/exchange_rates/" +const norgesBankDataSource = "Norges Bank" +const norgesBankBaseCurrency = "NOK" + +const norgesBankUpdateDateFormat = "2006-01-02 15" +const norgesBankUpdateDateTimezone = "Europe/Oslo" + +// NorgesBankDataSource defines the structure of exchange rates data source of Norges Bank +type NorgesBankDataSource struct { + ExchangeRatesDataSource +} + +// NorgesBankExchangeRateData represents the whole data from Norges Bank +type NorgesBankExchangeRateData struct { + XMLName xml.Name `xml:"StructureSpecificData"` + DataSet *NorgesBankExchangeRateDataSet `xml:"DataSet"` +} + +// NorgesBankExchangeRateDataSet represents the dataset for exchange rates data of Norges Bank +type NorgesBankExchangeRateDataSet struct { + ExchangeRates []*NorgesBankExchangeRate `xml:"Series"` +} + +// NorgesBankExchangeRate represents the exchange rate data from Norges Bank +type NorgesBankExchangeRate struct { + BaseCurrency string `xml:"BASE_CUR,attr"` + TargetCurrency string `xml:"QUOTE_CUR,attr"` + UnitExponent string `xml:"UNIT_MULT,attr"` + Observations []*NorgesBankExchangeRateObservation `xml:"Obs"` +} + +// NorgesBankExchangeRateObservation represents the observation data of exchange rate data from Norges Bank +type NorgesBankExchangeRateObservation struct { + Date string `xml:"TIME_PERIOD,attr"` + Rate string `xml:"OBS_VALUE,attr"` +} + +// ToLatestExchangeRateResponse returns a view-object according to original data from Norges Bank +func (e *NorgesBankExchangeRateData) ToLatestExchangeRateResponse(c core.Context) *models.LatestExchangeRateResponse { + if e.DataSet == nil || len(e.DataSet.ExchangeRates) < 1 { + log.Errorf(c, "[norges_bank_datasource.ToLatestExchangeRateResponse] all exchange rates is empty") + return nil + } + + timezone, err := time.LoadLocation(norgesBankUpdateDateTimezone) + + if err != nil { + log.Errorf(c, "[norges_bank_datasource.ToLatestExchangeRateResponse] failed to get timezone, timezone name is %s", norgesBankUpdateDateTimezone) + return nil + } + + exchangeRates := make(models.LatestExchangeRateSlice, 0, len(e.DataSet.ExchangeRates)) + latestUpdateTime := int64(0) + + for i := 0; i < len(e.DataSet.ExchangeRates); i++ { + exchangeRate := e.DataSet.ExchangeRates[i] + + if _, exists := validators.AllCurrencyNames[exchangeRate.BaseCurrency]; !exists { + continue + } + + if exchangeRate.TargetCurrency != norgesBankBaseCurrency { + continue + } + + if len(exchangeRate.Observations) < 1 { + continue + } + + updateDateTime := exchangeRate.Observations[0].Date + " 16" // Publication time of daily exchange rates is approximately 16:00 CET. + updateTime, err := time.ParseInLocation(norgesBankUpdateDateFormat, updateDateTime, timezone) + + if err != nil { + log.Errorf(c, "[norges_bank_datasource.ToLatestExchangeRateResponse] failed to parse update date, datetime is %s", exchangeRate.Observations[0].Date) + return nil + } + + if updateTime.Unix() > latestUpdateTime { + latestUpdateTime = updateTime.Unix() + } + + finalExchangeRate := exchangeRate.ToLatestExchangeRate(c, exchangeRate.Observations[0].Rate) + + if finalExchangeRate == nil { + continue + } + + exchangeRates = append(exchangeRates, finalExchangeRate) + } + + latestExchangeRateResp := &models.LatestExchangeRateResponse{ + DataSource: norgesBankDataSource, + ReferenceUrl: norgesBankExchangeRateReferenceUrl, + UpdateTime: latestUpdateTime, + BaseCurrency: norgesBankBaseCurrency, + ExchangeRates: exchangeRates, + } + + return latestExchangeRateResp +} + +// ToLatestExchangeRate returns a data pair according to original data from Norges Bank +func (e *NorgesBankExchangeRate) ToLatestExchangeRate(c core.Context, exchangeRate string) *models.LatestExchangeRate { + rate, err := utils.StringToFloat64(exchangeRate) + + if err != nil { + log.Warnf(c, "[norges_bank_datasource.ToLatestExchangeRate] failed to parse rate, currency is %s, rate is %s", e.BaseCurrency, exchangeRate) + return nil + } + + if rate <= 0 { + log.Warnf(c, "[norges_bank_datasource.ToLatestExchangeRate] rate is invalid, currency is %s, rate is %s", e.BaseCurrency, exchangeRate) + return nil + } + + unitExponent, err := utils.StringToInt(e.UnitExponent) + + if err != nil { + log.Warnf(c, "[norges_bank_datasource.ToLatestExchangeRate] failed to parse unit, currency is %s, unit exponent is %s", e.BaseCurrency, e.UnitExponent) + return nil + } + + finalRate := 1 / rate + + if unitExponent > 0 { + finalRate = finalRate / math.Pow10(-unitExponent) + } + + if math.IsInf(finalRate, 0) { + return nil + } + + return &models.LatestExchangeRate{ + Currency: e.BaseCurrency, + Rate: utils.Float64ToString(finalRate), + } +} + +// GetRequestUrls returns the Norges Bank data source urls +func (e *NorgesBankDataSource) GetRequestUrls() []string { + return []string{norgesBankExchangeRateUrl} +} + +// Parse returns the common response entity according to the Norges Bank data source raw response +func (e *NorgesBankDataSource) Parse(c core.Context, content []byte) (*models.LatestExchangeRateResponse, error) { + norgesBankData := &NorgesBankExchangeRateData{} + err := xml.Unmarshal(content, norgesBankData) + + if err != nil { + log.Errorf(c, "[norges_bank_datasource.Parse] failed to parse xml data, content is %s, because %s", string(content), err.Error()) + return nil, errs.ErrFailedToRequestRemoteApi + } + + latestExchangeRateResponse := norgesBankData.ToLatestExchangeRateResponse(c) + + if latestExchangeRateResponse == nil { + log.Errorf(c, "[norges_bank_datasource.Parse] failed to parse latest exchange rate data, content is %s", string(content)) + return nil, errs.ErrFailedToRequestRemoteApi + } + + return latestExchangeRateResponse, nil +} diff --git a/pkg/exchangerates/norges_bank_datasource_test.go b/pkg/exchangerates/norges_bank_datasource_test.go new file mode 100644 index 00000000..d8aea336 --- /dev/null +++ b/pkg/exchangerates/norges_bank_datasource_test.go @@ -0,0 +1,211 @@ +package exchangerates + +import ( + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/mayswind/ezbookkeeping/pkg/core" + "github.com/mayswind/ezbookkeeping/pkg/models" +) + +const norgesBankOfRomaniaMinimumRequiredContent = "\n" + + "\n" + + " \n" + + " \n" + + " \n" + + " \n" + + " \n" + + " \n" + + " \n" + + " \n" + + "" + +func TestNorgesBankDataSource_StandardDataExtractBaseCurrency(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(norgesBankOfRomaniaMinimumRequiredContent)) + assert.Equal(t, nil, err) + assert.Equal(t, "NOK", actualLatestExchangeRateResponse.BaseCurrency) +} + +func TestNorgesBankDataSource_StandardDataExtractUpdateTime(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(norgesBankOfRomaniaMinimumRequiredContent)) + assert.Equal(t, nil, err) + assert.Equal(t, int64(1731682800), actualLatestExchangeRateResponse.UpdateTime) +} + +func TestNorgesBankDataSource_StandardDataExtractExchangeRates(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(norgesBankOfRomaniaMinimumRequiredContent)) + assert.Equal(t, nil, err) + assert.Contains(t, actualLatestExchangeRateResponse.ExchangeRates, &models.LatestExchangeRate{ + Currency: "JPY", + Rate: "14.049087511766112", + }) + assert.Contains(t, actualLatestExchangeRateResponse.ExchangeRates, &models.LatestExchangeRate{ + Currency: "USD", + Rate: "0.09046089827671988", + }) +} + +func TestNorgesBankDataSource_BlankContent(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + _, err := dataSource.Parse(context, []byte("")) + assert.NotEqual(t, nil, err) +} + +func TestNorgesBankDataSource_OnlyXMLHeader(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + _, err := dataSource.Parse(context, []byte("")) + assert.NotEqual(t, nil, err) +} + +func TestNorgesBankDataSource_MissingExchangeRatesDataset(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + _, err := dataSource.Parse(context, []byte(""+ + ""+ + "")) + assert.NotEqual(t, nil, err) +} + +func TestNorgesBankDataSource_EmptyExchangeRatesDataset(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + _, err := dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + "")) + assert.NotEqual(t, nil, err) +} + +func TestNorgesBankDataSource_EmptyExchangeRateObservations(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) +} + +func TestNorgesBankDataSource_InvalidCurrency(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) +} + +func TestNorgesBankDataSource_InvalidTargetCurrency(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) +} + +func TestNorgesBankDataSource_EmptyRate(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) +} + +func TestNorgesBankDataSource_InvalidRate(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) + + actualLatestExchangeRateResponse, err = dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) +} + +func TestNorgesBankDataSource_InvalidUnit(t *testing.T) { + dataSource := &NorgesBankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) + + actualLatestExchangeRateResponse, err = dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) +} diff --git a/pkg/settings/setting.go b/pkg/settings/setting.go index a93685d8..32901d00 100644 --- a/pkg/settings/setting.go +++ b/pkg/settings/setting.go @@ -107,6 +107,7 @@ const ( EuroCentralBankDataSource string = "euro_central_bank" NationalBankOfGeorgiaDataSource string = "national_bank_of_georgia" BankOfIsraelDataSource string = "bank_of_israel" + NorgesBankDataSource string = "norges_bank" NationalBankOfPolandDataSource string = "national_bank_of_poland" NationalBankOfRomaniaDataSource string = "national_bank_of_romania" SwissNationalBankDataSource string = "swiss_national_bank" @@ -890,6 +891,7 @@ func loadExchangeRatesConfiguration(config *Config, configFile *ini.File, sectio dataSource == EuroCentralBankDataSource || dataSource == NationalBankOfGeorgiaDataSource || dataSource == BankOfIsraelDataSource || + dataSource == NorgesBankDataSource || dataSource == NationalBankOfPolandDataSource || dataSource == NationalBankOfRomaniaDataSource || dataSource == SwissNationalBankDataSource ||