xero_gateway 2.1.0 → 2.3.0

data/lib/xero_gateway/http.rb

@@ -79,15 +79,20 @@ module XeroGateway
             handle_oauth_error!(response)
           when 404
             handle_object_not_found!(response, url)
+          when 500..504
+            # Xero sends certain oauth errors back as 500 errors
+            handle_oauth_error!(response)
           else
             raise "Unknown response code: #{response.code.to_i}"
         end
       end
 
       def handle_oauth_error!(response)
-        error_details = CGI.parse(response.plain_body)
+        error_details = CGI.parse(response.plain_body.strip)
         description   = error_details["oauth_problem_advice"].first
 
+        description = "No description found: #{response.plain_body}" if description.blank?
+
         # see http://oauth.pbworks.com/ProblemReporting
         # In addition to token_expired and token_rejected, Xero also returns
         # 'rate limit exceeded' when more than 60 requests have been made in
@@ -97,7 +102,9 @@ module XeroGateway
           when "consumer_key_unknown" then raise OAuth::TokenInvalid.new(description)
           when "token_rejected"       then raise OAuth::TokenInvalid.new(description)
           when "rate limit exceeded"  then raise OAuth::RateLimitExceeded.new(description)
-          else raise OAuth::UnknownError.new(error_details["oauth_problem"].first + ':' + description)
+          else
+            message = (error_details["oauth_problem"].first || "Unknown Error") + ': ' + description
+            raise OAuth::UnknownError.new(message)
         end
       end
 
@@ -111,26 +118,27 @@ module XeroGateway
 
         doc = REXML::Document.new(raw_response, :ignore_whitespace_nodes => :all)
 
-        if doc.root.name == "ApiException"
+        if doc.root.nil? || doc.root.name != "ApiException"
+
+          raise "Unparseable 400 Response: #{raw_response}"
+
+        else
 
           raise ApiException.new(doc.root.elements["Type"].text,
                                  doc.root.elements["Message"].text,
                                  request_xml,
                                  raw_response)
 
-        else
-
-          raise "Unparseable 400 Response: #{raw_response}"
-
         end
-
       end
 
       def handle_object_not_found!(response, request_url)
         case(request_url)
           when /Invoices/ then raise InvoiceNotFoundError.new("Invoice not found in Xero.")
           when /BankTransactions/ then raise BankTransactionNotFoundError.new("Bank Transaction not found in Xero.")
+          when /Payments/ then raise PaymentNotFoundError.new("Payments not found in Xero.")
           when /CreditNotes/ then raise CreditNoteNotFoundError.new("Credit Note not found in Xero.")
+          when /ManualJournals/ then raise ManualJournalNotFoundError.new("Manual Journal not found in Xero.")
           else raise ObjectNotFound.new(request_url)
         end
       end

data/lib/xero_gateway/invoice.rb

@@ -37,9 +37,8 @@ module XeroGateway
     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
+    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
 
-    
     def initialize(params = {})
       @errors ||= []
       @payments ||= []
@@ -123,7 +122,13 @@ module XeroGateway
     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?
@@ -215,6 +220,7 @@ module XeroGateway
           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)
+          when "UpdatedDateUTC" then invoice.updated_date_utc = parse_date(element.text)
           when "Status" then invoice.invoice_status = element.text
           when "Reference" then invoice.reference = element.text
           when "BrandingThemeID" then invoice.branding_theme_id = element.text

data/lib/xero_gateway/item.rb

@@ -0,0 +1,27 @@
+module XeroGateway
+  class Item < BaseRecord
+    attributes({
+        "ItemID" => :string,
+        "Code"          => :string,
+        "InventoryAssetAccountCode" => :string,
+        "Name"          => :string,
+        "IsSold"        => :boolean,
+        "IsPurchased"   => :boolean,
+        "Description"   => :string,
+        "PurchaseDescription" => :string,
+        "IsTrackedAsInventory" => :boolean,
+        "TotalCostPool" => :float,
+        "QuantityOnHand" => :integer,
+
+        "SalesDetails"  => {
+          "UnitPrice"     => :float,
+          "AccountCode"   => :string
+        },
+
+        "PurchaseDetails" => {
+          "UnitPrice"     => :float,
+          "AccountCode"   => :string
+        }
+    })
+  end
+end

data/lib/xero_gateway/line_item_calculations.rb

@@ -20,7 +20,7 @@ module XeroGateway
 
     # 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) }
+      !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).
@@ -32,7 +32,7 @@ module XeroGateway
 
     # 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) }
+      !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).
@@ -44,7 +44,7 @@ module XeroGateway
 
     # Calculate the toal as sub_total + total_tax.
     def total
-      sub_total + total_tax
+      !line_items_downloaded? && @total || (sub_total + total_tax)
     end
 
   end

data/lib/xero_gateway/manual_journal.rb

@@ -2,6 +2,9 @@ module XeroGateway
   class ManualJournal
   	include Dates
 
+  	class Error < RuntimeError; end
+    class NoGatewayError < Error; end
+
     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)
 
     STATUSES = {
@@ -121,7 +124,7 @@ module XeroGateway
     def to_xml(b = Builder::XmlMarkup.new)
       b.ManualJournal {
         b.ManualJournalID manual_journal_id if manual_journal_id
-        b.Narration narration        
+        b.Narration narration
         b.JournalLines {
           self.journal_lines.each do |journal_line|
             journal_line.to_xml(b)
@@ -160,4 +163,4 @@ module XeroGateway
     end
 
   end
-end
+end

data/lib/xero_gateway/organisation.rb

@@ -1,75 +1,24 @@
 module XeroGateway
-  class Organisation
-    
-    unless defined? ATTRS
-      ATTRS = {
-        "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
-        "Version"   	          => :string,     # See Version Types
-        "BaseCurrency"          => :string,     # Default currency for organisation. See Currency types
-        "OrganisationType"      => :string,     # UNDOCUMENTED parameter, only returned for "real" (i.e non-demo) companies
-        "OrganisationStatus"    => :string,   # UNDOCUMENTED parameter
-        "IsDemoCompany"         => :boolean,    # UNDOCUMENTED parameter
-        "APIKey"                => :string,     # UNDOCUMENTED paramater, returned if organisations are linked via Xero Network
-        "CountryCode"           => :string,      # UNDOCUMENTED parameter
-        "TaxNumber"             => :string,
-        "FinancialYearEndDay"   => :string,
-        "FinancialYearEndMonth" => :string,
-        "PeriodLockDate"        => :string,
-        "CreatedDateUTC"        => :string        
-      }
-    end
-    
-    attr_accessor *ATTRS.keys.map(&:underscore)
-    
-    def initialize(params = {})
-      params.each do |k,v|
-        self.send("#{k}=", v)
-      end
-    end
-    
-    def ==(other)
-      ATTRS.keys.map(&:underscore).each do |field|
-        return false if send(field) != other.send(field)
-      end
-      return true
-    end
-    
-    def to_xml
-      b = Builder::XmlMarkup.new
-      
-      b.Organisation do
-        ATTRS.keys.each do |attr|
-          eval("b.#{attr} '#{self.send(attr.underscore.to_sym)}'")
-        end
-      end
-    end
-    
-    def self.from_xml(organisation_element)
-      Organisation.new.tap do |org|
-        organisation_element.children.each do |element|
-        
-          attribute             = element.name
-          underscored_attribute = element.name.underscore
-        
-          if ATTRS.keys.include?(attribute)
-                  
-            case (ATTRS[attribute])
-              when :boolean then  org.send("#{underscored_attribute}=", (element.text == "true"))
-              when :float   then  org.send("#{underscored_attribute}=", element.text.to_f)
-              else                org.send("#{underscored_attribute}=", element.text)
-            end
-            
-          else
-            
-            warn "Ignoring unknown attribute: #{attribute}" 
-            
-          end
-          
-        end
-      end
-    end
-    
+  class Organisation < BaseRecord
+    attributes({
+      "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
+      "Version"   	          => :string,     # See Version Types
+      "BaseCurrency"          => :string,     # Default currency for organisation. See Currency types
+      "OrganisationType"      => :string,     # only returned for "real" (i.e non-demo) companies
+      "OrganisationStatus"    => :string,
+      "IsDemoCompany"         => :boolean,
+      "APIKey"                => :string,     # returned if organisations are linked via Xero Network
+      "CountryCode"           => :string,
+      "TaxNumber"             => :string,
+      "FinancialYearEndDay"   => :string,
+      "FinancialYearEndMonth" => :string,
+      "PeriodLockDate"        => :string,
+      "CreatedDateUTC"        => :string,
+      "ShortCode"             => :string,
+      "Timezone"              => :string,
+      "LineOfBusiness"        => :string
+    })
   end
-end
+end

data/lib/xero_gateway/payment.rb

@@ -7,7 +7,8 @@ module XeroGateway
     attr_reader :errors
 
     # All accessible fields
-    attr_accessor :invoice_id, :invoice_number, :account_id, :code, :payment_id, :date, :amount, :reference, :currency_rate
+    attr_accessor :invoice_id, :invoice_number, :account_id, :code, :payment_id, :payment_type, :date, :amount, :reference, :currency_rate, :updated_at, :reconciled
+    alias_method :reconciled?, :reconciled
 
     def initialize(params = {})
       @errors ||= []
@@ -21,13 +22,18 @@ module XeroGateway
       payment = Payment.new
       payment_element.children.each do | element |
         case element.name
-          when 'PaymentID'    then payment.payment_id = element.text
-          when 'Date'         then payment.date = parse_date_time(element.text)
-          when 'Amount'       then payment.amount = BigDecimal.new(element.text)
-          when 'Reference'    then payment.reference = element.text
-          when 'CurrencyRate' then payment.currency_rate = BigDecimal.new(element.text)
-          when 'Invoice'      then payment.send("#{element.children.first.name.underscore}=", element.children.first.text)
-          when 'Account'      then payment.send("#{element.children.first.name.underscore}=", element.children.first.text)
+          when 'PaymentID'      then payment.payment_id = element.text
+          when 'PaymentType'    then payment.payment_type = element.text
+          when 'Date'           then payment.date = parse_date_time(element.text)
+          when 'UpdatedDateUTC' then payment.updated_at = parse_date_time(element.text)
+          when 'Amount'         then payment.amount = BigDecimal.new(element.text)
+          when 'Reference'      then payment.reference = element.text
+          when 'CurrencyRate'   then payment.currency_rate = BigDecimal.new(element.text)
+          when 'Invoice'
+            payment.invoice_id = element.elements["//InvoiceID"].text
+            payment.invoice_number = element.elements["//InvoiceNumber"].text
+          when 'IsReconciled'   then payment.reconciled = (element.text == "true")
+          when 'Account'        then payment.account_id = element.elements["//AccountID"].text
         end
       end
       payment
@@ -43,6 +49,9 @@ module XeroGateway
     def to_xml(b = Builder::XmlMarkup.new)
       b.Payment do
 
+        b.PaymentID          self.payment_id        if self.payment_id
+        b.PaymentType        self.payment_type      if self.payment_type
+
         if self.invoice_id || self.invoice_number
           b.Invoice do |i|
             i.InvoiceID         self.invoice_id     if self.invoice_id
@@ -61,10 +70,14 @@ module XeroGateway
         b.CurrencyRate      self.currency_rate  if self.currency_rate
         b.Reference         self.reference      if self.reference
 
+        if self.reconciled?
+          b.IsReconciled true
+        end
+
         b.Date              self.class.format_date(self.date || Date.today)
       end
     end
 
 
   end
-end
+end

data/lib/xero_gateway/phone.rb

@@ -36,6 +36,8 @@ module XeroGateway
             
       unless number
         @errors << ['number', "can't be blank"]
+      else
+        @errors << ['number', "must 50 characters or less"] if number.length > 50
       end
       
       if phone_type && !PHONE_TYPE[phone_type]

data/lib/xero_gateway/report.rb

@@ -0,0 +1,95 @@
+module XeroGateway
+  class Report
+    include Money
+    include Dates
+
+    attr_reader   :errors
+    attr_accessor :report_id, :report_name, :report_type, :report_titles, :report_date, :updated_at,
+                  :body, :column_names
+
+    def initialize(params={})
+      @errors         ||= []
+      @report_titles  ||= []
+      @body           ||= []
+
+      params.each do |k,v|
+        self.send("#{k}=", v)
+      end
+    end
+
+    def self.from_xml(report_element)
+      report = Report.new
+      report_element.children.each do | element |
+        case element.name
+          when 'ReportID'         then report.report_id = element.text
+          when 'ReportName'       then report.report_name = element.text
+          when 'ReportType'       then report.report_type = element.text
+          when 'ReportTitles'
+            each_title(element) do |title|
+              report.report_titles << title
+            end
+          when 'ReportDate'       then report.report_date = Date.parse(element.text)
+          when 'UpdatedDateUTC'   then report.updated_at = parse_date_time_utc(element.text)
+          when 'Rows'
+            report.column_names   ||= find_body_column_names(element)
+            each_row_content(element) do |content_hash|
+              report.body << OpenStruct.new(content_hash)
+            end
+        end
+      end
+      report
+    end
+
+  private
+
+    def self.each_row_content(xml_element, &block)
+      column_names   = find_body_column_names(xml_element).keys
+      xpath_body     = REXML::XPath.first(xml_element, "//RowType[text()='Section']").parent
+      rows_contents  = []
+      xpath_body.elements.each("Rows/Row") do |xpath_cells|
+        values        = find_body_cell_values(xpath_cells)
+        content_hash  = Hash[column_names.zip values]
+        rows_contents << content_hash
+        yield content_hash if block_given?
+      end
+      rows_contents
+    end
+
+    def self.each_title(xml_element, &block)
+      xpath_titles = REXML::XPath.first(xml_element, "//ReportTitles")
+      xpath_titles.elements.each("//ReportTitle") do |xpath_title|
+        title = xpath_title.text.strip
+        yield title if block_given?
+      end
+    end
+
+    def self.find_body_cell_values(xml_cells)
+      values = []
+      xml_cells.elements.each("Cells/Cell") do |xml_cell|
+        if value = xml_cell.children.first # finds <Value>...</Value>
+          values << value.text.try(:strip)
+          next
+        end
+        values << nil
+      end
+      values
+    end
+
+    # returns something like { column_1: "Amount", column_2: "Description", ... }
+    def self.find_body_column_names(body)
+      header       = REXML::XPath.first(body, "//RowType[text()='Header']")
+      names_map    = {}
+      column_count = 0
+      header.parent.elements.each("Cells/Cell") do |header_cell|
+        column_count += 1
+        column_key    = "column_#{column_count}".to_sym
+        column_name   = nil
+        name_value    = header_cell.children.first
+        column_name   = name_value.text.strip unless name_value.blank? # finds <Value>...</Value>
+        names_map[column_key] = column_name
+      end
+      names_map
+    end
+
+  end
+end

data/lib/xero_gateway/response.rb

@@ -1,17 +1,20 @@
 module XeroGateway
   class Response
     attr_accessor :response_id, :status, :errors, :provider, :date_time, :response_item, :request_params, :request_xml, :response_xml
-    
+
     def array_wrapped_response_item
       Array(response_item)
     end
-    
+
     alias_method :invoice,              :response_item
     alias_method :credit_note,          :response_item
     alias_method :bank_transaction,     :response_item
     alias_method :manual_journal,       :response_item
     alias_method :contact,              :response_item
+    alias_method :contact_group,        :response_item
     alias_method :organisation,         :response_item
+    alias_method :report,               :response_item
+    alias_method :contact_groups,       :array_wrapped_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
@@ -20,22 +23,24 @@ module XeroGateway
     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 :items,            :array_wrapped_response_item
     alias_method :currencies,           :array_wrapped_response_item
-    
+    alias_method :payments,             :array_wrapped_response_item
+
     def initialize(params = {})
       params.each do |k,v|
         self.send("#{k}=", v)
       end
-      
+
       @errors ||= []
       @response_item ||= []
     end
-    
-    
+
+
     def success?
       status == "OK"
     end
-    
+
     def error
       errors.blank? ? nil : errors[0]
     end