rk_fx_rates 0.0.1

data/lib/rk_fx_rates/provider/ecb.rb

@@ -0,0 +1,26 @@
+module RkFxRates
+  module Provider
+    class Ecb
+      
+      def self.data_url
+        return 'http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml'        
+      end
+
+      # see rk_fx_rates.rb for data structure description
+      def self.generate_fx_hash(data)
+        fx_hash = Hash.new
+        fx_hash["downloaded_at"] = Date.today
+        
+        data["Envelope"]["Cube"]["Cube"].each do |daily|
+          date = Chronic.parse( daily["time"] ).to_date
+          fx_hash[date] = Hash.new
+          daily["Cube"].each do |currency|
+            fx_hash[date] [currency["currency"]] = currency["rate"].to_f
+          end
+        end
+        return fx_hash
+      end
+
+    end # Ecb 
+  end # Provider
+end # RkFxRates 

data/lib/rk_fx_rates/version.rb

@@ -0,0 +1,3 @@
+module RkFxRates
+  VERSION = "0.0.1"
+end

data/lib/rk_fx_rates.rb

@@ -0,0 +1,73 @@
+require "rk_fx_rates/version"
+require 'rk_fx_rates/provider/ecb'
+
+require "httparty"
+require 'chronic'
+require 'yaml/store'
+require 'pry-remote'
+
+# To make sure the data from all source will be compatible, they are converted to a standardized data structure
+# {
+#   downloaded_at: "2013-11-27",
+#   data: {
+#     "2013-11-27" => {
+#       'USD' => 1.3547,
+#       'GBP' => 0.83830,
+#       ...
+#     },
+#     "2013-11-26" => ...
+#   }
+# }
+
+module RkFxRates
+  class ExchangeRate
+    include HTTParty
+
+  	def initialize(source = RkFxRates::Provider::Ecb)
+  		@source = source
+  	end
+
+    def retrieve
+      retrieve_latest unless File.exists?('exchange_rates.store')
+      fx_hash = YAML::load_file('exchange_rates.store')['rates']
+
+      fx_hash = retrieve_latest if fx_hash['downloaded_at'] < Chronic.parse('last weekday').to_date
+      return fx_hash
+    end
+  	
+  	def retrieve_latest
+      response = HTTParty.get(@source.data_url)
+      fx_hash = @source.generate_fx_hash(response.parsed_response)
+
+      # persist latest rates
+      store(fx_hash)
+      
+      return fx_hash
+    end
+
+    def at(date, from_currency, to_currency)
+      return to_euro(date, from_currency) * from_euro(date, to_currency)
+    end
+
+    private
+    	
+    def from_euro(date, to_currency)
+      return 1.0 if to_currency == 'EUR'
+      data = retrieve
+      rate = data[date][to_currency]
+    end
+
+    def to_euro(date, from_currency)
+      return 1.0 if from_currency == 'EUR'
+      data = retrieve
+      rate = 1.0 / data[date][from_currency]
+    end
+
+    def store(fx_hash)
+      store = YAML::Store.new("exchange_rates.store")
+      store.transaction do
+        store['rates'] = fx_hash        
+      end
+    end
+  end 
+end

data/rk_fx_rates.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rk_fx_rates/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rk_fx_rates"
+  spec.version       = RkFxRates::VERSION
+  spec.authors       = ["Rainer Kuhn"]
+  spec.email         = ["ticktricktrack@gmail.com"]
+  spec.description   = %q{Obtains foreign exchange rates}
+  spec.summary       = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "webmock"
+
+  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'chronic'
+  spec.add_runtime_dependency 'pry-remote'
+end

data/spec/lib/rk_fx_rates_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe RkFxRates do
+
+  before(:each) do
+    @fx_api = RkFxRates::ExchangeRate.new
+  end
+
+  it "should download the current exchange rates" do
+    @fx_api.retrieve_latest.should_not be nil
+  end
+
+  it "should display the download date" do
+    @fx_api.retrieve_latest["downloaded_at"].should == Date.today
+  end
+
+  # using the last monday to make sure the test runs with a weekday date
+  # simplified case with Euro as the start currency
+  it "should calcute the Exchange rate from EUR to USD" do
+    date = Chronic.parse('last monday').to_date
+    @fx_api.at( date, 'EUR', 'USD' ).should be > 1.2
+  end
+
+  it "should calculate the exchange rate from GBP to USD" do
+    date = Chronic.parse('last monday').to_date
+    @fx_api.at(date, 'GBP', 'USD').should be > 1.5
+  end
+
+  it "should calculate the exchange rate from EUR to EUR" do
+    date = Chronic.parse('last monday').to_date
+    @fx_api.at(date, 'EUR', 'EUR').should be == 1.0
+  end
+
+  context "with existing and current data" do
+    before(:each) do
+      @fx_api.retrieve_latest
+      WebMock.disable_net_connect!
+    end
+
+    it "should not download the data again" do
+      date = Chronic.parse('last monday').to_date
+      @fx_api.at(date, 'GBP', 'USD').should be > 1.5
+    end
+
+    after(:each) do
+      WebMock.allow_net_connect!
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rk_fx_rates.rb'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  WebMock.allow_net_connect!
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: rk_fx_rates
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rainer Kuhn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Obtains foreign exchange rates
+email:
+- ticktricktrack@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exchange_rates.store
+- lib/rk_fx_rates.rb
+- lib/rk_fx_rates/provider/ecb.rb
+- lib/rk_fx_rates/version.rb
+- rk_fx_rates.gemspec
+- spec/lib/rk_fx_rates_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.1.11
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/lib/rk_fx_rates_spec.rb
+- spec/spec_helper.rb