currency_cloud 0.5 → 0.7

data/lib/currency_cloud/resource.rb

@@ -11,13 +11,19 @@ module CurrencyCloud
     def self.actions(*actions)
       @actions ||= actions
       @actions.each do |action|
-        self.class_eval do # self.class.instance_eval # metaclass.instance_eval
+        self.class_eval do
           action_module = CurrencyCloud::Actions.const_get(action.to_s.capitalize)
           self.extend(action_module)
         end
+
+
+        self.send(:include, CurrencyCloud::Actions::Save) if action == :update
+        self.send(:include, CurrencyCloud::Actions::InstanceDelete) if action == :delete
       end
     end
     
+    attr_reader :changed_attributes
+    
     def initialize(object)
       @object = object
       @changed_attributes = Set.new

data/lib/currency_cloud/resources/balance.rb

@@ -3,6 +3,8 @@ module CurrencyCloud
     resource :balances
     actions :find
 
-    #TODO: currency
+    def self.currency(ccy)
+      get(ccy)
+    end
   end
 end

data/lib/currency_cloud/resources/beneficiary.rb

@@ -7,8 +7,7 @@ module CurrencyCloud
     actions :create, :retrieve, :find, :update, :delete
     
     def self.validate(params)
-      new(request.get("#{self.resource}/validate", params))
-    end
-        
+      post('validate', params)
+    end        
   end
 end

data/lib/currency_cloud/resources/payment.rb

@@ -5,7 +5,5 @@ module CurrencyCloud
     resource :payments
     
     actions :create, :retrieve, :find, :delete, :update
-    
-    #TODO: authorize, authorizations
   end
 end

data/lib/currency_cloud/resources/settlement.rb

@@ -5,26 +5,47 @@ module CurrencyCloud
     resource :settlements
     
     actions :create, :retrieve, :find, :delete
-    
+
     def add_conversion(conversion_id)
-      # TODO: Should just update state of current object using a refresh method?
-      new(request.post("#{self.resource}/#{self.id}/add_conversion", conversion_id: conversion_id))
+      update_attributes(Settlement.add_conversion(id, conversion_id))
     end
     
     def remove_conversion(conversion_id)
-      # TODO: Should just update state of current object using a refresh method?
-      new(request.post("#{self.resource}/#{self.id}/remove_conversion", conversion_id: conversion_id)) 
+      update_attributes(Settlement.remove_conversion(id, conversion_id))
     end
     
     def release
-      # TODO: Should just update state of current object using a refresh method?
-      new(request.post("#{self.resource}/#{self.id}/release")) 
+      update_attributes(Settlement.release(id))
     end
     
     def unrelease
-      # TODO: Should just update state of current object using a refresh method?
-      new(request.post("#{self.resource}/#{self.id}/unrelease")) 
+      update_attributes(Settlement.unrelease(id))
+    end
+
+    def self.add_conversion(settlement_id, conversion_id)
+      post("#{settlement_id}/add_conversion", conversion_id: conversion_id)
+    end
+    
+    def self.remove_conversion(settlement_id, conversion_id)
+      post("#{settlement_id}/remove_conversion", conversion_id: conversion_id)
     end
     
+    def self.release(settlement_id)
+      post("#{settlement_id}/release")
+    end
+    
+    def self.unrelease(settlement_id)
+      post("#{settlement_id}/unrelease")
+    end    
+
+    private
+    def update_attributes(settlement)
+      self.conversion_ids = settlement.conversion_ids
+      self.status = settlement.status
+      self.entries = settlement.entries
+      self.updated_at = settlement.updated_at
+      self.released_at = settlement.released_at
+      self
+    end
   end
 end

data/lib/currency_cloud/response_handler.rb

@@ -2,17 +2,16 @@ module CurrencyCloud
   
   class ResponseHandler
     
-    attr_reader :response
+    attr_reader :verb, :route, :params, :response
     
-    def self.process(response)
-      new(response).data
-    end
-    
-    def initialize(response)
+    def initialize(verb, route, params, response)
+      @verb = verb
+      @route = route
+      @params = params
       @response = response
     end
     
-    def data
+    def process
       if success?
         return parsed_response
       else
@@ -28,15 +27,15 @@ module CurrencyCloud
     
     def handle_failure
       error_class = case response.code
-        when 400 then CurrencyCloud::BadRequestError
-        when 401 then CurrencyCloud::AuthenticationError
-        when 403 then CurrencyCloud::ForbiddenError
-        when 404 then CurrencyCloud::NotFoundError
-        when 429 then CurrencyCloud::TooManyRequestsError
-        when 500 then CurrencyCloud::InternalApplicationError
-        else CurrencyCloud::UnexpectedError
+        when 400 then BadRequestError
+        when 401 then AuthenticationError
+        when 403 then ForbiddenError
+        when 404 then NotFoundError
+        when 429 then TooManyRequestsError
+        when 500 then InternalApplicationError
       end
-      raise error_class.new(response)
+      raise error_class.new(verb, route, params, response) if error_class
+      raise UnexpectedError.new(verb, route, params, response)
     end
     
     def parsed_response

data/lib/currency_cloud/session.rb

@@ -7,11 +7,11 @@ module CurrencyCloud
                      :uat => 'https://api-uat1.ccycloud.com'}
    
     attr_reader :environment, :login_id, :api_key
-    attr_accessor :token
+    attr_accessor :token, :on_behalf_of
     
     def self.validate_environment(environment)
       unless Environments.keys.include?(environment)
-        raise CurrencyCloud::ConfigError, "'#{environment}' is not a valid environment, must be one of: #{Environments.keys.join(", ")}"
+        raise CurrencyCloud::GeneralError, "'#{environment}' is not a valid environment, must be one of: #{Environments.keys.join(", ")}"
       end
     end
    
@@ -51,8 +51,8 @@ module CurrencyCloud
     private
     def validate
       self.class.validate_environment(environment)
-      raise CurrencyCloud::ConfigError, "login_id must be set using CurrencyCloud.login_id=" unless login_id
-      raise CurrencyCloud::ConfigError, "api_key must be set using CurrencyCloud.api_key=" unless api_key
+      raise CurrencyCloud::GeneralError, "login_id must be set using CurrencyCloud.login_id=" unless login_id
+      raise CurrencyCloud::GeneralError, "api_key must be set using CurrencyCloud.api_key=" unless api_key
     end
     
     def request

data/lib/currency_cloud/version.rb

@@ -3,6 +3,6 @@
 module CurrencyCloud
 
   ApiVersion = 'v2' # API Version
-  Version = '0.5' # Gem Version  
+  Version = '0.7' # Gem Version  
 
 end

data/spec/currency_cloud/request_handler_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'RequestHandler' do
+  let(:session) { CurrencyCloud::Session.new(:demonstration, nil, nil, '4df5b3e5882a412f148dcd08fa4e5b73')}
+  let(:response) { double('Response', code: 200, body: '{}') }
+
+  subject { CurrencyCloud::RequestHandler.new(session) }
+
+  describe 'with on_behalf_of parameter' do
+    it "adds it to parameters in HTTP call" do
+      session.on_behalf_of = "d1f7f5c2-4187-41da-88fc-b3ae40fa958f"
+
+      allow(HTTParty).to receive(:post) do |_, params|
+        expect(params).to include(:body)
+        expect(params[:body]).to include(on_behalf_of: "d1f7f5c2-4187-41da-88fc-b3ae40fa958f")
+      end.and_return(response)
+
+      subject.post('accounts/create', account_name: "Test Account")
+    end
+
+    it "ignores it if it's not a uuid" do
+      session.on_behalf_of = "nonsense variable"
+
+      allow(HTTParty).to receive(:post) do |_, params|
+        expect(params).to include(:body)
+        expect(params[:body]).to eq(account_name: "Test Account")
+      end.and_return(response)
+
+      subject.post('accounts/create', account_name: "Test Account")
+    end
+  end
+end

data/spec/currency_cloud/resource_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'Resource' do
+  before(:all) do
+    class Person < CurrencyCloud::Resource
+      resource :people
+      actions :update, :delete
+    end
+  end
+
+  describe "#save" do
+    it "only updates changed records" do
+      person = Person.new(id: 1, name: 'Richard', surname: 'Nienaber')
+      allow(person).to receive(:post).with(1, name: 'John')
+      person.name = 'John'
+      
+      expect(person.save).to eq(person)
+      expect(person.changed_attributes).to eq(Set.new)
+    end
+
+    it "does nothing if nothing has changed" do
+      person = Person.new(id: 1, name: 'Richard', surname: 'Nienaber')
+      
+      expect(person.save).to eq(person)
+      expect(person.changed_attributes).to eq(Set.new)
+    end
+  end
+
+  describe "#delete" do
+    it 'removes resource' do
+      person = Person.new(id: 1, name: 'Richard', surname: 'Nienaber')
+      allow(Person).to receive(:post).with('1/delete')
+
+      expect(person.delete).to eq(person)
+    end
+  end
+end

data/spec/currency_cloud_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe CurrencyCloud do
 
-  before(:each) do
+  before do
     CurrencyCloud.environment = nil
     CurrencyCloud.login_id = nil
     CurrencyCloud.api_key = nil
@@ -53,26 +53,70 @@ describe CurrencyCloud do
     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")
+       .to raise_error(CurrencyCloud::GeneralError, "'' 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")
+       .to raise_error(CurrencyCloud::GeneralError, "'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=")
+       .to raise_error(CurrencyCloud::GeneralError, "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=")
+       .to raise_error(CurrencyCloud::GeneralError, "api_key must be set using CurrencyCloud.api_key=")
     end
   end
+
+  describe "#on_behalf_of" do
+    before do
+      CurrencyCloud.environment = :demonstration
+      CurrencyCloud.token = '4df5b3e5882a412f148dcd08fa4e5b73'
+      CurrencyCloud.session.on_behalf_of = nil
+    end
+
+    it "sets the value on the session, and removes it when done" do
+      CurrencyCloud.on_behalf_of('c6ece846-6df1-461d-acaa-b42a6aa74045') do
+        expect(CurrencyCloud.session.on_behalf_of).to eq('c6ece846-6df1-461d-acaa-b42a6aa74045')
+      end
+      expect(CurrencyCloud.session.on_behalf_of).to be_nil
+    end
+
+    it "still removes the value from the session on error" do
+      expect do 
+        CurrencyCloud.on_behalf_of('c6ece846-6df1-461d-acaa-b42a6aa74045') do
+          expect(CurrencyCloud.session.on_behalf_of).to eq('c6ece846-6df1-461d-acaa-b42a6aa74045')
+          raise 'Completed Expected error'
+        end
+      end.to raise_error('Completed Expected error')
+      
+      expect(CurrencyCloud.session.on_behalf_of).to be_nil
+    end
+
+    it 'prevents reentrant usage' do
+      expect do
+        CurrencyCloud.on_behalf_of('c6ece846-6df1-461d-acaa-b42a6aa74045') do
+          CurrencyCloud.on_behalf_of('f57b2d33-652c-4589-a8ff-7762add2706d') do
+            raise "Should raise exception"
+          end
+        end
+      end.to raise_error(CurrencyCloud::GeneralError, "#on_behalf_of has already been set")
+    end
+
+    it 'prevents reentrant usage' do
+      expect do
+        CurrencyCloud.on_behalf_of('Richard Nienaber') do
+          raise "Should raise exception"
+        end
+      end.to raise_error(CurrencyCloud::GeneralError, "contact id for on behalf of is not a UUID")
+    end    
+  end
 end

data/spec/integration/actions_spec.rb

@@ -98,4 +98,32 @@ describe 'Actions', :vcr => true do
     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
+
+  it "can #validate beneficiaries" do
+    params = {
+      :bank_country => 'GB',
+      :currency => 'GBP',
+      :account_number => '12345678',
+      :routing_code_type_1 => 'sort_code',
+      :routing_code_value_1 => '123456',
+      :payment_types => ['regular']
+    }
+
+    beneficiary = CurrencyCloud::Beneficiary.validate(params)
+    expect(beneficiary).to be_a_kind_of(CurrencyCloud::Beneficiary)
+
+    expect(beneficiary.account_number).to include('12345678')
+    expect(beneficiary.payment_types).to include('regular')
+  end
+
+  it "can use #currency to retrieve balance" do
+    balance = CurrencyCloud::Balance.currency('GBP')
+
+    expect(balance).to be_a_kind_of(CurrencyCloud::Balance)
+
+    expect(balance.id).to eq("5a998e06-3eb7-46d6-ba58-f749864159ce")
+    expect(balance.amount).to eq('999866.78')
+    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
 end

data/spec/integration/errors_spec.rb

@@ -10,6 +10,40 @@ describe 'Error', :vcr => true do
     CurrencyCloud.token = nil
   end
 
+  it 'contains full details for api error' 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
+
+    expected_error = %Q{CurrencyCloud::BadRequestError
+---
+platform: #{error.platform}
+request:
+  parameters:
+    login_id: non-existent-login-id
+    api_key: ef0fd50fca1fb14c1fab3a8436b9ecb57528f0
+  verb: post
+  url: https://devapi.thecurrencycloud.com/v2/authenticate/api
+response:
+  status_code: 400
+  date: Wed, 29 Apr 2015 22:46:53 GMT
+  request_id: 2775253392756800903
+errors:
+- field: api_key
+  code: api_key_length_is_invalid
+  message: api_key should be 64 character(s) long
+  params:
+    length: 64
+}
+    expect(error.to_s).to eq(expected_error)
+  end
+
   it 'is raised on a bad request' do
     CurrencyCloud.login_id = 'non-existent-login-id'
     CurrencyCloud.api_key = 'ef0fd50fca1fb14c1fab3a8436b9ecb57528f0'
@@ -66,6 +100,19 @@ describe 'Error', :vcr => true do
     rescue CurrencyCloud::UnexpectedError => error
     end
 
+        expected_error = %Q{CurrencyCloud::UnexpectedError
+---
+platform: #{error.platform}
+request:
+  parameters:
+    login_id: rjnienaber@gmail.com
+    api_key: ef0fd50fca1fb14c1fab3a8436b9ecb65f02f129fd87eafa45ded8ae257528f0
+  verb: post
+  url: https://devapi.thecurrencycloud.com/v2/authenticate/api
+inner_error: Timeout::Error
+}
+
+    expect(error.to_s).to eq(expected_error)
     expect(error.inner_error).to_not be_nil
     expect(error.inner_error.class).to eq(Timeout::Error)
   end

data/spec/integration/rates_spec.rb

@@ -4,7 +4,7 @@ describe 'Rates', :vcr => true do
   before do
     CurrencyCloud.reset_session
     CurrencyCloud.environment = :demonstration
-    CurrencyCloud.token = '242993ca94b9d1c6c1d8f7d3275a6f36'
+    CurrencyCloud.token = 'bbdd421bdda373ea69670c9101fa9197'
   end
 
   it 'can #find' do