xeroizer 2.20.0 → 3.0.0

data/lib/xeroizer/http.rb

@@ -15,7 +15,7 @@
 module Xeroizer
   module Http
     class BadResponse < XeroizerError; end
-    RequestInfo = Struct.new(:url, :headers, :params, :body)
+    RequestInfo = Struct.new(:url, :headers, :params, :body, :method)
 
     ACCEPT_MIME_MAP = {
       :pdf  => 'application/pdf',
@@ -53,7 +53,7 @@ module Xeroizer
 
     private
 
-    def http_request(client, method, url, body, params = {})
+    def http_request(client, method, url, request_body, params = {})
       # headers = {'Accept-Encoding' => 'gzip, deflate'}
 
       headers = self.default_headers.merge({ 'charset' => 'utf-8' })
@@ -89,14 +89,14 @@ module Xeroizer
 
       attempts = 0
 
-      request_info = RequestInfo.new(url, headers, params, body)
+      request_info = RequestInfo.new(url, headers, params, request_body, method)
       before_request.call(request_info) if before_request
 
       begin
         attempts += 1
         logger.info("XeroGateway Request: #{method.to_s.upcase} #{uri.request_uri}") if self.logger
 
-        raw_body = params.delete(:raw_body) ? body : {:xml => body}
+        raw_body = params.delete(:raw_body) ? request_body : {:xml => request_body}
 
         response = with_around_request(request_info) do
           case method
@@ -109,22 +109,7 @@ module Xeroizer
         log_response(response, uri)
         after_request.call(request_info, response) if after_request
 
-        case response.code.to_i
-          when 200
-            response.plain_body
-          when 204
-            nil
-          when 400
-            handle_error!(response, body)
-          when 401
-            handle_oauth_error!(response)
-          when 404
-            handle_object_not_found!(response, url)
-          when 503
-            handle_oauth_error!(response)
-          else
-            handle_unknown_response_error!(response)
-        end
+        HttpResponse.from_response(response, request_body, url).body
       rescue Xeroizer::OAuth::NonceUsed => exception
         raise if attempts > nonce_used_max_attempts
         logger.info("Nonce used: " + exception.to_s) if self.logger
@@ -159,66 +144,6 @@ module Xeroizer
       end
     end
 
-    def handle_oauth_error!(response)
-      error_details = CGI.parse(response.plain_body)
-      description   = error_details["oauth_problem_advice"].first
-      problem = error_details["oauth_problem"].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.
-      if problem
-        case problem
-          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)
-          when "consumer_key_unknown"         then raise OAuth::ConsumerKeyUnknown.new(description)
-          when "nonce_used"                   then raise OAuth::NonceUsed.new(description)
-          when "organisation offline"         then raise OAuth::OrganisationOffline.new(description)
-          else raise OAuth::UnknownError.new(problem + ':' + description)
-        end
-      else
-        raise OAuth::UnknownError.new("Xero API may be down or the way OAuth errors are provided by Xero may have changed.")
-      end
-    end
-
-    def handle_error!(response, request_body)
-
-      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 && doc.root && doc.root.name == "ApiException"
-
-        raise ApiException.new(doc.root.xpath("Type").text,
-                               doc.root.xpath("Message").text,
-                               raw_response,
-                               doc,
-                               request_body)
-
-      else
-        raise BadResponse.new("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
-
-    def handle_unknown_response_error!(response)
-      raise BadResponse.new("Unknown response code: #{response.code.to_i}")
-    end
-
     def sleep_for(seconds = 1)
       sleep seconds
     end

data/lib/xeroizer/http_response.rb

@@ -0,0 +1,154 @@
+module Xeroizer
+  class BadResponse < XeroizerError; end
+
+  class XmlErrorResponse
+    def initialize(response, request_body, url)
+      @response = response
+      @request_body = request_body
+      @url = url
+    end
+
+    def raise_error!
+      case response.code.to_i
+      when 400
+        raise_bad_request!
+      when 401
+        raise_error
+      when 403
+        raise_error
+      when 404
+        raise_not_found!
+      when 429
+        raise_rate_limit_exceeded!
+      when 503
+        raise_error
+      else
+        raise_unknown_response_error!
+      end
+    end
+
+    def raise_error
+      description, problem = parse
+
+      # 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.
+      if problem
+        case problem
+        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)
+        when "consumer_key_unknown"         then raise OAuth::ConsumerKeyUnknown.new(description)
+        when "nonce_used"                   then raise OAuth::NonceUsed.new(description)
+        when "organisation offline"         then raise OAuth::OrganisationOffline.new(description)
+        else raise OAuth::UnknownError.new(problem + ':' + description)
+        end
+      else
+        raise OAuth::UnknownError.new("Xero API may be down or the way OAuth errors are provided by Xero may have changed.")
+      end
+    end
+
+    private
+
+    attr_reader :request_body, :response, :url
+
+    def parse
+      error_details = CGI.parse(response.plain_body)
+      description   = error_details["oauth_problem_advice"].first
+      problem = error_details["oauth_problem"].first
+      [description, problem]
+    end
+
+    def raise_bad_request!
+
+      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 && doc.root && (doc.root.name == "ApiException" || doc.root.name == 'Response')
+
+        raise ApiException.new(doc.root.xpath("Type").text,
+          doc.root.xpath("Message").text,
+          raw_response,
+          doc,
+          request_body)
+
+      else
+        raise Xeroizer::BadResponse.new("Unparseable 400 Response: #{raw_response}")
+      end
+    end
+
+    def raise_not_found!
+      case 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(url)
+      end
+    end
+
+    def raise_rate_limit_exceeded!
+      retry_after = response.response.headers["retry-after"].to_i
+      daily_limit_remaining = response.response.headers["x-daylimit-remaining"].to_i
+
+      description = "Rate limit exceeded: #{daily_limit_remaining} requests left for the day, #{retry_after} seconds until you can make another request"
+      raise OAuth::RateLimitExceeded.new(description, retry_after: retry_after, daily_limit_remaining: daily_limit_remaining)
+    end
+
+    def raise_unknown_response_error!
+      raise Xeroizer::BadResponse.new("Unknown response code: #{response.code.to_i}")
+    end
+  end
+
+  class HttpResponse
+    def self.from_response(response, request_body, url)
+      new(response, request_body, url)
+    end
+
+    def initialize(response, request_body, url)
+      @response = response
+      @request_body = request_body
+      @url = url
+    end
+
+    def body
+      response_code = response.code.to_i
+      return nil if response_code == 204
+      raise_error! unless response.code.to_i == 200
+      response.plain_body
+    end
+
+    private
+
+    def raise_error!
+      begin
+        error_details = JSON.parse(response.plain_body)
+        description  = error_details["Detail"]
+        case response.code.to_i
+        when 400
+          raise Xeroizer::BadResponse.new(description)
+        when 401
+          raise OAuth::TokenExpired.new(description) if description.include?("TokenExpired")
+          raise OAuth::TokenInvalid.new(description)
+        when 403
+          message = "Possible xero-tenant-id header issue. Xero Error: #{description}"
+          raise OAuth::Forbidden.new(message)
+        when 404
+          raise Xeroizer::ObjectNotFound.new(url)
+        else
+          raise Xeroizer::OAuth::UnknownError.new(description)
+        end
+      rescue JSON::ParserError
+        XmlErrorResponse.new(response, request_body, url).raise_error!
+      end
+    end
+
+    attr_reader :request_body, :response, :url
+  end
+end
+

data/lib/xeroizer/models/bank_transaction.rb

@@ -40,6 +40,7 @@ module Xeroizer
       string        :status
       string        :currency_code
       decimal       :currency_rate
+      boolean       :has_attachments
 
       alias_method :reconciled?, :is_reconciled
 

data/lib/xeroizer/models/batch_payment.rb

@@ -2,10 +2,13 @@ module Xeroizer
   module Record
 
     class BatchPaymentModel < BaseModel
-      set_permissions :read
+      set_permissions :read, :write
     end
 
     class BatchPayment < Base
+      set_primary_key :batch_payment_id
+      list_contains_summary_only false
+
       guid    :batch_payment_id
       string  :reference
       string  :details

data/lib/xeroizer/models/contact.rb

@@ -2,6 +2,7 @@ require "xeroizer/models/contact_person"
 require "xeroizer/models/balances"
 require "xeroizer/models/batch_payments"
 require "xeroizer/models/payment_terms"
+require "xeroizer/models/history_record"
 
 module Xeroizer
   module Record
@@ -11,6 +12,7 @@ module Xeroizer
       set_permissions :read, :write, :update
 
       include AttachmentModel::Extensions
+      include HistoryRecordModel::Extensions
 
     end
 
@@ -19,10 +21,12 @@ module Xeroizer
       CONTACT_STATUS = {
         'ACTIVE' =>     'Active',
         'DELETED' =>    'Deleted',
-        'ARCHIVED' => 'Archived'
+        'ARCHIVED' => 'Archived',
+        'GDPRREQUEST' => 'GDPR Request'
       } unless defined?(CONTACT_STATUS)
 
       include Attachment::Extensions
+      include HistoryRecord::Extensions
 
       set_primary_key :contact_id
       set_possible_primary_keys :contact_id, :contact_number
@@ -50,18 +54,20 @@ module Xeroizer
       string        :website # read only
       decimal       :discount # read only
       boolean       :has_attachments
+      string        :xero_network_key
 
       has_many  :addresses, :list_complete => true
       has_many  :phones, :list_complete => true
       has_many  :contact_groups, :list_complete => true
-      has_many  :contact_persons, :internal_name => :contact_people
+      has_many  :contact_persons, :internal_name => :contact_people, :list_complete => true
 
-      has_many :sales_tracking_categories, :model_name => 'ContactSalesTrackingCategory'
-      has_many :purchases_tracking_categories, :model_name => 'ContactPurchasesTrackingCategory'
+      has_many :sales_tracking_categories, :model_name => 'ContactSalesTrackingCategory', :list_complete => true
+      has_many :purchases_tracking_categories, :model_name => 'ContactPurchasesTrackingCategory', :list_complete => true
 
       has_one :balances, :model_name => 'Balances', :list_complete => true
       has_one :batch_payments, :model_name => 'BatchPayments', :list_complete => true
       has_one :payment_terms, :model_name => 'PaymentTerms', :list_complete => true
+      has_one :branding_theme, :list_complete => true
 
       validates_presence_of :name, :unless => Proc.new { | contact | contact.contact_id.present? || contact.contact_number.present? }
       validates_inclusion_of :contact_status, :in => CONTACT_STATUS.keys, :allow_blanks => true

data/lib/xeroizer/models/credit_note.rb

@@ -1,12 +1,12 @@
 module Xeroizer
   module Record
-    
+
     class CreditNoteModel < BaseModel
-        
+
       set_permissions :read, :write, :update
-      
+
       include AttachmentModel::Extensions
-      
+
       public
 
         # Retrieve the PDF version of the credit matching the `id`.
@@ -21,11 +21,11 @@ module Xeroizer
             pdf_data
           end
         end
-      
+
     end
-    
+
     class CreditNote < Base
-      
+
       CREDIT_NOTE_STATUS = {
         'AUTHORISED' =>       'Approved credit_notes awaiting payment',
         'DELETED' =>          'Draft credit_notes that are deleted',
@@ -35,7 +35,7 @@ module Xeroizer
         'VOIDED' =>           'Approved credit_notes that are voided'
       } unless defined?(CREDIT_NOTE_STATUS)
       CREDIT_NOTE_STATUSES = CREDIT_NOTE_STATUS.keys.sort
-      
+
       CREDIT_NOTE_TYPE = {
         'ACCRECCREDIT' =>           'Accounts Receivable',
         'ACCPAYCREDIT' =>           'Accounts Payable'
@@ -43,11 +43,11 @@ module Xeroizer
       CREDIT_NOTE_TYPES = CREDIT_NOTE_TYPE.keys.sort
 
       include Attachment::Extensions
-      
+
       set_primary_key :credit_note_id
       set_possible_primary_keys :credit_note_id, :credit_note_number
       list_contains_summary_only true
-      
+
       guid          :credit_note_id
       string        :credit_note_number
       string        :reference
@@ -72,15 +72,15 @@ module Xeroizer
       belongs_to    :contact
       has_many      :line_items
       has_many      :allocations
-      
+
       validates_inclusion_of :type, :in => CREDIT_NOTE_TYPES
       validates_inclusion_of :status, :in => CREDIT_NOTE_STATUSES, :allow_blanks => true
       validates_associated :contact
       validates_associated :line_items
       validates_associated :allocations, :allow_blanks => true
-      
+
       public
-      
+
         # Access the contact name without forcing a download of
         # an incomplete, summary credit note.
         def contact_name
@@ -91,20 +91,20 @@ module Xeroizer
         # incomplete, summary credit note.
         def contact_id
           attributes[:contact] && attributes[:contact][:contact_id]
-        end      
-      
+        end
+
         # Swallow assignment of attributes that should only be calculated automatically.
         def sub_total=(value);  raise SettingTotalDirectlyNotSupported.new(:sub_total);   end
         def total_tax=(value);  raise SettingTotalDirectlyNotSupported.new(:total_tax);   end
         def total=(value);      raise SettingTotalDirectlyNotSupported.new(:total);       end
-      
+
         # Calculate sub_total from line_items.
         def sub_total(always_summary = false)
           if !always_summary && (new_record? || (!new_record? && line_items && line_items.size > 0))
             overall_sum = (line_items || []).inject(BigDecimal('0')) { | sum, line_item | sum + line_item.line_amount }
-            
+
             # If the default amount types are inclusive of 'tax' then remove the tax amount from this sub-total.
-            overall_sum -= total_tax if line_amount_types == 'Inclusive' 
+            overall_sum -= total_tax if line_amount_types == 'Inclusive'
             overall_sum
           else
             attributes[:sub_total]
@@ -128,14 +128,14 @@ module Xeroizer
             attributes[:total]
           end
         end
-        
+
         # Retrieve the PDF version of this credit note.
         # @param [String] filename optional filename to store the PDF in instead of returning the data.
         def pdf(filename = nil)
           parent.pdf(id, filename)
         end
 
-        def save
+        def save!
           # Calling parse_save_response() on the credit note will wipe out
           # the allocations, so we have to manually preserve them.
           allocations_backup = self.allocations

data/lib/xeroizer/models/history_record.rb

@@ -0,0 +1,72 @@
+module Xeroizer
+  module Record
+
+    class HistoryRecordModel < BaseModel
+
+      module Extensions
+        def history(id)
+          application.HistoryRecord.history(url, id)
+        end
+
+        def add_note(id, details)
+          application.HistoryRecord.add_note(url, id, details)
+        end
+      end
+
+      set_permissions :read
+
+      # History Records can only be added, no update or delete is possible
+      def create_method
+        :http_put
+      end
+
+      def history(url, id)
+        response_xml = @application.http_get(@application.client, "#{url}/#{CGI.escape(id)}/history")
+
+        response = parse_response(response_xml)
+
+        response.response_items
+      end
+
+      def add_note(url, id, details)
+        record = build(details: details)
+        xml = to_bulk_xml([record])
+        response_xml = @application.http_put(@application.client,
+                                              "#{url}/#{CGI.escape(id)}/history",
+                                              xml,
+                                              raw_body: true
+                                             )
+        response = parse_response(response_xml)
+        if (response_items = response.response_items) && response_items.size > 0
+          response_items.size == 1 ? response_items.first : response_items
+        else
+          response
+        end
+      end
+
+    end
+
+    class HistoryRecord < Base
+
+      module Extensions
+        def history
+          parent.history(id)
+        end
+
+        def add_note(details)
+          parent.add_note(id, details)
+        end
+      end
+
+      datetime_utc :date_utc, :api_name => 'DateUTC'
+      string :date_utc_string, :api_name => 'DateUTCString'
+      string :changes
+      string :user
+      string :details
+
+      validates_presence_of :details
+
+    end
+
+  end
+end

data/lib/xeroizer/models/invoice.rb

@@ -1,5 +1,6 @@
 require "xeroizer/models/attachment"
 require "xeroizer/models/online_invoice"
+require "xeroizer/models/history_record"
 
 module Xeroizer
   module Record
@@ -16,6 +17,7 @@ module Xeroizer
 
       include AttachmentModel::Extensions
       include OnlineInvoiceModel::Extensions
+      include HistoryRecordModel::Extensions
 
       public
 
@@ -54,6 +56,7 @@ module Xeroizer
 
       include Attachment::Extensions
       include OnlineInvoice::Extensions
+      include HistoryRecord::Extensions
 
       set_primary_key :invoice_id
       set_possible_primary_keys :invoice_id, :invoice_number
@@ -91,7 +94,8 @@ module Xeroizer
       has_many     :credit_notes
       has_many     :prepayments
 
-      validates_presence_of :date, :due_date, :unless => :new_record?
+      validates_presence_of :date, :if => :new_record?
+      validates_presence_of :due_date, :if => :approved?
       validates_inclusion_of :type, :in => INVOICE_TYPES
       validates_inclusion_of :status, :in => INVOICE_STATUSES, :unless => :new_record?
       validates_inclusion_of :line_amount_types, :in => LINE_AMOUNT_TYPES, :unless => :new_record?

data/lib/xeroizer/models/line_item.rb

@@ -4,7 +4,7 @@ require 'xeroizer/models/line_amount_type'
 module Xeroizer
   module Record
     class LineItemModel < BaseModel
-
+      set_permissions
     end
 
     class LineItem < Base
@@ -24,6 +24,8 @@ module Xeroizer
 
       has_many  :tracking, :model_name => 'TrackingCategoryChild'
 
+      validates_presence_of :description, :unless => Proc.new { |line_item| line_item.item_code.present? }
+
       def initialize(parent)
         super(parent)
         @line_amount_set = false
@@ -42,7 +44,7 @@ module Xeroizer
         if quantity && unit_amount
           total = coerce_numeric(quantity) * coerce_numeric(unit_amount)
           if discount_rate.nonzero?
-            BigDecimal((total * ((100 - discount_rate) / 100)).to_s).round(2)
+            BigDecimal((total * ((100 - discount_rate.to_f) / 100)).to_s).round(2)
           elsif discount_amount
             BigDecimal((total - discount_amount).to_s).round(2)
           else

data/lib/xeroizer/models/manual_journal.rb

@@ -34,7 +34,8 @@ module Xeroizer
       string        :external_link_provider_name # only seems to be read-only at the moment
       boolean       :show_on_cash_basis_reports
       datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
-      
+      boolean       :has_attachments
+
       has_many      :journal_lines, :model_name => 'ManualJournalLine', :complete_on_page => true
       
       validates_presence_of :narration

data/lib/xeroizer/models/option.rb

@@ -11,7 +11,7 @@ module Xeroizer
       
       guid   :tracking_option_id
       string :name
-      
+      string :status
     end
     
   end

data/lib/xeroizer/models/payroll/address.rb

@@ -0,0 +1,53 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class AddressModel < PayrollBaseModel
+
+        class_inheritable_attributes :api_controller_name
+        class_inheritable_attributes :permissions
+        class_inheritable_attributes :xml_root_name
+        class_inheritable_attributes :optional_xml_root_name
+        class_inheritable_attributes :xml_node_name
+
+      end
+
+      class Address < PayrollBase
+
+        class_inheritable_attributes :fields, :possible_primary_keys, :primary_key_name, :summary_only, :validators
+
+
+        string      :address_line1
+        string      :address_line2
+        string      :city
+        string      :region
+        string      :postal_code
+        string      :country
+
+        # US Payroll fields
+        string      :street_address
+        string      :suite_or_apt_or_unit
+        string      :state
+        string      :zip
+        decimal     :latitude
+        decimal     :longitude
+
+      end
+
+      class HomeAddressModel < AddressModel
+        set_xml_node_name 'HomeAddress'
+      end
+
+      class HomeAddress < Address
+      end
+
+      class MailingAddressModel < AddressModel
+        set_xml_node_name 'MailingAddress'
+      end
+
+      class MailingAddress < Address
+      end
+
+    end
+  end
+end