historical-bank 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 598c943f0debd7880311ebe7be452417b8482e7d
-  data.tar.gz: 85c1004279edde93a2a2e56b4c1fef411d98f273
+  metadata.gz: b15169c2eadfa1f282eae84a1e7a3f3d39fbc594
+  data.tar.gz: 4ede618d723202121b19e1628ca4d7ecaece734e
 SHA512:
-  metadata.gz: 0ce3fb2034576449270f62515454bfe48654c669f0696702358fe4fc5f0bb1c77e960c304c32d03d38267a8d3b8c3ed065691c2c11bb3b93b84ad1e1a265c7cf
-  data.tar.gz: 0b312998d80ceb7e1f9a0e464484aa11b2c96b0977185cbc9993b9d542a47a57390158c139888adc1b8eb38ea02df0183c2ebe4fcdc14bfdaabc4ef64ad70816
+  metadata.gz: 8e4a858d6f4180f9284c2d625951503e91c18263c4c09ded26cf68ea49107e9ab4eb06f622182f918c552509b4c917c25e8e14f564eb5396c1dc27d21148849c
+  data.tar.gz: bfdb8af5f044e55620ee125233325eda35218ee9ffadb63771be3a1198ec5ff5936551fe94d40ca42e63595dda16292524eebf4dbee4942e8e6074ad91c02f0b

data/CHANGELOG.md

@@ -2,3 +2,7 @@
 
 ## 0.1.0
 - Added basic functionality and documentation.
+
+## 0.1.1
+- Added support for FREE and DEVELOPER OpenExchangeRates accounts. Downside when using these accounts is that OER rates are fetched for a single day at a time (as opposed to a whole month for more advanced plans).
+- Developers have to specify `oer_account_type` during configuration.

data/README.md

@@ -1,12 +1,13 @@
 # historical-bank-ruby
 
+[![Gem Version](https://badge.fury.io/rb/historical-bank.svg)](https://badge.fury.io/rb/historical-bank)
 [![Build Status](https://travis-ci.org/Skyscanner/historical-bank-ruby.svg?branch=master)](https://travis-ci.org/Skyscanner/historical-bank-ruby)
 
 ## Description
 
 This gem provides a bank that can serve historical rates,
 contrary to most bank implementations that provide only current market rates.
-[Open Exchange Rates](https://openexchangerates.org/) (OER) is used as the provider of the rates and an Enterprise or Unlimited plan is required.
+[Open Exchange Rates](https://openexchangerates.org/) (OER) is used as the provider of the rates.
 As the HTTP requests to OER can add latency to your calls, a `RatesStore` (cache) based on Redis was added, making it super-fast.
 
 You can use it as your default bank and keep calling the standard `money` gem methods (`Money#exchange_to`, `Bank#exchange_with`). On top of that, we've added a few more methods that allow accessing historical rates (`Money#exchange_to_historical`, `Bank#exchange_with_historical`).
@@ -84,7 +85,7 @@ Don't worry, the bank is thread-safe!
 
 ## Requirements
 
-- **OpenExchangeRates Enterprise or Unlimited plan** - It is needed for calling the `/time-series.json` endpoint which serves historical rates.
+- **OpenExchangeRates account** - If on the Free or Developer plan, the `/historical/*.json` endpoint is used for fetching rates for single days. If on the Enterprise or Unlimited plan, the `/time-series.json` endpoint is used for fetching rates for whole months, increasing efficiency.
 - **Redis >= 2.8** (versions of Redis earlier than 2.8 may also work fine, but this gem has only been tested with 2.8 and above.)
 - **Ruby >= 2.0**
 
@@ -115,6 +116,10 @@ Money::Bank::Historical.configure do |config|
   # (required) your OpenExchangeRates App ID
   config.oer_app_id = 'XXXXXXXXXXXXXXX'
 
+  # (optional) account type on openexchangerate.org (default: 'Enterprise')
+  # replace 'FREE' with 'DEVELOPER', 'ENTERPRISE', or 'UNLIMITED', according to your account type.
+  config.oer_account_type = Money::RatesProvider::OpenExchangeRates::AccountType::FREE
+
   # (optional) currency relative to which all the rates are stored (default: EUR)
   config.base_currency = Money::Currency.new('USD')
 

data/historical-bank.gemspec

@@ -18,7 +18,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'historical-bank'
-  s.version     = '0.1.0'
+  s.version     = '0.1.1'
   s.summary     = 'Historical Bank'
   s.description = 'A `Money::Bank::Base` with historical exchange rates'
   s.authors     = ['Kostis Dadamis', 'Emili Parreno']

data/lib/money/bank/historical.rb

@@ -27,6 +27,7 @@ class Money
     class Historical < Bank::Base
       # Configuration class for +Money::Bank::Historical+
       class Configuration
+
         # +Money::Currency+ relative to which all exchange rates will be cached
         attr_accessor :base_currency
         # URL of the Redis server
@@ -37,6 +38,8 @@ class Money
         attr_accessor :oer_app_id
         # timeout to set in the OpenExchangeRates requests
         attr_accessor :timeout
+        # type of account on OpenExchangeRates, to know which API endpoints are useable
+        attr_accessor :oer_account_type
 
         def initialize
           @base_currency = Currency.new('EUR')
@@ -44,6 +47,7 @@ class Money
           @redis_namespace = 'currency'
           @oer_app_id = nil
           @timeout = 15
+          @oer_account_type = RatesProvider::OpenExchangeRates::AccountType::ENTERPRISE
         end
       end
 
@@ -54,6 +58,7 @@ class Money
 
       # Configures the bank. Parameters that can be configured:
       # - +oer_app_id+ - (required) your OpenExchangeRates App ID
+      # - +oer_account_type+ - (optional) your OpenExchangeRates account type. Choose one of the values in the +Money::RatesProvider::OpenExchangeRates::AccountType+ module (default: +Money::RatesProvider::OpenExchangeRates::AccountType::ENTERPRISE+)
       # - +base_currency+ - (optional) +Money::Currency+ relative to which all the rates are stored (default: EUR)
       # - +redis_url+ - (optional) the URL of the Redis server (default: +redis://localhost:6379+)
       # - +redis_namespace+ - (optional) Redis namespace to prefix all keys (default: +currency+)
@@ -63,6 +68,7 @@ class Money
       #
       #   Money::Bank::Historical.configure do |config|
       #     config.oer_app_id = 'XXXXXXXXXXXXXXXXXXXXX'
+      #     config.oer_account_type = Money::RatesProvider::OpenExchangeRates::AccountType::FREE
       #     config.base_currency = Money::Currency.new('USD')
       #     config.redis_url = 'redis://localhost:6379'
       #     config.redis_namespace = 'currency'
@@ -84,7 +90,8 @@ class Money
                                                  Historical.configuration.redis_namespace)
         @provider = RatesProvider::OpenExchangeRates.new(Historical.configuration.oer_app_id,
                                                          @base_currency,
-                                                         Historical.configuration.timeout)
+                                                         Historical.configuration.timeout,
+                                                         Historical.configuration.oer_account_type)
         # for controlling access to @rates
         @mutex = Mutex.new
       end
@@ -284,7 +291,7 @@ class Money
       end
 
       def fetch_provider_base_rate(currency, date)
-        currency_date_rate_hash = @provider.fetch_month_rates(date)
+        currency_date_rate_hash = @provider.fetch_rates(date)
 
         date_rate_hash = currency_date_rate_hash[currency.iso_code]
         rate = date_rate_hash && date_rate_hash[date.iso8601]

data/lib/money/rates_provider/open_exchange_rates.rb

@@ -36,26 +36,39 @@ class Money
       # (https://docs.openexchangerates.org/docs/historical-json)
       MIN_DATE = Date.new(1999, 1, 1).freeze
 
+      module AccountType
+        FREE = 'Free'.freeze
+        DEVELOPER = 'Developer'.freeze
+        ENTERPRISE = 'Enterprise'.freeze
+        UNLIMITED = 'Unlimited'.freeze
+      end
+
       # ==== Parameters
-      # - +oer_app_id+ - App ID for the OpenExchangeRates API access (Enterprise or Unlimited plan)
+      # - +oer_app_id+ - App ID for the OpenExchangeRates API access
       # - +base_currency+ - The base currency that will be used for the OER requests. It should be a +Money::Currency+ object.
       # - +timeout+ - The timeout in seconds to set on the requests
-      def initialize(oer_app_id, base_currency, timeout)
+      # - +oer_account_type+ - The OpenExchangeRates account type. Should be one of +AccountType::FREE+, +DEVELOPER+, +ENTERPRISE+, or +UNLIMITED+
+      def initialize(oer_app_id, base_currency, timeout, oer_account_type)
         @oer_app_id = oer_app_id
         @base_currency_code = base_currency.iso_code
         @timeout = timeout
+        @fetch_rates_method_name = if oer_account_type == AccountType::FREE || oer_account_type == AccountType::DEVELOPER
+          :fetch_historical_rates
+        else
+          :fetch_time_series_rates
+        end
       end
 
-      # Fetches the rates for all available quote currencies for a whole month.
+      # Fetches the rates for all available quote currencies (for given date or for a whole month, depending on openexchangerates.org account type).
       # Fetching for all currencies or just one has the same API charge.
-      # In addition, the API doesn't allow fetching more than a month's data.
       #
       # It returns a +Hash+ with the rates for each quote currency and date
       # as shown in the example. Rates are +BigDecimal+.
       #
       # ==== Parameters
       #
-      # - +date+ - +date+'s month is the month for which we request rates. Minimum +date+ is January 1st 1999, as defined by the OER API (https://docs.openexchangerates.org/docs/api-introduction). Maximum +date+ is yesterday (UTC), as today's rates are not final (https://openexchangerates.org/faq/#timezone).
+      # - +date+ - +date+ for which the rates are requested. Minimum +date+ is January 1st 1999, as defined by the OER API (https://docs.openexchangerates.org/docs/api-introduction). Maximum +date+ is yesterday (UTC), as today's rates are not final (https://openexchangerates.org/faq/#timezone).
+      #            If Enterprise or Unlimited account in openexchangerates.org, the +date+'s month is the month for which we request rates
       #
       # ==== Errors
       #
@@ -64,26 +77,19 @@ class Money
       #
       # ==== Examples
       #
-      #   oer.fetch_month_rates(Date.new(2016, 10, 5))
+      #   oer.fetch_rates(Date.new(2016, 10, 5))
+      #   If Free or Developer account in openexchangerates.org, it will return only for the given date
+      #   # => {"AED"=>{"2016-10-05"=>#<BigDecimal:7fa19a188e98,'0.3672682E1',18(36)>}, {"AFN"=>{"2016-10-05"=>#<BigDecimal:7fa19a188e98,'0.3672682E1',18(36)>}, ...
+      #   If Enterprise or Unlimited account, it will return for the entire month for the given date 
       #   # => {"AED"=>{"2016-10-01"=>#<BigDecimal:7fa19a188e98,'0.3672682E1',18(36)>, "2016-10-02"=>#<BigDecimal:7fa19b11a5c8,'0.367296E1',18(36)>, ...
-      def fetch_month_rates(date)
+      def fetch_rates(date)
         if date < MIN_DATE || date > max_date
           raise ArgumentError, "Provided date #{date} for OER query should be "\
                                "between #{MIN_DATE} and #{max_date}"
         end
 
-        end_of_month = Date.civil(date.year, date.month, -1)
-
-        start_date = Date.civil(date.year, date.month, 1)
-        end_date = [end_of_month, max_date].min
-
-        options = request_options(start_date, end_date)
-        response = self.class.get('/time-series.json', options)
+        response = send(@fetch_rates_method_name, date)
 
-        unless response.success?
-          raise RequestFailed, "Month rates request failed for #{date} - "\
-                               "Code: #{response.code} - Body: #{response.body}"
-        end
 
         result = Hash.new { |hash, key| hash[key] = {} }
 
@@ -99,14 +105,53 @@ class Money
         result
       end
 
+
       private
 
-      def request_options(start_date, end_date)
-        {
+      # the API doesn't allow fetching more than a month's data.
+      def fetch_time_series_rates(date)
+        options = request_options
+
+        end_of_month = Date.civil(date.year, date.month, -1)
+        start_date = Date.civil(date.year, date.month, 1)
+        end_date = [end_of_month, max_date].min
+        options[:query][:start] = start_date
+        options[:query][:end] = end_date
+
+        response = self.class.get('/time-series.json', options)
+
+        unless response.success?
+          raise RequestFailed, "Month rates request failed for #{date} - "\
+                               "Code: #{response.code} - Body: #{response.body}"
+        end
+        response        
+      end
+
+      def fetch_historical_rates(date)
+        date_string = date.iso8601
+        options = request_options
+        response = self.class.get("/historical/#{date_string}.json", options)
+
+        unless response.success?
+          raise RequestFailed, "Historical rates request failed for #{date} - "\
+                               "Code: #{response.code} - Body: #{response.body}"
+        end
+
+        # Making the return value comply to the same structure returned from the #fetch_month_rates method (/time-series.json API)
+        { 
+          'start_date' => date_string,
+          'end_date' => date_string,
+          'base' => response['base'],
+          'rates' => {
+            date_string => response['rates']
+          }
+        }
+      end
+
+      def request_options
+        options = {
           query: {
             app_id:  @oer_app_id,
-            start:   start_date,
-            end:     end_date,
             base:    @base_currency_code
           },
           timeout: @timeout

data/spec/bank/historical_spec.rb

@@ -228,7 +228,7 @@ class Money
           allow_any_instance_of(RatesStore::HistoricalRedis).to receive(:get_rates)
             .with(to_currency).and_return(to_currency_base_rates_store)
           allow_any_instance_of(RatesProvider::OpenExchangeRates)
-            .to receive(:fetch_month_rates).with(date).and_return(rates_provider)
+            .to receive(:fetch_rates).with(date).and_return(rates_provider)
         end
 
         subject { bank.exchange_with_historical(from_money, to_currency, datetime) }
@@ -421,7 +421,7 @@ class Money
           before do
             # unstub and let it blow up
             allow_any_instance_of(RatesProvider::OpenExchangeRates)
-              .to receive(:fetch_month_rates).and_call_original
+              .to receive(:fetch_rates).and_call_original
           end
 
           it 'fails' do

data/spec/rates_provider/open_exchange_rates_spec.rb

@@ -21,13 +21,58 @@ require 'spec_helper'
 class Money
   module RatesProvider
     describe OpenExchangeRates do
-      describe '#fetch_month_rates' do
-        let(:base_currency_iso_code) { %w(GBP EUR USD).sample }
-        let(:base_currency) { Currency.wrap(base_currency_iso_code) }
-        let(:date) { Date.new(2010, 10, 10) }
-        let(:app_id) { SecureRandom.hex }
-        let(:timeout) { 15 }
-        let(:provider) { OpenExchangeRates.new(app_id, base_currency, timeout) }
+      let(:base_currency_iso_code) { %w(GBP EUR USD).sample }
+      let(:base_currency) { Currency.wrap(base_currency_iso_code) }
+      let(:date) { Date.new(2010, 10, 10) }
+      let(:app_id) { SecureRandom.hex }
+      let(:timeout) { 15 }
+      let(:response_headers) { { 'Content-Type' => 'application/json; charset=utf-8' } }
+
+      describe '#fetch_rates with FREE account' do
+        let(:provider) { OpenExchangeRates.new(app_id, base_currency, timeout, OpenExchangeRates::AccountType::FREE) }
+        let(:url) { 'https://openexchangerates.org/api/historical/2010-10-01.json' }
+        let(:date) { Date.new(2010, 10, 01) }
+        let(:query) do
+          {
+            app_id: app_id,
+            base:   base_currency_iso_code,
+          }
+        end
+
+        before do
+          stub_request(:get, url).with(query: query)
+                                 .to_return(status: status, body: response_body, headers: response_headers)
+        end
+
+        subject { provider.fetch_rates(date) }
+
+        context 'when request succeeds' do
+          let(:status) { 200 }
+          let(:base_currency_iso_code) { 'USD' }
+          let(:response_body) { File.read('./spec/fixtures/historical-2010-10-01.json') }
+
+          it 'format response similar to the full-month/time-series response' do
+            expect(subject.keys =~ ['base', 'rates', 'start_date', 'end_date'])
+          end
+
+          it 'return rates only for given date' do
+            dates = subject.map { |country, dates_hash| dates_hash.keys }.flatten.uniq
+            expect(dates.size == 1)
+            expect(dates.first == '2010-10-01')
+          end
+
+          it 'returns correct rates' do
+            expect(subject['VND']['2010-10-01']).to eq 19474.963646.to_d
+            expect(subject['EUR']['2010-10-01']).to eq 0.726556.to_d
+            expect(subject['CAD']['2010-10-01']).to eq 1.022502.to_d
+            expect(subject['CNY']['2010-10-01']).to eq 6.691335.to_d
+          end
+        end
+      end
+      
+
+      describe '#fetch_rates with UNLIMITED account' do
+        let(:provider) { OpenExchangeRates.new(app_id, base_currency, timeout, OpenExchangeRates::AccountType::UNLIMITED) }
         let(:url) { 'https://openexchangerates.org/api/time-series.json' }
         let(:query) do
           {
@@ -37,14 +82,13 @@ class Money
             end:    '2010-10-31'
           }
         end
-        let(:response_headers) { { 'Content-Type' => 'application/json; charset=utf-8' } }
 
         before do
           stub_request(:get, url).with(query: query)
                                  .to_return(status: status, body: response_body, headers: response_headers)
         end
 
-        subject { provider.fetch_month_rates(date) }
+        subject { provider.fetch_rates(date) }
 
         context 'when date is before 1999' do
           let(:date) { Faker::Date.between(Date.new(1900, 1, 1), Date.new(1998, 12, 31)) }
@@ -195,6 +239,8 @@ class Money
             end
           end
         end
+        
+
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: historical-bank
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kostis Dadamis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-16 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money