Refactor invoice processing and synchronization; implement InvoiceSyncJob and related services for improved background processing and logging

app/services/invoice_attachment_service.rb

@@ -0,0 +1,62 @@
+#The MIT License (MIT)
+#
+#Copyright (c) 2016 - 2026 rick barrette
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class InvoiceAttachmentService
+
+  def initialize(invoice, remote)
+    @invoice = invoice
+    @remote  = remote
+  end
+
+  # Attach invoice to issues based on issue IDs found in the invoice's private note and line descriptions
+  def attach
+    extract_issue_ids.each do |issue_id|
+      log "Processing issue ##{issue_id} for invoice ##{@invoice.doc_number}"
+      
+      issue = Issue.find_by(id: issue_id)
+      next unless issue
+      next unless issue.customer&.id == @invoice.customer&.id
+
+      unless issue.invoices.exists?(@invoice.id)
+        issue.invoices << @invoice
+        issue.save! if issue.changed?
+        log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
+      end
+
+      InvoiceCustomFieldSyncService.new(issue, @invoice, @remote).sync
+    end
+  end
+
+  private
+
+  # Extract issue IDs from the invoice's private note and line descriptions
+  def extract_issue_ids
+    ids = []
+
+    if @remote.private_note.present?
+      ids += scan(@remote.private_note)
+    end
+
+    Array(@remote.line_items).each do |line|
+      ids += scan(line.description.to_s)
+    end
+
+    ids.uniq
+  end
+
+  # Scan text for issue IDs in the format #123
+  def scan(text)
+    text.scan(/#(\d+)/).flatten.map(&:to_i)
+  end
+
+  def log(msg)
+    Rails.logger.info "[InvoiceAttachmentService] #{msg}"
+  end
+end

app/services/invoice_custom_field_sync_service.rb

@@ -0,0 +1,69 @@
+#The MIT License (MIT)
+#
+#Copyright (c) 2016 - 2026 rick barrette
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class InvoiceCustomFieldSyncService
+
+  def initialize(issue, invoice, remote)
+    @issue   = issue
+    @invoice = invoice
+    @remote = remote
+  end
+
+  # Sync custom fields on the issue based on the invoice data, then push changes to QBO if any fields were updated
+  def sync
+    return if @invoice.qbo_sync_locked?
+
+    log "Syncing custom fields for issue ##{@issue.id} based on invoice ##{@invoice.doc_number}"
+
+    changed = false
+
+    # Process Invoice Custom Fields via Hooks
+    Redmine::Hook.call_hook(
+      :process_invoice_custom_fields,
+      issue: @issue,
+      invoice: @remote
+    ).each do |context|
+        next unless context
+        changed ||= context[:is_changed]
+        log "Custom fields updated by hook, marking invoice for push to QBO" if context[:is_changed]
+    end
+
+    # Process Issue Custom Values from any issue custom fields that match the invoice custom fields
+    begin
+      value = @issue.custom_values.find_by(custom_field_id: CustomField.find_by_name(cf.name).id)
+      
+      # Check to see if the value is blank...
+      if not value.value.to_s.blank?
+        # Check to see if the value is diffrent
+        if not cf.string_value.to_s.eql? value.value.to_s
+          # update the custom field on the invoice
+          cf.string_value = value.value.to_s
+          is_changed = true
+        end
+      end
+    rescue
+      # Nothing to do here, there is no match
+    end
+
+    push_if_changed if changed
+  end
+
+  private
+
+  # If any custom fields were changed during the sync process, this method will trigger a push of the invoice data to QuickBooks Online to ensure that the remote data stays in sync with the local changes. It uses the InvoicePushService to handle the actual communication with QBO.
+  def push_if_changed
+    InvoicePushService.new(@invoice).push
+  end
+
+  def log(msg)
+    Rails.logger.info "[InvoiceCustomFieldSyncService] #{msg}"
+  end
+  
+end

app/services/invoice_push_service.rb

@@ -0,0 +1,47 @@
+#The MIT License (MIT)
+#
+#Copyright (c) 2016 - 2026 rick barrette
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class InvoicePushService
+  
+  def initialize(invoice)
+    @invoice = invoice
+  end
+
+  # Push invoice changes to QBO if the invoice is linked to any issues with custom field changes that need to be synced
+  def push
+    return if @invoice.qbo_sync_locked?
+
+    log "Pushing invoice ##{@invoice.id} to QBO due to linked issue custom field changes"
+
+    @invoice.update_column(:qbo_sync_locked, true)
+
+    qbo = Qbo.first
+
+    qbo.perform_authenticated_request do |access_token|
+      service = Quickbooks::Service::Invoice.new( company_id: qbo.realm_id, access_token: access_token)
+
+      remote = service.fetch_by_id(@invoice.id)
+
+      # modify remote object here if needed
+
+      service.update(remote)
+    end
+  rescue => e
+    Rails.logger.error "[InvoicePushService] #{e.message}"
+  ensure
+    @invoice.update_column(:qbo_sync_locked, false)
+  end
+
+  private
+
+  def log(msg)
+    Rails.logger.info "[InvoicePushService] #{msg}"
+  end
+end

app/services/invoice_sync_service.rb

@@ -0,0 +1,90 @@
+#The MIT License (MIT)
+#
+#Copyright (c) 2016 - 2026 rick barrette
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class InvoiceSyncService
+  PAGE_SIZE = 1000
+
+  def initialize(qbo:)
+    @qbo = qbo
+  end
+
+  # Sync all invoices, or only those updated since the last sync
+  def sync(full_sync: false)
+    log "Starting #{full_sync ? 'full' : 'incremental'} invoice sync"
+
+    @qbo.perform_authenticated_request do |access_token|
+      service = Quickbooks::Service::Invoice.new(company_id: @qbo.realm_id, access_token: access_token)
+
+      page = 1
+      loop do
+        collection = fetch_page(service, page, full_sync)
+        entries = Array(collection&.entries)
+        break if entries.empty?
+
+        entries.each { |remote| persist(remote) }
+
+        break if entries.size < PAGE_SIZE
+        page += 1
+      end
+    end
+
+    log "Invoice sync complete"
+  end
+
+  # Sync a single invoice by its QBO ID, used for webhook updates
+  def sync_by_id(id)
+    @qbo.perform_authenticated_request do |access_token|
+      service = Quickbooks::Service::Invoice.new(company_id: @qbo.realm_id, access_token: access_token)
+      remote = service.fetch_by_id(id)
+      persist(remote)
+    end
+  end
+
+  private
+
+  # Fetch a page of invoices, either all or only those updated since the last sync
+  def fetch_page(service, page, full_sync)
+    start_position = (page - 1) * PAGE_SIZE + 1
+
+    if full_sync
+      service.query("SELECT * FROM Invoice STARTPOSITION #{start_position} MAXRESULTS #{PAGE_SIZE}")
+    else
+      last_update = Invoice.maximum(:qbo_updated_at) || 1.year.ago
+      service.query(<<~SQL.squish)
+        SELECT * FROM Invoice
+        WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}'
+        STARTPOSITION #{start_position}
+        MAXRESULTS #{PAGE_SIZE}
+      SQL
+    end
+  end
+
+  # Create or update a local Invoice record based on the QBO remote data
+  def persist(remote)
+    invoice = Invoice.find_or_initialize_by(id: remote.id)
+
+    invoice.doc_number      = remote.doc_number
+    invoice.txn_date        = remote.txn_date
+    invoice.due_date        = remote.due_date
+    invoice.total_amount    = remote.total
+    invoice.balance         = remote.balance
+    invoice.qbo_updated_at  = remote.meta_data&.last_updated_time
+
+    invoice.customer = Customer.find_by(id: remote.customer_ref&.value)
+
+    invoice.save!
+
+    InvoiceAttachmentService.new(invoice, remote).attach
+  end
+
+  def log(msg)
+    Rails.logger.info "[InvoiceSyncService] #{msg}"
+  end
+end