Giter Site home page Giter Site logo

todddickerson / eu_central_bank Goto Github PK

View Code? Open in Web Editor NEW

This project forked from rubymoney/eu_central_bank

0.0 0.0 0.0 197 KB

A gem that calculates the exchange rate using published rates from European Central Bank. Compatible with the money gem

License: MIT License

Ruby 100.00%

eu_central_bank's Introduction

eu_central_bank

Build Status

Introduction

This gem downloads the exchange rates from the European Central Bank. You can calculate exchange rates with it. It is compatible with the money gem.

Installation

gem install eu_central_bank

In case you're using older ruby (< 2.1) you need nokogiri < 1.6.8, so add this to your Gemfile:

gem 'nokogiri', '1.6.8'

Dependencies

  • nokogiri
  • money

Usage

With the gem, you do not need to manually add exchange rates. Calling update_rates will download the rates from the European Central Bank. The API is the same as the money gem. Feel free to use Money objects with the bank.

require 'eu_central_bank'
eu_bank = EuCentralBank.new
Money.default_bank = eu_bank
money1 = Money.new(10)
money1.bank # eu_bank

# call this before calculating exchange rates
# this will download the rates from ECB
eu_bank.update_rates

# exchange 100 CAD to USD
# API is the same as the money gem
eu_bank.exchange(100, "CAD", "USD") # Money.new(80, "USD")
Money.us_dollar(100).exchange_to("CAD")  # Money.new(124, "CAD")

# using the new exchange_with method
eu_bank.exchange_with(Money.new(100, "CAD"), "USD") # Money.new(80, "USD")

For performance reasons, you may prefer to read from a file instead. Furthermore, ECB publishes their rates daily. It makes sense to save the rates in a file to read from. It also adds an updated_at field so that you can manage the update.

# cached location
cache = "/some/file/location/exchange_rates.xml"

# saves the rates in a specified location
eu_bank.save_rates(cache)

# reads the rates from the specified location
eu_bank.update_rates(cache)

if !eu_bank.rates_updated_at || eu_bank.rates_updated_at < Time.now - 1.days
  eu_bank.save_rates(cache)
  eu_bank.update_rates(cache)
end

# exchange 100 CAD to USD as usual
eu_bank.exchange_with(Money.new(100, "CAD"), "USD") # Money.new(80, "USD")

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

Copyright

Copyright (c) 2010-2016 RubyMoney. See LICENSE for details.

eu_central_bank's People

Contributors

ahukkanen avatar alto avatar antstorm avatar bak1an avatar boone avatar ej2015 avatar fedorn avatar flop avatar holek avatar ilake avatar joshuapinter avatar kevthedev avatar kriskhaira avatar laurens avatar liangzan avatar lomefin avatar maltoe avatar mcls avatar mgadikota-rpx avatar overloadedargs avatar pabse avatar prognostikos avatar richardvenneman avatar saurabhnanda avatar semmons99 avatar suciuvlad avatar taki avatar timdiggins avatar todddickerson avatar zachaysan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.