historical-bank 0.1.0

data/spec/rates_provider/open_exchange_rates_spec.rb

@@ -0,0 +1,201 @@
+#
+# Copyright 2017 Skyscanner Limited.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# frozen_string_literal: true
+
+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(:url) { 'https://openexchangerates.org/api/time-series.json' }
+        let(:query) do
+          {
+            app_id: app_id,
+            base:   base_currency_iso_code,
+            start:  '2010-10-01',
+            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) }
+
+        context 'when date is before 1999' do
+          let(:date) { Faker::Date.between(Date.new(1900, 1, 1), Date.new(1998, 12, 31)) }
+          let(:status) { 200 }
+          let(:response_body) { '' }
+
+          it 'fails with ArgumentError' do
+            expect { subject }.to raise_error(ArgumentError)
+          end
+        end
+
+        context 'when date is in the future' do
+          let(:date) { Date.today + 2 }
+          let(:status) { 200 }
+          let(:response_body) { '' }
+
+          it 'fails with ArgumentError' do
+            expect { subject }.to raise_error(ArgumentError)
+          end
+        end
+
+        context 'when request fails' do
+          let(:status) { 400 }
+          let(:response_body) { '' }
+
+          it 'fails with RequestFailed' do
+            expect { subject }.to raise_error(RatesProvider::RequestFailed)
+          end
+        end
+
+        context 'when request succeeds' do
+          let(:status) { 200 }
+
+          context 'when previous months' do
+            context 'when full response' do
+              let(:base_currency_iso_code) { 'EUR' }
+              let(:date) { Date.new(2015, 9, 29) }
+              let(:query) do
+                {
+                  app_id: app_id,
+                  base:   base_currency_iso_code,
+                  start:  '2015-09-01',
+                  end:    '2015-09-30'
+                }
+              end
+              let(:response_body) { File.read('./spec/fixtures/time-series-2015-09.json') }
+
+              it 'returns correct rates' do
+                expect(subject['BZD']['2015-09-01']).to eq 2.25696.to_d
+                expect(subject['AED']['2015-09-05']).to eq 4.094833.to_d
+                expect(subject['QAR']['2015-09-12']).to eq 4.126591.to_d
+                expect(subject['GBP']['2015-09-15']).to eq 0.734509.to_d
+                expect(subject['USD']['2015-09-22']).to eq 1.112897.to_d
+                expect(subject['ZWL']['2015-09-30']).to eq 360.157304.to_d
+              end
+            end
+
+            context 'when partial response' do
+              let(:response_body) do
+                {
+                  start_date: '2010-10-01',
+                  end_date:   '2010-10-31',
+                  base:       base_currency_iso_code,
+                  rates: {
+                    '2010-10-02' => {
+                      'VND' => 1.1,
+                      'USD' => 2.1,
+                      'CAD' => 3.1,
+                      'CNY' => 4.1
+                    },
+                    '2010-10-03' => {
+                      'VND' => 1.2,
+                      'USD' => 2.2,
+                      'CAD' => 3.2,
+                      'CNY' => 4.2
+                    },
+                    '2010-10-04' => {
+                      'VND' => 1.3,
+                      'USD' => 2.3,
+                      'CAD' => 3.3,
+                      'CNY' => 4.3
+                    }
+                  }
+                }.to_json
+              end
+              let(:expected_result) do
+                {
+                  'VND' => {
+                    '2010-10-02' => 1.1.to_d,
+                    '2010-10-03' => 1.2.to_d,
+                    '2010-10-04' => 1.3.to_d
+                  },
+                  'USD' => {
+                    '2010-10-02' => 2.1.to_d,
+                    '2010-10-03' => 2.2.to_d,
+                    '2010-10-04' => 2.3.to_d
+                  },
+                  'CAD' => {
+                    '2010-10-02' => 3.1.to_d,
+                    '2010-10-03' => 3.2.to_d,
+                    '2010-10-04' => 3.3.to_d
+                  },
+                  'CNY' => {
+                    '2010-10-02' => 4.1.to_d,
+                    '2010-10-03' => 4.2.to_d,
+                    '2010-10-04' => 4.3.to_d
+                  }
+                }
+              end
+
+              it { is_expected.to eq expected_result }
+            end
+          end
+
+          context 'when current month' do
+            # we'll mock current time with Timecop
+            let(:now) { Time.new(2016, 9, 23, 12, 0, 0) }
+            let(:date) { Date.new(2016, 9, 12) }
+            let(:query) do
+              {
+                app_id: app_id,
+                base:   base_currency_iso_code,
+                start:  '2016-09-01',
+                  # yesterday is the max date
+                end:    '2016-09-22'
+              }
+            end
+            # doesn't matter, we're checking the query here
+            let(:response_body) do
+              {
+                rates: {}
+              }.to_json
+            end
+            #   {
+            #     start_date: yesterday_utc.at_beginning_of_month.iso8601,
+            #     end_date:   yesterday_utc.iso8601,
+            #     base:       base_currency_iso_code,
+            #     rates: {} # doesn't matter, we're checking the query here
+            #   }.to_json
+            # end
+
+            before { Timecop.travel(now) }
+            after { Timecop.return }
+
+            it 'sets the correct end date' do
+              subject
+              expect(a_request(:get, url).with(query: query)).to have_been_made.once
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/rates_store/historical_redis_spec.rb

@@ -0,0 +1,176 @@
+#
+# Copyright 2017 Skyscanner Limited.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class Money
+  module RatesStore
+    describe HistoricalRedis do
+      let(:redis_url) { "redis://localhost:#{ENV['REDIS_PORT']}" }
+      let(:redis) { Redis.new(port: ENV['REDIS_PORT']) }
+
+      let(:base_currency) { Currency.new('EUR') }
+      let(:namespace) { 'currency_test' }
+      let(:store) { HistoricalRedis.new(base_currency, redis_url, namespace) }
+      let(:key_prefix) { 'currency_test:EUR' }
+
+      let(:usd_date_rate_hash) do
+        {
+          '2015-09-10' => 0.11111.to_d,
+          '2015-09-11' => 0.22222.to_d,
+          '2015-09-12' => 0.33333.to_d
+        }
+      end
+      let(:currency_date_rate_hash) do
+        {
+          'USD' => usd_date_rate_hash,
+          'GBP' => {
+            '2015-09-10' => 0.44444.to_d,
+            '2015-09-11' => 0.55555.to_d,
+            '2015-09-12' => 0.66666.to_d
+          },
+          'VND' => {
+            '2015-09-10' => 0.77777.to_d,
+            '2015-09-11' => 0.88888.to_d,
+            '2015-09-12' => 0.99999.to_d
+          }
+        }
+      end
+
+      after do
+        keys = redis.keys("#{namespace}*")
+        redis.del(keys) unless keys.empty?
+      end
+
+      describe '#add_rates' do
+        let(:expected_stored_hash_usd) do
+          {
+            '2015-09-10' => 0.11111.to_d.to_s,
+            '2015-09-11' => 0.22222.to_d.to_s,
+            '2015-09-12' => 0.33333.to_d.to_s
+          }
+        end
+        let(:expected_stored_hash_gbp) do
+          {
+            '2015-09-10' => 0.44444.to_d.to_s,
+            '2015-09-11' => 0.55555.to_d.to_s,
+            '2015-09-12' => 0.66666.to_d.to_s
+          }
+        end
+        let(:expected_stored_hash_vnd) do
+          {
+            '2015-09-10' => 0.77777.to_d.to_s,
+            '2015-09-11' => 0.88888.to_d.to_s,
+            '2015-09-12' => 0.99999.to_d.to_s
+          }
+        end
+
+        subject { store.add_rates(currency_date_rate_hash) }
+
+        context 'when no rates exist' do
+          it 'should store the values' do
+            subject
+            expect(redis.hgetall("#{key_prefix}:USD")).to eq expected_stored_hash_usd
+            expect(redis.hgetall("#{key_prefix}:GBP")).to eq expected_stored_hash_gbp
+            expect(redis.hgetall("#{key_prefix}:VND")).to eq expected_stored_hash_vnd
+          end
+        end
+
+        context 'when some rates exist' do
+          let(:preexistent_rates) do
+            {
+              'USD' => {
+                '2015-09-10' => 0.12345.to_d,
+                '2015-09-11' => 0.09876.to_d
+              }
+            }
+          end
+
+          before do
+            store.add_rates(preexistent_rates)
+          end
+
+          it 'overwrites their values' do
+            expect { subject }.to change { redis.hgetall("#{key_prefix}:USD") }
+              .to(expected_stored_hash_usd)
+          end
+        end
+
+        context 'when there is a Redis error' do
+          let(:redis_url) { 'redis://localhost:1231' }
+
+          it 'fails with RequestFailed' do
+            expect { subject }.to raise_error(RatesStore::RequestFailed)
+          end
+        end
+
+        context 'when base currency is included in the given currencies' do
+          context 'and its rate is 1' do
+            let(:currency_date_rate_hash) do
+              {
+                base_currency.iso_code => { '2015-09-10' => 1.0 }
+              }
+            end
+
+            it 'does not fail' do
+              subject
+            end
+          end
+
+          context 'and its rate is not 1' do
+            let(:currency_date_rate_hash) do
+              {
+                base_currency.iso_code => { '2015-09-10' => 0.423 }
+              }
+            end
+
+            it 'fails with ArgumentError' do
+              expect { subject }.to raise_error(ArgumentError)
+            end
+          end
+        end
+      end
+
+      describe '#get_rates' do
+        let(:from_currency) { Currency.new('USD') }
+
+        subject { store.get_rates(from_currency) }
+
+        context 'when rates exist' do
+          before do
+            store.add_rates(currency_date_rate_hash)
+          end
+
+          it { is_expected.to eq usd_date_rate_hash }
+        end
+
+        context "when rates don't exist" do
+          it { is_expected.to eq({}) }
+        end
+
+        context 'when there is a Redis error' do
+          let(:redis_url) { 'redis://localhost:1231' }
+
+          it 'fails with RequestFailed' do
+            expect { subject }.to raise_error(RatesStore::RequestFailed)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+#
+# Copyright 2017 Skyscanner Limited.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# frozen_string_literal: true
+
+ENV['RACK_ENV'] ||= 'test'
+ENV['REDIS_PORT'] ||= '6390'
+
+require 'webmock/rspec'
+require 'faker'
+require 'timecop'
+require 'byebug'
+require 'money/bank/historical'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: historical-bank
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kostis Dadamis
+- Emili Parreno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-16 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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A `Money::Bank::Base` with historical exchange rates
+email:
+- kostis.dadamis@skyscanner.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- AUTHORS
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- examples/add_get_rates.rb
+- examples/exchange.rb
+- historical-bank.gemspec
+- lib/money/bank/historical.rb
+- lib/money/rates_provider/open_exchange_rates.rb
+- lib/money/rates_store/historical_redis.rb
+- spec/bank/historical_spec.rb
+- spec/fixtures/time-series-2015-09.json
+- spec/rates_provider/open_exchange_rates_spec.rb
+- spec/rates_store/historical_redis_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Skyscanner/historical-bank-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- redis
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Historical Bank
+test_files:
+- spec/bank/historical_spec.rb
+- spec/fixtures/time-series-2015-09.json
+- spec/rates_provider/open_exchange_rates_spec.rb
+- spec/rates_store/historical_redis_spec.rb
+- spec/spec_helper.rb