money-open-exchange-rates 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73bc7cbbe69a86d58f6376c4670c53996aa6675d
-  data.tar.gz: 79425bdbc492a05b9070791f919389a5e2f347b0
+  metadata.gz: 2bb0f3d444f2239012893ebb5b147ea7ed833685
+  data.tar.gz: 73c55f153751549bda537ea4450fbe1dcf13b955
 SHA512:
-  metadata.gz: f8d8f3a886a0dfefc7f1172ebd72c81f5353cd96cfaae5477ba6d1c0e16ec2b2c4f546da7bb9cae06a597b3b8919d30eb0b39a0ac3b065fc0e9ca52c6a15bd3a
-  data.tar.gz: 1cf0505b5695351d429deff4e42fe762295a259c1d99cd908bfde791bda134867ccf9a662aff0be576d0e9ffd481a32e2d5a9ff2900ebb0884d77913e2315c72
+  metadata.gz: e84776814c80e1720bd0bac0014fd30b0bd58028c73d1dae3ab284ab374c25eca032c91ee6aab353e308358b977bd18776940c07908cfc871c577e180f692be6
+  data.tar.gz: 8d6cac3341389cf16dd7431b2cd32a1b61d210afd9e650ccdfe6935500a8eba1bcd68de7922a468806ad5ba0a8234cac48fab7ff3034171d45a12d214c9f770d

data/History.md

@@ -1,4 +1,20 @@
 
+v0.7.0 / 2016-10-23
+===================
+
+  * Merge pull request #36 from @lautis / drop-json-gem
+    * Use bundled JSON instead of gem
+  * Better api url tests
+  * README https links
+  * Fix rubocop offense Style/StringLiterals
+  * Improve documentation from inch suggestions
+  * Skip integration test when OXR_APP_ID not present
+  * Avoid leak of api key in integration tests
+  * Update josscrowcroft/open-exchange-rates link
+  * More info about OXR
+  * Merge pull request #35 from spk/integration-test
+    * Better integration test
+
 v0.6.1 / 2016-09-21
 ===================
 
@@ -7,7 +23,7 @@ v0.6.1 / 2016-09-21
   * Add failing test for source_url
 
 v0.6.0 / 2016-09-13
-==================
+===================
 
   * Merge pull request #29 from @xsve / pairrates
     * Implemented rate calculation for any pair of currencies via base currency

data/README.md

@@ -3,6 +3,17 @@
 A gem that calculates the exchange rate using published rates from
 [open-exchange-rates](https://openexchangerates.org/)
 
+Check [api documentation](https://docs.openexchangerates.org/)
+
+* [Live](https://docs.openexchangerates.org/docs/latest-json) and
+    [historical](https://docs.openexchangerates.org/docs/historical-json)
+    exchange rates for
+    [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.
+* Calculate pair rates.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,41 +38,43 @@ gem install money-open-exchange-rates
 
 ~~~ ruby
 require 'money/bank/open_exchange_rates_bank'
-moe = Money::Bank::OpenExchangeRatesBank.new
-moe.cache = 'path/to/file/cache'
-moe.app_id = 'your app id from https://openexchangerates.org/signup'
-moe.update_rates
+oxr = Money::Bank::OpenExchangeRatesBank.new
+oxr.cache = 'path/to/file/cache.json'
+oxr.app_id = 'your app id from https://openexchangerates.org/signup'
+oxr.update_rates
 
 # (optional)
 # set the seconds after than the current rates are automatically expired
 # by default, they never expire, in this example 1 day.
-moe.ttl_in_seconds = 86400
+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
-moe.secure_connection = true
+oxr.secure_connection = true
 # (optional)
 # set historical date of the rate
 # see https://openexchangerates.org/documentation#historical-data
-moe.date = '2015-01-01'
+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.
-moe.source = 'USD'
+oxr.source = 'USD'
 
 # Store in cache
-moe.save_rates
+oxr.save_rates
+
+Money.default_bank = oxr
 
-Money.default_bank = moe
+Money.default_bank.get_rate('USD', 'CAD')
 ~~~
 
 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
-moe.cache = Proc.new do |v|
+oxr.cache = Proc.new do |v|
   key = 'money:exchange_rates'
   if v
     Thread.current[key] = v
@@ -82,7 +95,7 @@ bundle exec rake
 
 ## Refs
 
-* <https://github.com/currencybot/open-exchange-rates>
+* <https://github.com/josscrowcroft/open-exchange-rates>
 * <https://github.com/RubyMoney/money>
 * <https://github.com/RubyMoney/eu_central_bank>
 * <https://github.com/RubyMoney/google_currency>
@@ -102,5 +115,5 @@ Copyright © 2011-2016 Laurent Arnoud <laurent@spkdev.net>
 [![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](http://img.shields.io/codeclimate/github/spk/money-open-exchange-rates.svg)](https://codeclimate.com/github/spk/money-open-exchange-rates)
-[![Inline docs](http://inch-ci.org/github/spk/money-open-exchange-rates.svg?branch=master)](http://inch-ci.org/github/spk/money-open-exchange-rates)
+[![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)

data/lib/money/bank/open_exchange_rates_bank.rb

@@ -34,26 +34,57 @@ class Money
 
       # use https to fetch rates from Open Exchange Rates
       # disabled by default to support free-tier users
+      #
+      # @example
+      #   oxr.secure_connection = true
+      #
+      # @param [Boolean] true for https, false for http
+      # @return [Boolean] true for https, false for http
       attr_accessor :secure_connection
 
       # As of the end of August 2012 all requests to the Open Exchange Rates
       # API must have a valid app_id
+      # see https://docs.openexchangerates.org/docs/authentication
+      #
+      # @example
+      #   oxr.app_id = 'YOUR_APP_APP_ID'
+      #
+      # @param [String] token to access OXR API
+      # @return [String] token to access OXR API
       attr_accessor :app_id
 
-      # Cache accessor, can be a String or a Proc
+      # Cache accessor
+      #
+      # @example
+      #   oxr.cache = 'path/to/file/cache.json'
+      #
+      # @param [String,Proc] for a String a filepath
+      # @return [String,Proc] for a String a filepath
       attr_accessor :cache
 
       # Date for historical api
-      # see https://openexchangerates.org/documentation#historical-data
+      # see https://docs.openexchangerates.org/docs/historical-json
+      #
+      # @example
+      #   oxr.date = '2015-01-01'
+      #
+      # @param [String] The requested date in YYYY-MM-DD format
+      # @return [String] The requested date in YYYY-MM-DD format
       attr_accessor :date
 
       # Rates expiration Time
+      #
+      # @return [Time] expiration time
       attr_reader :rates_expiration
 
       # Parsed OpenExchangeRates result as Hash
+      #
+      # @return [Hash] All rates as Hash
       attr_reader :oer_rates
 
       # Seconds after than the current rates are automatically expired
+      #
+      # @return [Integer] Setted time to live in seconds
       attr_reader :ttl_in_seconds
 
       # Set the seconds after than the current rates are automatically expired
@@ -76,7 +107,7 @@ class Money
       # for the free plan users.
       #
       # @example
-      #   source = 'USD'
+      #   oxr.source = 'USD'
       #
       # @param value [String] Currency code, ISO 3166-1 alpha-3
       #
@@ -88,12 +119,14 @@ class Money
       end
 
       # Get the base currency for all rates. By default, USD is used.
+      #
       # @return [String] base currency
       def source
         @source ||= OE_SOURCE
       end
 
       # Update all rates from openexchangerates JSON
+      #
       # @return [Array] Array of exchange rates
       def update_rates
         exchange_rates.each do |exchange_rate|
@@ -121,6 +154,7 @@ class Money
       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'
       #
@@ -133,6 +167,8 @@ class Money
       end
 
       # Expire rates when expired
+      #
+      # @return [NilClass, Time] nil if not expired or new expiration time
       def expire_rates
         return unless ttl_in_seconds
         return if rates_expiration > Time.now
@@ -142,6 +178,7 @@ class Money
 
       # Source url of openexchangerates
       # defined with app_id and secure_connection
+      #
       # @return [String] URL
       def source_url
         if source == OE_SOURCE
@@ -154,6 +191,7 @@ class Money
       protected
 
       # Latest url if no date given
+      #
       # @return [String] URL
       def oer_url
         if date
@@ -164,6 +202,7 @@ class Money
       end
 
       # Historical url generated from `date` attr_accessor
+      #
       # @return [String] URL
       def historical_url
         url = OER_HISTORICAL_URL
@@ -172,6 +211,7 @@ class Money
       end
 
       # Latest url
+      #
       # @return [String] URL
       def latest_url
         return SECURE_OER_URL if secure_connection
@@ -182,7 +222,7 @@ class Money
       # for the cache, or write to the cache file.
       #
       # @example
-      #   store_in_cache("{\"rates\": {\"AED\": 3.67304}}")
+      #   oxr.store_in_cache("{\"rates\": {\"AED\": 3.67304}}")
       #
       # @param text [String] String to cache
       # @return [String,Integer]
@@ -197,6 +237,8 @@ class Money
       end
 
       # Read from cache when exist
+      #
+      # @return [String] Raw string from file or cache proc
       def read_from_cache
         if cache.is_a?(Proc)
           cache.call(nil)
@@ -206,6 +248,7 @@ class Money
       end
 
       # Read from url
+      #
       # @return [String] JSON content
       def read_from_url
         raise NoAppId if app_id.nil? || app_id.empty?
@@ -215,7 +258,7 @@ class Money
       # Check validity of rates response only for store in cache
       #
       # @example
-      #   valid_rates?("{\"rates\": {\"AED\": 3.67304}}")
+      #   oxr.valid_rates?("{\"rates\": {\"AED\": 3.67304}}")
       #
       # @param [String] text is JSON content
       # @return [Boolean] valid or not
@@ -227,6 +270,7 @@ class Money
       end
 
       # Get expire rates, first from cache and then from url
+      #
       # @return [Hash] key is country code (ISO 3166-1 alpha-3) value Float
       def exchange_rates
         doc = JSON.parse(read_from_cache || read_from_url)
@@ -234,12 +278,14 @@ class Money
       end
 
       # Refresh expiration from now
-      # return [Time] new expiration time
+      #
+      # @return [Time] new expiration time
       def refresh_rates_expiration
         @rates_expiration = Time.now + ttl_in_seconds
       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'
       #
@@ -258,6 +304,7 @@ class Money
       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'
       #

data/lib/open_exchange_rates_bank/version.rb

@@ -2,5 +2,5 @@
 
 # Module for version constant
 module OpenExchangeRatesBank
-  VERSION = '0.6.1'.freeze
+  VERSION = '0.7.0'.freeze
 end

data/test/integration/Gemfile

@@ -1,2 +1,2 @@
-gem 'money'
-gem 'money-open-exchange-rates'
+gem 'money', '~> 6.7'
+gem 'money-open-exchange-rates', path: '../../'

data/test/integration/Gemfile.lock

@@ -1,22 +1,26 @@
+PATH
+  remote: ../../
+  specs:
+    money-open-exchange-rates (0.6.1)
+      monetize (~> 1.4)
+      money (~> 6.7)
+
 GEM
   specs:
     i18n (0.7.0)
-    json (1.8.3)
-    monetize (1.3.1)
-      money (~> 6.6)
-    money (6.6.1)
+    monetize (1.4.0)
+      money (~> 6.7)
+    money (6.7.1)
       i18n (>= 0.6.4, <= 0.7.0)
-    money-open-exchange-rates (0.4.0)
-      json (~> 1.8)
-      monetize (~> 1.3)
-      money (~> 6.6)
+      sixarm_ruby_unaccent (>= 1.1.1, < 2)
+    sixarm_ruby_unaccent (1.1.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  money
-  money-open-exchange-rates
+  money (~> 6.7)
+  money-open-exchange-rates!
 
 BUNDLED WITH
-   1.10.6
+   1.13.1

data/test/integration/api.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'money/bank/open_exchange_rates_bank'
+
+ERROR_MSG = 'Integration test failed!'.freeze
+cache_path = '/tmp/latest.json'
+to_currency = 'CAD'
+app_id = ENV['OXR_APP_ID']
+
+if app_id.nil? || app_id.empty?
+  puts 'OXR_APP_ID env var not set skipping integration tests'
+  exit 0
+end
+
+begin
+  puts 'OXR version', Money::Bank::OpenExchangeRatesBank::VERSION
+
+  oxr = Money::Bank::OpenExchangeRatesBank.new
+  oxr.cache = cache_path
+  oxr.app_id = app_id
+  oxr.update_rates
+  oxr.save_rates
+
+  Money.default_bank = oxr
+
+  cad_rate = Money.default_bank.get_rate('USD', to_currency)
+
+  json_to_currency = JSON.parse(File.read(cache_path))['rates'][to_currency]
+  puts 'JSON to_currency', json_to_currency
+  puts 'Money to_currency', cad_rate
+  # rubocop:disable Style/AndOr
+  json_to_currency == cad_rate or raise ERROR_MSG
+rescue
+  raise ERROR_MSG
+end

data/test/open_exchange_rates_bank_test.rb

@@ -176,24 +176,21 @@ describe Money::Bank::OpenExchangeRatesBank do
         subject.secure_connection = nil
         subject.source_url.must_equal historical_url
         subject.source_url.must_include 'http://'
-        subject.source_url.must_include 'api'
-        subject.source_url.must_include 'historical'
+        subject.source_url.must_include "/api/historical/#{subject.date}.json"
       end
 
       it 'should use the non-secure http url if secure_connection is false' do
         subject.secure_connection = false
         subject.source_url.must_equal historical_url
         subject.source_url.must_include 'http://'
-        subject.source_url.must_include 'api'
-        subject.source_url.must_include 'historical'
+        subject.source_url.must_include "/api/historical/#{subject.date}.json"
       end
 
       it 'should use the secure https url if secure_connection is true' do
         subject.secure_connection = true
         subject.source_url.must_equal historical_secure_url
         subject.source_url.must_include 'https://'
-        subject.source_url.must_include 'api'
-        subject.source_url.must_include 'historical'
+        subject.source_url.must_include "/api/historical/#{subject.date}.json"
       end
     end
 
@@ -210,24 +207,21 @@ describe Money::Bank::OpenExchangeRatesBank do
         subject.secure_connection = nil
         subject.source_url.must_equal source_url
         subject.source_url.must_include 'http://'
-        subject.source_url.must_include 'api'
-        subject.source_url.must_include 'latest'
+        subject.source_url.must_include '/api/latest.json'
       end
 
       it 'should use the non-secure http url if secure_connection is false' do
         subject.secure_connection = false
         subject.source_url.must_equal source_url
         subject.source_url.must_include 'http://'
-        subject.source_url.must_include 'api'
-        subject.source_url.must_include 'latest'
+        subject.source_url.must_include '/api/latest.json'
       end
 
       it 'should use the secure https url if secure_connection is true' do
         subject.secure_connection = true
         subject.source_url.must_equal source_secure_url
         subject.source_url.must_include 'https://'
-        subject.source_url.must_include 'api'
-        subject.source_url.must_include 'latest'
+        subject.source_url.must_include '/api/latest.json'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-open-exchange-rates
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Laurent Arnoud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-21 00:00:00.000000000 Z
+date: 2016-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -154,6 +140,7 @@ files:
 - test/data/latest.json
 - test/integration/Gemfile
 - test/integration/Gemfile.lock
+- test/integration/api.rb
 - test/open_exchange_rates_bank_test.rb
 - test/test_helper.rb
 homepage: http://github.com/spk/money-open-exchange-rates