money-transferwise-bank 0.1.1

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'rr'
+require 'money/bank/transferwise_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

data/test/transferwise_bank_test.rb

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+describe Money::Bank::TransferwiseBank do
+  subject { Money::Bank::TransferwiseBank.new }
+  let(:url) do
+    URI::HTTPS.build(
+      host: Money::Bank::TransferwiseBank::TW_SERVICE_HOST,
+      path: Money::Bank::TransferwiseBank::TW_SERVICE_PATH
+    )
+  end
+  let(:source) { Money::Bank::TransferwiseBank::TW_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, 'SSP') }
+          .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, 'SSP') }
+          .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_file { '' }
+      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_file { '{ "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_file { '{ 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 '#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 TransferwiseBank' do
+      subject.rates.each do |rate|
+        currency = rate['target']
+        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 +567
+      @new_usd_eur_rate = 0.890082
+      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_file { '' }
+      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

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: money-transferwise-bank
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mikel Kew
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: monetize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.9'
+- !ruby/object:Gem::Dependency
+  name: inch
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A gem that calculates the exchange rate using available rates from TransferWise.
+  Compatible with the money gem.
+email: mikel.j.kew@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/money/bank/transferwise_bank.rb
+- test/TEST_ACCESS_KEY
+- test/live.json
+- test/test_helper.rb
+- test/transferwise_bank_test.rb
+homepage: http://github.com/mikelkew/money-transferwise-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: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: A gem that calculates the exchange rate using available rates from TransferWise.
+test_files:
+- test/transferwise_bank_test.rb