currency_cloud 0.12.5 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b8d9b8ee2c5e1ca902791d041aa7600bc4563f5f311e06db860ecbc6fdab0c4
-  data.tar.gz: 47131c437ff8989a7e97eaab55f2bec5c89b94318d5fadf36bb3102d04ef3640
+  metadata.gz: 6efa7b769f16b04b941b9f3b1990c78f4273cbf8cdd54b19b9851f85f1d76357
+  data.tar.gz: 6dfb96ea6e380647ec3eb5083dfa4d174dda50ad0bfb2619d28e7e7878f47a4e
 SHA512:
-  metadata.gz: 71633d7f655e6f4833ba6d628c5fbab44933ad5eed7fa34488e32d301c6a99c064fcfc180b3c93e470e5502d0ac4b1716ca7e74320d1e10ae90ed0402d33f496
-  data.tar.gz: 02b7afefe55c14578b8d3b8865341d1907bd47e7b551b08032449fd33ecd213045eb722c75e1af1b3c4993f5ce3452aaf22826520169b4545beab28d2e9bd790
+  metadata.gz: 98d4f5311d45853d0e3fec905c6030af279f187032db13943f0ddd9be45301556c78189e87dce869408f0eecfbf067da3e6b4ebf9240ee3ebcabb0062983936f
+  data.tar.gz: 0ff09b593d7f81ca3c11f2bd00c0f6386584ab07fa0e93f6069a4759400a2ea65155301e715f4276436269ef9b766ad5e25e55ba16ea2cd99313c5d2fac20382

data/README.md

@@ -16,13 +16,18 @@ you just want to use the library in your application, you should run:
 If you want to build the gem from source:
 
   `gem build currency_cloud.gemspec`
+  
+## Deprecation Announcement
+
+October 2020: Please be aware that __Ruby 1.9__ is now deprecated, it will not be supported from January 2021.  
+Please upgrade to a supported, secure version of Ruby, listed below.  
+
 
 ## Supported Ruby versions
 
 This library aims to support and is [tested against][travis] the following Ruby
 implementations:
 
-* MRI 1.9.3
 * MRI 2.0.0
 * MRI 2.1.0
 * MRI 2.2.0

data/currency_cloud.gemspec

@@ -13,11 +13,17 @@ Gem::Specification.new do |s|
   s.licenses = ['MIT']
   s.required_ruby_version = '>= 1.9'
 
-  s.add_dependency('httparty', '0.14.0')
-  s.add_dependency('json', '>= 1.8')
+  s.add_dependency('httparty', '~> 0.14')
+
+  if RUBY_VERSION == '1.9.3'
+    s.add_dependency('json', '>= 1.8', '<= 2.2')
+    s.add_development_dependency('rake', '~> 10.3')
+  else
+    s.add_dependency('json', '~> 2.3')
+    s.add_development_dependency('rake', '~> 12.3.3')
+  end
 
   s.add_development_dependency('addressable', '<= 2.4.0')
-  s.add_development_dependency('rake', '~> 10.3')
   s.add_development_dependency('rspec', '~> 3.1')
   s.add_development_dependency('vcr', '~> 3.0.3')
   s.add_development_dependency('webmock', '~> 2.3.2')

data/lib/currency_cloud/balance.rb

@@ -8,5 +8,10 @@ module CurrencyCloud
     def self.currency(ccy)
       new(client.get(ccy))
     end
+
+    def self.top_up_margin(params)
+      top_up = client.post("top_up_margin", params)
+      MarginBalanceTopUp.new(top_up)
+    end
   end
 end

data/lib/currency_cloud/funding_account.rb

@@ -0,0 +1,8 @@
+module CurrencyCloud
+  class FundingAccount
+    include CurrencyCloud::Resource
+
+    resource :funding_accounts
+    actions :find
+  end
+end

data/lib/currency_cloud/margin_balance_top_up.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class MarginBalanceTopUp
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/payment.rb

@@ -24,5 +24,15 @@ module CurrencyCloud
       result = client.get("payment_delivery_date", params)
       PaymentDeliveryDateResult.new(result)
     end
+
+    def self.quote_payment_fee(params)
+      result = client.get("quote_payment_fee", params)
+      QuotePaymentFee.new(result)
+    end
+
+    def self.tracking_info(id)
+      result = client.get("#{id}/tracking_info")
+      PaymentTrackingInfo.new(result)
+    end
   end
 end

data/lib/currency_cloud/payment_fee_rule.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class PaymentFeeRule
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/payment_tracking_info.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class PaymentTrackingInfo
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/quote_payment_fee.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class QuotePaymentFee
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/reference.rb

@@ -43,5 +43,10 @@ module CurrencyCloud
       BankDetails.new(bank_details)
     end
 
+    def self.payment_fee_rules(params = {})
+      response = client.get('payment_fee_rules', params)
+      response['payment_fee_rules'].map { |s| PaymentFeeRule.new(s) }
+    end
+
   end
 end

data/lib/currency_cloud/version.rb

@@ -1,6 +1,6 @@
 # Separate Gem version from 'API version'
 
 module CurrencyCloud
-  API_VERSION = 'v2'.freeze # API Version
-  VERSION = '0.12.5'.freeze # Gem Version
+  API_VERSION = "v2".freeze # API Version
+  VERSION = "1.0.3".freeze # Gem Version
 end

data/lib/currency_cloud/withdrawal_account.rb

@@ -0,0 +1,17 @@
+module CurrencyCloud
+  class WithdrawalAccount
+    include CurrencyCloud::Resource
+
+    resource :withdrawal_accounts
+
+    def self.find(params = {})
+      result = client.get("/", params)
+      WithdrawalAccounts.new(:withdrawal_accounts, self, result)
+    end
+
+    def self.pull_funds(withdrawal_account_id, params = {})
+      result = client.post("#{withdrawal_account_id}/pull_funds", params)
+      WithdrawalAccountFunds.new(result)
+    end
+  end
+end

data/lib/currency_cloud/withdrawal_account_funds.rb

@@ -0,0 +1,5 @@
+module CurrencyCloud
+  class WithdrawalAccountFunds
+    include CurrencyCloud::Resource
+  end
+end

data/lib/currency_cloud/withdrawal_accounts.rb

@@ -0,0 +1,6 @@
+require "currency_cloud/resourceful_collection"
+
+module CurrencyCloud
+  class WithdrawalAccounts < CurrencyCloud::ResourcefulCollection
+  end
+end

data/spec/integration/actions_spec.rb

@@ -126,4 +126,15 @@ describe 'Actions', vcr: true do
     expect(balance.created_at).to eq('2014-12-04T09:50:35+00:00')
     expect(balance.updated_at).to eq('2015-03-23T14:33:37+00:00')
   end
+
+  it 'can top up margin balance' do
+    top_up = CurrencyCloud::Balance.top_up_margin(currency: 'GBP', amount: 450)
+
+    expect(top_up).to be_a_kind_of(CurrencyCloud::MarginBalanceTopUp)
+
+    expect(top_up.account_id).to eq('6c046c51-2387-4004-8e87-4bf97102e36d')
+    expect(top_up.transferred_amount).to eq('450.0')
+    expect(top_up.currency).to eq('GBP')
+    expect(top_up.transfer_completed_at).to eq('2007-11-19T08:37:48-06:00')
+  end
 end

data/spec/integration/funding_account_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe "FundingAccounts", vcr: true do
+  before do
+    CurrencyCloud.login_id = "development@currencycloud.com"
+    CurrencyCloud.api_key = "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
+    CurrencyCloud.environment = :demonstration
+    CurrencyCloud.reset_session
+  end
+  it 'can #find' do
+
+    accounts = CurrencyCloud::FundingAccount.find(currency: 'GBP', per_page: 5)
+    expect(accounts.length).to eq 1
+
+    account = accounts[0]
+    expect(account).to be_a(CurrencyCloud::FundingAccount)
+    expect(account.id).to eq "b7981972-8e29-485b-8a4a-9643fc6ae3sa"
+    expect(account.account_id).to eq "8d98bdc8-e8e3-47dc-bd08-3dd0f4f7ea7b"
+    expect(account.account_number).to eq "012345678"
+    expect(account.account_number_type).to eq "account_number"
+    expect(account.account_holder_name).to eq "Jon Doe"
+    expect(account.bank_name).to eq "Starling"
+    expect(account.bank_address).to eq "3rd floor, 2 Finsbury Avenue, London, EC2M 2PP, GB"
+    expect(account.bank_country).to eq "UK"
+    expect(account.currency).to eq "GBP"
+    expect(account.payment_type).to eq "regular"
+    expect(account.routing_code).to eq "010203"
+    expect(account.routing_code_type).to eq "sort_code"
+    expect(account.created_at).to eq "2018-05-14T14:18:30+00:00"
+    expect(account.updated_at).to eq "2018-05-14T14:19:30+00:00"
+  end
+
+end

data/spec/integration/payments_spec.rb

@@ -94,4 +94,32 @@ describe 'Payments', vcr: true do
     expect(result.currency).to eq('GBP')
     expect(result.bank_country).to eq('GB')
   end
+
+  it "can retrieve #quote_payment_fee" do
+    quote_payment_fee = CurrencyCloud::Payment.quote_payment_fee(payment_date: "2019-06-07", payment_type: "regular", currency: "GBP", bank_country: "GB")
+
+    expect(quote_payment_fee).to_not be_nil
+    expect(quote_payment_fee.account_id).to eq("0534aaf2-2egg-0134-2f36-10b11cd33cfb")
+    expect(quote_payment_fee.fee_amount).to eq("10.00")
+    expect(quote_payment_fee.fee_currency).to eq("EUR")
+    expect(quote_payment_fee.payment_currency).to eq("USD")
+    expect(quote_payment_fee.payment_destination_country).to eq("US")
+    expect(quote_payment_fee.payment_type).to eq("regular")
+    expect(quote_payment_fee.charge_type).to be_nil
+  end
+
+  it "can retrieve #payment_tracking_info" do
+    payment_tracking_info = CurrencyCloud::Payment.tracking_info("46ed4827-7b6f-4491-a06f-b548d5a7512d")
+
+    expect(payment_tracking_info).to be_a(CurrencyCloud::PaymentTrackingInfo)
+    expect(payment_tracking_info.uetr).to eq("46ed4827-7b6f-4491-a06f-b548d5a7512d")
+    expect(payment_tracking_info.transaction_status["status"]).to eq("processing")
+    expect(payment_tracking_info.transaction_status["reason"]).to eq("transferred_and_tracked")
+    expect(payment_tracking_info.initiation_time).to eq("2019-07-09T13:20:30+00:00")
+    expect(payment_tracking_info.completion_time).to be_nil
+    expect(payment_tracking_info.last_update_time).to eq("2019-07-10T15:39:08+00:00")
+    expect(payment_tracking_info.payment_events.length).to eq(7)
+    expect(payment_tracking_info.payment_events[6]["tracker_event_type"]).to eq("customer_credit_transfer_payment")
+    expect(payment_tracking_info.payment_events[6]["instructed_amount"]["amount"]).to eq("745437.57")
+  end
 end

data/spec/integration/rates_spec.rb

@@ -36,4 +36,12 @@ describe 'Rates', vcr: true do
     expect(detailed_rate.client_sell_amount).to eq('15234.00')
     expect(detailed_rate.settlement_cut_off_time).to eq('2015-04-29T14:00:00Z')
   end
+
+  it 'can provided #detailed rate with conversion date preference' do
+    detailed_rate = CurrencyCloud::Rate.detailed(buy_currency: 'GBP', sell_currency: 'USD', fixed_side: 'buy', amount: '10000', conversion_date_preference: 'optimize_liquidity')
+
+    expect(detailed_rate).to be_a_kind_of(CurrencyCloud::Rate)
+    expect(detailed_rate.client_sell_amount).to eq('14081.00')
+    expect(detailed_rate.settlement_cut_off_time).to eq('2020-05-21T14:00:00Z')
+  end
 end

data/spec/integration/reference_spec.rb

@@ -24,9 +24,11 @@ describe 'Reference', vcr: true do
 
     expect(dates.invalid_conversion_dates).to_not be_empty
     invalid_conversion_date = dates.invalid_conversion_dates.first
-    expect(invalid_conversion_date).to eq(['2018-07-21', 'No trading on Saturday'])
-    expect(dates.first_conversion_date).to eq('2018-07-16')
-    expect(dates.default_conversion_date).to eq('2018-07-18')
+    expect(invalid_conversion_date).to eq(["2020-11-11", "Veterans' Day"])
+    expect(dates.first_conversion_date).to eq("2020-11-10")
+    expect(dates.default_conversion_date).to eq("2020-11-12")
+    expect(dates.first_conversion_cutoff_datetime).to eq("2020-11-10T15:30:00+00:00")
+    expect(dates.optimize_liquidity_conversion_date).to eq("2020-11-12")
   end
 
   it 'can retrieve #currencies' do
@@ -95,4 +97,51 @@ describe 'Reference', vcr: true do
     expect(details.bank_country_ISO).to eq('GB')
     expect(details.currency).to be_nil
   end
+
+  it 'can retrieve #payment_fee_rules' do
+    payment_fee_rules1 = CurrencyCloud::Reference.payment_fee_rules()
+    expect(payment_fee_rules1.size).to eq(3)
+
+    fee_rule1_1 = payment_fee_rules1[0]
+    expect(fee_rule1_1).to be_a(CurrencyCloud::PaymentFeeRule)
+    expect(fee_rule1_1.charge_type).to eq('shared')
+    expect(fee_rule1_1.fee_amount).to eq('2.00')
+    expect(fee_rule1_1.fee_currency).to eq('AED')
+    expect(fee_rule1_1.payment_type).to eq('priority')
+
+    fee_rule1_2 = payment_fee_rules1[1]
+    expect(fee_rule1_2).to be_a(CurrencyCloud::PaymentFeeRule)
+    expect(fee_rule1_2.charge_type).to eq('shared')
+    expect(fee_rule1_2.fee_amount).to eq('12.00')
+    expect(fee_rule1_2.fee_currency).to eq('USD')
+    expect(fee_rule1_2.payment_type).to eq('regular')
+
+    fee_rule1_3 = payment_fee_rules1[2]
+    expect(fee_rule1_3).to be_a(CurrencyCloud::PaymentFeeRule)
+    expect(fee_rule1_3.charge_type).to eq('ours')
+    expect(fee_rule1_3.fee_amount).to eq('5.25')
+    expect(fee_rule1_3.fee_currency).to eq('GBP')
+    expect(fee_rule1_3.payment_type).to eq('priority')
+
+    payment_fee_rules2 = CurrencyCloud::Reference.payment_fee_rules(payment_type: 'regular')
+    expect(payment_fee_rules2.size).to eq(1)
+
+    fee_rule2_1 = payment_fee_rules2[0]
+    expect(fee_rule2_1).to be_a(CurrencyCloud::PaymentFeeRule)
+    expect(fee_rule2_1.charge_type).to eq('shared')
+    expect(fee_rule2_1.fee_amount).to eq('12.00')
+    expect(fee_rule2_1.fee_currency).to eq('USD')
+    expect(fee_rule2_1.payment_type).to eq('regular')
+
+    payment_fee_rules3 = CurrencyCloud::Reference.payment_fee_rules(charge_type: 'ours')
+    expect(payment_fee_rules3.size).to eq(1)
+
+    fee_rule3_1 = payment_fee_rules3[0]
+    expect(fee_rule3_1).to be_a(CurrencyCloud::PaymentFeeRule)
+    expect(fee_rule3_1.charge_type).to eq('ours')
+    expect(fee_rule3_1.fee_amount).to eq('5.25')
+    expect(fee_rule3_1.fee_currency).to eq('GBP')
+    expect(fee_rule3_1.payment_type).to eq('priority')
+  end
+
 end

data/spec/integration/withdrawal_accounts_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe "WithdrawalAccounts", vcr: true do
+  before do
+    CurrencyCloud.login_id = "development@currencycloud.com"
+    CurrencyCloud.api_key = "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
+    CurrencyCloud.environment = :demonstration
+    CurrencyCloud.reset_session
+  end
+
+  it "can find #withdrawal_accounts" do
+    withdrawal_accounts = CurrencyCloud::WithdrawalAccount.find(
+        account_id: "72970a7c-7921-431c-b95f-3438724ba16f"
+    )
+    expect(withdrawal_accounts.length).to eq(1)
+
+    withdrawal_account = withdrawal_accounts[0]
+    expect(withdrawal_account).to be_a(CurrencyCloud::WithdrawalAccount)
+    expect(withdrawal_account.id).to eq("0886ac00-6ab6-41a6-b0e1-8d3faf2e0de2")
+    expect(withdrawal_account.account_name).to eq("currencycloud")
+    expect(withdrawal_account.account_holder_name).to eq("The Currency Cloud")
+    expect(withdrawal_account.account_holder_dob).to be_nil
+    expect(withdrawal_account.routing_code).to eq("123456789")
+    expect(withdrawal_account.account_number).to eq("01234567890")
+    expect(withdrawal_account.currency).to eq("USD")
+    expect(withdrawal_account.account_id).to eq("72970a7c-7921-431c-b95f-3438724ba16f")
+  end
+
+  it "can find #withdrawal_accounts2" do
+    withdrawal_accounts = CurrencyCloud::WithdrawalAccount.find()
+    expect(withdrawal_accounts.length).to eq(2)
+
+    withdrawal_account1 = withdrawal_accounts[0]
+    expect(withdrawal_account1).to be_a(CurrencyCloud::WithdrawalAccount)
+    expect(withdrawal_account1.id).to eq("0886ac00-6ab6-41a6-b0e1-8d3faf2e0de2")
+    expect(withdrawal_account1.account_name).to eq("currencycloud")
+    expect(withdrawal_account1.account_holder_name).to eq("The Currency Cloud")
+    expect(withdrawal_account1.account_holder_dob).to be_nil
+    expect(withdrawal_account1.routing_code).to eq("123456789")
+    expect(withdrawal_account1.account_number).to eq("01234567890")
+    expect(withdrawal_account1.currency).to eq("USD")
+    expect(withdrawal_account1.account_id).to eq("72970a7c-7921-431c-b95f-3438724ba16f")
+
+    withdrawal_account2 = withdrawal_accounts[1]
+    expect(withdrawal_account2).to be_a(CurrencyCloud::WithdrawalAccount)
+    expect(withdrawal_account2.id).to eq("0886ac00-6ab6-41a6-b0e1-8d3faf2e0de3")
+    expect(withdrawal_account2.account_name).to eq("currencycloud2")
+    expect(withdrawal_account2.account_holder_name).to eq("The Currency Cloud 2")
+    expect(withdrawal_account2.account_holder_dob).to eq("1990-07-20")
+    expect(withdrawal_account2.routing_code).to eq("223456789")
+    expect(withdrawal_account2.account_number).to eq("01234567892")
+    expect(withdrawal_account2.currency).to eq("GBP")
+    expect(withdrawal_account2.account_id).to eq("72970a7c-7921-431c-b95f-3438724ba16e")
+  end
+
+  it "can pull funds" do
+    withdrawal_account_funds = CurrencyCloud::WithdrawalAccount.pull_funds(
+        "0886ac00-6ab6-41a6-b0e1-8d3faf2e0de2",
+        reference: "PullFunds1",
+        amount: 100.0
+    )
+    expect(withdrawal_account_funds).to be_a(CurrencyCloud::WithdrawalAccountFunds)
+    expect(withdrawal_account_funds.id).to eq("e2e6b7aa-c9e8-4625-96a6-b97d4baab758")
+    expect(withdrawal_account_funds.withdrawal_account_id).to eq("0886ac00-6ab6-41a6-b0e1-8d3faf2e0de2")
+    expect(withdrawal_account_funds.reference).to eq("PullFunds1")
+    expect(withdrawal_account_funds.amount).to eq("100.00")
+    expect(withdrawal_account_funds.created_at).to eq("2020-06-29T08:02:31+00:00")
+  end
+end

data/spec/support/vcr_cassettes/Accounts/can_retrieve_account_payment_charges_settings.yml

@@ -8,7 +8,7 @@ http_interactions:
         string: login_id=development%40currencycloud.com&api_key=deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef
       headers:
         User-Agent:
-          - CurrencyCloudSDK/2.0 Ruby/0.9.0
+          - CurrencyCloudSDK/2.0 Ruby/1.0.3
     response:
       status:
         code: 200
@@ -58,7 +58,7 @@ http_interactions:
         X-Auth-Token:
           - deadbeefdeadbeefdeadbeefdeadbeef
         User-Agent:
-          - CurrencyCloudSDK/2.0 Ruby/0.9.0
+          - CurrencyCloudSDK/2.0 Ruby/1.0.3
     response:
       status:
         code: 200

data/spec/support/vcr_cassettes/Accounts/can_update_account_payment_charges_settings.yml

@@ -8,7 +8,7 @@ http_interactions:
         string: login_id=development%40currencycloud.com&api_key=deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef
       headers:
         User-Agent:
-          - CurrencyCloudSDK/2.0 Ruby/0.9.0
+          - CurrencyCloudSDK/2.0 Ruby/1.0.3
     response:
       status:
         code: 200
@@ -58,7 +58,7 @@ http_interactions:
         X-Auth-Token:
           - deadbeefdeadbeefdeadbeefdeadbeef
         User-Agent:
-          - CurrencyCloudSDK/2.0 Ruby/0.9.0
+          - CurrencyCloudSDK/2.0 Ruby/1.0.3
     response:
       status:
         code: 200