money-oxr

A Money-compatible rate store that uses exchange rates from openexchangerates.org.

A few improvements over the existing money-open-exchange-rates gem:

• Uses BigDecimal instead of Float for exchange rates.
• Automatically caches API results to file if a :cache_path option is provided.
• Automatically fetches new data from API if data becomes stale if a :max_age option is provided.

Add this line to your application's Gemfile:

gem 'money-oxr'

And then execute:

$ bundle

Or install it yourself as:

$ gem install money-oxr

With the gem, you do not need to manually add exchange rates. Calling load will load the rates from the cache file or download the rates from the API depending on your options.

require 'money_oxr/bank'
Money.default_bank = MoneyOXR::Bank.new(
  app_id: 'abcd1234',
  cache_path: 'config/oxr.json',
  max_age: 86400
)

If you only want to load data from a file without ever fetching from the API, the :app_id and :max_age options are not necessary.

require 'money_oxr/bank'
Money.default_bank = MoneyOXR::Bank.new(
  cache_path: 'config/oxr.json'
)

If you are on a paid plan from openexchangerates.org and you wish to use a different source currency, you may provide it with the :source option. The default is USD.

require 'money_oxr/bank'
Money.default_bank = MoneyOXR::Bank.new(
  app_id: 'abcd1234',
  cache_path: 'config/oxr.json',
  max_age: 86400,
  source: 'GBP'
)

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, update the version number in money-oxr.gemspec, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/edlebert/money-oxr.

The gem is available as open source under the terms of the MIT License.