currency_cloud 0.5

data/lib/currency_cloud/version.rb

@@ -0,0 +1,8 @@
+# Separate Gem version from 'API version'
+
+module CurrencyCloud
+
+  ApiVersion = 'v2' # API Version
+  Version = '0.5' # Gem Version  
+
+end

data/spec/currency_cloud_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe CurrencyCloud do
+
+  before(:each) do
+    CurrencyCloud.environment = nil
+    CurrencyCloud.login_id = nil
+    CurrencyCloud.api_key = nil
+    CurrencyCloud.reset_session
+  end
+
+  describe "#environment" do
+
+    it "can set the environment" do
+      CurrencyCloud.environment = :development
+      expect(CurrencyCloud.environment).to eq(:development)
+    end
+
+  end
+
+  describe "#login_id" do
+
+    it "can set the login_id" do
+      CurrencyCloud.login_id = 'test@example.com'
+      expect(CurrencyCloud.login_id).to eq('test@example.com')
+    end
+
+  end
+
+  describe "#api_key" do
+
+    it "can set the api_key" do
+      CurrencyCloud.api_key = 'e3b0d6895f91f46d9eaf5c95aa0f64dca9007b7ab0778721b6cdc0a8bc7c563b'
+      expect(CurrencyCloud.api_key).to eq('e3b0d6895f91f46d9eaf5c95aa0f64dca9007b7ab0778721b6cdc0a8bc7c563b')
+    end
+
+  end
+
+  describe "#session" do
+
+    it "returns a session object" do
+      CurrencyCloud.environment = :demonstration
+      CurrencyCloud.login_id = 'test@example.com'
+      CurrencyCloud.api_key = 'e3b0d6895f91f46d9eaf5c95aa0f64dca9007b7ab0778721b6cdc0a8bc7c563b'
+
+      request_handler = double('RequestHandler')
+      expect(request_handler).to receive(:post).and_return({'auth_token' => '123'})
+      expect(CurrencyCloud::RequestHandler).to receive(:new).and_return(request_handler)
+
+      expect(CurrencyCloud.session).to be_a(CurrencyCloud::Session)
+    end
+
+    it "raises an error if the environment is not set" do
+      CurrencyCloud.environment = nil
+      expect { CurrencyCloud.session }
+       .to raise_error(CurrencyCloud::ConfigError, "'' is not a valid environment, must be one of: production, demonstration, uat")
+    end
+
+    it "raises an error if the environment is invalid" do
+      CurrencyCloud.environment = :invalid
+      expect { CurrencyCloud.session }
+       .to raise_error(CurrencyCloud::ConfigError, "'invalid' is not a valid environment, must be one of: production, demonstration, uat")
+    end
+
+    it "raises an error if the login_id is not set" do
+      CurrencyCloud.environment = :demonstration
+      expect { CurrencyCloud.session }
+       .to raise_error(CurrencyCloud::ConfigError, "login_id must be set using CurrencyCloud.login_id=")
+    end
+
+    it "raises an error if the api_key is not set" do
+      CurrencyCloud.environment = :demonstration
+      CurrencyCloud.login_id = 'test@example.com'
+      expect { CurrencyCloud.session }
+       .to raise_error(CurrencyCloud::ConfigError, "api_key must be set using CurrencyCloud.api_key=")
+    end
+  end
+end

data/spec/integration/actions_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe 'Actions', :vcr => true do
+  before do
+    CurrencyCloud.reset_session
+    CurrencyCloud.environment = :demonstration
+    CurrencyCloud.token = '4df5b3e5882a412f148dcd08fa4e5b73'
+  end
+
+  it "can #create" do
+    params = {
+      :bank_account_holder_name => 'Test User',
+      :bank_country => 'GB',
+      :currency => 'GBP',
+      :name => 'Test User',
+      :account_number => '12345678',
+      :routing_code_type_1 => 'sort_code',
+      :routing_code_value_1 => '123456',
+      :payment_types => ['regular']
+    }
+
+    beneficiary = CurrencyCloud::Beneficiary.create(params)
+    expect(beneficiary).to be_a_kind_of(CurrencyCloud::Beneficiary)
+
+    expect(beneficiary.id).to eq('081596c9-02de-483e-9f2a-4cf55dcdf98c')
+    expect(beneficiary.bank_account_holder_name).to eq('Test User')
+    expect(beneficiary.payment_types).to include('regular')
+    expect(beneficiary.created_at).to eq('2015-04-25T09:21:00+00:00')
+    expect(beneficiary.updated_at).to eq('2015-04-25T09:21:00+00:00')
+  end
+
+  it "can #retrieve" do
+    beneficiary = CurrencyCloud::Beneficiary.retrieve('081596c9-02de-483e-9f2a-4cf55dcdf98c')
+    expect(beneficiary).to be_a_kind_of(CurrencyCloud::Beneficiary)
+
+    expect(beneficiary.id).to eq('081596c9-02de-483e-9f2a-4cf55dcdf98c')
+    expect(beneficiary.bank_account_holder_name).to eq('Test User')
+    expect(beneficiary.payment_types).to include('regular')
+    expect(beneficiary.created_at).to eq('2015-04-25T09:21:00+00:00')
+    expect(beneficiary.updated_at).to eq('2015-04-25T09:21:00+00:00')
+  end
+
+  it "can #first" do
+    beneficiary = CurrencyCloud::Beneficiary.first(:bank_account_holder_name => 'Test User')
+    expect(beneficiary).to be_a_kind_of(CurrencyCloud::Beneficiary)
+
+    expect(beneficiary.id).to eq('081596c9-02de-483e-9f2a-4cf55dcdf98c')
+    expect(beneficiary.bank_account_holder_name).to eq('Test User')
+    expect(beneficiary.payment_types).to include('regular')
+    expect(beneficiary.created_at).to eq('2015-04-25T09:21:00+00:00')
+    expect(beneficiary.updated_at).to eq('2015-04-25T10:58:21+00:00')
+  end
+
+  it "can #find" do
+    beneficiaries = CurrencyCloud::Beneficiary.find
+    expect(beneficiaries).to_not be_empty
+    expect(beneficiaries.length).to eq(1)
+    
+    beneficiaries.each do |b|
+      expect(b).to_not be_nil
+      expect(b).to be_a_kind_of(CurrencyCloud::Beneficiary)
+    end
+
+    pagination = beneficiaries.pagination
+    expect(pagination.total_entries).to eq(1)
+    expect(pagination.total_pages).to eq(1)
+    expect(pagination.current_page).to eq(1)
+    expect(pagination.per_page).to eq(25)
+    expect(pagination.previous_page).to eq(-1)
+    expect(pagination.next_page).to eq(-1)
+    expect(pagination.order).to eq('created_at')
+    expect(pagination.order_asc_desc).to eq('asc')    
+  end
+
+  it "can #update" do
+    beneficiary = CurrencyCloud::Beneficiary.update('081596c9-02de-483e-9f2a-4cf55dcdf98c', :bank_account_holder_name => 'Test User 2')
+    expect(beneficiary).to be_a_kind_of(CurrencyCloud::Beneficiary)
+    expect(beneficiary.bank_account_holder_name).to eq('Test User 2')
+  end
+
+  it "can #delete" do
+    beneficiary = CurrencyCloud::Beneficiary.delete('081596c9-02de-483e-9f2a-4cf55dcdf98c')
+    expect(beneficiary).to be_a_kind_of(CurrencyCloud::Beneficiary)
+
+    expect(beneficiary.id).to eq('081596c9-02de-483e-9f2a-4cf55dcdf98c')
+    expect(beneficiary.bank_account_holder_name).to eq('Test User 2')
+    expect(beneficiary.payment_types).to include('regular')
+    expect(beneficiary.created_at).to eq('2015-04-25T09:21:00+00:00')
+    expect(beneficiary.updated_at).to eq('2015-04-25T11:06:27+00:00')
+  end
+
+  it "can #current" do
+    account = CurrencyCloud::Account.current
+
+    expect(account).to be_a_kind_of(CurrencyCloud::Account)
+    expect(account.id).to eq('8ec3a69b-02d1-4f09-9a6b-6bd54a61b3a8')
+    expect(account.postal_code).to be_nil
+    expect(account.created_at).to eq('2015-04-24T15:57:55+00:00')
+    expect(account.updated_at).to eq('2015-04-24T15:57:55+00:00')
+  end
+end

data/spec/integration/authentication_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'Authentication', :vcr => true do
+  before(:each) do
+    CurrencyCloud.reset_session
+    CurrencyCloud.environment = :demonstration
+    CurrencyCloud.login_id = 'rjnienaber@gmail.com'
+    CurrencyCloud.api_key = 'ef0fd50fca1fb14c1fab3a8436b9ecb65f02f129fd87eafa45ded8ae257528f0'
+    CurrencyCloud.token = nil
+  end
+
+  it 'happens lazily' do
+    expect(CurrencyCloud.session).to_not be_nil
+    expect(CurrencyCloud.session.token).to eq('57ef449f6316f2f54dfec37c2006fe50')
+  end
+
+  it 'can use just a token' do
+    CurrencyCloud.login_id = nil
+    CurrencyCloud.api_key = nil
+    CurrencyCloud.token = '7fbba909f66ee6721b2e20a5fa1ccae7'
+
+    response = CurrencyCloud::Beneficiary.find
+    expect(response).to_not be_nil
+  end
+
+  it 'can be closed' do
+    CurrencyCloud.session 
+    expect(CurrencyCloud.close_session).to eq(true)
+  end
+
+  it 'handles session timeout error' do
+    CurrencyCloud.token = '3907f05da86533710efc589d58f51f45'
+
+    response = CurrencyCloud::Beneficiary.find
+    expect(response).to_not be_nil
+  end
+end

data/spec/integration/errors_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+require 'net/http'
+
+describe 'Error', :vcr => true do
+  before(:each) do
+    CurrencyCloud.reset_session
+    CurrencyCloud.environment = :demonstration
+    CurrencyCloud.login_id = 'rjnienaber@gmail.com'
+    CurrencyCloud.api_key = 'ef0fd50fca1fb14c1fab3a8436b9ecb65f02f129fd87eafa45ded8ae257528f0'
+    CurrencyCloud.token = nil
+  end
+
+  it 'is raised on a bad request' do
+    CurrencyCloud.login_id = 'non-existent-login-id'
+    CurrencyCloud.api_key = 'ef0fd50fca1fb14c1fab3a8436b9ecb57528f0'
+
+    error = nil
+    begin
+      CurrencyCloud.session
+      raise 'Should have failed'
+    rescue CurrencyCloud::BadRequestError => error
+    end
+
+    expect(error.code).to eq('auth_invalid_user_login_details')
+    expect(error.raw_response).to_not be_nil
+    expect(error.status_code).to eq(400)
+    expect(error.messages.length).to eq(1)
+
+    error_message = error.messages[0]
+    expect(error_message.field).to eq('api_key')
+    expect(error_message.code).to eq('api_key_length_is_invalid')
+    expect(error_message.message).to eq('api_key should be 64 character(s) long')
+    expect(error_message.params).to include("length" => 64)
+  end
+
+  it 'is raised on incorrect authentication details' do
+    CurrencyCloud.login_id = 'non-existent-login-id'
+    CurrencyCloud.api_key = 'efb5ae2af84978b7a37f18dd61c8bbe139b403009faea83484405a3dcb64c4d8'
+
+    error = nil
+    begin
+      CurrencyCloud.session
+      raise 'Should have failed'
+    rescue CurrencyCloud::AuthenticationError => error
+    end
+
+    expect(error.code).to eq('auth_failed')
+    expect(error.raw_response).to_not be_nil
+    expect(error.status_code).to eq(401)
+    expect(error.messages.length).to eq(1)
+
+    error_message = error.messages[0]
+    expect(error_message.field).to eq('username')
+    expect(error_message.code).to eq('invalid_supplied_credentials')
+    expect(error_message.message).to eq('Authentication failed with the supplied credentials')
+    expect(error_message.params).to be_empty
+  end
+
+  it 'is raised on unexpected error' do
+    allow(HTTParty).to receive(:post).and_raise(Timeout::Error)
+
+    error = nil
+    begin
+      CurrencyCloud.session
+      raise 'Should have failed'
+    rescue CurrencyCloud::UnexpectedError => error
+    end
+
+    expect(error.inner_error).to_not be_nil
+    expect(error.inner_error.class).to eq(Timeout::Error)
+  end
+
+  it 'is raised on a forbidden request' do
+    error = nil
+    begin
+      CurrencyCloud.session
+      raise 'Should have failed'
+    rescue CurrencyCloud::ForbiddenError => error
+    end
+
+    expect(error.code).to eq('auth_failed')
+    expect(error.raw_response).to_not be_nil
+    expect(error.status_code).to eq(403)
+    expect(error.messages.length).to eq(1)
+
+    error_message = error.messages[0]
+    expect(error_message.field).to eq('username')
+    expect(error_message.code).to eq('invalid_supplied_credentials')
+    expect(error_message.message).to eq('Authentication failed with the supplied credentials')
+    expect(error_message.params).to be_empty
+  end
+
+  it 'is raised when a resource is not found' do
+    CurrencyCloud.token = '656485646b068f6e9c81e3d885fa54f5'
+    error = nil
+    begin
+      CurrencyCloud::Beneficiary.retrieve('081596c9-02de-483e-9f2a-4cf55dcdf98c') 
+      raise 'Should fail'
+    rescue CurrencyCloud::NotFoundError => error
+    end 
+
+    expect(error.code).to eq('beneficiary_not_found')
+    expect(error.raw_response).to_not be_nil
+    expect(error.status_code).to eq(404)
+    expect(error.messages.length).to eq(1)
+
+    error_message = error.messages[0]
+    expect(error_message.field).to eq('id')
+    expect(error_message.code).to eq('beneficiary_not_found')
+    expect(error_message.message).to eq('Beneficiary was not found for this id')
+    expect(error_message.params).to be_empty
+  end
+  
+  it 'is raised on an internal server error' do
+
+    error = nil
+    begin
+      CurrencyCloud.session
+      raise 'Should have failed'
+    rescue CurrencyCloud::InternalApplicationError => error
+    end
+
+    expect(error.code).to eq('internal_application_error')
+    expect(error.raw_response).to_not be_nil
+    expect(error.status_code).to eq(500)
+    expect(error.messages.length).to eq(1)
+
+    error_message = error.messages[0]
+    expect(error_message.field).to eq('base')
+    expect(error_message.code).to eq('internal_application_error')
+    expect(error_message.message).to eq('A general application error occurred')
+    expect(error_message.params).to include("request_id" => 2771875643610572878)
+  end
+  
+  it 'is raised when too many requests have been issued' do
+    CurrencyCloud.login_id = 'rjnienaber@gmail.com2'
+
+    error = nil
+    begin
+      CurrencyCloud.session
+      
+      raise 'Should have failed'
+    rescue CurrencyCloud::TooManyRequestsError => error
+    end
+
+    expect(error.code).to eq('too_many_requests')
+    expect(error.raw_response).to_not be_nil
+    expect(error.status_code).to eq(429)
+    expect(error.messages.length).to eq(1)
+
+    error_message = error.messages[0]
+    expect(error_message.field).to eq('base')
+    expect(error_message.code).to eq('too_many_requests')
+    expect(error_message.message).to eq('Too many requests have been made to the api. Please refer to the Developer Center for more information')
+    expect(error_message.params).to be_empty
+  end
+end

data/spec/integration/rates_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe 'Rates', :vcr => true do
+  before do
+    CurrencyCloud.reset_session
+    CurrencyCloud.environment = :demonstration
+    CurrencyCloud.token = '242993ca94b9d1c6c1d8f7d3275a6f36'
+  end
+
+  it 'can #find' do
+    rates = CurrencyCloud::Rate.find(currency_pair: 'GBPUSD,EURGBP')
+
+    expect(rates).to_not be_nil
+    expect(rates.currencies).to_not be_empty
+
+    currencies = rates.currencies
+    expect(currencies.length).to eq(2)
+    
+    currencies.each do |b|
+      expect(b).to_not be_nil
+      expect(b).to be_a_kind_of(CurrencyCloud::Rate)
+    end
+
+    rate = currencies.first
+    expect(rate.currency_pair).to eq('EURGBP')
+    expect(rate.bid).to eq('0.71445')
+    expect(rate.offer).to eq('0.71508')
+
+    expect(rates.unavailable).to be_empty
+  end 
+
+  it 'can provided #detailed rate' do
+    detailed_rate = CurrencyCloud::Rate.detailed(buy_currency: 'GBP', sell_currency: 'USD', fixed_side: 'buy', amount: '10000')
+
+    expect(detailed_rate).to be_a_kind_of(CurrencyCloud::Rate)
+    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
+end

data/spec/integration/reference_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe 'Reference', :vcr => true do
+  before do
+    CurrencyCloud.reset_session
+    CurrencyCloud.environment = :demonstration
+    CurrencyCloud.token = '1c9da5726314246acfb09ec5651307a5'
+  end
+
+  it 'can retrieve #beneficiary_required_details' do
+    details = CurrencyCloud::Reference.beneficiary_required_details(:currency => 'GBP', :bank_account_country => 'GB', :beneficiary_country => 'GB')
+    expect(details).to_not be_empty
+
+    details = details.first
+    expect(details['payment_type']).to eq('priority')
+    expect(details["payment_type"]).to eq("priority")
+    expect(details["beneficiary_entity_type"]).to eq("individual")
+    expect(details["beneficiary_address"]).to eq("^.{1,255}")
+    expect(details["beneficiary_city"]).to eq("^.{1,255}")
+    expect(details["beneficiary_country"]).to eq("^[A-z]{2}$")
+    expect(details["beneficiary_first_name"]).to eq("^.{1,255}")
+    expect(details["beneficiary_last_name"]).to eq("^.{1,255}")
+    expect(details["acct_number"]).to eq("^[0-9A-Z]{1,50}$")
+    expect(details["sort_code"]).to eq("^\\d{6}$")
+  end 
+
+  it 'can retrieve #conversion_dates' do
+    dates = CurrencyCloud::Reference.conversion_dates(:conversion_pair => 'GBPUSD')
+
+    expect(dates.invalid_conversion_dates).to_not be_empty
+    invalid_conversion_date = dates.invalid_conversion_dates.first
+    expect(invalid_conversion_date).to eq(["2015-05-02", "No trading on Saturday"])
+    expect(dates.first_conversion_date).to eq('2015-04-30')
+    expect(dates.default_conversion_date).to eq('2015-04-30')
+  end 
+
+  it 'can retrieve #currencies' do
+    currencies = CurrencyCloud::Reference.currencies
+    expect(currencies).to_not be_empty
+
+    currency = currencies.first
+    expect(currency).to be_a_kind_of(CurrencyCloud::Currency)
+    expect(currency.code).to eq('AED')
+    expect(currency.name).to eq('United Arab Emirates Dirham')
+    expect(currency.decimal_places).to eq(2)
+  end 
+
+  it 'can retrieve #settlement_accounts' do
+    settlement_accounts = CurrencyCloud::Reference.settlement_accounts(:currency => 'GBP')
+    expect(settlement_accounts).to_not be_empty
+
+    settlement_account = settlement_accounts.first
+    expect(settlement_account).to be_a_kind_of(CurrencyCloud::SettlementAccount)
+    expect(settlement_account.bank_account_holder_name).to eq("The Currency Cloud GBP - Client Seg A/C")
+    expect(settlement_account.bank_address).to be_empty
+  end 
+end