tlconnor-xero_gateway 1.0.2 → 1.0.3

data/CHANGELOG.textile

@@ -1,9 +1,15 @@
-h2. 1.0.2, releases 04/12/2008
+h2. 1.0.3, released 09/12/2008
+
+* Major refactorings to DRY out gateway.rb
+* Removed all messages classes in favour of invoice.to_xml and Invoice.from_xml(element)
+* Added unit tests for the handing of errors from Xero
+
+h2. 1.0.2, released 04/12/2008
 
 * Added implementation of GET /api.xro/1.0/tracking
 
 
-h2. 1.0.1, releases 02/12/2008
+h2. 1.0.1, released 02/12/2008
 
 * Added implementation of GET /api.xro/1.0/accounts
 * Replaced Invoice.id, Contact.id etc with Invoice.invoice_id, Contact.contact_id to avoid Object.id errors

data/lib/xero_gateway/account.rb

@@ -15,5 +15,32 @@ module XeroGateway
       end
       return true
     end
+    
+    def to_xml
+      b = Builder::XmlMarkup.new
+      
+      b.Account {
+        b.Code self.code
+        b.Name self.name
+        b.Type self.type
+        b.TaxType self.tax_type
+        b.Description self.description
+      }
+    end
+    
+    def self.from_xml(account_element)
+      account = Account.new
+      account_element.children.each do |element|
+        case(element.name)
+          when "Code" then account.code = element.text
+          when "Name" then account.name = element.text
+          when "Type" then account.type = element.text
+          when "TaxType" then account.tax_type = element.text
+          when "Description" then account.description = element.text
+        end
+      end      
+      account
+    end
+    
   end
 end

data/lib/xero_gateway/contact.rb

@@ -1,5 +1,7 @@
 module XeroGateway
   class Contact
+    include Dates
+    
     attr_accessor :contact_id, :contact_number, :status, :name, :email, :addresses, :phones, :updated_at
     
     def initialize(params = {})
@@ -39,5 +41,91 @@ module XeroGateway
       end
       return true
     end
+    
+    def to_xml
+      b = Builder::XmlMarkup.new
+      
+      b.Contact {
+        b.ContactID self.contact_id if self.contact_id
+        b.ContactNumber self.contact_number if self.contact_number
+        b.Name self.name
+        b.EmailAddress self.email if self.email
+        b.Addresses {
+          self.addresses.each do |address|
+            b.Address {
+              b.AddressType address.address_type
+              b.AddressLine1 address.line_1 if address.line_1
+              b.AddressLine2 address.line_2 if address.line_2
+              b.AddressLine3 address.line_3 if address.line_3
+              b.AddressLine4 address.line_4 if address.line_4
+              b.City address.city if address.city
+              b.Region address.region if address.region
+              b.PostalCode address.post_code if address.post_code
+              b.Country address.country if address.country
+            }
+          end
+        }
+        b.Phones {
+          self.phones.each do |phone|
+            b.Phone {
+              b.PhoneType phone.phone_type
+              b.PhoneNumber phone.number
+              b.PhoneAreaCode phone.area_code if phone.area_code
+              b.PhoneCountryCode phone.country_code if phone.country_code
+            }
+          end
+        }
+      }
+    end
+    
+    # Take a Contact element and convert it into an Contact object
+    def self.from_xml(contact_element)
+      contact = Contact.new
+      contact_element.children.each do |element|
+        case(element.name)
+          when "ContactID" then contact.contact_id = element.text
+          when "ContactNumber" then contact.contact_number = element.text
+          when "ContactStatus" then contact.status = element.text
+          when "Name" then contact.name = element.text
+          when "EmailAddress" then contact.email = element.text
+          when "Addresses" then element.children.each {|address| contact.addresses << parse_address(address)}
+          when "Phones" then element.children.each {|phone| contact.phones << parse_phone(phone)}
+        end
+      end
+      contact
+    end
+    
+    private
+    
+    def self.parse_address(address_element)
+      address = Address.new
+      address_element.children.each do |element|
+        case(element.name)
+          when "AddressType" then address.address_type = element.text
+          when "AddressLine1" then address.line_1 = element.text
+          when "AddressLine2" then address.line_2 = element.text
+          when "AddressLine3" then address.line_3 = element.text
+          when "AddressLine4" then address.line_4 = element.text        
+          when "City" then address.city = element.text
+          when "Region" then address.region = element.text
+          when "PostalCode" then address.post_code = element.text
+          when "Country" then address.country = element.text
+        end
+      end
+      address
+    end
+    
+    def self.parse_phone(phone_element)
+      phone = Phone.new
+      phone_element.children.each do |element|
+        case(element.name)
+          when "PhoneType" then phone.phone_type = element.text
+          when "PhoneNumber" then phone.number = element.text
+          when "PhoneAreaCode" then phone.area_code = element.text
+          when "PhoneCountryCode" then phone.country_code = element.text      
+        end
+      end
+      phone
+    end    
   end
 end

data/lib/xero_gateway/error.rb

@@ -0,0 +1,19 @@
+module XeroGateway
+  class Error
+    attr_accessor :description, :date_time, :type, :message
+    
+    def initialize(params = {})
+      params.each do |k,v|
+        self.instance_variable_set("@#{k}", v)  ## create and initialize an instance variable for this key/value pair
+        self.send("#{k}=", v)
+      end
+    end
+    
+    def ==(other)
+      [:description, :date_time, :type, :message].each do |field|
+        return false if send(field) != other.send(field)
+      end
+      return true
+    end
+  end
+end

data/lib/xero_gateway/gateway.rb

@@ -20,23 +20,7 @@ module XeroGateway
     
       response_xml = http_get("#{@xero_url}/contacts", request_params)
     
-      doc = REXML::Document.new(response_xml)
-    
-      # Create the response object
-      response = build_response(doc)
-
-      # Add the contacts to the response
-      if response.success?
-        response.response_item = []
-        REXML::XPath.each(doc, "/Response/Contacts/Contact") do |contact_element|
-          response.response_item << XeroGateway::Messages::ContactMessage.from_xml(contact_element)
-        end
-      end
-    
-      # Add the request and response XML to the response object
-      response.request_params = request_params
-      response.response_xml = response_xml
-      response
+      parse_response(response_xml, :request_params => request_params)
     end
     
     # Retrieve a contact from Xero
@@ -70,23 +54,10 @@ module XeroGateway
     #
     # create_contact(contact)
     def create_contact(contact)
-      request_xml = XeroGateway::Messages::ContactMessage.build_xml(contact)      
+      request_xml = contact.to_xml
       response_xml = http_put("#{@xero_url}/contact", request_xml, {})
 
-      doc = REXML::Document.new(response_xml)
-    
-      # Create the response object
-      response = build_response(doc)
-
-      # Add the invoice to the response
-      if response.success?
-        response.response_item = XeroGateway::Messages::ContactMessage.from_xml(REXML::XPath.first(doc, "/Response/Contact"))
-      end
-    
-      # Add the request and response XML to the response object
-      response.request_xml = request_xml
-      response.response_xml = response_xml
-      response      
+      parse_response(response_xml, :request_xml => request_xml)
     end
     
     #
@@ -101,24 +72,10 @@ module XeroGateway
     def update_contact(contact)
       raise "contact_id or contact_number is required for updating contacts" if contact.contact_id.nil? and contact.contact_number.nil?
       
-      request_xml = XeroGateway::Messages::ContactMessage.build_xml(contact)      
+      request_xml = contact.to_xml
       response_xml = http_post("#{@xero_url}/contact", request_xml, {})
 
-      doc = REXML::Document.new(response_xml)
-    
-      # Create the response object
-      response = build_response(doc)
-
-      # Add the invoice to the response
-      if response.success?
-        response.response_item = XeroGateway::Messages::ContactMessage.from_xml(REXML::XPath.first(doc, "/Response/Contact"))
-      end
-    
-      # Add the request and response XML to the response object
-      response.request_xml = request_xml
-      response.response_xml = response_xml
-    
-      response
+      parse_response(response_xml, :request_xml => request_xml)
     end
 
     # Retrieves an invoice from Xero based on its GUID
@@ -144,23 +101,7 @@ module XeroGateway
     
       response_xml = http_get("#{@xero_url}/invoices", request_params)
 
-      doc = REXML::Document.new(response_xml)
-    
-      # Create the response object
-      response = build_response(doc)
-
-      # Add the invoices to the response
-      if response.success?
-        response.response_item = []
-        REXML::XPath.first(doc, "/Response/Invoices").children.each do |invoice_element|
-          response.response_item << XeroGateway::Messages::InvoiceMessage.from_xml(invoice_element)
-        end
-      end
-    
-      # Add the request and response XML to the response object
-      response.request_params = request_params
-      response.response_xml = response_xml
-      response      
+      parse_response(response_xml, :request_params => request_params)
     end
   
     # Creates an invoice in Xero based on an invoice object
@@ -191,24 +132,10 @@ module XeroGateway
     #
     #    create_invoice(invoice)
     def create_invoice(invoice)
-      request_xml = XeroGateway::Messages::InvoiceMessage.build_xml(invoice)      
+      request_xml = invoice.to_xml
       response_xml = http_put("#{@xero_url}/invoice", request_xml)
 
-      doc = REXML::Document.new(response_xml)
-    
-      # Create the response object
-      response = build_response(doc)
-
-      # Add the invoice to the response
-      if response.success?
-        response.response_item = XeroGateway::Messages::InvoiceMessage.from_xml(REXML::XPath.first(doc, "/Response/Invoice"))
-      end
-    
-      # Add the request and response XML to the response object
-      response.request_xml = request_xml
-      response.response_xml = response_xml
-    
-      response
+      parse_response(response_xml, :request_xml => request_xml)
     end
 
     #
@@ -216,21 +143,7 @@ module XeroGateway
     #
     def get_accounts
       response_xml = http_get("#{xero_url}/accounts")
-      
-      doc = REXML::Document.new(response_xml)
-    
-      # Create the response object
-      response = build_response(doc)
-
-      # Add the accounts to the response
-      response.response_item = []
-      REXML::XPath.first(doc, "/Response/Accounts").children.each do |account_element|
-        response.response_item << XeroGateway::Messages::AccountMessage.from_xml(account_element)
-      end
-      
-      # Add the request and response XML to the response object
-      response.response_xml = response_xml
-      response
+      parse_response(response_xml)
     end
 
     #
@@ -238,21 +151,7 @@ module XeroGateway
     #
     def get_tracking_categories
       response_xml = http_get("#{xero_url}/tracking")
-      
-      doc = REXML::Document.new(response_xml)
-    
-      # Create the response object
-      response = build_response(doc)
-
-      # Add the accounts to the response
-      response.response_item = []
-      REXML::XPath.first(doc, "/Response/Tracking").children.each do |tracking_category_element|
-        response.response_item << XeroGateway::Messages::TrackingCategoryMessage.from_xml(tracking_category_element)
-      end
-      
-      # Add the request and response XML to the response object
-      response.response_xml = response_xml
-      response
+      parse_response(response_xml)      
     end
 
 
@@ -261,61 +160,59 @@ module XeroGateway
     def get_invoice(invoice_id = nil, invoice_number = nil)
       request_params = invoice_id ? {:invoiceID => invoice_id} : {:invoiceNumber => invoice_number}
       response_xml = http_get("#{@xero_url}/invoice", request_params)
-    
-      doc = REXML::Document.new(response_xml)
-    
-      # Create the response object
-      response = build_response(doc)
 
-      # Add the invoice to the response
-      response.response_item = XeroGateway::Messages::InvoiceMessage.from_xml(REXML::XPath.first(doc, "/Response/Invoice")) if response.success?
-    
-      # Add the request and response XML to the response object
-      response.request_params = request_params
-      response.response_xml = response_xml
-      response
+      parse_response(response_xml, :request_params => request_params)
     end
 
     def get_contact(contact_id = nil, contact_number = nil)
       request_params = contact_id ? {:contactID => contact_id} : {:contactNumber => contact_number}
       response_xml = http_get("#{@xero_url}/contact", request_params)
-    
-      doc = REXML::Document.new(response_xml)
-    
-      # Create the response object
-      response = build_response(doc)
 
-      # Add the invoice to the response
-      response.response_item = XeroGateway::Messages::ContactMessage.from_xml(REXML::XPath.first(doc, "/Response/Contact")) if response.success?
-    
-      # Add the request and response XML to the response object
-      response.request_params = request_params
-      response.response_xml = response_xml
-      response
+      parse_response(response_xml, :request_params => request_params)
     end
-    
-    
-    
-    def build_response(response_document)
-      response = XeroGateway::Response.new({
-        :response_id => REXML::XPath.first(response_document, "/Response/ID").text,
-        :status => REXML::XPath.first(response_document, "/Response/Status").text,
-        :provider => REXML::XPath.first(response_document, "/Response/ProviderName").text,
-        :date_time => REXML::XPath.first(response_document, "/Response/DateTimeUTC").text,
-      })
-    
-      # Add any errors to the response object
-      if !response.success?
-        REXML::XPath.each(response_document, "/Response/Error") do |error|
-          response.errors << {
-            :date_time => REXML::XPath.first(error, "/DateTime").text,
-            :type => REXML::XPath.first(error, "/ExceptionType").text,
-            :message => REXML::XPath.first(error, "/Message").text           
-          }          
+
+    def parse_response(response_xml, request = {})
+      doc = REXML::Document.new(response_xml)
+
+      response = XeroGateway::Response.new
+
+      response_element = REXML::XPath.first(doc, "/Response")
+      
+      if response_element.nil?
+        # The Xero API documentation states that it will always return valid XML with
+        # a response element, unless an invalid API key is provided.
+        response.status = "INVALID_API_KEY"
+      else
+        response_element.children.each do |element|
+          case(element.name)
+            when "ID" then response.response_id = element.text
+            when "Status" then response.status = element.text
+            when "ProviderName" then response.provider = element.text
+            when "DateTimeUTC" then response.date_time = element.text
+            when "Contact" then response.response_item = Contact.from_xml(element)
+            when "Invoice" then response.response_item = Invoice.from_xml(element)
+            when "Contacts" then element.children.each {|child| response.response_item << Contact.from_xml(child) }
+            when "Invoices" then element.children.each {|child| response.response_item << Invoice.from_xml(child) }
+            when "Accounts" then element.children.each {|child| response.response_item << Account.from_xml(child) }
+            when "Tracking" then element.children.each {|child| response.response_item << TrackingCategory.from_xml(child) }
+            when "Errors" then element.children.each { |error| parse_error(error, response) }
+          end
         end
       end
-    
-      response      
+      
+      response.request_params = request[:request_params]
+      response.request_xml = request[:request_xml]
+      response.response_xml = response_xml
+      response
+    end    
+
+    def parse_error(error_element, response)
+      response.errors << Error.new(
+          :description => REXML::XPath.first(error_element, "Description").text,
+          :date_time => REXML::XPath.first(error_element, "//DateTime").text,
+          :type => REXML::XPath.first(error_element, "//ExceptionType").text,
+          :message => REXML::XPath.first(error_element, "//Message").text           
+      )
     end
-  end
+  end  
 end

data/lib/xero_gateway/invoice.rb

@@ -1,5 +1,8 @@
 module XeroGateway
   class Invoice
+    include Dates
+    include Money
+    
     # All accessible fields
     attr_accessor :invoice_id, :invoice_number, :invoice_type, :invoice_status, :date, :due_date, :reference, :tax_inclusive, :includes_tax, :sub_total, :total_tax, :total, :line_items, :contact
     
@@ -28,5 +31,118 @@ module XeroGateway
       end
       return true
     end
+    
+    def to_xml
+      b = Builder::XmlMarkup.new
+      
+      b.Invoice {
+        b.InvoiceType self.invoice_type
+        b.Contact {
+          b.ContactID self.contact.contact_id if self.contact.contact_id
+          b.Name self.contact.name
+          b.EmailAddress self.contact.email if self.contact.email
+          b.Addresses {
+            self.contact.addresses.each do |address|
+              b.Address {
+                b.AddressType address.address_type
+                b.AddressLine1 address.line_1 if address.line_1
+                b.AddressLine2 address.line_2 if address.line_2
+                b.AddressLine3 address.line_3 if address.line_3
+                b.AddressLine4 address.line_4 if address.line_4
+                b.City address.city if address.city
+                b.Region address.region if address.region
+                b.PostalCode address.post_code if address.post_code
+                b.Country address.country if address.country
+              }
+            end
+          }
+          b.Phones {
+            self.contact.phones.each do |phone|
+              b.Phone {
+                b.PhoneType phone.phone_type
+                b.PhoneNumber phone.number
+                b.PhoneAreaCode phone.area_code if phone.area_code
+                b.PhoneCountryCode phone.country_code if phone.country_code
+              }
+            end
+          }
+        }
+        b.InvoiceDate Invoice.format_date_time(self.date)
+        b.DueDate Invoice.format_date_time(self.due_date) if self.due_date
+        b.InvoiceNumber self.invoice_number
+        b.Reference self.reference if self.reference
+        b.TaxInclusive self.tax_inclusive if self.tax_inclusive
+        b.IncludesTax self.includes_tax
+        b.SubTotal Invoice.format_money(self.sub_total) if self.sub_total
+        b.TotalTax Invoice.format_money(self.total_tax) if self.total_tax
+        b.Total Invoice.format_money(self.total) if self.total
+        b.LineItems {
+          self.line_items.each do |line_item|
+            b.LineItem {
+              b.Description line_item.description
+              b.Quantity line_item.quantity if line_item.quantity
+              b.UnitAmount Invoice.format_money(line_item.unit_amount)
+              b.TaxType line_item.tax_type if line_item.tax_type
+              b.TaxAmount Invoice.format_money(line_item.tax_amount) if line_item.tax_amount
+              b.LineAmount Invoice.format_money(line_item.line_amount)
+              b.AccountCode line_item.account_code || 200
+              b.Tracking {
+                b.TrackingCategory {
+                  b.Name line_item.tracking_category
+                  b.Option line_item.tracking_option
+                }
+              }
+            }              
+          end
+        }
+      }
+    end
+    
+    def self.from_xml(invoice_element)        
+      invoice = Invoice.new
+      invoice_element.children.each do |element|
+        case(element.name)
+          when "InvoiceStatus" then invoice.invoice_status = element.text
+          when "InvoiceID" then invoice.invoice_id = element.text
+          when "InvoiceNumber" then invoice.invoice_number = element.text            
+          when "InvoiceType" then invoice.invoice_type = element.text
+          when "InvoiceDate" then invoice.date = parse_date_time(element.text)
+          when "DueDate" then invoice.due_date = parse_date_time(element.text)
+          when "Reference" then invoice.reference = element.text
+          when "TaxInclusive" then invoice.tax_inclusive = (element.text == "true")
+          when "IncludesTax" then invoice.includes_tax = (element.text == "true")
+          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 "Contact" then invoice.contact = Contact.from_xml(element)
+          when "LineItems" then element.children.each {|line_item| invoice.line_items << parse_line_item(line_item)}
+        end
+      end      
+      invoice
+    end
+    
+    private
+    
+    def self.parse_line_item(line_item_element)
+      line_item = LineItem.new
+      line_item_element.children.each do |element|
+        case(element.name)
+          when "LineItemID" then line_item.line_item_id = element.text
+          when "Description" then line_item.description = element.text
+          when "Quantity" then line_item.quantity = element.text.to_i
+          when "UnitAmount" then line_item.unit_amount = BigDecimal.new(element.text)
+          when "TaxType" then line_item.tax_type = element.text
+          when "TaxAmount" then line_item.tax_amount = BigDecimal.new(element.text)
+          when "LineAmount" then line_item.line_amount = BigDecimal.new(element.text)
+          when "AccountCode" then line_item.account_code = element.text
+          when "Tracking" then
+          if element.elements['TrackingCategory']
+            line_item.tracking_category = element.elements['TrackingCategory/Name'].text
+            line_item.tracking_option = element.elements['TrackingCategory/Option'].text
+          end
+        end
+      end
+      line_item
+    end
   end
 end

data/lib/xero_gateway/response.rb

@@ -18,6 +18,7 @@ module XeroGateway
       end
       
       @errors ||= []
+      @response_item ||= []
     end    
     
     def success?

data/lib/xero_gateway/tracking_category.rb

@@ -16,5 +16,31 @@ module XeroGateway
       end
       return true
     end
+    
+    def to_xml
+      b = Builder::XmlMarkup.new
+      
+      b.TrackingCategory {
+        b.Name self.name
+        b.Options {
+          self.options.each do |option|
+            b.Option {
+              b.Name option
+            }
+          end
+        }
+      }
+    end
+    
+    def self.from_xml(tracking_category_element)
+      tracking_category = TrackingCategory.new
+      tracking_category_element.children.each do |element|
+        case(element.name)
+          when "Name" then tracking_category.name = element.text
+          when "Options" then element.children.each {|option| tracking_category.options << option.children.first.text}
+        end
+      end
+      tracking_category              
+    end    
   end
 end

data/lib/xero_gateway.rb

@@ -15,9 +15,6 @@ require File.dirname(__FILE__) + "/xero_gateway/contact"
 require File.dirname(__FILE__) + "/xero_gateway/address"
 require File.dirname(__FILE__) + "/xero_gateway/phone"
 require File.dirname(__FILE__) + "/xero_gateway/account"
+require File.dirname(__FILE__) + "/xero_gateway/error"
 require File.dirname(__FILE__) + "/xero_gateway/tracking_category"
-require File.dirname(__FILE__) + "/xero_gateway/messages/contact_message"
-require File.dirname(__FILE__) + "/xero_gateway/messages/invoice_message"
-require File.dirname(__FILE__) + "/xero_gateway/messages/account_message"
-require File.dirname(__FILE__) + "/xero_gateway/messages/tracking_category_message"
 require File.dirname(__FILE__) + "/xero_gateway/gateway"

data/test/integration/create_contact_test.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class CreateContactTest < Test::Unit::TestCase
-  include IntegrationTestMethods
+  include TestHelper
   
   def setup
     @gateway = XeroGateway::Gateway.new(
@@ -22,6 +22,8 @@ class CreateContactTest < Test::Unit::TestCase
     result = @gateway.create_contact(example_contact)
     assert result.success?
     assert !result.contact.contact_id.nil?
+    assert !result.request_xml.nil?
+    assert !result.response_xml.nil?
     assert_equal result.contact.name, example_contact.name
   end
 end

data/test/integration/create_invoice_test.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class CreateInvoiceTest < Test::Unit::TestCase
-  include IntegrationTestMethods
+  include TestHelper
   
   def setup
     @gateway = XeroGateway::Gateway.new(
@@ -21,6 +21,8 @@ class CreateInvoiceTest < Test::Unit::TestCase
     
     result = @gateway.create_invoice(example_invoice)
     assert result.success?
+    assert !result.request_xml.nil?
+    assert !result.response_xml.nil?
     assert !result.invoice.invoice_id.nil?
     assert result.invoice.invoice_number == example_invoice.invoice_number
   end