tlconnor-xero_gateway 1.0.2 → 1.0.3

data/lib/xero_gateway/messages/contact_message.rb

@@ -1,93 +0,0 @@
-module XeroGateway
-  module Messages
-    class ContactMessage
-      include Dates
-      
-      def self.build_xml(contact)
-        b = Builder::XmlMarkup.new
-        
-        b.Contact {
-          b.ContactID contact.contact_id if contact.contact_id
-          b.ContactNumber contact.contact_number if contact.contact_number
-          b.Name contact.name
-          b.EmailAddress contact.email if contact.email
-          b.Addresses {
-            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 {
-            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
-          }
-        }
-      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
-end

data/lib/xero_gateway/messages/invoice_message.rb

@@ -1,122 +0,0 @@
-module XeroGateway
-  module Messages
-    class InvoiceMessage
-      include Dates
-      include Money
-      
-      def self.build_xml(invoice)
-        b = Builder::XmlMarkup.new
-        
-        b.Invoice {
-          b.InvoiceType invoice.invoice_type
-          b.Contact {
-            b.ContactID invoice.contact.contact_id if invoice.contact.contact_id
-            b.Name invoice.contact.name
-            b.EmailAddress invoice.contact.email if invoice.contact.email
-            b.Addresses {
-              invoice.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 {
-              invoice.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 format_date_time(invoice.date)
-          b.DueDate format_date_time(invoice.due_date) if invoice.due_date
-          b.InvoiceNumber invoice.invoice_number
-          b.Reference invoice.reference if invoice.reference
-          b.TaxInclusive invoice.tax_inclusive if invoice.tax_inclusive
-          b.IncludesTax invoice.includes_tax
-          b.SubTotal format_money(invoice.sub_total) if invoice.sub_total
-          b.TotalTax format_money(invoice.total_tax) if invoice.total_tax
-          b.Total format_money(invoice.total) if invoice.total
-          b.LineItems {
-            invoice.line_items.each do |line_item|
-              b.LineItem {
-                b.Description line_item.description
-                b.Quantity line_item.quantity if line_item.quantity
-                b.UnitAmount format_money(line_item.unit_amount)
-                b.TaxType line_item.tax_type if line_item.tax_type
-                b.TaxAmount format_money(line_item.tax_amount) if line_item.tax_amount
-                b.LineAmount 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
-      
-      # Take an Invoice element and convert it into an Invoice object
-      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 = ContactMessage.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
-end

data/lib/xero_gateway/messages/tracking_category_message.rb

@@ -1,32 +0,0 @@
-module XeroGateway
-  module Messages
-    class TrackingCategoryMessage      
-      
-      def self.build_xml(tracking_category)
-        b = Builder::XmlMarkup.new
-        
-        b.TrackingCategory {
-          b.Name tracking_category.name
-          b.Options {
-            tracking_category.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
-end

data/test/integration/integration_test_methods.rb

@@ -1,64 +0,0 @@
-module IntegrationTestMethods
-  # The integration tests can be run against the Xero test environment.  You mush have a company set up in the test
-  # environment, and you must have set up a customer key for that account.
-  #
-  # You can then run the tests against the test environment using the commands (linux or mac):
-  # export STUB_XERO_CALLS=false
-  # export API_KEY=[your_api_key]
-  # export CUSTOMER_KEY=[your_customer_key]
-  # rake test
-  STUB_XERO_CALLS = ENV["STUB_XERO_CALLS"].nil? ? true : (ENV["STUB_XERO_CALLS"] == "true") unless defined? STUB_XERO_CALLS
-  
-  API_KEY = ENV["API_KEY"] unless defined? API_KEY
-  CUSTOMER_KEY = ENV["CUSTOMER_KEY"] unless defined? CUSTOMER_KEY
-
-  
-  def dummy_invoice
-     invoice = XeroGateway::Invoice.new({
-       :invoice_type => "ACCREC",
-       :due_date => Date.today + 20,
-       :invoice_number => STUB_XERO_CALLS ? "INV-0001" : "#{Time.now.to_f}",
-       :reference => "YOUR REFERENCE (NOT NECESSARILY UNIQUE!)",
-       :sub_total => 1000,
-       :total_tax => 125,
-       :total => 1125
-     })
-     invoice.contact = dummy_contact
-     invoice.line_items << XeroGateway::LineItem.new(
-       :description => "THE DESCRIPTION OF THE LINE ITEM",
-       :unit_amount => 1000,
-       :tax_amount => 125,
-       :line_amount => 1000,
-       :tracking_category => "THE TRACKING CATEGORY FOR THE LINE ITEM",
-       :tracking_option => "THE TRACKING OPTION FOR THE LINE ITEM"
-     )
-     invoice
-  end
-  
-  def dummy_contact
-    unique_id = Time.now.to_f
-    contact = XeroGateway::Contact.new(:name => STUB_XERO_CALLS ? "CONTACT NAME" : "THE NAME OF THE CONTACT #{unique_id}")
-    contact.email = "bob#{unique_id}@example.com"
-    contact.phone.number = "12345"
-    contact.address.line_1 = "LINE 1 OF THE ADDRESS"
-    contact.address.line_2 = "LINE 2 OF THE ADDRESS"
-    contact.address.line_3 = "LINE 3 OF THE ADDRESS"
-    contact.address.line_4 = "LINE 4 OF THE ADDRESS"
-    contact.address.city = "WELLINGTON"
-    contact.address.region = "WELLINGTON"
-    contact.address.country = "NEW ZEALAND"
-    contact.address.post_code = "6021"
-
-    contact
-  end
-  
-  def get_file_as_string(filename)
-    data = ''
-    f = File.open(File.dirname(__FILE__) + "/stub_responses/" + filename, "r") 
-    f.each_line do |line|
-      data += line
-    end
-    f.close
-    return data
-  end
-end

data/test/integration/stub_responses/accounts.xml

@@ -1 +0,0 @@
-<?xml version="1.0"?><Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><ID>cf37ba46-29a7-4824-ad63-43482463afed</ID><Status>OK</Status><ProviderName>WebStock</ProviderName><DateTimeUTC>2008-12-01T08:39:54.70175Z</DateTimeUTC><Accounts><Account><Code>200</Code><Name>Sales</Name><Type>REVENUE</Type><TaxType>OUTPUT</TaxType><Description>Income from any normal business activity</Description></Account><Account><Code>260</Code><Name>Other Revenue</Name><Type>REVENUE</Type><TaxType>OUTPUT</TaxType><Description>Any other income that does not relate to normal business activities and is not recurring</Description></Account><Account><Code>270</Code><Name>Interest Income</Name><Type>REVENUE</Type><TaxType>NONE</TaxType><Description>Gross interest income (i.e. before deducting Residential Withholding Tax), such as bank interest</Description></Account><Account><Code>400</Code><Name>Advertising</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred for advertising while trying to increase sales</Description></Account><Account><Code>404</Code><Name>Bank Fees</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>Fees charged by your bank for transactions regarding your bank account(s).</Description></Account><Account><Code>408</Code><Name>Cleaning</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred for cleaning  business property.</Description></Account><Account><Code>412</Code><Name>Consulting &amp; Accounting</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses related to paying consultants</Description></Account><Account><Code>416</Code><Name>Depreciation</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>The amount of the asset's cost (based on the useful life) that was consumed during the period</Description></Account><Account><Code>420</Code><Name>Entertainment</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>50% of the total expense relating to business-related entertainment. E.g. shouting clients or employees  a drink or a meal etc.</Description></Account><Account><Code>424</Code><Name>Entertainment - Non deductible</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>Expenses paid by company for the business but are not deductable for income tax purposes.</Description></Account><Account><Code>425</Code><Name>Freight &amp; Courier</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred on courier &amp; freight costs</Description></Account><Account><Code>429</Code><Name>General Expenses</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>General expenses related to the running of the business.</Description></Account><Account><Code>433</Code><Name>Insurance</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred for insuring the business' assets</Description></Account><Account><Code>437</Code><Name>Interest Expense</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>Any interest expenses paid to IRD, business bank accounts or credit card accounts.</Description></Account><Account><Code>441</Code><Name>Legal expenses</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred on any legal matters</Description></Account><Account><Code>445</Code><Name>Light, Power, Heating</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred for lighting, powering or heating the premises</Description></Account><Account><Code>449</Code><Name>Motor Vehicle Expenses</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred on the running of company motor vehicles</Description></Account><Account><Code>453</Code><Name>Office Expenses</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>General expenses related to the running of the business office.</Description></Account><Account><Code>461</Code><Name>Printing &amp; Stationery</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred by the entity as a result of printing and stationery</Description></Account><Account><Code>469</Code><Name>Rent</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>The payment to lease a building or area.</Description></Account><Account><Code>473</Code><Name>Repairs and Maintenance</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred on a damaged or run down asset that will bring the asset back to its original condition.</Description></Account><Account><Code>477</Code><Name>Salaries</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>Payment to employees in exchange for their resources</Description></Account><Account><Code>478</Code><Name>KiwiSaver Employer Contributions</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>KiwiSaver employer contributions</Description></Account><Account><Code>485</Code><Name>Subscriptions</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>E.g. Magazines, professional bodies.</Description></Account><Account><Code>489</Code><Name>Telephone &amp; Internet</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenditure incurred from any business-related phone calls, phone lines, or internet connections</Description></Account><Account><Code>493</Code><Name>Travel - National</Name><Type>OVERHEADS</Type><TaxType>INPUT</TaxType><Description>Expenses incurred from domestic travel which has a business purpose</Description></Account><Account><Code>494</Code><Name>Travel - International</Name><Type>OVERHEADS</Type><TaxType>NONE</TaxType><Description>Expenses incurred from international travel which has a business purpose</Description></Account><Account><Code>505</Code><Name>Income Tax Expense</Name><Type>EXPENSE</Type><TaxType>NONE</TaxType><Description>A percentage of total earnings paid to the government.</Description></Account><Account><Code>610</Code><Name>Accounts Receivable</Name><Type>CURRENT</Type><TaxType>NONE</TaxType><Description>Outstanding invoices the company has issued out to the client but has not yet received in cash at balance date.</Description></Account><Account><Code>611</Code><Name>less Provision for Doubtful Debts</Name><Type>CURRENT</Type><TaxType>NONE</TaxType><Description>A provision anticipating that some of the accounts receivables will become bad debts.</Description></Account><Account><Code>620</Code><Name>Prepayments</Name><Type>CURRENT</Type><TaxType>NONE</TaxType><Description>An expenditure that has been paid for in advance.</Description></Account><Account><Code>625</Code><Name>Withholding tax paid</Name><Type>CURRENT</Type><TaxType>NONE</TaxType><Description>Withholding tax paid</Description></Account><Account><Code>710</Code><Name>Office Equipment</Name><Type>FIXED</Type><TaxType>INPUT</TaxType><Description>Office equipment that is owned and controlled by the business</Description></Account><Account><Code>711</Code><Name>Less Accumulated Depreciation on Office Equipment</Name><Type>FIXED</Type><TaxType>NONE</TaxType><Description>The total amount of office equipment cost that has been consumed by the entity (based on the useful life)</Description></Account><Account><Code>720</Code><Name>Computer Equipment</Name><Type>FIXED</Type><TaxType>INPUT</TaxType><Description>Computer equipment that is owned and controlled by the business</Description></Account><Account><Code>721</Code><Name>Less Accumulated Depreciation on Computer Equipment</Name><Type>FIXED</Type><TaxType>NONE</TaxType><Description>The total amount of computer equipment cost that has been consumed by the business (based on the useful life)</Description></Account><Account><Code>800</Code><Name>Accounts Payable</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>Outstanding invoices the company has received from suppliers but has not yet paid at balance date</Description></Account><Account><Code>801</Code><Name>Unpaid Expense Claims</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>Expense claims typically made by employees/shareholder employees still outstanding.</Description></Account><Account><Code>820</Code><Name>GST</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>The balance in this account represents GST owing to or from the IRD. At the end of the GST period, it is this account that should be used to code against either the 'refunds from' or 'payments to' the IRD that will appear on the bank statement. Xero has been designed to use only one GST account to track GST on income and expenses, so there is no need to add any new GST accounts to Xero.</Description></Account><Account><Code>821</Code><Name>GST On Imports</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>GST paid to customs.</Description></Account><Account><Code>825</Code><Name>PAYE Payable</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>The amount of PAYE tax that is due to be paid</Description></Account><Account><Code>830</Code><Name>Income Tax</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>The amount of income tax that is due to be paid, also resident withholding tax paid on interest received.</Description></Account><Account><Code>840</Code><Name>Historical Adjustment</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>For accountant adjustments</Description></Account><Account><Code>850</Code><Name>Suspense</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>An entry that allows an unknown transaction to be entered, so the accounts can still be worked on in balance and the entry can be dealt with later.</Description></Account><Account><Code>860</Code><Name>Rounding</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>An adjustment entry to allow for rounding</Description></Account><Account><Code>877</Code><Name>Tracking Transfers</Name><Type>CURRLIAB</Type><TaxType>NONE</TaxType><Description>Transfers between tracking categories</Description></Account><Account><Code>900</Code><Name>Loan</Name><Type>TERMLIAB</Type><TaxType>NONE</TaxType><Description>Money that has been borrowed from a creditor</Description></Account><Account><Code>960</Code><Name>Retained Earnings</Name><Type>EQUITY</Type><TaxType>NONE</TaxType><Description>Do not Use</Description></Account><Account><Code>970</Code><Name>Owner A Funds Introduced</Name><Type>EQUITY</Type><TaxType>NONE</TaxType><Description>Funds contributed by the owner</Description></Account><Account><Code>980</Code><Name>Owner A Drawings</Name><Type>EQUITY</Type><TaxType>NONE</TaxType><Description>Withdrawals by the owners</Description></Account></Accounts></Response>