money-open-exchange-rates 0.7.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2bb0f3d444f2239012893ebb5b147ea7ed833685
-  data.tar.gz: 73c55f153751549bda537ea4450fbe1dcf13b955
+SHA256:
+  metadata.gz: 213847dd55f3bbc717a20dc056e61510f4b00ede31bce5b1c7022b16eedc875e
+  data.tar.gz: e245e87886f4c2fc2d8ae6fcf25c80d5f7797ffc3d877eaafab18abd2f911050
 SHA512:
-  metadata.gz: e84776814c80e1720bd0bac0014fd30b0bd58028c73d1dae3ab284ab374c25eca032c91ee6aab353e308358b977bd18776940c07908cfc871c577e180f692be6
-  data.tar.gz: 8d6cac3341389cf16dd7431b2cd32a1b61d210afd9e650ccdfe6935500a8eba1bcd68de7922a468806ad5ba0a8234cac48fab7ff3034171d45a12d214c9f770d
+  metadata.gz: 7a63501cb0baad531f152bedc2a232697f9c64da9bfeef9dd576ecbcda9dceaed83aba902f272c5cd4d44af20e9a55bd7654e1c244a60a5620b9db6f033c6f4b
+  data.tar.gz: 0c5466657cac8fb4e826d7d9e24ac354778eca529ac156385d3dc44070ed78d3e9278ffc2e17ccad705311195fdaa2822d17855cbcd2e721d90cab37ebe1c0c2

data/Gemfile

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'simplecov', require: false

data/History.md

@@ -1,4 +1,107 @@
 
+1.4.0 / 2020-09-11
+==================
+
+  * Fix jruby test for cross courses
+  * Fix deprecation global use of must_equal
+  * Merge pull request #66 from @korun / clear-cross-courses
+    * Update rates inside transaction, to prevent RC issues
+  * Merge pull request #65 from @korun / ensure-file-closed
+    * Fix unclosed file descriptor after read_from_cache
+  * Merge pull request #64 from @anton-smagin / clear-cross-courses
+    * Set old rates to nil on #update_rates before set new one to expire pair rates using base
+  * Add coverage stage on ci
+  * Remove Ruby 2.3 support
+  * Switch to gitlab ci
+  * Update README
+  * Fix rubocop to 0.76.0 and remove minitest-focus
+  * Update gitlab ci gem install does not have --no-ri anymore
+  * README add more doc about update_rates
+  * Fix deprecation for minitest 6
+  * Fix flaky test about Money::Bank::NoAppId
+  * Support Pathname for cache
+  * Update rubocop to 0.76
+  * Remove Ruby 2.2 support and update rubocop
+  * Update travis list
+  * README: improve refresh doc
+
+1.3.0 / 2019-01-20
+==================
+
+  * Update webmock to 3.5
+  * Update rubocop to 0.63
+  * Switch from rr to mocha/minitest
+  * Add prettyprint option
+  * README: add info about tests
+  * Remove deprecated secure_connection= option
+  * Merge pull request #54 from @LinkUpStudioUA / symbols-doc-link-fix
+    * Fix link to filtering by symbols doc
+  * Fix bundler to <2 on travis (dropped support Ruby < 2.3)
+  * Fix bundler to 1.17.3 (2.0 dropped support Ruby < 2.3)
+  * Merge pull request #52 from @thejchap / feature/symbols
+    * add support for symbols query param
+  * Remove ruby 2.0/2.1 support and fix rubocop offenses
+  * Add minitest-focus gem
+  * Avoid redefine json_response method
+
+v1.2.2 / 2018-03-31
+===================
+
+  * Warn secure_connection= is deprecated
+  * More simple code on calc_pair_rate_using_base
+  * Increase code coverage on source_url
+  * Fix parse error specs on refresh_rates
+  * Use Coveralls for coverage
+  * Add tests for rates_timestamp issue
+
+v1.2.1 / 2018-03-31
+===================
+
+  * Fix rates_timestamp should be now per default
+
+v1.2.0 / 2018-03-31
+===================
+
+  * Merge pull request #51 from spk/fix-expire_rates
+    * Add force_refresh_rate_on_expire option and use api timestamp
+  * README: info currency-exchange
+
+v1.1.1 / 2018-03-30
+===================
+
+  * Merge pull request #50 from @v-kolesnikov / fix/avoid-monetize
+    * Use `monetize` as a development dependency only
+
+v1.1.0 / 2018-03-28
+===================
+
+  * Force refresh when ttl is expire and cache invalid (issue #47)
+  * Less strict dependency version for money/monetize
+
+v1.0.2 / 2018-03-27
+===================
+
+  * Merge pull request #46 from @cedricpim / fix-float-big-decimal-casting
+    * Fix issue with Float casting for BigDecimal
+
+v1.0.1 / 2018-03-25
+===================
+
+  * Use BigDecimal instead of Float
+
+v1.0.0 / 2018-03-25
+===================
+
+  * Merge pull request #41 from @b-mandelbrot /add-show-alternative
+    * Add support for black market and digital currency rates
+  * Merge pull request #42 from spk/save-rates-when-ttl-expire
+    * Save rates to cache after first fetch and add example with Rails
+    * Improve documation about cache and rates ttl
+    * Save rates when ttl expire
+  * Merge pull request #40 from @Jetbuilt / deprecate-secure_connection
+    * Closes #39 - Make all requests over https and deprecate `secure_connection`
+  * Support Ruby >= 2.0
+
 v0.7.0 / 2016-10-23
 ===================
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2011-2016 Laurent Arnoud <laurent@spkdev.net>
+Copyright (c) 2011-2020 Laurent Arnoud <laurent@spkdev.net>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,9 @@
 # Money Open Exchange Rates
 
 A gem that calculates the exchange rate using published rates from
-[open-exchange-rates](https://openexchangerates.org/)
+[open-exchange-rates](https://openexchangerates.org/). Compatible with
+[Money](https://github.com/RubyMoney/money#currency-exchange) [currency
+exchange](http://www.rubydoc.info/gems/money/Money/Bank/VariableExchange).
 
 Check [api documentation](https://docs.openexchangerates.org/)
 
@@ -11,69 +13,136 @@ Check [api documentation](https://docs.openexchangerates.org/)
     [180 currencies](https://docs.openexchangerates.org/docs/supported-currencies).
 * [Free plan](https://openexchangerates.org/signup) hourly updates, with USD
     base and up to 1,000 requests/month.
-* Currency caching.
+* Automatically caches API results to file or Rails cache.
 * Calculate pair rates.
+* Automatically fetches new data from API if data becomes stale when
+    `ttl_in_seconds` option is provided.
+* Support for black market and digital currency rates with `show_alternative`
+    option.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-~~~ ruby
+``` ruby
 gem 'money-open-exchange-rates'
-~~~
+```
 
 And then execute:
 
-~~~
+```
 bundle
-~~~
+```
 
 Or install it yourself as:
 
-~~~
+```
 gem install money-open-exchange-rates
-~~~
+```
 
 ## Usage
 
-~~~ ruby
+``` ruby
 require 'money/bank/open_exchange_rates_bank'
-oxr = Money::Bank::OpenExchangeRatesBank.new
-oxr.cache = 'path/to/file/cache.json'
+
+# Memory store per default; for others just pass as argument a class like
+# explained in https://github.com/RubyMoney/money#exchange-rate-stores
+oxr = Money::Bank::OpenExchangeRatesBank.new(Money::RatesStore::Memory.new)
 oxr.app_id = 'your app id from https://openexchangerates.org/signup'
+
+# Update the rates for the current rates storage
+# If the storage is memory you will have to restart the server to be taken into
+# account.
+# If the storage is a database, file, this can be added to
+# crontab/worker/scheduler `Money.default_bank.update_rates`
 oxr.update_rates
 
 # (optional)
-# set the seconds after than the current rates are automatically expired
+# See https://github.com/spk/money-open-exchange-rates#cache for more info
+# Updated only when `refresh_rates` is called
+oxr.cache = 'path/to/file/cache.json'
+
+# (optional)
+# Set the seconds after than the current rates are automatically expired
 # by default, they never expire, in this example 1 day.
+# This ttl is about money store (memory, database ...) passed though
+# `Money::Bank::OpenExchangeRatesBank` as argument not about `cache` option.
+# The base time is the timestamp fetched from API.
 oxr.ttl_in_seconds = 86400
+
 # (optional)
-# use https to fetch rates from Open Exchange Rates
-# disabled by default to support free-tier users
-# see https://openexchangerates.org/documentation#https
-oxr.secure_connection = true
-# (optional)
-# set historical date of the rate
+# Set historical date of the rate
 # see https://openexchangerates.org/documentation#historical-data
 oxr.date = '2015-01-01'
+
 # (optional)
 # Set the base currency for all rates. By default, USD is used.
 # OpenExchangeRates only allows USD as base currency
 # for the free plan users.
 oxr.source = 'USD'
 
-# Store in cache
-oxr.save_rates
+# (optional)
+# Extend returned values with alternative, black market and digital currency
+# rates. By default, false is used
+# see: https://docs.openexchangerates.org/docs/alternative-currencies
+oxr.show_alternative = true
+
+# (optional)
+# Minified Response ('prettyprint')
+# see https://docs.openexchangerates.org/docs/prettyprint
+oxr.prettyprint = false
+
+# (optional)
+# Refresh rates, store in cache and update rates
+# Should be used on crontab/worker/scheduler `Money.default_bank.refresh_rates`
+# If you are using unicorn-worker-killer gem or on Heroku like platform,
+# you should avoid to put this on the initializer of your Rails application,
+# because will increase your OXR API usage.
+oxr.refresh_rates
+
+# (optional)
+# Force refresh rates cache and store on the fly when ttl is expired
+# This will slow down request on get_rate, so use at your on risk, if you don't
+# want to setup crontab/worker/scheduler for your application.
+# Again this is not safe with multiple servers and could increase API usage.
+oxr.force_refresh_rate_on_expire = true
 
 Money.default_bank = oxr
 
 Money.default_bank.get_rate('USD', 'CAD')
-~~~
+```
+
+## Refresh rates
+
+### With [whenever](https://github.com/javan/whenever)
+
+``` ruby
+every :hour do
+  runner "Money.default_bank.refresh_rates"
+  # you will have to restart the server if you are using memory rate store
+  runner "Money.default_bank.update_rates"
+end
+```
 
-You can also provide a Proc as a cache to provide your own caching mechanism
+### With rake task
+
+``` ruby
+namespace :open_exchange_rates do
+  desc "Refresh rates from cache and update rates"
+  task :refresh_rates => :environment do
+    Money.default_bank.refresh_rates
+    # you will have to restart the server if you are using memory rate store
+    Money.default_bank.update_rates
+  end
+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
+``` ruby
 oxr.cache = Proc.new do |v|
   key = 'money:exchange_rates'
   if v
@@ -82,16 +151,88 @@ oxr.cache = Proc.new do |v|
     Thread.current[key]
   end
 end
-~~~
+```
+
+With `Rails` cache example:
+
+``` ruby
+OXR_CACHE_KEY = "#{Rails.env}:money:exchange_rates".freeze
+oxr.ttl_in_seconds = 86400
+oxr.cache = Proc.new do |text|
+  if text
+    Rails.cache.write(OXR_CACHE_KEY, text)
+  else
+    Rails.cache.read(OXR_CACHE_KEY)
+  end
+end
+```
+
+To update the cache call `Money.default_bank.refresh_rates` on
+crontab/worker/scheduler. This have to be done this way because the fetch can
+take some time (HTTP call) and can fail.
+
+## Full example configuration initializer with Rails and cache
+
+``` ruby
+require 'money/bank/open_exchange_rates_bank'
+
+OXR_CACHE_KEY = "#{Rails.env}:money:exchange_rates".freeze
+# ExchangeRate is an ActiveRecord model
+# more info at https://github.com/RubyMoney/money#exchange-rate-stores
+oxr = Money::Bank::OpenExchangeRatesBank.new(ExchangeRate)
+oxr.ttl_in_seconds = 86400
+oxr.cache = Proc.new do |text|
+  if text
+    # only expire when refresh_rates is called or `force_refresh_rate_on_expire`
+    # option is enabled
+    # you can also set `expires_in` option on write to force fetch new rates
+    Rails.cache.write(OXR_CACHE_KEY, text)
+  else
+    Rails.cache.read(OXR_CACHE_KEY)
+  end
+end
+oxr.app_id = ENV['OXR_API_KEY']
+oxr.show_alternative = true
+oxr.prettyprint = false
+
+# This can be removed if you have data to avoid http call on boot for production
+oxr.update_rates
+
+Money.default_bank = oxr
+```
+
+See also how to [refresh and update rates](#refresh-rates)
+
+### Tests
+
+To avoid to hit the API we can use the cache option with a saved file like this:
+
+``` ruby
+OXR_CACHE_KEY = "#{Rails.env}:money:exchange_rates".freeze
+if Rails.env.test?
+  oxr.cache = Rails.root.join("test/fixtures/currency-rates.json").to_s
+else
+  oxr.ttl_in_seconds = 5.minutes.to_i
+  oxr.cache = Proc.new do |text|
+    if text
+      Rails.cache.write(OXR_CACHE_KEY, text)
+    else
+      Rails.cache.read(OXR_CACHE_KEY)
+    end
+  end
+end
+```
+
+## Pair rates
 
 Unknown pair rates are transparently calculated: using inverse rate (if known),
 or using base currency rate to both currencies forming the pair.
 
 ## Tests
 
-~~~
+```
 bundle exec rake
-~~~
+```
 
 ## Refs
 
@@ -108,12 +249,12 @@ See [GitHub](https://github.com/spk/money-open-exchange-rates/graphs/contributor
 
 The MIT License
 
-Copyright © 2011-2016 Laurent Arnoud <laurent@spkdev.net>
+Copyright © 2011-2020 Laurent Arnoud <laurent@spkdev.net>
 
 ---
-[![Build](https://img.shields.io/travis-ci/spk/money-open-exchange-rates.svg)](https://travis-ci.org/spk/money-open-exchange-rates)
+[![Build](https://img.shields.io/gitlab/pipeline/spkdev/money-open-exchange-rates/master)](https://gitlab.com/spkdev/money-open-exchange-rates/-/commits/master)
+[![Coverage](https://gitlab.com/spkdev/money-open-exchange-rates/badges/master/coverage.svg)](https://gitlab.com/spkdev/money-open-exchange-rates/-/commits/master)
 [![Version](https://img.shields.io/gem/v/money-open-exchange-rates.svg)](https://rubygems.org/gems/money-open-exchange-rates)
 [![Documentation](https://img.shields.io/badge/doc-rubydoc-blue.svg)](http://www.rubydoc.info/gems/money-open-exchange-rates)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT "MIT")
-[![Code Climate](https://img.shields.io/codeclimate/github/spk/money-open-exchange-rates.svg)](https://codeclimate.com/github/spk/money-open-exchange-rates)
 [![Inline docs](https://inch-ci.org/github/spk/money-open-exchange-rates.svg?branch=master)](http://inch-ci.org/github/spk/money-open-exchange-rates)