nbu_currency 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eadde143ecc5055f47ac8df94bea1918e19da3c3
+  data.tar.gz: a713228111f3db6c4056a90c0dfe28249ffe3afd
+SHA512:
+  metadata.gz: 1ed4b1be1c9ac7d9c1b2244e7287df7a5b74534373b3c4c29d8bcbcf90f7ec0d0ca5fa888450a279a9fab9471ec7d748553291f19cdbe298a08e23be4ac9f4e0
+  data.tar.gz: 7bcf90befb632a92d0accbdedc3bf6450f0d21f2b48ffd5439d4b00bf199532f1502e9dfb1e083b942f6548be9d16a8dfb36e4050b5b5489e352d728b7f4db07

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nazar Matus
+
+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,65 @@
+# 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:
+
+```ruby
+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.
+
+``` ruby
+# 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](https://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

data/Rakefile

@@ -0,0 +1,3 @@
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nbu_currency"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nbu_currency.rb

@@ -0,0 +1,129 @@
+require 'nbu_currency/version'
+require 'open-uri'
+require 'nokogiri'
+require 'money'
+
+class InvalidCache < StandardError ; end
+
+class NbuCurrency < Money::Bank::VariableExchange
+
+  attr_accessor :last_updated
+  attr_accessor :rates_updated_at
+
+  CURRENCIES = %w(USD CAD EUR GBP UAH).map(&:freeze).freeze
+  NBU_RATES_URL = 'https://privat24.privatbank.ua/p24/accountorder?oper=prp&PUREXML&apicour&country=ua&full'.freeze
+
+  def update_rates(cache=nil)
+    update_parsed_rates(doc(cache))
+  end
+
+  def save_rates(cache, url=NBU_RATES_URL)
+    raise InvalidCache unless cache
+    File.open(cache, "w") do |file|
+      io = open(url);
+      io.each_line { |line| file.puts line }
+    end
+  end
+
+  def update_rates_from_s(content)
+    update_parsed_rates(doc_from_s(content))
+  end
+
+  def save_rates_to_s(url=NBU_RATES_URL)
+    open(url).read
+  end
+
+  def exchange(cents, from_currency, to_currency)
+    exchange_with(Money.new(cents, from_currency), to_currency)
+  end
+
+  def exchange_with(from, to_currency)
+    from_base_rate, to_base_rate = nil, nil
+    rate = get_rate(from, to_currency)
+
+    unless rate
+      @mutex.synchronize do
+        opts = { without_mutex: true }
+        from_base_rate = get_rate("UAH", from.currency.to_s, opts)
+        to_base_rate = get_rate("UAH", to_currency, opts)
+      end
+      rate = to_base_rate / from_base_rate
+    end
+
+    calculate_exchange(from, to_currency, rate)
+  end
+
+  def get_rate(from, to, opts = {})
+    fn = -> { @rates[rate_key_for(from, to, opts)] }
+
+    if opts[:without_mutex]
+      fn.call
+    else
+      @mutex.synchronize { fn.call }
+    end
+  end
+
+  def set_rate(from, to, rate, opts = {})
+    fn = -> { @rates[rate_key_for(from, to, opts)] = rate }
+
+    if opts[:without_mutex]
+      fn.call
+    else
+      @mutex.synchronize { fn.call }
+    end
+  end
+
+  protected
+
+  def doc(cache, url=NBU_RATES_URL)
+    rates_source = !!cache ? cache : url
+    begin
+      Nokogiri::XML(open(rates_source)).tap do |doc|
+        if doc.xpath('exchangerate/exchangerate/@date').any?
+          doc.xpath('exchangerate/exchangerate')
+        else
+          raise Nokogiri::XML::XPath::SyntaxError
+        end
+      end
+    rescue Nokogiri::XML::XPath::SyntaxError
+      Nokogiri::XML(open(url))
+    end
+  end
+
+  def doc_from_s(content)
+    Nokogiri::XML(content)
+  end
+
+  def update_parsed_rates(doc)
+    rates = doc.xpath('exchangerate/exchangerate')
+
+    @mutex.synchronize do
+      rates.each do |exchange_rate|
+        rate = BigDecimal(exchange_rate.attribute("buy").value.to_i) / exchange_rate.attribute("unit").value.to_f / 10000.0
+        currency = exchange_rate.attribute("ccy").value
+        set_rate("UAH", currency, rate, :without_mutex => true)
+      end
+      set_rate("UAH", "UAH", 1, :without_mutex => true)
+    end
+
+    rates_updated_at = doc.xpath('exchangerate/exchangerate/@date').first.value
+    @rates_updated_at = Time.parse(rates_updated_at)
+
+    @last_updated = Time.now
+  end
+
+  private
+
+  def calculate_exchange(from, to_currency, rate)
+    to_currency_money = Money::Currency.wrap(to_currency).subunit_to_unit
+    from_currency_money = from.currency.subunit_to_unit
+    decimal_money = BigDecimal(to_currency_money) / BigDecimal(from_currency_money)
+    money = (decimal_money * from.cents * rate).round
+    Money.new(money, to_currency)
+  end
+
+  def rate_key_for(from, to, opts)
+    key = "#{from}_TO_#{to}"
+    key.upcase
+  end
+end

data/lib/nbu_currency/version.rb

@@ -0,0 +1,5 @@
+require 'money'
+
+class NbuCurrency < Money::Bank::VariableExchange
+  VERSION = "0.1.0"
+end

data/nbu_currency.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nbu_currency/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nbu_currency"
+  spec.version       = NbuCurrency::VERSION
+  spec.authors       = ["Nazar Matus"]
+  spec.email         = ["funkyloverone@gmail.com"]
+
+  spec.summary       = %q{Calculates exchange rates based on rates from National Bank of Ukraine. Money gem compatible.}
+  spec.description   = %q{This gem reads exchange rates from the National Bank of Ukraine website. It uses it to calculates exchange rates. It is compatible with the money gem.}
+  spec.homepage      = "https://github.com/FunkyloverOne/nbu_currency"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+  end
+
+  spec.add_dependency "nokogiri", "~> 1.6.3"
+  spec.add_dependency "money", "~> 6.5.0"
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: nbu_currency
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nazar Matus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.5.0
+description: This gem reads exchange rates from the National Bank of Ukraine website.
+  It uses it to calculates exchange rates. It is compatible with the money gem.
+email:
+- funkyloverone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nbu_currency.rb
+- lib/nbu_currency/version.rb
+- nbu_currency.gemspec
+- tasks/rspec.rake
+homepage: https://github.com/FunkyloverOne/nbu_currency
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Calculates exchange rates based on rates from National Bank of Ukraine. Money
+  gem compatible.
+test_files: []