ecb-currency_converter 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ecb-currency_converter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael J. Sepcot
+
+MIT License
+
+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,43 @@
+# ECB::CurrencyConverter
+
+Currency Conversion using the European Central Bank's Euro foreign exchange reference rates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ecb-currency_converter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ecb-currency_converter
+
+## Usage
+
+To convert between two currencies:
+
+    ECB::CurrencyConverter.exchange(100, 'EUR', 'USD')
+    => 133.73999999999998
+
+    ECB::CurrencyConverter.exchange(100, 'USD', 'EUR')
+    => 74.77194556602363
+
+To get the most recent exchange rate between two currencies:
+
+    ECB::CurrencyConverter.rate('EUR', 'USD')
+    => 1.3374
+
+    ECB::CurrencyConverter.rate('USD', 'EUR')
+    => 0.7477194556602363
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/ecb-currency_converter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ecb/currency_converter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ecb-currency_converter'
+  spec.version       = ECB::CurrencyConverter::VERSION
+  spec.authors       = ['Michael J. Sepcot']
+  spec.email         = ['developer@sepcot.com']
+  spec.description   = %q{Currency Conversion using the European Central Bank's Euro foreign exchange reference rates.}
+  spec.summary       = %q{Currency Conversion using the European Central Bank's Euro foreign exchange reference rates.}
+  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 'fakeweb'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'httparty', '~> 0.11.0'
+end

data/lib/ecb/currency_converter/exceptions.rb

@@ -0,0 +1,23 @@
+module ECB # :nodoc:
+  # = ECB Unknown Currency Error
+  #
+  # Raised when we try to grab data for an unsupported currency code.
+  #
+  # * +currency_code+ - the unsupported ISO 4217 Currency Code.
+  class UnknownCurrencyError < StandardError
+    def initialize(currency_code)
+      super("#{currency_code} is not supported.")
+    end
+  end
+
+  # = ECB Missing Exchange Rate Error
+  #
+  # Raised when the data for a supported currency code is +nil+ or +zero?+.
+  #
+  # * +currency_code+ - the unsupported ISO 4217 Currency Code.
+  class MissingExchangeRateError < StandardError
+    def initialize(currency_code)
+      super("Foreign exchange reference rate for #{currency_code} is missing.")
+    end
+  end
+end

data/lib/ecb/currency_converter/version.rb

@@ -0,0 +1,5 @@
+module ECB # :nodoc:
+  module CurrencyConverter # :nodoc:
+    VERSION = '0.1.0'
+  end
+end

data/lib/ecb/currency_converter.rb

@@ -0,0 +1,107 @@
+require 'ecb/currency_converter/exceptions'
+require 'ecb/currency_converter/version'
+require 'httparty'
+
+module ECB # :nodoc:
+  # = European Central Bank - Currency Converter
+  #
+  # Convert values or find the most recent foreign exchange reference rate
+  # between any of the +CURRENCIES+ supported by the European Central Bank.
+  #
+  # An overview of the latest Euro foreign exchange reference rates is
+  # avaliable at:
+  #
+  #   http://www.ecb.int/stats/exchange/eurofxref/html/index.en.html
+  #
+  module CurrencyConverter
+    DAILY_URI = 'http://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml'
+    CURRENCIES = [
+      'AUD', # Australian Dollar (A$)
+      'BGN', # Bulgarian Lev (BGN)
+      'BRL', # Brazilian Real (R$)
+      'CAD', # Canadian Dollar (CA$)
+      'CHF', # Swiss Franc (CHF)
+      'CNY', # Chinese Yuan (CN¥)
+      'CZK', # Czech Republic Koruna (CZK)
+      'DKK', # Danish Krone (DKK)
+      'EUR', # Euro (€)
+      'GBP', # British Pound Sterling (£)
+      'HKD', # Hong Kong Dollar (HK$)
+      'HRK', # Croatian Kuna (HRK)
+      'HUF', # Hungarian Forint (HUF)
+      'IDR', # Indonesian Rupiah (IDR)
+      'ILS', # Israeli New Sheqel (₪)
+      'INR', # Indian Rupee (Rs.)
+      'JPY', # Japanese Yen (¥)
+      'KRW', # South Korean Won (₩)
+      'LTL', # Lithuanian Litas (LTL)
+      'LVL', # Latvian Lats (LVL)
+      'MXN', # Mexican Peso (MX$)
+      'MYR', # Malaysian Ringgit (MYR)
+      'NOK', # Norwegian Krone (NOK)
+      'NZD', # New Zealand Dollar (NZ$)
+      'PHP', # Philippine Peso (Php)
+      'PLN', # Polish Zloty (PLN)
+      'RON', # Romanian Leu (RON)
+      'RUB', # Russian Ruble (RUB)
+      'SEK', # Swedish Krona (SEK)
+      'SGD', # Singapore Dollar (SGD)
+      'THB', # Thai Baht (฿)
+      'TRY', # Turkish Lira (TRY)
+      'USD', # US Dollar ($)
+      'ZAR', # South African Rand (ZAR)
+    ]
+
+    class << self # Class methods
+      # Converts the +value+ between +from+ and +to+ currencies.
+      #
+      # = Example
+      #
+      #   ECB::CurrencyConverter.exchange(100, 'EUR', 'USD')
+      #   => 133.73999999999998
+      #
+      #   ECB::CurrencyConverter.exchange(100, 'USD', 'EUR')
+      #   => 74.77194556602363
+      def exchange(value, from, to)
+        value * rate(from, to)
+      end
+
+      # Return the exchange rate between +from+ and +to+ currencies.
+      #
+      # = Example
+      #
+      #   ECB::CurrencyConverter.rate('EUR', 'USD')
+      #   => 1.3374
+      #
+      #   ECB::CurrencyConverter.rate('USD', 'EUR')
+      #   => 0.7477194556602363
+      def rate(from, to)
+        load_data!
+        validate(from, to)
+
+        1.0 / @euro[from] * @euro[to]
+      end
+    private
+      # Load data from European Central Bank's daily XML feed.
+      def load_data!
+        @euro ||= begin
+          response = HTTParty.get(DAILY_URI, format: :xml)
+
+          data = response['Envelope']['Cube']['Cube']['Cube']
+          data = data.reduce({}) { |a,e| a[e['currency']] = e['rate'].to_f; a }
+          data['EUR'] = 1.0
+          data
+        end
+      end
+
+      # Raise errors for invalid currencies or missing data.
+      def validate(from, to)
+        raise UnknownCurrencyError.new(from)  unless CURRENCIES.include?(from)
+        raise UnknownCurrencyError.new(to)    unless CURRENCIES.include?(to)
+
+        raise MissingExchangeRateError.new(from)  if @euro[from].to_f.zero?
+        raise MissingExchangeRateError.new(to)    if @euro[to].to_f.zero?
+      end
+    end
+  end
+end

data/spec/ecb/currency_converter_spec.rb

@@ -0,0 +1,139 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+def rate_comparison(from, to, actual)
+  ECB::CurrencyConverter.rate(from, to).should be_within(0.0001).of(actual)
+end
+
+def exchange_comparison(amount, from, to, actual)
+  ECB::CurrencyConverter.exchange(amount, from, to).should(
+    be_within(0.0001).of(actual)
+  )
+end
+
+describe ECB::CurrencyConverter do
+  describe '#exchange' do
+    it 'should convert between currencies through the EUR' do
+      [ ['AUD', 'LTL', 244.34222], ['BGN', 'LVL',  35.87278],
+        ['BRL', 'MXN', 591.82960], ['CAD', 'MYR', 309.46094],
+        ['CHF', 'NOK', 624.72594], ['CNY', 'NZD',  20.44337],
+        ['CZK', 'PHP', 225.03894], ['DKK', 'PLN',  57.04671],
+        ['EUR', 'KRW', 151703.00], ['GBP', 'RON', 525.55477],
+        ['HKD', 'RUB', 413.00283], ['HRK', 'SEK', 115.89472],
+        ['HUF', 'SGD',   0.57404], ['IDR', 'THB',   0.31147],
+        ['ILS', 'TRY',  52.38214], ['INR', 'USD',   1.70152],
+        ['JPY', 'ZAR',  10.51728],
+      ].each do |from, to, actual|
+        exchange_comparison(100, from, to, actual)
+      end
+    end
+  end
+
+  describe '#rate' do
+    it 'should match the provided rates when converting from EUR' do
+      [ ['AUD', 1.4131],   ['BGN', 1.9558],  ['BRL', 2.9203],
+        ['CAD', 1.3635],   ['CHF', 1.2315],  ['CNY', 8.1963],
+        ['CZK', 25.680],   ['DKK', 7.4595],  ['GBP', 0.85620],
+        ['HKD', 10.3762],  ['HRK', 7.4855],  ['HUF', 293.62],
+        ['IDR', 13246.45], ['ILS', 4.8045],  ['INR', 78.6000],
+        ['JPY', 127.55],   ['KRW', 1517.03], ['LTL', 3.4528],
+        ['LVL', 0.7016],   ['MXN', 17.2832], ['MYR', 4.2195],
+        ['NOK', 7.6935],   ['NZD', 1.6756],  ['PHP', 57.790],
+        ['PLN', 4.2554],   ['RON', 4.4998],  ['RUB', 42.8540],
+        ['SEK', 8.6753],   ['SGD', 1.6855],  ['THB', 41.259],
+        ['TRY', 2.5167],   ['USD', 1.3374],  ['ZAR', 13.4148]
+      ].each do |currency, value|
+        rate_comparison('EUR', currency, value)
+      end
+    end
+
+    it 'should match the inverted rates when converting to EUR' do
+      [ ['AUD', 1.4131],   ['BGN', 1.9558],  ['BRL', 2.9203],
+        ['CAD', 1.3635],   ['CHF', 1.2315],  ['CNY', 8.1963],
+        ['CZK', 25.680],   ['DKK', 7.4595],  ['GBP', 0.85620],
+        ['HKD', 10.3762],  ['HRK', 7.4855],  ['HUF', 293.62],
+        ['IDR', 13246.45], ['ILS', 4.8045],  ['INR', 78.6000],
+        ['JPY', 127.55],   ['KRW', 1517.03], ['LTL', 3.4528],
+        ['LVL', 0.7016],   ['MXN', 17.2832], ['MYR', 4.2195],
+        ['NOK', 7.6935],   ['NZD', 1.6756],  ['PHP', 57.790],
+        ['PLN', 4.2554],   ['RON', 4.4998],  ['RUB', 42.8540],
+        ['SEK', 8.6753],   ['SGD', 1.6855],  ['THB', 41.259],
+        ['TRY', 2.5167],   ['USD', 1.3374],  ['ZAR', 13.4148]
+      ].each do |currency, value|
+        rate_comparison(currency, 'EUR', 1.0 / value)
+      end
+    end
+
+    it 'should report a rate of 1.0 between the same currency' do
+      rate_comparison('KRW', 'KRW', 1.0)
+    end
+
+    it 'should convert rates between currencies through the EUR' do
+      [ ['AUD', 'LTL', 2.44342], ['BGN', 'LVL', 0.35872],
+        ['BRL', 'MXN', 5.91829], ['CAD', 'MYR', 3.09460],
+        ['CHF', 'NOK', 6.24725], ['CNY', 'NZD', 0.20443],
+        ['CZK', 'PHP', 2.25038], ['DKK', 'PLN', 0.57046],
+        ['GBP', 'RON', 5.25554], ['HKD', 'RUB', 4.13002],
+        ['HRK', 'SEK', 1.15894], ['HUF', 'SGD', 0.00574],
+        ['IDR', 'THB', 0.00311], ['ILS', 'TRY', 0.52382],
+        ['INR', 'USD', 0.01701], ['JPY', 'ZAR', 0.10517],
+      ].each do |from, to, value|
+        rate_comparison(from, to, value)
+      end
+    end
+
+    describe '#validate' do
+      describe ECB::UnknownCurrencyError do
+        it 'should raise an error on an unsupported currency code' do
+          expect {
+            ECB::CurrencyConverter.exchange(100, 'USD', 'UNKNOWN')
+          }.to raise_error(ECB::UnknownCurrencyError)
+
+          expect {
+            ECB::CurrencyConverter.exchange(100, 'UNKNOWN', 'USD')
+          }.to raise_error(ECB::UnknownCurrencyError)
+        end
+
+        it 'should not raise an error for supported currency codes' do
+          expect {
+            ECB::CurrencyConverter.exchange(100, 'EUR', 'USD')
+          }.to_not raise_error(ECB::UnknownCurrencyError)
+        end
+      end
+
+      describe ECB::MissingExchangeRateError do
+        before do
+          ECB::CurrencyConverter.send(:load_data!)
+
+          euro = ECB::CurrencyConverter.instance_variable_get(:@euro)
+          euro['USD'] = nil
+
+          ECB::CurrencyConverter.instance_variable_set(:@euro, euro)
+        end
+
+        after do
+          ECB::CurrencyConverter.instance_variable_set(:@euro, nil)
+        end
+
+        it 'should raise an error if supported data is missing' do
+          expect {
+            ECB::CurrencyConverter.exchange(100, 'EUR', 'USD')
+          }.to raise_error(ECB::MissingExchangeRateError)
+
+          expect {
+            ECB::CurrencyConverter.exchange(100, 'USD', 'EUR')
+          }.to raise_error(ECB::MissingExchangeRateError)
+        end
+
+        it 'should not raise an error if we have data available' do
+          expect {
+            ECB::CurrencyConverter.exchange(100, 'EUR', 'GBP')
+          }.to_not raise_error(ECB::MissingExchangeRateError)
+
+          expect {
+            ECB::CurrencyConverter.exchange(100, 'GBP', 'EUR')
+          }.to_not raise_error(ECB::MissingExchangeRateError)
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/eurofxref-daily.xml

@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<gesmes:Envelope xmlns:gesmes="http://www.gesmes.org/xml/2002-08-01" xmlns="http://www.ecb.int/vocabulary/2002-08-01/eurofxref">
+  <gesmes:subject>Reference rates</gesmes:subject>
+  <gesmes:Sender>
+    <gesmes:name>European Central Bank</gesmes:name>
+  </gesmes:Sender>
+  <Cube>
+    <Cube time="2013-06-18">
+      <Cube currency="USD" rate="1.3374"/>
+      <Cube currency="JPY" rate="127.55"/>
+      <Cube currency="BGN" rate="1.9558"/>
+      <Cube currency="CZK" rate="25.680"/>
+      <Cube currency="DKK" rate="7.4595"/>
+      <Cube currency="GBP" rate="0.85620"/>
+      <Cube currency="HUF" rate="293.62"/>
+      <Cube currency="LTL" rate="3.4528"/>
+      <Cube currency="LVL" rate="0.7016"/>
+      <Cube currency="PLN" rate="4.2554"/>
+      <Cube currency="RON" rate="4.4998"/>
+      <Cube currency="SEK" rate="8.6753"/>
+      <Cube currency="CHF" rate="1.2315"/>
+      <Cube currency="NOK" rate="7.6935"/>
+      <Cube currency="HRK" rate="7.4855"/>
+      <Cube currency="RUB" rate="42.8540"/>
+      <Cube currency="TRY" rate="2.5167"/>
+      <Cube currency="AUD" rate="1.4131"/>
+      <Cube currency="BRL" rate="2.9203"/>
+      <Cube currency="CAD" rate="1.3635"/>
+      <Cube currency="CNY" rate="8.1963"/>
+      <Cube currency="HKD" rate="10.3762"/>
+      <Cube currency="IDR" rate="13246.45"/>
+      <Cube currency="ILS" rate="4.8045"/>
+      <Cube currency="INR" rate="78.6000"/>
+      <Cube currency="KRW" rate="1517.03"/>
+      <Cube currency="MXN" rate="17.2832"/>
+      <Cube currency="MYR" rate="4.2195"/>
+      <Cube currency="NZD" rate="1.6756"/>
+      <Cube currency="PHP" rate="57.790"/>
+      <Cube currency="SGD" rate="1.6855"/>
+      <Cube currency="THB" rate="41.259"/>
+      <Cube currency="ZAR" rate="13.4148"/>
+    </Cube>
+  </Cube>
+</gesmes:Envelope>

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'ecb/currency_converter'
+require 'fakeweb'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    FakeWeb.allow_net_connect = false
+
+    xml = File.read(File.expand_path(
+      File.join(File.dirname(__FILE__), 'fixtures', 'eurofxref-daily.xml')
+    ))
+    FakeWeb.register_uri(:get, ECB::CurrencyConverter::DAILY_URI, body: xml)
+  end
+
+  config.after(:suite) do
+    FakeWeb.allow_net_connect = true
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: ecb-currency_converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael J. Sepcot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: Currency Conversion using the European Central Bank's Euro foreign exchange
+  reference rates.
+email:
+- developer@sepcot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ecb-currency_converter.gemspec
+- lib/ecb/currency_converter.rb
+- lib/ecb/currency_converter/exceptions.rb
+- lib/ecb/currency_converter/version.rb
+- spec/ecb/currency_converter_spec.rb
+- spec/fixtures/eurofxref-daily.xml
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Currency Conversion using the European Central Bank's Euro foreign exchange
+  reference rates.
+test_files:
+- spec/ecb/currency_converter_spec.rb
+- spec/fixtures/eurofxref-daily.xml
+- spec/spec_helper.rb