Coder Social home page Coder Social logo

funkyloverone / nbu_currency Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 156 KB

A gem that calculates the exchange rate using published rates from National Bank of Ukraine. Compatible with the money gem

License: MIT License

Ruby 98.98% Shell 1.02%

nbu_currency's Introduction

nbu_currency

Introduction

This gem downloads the exchange rates from the National Bank Of Ukraine. You can calculate exchange rates with it. It is compatible with the money gem.

Installation

Add this line to your application's Gemfile:

gem 'nbu_currency'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nbu_currency

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 National Bank Of Ukraine. The API is the same as the money gem. Feel free to use Money objects with the bank.

For performance reasons, you may prefer to read from a file instead. Furthermore, NBU publishes their rates daily. It makes sense to save the rates in a file to read from. It also adds an update_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
nbu_bank.save_rates(cache)

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

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

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

Development

After checking out the repo, run bin/setup to install dependencies. Then, 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 version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/FunkyloverOne/nbu_currency/fork )
  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 a new Pull Request

nbu_currency's People

Contributors

funkyloverone avatar

Watchers

 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.