eu_central_bank 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a531cbda27d58075c18fb0ed04177d5d16872e178046854495fe87c2094678e
-  data.tar.gz: b87062758ed6a9ef559fbd42a8d3bdf4f59366abd3c201951a01af62bbfb46df
+  metadata.gz: b589452c483bac16b40ab1372829694c9f261b9c802381110ed00fcebb73eaa6
+  data.tar.gz: 551614b051eb56ef4c10be19a5e796ebe0194287e1c278d374ae12f9aa5a2b9e
 SHA512:
-  metadata.gz: fffe386b9fadfa03a24e36e77bb52d66df0c21e9d042e96a74e945b314798ee942938a3e2f9aec29c69aabedd2b3934bca780574112c842764f7708816ddeee9
-  data.tar.gz: 6f495beaafc197894bbeecb9333f31d4d5b530879f64d162442fc8389793a23f87096100ee5ebc9a978143f350445dbd6e0c6651448dddc870b35e7efac8da04
+  metadata.gz: 0774ff56419fa0b24d71d8747259b1464468e3cbdb4b6db52808bf3ab9e6023cdb4a00f92e387df9e27fb9d84a16a933a588f49e7d7355db86704fa0a67ab8d7
+  data.tar.gz: 1f2a24bfd29add88ea0c537b2b7be8a245bcd8fdbe8a7bda04474757e3df9b8ebb62271b34e8dadfc029c2918b4d5c80f4a6783f043eb22d9447f29911db2534

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # eu_central_bank changelog
 
+## 1.7.0 (Nov 17 2021)
+
+* Support historical rates
+
 ## 1.6.1 (Mar 3 2021)
 
 * Allow a fallback when loading cached rate files to inhibit network fetch. 

data/lib/eu_central_bank/rates_document.rb

@@ -0,0 +1,45 @@
+class EuCentralBank < Money::Bank::VariableExchange
+  class RatesDocument < Nokogiri::XML::SAX::Document
+    attr_reader :rates
+    attr_reader :errors
+    attr_reader :updated_at
+
+    def initialize
+      @rates = {}
+      @errors = []
+      @updated_at = nil
+      @current_date = nil
+    end
+
+    def error(msg)
+      # TODO: remove this workaround after
+      # https://github.com/sparklemotion/nokogiri/pull/1872
+      # is released
+      @errors << msg
+      super
+    end
+
+    def start_element(name, attributes=[])
+      return if name != 'Cube' || attributes.empty?
+      begin
+        first_name, first_value = attributes[0]
+        case first_name
+        when 'time'
+          @current_date = Time.parse(first_value).to_date
+          @updated_at ||= @current_date
+          @rates[@current_date] = []
+        when 'currency'
+          currency = first_value
+          _, rate = attributes[1]
+          @rates[@current_date] << [currency, rate]
+        end
+      rescue StandardError => e
+        raise Nokogiri::XML::XPath::SyntaxError, e.message
+      end
+    end
+
+    def end_document
+      raise Nokogiri::XML::XPath::SyntaxError if @rates.empty? || @updated_at.nil?
+    end
+  end
+end

data/lib/eu_central_bank.rb

@@ -2,6 +2,7 @@ require 'open-uri'
 require 'nokogiri'
 require 'money'
 require 'money/rates_store/store_with_historical_data_support'
+require 'eu_central_bank/rates_document'
 
 class InvalidCache < StandardError ; end
 
@@ -19,6 +20,9 @@ class EuCentralBank < Money::Bank::VariableExchange
   CURRENCIES = %w(USD JPY BGN CZK DKK GBP HUF ILS ISK PLN RON SEK CHF NOK HRK RUB TRY AUD BRL CAD CNY HKD IDR INR KRW MXN MYR NZD PHP SGD THB ZAR).map(&:freeze).freeze
   ECB_RATES_URL = 'https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml'.freeze
   ECB_90_DAY_URL = 'https://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml'.freeze
+  ECB_ALL_HIST_URL = 'https://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist.xml'.freeze
+
+  LEGACY_CURRENCIES = %w(CYP SIT ROL TRL)
 
   def initialize(st = Money::RatesStore::StoreWithHistoricalDataSupport.new, &block)
     super
@@ -29,20 +33,26 @@ class EuCentralBank < Money::Bank::VariableExchange
     update_parsed_rates(doc(cache, url))
   end
 
-  def update_historical_rates(cache=nil)
-    update_parsed_historical_rates(doc(cache, ECB_90_DAY_URL))
+  def update_historical_rates(cache=nil, all=false)
+    url = all ? ECB_ALL_HIST_URL : ECB_90_DAY_URL
+    update_parsed_historical_rates(doc(cache, url))
   end
 
   def save_rates(cache, url=ECB_RATES_URL)
     raise InvalidCache unless cache
     File.open(cache, "w") do |file|
-      io = open_url(url);
+      io = open_url(url)
       io.each_line { |line| file.puts line }
     end
   end
 
+  def save_historical_rates(cache, all=false)
+    url = all ? ECB_ALL_HIST_URL : ECB_90_DAY_URL
+    save_rates(cache, url)
+  end
+
   def update_rates_from_s(content)
-    update_parsed_rates(doc_from_s(content))
+    update_parsed_rates(parse_rates(content))
   end
 
   def save_rates_to_s(url=ECB_RATES_URL)
@@ -164,48 +174,53 @@ class EuCentralBank < Money::Bank::VariableExchange
 
   def doc(cache, url=ECB_RATES_URL)
     rates_source = !!cache ? cache : url
-    Nokogiri::XML(open_url(rates_source)).tap { |doc| doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube//xmlns:Cube') }
-  rescue Nokogiri::XML::XPath::SyntaxError
-    Nokogiri::XML(open_url(url))
+    begin
+      parse_rates(open_url(rates_source))
+    rescue Nokogiri::XML::XPath::SyntaxError
+      parse_rates(open_url(url))
+    end
   end
 
-  def doc_from_s(content)
-    Nokogiri::XML(content)
-  end
+  def parse_rates(io)
+    doc = ::EuCentralBank::RatesDocument.new
+    parser = Nokogiri::XML::SAX::Parser.new(doc)
+    parser.parse(io)
 
-  def update_parsed_rates(doc)
-    rates = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube//xmlns:Cube')
+    unless doc.errors.empty?
+      # Temporary workaround for jruby until
+      # https://github.com/sparklemotion/nokogiri/pull/1872 gets
+      # released and we bump nokogiri version to include it.
+      # TLDR: jruby version of SAX parser will mask all the exceptions
+      # raised in document so we will raise it here if there were errors.
+      raise Nokogiri::XML::XPath::SyntaxError, doc.errors.join("\n")
+    end
 
-    store.transaction true do
-      rates.each do |exchange_rate|
-        rate = BigDecimal(exchange_rate.attribute("rate").value, DECIMAL_PRECISION)
-        currency = exchange_rate.attribute("currency").value
-        set_rate("EUR", currency, rate)
+    doc
+  end
+
+  def copy_rates(rates_document, with_date = false)
+    rates_document.rates.each do |date, rates|
+      rates.each do |currency, rate|
+        next if LEGACY_CURRENCIES.include?(currency)
+        set_rate('EUR', currency, BigDecimal(rate, DECIMAL_PRECISION), with_date ? date : nil)
       end
-      set_rate("EUR", "EUR", 1)
+      set_rate('EUR', 'EUR', 1, with_date ? date : nil)
     end
+  end
 
-    rates_updated_at = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube/@time').first.value
-    @rates_updated_at = Time.parse(rates_updated_at)
-
+  def update_parsed_rates(rates_document)
+    store.transaction true do
+      copy_rates(rates_document)
+    end
+    @rates_updated_at = rates_document.updated_at
     @last_updated = Time.now
   end
 
-  def update_parsed_historical_rates(doc)
-    rates = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube//xmlns:Cube')
-
+  def update_parsed_historical_rates(rates_document)
     store.transaction true do
-      rates.each do |exchange_rate|
-        rate = BigDecimal(exchange_rate.attribute("rate").value, DECIMAL_PRECISION)
-        currency = exchange_rate.attribute("currency").value
-        date = exchange_rate.parent.attribute("time").value
-        set_rate("EUR", currency, rate, date)
-      end
+      copy_rates(rates_document, true)
     end
-
-    rates_updated_at = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube/@time').first.value
-    @historical_rates_updated_at = Time.parse(rates_updated_at)
-
+    @historical_rates_updated_at = rates_document.updated_at
     @historical_last_updated = Time.now
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eu_central_bank
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Shane Emmons
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -70,6 +70,7 @@ files:
 - LICENSE
 - README.md
 - lib/eu_central_bank.rb
+- lib/eu_central_bank/rates_document.rb
 - lib/money/rates_store/store_with_historical_data_support.rb
 homepage: https://github.com/RubyMoney/eu_central_bank
 licenses:
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Calculates exchange rates based on rates from european central bank. Money