xero_gateway 2.0.2

data/lib/xero_gateway/http.rb

@@ -0,0 +1,128 @@
+module XeroGateway
+  module Http
+    OPEN_TIMEOUT = 10 unless defined? OPEN_TIMEOUT
+    READ_TIMEOUT = 60 unless defined? READ_TIMEOUT
+    ROOT_CA_FILE = File.join(File.dirname(__FILE__), 'ca-certificates.crt') unless defined? ROOT_CA_FILE
+    
+    def http_get(client, url, extra_params = {})
+      http_request(client, :get, url, nil, extra_params)
+    end
+
+    def http_post(client, url, body, extra_params = {})
+      http_request(client, :post, url, body, extra_params)
+    end
+
+    def http_put(client, url, body, extra_params = {})
+      http_request(client, :put, url, body, extra_params)
+    end
+    
+    private
+    
+      def http_request(client, method, url, body, params = {})
+        # headers = {'Accept-Encoding' => 'gzip, deflate'}
+
+        headers = { 'charset' => 'utf-8' }
+
+        if method != :get
+          headers['Content-Type'] ||= "application/x-www-form-urlencoded"
+        end
+
+        # HAX.  Xero completely misuse the If-Modified-Since HTTP header.
+        headers['If-Modified-Since'] = params.delete(:ModifiedAfter).utc.strftime("%Y-%m-%dT%H:%M:%S") if params[:ModifiedAfter]
+
+        if params.any?
+          url += "?" + params.map {|key,value| "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"}.join("&")
+        end
+
+        uri   = URI.parse(url)
+
+        # # Only setup @cached_http once on first use as loading the CA file is quite expensive computationally.
+        # unless @cached_http && @cached_http.address == uri.host && @cached_http.port == uri.port
+        #   @cached_http = Net::HTTP.new(uri.host, uri.port) 
+        #   @cached_http.open_timeout = OPEN_TIMEOUT
+        #   @cached_http.read_timeout = READ_TIMEOUT
+        #   @cached_http.use_ssl      = true
+        # 
+        #   # Need to validate server's certificate against root certificate authority to prevent man-in-the-middle attacks.
+        #   @cached_http.ca_file        = ROOT_CA_FILE
+        #   # http.verify_mode    = OpenSSL::SSL::VERIFY_NONE
+        #   @cached_http.verify_mode    = OpenSSL::SSL::VERIFY_PEER
+        #   @cached_http.verify_depth   = 5
+        # end
+        
+        logger.info("\n== [#{Time.now.to_s}] XeroGateway Request: #{uri.request_uri} ") if self.logger
+        
+        response = case method
+          when :get   then    client.get(uri.request_uri, headers)
+          when :post  then    client.post(uri.request_uri, { :xml => body }, headers)
+          when :put   then    client.put(uri.request_uri, { :xml => body }, headers)
+        end
+        
+        if self.logger
+          logger.info("== [#{Time.now.to_s}] XeroGateway Response (#{response.code})")
+          
+          unless response.code.to_i == 200
+            logger.info("== #{uri.request_uri} Response Body \n\n #{response.plain_body} \n == End Response Body")
+          end
+        end
+        
+        case response.code.to_i
+          when 200
+            response.plain_body
+          when 400
+            handle_error!(response)  
+          when 401
+            handle_oauth_error!(response)
+          when 404
+            handle_object_not_found!(response, url)
+          else
+            raise "Unknown response code: #{response.code.to_i}"
+        end
+      end
+       
+      def handle_oauth_error!(response)
+        error_details = CGI.parse(response.plain_body)
+        description   = error_details["oauth_problem_advice"].first
+      
+        # see http://oauth.pbworks.com/ProblemReporting
+        # Xero only appears to return either token_expired or token_rejected
+        case (error_details["oauth_problem"].first)
+          when "token_expired"        then raise OAuth::TokenExpired.new(description)
+          when "token_rejected"       then raise OAuth::TokenInvalid.new(description)
+        end
+      end
+      
+      def handle_error!(response)
+        
+        raw_response = response.plain_body
+        
+        # Xero Gateway API Exceptions *claim* to be UTF-16 encoded, but fail REXML/Iconv parsing...
+        # So let's ignore that :)
+        raw_response.gsub! '<?xml version="1.0" encoding="utf-16"?>', ''
+        
+        doc = REXML::Document.new(raw_response, :ignore_whitespace_nodes => :all)
+        
+        if doc.root.name == "ApiException"
+
+          raise ApiException.new(doc.root.elements["Type"].text, 
+                                 doc.root.elements["Message"].text, 
+                                 raw_response)
+
+        else
+          
+          raise "Unparseable 400 Response: #{raw_response}"
+          
+        end
+        
+      end
+      
+      def handle_object_not_found!(response, request_url)
+        if request_url =~ /Invoices/
+          raise InvoiceNotFoundError.new("Invoice not found in Xero.")
+        else
+          raise ObjectNotFound.new(request_url)
+        end
+      end
+      
+  end
+end

data/lib/xero_gateway/http_encoding_helper.rb

@@ -0,0 +1,49 @@
+# Intended to extend the Net::HTTP response object
+# and adds support for decoding gzip and deflate encoded pages
+#
+# Author: Jason Stirk <http://griffin.oobleyboo.com>
+# Home: http://griffin.oobleyboo.com/projects/http_encoding_helper
+# Created: 5 September 2007
+# Last Updated: 23 November 2007
+#
+# Usage:
+#
+# require 'net/http'
+# require 'http_encoding_helper'
+# headers={'Accept-Encoding' => 'gzip, deflate' }
+# http = Net::HTTP.new('griffin.oobleyboo.com', 80)
+# http.start do |h|
+#   request = Net::HTTP::Get.new('/', headers)
+#   response = http.request(request)
+#   content=response.plain_body     # Method from our library
+#   puts "Transferred: #{response.body.length} bytes"
+#   puts "Compression: #{response['content-encoding']}"
+#   puts "Extracted: #{response.plain_body.length} bytes"  
+# end
+#	
+
+require 'zlib'
+require 'stringio'
+
+class Net::HTTPResponse
+  # Return the uncompressed content
+  def plain_body
+    encoding=self['content-encoding']
+    content=nil
+    if encoding then
+      case encoding
+        when 'gzip'
+          i=Zlib::GzipReader.new(StringIO.new(self.body))
+          content=i.read
+        when 'deflate'
+          i=Zlib::Inflate.new
+          content=i.inflate(self.body)
+        else
+          raise "Unknown encoding - #{encoding}"
+      end
+    else
+      content=self.body
+    end
+    return content
+  end
+end

data/lib/xero_gateway/invoice.rb

@@ -0,0 +1,278 @@
+module XeroGateway
+  class Invoice
+    include Dates
+    include Money
+    
+    class Error < RuntimeError; end
+    class NoGatewayError < Error; end
+    class InvalidLineItemError < Error; end
+    
+    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',
+      'DRAFT' =>            'Invoices saved as draft or entered via API',
+      'PAID' =>             'Invoices approved and fully paid',
+      '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.
+    attr_reader :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, :line_amount_types, :currency_code, :line_items, :contact, :payments, :fully_paid_on, :amount_due, :amount_paid, :amount_credited
+
+    
+    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 => "Inclusive"
+      }.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: 
+    #  address.valid?     # Returns true/false
+    #  
+    #  Additionally sets address.errors array to an array of field/error.
+    def valid?
+      @errors = []
+      
+      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
+
+      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 create a new associated line_item.
+    # Usage:
+    #   invoice.add_line_item({:description => "Bob's Widgets", :quantity => 1, :unit_amount => 120})
+    def add_line_item(params = {})
+      line_item = nil
+      case params
+        when Hash then      line_item = LineItem.new(params)
+        when LineItem then  line_item = params
+        else                raise InvalidLineItemError
+      end
+      
+      @line_items << line_item
+      
+      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)
+    end
+    
+    # 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) }
+    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)
+    end
+    
+    # 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) }
+    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)
+    end
+    
+    # Calculate the toal as sub_total + total_tax.
+    def total
+      sub_total + total_tax
+    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
+    
+    # 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
+        
+      # There is an invoice_is so we can assume this record was loaded from Xero.
+      # attempt to download the line_item records.
+      elsif invoice_id =~ GUID_REGEX
+        raise NoGatewayError unless @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.
+      else
+        @line_items
+      end
+    end
+    
+    def ==(other)
+      ["invoice_number", "invoice_type", "invoice_status", "reference", "currency_code", "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 createsave method.
+    # If contact_id and contact_number are nil then create, otherwise, attempt to save.
+    def save
+      create
+    end
+    
+    # Creates this invoice record (using gateway.create_invoice) with the associated gateway.
+    # If no gateway set, raise a Xero::Invoice::NoGatewayError exception.
+    def create
+      raise NoGatewayError unless gateway
+      gateway.create_invoice(self)
+    end
+    
+    # Alias create as save as this is currently the only write action.
+    alias_method :save, :create
+            
+    def to_xml(b = Builder::XmlMarkup.new)
+      b.Invoice {
+        b.Type self.invoice_type
+        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
+        b.Status self.invoice_status if self.invoice_status
+        b.InvoiceNumber self.invoice_number if invoice_number
+        b.Reference self.reference if self.reference
+        b.CurrencyCode self.currency_code if self.currency_code
+        b.LineAmountTypes self.line_amount_types
+        b.LineItems {
+          self.line_items.each do |line_item|
+            line_item.to_xml(b)
+          end
+        }
+      }
+    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 "Type" then invoice.invoice_type = element.text
+          when "CurrencyCode" then invoice.currency_code = element.text
+          when "Type" then invoice.invoice_type = 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)
+          when "Status" then invoice.invoice_status = element.text
+          when "Reference" then invoice.reference = element.text
+          when "LineAmountTypes" then invoice.line_amount_types = element.text
+          when "LineItems" then element.children.each {|line_item| invoice.line_items_downloaded = true; invoice.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)
+        end
+      end      
+      invoice
+    end    
+  end
+end