diff --git a/conf/ezbookkeeping.ini b/conf/ezbookkeeping.ini index 50443b68..b3f639a9 100644 --- a/conf/ezbookkeeping.ini +++ b/conf/ezbookkeeping.ini @@ -347,6 +347,7 @@ custom_map_tile_server_default_zoom_level = 14 # "national_bank_of_poland": https://nbp.pl/en/statistic-and-financial-reporting/rates/ # "bank_of_israel": https://www.boi.org.il/en/economic-roles/financial-markets/exchange-rates/ # "swiss_national_bank": https://www.snb.ch/en/the-snb/mandates-goals/statistics/statistics-pub/current_interest_exchange_rates +# "danmarks_national_bank": https://www.nationalbanken.dk/en/what-we-do/stable-prices-monetary-policy-and-the-danish-economy/exchange-rates # "international_monetary_fund": https://www.imf.org/external/np/fin/data/param_rms_mth.aspx data_source = euro_central_bank diff --git a/pkg/exchangerates/danmarks_national_bank_datasource.go b/pkg/exchangerates/danmarks_national_bank_datasource.go new file mode 100644 index 00000000..4757bbd8 --- /dev/null +++ b/pkg/exchangerates/danmarks_national_bank_datasource.go @@ -0,0 +1,154 @@ +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 danmarksNationalbankExchangeRateUrl = "https://www.nationalbanken.dk/api/currencyratesxml?lang=en" +const danmarksNationalbankExchangeRateReferenceUrl = "https://www.nationalbanken.dk/en/what-we-do/stable-prices-monetary-policy-and-the-danish-economy/exchange-rates" +const danmarksNationalbankDataSource = "Danmarks Nationalbank" + +const danmarksNationalbankDataUpdateDateFormat = "2006-01-02 15" +const danmarksNationalbankDataUpdateDateTimezone = "Europe/Berlin" + +// DanmarksNationalbankDataSource defines the structure of exchange rates data source of Danmarks Nationalbank +type DanmarksNationalbankDataSource struct { + ExchangeRatesDataSource +} + +// DanmarksNationalbankExchangeRateData represents the whole data from Danmarks Nationalbank +type DanmarksNationalbankExchangeRateData struct { + XMLName xml.Name `xml:"exchangerates"` + DailyExchangeRates []*DanmarksNationalbankDailyExchangeRates `xml:"dailyrates"` + BaseCurrency string `xml:"refcur,attr"` +} + +// DanmarksNationalbankDailyExchangeRates represents the exchange rates data from Danmarks Nationalbank +type DanmarksNationalbankDailyExchangeRates struct { + Date string `xml:"id,attr"` + ExchangeRates []*DanmarksNationalbankExchangeRate `xml:"currency"` +} + +// DanmarksNationalbankExchangeRate represents the exchange rate data from Danmarks Nationalbank +type DanmarksNationalbankExchangeRate struct { + Currency string `xml:"code,attr"` + Rate string `xml:"rate,attr"` +} + +// ToLatestExchangeRateResponse returns a view-object according to original data from Danmarks Nationalbank +func (e *DanmarksNationalbankExchangeRateData) ToLatestExchangeRateResponse(c core.Context) *models.LatestExchangeRateResponse { + if len(e.DailyExchangeRates) < 1 { + log.Errorf(c, "[danmarks_national_bank_datasource.ToLatestExchangeRateResponse] daily exchange rates is empty") + return nil + } + + latestDanmarksNationalbankExchangeRate := e.DailyExchangeRates[0] + + if len(latestDanmarksNationalbankExchangeRate.ExchangeRates) < 1 { + log.Errorf(c, "[danmarks_national_bank_datasource.ToLatestExchangeRateResponse] exchange rates is empty") + return nil + } + + exchangeRates := make(models.LatestExchangeRateSlice, 0, len(latestDanmarksNationalbankExchangeRate.ExchangeRates)) + + for i := 0; i < len(latestDanmarksNationalbankExchangeRate.ExchangeRates); i++ { + exchangeRate := latestDanmarksNationalbankExchangeRate.ExchangeRates[i] + + if _, exists := validators.AllCurrencyNames[exchangeRate.Currency]; !exists { + continue + } + + finalExchangeRate := exchangeRate.ToLatestExchangeRate(c) + + if finalExchangeRate == nil { + continue + } + + exchangeRates = append(exchangeRates, finalExchangeRate) + } + + timezone, err := time.LoadLocation(danmarksNationalbankDataUpdateDateTimezone) + + if err != nil { + log.Errorf(c, "[danmarks_national_bank_datasource.ToLatestExchangeRateResponse] failed to get timezone, timezone name is %s", danmarksNationalbankDataUpdateDateTimezone) + return nil + } + + updateDateTime := latestDanmarksNationalbankExchangeRate.Date + " 16" // ECB publishes the reference rates determined at the concertation at 16:00 and shortly after Danmarks Nationalbank publishes the prices in Danish kroner + updateTime, err := time.ParseInLocation(danmarksNationalbankDataUpdateDateFormat, updateDateTime, timezone) + + if err != nil { + log.Errorf(c, "[danmarks_national_bank_datasource.ToLatestExchangeRateResponse] failed to parse update date, datetime is %s", updateDateTime) + return nil + } + + latestExchangeRateResp := &models.LatestExchangeRateResponse{ + DataSource: danmarksNationalbankDataSource, + ReferenceUrl: danmarksNationalbankExchangeRateReferenceUrl, + UpdateTime: updateTime.Unix(), + BaseCurrency: e.BaseCurrency, + ExchangeRates: exchangeRates, + } + + return latestExchangeRateResp +} + +// ToLatestExchangeRate returns a data pair according to original data from Danmarks Nationalbank +func (e *DanmarksNationalbankExchangeRate) ToLatestExchangeRate(c core.Context) *models.LatestExchangeRate { + rate, err := utils.StringToFloat64(e.Rate) + + if err != nil { + log.Warnf(c, "[danmarks_national_bank_datasource.ToLatestExchangeRate] failed to parse rate, currency is %s, rate is %s", e.Currency, e.Rate) + return nil + } + + if rate <= 0 { + log.Warnf(c, "[danmarks_national_bank_datasource.ToLatestExchangeRate] rate is invalid, currency is %s, rate is %s", e.Currency, e.Rate) + return nil + } + + finalRate := 100 / rate // the latest exchange rates listed as the price in Danish kroner for 100 units of foreign currency + + if math.IsInf(finalRate, 0) { + return nil + } + + return &models.LatestExchangeRate{ + Currency: e.Currency, + Rate: utils.Float64ToString(finalRate), + } +} + +// GetRequestUrls returns the Danmarks Nationalbank data source urls +func (e *DanmarksNationalbankDataSource) GetRequestUrls() []string { + return []string{danmarksNationalbankExchangeRateUrl} +} + +// Parse returns the common response entity according to the Danmarks Nationalbank data source raw response +func (e *DanmarksNationalbankDataSource) Parse(c core.Context, content []byte) (*models.LatestExchangeRateResponse, error) { + danmarksNationalbankData := &DanmarksNationalbankExchangeRateData{} + err := xml.Unmarshal(content, danmarksNationalbankData) + + if err != nil { + log.Errorf(c, "[danmarks_national_bank_datasource.Parse] failed to parse xml data, content is %s, because %s", string(content), err.Error()) + return nil, errs.ErrFailedToRequestRemoteApi + } + + latestExchangeRateResponse := danmarksNationalbankData.ToLatestExchangeRateResponse(c) + + if latestExchangeRateResponse == nil { + log.Errorf(c, "[danmarks_national_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/danmarks_national_bank_datasource_test.go b/pkg/exchangerates/danmarks_national_bank_datasource_test.go new file mode 100644 index 00000000..5df01512 --- /dev/null +++ b/pkg/exchangerates/danmarks_national_bank_datasource_test.go @@ -0,0 +1,141 @@ +package exchangerates + +import ( + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/mayswind/ezbookkeeping/pkg/core" + "github.com/mayswind/ezbookkeeping/pkg/models" +) + +const danmarksNationalbankMinimumRequiredContent = "\n" + + "\n" + + " \n" + + " \n" + + " \n" + + " \n" + + "" + +func TestDanmarksNationalbankDataSource_StandardDataExtractBaseCurrency(t *testing.T) { + dataSource := &DanmarksNationalbankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(danmarksNationalbankMinimumRequiredContent)) + assert.Equal(t, nil, err) + assert.Equal(t, "DKK", actualLatestExchangeRateResponse.BaseCurrency) +} + +func TestDanmarksNationalbankDataSource_StandardDataExtractUpdateTime(t *testing.T) { + dataSource := &DanmarksNationalbankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(danmarksNationalbankMinimumRequiredContent)) + assert.Equal(t, nil, err) + assert.Equal(t, int64(1731596400), actualLatestExchangeRateResponse.UpdateTime) +} + +func TestDanmarksNationalbankDataSource_StandardDataExtractExchangeRates(t *testing.T) { + dataSource := &DanmarksNationalbankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(danmarksNationalbankMinimumRequiredContent)) + assert.Equal(t, nil, err) + assert.Contains(t, actualLatestExchangeRateResponse.ExchangeRates, &models.LatestExchangeRate{ + Currency: "USD", + Rate: "0.1412070377587619", + }) + assert.Contains(t, actualLatestExchangeRateResponse.ExchangeRates, &models.LatestExchangeRate{ + Currency: "CNY", + Rate: "1.022390348635109", + }) +} + +func TestDanmarksNationalbankDataSource_BlankContent(t *testing.T) { + dataSource := &DanmarksNationalbankDataSource{} + context := core.NewNullContext() + + _, err := dataSource.Parse(context, []byte("")) + assert.NotEqual(t, nil, err) +} + +func TestDanmarksNationalbankDataSource_OnlyXMLHeader(t *testing.T) { + dataSource := &DanmarksNationalbankDataSource{} + context := core.NewNullContext() + + _, err := dataSource.Parse(context, []byte("")) + assert.NotEqual(t, nil, err) +} + +func TestDanmarksNationalbankDataSource_EmptyExchangeRatesContent(t *testing.T) { + dataSource := &DanmarksNationalbankDataSource{} + context := core.NewNullContext() + + _, err := dataSource.Parse(context, []byte(""+ + ""+ + "")) + assert.NotEqual(t, nil, err) +} + +func TestDanmarksNationalbankDataSource_EmptyDailyRatesContent(t *testing.T) { + dataSource := &DanmarksNationalbankDataSource{} + context := core.NewNullContext() + + _, err := dataSource.Parse(context, []byte(""+ + ""+ + ""+ + ""+ + "")) + assert.NotEqual(t, nil, err) +} + +func TestDanmarksNationalbankDataSource_InvalidCurrency(t *testing.T) { + dataSource := &DanmarksNationalbankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) +} + +func TestDanmarksNationalbankDataSource_EmptyRate(t *testing.T) { + dataSource := &DanmarksNationalbankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) +} + +func TestDanmarksNationalbankDataSource_InvalidRate(t *testing.T) { + dataSource := &DanmarksNationalbankDataSource{} + context := core.NewNullContext() + + actualLatestExchangeRateResponse, err := dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) + + actualLatestExchangeRateResponse, err = dataSource.Parse(context, []byte(""+ + ""+ + " \n"+ + " \n"+ + " \n"+ + "")) + assert.Equal(t, nil, err) + assert.Len(t, actualLatestExchangeRateResponse.ExchangeRates, 0) +} diff --git a/pkg/exchangerates/exchange_rates_datasource_container.go b/pkg/exchangerates/exchange_rates_datasource_container.go index 6a5a8d30..c3f3b88c 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.SwissNationalBankDataSource { Container.Current = &SwissNationalBankDataSource{} return nil + } else if config.ExchangeRatesDataSource == settings.DanmarksNationalbankDataSource { + Container.Current = &DanmarksNationalbankDataSource{} + return nil } else if config.ExchangeRatesDataSource == settings.InternationalMonetaryFundDataSource { Container.Current = &InternationalMonetaryFundDataSource{} return nil diff --git a/pkg/settings/setting.go b/pkg/settings/setting.go index 24fc1026..863ebd66 100644 --- a/pkg/settings/setting.go +++ b/pkg/settings/setting.go @@ -107,6 +107,7 @@ const ( NationalBankOfPolandDataSource string = "national_bank_of_poland" BankOfIsraelDataSource string = "bank_of_israel" SwissNationalBankDataSource string = "swiss_national_bank" + DanmarksNationalbankDataSource string = "danmarks_national_bank" InternationalMonetaryFundDataSource string = "international_monetary_fund" ) @@ -893,6 +894,8 @@ func loadExchangeRatesConfiguration(config *Config, configFile *ini.File, sectio config.ExchangeRatesDataSource = BankOfIsraelDataSource } else if dataSource == SwissNationalBankDataSource { config.ExchangeRatesDataSource = SwissNationalBankDataSource + } else if dataSource == DanmarksNationalbankDataSource { + config.ExchangeRatesDataSource = DanmarksNationalbankDataSource } else if dataSource == InternationalMonetaryFundDataSource { config.ExchangeRatesDataSource = InternationalMonetaryFundDataSource } else {