riksbank_currency 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9cb06cc185f232c081fab9056bf2332c9ded9fb
+  data.tar.gz: 36ae9d4767b38845cc27aa9e244892c64a47ceda
+SHA512:
+  metadata.gz: b4fb912717f93c4176b426793ac97c9e4595b6d595f9d2ead159ca9efa91ade61fcbca2a2d6f293df78b0daf723f5df5528f57f7374f44760cf037be15748a53
+  data.tar.gz: 46aba20322e6226a4802f8c0026b6cfc8495b316b29fdc7095d5a0edd1d84bb42f1a8e23da7b5d79c6e82520d46804ff9b75e88fbfa4f075de2753ef226e8c3d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# RVM
+.ruby-gemset
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in riksbank_currency.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    riksbank_currency (0.1.0)
+      nokogiri (~> 1.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  riksbank_currency!
+  rspec (~> 3.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrey Yakovlev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,122 @@
+# Riksbank Exchange Rates
+
+Simple wrapper for Riksbank API that returns currency exchange rates for the specific date.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'riksbank_currency'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install riksbank_currency
+
+## Usage
+
+### Initialize
+
+```ruby
+  bank = RiksbankCurrency::Rates.new(date: Date.yesterday, base: 'USD')
+```
+
+Initializer options:
+
+  * `date` - the day for which we want to get exchange rates. It should be `Date` object 
+  * `base` - base currency (by default `SEK`)
+  * `rates` - you can pass your own hash with rates. Can be useful for caching purposes
+
+
+### Retrieve a specific rate
+
+```ruby
+  # how many euros in one american dollar?
+  bank.rate('USD', 'EUR').to_f # => 0.80607
+  
+  # by default it converts to SEK
+  bank.rate('USD').to_f # => 7.913
+```
+
+Get all available currencies:
+
+```ruby
+  bank.currencies # => ['AUD', 'BRL', 'CAD', 'CHF', 'CNY', 'CZK', 'DKK', 'EUR'...]
+```
+
+Get all rates
+
+```ruby
+  bank.rates # => { 'NOK' => 105.556298, 'INR' => 13.619511, … }
+```
+
+### Bank days and holidays
+
+During the holidays or weekends bank doesn't change exchange rates. It means that
+bank doesn't have exchange rates for Saturday or Christmas.
+
+Also, another problem in the current day. Bank refreshes rates twice per day (morning and evening).
+So, therefore at 3 o'clock of morning bank doensn't have fresh rates and we should use
+rates from prevoius day.
+
+This gem deals with all of this problems:
+
+```ruby
+  # 20.01.2018 is Saturday, bank doesn't work at this day
+  holiday_bank = RiksbankCurrency::Rates.new(date: Date.new(2018, 1, 20))
+  
+  # rates will be got from Friday!
+  holiday_bank.rate_date # Fri, 19 Jan 2018
+  
+  
+  
+  
+  # imagine that we do it at night
+  # Time.current => Fri, 26 Jan 2018 03:00:00 UTC +00:00 
+  morning_bank = RiksbankCurrency::Rates.new
+  
+  # it is too early, bank doensn't work at this time
+  # let's use yesterday rates 
+  morning_bank.rate_date # Thu, 25 Jan 2018
+```
+
+### Available currencies
+
+Pay attention to check available currencies at [official bank page](http://www.riksbank.se/en/Interest-and-exchange-rates/Series-for-web-services/).
+
+By default this gem uses only existing currencies for 2018. For example, FIM (Finland Marka)
+has rates only till 2002 and it doesn't exist anymore in 2018.
+
+So, if you wanna get information about FIM exchange rate in 2001 you should 
+change the gem defaults:
+
+```ruby
+  RiksbankCurrency.currencies << 'FIM'
+  
+  old_bank = RiksbankCurrency::Rates.new(date: Date.new(2001, 1, 16))
+  old_bank.rate('FIM').to_f # 1.495527
+  
+  today_bank = RiksbankCurrency::Rates.new
+  today_bank.rate('FIM') # nil
+```
+
+#### Default currencies
+
+```ruby
+%w(AUD BRL CAD CHF CNY CZK DKK EUR GBP HKD HUF IDR INR ISK JPY
+   KRW MAD MXN NOK NZD PLN RUB SAR SGD THB TRY USD ZAR)
+```
+
+## Legal
+
+The author of this gem is not affiliated with the Riksbank.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/riksbank_currency/business_day.rb

@@ -0,0 +1,33 @@
+require 'nokogiri'
+
+module RiksbankCurrency
+  module BusinessDay
+    module_function
+
+    def get_latest(date)
+      template = <<-XML
+          <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsd="http://swea.riksbank.se/xsd">
+          <soap:Header/>
+            <soap:Body>
+              <xsd:getCalendarDays>
+                <datefrom>#{Helper.format_date(date.prev_month)}</datefrom>
+                <dateto>#{Helper.format_date(date)}</dateto>
+              </xsd:getCalendarDays>
+            </soap:Body>
+          </soap:Envelope>
+      XML
+
+      date = nil
+
+      Request.call(template).xpath('//return').reverse_each do |block|
+        bankday = block.at_xpath('bankday').content == 'Y'
+        next unless bankday
+
+        date = Helper.parse_date(block.at_xpath('caldate').content)
+        break
+      end
+
+      date
+    end
+  end
+end

data/lib/riksbank_currency/fetcher/date_fetcher.rb

@@ -0,0 +1,81 @@
+module RiksbankCurrency
+  # Get historical rates by date.
+  #
+  # @see https://swea.riksbank.se/sweaWS/docs/api/call/getInterestAndExchangeRates.htm
+  #
+  # IMPORTANT! The date should be less than current date. To get rates for today
+  # see at TodayFetcher
+  class DateFetcher
+    def initialize(date)
+      @date = date
+    end
+
+    def rate_date
+      @rate_date ||= BusinessDay.get_latest(@date)
+    end
+
+    def to_hash
+      rates = {}
+
+      response.xpath("//series").each do |series|
+        currency = Helper.currency_from_seriesid(series.at_xpath('seriesid').content)
+
+        if (rate = series.at_xpath('resultrows/value').content).length > 0
+          unit = BigDecimal(series.at_xpath('unit').content)
+          rate = BigDecimal(rate)
+
+          rates[currency] = rate / unit
+        else
+          next
+        end
+      end
+
+      rates
+    end
+
+    def response
+      @response ||= Request.call(xml_template)
+    end
+
+    protected
+
+    def groups
+      RiksbankCurrency.currencies.map do |currency|
+        group(currency)
+      end.join('')
+    end
+
+    def group(currency)
+      <<-XML
+        <searchGroupSeries>
+          <groupid>130</groupid>
+          <seriesid>#{Helper.currency_to_seriesid(currency)}</seriesid>
+        </searchGroupSeries>
+      XML
+    end
+
+    def xml_template
+      formatted_date = Helper.format_date(rate_date)
+      <<-XML
+      <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsd="http://swea.riksbank.se/xsd">
+        <soap:Header/>
+        <soap:Body>
+          <xsd:getInterestAndExchangeRates>
+            <searchRequestParameters>
+              <aggregateMethod>D</aggregateMethod>
+              <avg>false</avg>
+              <datefrom>#{formatted_date}</datefrom>
+              <dateto>#{formatted_date}</dateto>
+              <languageid>en</languageid>
+              <max>true</max>
+              <min>false</min>
+              #{groups}
+              <ultimo>false</ultimo>
+            </searchRequestParameters>
+          </xsd:getInterestAndExchangeRates>   
+        </soap:Body>
+      </soap:Envelope>
+      XML
+    end
+  end
+end

data/lib/riksbank_currency/fetcher/today_fetcher.rb

@@ -0,0 +1,61 @@
+module RiksbankCurrency
+  # Get the latest rates that will be correct for the current day.
+  #
+  # @see https://swea.riksbank.se/sweaWS/docs/api/call/getLatestInterestAndExchangeRates.htm
+  class TodayFetcher
+    def rate_date
+      @rate_date ||=
+        begin
+          response.xpath("//resultrows/date").map do |date_node|
+            Helper.parse_date(date_node.content)
+          end.max
+        end
+    end
+
+    def to_hash
+      rates = {}
+
+      response.xpath("//series").each do |series|
+        currency = Helper.currency_from_seriesid(series.at_xpath('seriesid').content)
+
+        if (rate = series.at_xpath('resultrows/value').content).length > 0
+          unit = BigDecimal(series.at_xpath('unit').content)
+          rate = BigDecimal(rate)
+
+          rates[currency] = rate / unit
+        else
+          next
+        end
+      end
+
+      rates
+    end
+
+    def response
+      @response ||= Request.call(xml_template)
+    end
+
+    protected
+
+    def series
+      RiksbankCurrency.currencies.map do |currency|
+        id = Helper.currency_to_seriesid(currency)
+        "<seriesid>#{id}</seriesid>"
+      end.join('')
+    end
+
+    def xml_template
+      <<-XML
+      <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsd="http://swea.riksbank.se/xsd">
+        <soap:Header/>
+        <soap:Body>
+          <xsd:getLatestInterestAndExchangeRates>
+            <languageid>en</languageid>
+            #{series}
+          </xsd:getLatestInterestAndExchangeRates>   
+        </soap:Body>
+      </soap:Envelope>
+      XML
+    end
+  end
+end

data/lib/riksbank_currency/fetcher.rb

@@ -0,0 +1,60 @@
+require 'nokogiri'
+require 'date'
+
+module RiksbankCurrency
+  class Fetcher
+    # @param [Date] date
+    # @param [String] base currency
+    def initialize(date, base)
+      @date = date
+      @base = base.to_s
+    end
+
+    # Convert XML response to Hash and recalculate it by @base currency
+    # Example:
+    #   {
+    #     "EUR": 9.021,
+    #     "USD": 7.65
+    #   }
+    # @return [Hash]
+    def to_hash
+      rates = fetcher.to_hash
+      rates['SEK'] = 1.0
+      recombine_by_base(rates)
+    end
+
+    # Define correct rate fetcher
+    # @return [TodayFetcher,DateFetcher]
+    def fetcher
+      @fetcher ||=
+        if @date == Date.today
+          TodayFetcher.new
+        else
+          DateFetcher.new(@date)
+        end
+    end
+
+    # @return [Date]
+    def rate_date
+      fetcher.rate_date
+    end
+
+    protected
+
+    def recombine_by_base(rates)
+      if @base != 'SEK'
+        new_rates = {}
+
+        rates.each do |currency, value|
+          new_rates[currency] = rates[@base] / value
+        end
+
+        rates = new_rates
+      end
+
+      rates[@base] = 1.0
+
+      rates
+    end
+  end
+end

data/lib/riksbank_currency/helper.rb

@@ -0,0 +1,36 @@
+module RiksbankCurrency
+  module Helper
+    module_function
+
+    # Extract currency ISO name from Riksbank series name
+    # Example: SEKEURPMI => EUR
+    #
+    # @see http://www.riksbank.se/en/Interest-and-exchange-rates/Series-for-web-services/
+    #
+    # @param [String] Riksbank SeriesId
+    def currency_from_seriesid(seriesid)
+      unless (matches = seriesid.match(/SEK(\w+)PMI/)).nil?
+        matches[1]
+      end
+    end
+
+    # Generate series name for specific currency
+    # @param [String] currency ISO name
+    def currency_to_seriesid(currency)
+      "SEK#{currency.upcase}PMI"
+    end
+
+    # Converts date to the bank format
+    # @param [Date] date
+    def format_date(date)
+      date.strftime("%Y-%m-%d")
+    end
+
+    # Parse date from bank format
+    # @param [String] date string in format "YYYY-MM-DD"
+    # @return [Date]
+    def parse_date(string_date)
+      Date.new(*string_date.split('-').map(&:to_i))
+    end
+  end
+end

data/lib/riksbank_currency/rates.rb

@@ -0,0 +1,51 @@
+require 'date'
+
+module RiksbankCurrency
+  class Rates
+    def initialize(**options)
+      @date = options[:date] || Date.today
+      @base = options[:base] || 'SEK'
+
+      # it is possible to pass cached rates to initializer to avoid extra http calls
+      unless options[:rates].nil?
+        @rates     = options[:rates]
+        @rate_date = @date
+      end
+    end
+
+    # @return [RiksbankCurreny::Fetcher]
+    def fetcher
+      @fetcher ||= Fetcher.new(@date, @base)
+    end
+
+    def rate(from, to = @base)
+      return nil if rates[from].nil? || rates[to].nil?
+      rates[from] / rates[to]
+    end
+
+    # Hash with all available currencies
+    # {
+    #   "EUR": 9.021,
+    #   "USD": 7.211
+    # }
+    # @return [Hash]
+    def rates
+      @rates ||= fetcher.to_hash
+    end
+
+    # Sometimes date passed to the initializer differs from real exchange date.
+    # It causes from holidays, weekends and etc.
+    #
+    # For example, if we want to get rates for the `1st of January 2018` then rate date
+    # will be `27th of December 2017`
+    # @return [Date]
+    def rate_date
+      @rate_date ||= fetcher.rate_date
+    end
+
+    # @return [Array]
+    def currencies
+      rates.keys
+    end
+  end
+end

data/lib/riksbank_currency/request.rb

@@ -0,0 +1,24 @@
+require 'uri'
+require 'net/http'
+require 'nokogiri'
+
+module RiksbankCurrency
+  module Request
+    module_function
+
+    ENDPOINT = "http://swea.riksbank.se/sweaWS/services/SweaWebServiceHttpSoap12Endpoint"
+
+    # @param [String] xml_body
+    # @return [Nokogiri::XML::Document]
+    def call(xml_body)
+      uri = URI.parse(ENDPOINT)
+
+      request = Net::HTTP::Post.new(uri.path)
+      request.body = xml_body
+      request.content_type = 'text/xml'
+
+      response = Net::HTTP.new(uri.host, uri.port).start { |http| http.request request }
+      Nokogiri::XML(response.body)
+    end
+  end
+end

data/lib/riksbank_currency/version.rb

@@ -0,0 +1,3 @@
+module RiksbankCurrency
+  VERSION = "0.1.1"
+end

data/lib/riksbank_currency.rb

@@ -0,0 +1,26 @@
+require 'bigdecimal'
+require 'bigdecimal/util'
+require 'uri'
+
+require 'riksbank_currency/helper'
+require 'riksbank_currency/business_day'
+require 'riksbank_currency/fetcher'
+require 'riksbank_currency/fetcher/date_fetcher'
+require 'riksbank_currency/fetcher/today_fetcher'
+require 'riksbank_currency/rates'
+require 'riksbank_currency/request'
+require 'riksbank_currency/version'
+
+module RiksbankCurrency
+  # list of available currencies in 2018
+  @@currencies = %w(AUD BRL CAD CHF CNY CZK DKK EUR GBP HKD HUF IDR INR ISK JPY
+                    KRW MAD MXN NOK NZD PLN RUB SAR SGD THB TRY USD ZAR)
+
+  def self.currencies
+    @@currencies
+  end
+
+  def self.currencies=(val)
+    @@currencies = val
+  end
+end

data/riksbank_currency.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "riksbank_currency/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "riksbank_currency"
+  spec.version       = RiksbankCurrency::VERSION
+  spec.authors       = ["Andrey Yakovlev"]
+  spec.email         = ["sigra.yandex@gmail.com"]
+
+  spec.summary       = "Retrieves exchange rates from the Riksbank Sweden"
+  spec.homepage      = "https://github.com/sigra/riksbank-currency"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: riksbank_currency
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Andrey Yakovlev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email:
+- sigra.yandex@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/riksbank_currency.rb
+- lib/riksbank_currency/business_day.rb
+- lib/riksbank_currency/fetcher.rb
+- lib/riksbank_currency/fetcher/date_fetcher.rb
+- lib/riksbank_currency/fetcher/today_fetcher.rb
+- lib/riksbank_currency/helper.rb
+- lib/riksbank_currency/rates.rb
+- lib/riksbank_currency/request.rb
+- lib/riksbank_currency/version.rb
+- riksbank_currency.gemspec
+homepage: https://github.com/sigra/riksbank-currency
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Retrieves exchange rates from the Riksbank Sweden
+test_files: []