xero_gateway-n8vision 2.0.20

data/init.rb

@@ -0,0 +1 @@
+require 'xero_gateway'

data/lib/oauth/oauth_consumer.rb

@@ -0,0 +1,14 @@
+module OAuth
+  class Consumer
+    
+    def http_with_ssl_client_certificates(*args)
+      @http ||= http_without_ssl_client_certificates(*args).tap do |http|
+        http.cert = options[:ssl_client_cert]
+        http.key  = options[:ssl_client_key]
+      end
+    end
+  
+    alias_method_chain :http, :ssl_client_certificates
+    
+  end
+end

data/lib/xero_gateway.rb

@@ -0,0 +1,41 @@
+require "cgi"
+require "uri"
+require "net/https"
+require "rexml/document"
+require "builder"
+require "bigdecimal"
+require "oauth"
+require 'oauth/signature/rsa/sha1'
+require "forwardable"
+require "active_support/all"
+
+require File.join(File.dirname(__FILE__), 'oauth', 'oauth_consumer')
+
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'http_encoding_helper')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'http')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'dates')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'money')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'line_item_calculations')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'response')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'account')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'accounts_list')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'tracking_category')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'contact')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'line_item')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'payment')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'invoice')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'bank_transaction')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'credit_note')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'journal_line')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'manual_journal')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'address')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'phone')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'organisation')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'tax_rate')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'currency')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'error')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'oauth')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'exceptions')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'gateway')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'private_app')
+require File.join(File.dirname(__FILE__), 'xero_gateway', 'partner_app')

data/lib/xero_gateway/account.rb

@@ -0,0 +1,86 @@
+module XeroGateway
+  class Account
+    
+    TYPE = {
+      'CURRENT' =>        '',
+      'FIXED' =>          '',
+      'PREPAYMENT' =>     '',
+      'EQUITY' =>         '',
+      'DEPRECIATN' =>     '',
+      'DIRECTCOSTS' =>    '',
+      'EXPENSE' =>        '',
+      'OVERHEADS' =>      '',
+      'CURRLIAB' =>       '',
+      'LIABILITY' =>      '',
+      'TERMLIAB' =>       '',
+      'OTHERINCOME' =>    '',
+      'REVENUE' =>        '',
+      'SALES' =>          ''
+    } unless defined?(TYPE)
+    
+    TAX_TYPE = {
+      'NONE' =>             'No GST',
+      'EXEMPTINPUT' =>      'VAT on expenses exempt from VAT (UK only)',
+      'INPUT' =>            'GST on expenses',
+      'SRINPUT' =>          'VAT on expenses',
+      'ZERORATEDINPUT' =>   'Expense purchased from overseas (UK only)',
+      'RRINPUT' =>          'Reduced rate VAT on expenses (UK Only)', 
+      'EXEMPTOUTPUT' =>     'VAT on sales exempt from VAT (UK only)',
+      'ECZROUTPUT' =>       'EC Zero-rated output',
+      'OUTPUT' =>           'OUTPUT (old rate)',
+      'OUTPUT2' =>          'OUTPUT2',
+      'SROUTPUT' =>         'SROUTPUT',
+      'ZERORATEDOUTPUT' =>  'Sales made from overseas (UK only)',
+      'RROUTPUT' =>         'Reduced rate VAT on sales (UK Only)',
+      'ZERORATED' =>        'Zero-rated supplies/sales from overseas (NZ Only)'
+    } unless defined?(TAX_TYPE)
+    
+    attr_accessor :account_id, :code, :name, :type, :tax_type, :description, :system_account, :enable_payments_to_account, :currency_code
+    
+    def initialize(params = {})
+      params.each do |k,v|
+        self.send("#{k}=", v)
+      end
+    end
+    
+    def ==(other)
+      [:account_id, :code, :name, :type, :tax_type, :description, :system_account, :enable_payments_to_account].each do |field|
+        return false if send(field) != other.send(field)
+      end
+      return true
+    end
+    
+    def to_xml(b = Builder::XmlMarkup.new, options={})
+      b.tag!(options[:name] ? options[:name] : 'Account') {
+        b.AccountID self.account_id
+        b.Code self.code
+        b.Name self.name
+        b.Type self.type
+        b.TaxType self.tax_type
+        b.Description self.description
+        b.SystemAccount self.system_account unless self.system_account.nil?
+        b.EnablePaymentsToAccount self.enable_payments_to_account
+        b.CurrencyCode currency_code if currency_code
+      }
+    end
+    
+    def self.from_xml(account_element)
+      account = Account.new
+      account_element.children.each do |element|
+        case(element.name)
+          when "AccountID" then account.account_id = element.text
+          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
+          when "SystemAccount" then account.system_account = element.text
+          when "EnablePaymentsToAccount" then account.enable_payments_to_account = (element.text == 'true')
+          when "CurrencyCode" then account.currency_code = element.text
+        end
+      end      
+      account
+    end
+    
+  end
+end

data/lib/xero_gateway/accounts_list.rb

@@ -0,0 +1,73 @@
+module XeroGateway
+  class AccountsList
+    
+    # Xero::Gateway associated with this invoice.
+    attr_accessor :gateway
+    
+    # All accessible fields
+    attr_accessor :accounts
+    
+    # Hash of accounts with the account code as the key.
+    attr :accounts_by_code
+    
+    # Boolean representing whether the accounts list has been loaded.
+    attr :loaded
+    
+    public
+    
+      def initialize(gateway, initial_load = true)
+        raise NoGatewayError unless gateway && gateway.is_a?(XeroGateway::Gateway)
+        @gateway = gateway
+        @loaded = false
+        
+        load if initial_load
+      end
+    
+      def load
+        @loaded = false
+        response = gateway.get_accounts
+        @accounts = response.accounts
+        @loaded = true
+        
+        # Cache accounts by code.
+        @accounts_by_code = {}
+        @accounts.each do | account |
+          @accounts_by_code[account.code.to_s] = account
+        end
+      end
+      
+      def loaded?
+        @loaded == true
+      end
+      
+      # Lookup account by account_code.
+      def find_by_code(account_code)
+        raise AccountsListNotLoadedError unless loaded?
+        @accounts_by_code[account_code.to_s]
+      end
+      
+      # Alias [] method to find_by_code.
+      def [](account_code)
+        find_by_code(account_code)
+      end
+    
+      # Return a list of all accounts matching account_type.
+      def find_all_by_type(account_type)
+        raise AccountsListNotLoadedError unless loaded?
+        @accounts.inject([]) do | list, account |
+          list << account if account.type == account_type
+          list
+        end
+      end
+      
+      # Return a list of all accounts matching tax_type.
+      def find_all_by_tax_type(tax_type)
+        raise AccountsListNotLoadedError unless loaded?
+        @accounts.inject([]) do | list, account |
+          list << account if account.tax_type == tax_type
+          list
+        end
+      end
+      
+  end
+end

data/lib/xero_gateway/address.rb

@@ -0,0 +1,96 @@
+module XeroGateway
+  class Address
+    
+    ADDRESS_TYPE = {
+      'STREET' =>     'Street',
+      'POBOX' =>      'PO Box'
+    } unless defined?(ADDRESS_TYPE)
+    
+    # Any errors that occurred when the #valid? method called.
+    attr_reader :errors
+    
+    attr_accessor :address_type, :line_1, :line_2, :line_3, :line_4, :city, :region, :post_code, :country
+    
+    def initialize(params = {})
+      @errors ||= []
+      
+      params = {
+        :address_type => "POBOX"
+      }.merge(params)
+      
+      params.each do |k,v|
+        self.send("#{k}=", v)
+      end
+    end
+    
+    # Validate the Address record according to what will be valid by the gateway.
+    #
+    # Usage: 
+    #  address.valid?     # Returns true/false
+    #  
+    #  Additionally sets address.errors array to an array of field/error.
+    def valid?
+      @errors = []
+            
+      if address_type && !ADDRESS_TYPE[address_type]
+        @errors << ['address_type', "must be one of #{ADDRESS_TYPE.keys.join('/')} and is currently #{address_type}"]
+      end
+      
+      @errors.size == 0
+    end    
+    
+    def to_xml(b = Builder::XmlMarkup.new)
+      b.Address {
+        b.AddressType address_type
+        b.AddressLine1 line_1 if line_1
+        b.AddressLine2 line_2 if line_2
+        b.AddressLine3 line_3 if line_3
+        b.AddressLine4 line_4 if line_4
+        b.City city if city
+        b.Region region if region
+        b.PostalCode post_code if post_code
+        b.Country country if country
+      }
+    end
+    
+    def self.from_xml(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(string)
+      address = Address.new
+      
+      parts = string.split("\r\n")
+      
+      if(parts.size > 3)
+        parts = [parts.shift, parts.shift, parts.shift, parts.join(", ")]
+      end
+      
+      parts.each_with_index do |line, index|
+        address.send("line_#{index+1}=", line)
+      end
+      address
+    end
+    
+    def ==(other)
+      [:address_type, :line_1, :line_2, :line_3, :line_4, :city, :region, :post_code, :country].each do |field|
+        return false if send(field) != other.send(field)
+      end
+      return true
+    end
+  end
+end

data/lib/xero_gateway/bank_transaction.rb

@@ -0,0 +1,175 @@
+module XeroGateway
+  class BankTransaction
+    include Dates
+    include LineItemCalculations
+
+    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)
+
+    TYPES = {
+      'RECEIVE' => 'Receive Bank Transaction',
+      'SPEND'   => 'Spend Bank Transaction',
+    } unless defined?(TYPES)
+
+    STATUSES = {
+      'ACTIVE'  => 'Bank Transaction is active',
+      'DELETED' => 'Bank Transaction is deleted',
+    } unless defined?(STATUSES)
+
+    # Xero::Gateway associated with this invoice.
+    attr_accessor :gateway
+
+    # Any errors that occurred when the #valid? method called.
+    attr_reader :errors
+
+    # Represents whether the line_items have been downloaded when getting from GET /API.XRO/2.0/BankTransactions
+    attr_accessor :line_items_downloaded
+
+    # accessible fields
+    attr_accessor :bank_transaction_id, :type, :date, :reference, :status, :contact, :line_items, :bank_account, :url, :is_reconciled
+
+    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
+
+    def ==(other)
+      ['type', 'reference', 'status', 'contact', 'line_items', 'bank_account'].each do |field|
+        return false if send(field) != other.send(field)
+      end
+
+      ["date"].each do |field|
+        return false if send(field).to_s != other.send(field).to_s
+      end
+      return true
+    end
+
+    # Validate the BankTransaction record according to what will be valid by the gateway.
+    #
+    # Usage:
+    #  bank_transaction.valid?     # Returns true/false
+    #
+    #  Additionally sets bank_transaction.errors array to an array of field/error.
+    def valid?
+      @errors = []
+
+      if !bank_transaction_id.nil? && bank_transaction_id !~ GUID_REGEX
+        @errors << ['bank_transaction_id', 'must be blank or a valid Xero GUID']
+      end
+
+      if type && !TYPES[type]
+        @errors << ['type', "must be one of #{TYPES.keys.join('/')}"]
+      end
+
+      if status && !STATUSES[status]
+        @errors << ['status', "must be one of #{STATUSES.keys.join('/')}"]
+      end
+
+      unless date
+        @errors << ['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
+
+
+    def line_items_downloaded?
+      @line_items_downloaded
+    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 bank_transaction_id =~ GUID_REGEX && @gateway
+        # There is a bank_transaction_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_bank_transaction(bank_transaction_id)
+        raise BankTransactionNotFoundError, "Bank Transaction with ID #{bank_transaction_id} not found in Xero." unless response.success? && response.bank_transaction.is_a?(XeroGateway::BankTransaction)
+
+        @line_items = response.bank_transaction.line_items
+        @line_items_downloaded = true
+
+        @line_items
+
+      # Otherwise, this is a new bank transaction, so return the line_items reference.
+      else
+        @line_items
+      end
+    end
+
+    def to_xml(b = Builder::XmlMarkup.new)
+      b.BankTransaction {
+        b.BankTransactionID bank_transaction_id if bank_transaction_id
+        b.Type type
+        # b.CurrencyCode self.currency_code if self.currency_code
+        contact.to_xml(b) if contact
+        bank_account.to_xml(b, :name => 'BankAccount') if bank_account
+        b.Date BankTransaction.format_date(date || Date.today)
+        b.Status status if status
+        b.Reference reference if reference
+        b.IsReconciled true if self.is_reconciled
+        b.LineItems {
+          self.line_items.each do |line_item|
+            line_item.to_xml(b)
+          end
+        }
+        b.Url url if url
+      }
+    end
+
+    def self.from_xml(bank_transaction_element, gateway = nil, options = {})
+      bank_transaction = BankTransaction.new(options.merge({:gateway => gateway}))
+      bank_transaction_element.children.each do |element|
+        case(element.name)
+          when "BankTransactionID" then bank_transaction.bank_transaction_id = element.text
+          when "Type" then bank_transaction.type = element.text
+          # when "CurrencyCode" then invoice.currency_code = element.text
+          when "Contact" then bank_transaction.contact = Contact.from_xml(element)
+          when "BankAccount" then bank_transaction.bank_account = Account.from_xml(element)
+          when "Date" then bank_transaction.date = parse_date(element.text)
+          when "Status" then bank_transaction.status = element.text
+          when "Reference" then bank_transaction.reference = element.text
+          when "LineItems" then element.children.each {|line_item| bank_transaction.line_items_downloaded = true; bank_transaction.line_items << LineItem.from_xml(line_item) }
+          # 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)
+          # when "AmountCredited" then invoice.amount_credited = BigDecimal.new(element.text)
+          # when "SentToContact" then invoice.sent_to_contact = (element.text.strip.downcase == "true")
+          when "IsReconciled" then bank_transaction.is_reconciled = (element.text.strip.downcase == "true")
+          when "Url" then bank_transaction.url = element.text
+        end
+      end
+      bank_transaction
+    end # from_xml
+
+  end
+end