xeroizer 0.1.0

data/lib/xeroizer/exceptions.rb

@@ -0,0 +1,94 @@
+module Xeroizer
+  class ApiException < StandardError
+    
+    def initialize(type, message, xml)
+      @type     = type
+      @message  = message
+      @xml      = xml
+    end
+    
+    def message
+      "#{@type}: #{@message} \n Generated by the following XML: \n #{@xml}"
+    end
+    
+  end
+  
+  class UnparseableResponse < StandardError
+    
+    def initialize(root_element_name)
+      @root_element_name = root_element_name
+    end
+    
+    def message
+      "A root element of #{@root_element_name} was returned, and we don't understand that!"
+    end
+      
+  end
+  
+  class ObjectNotFound < StandardError
+    
+    def initialize(api_endpoint)
+      @api_endpoint = api_endpoint
+    end
+    
+    def message
+      "Couldn't find object for API Endpoint #{@api_endpoint}"
+    end
+    
+  end
+  
+  class InvoiceNotFoundError < StandardError; end
+
+  class CreditNoteNotFoundError < StandardError; end
+  
+  class MethodNotAllowed < StandardError
+    
+    def initialize(klass, method)
+      @klass = klass
+      @method = method
+    end
+    
+    def message
+      "Method #{@method} not allowed on #{@klass}"
+    end
+    
+  end
+  
+  class RecordKeyMustBeDefined < StandardError
+    
+    def initialize(possible_keys)
+      @possible_keys = possible_keys
+    end
+    
+    def message
+      "One of the keys #{@possible_keys.join(', ')} need to be defined to update the record."
+    end
+    
+  end
+
+  class SettingTotalDirectlyNotSupported < StandardError
+    
+    def initialize(attribute_name)
+      @attribute_name = attribute_name
+    end
+    
+    def message
+      "Can't set the total #{@attribute_name} directly as this is calculated automatically."
+    end
+    
+  end
+
+  class InvalidAttributeInWhere < StandardError
+    
+    def initialize(model_name, attribute_name)
+      @model_name = model_name
+      @attribute_name = attribute_name
+    end
+    
+    def message
+      "#{@attribute_name} is not an attribute of #{@model_name}."
+    end
+    
+  end
+  
+end

data/lib/xeroizer/generic_application.rb

@@ -0,0 +1,40 @@
+require 'xeroizer/record/application_helper'
+
+module Xeroizer
+  class GenericApplication
+    
+    include Http
+    extend Record::ApplicationHelper
+    
+    attr_reader :client, :xero_url, :logger
+    
+    extend Forwardable
+    def_delegators :client, :access_token
+    
+    record :Account
+    record :BrandingTheme
+    record :Contact
+    record :CreditNote
+    record :Currency
+    record :Invoice
+    record :Item
+    record :Journal
+    record :ManualJournal
+    record :Organisation
+    record :Payment
+    record :TaxRate
+    record :TrackingCategory
+    
+    public
+    
+      # Never used directly. Use sub-classes instead.
+      # @see PublicApplication
+      # @see PrivateApplication
+      # @see PartnerApplication
+      def initialize(consumer_key, consumer_secret, options = {})
+        @xero_url = options[:xero_url] || "https://api.xero.com/api.xro/2.0"
+        @client   = OAuth.new(consumer_key, consumer_secret, options)
+      end
+          
+  end
+end

data/lib/xeroizer/http.rb

@@ -0,0 +1,148 @@
+module Xeroizer
+  module Http
+    
+    ACCEPT_MIME_MAP = {
+      :pdf  => 'application/pdf',
+      :json => 'application/json'
+    }
+    
+    # Shortcut method for #http_request with `method` = :get.
+    #
+    # @param [OAuth] client OAuth client
+    # @param [String] url URL of request
+    # @param [Hash] extra_params extra query string parameters.
+    def http_get(client, url, extra_params = {})
+      http_request(client, :get, url, nil, extra_params)
+    end
+
+    # Shortcut method for #http_request with `method` = :post.
+    #
+    # @param [OAuth] client OAuth client
+    # @param [String] url URL of request
+    # @param [String] body XML message to post.
+    # @param [Hash] extra_params extra query string parameters.
+    def http_post(client, url, body, extra_params = {})
+      http_request(client, :post, url, body, extra_params)
+    end
+
+    # Shortcut method for #http_request with `method` = :put.
+    #
+    # @param [OAuth] client OAuth client
+    # @param [String] url URL of request
+    # @param [String] body XML message to put.
+    # @param [Hash] extra_params extra query string parameters.
+    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]
+        
+        # Allow 'Accept' header to be specified with :accept parameter.
+        # Valid values are :pdf or :json.
+        if params[:response]
+          response_type = params.delete(:response)
+          headers['Accept'] = case response_type
+            when Symbol then  ACCEPT_MIME_MAP[response_type]
+            else              response_type
+          end
+        end
+        
+        if params.any?
+          url += "?" + params.map {|key,value| "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"}.join("&")
+        end
+
+        uri   = URI.parse(url)
+        
+        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
+        # In addition to token_expired and token_rejected, Xero also returns
+        # 'rate limit exceeded' when more than 60 requests have been made in
+        # a second.
+        case (error_details["oauth_problem"].first)
+          when "token_expired"        then raise OAuth::TokenExpired.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)
+        end
+      end
+      
+      def handle_error!(response)
+        
+        raw_response = response.plain_body
+        
+        # XeroGenericApplication 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)
+        doc = Nokogiri::XML(raw_response)
+        
+        if doc.root.name == "ApiException"
+
+          raise ApiException.new(doc.root.xpath("Type").text, 
+                                 doc.root.xpath("Message").text, 
+                                 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 /CreditNotes/ then raise CreditNoteNotFoundError.new("Credit Note not found in Xero.")
+          else raise ObjectNotFound.new(request_url)
+        end
+      end
+      
+  end
+end

data/lib/xeroizer/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/xeroizer/models/account.rb

@@ -0,0 +1,60 @@
+module Xeroizer
+  module Record
+    
+    class AccountModel < BaseModel
+        
+      set_permissions :read
+        
+    end
+    
+    class Account < Base
+    
+      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)',
+        'OUTPUT' =>           'OUTPUT',
+        '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)
+      
+      set_primary_key :account_id
+            
+      guid    :account_id
+      string  :code
+      string  :name
+      string  :type
+      string  :status
+      string  :currency_code
+      string  :tax_type
+      string  :description
+      string  :system_account
+      boolean :enable_payments_to_account
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/address.rb

@@ -0,0 +1,31 @@
+module Xeroizer
+  module Record
+    
+    class AddressModel < BaseModel
+            
+    end
+    
+    class Address < Base
+      
+      ADDRESS_TYPE = {
+        'STREET' =>     'Street',
+        'POBOX' =>      'PO Box',
+        'DEFAULT' =>    'Default address type'
+      } unless defined?(ADDRESS_TYPE)
+      
+      string :address_type, :internal_name => :type
+      string :address_line1, :internal_name => :line1
+      string :address_line2, :internal_name => :line2
+      string :address_line3, :internal_name => :line3
+      string :address_line4, :internal_name => :line4
+      string :city
+      string :region
+      string :postal_code
+      string :country
+      
+      validates_inclusion_of :type, :in => ADDRESS_TYPE.keys
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/branding_theme.rb

@@ -0,0 +1,22 @@
+module Xeroizer
+  module Record
+    
+    class BrandingThemeModel < BaseModel
+    
+      set_permissions :read
+    
+    end
+    
+    class BrandingTheme < Base
+      
+      set_primary_key :branding_theme_id
+      
+      guid      :branding_theme_id
+      string    :name
+      integer   :sort_order
+      datetime  :created_date_utc, :api_name => 'CreatedDateUTC'
+
+    end
+    
+  end
+end