xeroizer 2.17.1 → 3.0.0

data/lib/xeroizer/connection.rb

@@ -0,0 +1,49 @@
+module Xeroizer
+  class Connection
+    attr_accessor :attributes
+    attr_reader :parent
+
+    class << self
+      def current_connections(client)
+        response = do_request(client)
+
+        if response.success?
+          JSON.parse(response.plain_body).map do |connection_json|
+            build(connection_json, client)
+          end
+        else
+          raise Xeroizer::OAuth::TokenInvalid, response.plain_body
+        end
+      end
+
+      def build(attributes, parent)
+        record = new(parent)
+        record.attributes = attributes
+        record
+      end
+
+      private
+
+      def do_request(client)
+        client.get('https://api.xero.com/connections')
+      end
+    end
+
+    def initialize(parent)
+      @parent = parent
+      @attributes = {}
+    end
+
+    def method_missing(name, *_args)
+      @attributes.send(:[], name.to_s.camelcase(:lower))
+    end
+
+    def delete
+      parent.delete("https://api.xero.com/connections/#{id}")
+    end
+
+    def to_h
+      attributes.transform_keys(&:underscore)
+    end
+  end
+end

data/lib/xeroizer/exceptions.rb

@@ -97,6 +97,8 @@ module Xeroizer
     
   end
 
+  class RecordInvalid < XeroizerError; end
+
   class SettingTotalDirectlyNotSupported < XeroizerError
     
     def initialize(attribute_name)
@@ -153,5 +155,7 @@ module Xeroizer
     end
 
   end
+
+  class InvalidClientError < XeroizerError; end
   
 end

data/lib/xeroizer/generic_application.rb

@@ -6,17 +6,20 @@ module Xeroizer
     include Http
     extend Record::ApplicationHelper
 
-    attr_reader :client, :xero_url, :logger, :rate_limit_sleep, :rate_limit_max_attempts,
+    attr_reader :client, :logger, :rate_limit_sleep, :rate_limit_max_attempts,
                 :default_headers, :unitdp, :before_request, :after_request, :around_request, :nonce_used_max_attempts
 
+    attr_accessor :xero_url
+
     extend Forwardable
     def_delegators :client, :access_token
 
     record :Account
     record :Allocation
     record :Attachment
-    record :BrandingTheme
     record :Balances
+    record :BatchPayment
+    record :BrandingTheme
     record :Contact
     record :ContactGroup
     record :CreditNote
@@ -25,15 +28,19 @@ module Xeroizer
     record :ExpenseClaim
     record :Invoice
     record :InvoiceReminder
+    record :HistoryRecord
+    record :OnlineInvoice
     record :Item
     record :Journal
     record :LineItem
     record :ManualJournal
     record :Organisation
     record :Payment
+    record :PaymentService
     record :Prepayment
     record :Overpayment
     record :PurchaseOrder
+    record :Quote
     record :Receipt
     record :RepeatingInvoice
     record :Schedule
@@ -60,7 +67,8 @@ module Xeroizer
       # @see PublicApplication
       # @see PrivateApplication
       # @see PartnerApplication
-      def initialize(consumer_key, consumer_secret, options = {})
+      def initialize(client, options = {})
+        raise Xeroizer::InvalidClientError.new unless [OAuth, OAuth2].member?(client.class)
         @xero_url = options[:xero_url] || "https://api.xero.com/api.xro/2.0"
         @rate_limit_sleep = options[:rate_limit_sleep] || false
         @rate_limit_max_attempts = options[:rate_limit_max_attempts] || 5
@@ -69,7 +77,7 @@ module Xeroizer
         @before_request = options.delete(:before_request)
         @after_request = options.delete(:after_request)
         @around_request = options.delete(:around_request)
-        @client = OAuth.new(consumer_key, consumer_secret, options.merge({default_headers: default_headers}))
+        @client = client
         @logger = options[:logger] || false
         @unitdp = options[:unitdp] || 2
       end
@@ -79,6 +87,6 @@ module Xeroizer
         xero_client.xero_url = options[:xero_url] || "https://api.xero.com/payroll.xro/1.0"
         @payroll ||= PayrollApplication.new(xero_client)
       end
-          
+
   end
 end

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,20 +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 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
@@ -157,75 +144,15 @@ 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
 
     # unitdp query string parameter to be added to request params
     # when the application option has been set and the model has line items
-    # http://developer.xero.com/documentation/advanced-docs/rounding-in-xero/#unitamount
+    # https://developer.xero.com/documentation/api-guides/rounding-in-xero#unitamount
     def unitdp_param(request_url)
-      models = [/Invoices/, /CreditNotes/, /BankTransactions/, /Receipts/]
+      models = [/Invoices/, /CreditNotes/, /BankTransactions/, /Receipts/, /Items/, /Overpayments/, /Prepayments/]
       self.unitdp == 4 && models.any?{ |m| request_url =~ m } ? {:unitdp => 4} : {}
     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_account.rb

@@ -7,6 +7,7 @@ module Xeroizer
     class BankAccount < Base
       guid   :account_id
       string :code
+      string :name
     end
   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

@@ -0,0 +1,27 @@
+module Xeroizer
+  module Record
+
+    class BatchPaymentModel < BaseModel
+      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
+      date    :date
+      string  :type
+      string  :status
+      decimal :total_amount
+      boolean :is_reconciled
+
+      datetime_utc :updated_date_utc, :api_name => 'UpdatedDateUTC'
+
+      belongs_to :account
+      has_many   :payments
+    end
+  end
+end

data/lib/xeroizer/models/branding_theme.rb

@@ -1,22 +1,62 @@
+require "xeroizer/models/payment_service"
+
 module Xeroizer
   module Record
-    
+
     class BrandingThemeModel < BaseModel
-    
-      set_permissions :read
-    
+
+      set_permissions :read, :write
+
+      public
+
+      def payment_services(id)
+        @payment_services ||= @application.http_get(@application.client, payment_services_endpoint(id))
+      end
+
+      def add_payment_service(id:, payment_service_id:)
+        xml = {
+          PaymentService: {
+            PaymentServiceID: payment_service_id
+          }
+        }.to_xml
+
+        @application.http_post(@application.client, payment_services_endpoint(id), xml)
+      end
+
+      private
+
+      def payment_services_endpoint(id)
+        "#{url}/#{id}/PaymentServices"
+      end
+
     end
-    
+
     class BrandingTheme < Base
-      
+
       set_primary_key :branding_theme_id
-      
+
       guid      :branding_theme_id
       string    :name
       integer   :sort_order
       datetime_utc  :created_date_utc, :api_name => 'CreatedDateUTC'
 
+      # Unfortunately, this part of the API does not work the same as the rest.
+      # You cannot POST child records to Branding Themes.
+      #
+      # The endpoints are:
+      # GET /BrandingThemes/{BrandingThemeID}/PaymentServices
+      # POST /BrandingThemes/{BrandingThemeID}/PaymentServices
+      #
+      # has_one :payment_service, :model_name => 'PaymentService', :list_complete => true
+
+      def payment_services
+        parent.payment_services(id)
+      end
+
+      def add_payment_service(payment_service_id)
+        parent.add_payment_service(id: id, payment_service_id: payment_service_id)
+      end
     end
-    
+
   end
-end
+end

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,20 +54,22 @@ 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
-      has_many  :contact_persons, :internal_name => :contact_people
+      has_many  :contact_groups, :list_complete => true
+      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?}
+      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
       validates_associated :addresses, allow_blanks: true
 

data/lib/xeroizer/models/contact_group.rb

@@ -11,8 +11,53 @@ module Xeroizer
       string :name
       string :status
 
+      set_primary_key :contact_group_id
+      list_contains_summary_only true
       has_many :contacts, :list_complete => true
 
+      # Adding Contact uses different API endpoint
+      # https://developer.xero.com/documentation/api/contactgroups#PUT
+      def add_contact(contact)
+        @contacts ||= []
+        @contacts <<  contact
+      end
+
+      def delete
+        status = 'DELETED'
+      end
+
+      def name=(value)
+        @modified = true unless @attributes[:name].nil? or @attributes[:name] == value
+        @attributes[:name] = value
+      end
+
+      def status=(value)
+        @modified = true unless @attributes[:status].nil? or @attributes[:status] == value
+        @attributes[:status] = value
+      end
+
+      def save!
+        super if new_record? or @modified
+        @modified = false
+        if @contacts
+          req = cg_xml
+          app = parent.application
+          res = app.http_put(app.client, "#{parent.url}/#{CGI.escape(id)}/Contacts", req)
+          parse_save_response(res)
+        end
+      end
+
+      def cg_xml
+        b = Builder::XmlMarkup.new(:indent => 2)
+        b.tag!('Contacts') do
+          @contacts.each do |c|
+            b.tag!('Contact') do
+              b.tag!('ContactID', c.id)
+            end
+          end
+        end
+      end
+
     end
 
   end