xero_gateway 2.3.0 → 2.4.0

data/lib/xero_gateway/invoice.rb

@@ -3,18 +3,18 @@ module XeroGateway
     include Dates
     include Money
     include LineItemCalculations
-    
+
     INVOICE_TYPE = {
       'ACCREC' =>           'Accounts Receivable',
       'ACCPAY' =>           'Accounts Payable'
     } unless defined?(INVOICE_TYPE)
-    
+
     LINE_AMOUNT_TYPES = {
       "Inclusive" =>        'Invoice lines are inclusive tax',
       "Exclusive" =>        'Invoice lines are exclusive of tax (default)',
       "NoTax"     =>        'Invoices lines have no tax'
     } unless defined?(LINE_AMOUNT_TYPES)
-    
+
     INVOICE_STATUS = {
       'AUTHORISED' =>       'Approved invoices awaiting payment',
       'DELETED' =>          'Draft invoices that are deleted',
@@ -23,49 +23,52 @@ module XeroGateway
       'SUBMITTED' =>        'Invoices entered by an employee awaiting approval',
       'VOID' =>             'Approved invoices that are voided'
     } unless defined?(INVOICE_STATUS)
-    
+
     GUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/ unless defined?(GUID_REGEX)
-        
+
     # Xero::Gateway associated with this invoice.
     attr_accessor :gateway
-    
+
     # Any errors that occurred when the #valid? method called.
     # Or errors that were within the XML payload from Xero
     attr_accessor :errors
 
     # Represents whether the line_items have been downloaded when getting from GET /API.XRO/2.0/INVOICES
     attr_accessor :line_items_downloaded
-  
+
     # All accessible fields
-    attr_accessor :invoice_id, :invoice_number, :invoice_type, :invoice_status, :date, :due_date, :reference, :branding_theme_id, :line_amount_types, :currency_code, :line_items, :contact, :payments, :fully_paid_on, :amount_due, :amount_paid, :amount_credited, :sent_to_contact, :url, :updated_date_utc
+    attr_accessor :invoice_id, :invoice_number, :invoice_type, :invoice_status, :date, :due_date, :reference, :branding_theme_id,
+                  :line_amount_types, :currency_code, :currency_rate, :payments, :fully_paid_on, :amount_due, :amount_paid, :amount_credited,
+                  :sent_to_contact, :url, :updated_date_utc
+    attr_writer   :contact, :line_items
 
     def initialize(params = {})
       @errors ||= []
       @payments ||= []
-      
+
       # Check if the line items have been downloaded.
       @line_items_downloaded = (params.delete(:line_items_downloaded) == true)
-      
+
       params = {
         :line_amount_types => "Exclusive"
       }.merge(params)
-      
+
       params.each do |k,v|
         self.send("#{k}=", v)
       end
-      
+
       @line_items ||= []
     end
-    
+
     # Validate the Address record according to what will be valid by the gateway.
     #
-    # Usage: 
+    # Usage:
     #  address.valid?     # Returns true/false
-    #  
+    #
     #  Additionally sets address.errors array to an array of field/error.
     def valid?
       @errors = []
-      
+
       if !INVOICE_TYPE[invoice_type]
         @errors << ['invoice_type', "must be one of #{INVOICE_TYPE.keys.join('/')}"]
       end
@@ -73,7 +76,7 @@ module XeroGateway
       if !invoice_id.nil? && invoice_id !~ GUID_REGEX
         @errors << ['invoice_id', 'must be blank or a valid Xero GUID']
       end
-            
+
       if invoice_status && !INVOICE_STATUS[invoice_status]
         @errors << ['invoice_status', "must be one of #{INVOICE_STATUS.keys.join('/')}"]
       end
@@ -81,87 +84,73 @@ module XeroGateway
       if line_amount_types && !LINE_AMOUNT_TYPES[line_amount_types]
         @errors << ['line_amount_types', "must be one of #{LINE_AMOUNT_TYPES.keys.join('/')}"]
       end
-      
+
       unless date
         @errors << ['invoice_date', "can't be blank"]
       end
-      
+
       # Make sure contact is valid.
       unless @contact && @contact.valid?
         @errors << ['contact', 'is invalid']
       end
-      
+
       # Make sure all line_items are valid.
       unless line_items.all? { | line_item | line_item.valid? }
         @errors << ['line_items', "at least one line item invalid"]
       end
-      
+
       @errors.size == 0
     end
-    
+
     # Helper method to create the associated contact object.
     def build_contact(params = {})
       self.contact = gateway ? gateway.build_contact(params) : Contact.new(params)
     end
-    
+
     def contact
       @contact ||= build_contact
     end
-    
+
     # Helper method to check if the invoice is accounts payable.
     def accounts_payable?
       invoice_type == 'ACCPAY'
     end
-    
+
     # Helper method to check if the invoice is accounts receivable.
     def accounts_receivable?
       invoice_type == 'ACCREC'
     end
-    
+
     # Whether or not the line_items have been downloaded (GET/invoices does not download line items).
     def line_items_downloaded?
       @line_items_downloaded
     end
 
-    %w(sub_total tax_total total).each do |line_item_total_type|
-      define_method("#{line_item_total_type}=") do |new_total|
-        instance_variable_set("@#{line_item_total_type}", new_total) unless line_items_downloaded?
-      end
-    end
-        
     # If line items are not downloaded, then attempt a download now (if this record was found to begin with).
     def line_items
       if line_items_downloaded?
         @line_items
-
       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)
-        
-        @line_items = response.invoice.line_items
-        @line_items_downloaded = true
-        
-        @line_items
-        
-      # Otherwise, this is a new invoice, so return the line_items reference.
+        @line_items = download_line_items
       else
+        # Otherwise, this is a new invoice, so return the line_items reference.
         @line_items
       end
     end
-    
+
     def ==(other)
-      ["invoice_number", "invoice_type", "invoice_status", "reference", "currency_code", "line_amount_types", "contact", "line_items"].each do |field|
+      ["invoice_number", "invoice_type", "invoice_status", "reference", "currency_code", "currency_rate", "line_amount_types", "contact", "line_items"].each do |field|
         return false if send(field) != other.send(field)
       end
-      
+
       ["date", "due_date"].each do |field|
         return false if send(field).to_s != other.send(field).to_s
       end
       return true
     end
-    
+
     # General purpose create/save method.
     # If invoice_id is nil then create, otherwise, attempt to save.
     def save
@@ -171,27 +160,28 @@ module XeroGateway
         update
       end
     end
-    
+
     # Creates this invoice record (using gateway.create_invoice) with the associated gateway.
     # If no gateway set, raise a NoGatewayError exception.
     def create
       raise NoGatewayError unless gateway
       gateway.create_invoice(self)
     end
-    
+
     # Updates this invoice record (using gateway.update_invoice) with the associated gateway.
     # If no gateway set, raise a NoGatewayError exception.
     def update
       raise NoGatewayError unless gateway
       gateway.update_invoice(self)
     end
-    
+
     def to_xml(b = Builder::XmlMarkup.new)
       b.Invoice {
         b.InvoiceID self.invoice_id if self.invoice_id
         b.InvoiceNumber self.invoice_number if invoice_number
         b.Type self.invoice_type
-        b.CurrencyCode self.currency_code if self.currency_code
+        b.CurrencyCode currency_code if currency_code
+        b.CurrencyRate currency_rate if currency_rate
         contact.to_xml(b)
         b.Date Invoice.format_date(self.date || Date.today)
         b.DueDate Invoice.format_date(self.due_date) if self.due_date
@@ -207,16 +197,17 @@ module XeroGateway
         b.Url url if url
       }
     end
-    
+
     #TODO UpdatedDateUTC
     def self.from_xml(invoice_element, gateway = nil, options = {})
       invoice = Invoice.new(options.merge({:gateway => gateway}))
       invoice_element.children.each do |element|
         case(element.name)
           when "InvoiceID" then invoice.invoice_id = element.text
-          when "InvoiceNumber" then invoice.invoice_number = element.text            
+          when "InvoiceNumber" then invoice.invoice_number = element.text
           when "Type" then invoice.invoice_type = element.text
           when "CurrencyCode" then invoice.currency_code = element.text
+          when "CurrencyRate" then invoice.currency_rate = BigDecimal.new(element.text)
           when "Contact" then invoice.contact = Contact.from_xml(element)
           when "Date" then invoice.date = parse_date(element.text)
           when "DueDate" then invoice.due_date = parse_date(element.text)
@@ -229,8 +220,6 @@ module XeroGateway
           when "SubTotal" then invoice.sub_total = BigDecimal.new(element.text)
           when "TotalTax" then invoice.total_tax = BigDecimal.new(element.text)
           when "Total" then invoice.total = BigDecimal.new(element.text)
-          when "InvoiceID" then invoice.invoice_id = element.text
-          when "InvoiceNumber" then invoice.invoice_number = element.text
           when "Payments" then element.children.each { | payment | invoice.payments << Payment.from_xml(payment) }
           when "AmountDue" then invoice.amount_due = BigDecimal.new(element.text)
           when "AmountPaid" then invoice.amount_paid = BigDecimal.new(element.text)
@@ -242,5 +231,15 @@ module XeroGateway
       end
       invoice
     end
+
+    private
+
+      def download_line_items
+        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)
+
+        @line_items_downloaded = true
+        @line_items = response.invoice.line_items
+      end
   end
 end

data/lib/xero_gateway/line_item_calculations.rb

@@ -1,5 +1,6 @@
 module XeroGateway
   module LineItemCalculations
+
     def add_line_item(params = {})
       line_item = nil
       case params
@@ -11,41 +12,38 @@ module XeroGateway
       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)
+    %w(sub_total total_tax total).each do |line_item_total_type|
+      define_method("#{line_item_total_type}=") do |new_total|
+        instance_variable_set("@#{line_item_total_type}", new_total) unless line_items_downloaded?
+      end
     end
 
     # Calculate the sub_total as the SUM(line_item.line_amount).
     def sub_total
-      !line_items_downloaded? && @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)
+      total_cache(:sub_total) || sum_line_items(line_items, :line_amount)
     end
 
     # Calculate the total_tax as the SUM(line_item.tax_amount).
     def total_tax
-      !line_items_downloaded? && @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)
+      total_cache(:total_tax) || sum_line_items(line_items, :tax_amount)
     end
 
     # Calculate the toal as sub_total + total_tax.
     def total
-      !line_items_downloaded? && @total || (sub_total + total_tax)
+      total_cache(:total) || (sub_total + total_tax)
     end
 
+    private
+
+      def total_cache(name)
+        instance_variable_defined?("@#{name}") && instance_variable_get("@#{name}")
+      end
+
+      def sum_line_items(lines, sum_type = :line_amount)
+        lines.inject(BigDecimal.new('0')) do |sum, line|
+          sum + BigDecimal.new(line.send(sum_type).to_s)
+        end
+      end
+
   end
 end

data/lib/xero_gateway/manual_journal.rb

@@ -24,7 +24,8 @@ module XeroGateway
     attr_accessor :journal_lines_downloaded
 
     # accessible fields
-    attr_accessor :manual_journal_id, :narration, :date, :status, :journal_lines, :url, :show_on_cash_basis_reports
+    attr_accessor :manual_journal_id, :narration, :date, :status, :url, :show_on_cash_basis_reports
+    attr_writer   :journal_lines
 
     def initialize(params = {})
       @errors ||= []

data/lib/xero_gateway/organisation.rb

@@ -1,6 +1,7 @@
 module XeroGateway
   class Organisation < BaseRecord
     attributes({
+      "OrganisationID"        => :string,
       "Name" 	                => :string,     # Display name of organisation shown in Xero
       "LegalName"             => :string,	    # Organisation name shown on Reports
       "PaysTax" 	            => :boolean,    # Boolean to describe if organisation is registered with a local tax authority i.e. true, false
@@ -18,7 +19,13 @@ module XeroGateway
       "CreatedDateUTC"        => :string,
       "ShortCode"             => :string,
       "Timezone"              => :string,
-      "LineOfBusiness"        => :string
+      "LineOfBusiness"        => :string,
+      "Addresses"             => [Address]
     })
+
+    def add_address(address_params)
+      self.addresses ||= []
+      self.addresses << Address.new(address_params)
+    end
   end
 end

data/lib/xero_gateway/partner_app.rb

@@ -1,35 +1,29 @@
 module XeroGateway
   class PartnerApp < Gateway
-    
+
     class CertificateRequired < StandardError; end
-    
-    NO_SSL_CLIENT_CERT_MESSAGE   = "You need to provide a client ssl certificate and key pair (these are the ones you got from Entrust and should not be password protected) as :ssl_client_cert and :ssl_client_key (should be .crt or .pem files)"
+
     NO_PRIVATE_KEY_ERROR_MESSAGE = "You need to provide your private key (corresponds to the public key you uploaded at api.xero.com) as :private_key_file (should be .crt or .pem files)"
-    
+
     def_delegators :client, :session_handle, :renew_access_token, :authorization_expires_at
-     
+
     def initialize(consumer_key, consumer_secret, options = {})
-      
-      raise CertificateRequired.new(NO_SSL_CLIENT_CERT_MESSAGE)   unless options[:ssl_client_cert]
-      raise CertificateRequired.new(NO_SSL_CLIENT_CERT_MESSAGE)   unless options[:ssl_client_key]
       raise CertificateRequired.new(NO_PRIVATE_KEY_ERROR_MESSAGE) unless options[:private_key_file]
-      
-      options.merge!(
-        :site             => "https://api-partner.network.xero.com",
-        :authorize_url    => 'https://api.xero.com/oauth/Authorize', 
+
+      defaults = {
+        :site             => "https://api.xero.com",
+        :authorize_url    => 'https://api.xero.com/oauth/Authorize',
         :signature_method => 'RSA-SHA1',
-        :ssl_client_cert  => OpenSSL::X509::Certificate.new(File.read(options[:ssl_client_cert])),
-        :ssl_client_key   => OpenSSL::PKey::RSA.new(File.read(options[:ssl_client_key])),
-        :private_key_file => options[:private_key_file]
-      )
-      
-      @xero_url = options[:xero_url] || "https://api-partner.xero.com/api.xro/2.0"  
-      @client   = OAuth.new(consumer_key, consumer_secret, options)
+      }
+
+      options = defaults.merge(options)
+
+      super(consumer_key, consumer_secret, defaults.merge(options))
     end
 
     def set_session_handle(handle)
       client.session_handle = handle
     end
-    
+
   end
 end

data/lib/xero_gateway/tax_rate.rb

@@ -3,6 +3,7 @@ module XeroGateway
     attributes({
       "Name"                  => :string,
       "TaxType"               => :string,
+      "Status"                => :string,
       "CanApplyToAssets"      => :boolean,
       "CanApplyToEquity"      => :boolean,
       "CanApplyToExpenses"    => :boolean,

data/lib/xero_gateway/version.rb

@@ -1,3 +1,3 @@
 module XeroGateway
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 end

data/test/integration/get_invoices_test.rb

@@ -2,91 +2,100 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class GetInvoicesTest < Test::Unit::TestCase
   include TestHelper
-  
+
   INVALID_INVOICE_ID = "99999999-9999-9999-9999-999999999999" unless defined?(INVALID_INVOICE_ID)
-  
+  INVOICE_GET_URL = /\/Invoices\/a99a9aaa-9999-99a9-9aa9-aaaaaa9a9999/
+
   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 =~ /Invoices/ }.returns(get_file_as_string("invoices.xml"))
       @gateway.stubs(:http_put).with {|client, url, body, params| url =~ /Invoices$/ }.returns(get_file_as_string("create_invoice.xml"))
 
       # Get an invoice with an invalid ID number.
       @gateway.stubs(:http_get).with {|client, url, params| url =~ Regexp.new("Invoices/#{INVALID_INVOICE_ID}") }.returns(get_file_as_string("invoice_not_found_error.xml"))
+
+      # Get referenced invoice with line items
+      @gateway.stubs(:http_get).with {|client, url, params, headers| url =~ INVOICE_GET_URL && headers["Accept"].blank? }.returns(get_file_as_string("invoice.xml"))
     end
   end
-  
+
   def test_get_invoices
     # Make sure there is an invoice in Xero to retrieve
     invoice = @gateway.create_invoice(dummy_invoice).invoice
-    
+
     result = @gateway.get_invoices
     assert result.success?
     assert !result.request_params.nil?
-    assert !result.response_xml.nil?  
+    assert !result.response_xml.nil?
     assert result.invoices.collect {|i| i.invoice_number}.include?(invoice.invoice_number)
     assert result.invoices[0].sent_to_contact == true
     assert result.invoices[1].sent_to_contact == false
   end
-  
+
   def test_get_invoices_with_modified_since_date
     # Create a test invoice
     invoice = dummy_invoice
     @gateway.create_invoice(invoice)
-    
+
     # Check that it is returned
     result = @gateway.get_invoices(:modified_since => Date.today - 1)
     assert result.success?
     assert !result.request_params.nil?
-    assert !result.response_xml.nil?    
+    assert !result.response_xml.nil?
     assert result.request_params.keys.include?(:ModifiedAfter) # make sure the flag was sent
     assert result.invoices.collect {|response_invoice| response_invoice.invoice_number}.include?(invoice.invoice_number)
   end
-  
+
   def test_line_items_downloaded_set_correctly
     # No line items.
     response = @gateway.get_invoices
     assert_equal(true, response.success?)
-    
+
     invoice = response.invoices.first
     assert_kind_of(XeroGateway::Invoice, invoice)
     assert_equal(false, invoice.line_items_downloaded?)
+    assert_equal 1, invoice.line_items.size
+    line_item = invoice.line_items.first
+    assert_kind_of(XeroGateway::LineItem, line_item)
+    assert_equal 'A LINE ITEM', line_item.description
+    assert_equal 12.34, line_item.unit_amount
   end
-  
+
   # Make sure that a reference to gateway is passed when the get_invoices response is parsed.
   def test_get_contacts_gateway_reference
     result = @gateway.get_invoices
     assert(result.success?)
     assert_not_equal(0, result.invoices.size)
-    
+
     result.invoices.each do | invoice |
       assert(invoice.gateway === @gateway)
     end
   end
-  
+
   # Test to make sure that we correctly error when an invoice doesn't have an ID.
   # This should usually never be ecountered, but might if a draft invoice is deleted from Xero.
   def test_to_ensure_that_an_invoice_with_invalid_id_errors
     # Make sure there is an invoice to retrieve, even though we will mangle it later.
     invoice = @gateway.create_invoice(dummy_invoice).invoice
-    
+
     result = @gateway.get_invoices
     assert_equal(true, result.success?)
-    
+
     invoice = result.invoices.first
     assert_equal(false, invoice.line_items_downloaded?)
-    
+
     # Mangle invoice_id to invalid one.
     invoice.invoice_id = INVALID_INVOICE_ID
-    
+
     # Make sure we fail here.
     line_items = nil
     assert_raise(XeroGateway::InvoiceNotFoundError) { line_items = invoice.line_items }
     assert_nil(line_items)
-    
+
   end
-  
-end
+
+end

data/test/integration/get_organisation_test.rb

@@ -2,23 +2,24 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class GetOrganisationTest < 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 =~ /Organisation$/ }.returns(get_file_as_string("organisation.xml"))          
+
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ /Organisation$/ }.returns(get_file_as_string("organisation.xml"))
     end
   end
-  
+
   def test_get_organisation
     result = @gateway.get_organisation
     assert result.success?
     assert !result.response_xml.nil?
-    
+
     assert_equal XeroGateway::Organisation, result.organisation.class
     assert_equal "Demo Company (NZ)", result.organisation.name
+    assert_equal "c3d5e782-2153-4cda-bdb4-cec791ceb90d", result.organisation.organisation_id
   end
-end
+end

data/test/integration/get_tax_rates_test.rb

@@ -2,24 +2,24 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class GetTaxRatesTest < 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 =~ /TaxRates$/ }.returns(get_file_as_string("tax_rates.xml"))          
+
+      @gateway.stubs(:http_get).with {|client, url, params| url =~ /TaxRates$/ }.returns(get_file_as_string("tax_rates.xml"))
     end
   end
-  
+
   def test_get_tax_rates
     result = @gateway.get_tax_rates
     assert result.success?
     assert !result.response_xml.nil?
-    
+
     assert result.tax_rates.size > 0
     assert_equal XeroGateway::TaxRate, result.tax_rates.first.class
-    assert_equal "GST on Expenses", result.tax_rates.first.name
+    assert_equal "15% GST on Expenses", result.tax_rates.first.name
   end
-end
+end

data/test/test_helper.rb

@@ -102,7 +102,7 @@ module TestHelper
   end
 
   def get_file(filename)
-    data = File.read( File.dirname(__FILE__) + "/stub_responses/" + filename)
+    File.read( File.dirname(__FILE__) + "/stub_responses/" + filename)
   end
 
   def create_test_bank_transaction(params={}, contact_params={}, line_item_params={})