money-openexchangerates-bank 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d1de65480f09a588a4682745d9134a7a1200442
+  data.tar.gz: ceedd43fa6d2ab3c856d6adeffdabe43b4342b83
+SHA512:
+  metadata.gz: db4fedb4010411e85ca593135944e679c35e879401694c107ecc10848b4bbf048035ffec3a6d508162ff334711ce86ca8552425c27cbd6ed19a27d147c5afd97
+  data.tar.gz: 1ae9b5d341306846427c7094b6c6507c56130190c6db7122cb0c2ce4996c7c391db2819b0be3436b072b1843dd6bf57ff61d59dda7a4e97ec93c83497046dd17

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :test, :development do
+  platforms :ruby_19, :jruby_19 do
+    gem 'tins', '~> 1.6'
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Phlegx Systems OG
+
+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,225 @@
+# Money Openexchangerates Bank
+
+[![Gem Version](https://badge.fury.io/rb/money-openexchangerates-bank.svg)](https://rubygems.org/gems/money-openexchangerates-bank)
+[![Gem](https://img.shields.io/gem/dt/money-openexchangerates-bank.svg?maxAge=2592000)](https://rubygems.org/gems/money-openexchangerates-bank)
+[![Build Status](https://secure.travis-ci.org/phlegx/money-openexchangerates-bank.svg?branch=master)](https://travis-ci.org/phlegx/money-openexchangerates-bank)
+[![Code Climate](http://img.shields.io/codeclimate/github/phlegx/money-openexchangerates-bank.svg)](https://codeclimate.com/github/phlegx/money-openexchangerates-bank)
+[![Inline Docs](http://inch-ci.org/github/phlegx/money-openexchangerates-bank.svg?branch=master)](http://inch-ci.org/github/phlegx/money-openexchangerates-bank)
+[![Dependency Status](https://gemnasium.com/phlegx/money-openexchangerates-bank.svg)](https://gemnasium.com/phlegx/money-openexchangerates-bank)
+[![License](https://img.shields.io/github/license/phlegx/money-openexchangerates-bank.svg)](http://opensource.org/licenses/MIT)
+
+A gem that calculates the exchange rate using published rates from
+[openexchangerates.org](https://openexchangerates.org/)
+
+## Openexchangerates API
+
+~~~ json
+{
+  "timestamp": 1441101909,
+  "base": "USD",
+  "rates": {
+      /* 190 currencies */
+      "AUD": 1.413637,
+      "CAD": 1.316495,
+      "CHF": 0.96355,
+      "EUR": 0.888466,
+      "BTC": 0.004322, /* Includes cryptocurrencies! */
+      ...
+      }
+}
+~~~
+
+See more about Openexchangerates product plans on https://openexchangerates.org/signup.
+
+## Features
+
+* supports 190 currencies
+* includes cryptocurrencies
+* precision of rates up to 6 digits after point
+* uses fast and reliable json api
+* average response time < 20ms
+* supports caching currency rates
+* calculates every pair rate calculating inverse rate or using base currency rate
+* supports multi threading
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'money-openexchangerates-bank'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install money-openexchangerates-bank
+
+## Usage
+
+~~~ ruby
+# Minimal requirements
+require 'money/bank/openexchangerates_bank'
+moxb = Money::Bank::OpenexchangeratesBank.new
+moxb.access_key = 'your access_key from https://openexchangerates.com/signup'
+
+# Update rates (get new rates from remote if expired or access rates from cache)
+moxb.update_rates
+
+# Force update rates from remote and store in cache
+# moxb.update_rates(true)
+
+# (optional)
+# Set the base currency for all rates. By default, USD is used.
+# OpenexchangeratesBank only allows USD as base currency for the free plan users.
+moxb.source = 'EUR'
+
+# (optional)
+# Set the seconds after than the current rates are automatically expired
+# by default, they never expire, in this example 1 day.
+moxb.ttl_in_seconds = 86400
+
+# (optional)
+# Use https to fetch rates from OpenexchangeratesBank
+# OpenexchangeratesBank only allows http as connection for the free plan users.
+moxb.secure_connection = true
+
+# Define cache (string or pathname)
+moxb.cache = 'path/to/file/cache'
+
+# Set money default bank to Openexchangerates bank
+Money.default_bank = moxb
+~~~
+
+### More methods
+
+~~~ ruby
+moxb = Money::Bank::OpenexchangeratesBank.new
+
+# Returns the base currency set for all rates.
+moxb.source
+
+# Include also alternative rates.
+moxb.alternatives = :all
+
+# Get only alternative rates.
+moxb.alternatives = :only
+
+# Default is nil to get only regular rates.
+# moxb.alternatives = nil
+
+# Expires rates if the expiration time is reached.
+moxb.expire_rates!
+
+# Returns true if the expiration time is reached.
+moxb.expired?
+
+# Get the API source url.
+moxb.source_url
+
+# Get the rates timestamp of the last API request.
+moxb.rates_timestamp
+
+# Get the rates timestamp of loaded rates in memory.
+moxb.rates_mem_timestamp
+~~~
+
+### How to exchange
+
+~~~ ruby
+# Exchange 1000 cents (10.0 USD) to EUR
+Money.new(1000, 'USD').exchange_to('EUR')        # => #<Money fractional:89 currency:EUR>
+Money.new(1000, 'USD').exchange_to('EUR').to_f   # => 8.9
+
+# Format
+Money.new(1000, 'USD').exchange_to('EUR').format # => €8.90
+
+# Get the rate
+Money.default_bank.get_rate('USD', 'CAD')        # => 0.9
+~~~
+
+See more on https://github.com/RubyMoney/money.
+
+### Using gem money-rails
+
+You can also use it in Rails with the gem [money-rails](https://github.com/RubyMoney/money-rails).
+
+~~~ ruby
+require 'money/bank/openexchangerates_bank'
+
+MoneyRails.configure do |config|
+  moxb = Money::Bank::OpenexchangeratesBank.new
+  moxb.access_key = 'your access_key from https://openexchangerates.com/signup'
+  moxb.update_rates
+
+  config.default_bank = moxb
+end
+~~~
+
+### Cache
+
+You can also provide a Proc as a cache to provide your own caching mechanism
+perhaps with Redis or just a thread safe `Hash` (global). For example:
+
+~~~ ruby
+moxb.cache = Proc.new do |v|
+  key = 'money:openexchangerates_bank'
+  if v
+    Thread.current[key] = v
+  else
+    Thread.current[key]
+  end
+end
+~~~
+
+## Process
+
+The gem fetches all rates in a cache with USD as base currency. It's possible to compute the rate between any of the currencies by calculating a pair rate using base USD rate.
+
+## Tests
+
+You can place your own key on a file or environment
+variable named TEST_ACCESS_KEY and then run:
+
+~~~
+bundle exec rake
+~~~
+
+## Refs
+
+* Gem [money](https://github.com/RubyMoney/money)
+* Gem [money-currencylayer-bank](https://github.com/phlegx/money-currencylayer-bank)
+* Gem [money-open-exchange-rates](https://github.com/spk/money-open-exchange-rates)
+* Gem [money-historical-bank](https://github.com/atwam/money-historical-bank)
+
+## Other Implementations
+
+* Gem [money-currencylayer-bank](https://github.com/phlegx/money-currencylayer-bank)
+* Gem [money-open-exchange-rates](https://github.com/spk/money-open-exchange-rates)
+* Gem [money-historical-bank](https://github.com/atwam/money-historical-bank)
+* Gem [currencylayer](https://github.com/askuratovsky/currencylayer)
+* Gem [eu_central_bank](https://github.com/RubyMoney/eu_central_bank)
+* Gem [nordea](https://github.com/matiaskorhonen/nordea)
+* Gem [google_currency](https://github.com/RubyMoney/google_currency)
+
+## Contributors
+
+* See [github.com/phlegx/money-openexchangerates-bank](https://github.com/phlegx/money-openexchangerates-bank/graphs/contributors).
+* Inspired by [github.com/phlegx/money-currencylayer-bank](https://github.com/phlegx/money-currencylayer-bank/graphs/contributors).
+
+## Contributing
+
+1. Fork it ( https://github.com/[your-username]/money-openexchangerates-bank/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
+
+## License
+
+The MIT License
+
+Copyright (c) 2017 Phlegx Systems OG

data/lib/money/bank/openexchangerates_bank.rb

@@ -0,0 +1,353 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'open-uri'
+require 'money'
+require 'json'
+
+# Money gem class
+class Money
+  # Build in memory rates store
+  module RatesStore
+    # Memory class
+    class Memory
+      # Add method to reset the build in memory store
+      # @param [Hash] rt Optional initial exchange rate data.
+      # @return [Object] store.
+      def reset!(rt = {})
+        transaction { @index = rt }
+      end
+    end
+  end
+
+  # https://github.com/RubyMoney/money#exchange-rate-stores
+  module Bank
+    # Invalid cache, file not found or cache empty
+    class InvalidCache < StandardError; end
+
+    # App id not set error
+    class NoAccessKey < StandardError; end
+
+    # CurrencylayerBank base class
+    class OpenexchangeratesBank < Money::Bank::VariableExchange
+      # CurrencylayerBank url
+      CL_URL = 'http://openexchangerates.org/api/latest.json'.freeze
+      # CurrencylayerBank secure url
+      CL_SECURE_URL = CL_URL.sub('http:', 'https:')
+      # Default base currency
+      CL_SOURCE = 'USD'.freeze
+
+      # Use https to fetch rates from CurrencylayerBank
+      # CurrencylayerBank only allows http as connection
+      # for the free plan users.
+      #
+      # @param value [Boolean] true for secure connection
+      # @return [Boolean] chosen secure connection
+      attr_accessor :secure_connection
+
+      # API must have a valid access_key
+      #
+      # @param value [String] API access key
+      # @return [String] chosen API access key
+      attr_accessor :access_key
+
+      # Cache accessor, can be a String or a Proc
+      #
+      # @param value [String,Pathname,Proc] cache system
+      # @return [String,Pathname,Proc] chosen cache system
+      attr_accessor :cache
+
+      # Parsed CurrencylayerBank result as Hash
+      attr_reader :rates
+
+      # Get the timestamp of rates in memory
+      # @return [Time] time object or nil
+      attr_reader :rates_mem_timestamp
+
+      # Set the seconds after than the current rates are automatically expired
+      # by default, they never expire.
+      #
+      # @example
+      #   ttl_in_seconds = 86400 # will expire the rates in one day
+      #
+      # @param value [Integer] time to live in seconds
+      # @return [Integer] chosen time to live in seconds
+      attr_writer :ttl_in_seconds
+
+      # Set the base currency for all rates. By default, USD is used.
+      # CurrencylayerBank only allows USD as base currency
+      # for the free plan users.
+      #
+      # @example
+      #   source = 'USD'
+      #
+      # @param value [String] Currency code, ISO 3166-1 alpha-3
+      # @return [String] chosen base currency
+      def source=(value)
+        @source = Money::Currency.find(value.to_s).try(:iso_code) || CL_SOURCE
+      end
+
+      # Get the base currency for all rates. By default, USD is used.
+      # @return [String] base currency
+      def source
+        @source ||= CL_SOURCE
+      end
+
+      # Set alternative system, to request alternative rates
+      #
+      # @example
+      #   alternatives = :all
+      #   alternatives = :only
+      #   alternatives = nil
+      #
+      # @param value [String,Symbol] alternatives
+      # @return [String,nil] chosen alternative system
+      def alternatives=(system)
+        @alternatives = case system.to_sym
+                        when :all
+                          'show_alternative'
+                        when :only
+                          'only_alternative'
+                        end
+      end
+
+      # Get alternative system. Default is nil
+      # @return [String,nil] chosen alternative system
+      def alternatives
+        @alternatives || nil
+      end
+
+      # Get the seconds after than the current rates are automatically expired
+      # by default, they never expire.
+      # @return [Integer] chosen time to live in seconds
+      def ttl_in_seconds
+        @ttl_in_seconds ||= 0
+      end
+
+      # Update all rates from CurrencylayerBank JSON
+      # @return [Array] array of exchange rates
+      def update_rates(straight = false)
+        store.reset!
+        exchange_rates(straight).each do |exchange_rate|
+          currency = exchange_rate.first
+          rate = exchange_rate.last
+          next unless Money::Currency.find(currency)
+          add_rate(source, currency, rate)
+          add_rate(currency, source, 1.0 / rate)
+        end
+        @rates_mem_timestamp = rates_timestamp
+      end
+
+      # Override Money `add_rate` method for caching
+      # @param [String] from_currency Currency ISO code. ex. 'USD'
+      # @param [String] to_currency Currency ISO code. ex. 'CAD'
+      # @param [Numeric] rate Rate to use when exchanging currencies.
+      # @return [Numeric] rate.
+      def add_rate(from_currency, to_currency, rate)
+        super
+      end
+
+      # Alias super method
+      alias super_get_rate get_rate
+
+      # Override Money `get_rate` method for caching
+      # @param [String] from_currency Currency ISO code. ex. 'USD'
+      # @param [String] to_currency Currency ISO code. ex. 'CAD'
+      # @param [Hash] opts Options hash to set special parameters.
+      # @return [Numeric] rate.
+      def get_rate(from_currency, to_currency, opts = {})
+        expire_rates!
+        rate = get_rate_or_calc_inverse(from_currency, to_currency, opts)
+        rate || calc_pair_rate_using_base(from_currency, to_currency, opts)
+      end
+
+      # Fetch new rates if cached rates are expired or stale
+      # @return [Boolean] true if rates are expired and updated from remote
+      def expire_rates!
+        if expired?
+          update_rates(true)
+          true
+        elsif stale?
+          update_rates
+          true
+        else
+          false
+        end
+      end
+
+      # Check if rates are expired
+      # @return [Boolean] true if rates are expired
+      def expired?
+        Time.now > rates_expiration
+      end
+
+      # Check if rates are stale
+      # Stale is true if rates are updated straight by another thread.
+      # The actual thread has always old rates in memory store.
+      # @return [Boolean] true if rates are stale
+      def stale?
+        rates_timestamp != rates_mem_timestamp
+      end
+
+      # Source url of CurrencylayerBank
+      # defined with access_key and secure_connection
+      # @return [String] the remote API url
+      def source_url
+        raise NoAccessKey if access_key.nil? || access_key.empty?
+        cl_url = CL_URL
+        cl_url = CL_SECURE_URL if secure_connection
+        params = "#{cl_url}?base=#{source}&app_id=#{access_key}&prettyprint=0"
+        params += "&#{alternatives}=1" unless alternatives.nil?
+        params
+      end
+
+      # Get rates expiration time based on ttl
+      # @return [Time] rates expiration time
+      def rates_expiration
+        rates_timestamp + ttl_in_seconds
+      end
+
+      # Get the timestamp of rates
+      # @return [Time] time object or nil
+      def rates_timestamp
+        raw = raw_rates_careful
+        raw.key?('timestamp') ? Time.at(raw['timestamp']) : Time.at(0)
+      end
+
+      protected
+
+      # Store the provided text data by calling the proc method provided
+      # for the cache, or write to the cache file.
+      #
+      # @example
+      #   store_in_cache("{\"rates\": {\"AED\": 3.67304}}")
+      #
+      # @param text [String] parsed JSON content
+      # @return [String,Integer]
+      def store_in_cache(text)
+        if cache.is_a?(Proc)
+          cache.call(text)
+        elsif cache.is_a?(String) || cache.is_a?(Pathname)
+          write_to_file(text)
+        end
+      end
+
+      # Writes content to file cache
+      # @param text [String] parsed JSON content
+      # @return [String,Integer]
+      def write_to_file(text)
+        open(cache, 'w') do |f|
+          f.write(text)
+        end
+      rescue Errno::ENOENT
+        raise InvalidCache
+      end
+
+      # Read from cache when exist
+      # @return [Proc,String] parsed JSON content
+      def read_from_cache
+        if cache.is_a?(Proc)
+          cache.call(nil)
+        elsif (cache.is_a?(String) || cache.is_a?(Pathname)) &&
+              File.exist?(cache)
+          open(cache).read
+        end
+      end
+
+      # Get remote content and store in cache
+      # @return [String] unparsed JSON content
+      def read_from_url
+        text = open_url
+        store_in_cache(text) if valid_rates?(text) && cache
+        text
+      end
+
+      # Opens an url and reads the content
+      # @return [String] unparsed JSON content
+      def open_url
+        open(source_url).read
+      rescue OpenURI::HTTPError
+        ''
+      end
+
+      # Check validity of rates response only for store in cache
+      #
+      # @example
+      #   valid_rates?("{\"rates\": {\"AED\": 3.67304}}")
+      #
+      # @param [String] text is JSON content
+      # @return [Boolean] valid or not
+      def valid_rates?(text)
+        parsed = JSON.parse(text)
+        parsed && parsed.key?('rates')
+      rescue JSON::ParserError
+        false
+      end
+
+      # Get exchange rates with different strategies
+      #
+      # @example
+      #   exchange_rates(true)
+      #   exchange_rates
+      #
+      # @param straight [Boolean] true for straight, default is careful
+      # @return [Hash] key is country code (ISO 3166-1 alpha-3) value Float
+      def exchange_rates(straight = false)
+        @rates = if straight
+                   raw_rates_straight['rates']
+                 else
+                   raw_rates_careful['rates']
+                 end
+      end
+
+      # Get raw exchange rates from cache and then from url
+      # @param rescue_straight [Boolean] true for rescue straight, default true
+      # @return [String] JSON content
+      def raw_rates_careful(rescue_straight = true)
+        JSON.parse(read_from_cache.to_s)
+      rescue JSON::ParserError
+        rescue_straight ? raw_rates_straight : { 'rates' => {} }
+      end
+
+      # Get raw exchange rates from url
+      # @return [String] JSON content
+      def raw_rates_straight
+        JSON.parse(read_from_url)
+      rescue JSON::ParserError
+        raw_rates_careful(false)
+      end
+
+      # Get rate or calculate it as inverse rate
+      # @param [String] from_currency Currency ISO code. ex. 'USD'
+      # @param [String] to_currency Currency ISO code. ex. 'CAD'
+      # @return [Numeric] rate or rate calculated as inverse rate.
+      def get_rate_or_calc_inverse(from_currency, to_currency, opts = {})
+        rate = super_get_rate(from_currency, to_currency, opts)
+        unless rate
+          # Tries to calculate an inverse rate
+          inverse_rate = super_get_rate(to_currency, from_currency, opts)
+          if inverse_rate
+            rate = 1.0 / inverse_rate
+            add_rate(from_currency, to_currency, rate)
+          end
+        end
+        rate
+      end
+
+      # Tries to calculate a pair rate using base currency rate
+      # @param [String] from_currency Currency ISO code. ex. 'USD'
+      # @param [String] to_currency Currency ISO code. ex. 'CAD'
+      # @return [Numeric] rate or nil if cannot calculate rate.
+      def calc_pair_rate_using_base(from_currency, to_currency, opts = {})
+        from_base_rate = get_rate_or_calc_inverse(source, from_currency, opts)
+        to_base_rate   = get_rate_or_calc_inverse(source, to_currency, opts)
+        if to_base_rate && from_base_rate
+          rate = to_base_rate / from_base_rate
+          add_rate(from_currency, to_currency, rate)
+          return rate
+        end
+        nil
+      end
+    end
+  end
+end

data/test/TEST_ACCESS_KEY

@@ -0,0 +1 @@
+your access_key from https://openexchangerates.org/signup

data/test/live.json

@@ -0,0 +1,198 @@
+{
+  "disclaimer": "Usage subject to terms: https://openexchangerates.org/terms",
+  "license": "https://openexchangerates.org/license",
+  "timestamp": 1440755169,
+  "base": "USD",
+  "rates": {
+    "AED": 3.673035,
+    "AFN": 68.7835,
+    "ALL": 120.3,
+    "AMD": 485.02,
+    "ANG": 1.789597,
+    "AOA": 165.9145,
+    "ARS": 16.0905,
+    "AUD": 1.337896,
+    "AWG": 1.800506,
+    "AZN": 1.685,
+    "BAM": 1.74995,
+    "BBD": 2,
+    "BDT": 81.152488,
+    "BGN": 1.749004,
+    "BHD": 0.37695,
+    "BIF": 1708.65,
+    "BMD": 1,
+    "BND": 1.389105,
+    "BOB": 6.987637,
+    "BRL": 3.269899,
+    "BSD": 1,
+    "BTC": 0.000424652342,
+    "BTN": 64.758477,
+    "BTS": 10.6793407974,
+    "BWP": 10.39206,
+    "BYN": 1.863063,
+    "BZD": 2.020847,
+    "CAD": 1.350885,
+    "CDF": 1428.863033,
+    "CHF": 0.97632,
+    "CLF": 0.025113,
+    "CLP": 674.325,
+    "CNH": 6.879369,
+    "CNY": 6.8903,
+    "COP": 2910.479832,
+    "CRC": 578.11,
+    "CUC": 1,
+    "CUP": 25.5,
+    "CVE": 99,
+    "CZK": 23.642313,
+    "DASH": 0.006760512,
+    "DJF": 178.77,
+    "DKK": 6.648526,
+    "DOGE": 269.551968987,
+    "DOP": 47.51621,
+    "DZD": 108.444,
+    "EAC": 4732.13456667,
+    "EGP": 18.0813,
+    "EMC": 0.837052105,
+    "ERN": 15.335585,
+    "ETB": 23.124034,
+    "ETH": 0.005376611,
+    "EUR": 0.886584,
+    "FCT": 0.0634141713,
+    "FJD": 2.074747,
+    "FKP": 0.771523,
+    "FTC": 25.1412108028,
+    "GBP": 0.771523,
+    "GEL": 2.40678,
+    "GGP": 0.771523,
+    "GHS": 4.345,
+    "GIP": 0.771523,
+    "GMD": 46.15,
+    "GNF": 9204.45,
+    "GTQ": 7.37438,
+    "GYD": 209.141431,
+    "HKD": 7.788739,
+    "HNL": 23.621643,
+    "HRK": 6.6359,
+    "HTG": 68.95723,
+    "HUF": 275.216,
+    "IDR": 13305.1241,
+    "ILS": 3.59376,
+    "IMP": 0.771523,
+    "INR": 64.7775,
+    "IQD": 1175.736141,
+    "IRR": 32454.938798,
+    "ISK": 100.464841,
+    "JEP": 0.771523,
+    "JMD": 130.676848,
+    "JOD": 0.709503,
+    "JPY": 111.794375,
+    "KES": 103.285,
+    "KGS": 67.885152,
+    "KHR": 4074.45,
+    "KMF": 440.2,
+    "KPW": 899.91,
+    "KRW": 1124.165,
+    "KWD": 0.303677,
+    "KYD": 0.837868,
+    "KZT": 310.93,
+    "LAK": 8237.85,
+    "LBP": 1517.2,
+    "LD": 251.7,
+    "LKR": 152.74,
+    "LRD": 94.497383,
+    "LSL": 13.310652,
+    "LTC": 0.031068873,
+    "LYD": 1.404403,
+    "MAD": 9.76775,
+    "MDL": 18.284966,
+    "MGA": 3086.6,
+    "MKD": 55.054704,
+    "MMK": 1377.4,
+    "MNT": 2410.880742,
+    "MOP": 8.065265,
+    "MRO": 362.423894,
+    "MUR": 34.746,
+    "MVR": 15.570203,
+    "MWK": 726.14,
+    "MXN": 18.589873,
+    "MYR": 4.290006,
+    "MZN": 70.932906,
+    "NAD": 13.02095,
+    "NGN": 320,
+    "NIO": 29.939182,
+    "NMC": 0.4415677667,
+    "NOK": 8.39117,
+    "NPR": 104.278757,
+    "NVC": 0.2067437432,
+    "NXT": 12.0649323229,
+    "NZD": 1.422657,
+    "OMR": 0.384999,
+    "PAB": 1,
+    "PEN": 3.281961,
+    "PGK": 3.191399,
+    "PHP": 49.99,
+    "PKR": 105.39,
+    "PLN": 3.74213,
+    "PPC": 0.4604239038,
+    "PYG": 5622.8,
+    "QAR": 3.6415,
+    "RON": 4.0667,
+    "RSD": 109.81,
+    "RUB": 56.454783,
+    "RWF": 848.135575,
+    "SAR": 3.750449,
+    "SBD": 7.852215,
+    "SCR": 13.488435,
+    "SDG": 6.712818,
+    "SEK": 8.704256,
+    "SGD": 1.388248,
+    "SHP": 0.771523,
+    "SLL": 7502.169019,
+    "SOS": 581.655,
+    "SRD": 7.5375,
+    "SSP": 118.5751,
+    "STD": 21882.388901,
+    "STR": 17.4617511685,
+    "SVC": 8.797503,
+    "SYP": 214.35,
+    "SZL": 13.312834,
+    "THB": 34.37,
+    "TJS": 8.824018,
+    "TMT": 3.504979,
+    "TND": 2.407735,
+    "TOP": 2.311691,
+    "TRY": 3.564739,
+    "TTD": 6.765558,
+    "TWD": 30.17,
+    "TZS": 2237.3,
+    "UAH": 26.265,
+    "UGX": 3631.55,
+    "USD": 1,
+    "UYU": 28.265527,
+    "UZS": 3841.15,
+    "VEF": 9.985022,
+    "VEF_BLKMKT": 5890.73,
+    "VEF_DICOM": 721.33,
+    "VEF_DIPRO": 10,
+    "VND": 22679.057152,
+    "VTC": 2.3128712447,
+    "VUV": 108.260636,
+    "WST": 2.568925,
+    "XAF": 586.424407,
+    "XAG": 0.05858746,
+    "XAU": 0.00079841,
+    "XCD": 2.70255,
+    "XDR": 0.722859,
+    "XMR": 0.0177529017,
+    "XOF": 586.982338,
+    "XPD": 0.00129134,
+    "XPF": 106.897736,
+    "XPM": 1.4437020712,
+    "XPT": 0.00105933,
+    "XRP": 3.054084697,
+    "YER": 250.294142,
+    "ZAR": 12.963878,
+    "ZMW": 9.315,
+    "ZWL": 322.387247
+  }
+}

data/test/openexchangerates_bank_test.rb

@@ -0,0 +1,305 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+describe Money::Bank::OpenexchangeratesBank do
+  subject { Money::Bank::OpenexchangeratesBank.new }
+  let(:url) { Money::Bank::OpenexchangeratesBank::CL_URL }
+  let(:secure_url) { Money::Bank::OpenexchangeratesBank::CL_SECURE_URL }
+  let(:source) { Money::Bank::OpenexchangeratesBank::CL_SOURCE }
+  let(:temp_cache_path) do
+    File.expand_path(File.join(File.dirname(__FILE__), 'temp.json'))
+  end
+  let(:data_path) do
+    File.expand_path(File.join(File.dirname(__FILE__), 'live.json'))
+  end
+
+  describe 'exchange' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.cache = temp_cache_path
+      stub(subject).source_url { data_path }
+      subject.update_rates
+    end
+
+    after do
+      File.unlink(temp_cache_path)
+    end
+
+    describe 'without rates' do
+      it 'able to exchange a money to its own currency even without rates' do
+        money = Money.new(0, 'USD')
+        subject.exchange_with(money, 'USD').must_equal money
+      end
+
+      it "raise if it can't find an exchange rate" do
+        money = Money.new(0, 'USD')
+        proc { subject.exchange_with(money, 'LTL') }
+          .must_raise Money::Bank::UnknownRate
+      end
+    end
+
+    describe 'with rates' do
+      before do
+        subject.update_rates
+      end
+
+      it 'should be able to exchange money from USD to a known exchange rate' do
+        money = Money.new(100, 'USD')
+        subject.exchange_with(money, 'BBD').must_equal Money.new(200, 'BBD')
+      end
+
+      it 'should be able to exchange money from a known exchange rate to USD' do
+        money = Money.new(200, 'BBD')
+        subject.exchange_with(money, 'USD').must_equal Money.new(100, 'USD')
+      end
+
+      it "should raise if it can't find an exchange rate" do
+        money = Money.new(0, 'USD')
+        proc { subject.exchange_with(money, 'LTL') }
+          .must_raise Money::Bank::UnknownRate
+      end
+    end
+  end
+
+  describe 'cache rates' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.cache = temp_cache_path
+      stub(subject).source_url { data_path }
+      subject.update_rates
+    end
+
+    after do
+      File.delete(temp_cache_path) if File.exist?(temp_cache_path)
+    end
+
+    it 'should allow update after save' do
+      begin
+        subject.update_rates
+      rescue
+        assert false, 'Should allow updating after saving'
+      end
+    end
+
+    it 'should not break an existing file if save fails to read' do
+      initial_size = File.read(temp_cache_path).size
+      stub(subject).open_url { '' }
+      subject.update_rates
+      File.read(temp_cache_path).size.must_equal initial_size
+    end
+
+    it 'should not break an existing file if save returns json without rates' do
+      initial_size = File.read(temp_cache_path).size
+      stub(subject).open_url { '{ "error": "An error" }' }
+      subject.update_rates
+      File.read(temp_cache_path).size.must_equal initial_size
+    end
+
+    it 'should not break an existing file if save returns a invalid json' do
+      initial_size = File.read(temp_cache_path).size
+      stub(subject).open_url { '{ invalid_json: "An error" }' }
+      subject.update_rates
+      File.read(temp_cache_path).size.must_equal initial_size
+    end
+  end
+
+  describe 'no cache' do
+    before do
+      subject.cache = nil
+      subject.access_key = TEST_ACCESS_KEY
+      stub(subject).source_url { data_path }
+    end
+
+    it 'should get from url' do
+      subject.update_rates
+      subject.rates.wont_be_empty
+    end
+  end
+
+  describe 'no valid file for cache' do
+    before do
+      subject.cache = "space_dir#{rand(999_999_999)}/out_space_file.json"
+      subject.access_key = TEST_ACCESS_KEY
+      stub(subject).source_url { data_path }
+    end
+
+    it 'should raise an error if invalid path is given' do
+      proc { subject.update_rates }.must_raise Money::Bank::InvalidCache
+    end
+  end
+
+  describe 'using proc for cache' do
+    before :each do
+      @global_rates = nil
+      subject.cache = proc { |v|
+        if v
+          @global_rates = v
+        else
+          @global_rates
+        end
+      }
+      subject.access_key = TEST_ACCESS_KEY
+    end
+
+    it 'should get from url normally' do
+      stub(subject).source_url { data_path }
+      subject.update_rates
+      subject.rates.wont_be_empty
+    end
+
+    it 'should save from url and get from cache' do
+      stub(subject).source_url { data_path }
+      subject.update_rates
+      @global_rates.wont_be_empty
+      dont_allow(subject).source_url
+      subject.update_rates
+      subject.rates.wont_be_empty
+    end
+  end
+
+  describe '#secure_connection' do
+    it "should use the non-secure http url if secure_connection isn't set" do
+      subject.secure_connection = nil
+      subject.access_key = TEST_ACCESS_KEY
+      subject.source_url.must_equal "#{url}?base=#{source}&"\
+                                    "app_id=#{TEST_ACCESS_KEY}&"\
+                                    'prettyprint=0'
+    end
+
+    it 'should use the non-secure http url if secure_connection is false' do
+      subject.secure_connection = false
+      subject.access_key = TEST_ACCESS_KEY
+      subject.source_url.must_equal "#{url}?base=#{source}&"\
+                                    "app_id=#{TEST_ACCESS_KEY}&"\
+                                    'prettyprint=0'
+    end
+
+    it 'should use the secure https url if secure_connection is set to true' do
+      subject.secure_connection = true
+      subject.access_key = TEST_ACCESS_KEY
+      subject.source_url.must_equal "#{secure_url}?base=#{source}&"\
+                                    "app_id=#{TEST_ACCESS_KEY}&"\
+                                    'prettyprint=0'
+      subject.source_url.must_include 'https://'
+    end
+  end
+
+  describe '#update_rates' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.cache = data_path
+      stub(subject).source_url { data_path }
+      subject.update_rates
+    end
+
+    it 'should update itself with exchange rates from OpenexchangeratesBank' do
+      subject.rates.keys.each do |currency|
+        next unless Money::Currency.find(currency)
+        subject.get_rate('USD', currency).must_be :>, 0
+      end
+    end
+
+    it 'should not return 0 with integer rate' do
+      wtf = {
+        priority: 1,
+        iso_code: 'WTF',
+        name: 'WTF',
+        symbol: 'WTF',
+        subunit: 'Cent',
+        subunit_to_unit: 1000,
+        separator: '.',
+        delimiter: ','
+      }
+      Money::Currency.register(wtf)
+      Timecop.freeze(subject.rates_timestamp) do
+        subject.add_rate('USD', 'WTF', 2)
+        subject.add_rate('WTF', 'USD', 2)
+        subject.exchange_with(5000.to_money('WTF'), 'USD').cents
+        subject.exchange_with(5000.to_money('WTF'), 'USD').cents.wont_equal 0
+      end
+    end
+  end
+
+  describe '#access_key' do
+    before do
+      subject.cache = temp_cache_path
+      stub(OpenURI::OpenRead).open(url) { File.read data_path }
+    end
+
+    it 'should raise an error if no access key is set' do
+      proc { subject.update_rates }.must_raise Money::Bank::NoAccessKey
+    end
+  end
+
+  describe '#expire_rates!' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.ttl_in_seconds = 1000
+      @old_usd_eur_rate = 0.655
+      # see test/live.json +59
+      @new_usd_eur_rate = 0.886584
+      subject.cache = temp_cache_path
+      stub(subject).source_url { data_path }
+      subject.update_rates
+      subject.add_rate('USD', 'EUR', @old_usd_eur_rate)
+    end
+
+    after do
+      File.delete(temp_cache_path) if File.exist?(temp_cache_path)
+    end
+
+    describe 'when the ttl has expired' do
+      it 'should update the rates' do
+        Timecop.freeze(subject.rates_timestamp + 1000) do
+          subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
+        end
+        Timecop.freeze(subject.rates_timestamp + 1001) do
+          subject.get_rate('USD', 'EUR').wont_equal @old_usd_eur_rate
+          subject.get_rate('USD', 'EUR').must_equal @new_usd_eur_rate
+        end
+      end
+
+      it 'updates the next expiration time' do
+        Timecop.freeze(subject.rates_timestamp + 1001) do
+          exp_time = subject.rates_timestamp + 1000
+          subject.expire_rates!
+          subject.rates_expiration.must_equal exp_time
+        end
+      end
+    end
+
+    describe 'when the ttl has not expired' do
+      it 'not should update the rates' do
+        subject.update_rates
+        exp_time = subject.rates_expiration
+        subject.expire_rates!
+        subject.rates_expiration.must_equal exp_time
+      end
+    end
+  end
+
+  describe '#rates_timestamp' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.cache = temp_cache_path
+      stub(subject).source_url { data_path }
+    end
+
+    after do
+      File.delete(temp_cache_path) if File.exist?(temp_cache_path)
+    end
+
+    it 'should return 1970-01-01 datetime if no rates' do
+      stub(subject).open_url { '' }
+      subject.update_rates
+      subject.rates_timestamp.must_equal Time.at(0)
+    end
+
+    it 'should return a Time object' do
+      subject.update_rates
+      subject.rates_timestamp.class.must_equal Time
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'rr'
+require 'money/bank/openexchangerates_bank'
+require 'monetize'
+require 'timecop'
+require 'pry'
+
+TEST_ACCESS_KEY_PATH = File.join(File.dirname(__FILE__), 'TEST_ACCESS_KEY')
+TEST_ACCESS_KEY = ENV['TEST_ACCESS_KEY'] || File.read(TEST_ACCESS_KEY_PATH)
+
+if TEST_ACCESS_KEY.nil? || TEST_ACCESS_KEY.empty?
+  raise "Please add a valid access key to file #{TEST_ACCESS_KEY_PATH} or to " \
+    ' TEST_ACCESS_KEY environment'
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: money-openexchangerates-bank
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Egon Zemmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.7'
+- !ruby/object:Gem::Dependency
+  name: monetize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-line
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: A gem that calculates the exchange rate using published rates from openexchangerates.org.
+  Compatible with the money gem.
+email: office@phlegx.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/money/bank/openexchangerates_bank.rb
+- test/TEST_ACCESS_KEY
+- test/live.json
+- test/openexchangerates_bank_test.rb
+- test/test_helper.rb
+homepage: http://github.com/phlegx/money-openexchangerates-bank
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A gem that calculates the exchange rate using published rates from openexchangerates.org.
+test_files:
+- test/openexchangerates_bank_test.rb
+has_rdoc: