xero_gateway 2.0.13 → 2.0.14

data/lib/xero_gateway/invoice.rb

@@ -2,10 +2,9 @@ module XeroGateway
   class Invoice
     include Dates
     include Money
+    include LineItemCalculations
     
-    class Error < RuntimeError; end
     class NoGatewayError < Error; end
-    class InvalidLineItemError < Error; end
     
     INVOICE_TYPE = {
       'ACCREC' =>           'Accounts Receivable',
@@ -39,7 +38,7 @@ module XeroGateway
     attr_accessor :line_items_downloaded
   
     # All accessible fields
-    attr_accessor :invoice_id, :invoice_number, :invoice_type, :invoice_status, :date, :due_date, :reference, :line_amount_types, :currency_code, :line_items, :contact, :payments, :fully_paid_on, :amount_due, :amount_paid, :amount_credited, :sent_to_contact
+    attr_accessor :invoice_id, :invoice_number, :invoice_type, :invoice_status, :date, :due_date, :reference, :line_amount_types, :currency_code, :line_items, :contact, :payments, :fully_paid_on, :amount_due, :amount_paid, :amount_credited, :sent_to_contact, :url
 
     
     def initialize(params = {})
@@ -107,58 +106,6 @@ module XeroGateway
       @contact ||= build_contact
     end
     
-    # Helper method to create a new associated line_item.
-    # Usage:
-    #   invoice.add_line_item({:description => "Bob's Widgets", :quantity => 1, :unit_amount => 120})
-    def add_line_item(params = {})
-      line_item = nil
-      case params
-        when Hash then      line_item = LineItem.new(params)
-        when LineItem then  line_item = params
-        else                raise InvalidLineItemError
-      end
-      
-      @line_items << line_item
-      
-      line_item
-    end
-    
-    # Deprecated (but API for setter remains).
-    #
-    # As sub_total must equal SUM(line_item.line_amount) for the API call to pass, this is now
-    # automatically calculated in the sub_total method.
-    def sub_total=(value)
-    end
-    
-    # Calculate the sub_total as the SUM(line_item.line_amount).
-    def sub_total
-      line_items.inject(BigDecimal.new('0')) { | sum, line_item | sum + BigDecimal.new(line_item.line_amount.to_s) }
-    end
-    
-    # Deprecated (but API for setter remains).
-    #
-    # As total_tax must equal SUM(line_item.tax_amount) for the API call to pass, this is now
-    # automatically calculated in the total_tax method.
-    def total_tax=(value)
-    end
-    
-    # Calculate the total_tax as the SUM(line_item.tax_amount).
-    def total_tax
-      line_items.inject(BigDecimal.new('0')) { | sum, line_item | sum + BigDecimal.new(line_item.tax_amount.to_s) }
-    end
-    
-    # Deprecated (but API for setter remains).
-    #
-    # As total must equal sub_total + total_tax for the API call to pass, this is now
-    # automatically calculated in the total method.
-    def total=(value)
-    end
-    
-    # Calculate the toal as sub_total + total_tax.
-    def total
-      sub_total + total_tax
-    end
-    
     # Helper method to check if the invoice is accounts payable.
     def accounts_payable?
       invoice_type == 'ACCPAY'
@@ -178,12 +125,10 @@ module XeroGateway
     def line_items
       if line_items_downloaded?
         @line_items
-        
-      # There is an invoice_is so we can assume this record was loaded from Xero.
-      # attempt to download the line_item records.
-      elsif invoice_id =~ GUID_REGEX
-        raise NoGatewayError unless @gateway
-        
+
+      elsif invoice_id =~ GUID_REGEX && @gateway
+        # There is an invoice_id so we can assume this record was loaded from Xero.
+        # Let's attempt to download the line_item records (if there is a gateway)
         response = @gateway.get_invoice(invoice_id)
         raise InvoiceNotFoundError, "Invoice with ID #{invoice_id} not found in Xero." unless response.success? && response.invoice.is_a?(XeroGateway::Invoice)
         
@@ -250,6 +195,7 @@ module XeroGateway
             line_item.to_xml(b)
           end
         }
+        b.Url url if url
       }
     end
     
@@ -279,6 +225,7 @@ module XeroGateway
           when "AmountPaid" then invoice.amount_paid = BigDecimal.new(element.text)
           when "AmountCredited" then invoice.amount_credited = BigDecimal.new(element.text)
           when "SentToContact" then invoice.sent_to_contact = (element.text.strip.downcase == "true")
+          when "Url" then invoice.url = element.text
         end
       end      
       invoice

data/lib/xero_gateway/line_item_calculations.rb

@@ -0,0 +1,55 @@
+module XeroGateway
+  module LineItemCalculations
+
+    class Error < RuntimeError; end
+    class InvalidLineItemError < Error; end
+
+    def add_line_item(params = {})
+      line_item = nil
+      case params
+        when Hash then      line_item = LineItem.new(params)
+        when LineItem then  line_item = params
+        else                raise InvalidLineItemError
+      end
+      @line_items << line_item
+      line_item
+    end
+
+    # Deprecated (but API for setter remains).
+    #
+    # As sub_total must equal SUM(line_item.line_amount) for the API call to pass, this is now
+    # automatically calculated in the sub_total method.
+    def sub_total=(value)
+    end
+
+    # Calculate the sub_total as the SUM(line_item.line_amount).
+    def sub_total
+      line_items.inject(BigDecimal.new('0')) { | sum, line_item | sum + BigDecimal.new(line_item.line_amount.to_s) }
+    end
+
+    # Deprecated (but API for setter remains).
+    #
+    # As total_tax must equal SUM(line_item.tax_amount) for the API call to pass, this is now
+    # automatically calculated in the total_tax method.
+    def total_tax=(value)
+    end
+
+    # Calculate the total_tax as the SUM(line_item.tax_amount).
+    def total_tax
+      line_items.inject(BigDecimal.new('0')) { | sum, line_item | sum + BigDecimal.new(line_item.tax_amount.to_s) }
+    end
+
+    # Deprecated (but API for setter remains).
+    #
+    # As total must equal sub_total + total_tax for the API call to pass, this is now
+    # automatically calculated in the total method.
+    def total=(value)
+    end
+
+    # Calculate the toal as sub_total + total_tax.
+    def total
+      sub_total + total_tax
+    end
+
+  end
+end

data/lib/xero_gateway/response.rb

@@ -6,17 +6,19 @@ module XeroGateway
       Array(response_item)
     end
     
-    alias_method :invoice,      :response_item
-    alias_method :credit_note,  :response_item
-    alias_method :contact,      :response_item
-    alias_method :organisation, :response_item
-    alias_method :invoices,     :array_wrapped_response_item
-    alias_method :credit_notes, :array_wrapped_response_item
-    alias_method :contacts,     :array_wrapped_response_item
-    alias_method :accounts,     :array_wrapped_response_item
-    alias_method :tracking_categories, :array_wrapped_response_item
-    alias_method :tax_rates,    :array_wrapped_response_item
-    alias_method :currencies,   :array_wrapped_response_item
+    alias_method :invoice,              :response_item
+    alias_method :credit_note,          :response_item
+    alias_method :bank_transaction,     :response_item
+    alias_method :contact,              :response_item
+    alias_method :organisation,         :response_item
+    alias_method :invoices,             :array_wrapped_response_item
+    alias_method :credit_notes,         :array_wrapped_response_item
+    alias_method :bank_transactions,    :array_wrapped_response_item
+    alias_method :contacts,             :array_wrapped_response_item
+    alias_method :accounts,             :array_wrapped_response_item
+    alias_method :tracking_categories,  :array_wrapped_response_item
+    alias_method :tax_rates,            :array_wrapped_response_item
+    alias_method :currencies,           :array_wrapped_response_item
     
     def initialize(params = {})
       params.each do |k,v|

data/test/integration/create_bank_transaction_test.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class CreateBankTransactionTest < Test::Unit::TestCase
+  include TestHelper
+
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /BankTransactions$/ }.returns(get_file_as_string("create_bank_transaction.xml"))
+      @gateway.stubs(:http_post).with {|client, url, body, params| url =~ /BankTransactions$/ }.returns(get_file_as_string("bank_transaction.xml"))
+    end
+  end
+
+  def test_create_bank_transaction
+    example_bank_transaction = create_test_bank_transaction.dup
+
+    result = @gateway.create_bank_transaction(example_bank_transaction)
+    assert_kind_of XeroGateway::Response, result
+    assert result.success?
+    assert !result.request_xml.nil?
+    assert !result.response_xml.nil?
+    assert !result.bank_transaction.bank_transaction_id.nil?
+    assert example_bank_transaction.bank_transaction_id =~ GUID_REGEX
+  end
+
+  def test_create_bank_transaction_valid
+    example_bank_transaction = create_test_bank_transaction.dup
+    assert_equal true, example_bank_transaction.valid?,
+      "bank_transaction is invalid - errors:\n\t#{example_bank_transaction.errors.map { | error | "#{error[0]} #{error[1]}"}.join("\n\t")}"
+  end
+
+  private
+
+
+end

data/test/integration/get_bank_transaction_test.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetBankTransactionTest < Test::Unit::TestCase
+  include TestHelper
+
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ /BankTransactions(\/[0-9a-z\-]+)?$/i }.returns(get_file_as_string("bank_transaction.xml"))
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /BankTransactions$/ }.returns(get_file_as_string("create_bank_transaction.xml"))
+    end
+  end
+
+  def test_get_bank_transaction
+    # Make sure there is a bank transaction in Xero to retrieve
+    response = @gateway.create_bank_transaction(create_test_bank_transaction)
+    bank_transaction = response.bank_transaction
+
+    result = @gateway.get_bank_transaction(bank_transaction.bank_transaction_id)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert_equal result.bank_transaction.bank_transaction_id, bank_transaction.bank_transaction_id
+    assert_equal result.bank_transaction.reference, bank_transaction.reference
+
+    result = @gateway.get_bank_transaction(bank_transaction.bank_transaction_id)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert_equal result.bank_transaction.bank_transaction_id, bank_transaction.bank_transaction_id
+  end
+
+  def test_line_items_downloaded_set_correctly
+    # Make sure there is a bank transaction in Xero to retrieve.
+    example_bank_transaction = @gateway.create_bank_transaction(create_test_bank_transaction).bank_transaction
+  
+    # No line items.
+    response = @gateway.get_bank_transaction(example_bank_transaction.bank_transaction_id)
+    assert_equal(true, response.success?)
+  
+    bank_transaction = response.bank_transaction
+    assert_kind_of(XeroGateway::LineItem, bank_transaction.line_items.first)
+    assert_kind_of(XeroGateway::BankTransaction, bank_transaction)
+    assert_equal(true, bank_transaction.line_items_downloaded?)
+  end
+
+end

data/test/integration/get_bank_transactions_test.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GetBankTransactionsTest < Test::Unit::TestCase
+  include TestHelper
+
+  INVALID_BANK_TRANSACTION_ID = "99999999-9999-9999-9999-999999999999" unless defined?(INVALID_BANK_TRANSACTION_ID)
+
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ /BankTransactions(\/[0-9a-z\-]+)?$/i }.returns(get_file_as_string("bank_transactions.xml"))
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /BankTransactions$/ }.returns(get_file_as_string("create_bank_transaction.xml"))
+
+      # Get a bank transaction with an invalid ID.
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ Regexp.new("BankTransactions/#{INVALID_BANK_TRANSACTION_ID}") }.returns(get_file_as_string("bank_transaction_not_found_error.xml"))
+    end
+  end
+
+  def test_get_bank_transactions
+    # Make sure there is a bank transaction in Xero to retrieve
+    bank_transaction = @gateway.create_bank_transaction(create_test_bank_transaction).bank_transaction
+
+    result = @gateway.get_bank_transactions
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert result.bank_transactions.collect {|i| i.reference}.include?(bank_transaction.reference)
+    assert result.bank_transactions.collect {|i| i.bank_transaction_id}.include?(bank_transaction.bank_transaction_id)
+  end
+
+  def test_get_bank_transactions_with_modified_since_date
+    # Create a test bank transaction
+    @gateway.create_bank_transaction(create_test_bank_transaction)
+
+    # Check that it is returned
+    result = @gateway.get_bank_transactions(:modified_since => Date.today - 1)
+    assert result.success?
+    assert !result.request_params.nil?
+    assert !result.response_xml.nil?
+    assert result.request_params.keys.include?(:ModifiedAfter) # make sure the flag was sent
+  end
+
+  def test_line_items_downloaded_set_correctly
+    # No line items.
+    response = @gateway.get_bank_transactions
+    assert_equal(true, response.success?)
+
+    bank_transaction = response.bank_transactions.first
+    assert_kind_of(XeroGateway::BankTransaction, bank_transaction)
+    assert_equal(false, bank_transaction.line_items_downloaded?)
+  end
+
+  # Make sure that a reference to gateway is passed when the get_bank_transactions response is parsed.
+  def test_get_bank_transactions_gateway_reference
+    result = @gateway.get_bank_transactions
+    assert(result.success?)
+    assert_not_equal(0, result.bank_transactions.size)
+
+    result.bank_transactions.each do |bank_transaction|
+      assert(bank_transaction.gateway === @gateway)
+    end
+  end
+
+  # Test to make sure that we correctly error when a bank transaction doesn't have an ID.
+  # This should usually never be ecountered.
+  def test_to_ensure_that_a_bank_transaction_with_invalid_id_errors
+    # Make sure there is a bank transaction to retrieve, even though we will mangle it later.
+    bank_transaction = @gateway.create_bank_transaction(create_test_bank_transaction).bank_transaction
+
+    result = @gateway.get_bank_transactions
+    assert_equal(true, result.success?)
+
+    bank_transaction = result.bank_transactions.first
+    assert_equal(false, bank_transaction.line_items_downloaded?)
+
+    # Mangle invoice_id to invalid one.
+    bank_transaction.bank_transaction_id = INVALID_BANK_TRANSACTION_ID
+
+    # Make sure we fail here.
+    line_items = nil
+    assert_raise(XeroGateway::BankTransactionNotFoundError) { line_items = bank_transaction.line_items }
+    assert_nil(line_items)
+  end
+
+end

data/test/integration/update_bank_transaction_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UpdateBankTransactionTest < Test::Unit::TestCase
+  include TestHelper
+
+  def setup
+    @gateway = XeroGateway::Gateway.new(CONSUMER_KEY, CONSUMER_SECRET)
+
+    if STUB_XERO_CALLS
+      @gateway.xero_url = "DUMMY_URL"
+
+      @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /BankTransactions$/ }.returns(get_file_as_string("create_bank_transaction.xml"))
+      @gateway.stubs(:http_post).with {|client, url, body, params| url =~ /BankTransactions$/ }.returns(get_file_as_string("bank_transaction.xml"))
+    end
+  end
+
+  def test_update_bank_transaction
+    bank_transaction = @gateway.create_bank_transaction(create_test_bank_transaction).bank_transaction
+
+    today = Date.today
+    bank_transaction.date = today
+
+    result = @gateway.update_bank_transaction(bank_transaction)
+
+    assert result.success?
+    assert !result.request_xml.nil?
+    assert !result.response_xml.nil?
+    assert_equal bank_transaction.bank_transaction_id, result.bank_transaction.bank_transaction_id
+    assert_equal today, result.bank_transaction.date if !STUB_XERO_CALLS
+  end
+end

data/test/test_helper.rb

@@ -100,5 +100,80 @@ module TestHelper
     f.close
     return data
   end
-  
+
+  def create_test_bank_transaction(params={}, contact_params={}, line_item_params={})
+    params = {
+      :type       => 'RECEIVE',
+      :date       => Date.today,
+      :reference  => '12345',
+      :status     => 'ACTIVE',
+    }.merge(params)
+    bank_transaction = XeroGateway::BankTransaction.new(params)
+
+    bank_transaction.contact = create_test_contact(contact_params)
+    add_test_line_items(bank_transaction, line_item_params)
+    bank_transaction.bank_account = create_test_account
+
+    bank_transaction
+  end
+
+  def add_test_line_items(bank_transaction, line_item_params={})
+    if line_item_params
+      line_item_params = [line_item_params].flatten # always use an array, even if only a single hash passed in
+
+      # At least one line item, make first have some defaults.
+      line_item_params << {} if line_item_params.size == 0
+      line_item_params[0] = {
+        :description  => "A LINE ITEM",
+        :account_code => "200",
+        :unit_amount  => BigDecimal.new("100"),
+        :tax_amount   => BigDecimal.new("12.5"),
+        :tracking     => XeroGateway::TrackingCategory.new(:name => "blah", :options => "hello")
+      }.merge(line_item_params[0])
+
+      # Create line_items from line_item_params
+      line_item_params.each do |line_item|
+        bank_transaction.add_line_item(line_item)
+      end
+    end
+    bank_transaction
+  end
+
+  def create_test_account
+    account = XeroGateway::Account.new(:account_id => "57cedda9")
+    account.code = "200"
+    account.name = "Sales"
+    account.type = "REVENUE"
+    account.tax_type = "OUTPUT"
+    account.description = "Income from any normal business activity"
+    account.enable_payments_to_account = false
+    account
+  end
+
+  def create_test_contact(contact_params={})
+    # Strip out :address key from contact_params to use as the default address.
+    stripped_address = {
+      :address_type => 'STREET',
+      :line_1       => 'LINE 1 OF THE ADDRESS'
+    }.merge(contact_params.delete(:address) || {})
+
+    # Strip out :phone key from contact_params to use at the default phone.
+    stripped_phone = {
+      :phone_type => 'DEFAULT',
+      :number     => '12345678'
+    }.merge(contact_params.delete(:phone) || {})
+
+    contact_params = {
+      :contact_id => '00000000-0000-0000-0000-000000000000', # Just any valid GUID
+      :name       => "CONTACT NAME",
+      :first_name => "Bob",
+      :last_name  => "Builder"
+    }.merge(contact_params)
+
+    contact = XeroGateway::Contact.new(contact_params)
+    contact.address = XeroGateway::Address.new(stripped_address)
+    contact.phone = XeroGateway::Phone.new(stripped_phone)
+    contact
+  end
+
 end