Merge branch 'master' into dev

app/controllers/estimate_controller.rb

@@ -65,7 +65,7 @@ class EstimateController < ApplicationController
 
   # Renders the estimate PDF or redirects with an error if rendering fails.
   def render_pdf(estimate)
-    pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [estimate.id])
+    pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [estimate.id])
     send_data( pdf, filename: "estimate #{ref}.pdf", disposition: :inline, type: "application/pdf" )
   rescue StandardError => e
     log "PDF render failed for Estimate #{estimate&.id}: #{e.message}"

app/controllers/invoice_controller.rb

@@ -18,7 +18,7 @@ class InvoiceController < ApplicationController
     log "Processing request for #{request.original_url}"
 
     invoice_ids = Array(params[:invoice_ids] || params[:id])
-    pdf, ref = InvoicePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: invoice_ids)
+    pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: invoice_ids)
 
     send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
 

app/controllers/qbo_controller.rb

@@ -46,9 +46,13 @@ class QboController < ApplicationController
     redirect_to issue || root_path, flash: { error: e.message }
   end
 
-  # Manual sync endpoint to trigger a full synchronization of QuickBooks entities with the local database. Enqueues all relevant sync jobs and redirects to the home page with a notice that syncing has started.
+  # Manual sync endpoint to trigger synchronization of QuickBooks entities
+  # with the local database. Supports full or partial sync depending on
+  # the `full_sync` boolean parameter.
   def sync
-    QboSyncDispatcher.full_sync!
+    full_sync = ActiveModel::Type::Boolean.new.cast(params[:full_sync])
+    QboSyncDispatcher.sync!(full_sync: full_sync)
+
     redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
   end
 

app/jobs/customer_sync_job.rb

@@ -1,36 +0,0 @@
-#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 CustomerSyncJob < ApplicationJob
-  queue_as :default
-  retry_on StandardError, wait: 5.minutes, attempts: 5
-
-  # Perform a full sync of all customers, or an incremental sync of only those updated since the last sync
-  def perform(full_sync: false, id: nil)
-    qbo = QboConnectionService.current!
-    raise "No QBO configuration found" unless qbo
-
-    log "Starting #{full_sync ? 'full' : 'incremental'} sync for customer ##{id || 'all'}..."
-
-    service = CustomerSyncService.new(qbo: qbo)
-
-    if id.present?
-      service.sync_by_id(id)
-    else
-      service.sync(full_sync: full_sync)
-    end
-  end
-
-  private
-
-  def log(msg)
-    Rails.logger.info "[CustomerSyncJob] #{msg}"
-  end
-end

app/jobs/employee_sync_job.rb

@@ -1,36 +0,0 @@
-#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 EmployeeSyncJob < ApplicationJob
-  queue_as :default
-  retry_on StandardError, wait: 5.minutes, attempts: 5
-
-  # Performs a sync of employees from QuickBooks Online.
-  def perform(full_sync: false, id: nil)
-    qbo = QboConnectionService.current!
-    raise "No QBO configuration found" unless qbo
-
-    log "Starting #{full_sync ? 'full' : 'incremental'} sync for employee ##{id || 'all'}..."
-
-    service = EmployeeSyncService.new(qbo: qbo)
-
-    if id.present?
-      service.sync_by_id(id)
-    else
-      service.sync(full_sync: full_sync)
-    end
-  end
-
-  private
-
-  def log(msg)
-    Rails.logger.info "[EmployeeSyncJob] #{msg}"
-  end
-end

app/jobs/invoice_sync_job.rb

@@ -1,36 +0,0 @@
-#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 InvoiceSyncJob < ApplicationJob
-  queue_as :default
-  retry_on StandardError, wait: 5.minutes, attempts: 5
-
-  # Performs a sync of invoices from QuickBooks Online.
-  def perform(full_sync: false, id: nil)
-    qbo = QboConnectionService.current!
-    raise "No QBO configuration found" unless qbo
-
-    log "Starting #{full_sync ? 'full' : 'incremental'} sync for invoice ##{id || 'all'}..."
-
-    service = InvoiceSyncService.new(qbo: qbo)
-
-    if id.present?
-      service.sync_by_id(id)
-    else
-      service.sync(full_sync: full_sync)
-    end
-  end
-
-  private
-
-  def log(msg)
-    Rails.logger.info "[InvoiceSyncJob] #{msg}"
-  end
-end

app/jobs/qbo_sync_dispatcher.rb

@@ -11,29 +11,35 @@
 class QboSyncDispatcher
 
   SYNC_JOBS = [
-    CustomerSyncJob,
-    EstimateSyncJob,
-    InvoiceSyncJob,
-    EmployeeSyncJob
+    Customer,
+    Estimate,
+    Invoice,
+    Employee
   ].freeze
 
-  # Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database. Each job is enqueued with the `full_sync` flag set to true.
-  def self.full_sync!
+  # Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database. 
+  # Each job is enqueued with the `full_sync` flag set to true.
+  def self.sync!(full_sync: false)
+    log "Manual Sync initated for #{full_sync ? "full sync" : "incremental sync"}"
+    enque_jobs full_sync: full_sync
+  end
 
+  private
+
+  # Dynamically enques all sync jobs
+  def self.enque_jobs(full_sync: full_sync)
     jobs = SYNC_JOBS.dup
 
     # Allow other plugins to add addtional sync jobs via Hooks
     Redmine::Hook.call_hook( :qbo_full_sync ).each do |context|
         next unless context
         jobs.push context
-        log "Added additionals QBO Sync Job for #{contex.to_s}"
+        log "Added additionals QBO Sync Job for #{context.to_s}"
     end
 
-    jobs.each { |job| job.perform_later(full_sync: true) }
+    jobs.each { |job| QboSyncJob.perform_later(entity: job, full_sync: full_sync) }
   end
 
-  private
-
   def self.log(msg)
     Rails.logger.info "[QboSyncDispatcher] #{msg}"
   end

app/jobs/qbo_sync_job.rb

@@ -8,23 +8,22 @@
 #
 #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 EstimateSyncJob < ApplicationJob
+class QboSyncJob < ApplicationJob
   queue_as :default
   retry_on StandardError, wait: 5.minutes, attempts: 5
 
-  # Performs a sync of estimates from QuickBooks Online.
-  def perform(full_sync: false, id: nil, doc_number: nil)
-    qbo = QboConnectionService.current!
-    raise "No QBO configuration found" unless qbo
+  # Perform a full sync of all records for the entity, or an incremental sync of only those updated since the last sync
+  def perform(full_sync: false, id: nil, entity: nil, doc_number: nil)
+    raise "An entity to sync is required" unless entity
+    @entity = entity
 
-    log "Starting #{full_sync ? 'full' : 'incremental'} sync for estimate ##{id || doc_number || 'all'}..."
-
-    service = EstimateSyncService.new(qbo: qbo)
+    log "Starting #{full_sync ? 'full' : 'incremental'} sync for #{entity} ##{id || doc_number || 'all'}..."
+    service = "#{entity}SyncService".constantize.new
 
     if id.present?
       service.sync_by_id(id)
     elsif doc_number.present?
-      service.sync_by_doc(doc_number)
+      service.sync_by_doc_number(doc_number)
     else
       service.sync(full_sync: full_sync)
     end
@@ -32,7 +31,8 @@ class EstimateSyncJob < ApplicationJob
 
   private
 
+  # Log messages with the entity type for better traceability
   def log(msg)
-    Rails.logger.info "[EstimateSyncJob] #{msg}"
+    Rails.logger.info "[#{@entity}SyncJob] #{msg}"
   end
 end

app/models/customer.rb

@@ -19,6 +19,7 @@ class Customer < QboBaseModel
   validates_presence_of :name
   before_validation :normalize_phone_numbers
   self.primary_key = :id
+  qbo_sync push: true
   
   acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
                      scope: ->(_context) { left_joins(:project) },
@@ -32,14 +33,12 @@ class Customer < QboBaseModel
 
   # Returns the customer's email address
   def email
-    details
-    return @details&.email_address&.address
+    return details&.email_address&.address
   end
   
   # Updates the customer's email address
   def email=(s)
-    details
-    @details.email_address = s
+    details.email_address = s
   end
   
   # Customers are not bound by a project
@@ -50,22 +49,19 @@ class Customer < QboBaseModel
 
   # returns the customer's mobile phone
   def mobile_phone
-    details
-    return @details&.mobile_phone&.free_form_number
+    return details&.mobile_phone&.free_form_number
   end
   
   # Updates the custome's mobile phone number
   def mobile_phone=(n)
-    details
     pn = Quickbooks::Model::TelephoneNumber.new
     pn.free_form_number = n
-    @details.mobile_phone = pn
+    details.mobile_phone = pn
   end
 
   # Updates Both local DB name & QBO display_name
   def name=(s)
-    details
-    @details.display_name = s
+    details.display_name = s
     super
   end
 
@@ -77,22 +73,19 @@ class Customer < QboBaseModel
 
   # Sets the notes for the customer
   def notes=(s)
-    details
-    @details.notes = s
+    details.notes = s
   end
 
   # returns the customer's primary phone
   def primary_phone
-    details
-    return @details&.primary_phone&.free_form_number
+    return details&.primary_phone&.free_form_number
   end
   
   # Updates the customer's primary phone number
   def primary_phone=(n)
-    details
     pn = Quickbooks::Model::TelephoneNumber.new
     pn.free_form_number = n
-    @details.primary_phone = pn
+    details.primary_phone = pn
   end
 
   # Seach for customers by name or phone number

app/models/employee.rb

@@ -13,5 +13,6 @@ class Employee < QboBaseModel
   has_many :users
   validates_presence_of :id, :name
   self.primary_key = :id
+  qbo_sync push: false
   
 end

app/models/estimate.rb

@@ -14,15 +14,16 @@ class Estimate < QboBaseModel
   belongs_to :customer 
   validates_presence_of :doc_number, :id
   self.primary_key = :id
+  qbo_sync push: false
 
   # returns a human readable string
   def to_s
     return self[:doc_number]
   end
 
-  # sync only one estimate
+  # sync only one estimate by document number
   def self.sync_by_doc_number(number)
-    EstimateSyncJob.perform_later(doc_number: number)
+    QboSyncJob.perform_later(entity: model_name.name, doc_number: number)
   end
   
 end

app/models/invoice.rb

@@ -15,6 +15,7 @@ class Invoice < QboBaseModel
   validates :id, presence: true, uniqueness: true
   validates :doc_number, :txn_date, presence: true
   self.primary_key = :id
+  qbo_sync push: false
 
   # Return the invoice's document number as its string representation
   def to_s

app/models/qbo.rb

@@ -27,8 +27,9 @@ class Qbo < ActiveRecord::Base
   # Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
   def self.last_sync
     qbo = QboConnectionService.current!
-    return I18n.t(:label_qbo_never_synced) unless qbo&.last_sync
     format_time(qbo.last_sync)
+  rescue
+    return I18n.t(:label_qbo_never_synced)
   end
 
   private

app/models/qbo_base_model.rb

@@ -14,6 +14,10 @@ class QboBaseModel < ActiveRecord::Base
 
   self.abstract_class = true
   validates_presence_of :id
+  class_attribute :qbo_push_enabled, default: true
+  attr_accessor :skip_qbo_push
+  before_validation :push_to_qbo, on: :create, if: :push_to_qbo?
+  after_commit :push_to_qbo, on: :update, if: :push_to_qbo?
 
   # Returns the details of the entity. 
   # If the details have already been fetched, it returns the cached version. 
@@ -24,8 +28,7 @@ class QboBaseModel < ActiveRecord::Base
       xml = Rails.cache.fetch(details_cache_key, expires_in: 10.minutes) do
         fetch_details.to_xml_ns
       end
-      model_class = "Quickbooks::Model::#{model_name.name}".constantize
-      model_class.from_xml(xml)
+      qbo_model_class.from_xml(xml)
     end
   end
 
@@ -34,7 +37,6 @@ class QboBaseModel < ActiveRecord::Base
     "#{model_name.name}:#{id}:qbo_details:#{updated_at.to_i}"
   end
 
-
   # Returns the last sync time formatted for display. 
   # If no sync has occurred, returns a default message.
   def self.last_sync
@@ -45,8 +47,7 @@ class QboBaseModel < ActiveRecord::Base
   # Magic Method
   # Maps Get/Set methods to QBO entity object
   def method_missing(method_name, *args, &block)
-    model_class = "Quickbooks::Model::#{model_name.name}".constantize
-    if model_class.method_defined?(method_name)
+    if qbo_model_class.method_defined?(method_name)
       details
       @details.public_send(method_name, *args, &block)
     else
@@ -54,40 +55,42 @@ class QboBaseModel < ActiveRecord::Base
     end
   end
 
-  # Repsonds to missing methods by delegating to the QBO customer details object if the method is defined there.
+  def push_to_qbo?
+    log "qbo_push_enabled #{self.class.qbo_push_enabled}"
+    log "skip_qbo_push #{skip_qbo_push}"
+
+    self.class.qbo_push_enabled && skip_qbo_push != true
+  end
+
+  # Repsonds to missing methods by delegating to the QBO entity calss if the method is defined there.
   # This allows for dynamic access to any attributes or methods of the QBO customer without having to explicitly define them in the Subclass model, providing flexibility and reducing boilerplate code.
   def respond_to_missing?(method_name, include_private = false)
-    model_class = "Quickbooks::Model::#{model_name.name}".constantize
-    model_class.method_defined?(method_name) || super
+    qbo_model_class.method_defined?(method_name) || super
   end
 
   # Sync all entities, typically triggered by a scheduled task or manual sync request
   def self.sync
-    job = "#{model_name.name}SyncJob".constantize
-    job.perform_later(full_sync: true)
+    QboSyncJob.perform_later(entity: model_name.name, full_sync: true)
   end
 
   # Sync a single entity by ID, typically triggered by a webhook notification or manual sync request
   def self.sync_by_id(id)
-    job = "#{model_name.name}SyncJob".constantize
-    job.perform_later(id: id)
+    QboSyncJob.perform_later(entity: model_name.name, id: id)
   end
 
-  # Push the updates
-  def save_with_push
-    log "Starting push for #{model_name.name} ##{self.id}..."
-    qbo = QboConnectionService.current!
-    service = "#{model_name.name}Service".constantize
-    service.new(qbo: qbo, remote: self).push()
-    Rails.cache.delete(details_cache_key)
-    save_without_push
+  # Flag used to update local without pushing to QBO.
+  # This is used to prevent loops with the webhook
+  def skip_qbo_push?
+     !!skip_qbo_push
   end
 
-   alias_method :save_without_push, :save
-   alias_method :save, :save_with_push
+  def self.qbo_sync(push: true)
+    self.qbo_push_enabled = push
+  end
 
   private
   
+  # Log messages with a standarized prefix
   def log(msg)
     Rails.logger.info "[#{model_name.name}] #{msg}"
   end
@@ -95,9 +98,25 @@ class QboBaseModel < ActiveRecord::Base
   # Fetches the entity's details from QuickBooks Online. 
   def fetch_details
     log "Fetching details for #{model_name.name} ##{id} from QBO..."
-    qbo = QboConnectionService.current!
-    service_class = "#{model_name.name}Service".constantize
-    service_class.new(qbo: qbo, remote: self).pull()
+    service_class.new(local: self).pull()
+  end
+
+  # Pushs the entity's details from QuickBooks Online.
+  def push_to_qbo
+    log "Starting push for #{model_name.name} ##{id}..."
+    reslut = service_class.new(local: self).push
+    Rails.cache.delete(details_cache_key)
+    return reslut
+  end
+
+  # Dynamically get the Quickbooks Model Class
+  def qbo_model_class
+    @qbo_model_class ||= "Quickbooks::Model::#{model_name.name}".constantize
+  end
+
+  # Dynamically get the Service Class
+  def service_class
+    @service_class ||= "#{model_name.name}Service".constantize
   end
 
 end

app/services/customer_sync_service.rb

@@ -17,16 +17,13 @@ class CustomerSyncService < SyncServiceBase
     Customer
   end
 
-  # Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
-  def destroy_remote?(remote)
+  # Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
+  def destroy_local?(remote)
     !remote.active?
   end
 
-  # Map relevant attributes from the QBO Customer to the local Customer model
-  def process_attributes(local, remote)
-    local.name = remote.display_name
-    local.phone_number = remote.primary_phone&.free_form_number&.gsub(/\D/, '')
-    local.mobile_phone_number = remote.mobile_phone&.free_form_number&.gsub(/\D/, '')
-  end
+  map_attribute :name, :display_name
+  map_phone :phone_number, :primary_phone
+  map_phone :mobile_phone_number, :mobile_phone
 
 end

app/services/employee_sync_service.rb

@@ -17,14 +17,11 @@ class EmployeeSyncService < SyncServiceBase
     Employee
   end
 
-  # Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
-  def destroy_remote?(remote)
+  # Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
+  def destroy_local?(remote)
     !remote.active?
   end
 
-  # Map relevant attributes from the QBO Employee to the local Employee model
-  def process_attributes(local, remote)
-    local.name = remote.display_name
-  end
+  map_attribute :name, :display_name
 
 end

app/services/estimate_pdf_service.rb

@@ -1,16 +0,0 @@
-#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 EstimatePdfService < PdfServiceBase
-
-  def self.model_class
-    Estimate
-  end
-
-end

app/services/estimate_sync_service.rb

@@ -10,6 +10,14 @@
 
 class EstimateSyncService < SyncServiceBase
 
+  # sync only one estimate
+  def sync_by_doc_number(number)
+    log "Syncing estimate by doc number #{number}"
+    QboConnectionService.with_qbo_service(entity: @entity) do |service|
+      persist(service.find_by( :doc_number, number).first)
+    end
+  end
+  
   private
 
   # Specify the local model this service syncs
@@ -17,11 +25,7 @@ class EstimateSyncService < SyncServiceBase
     Estimate
   end
 
-  # Map relevant attributes from the QBO Estimate to the local Estimate model
-  def process_attributes(local, remote)
-    local.doc_number = remote.doc_number
-    local.txn_date = remote.txn_date
-    local.customer = Customer.find_by(id: remote.customer_ref&.value)
-  end
+  map_attributes :doc_number, :txn_date
+  map_belongs_to :customer
 
 end

app/services/invoice_pdf_service.rb

@@ -1,16 +0,0 @@
-#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 InvoicePdfService < PdfServiceBase
-
-  def self.model_class
-    Invoice
-  end
-
-end

app/services/invoice_push_service.rb

@@ -17,20 +17,11 @@ class InvoicePushService
   # 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 = QboConnectionService.current!
-
-    qbo.perform_authenticated_request do |access_token|
-      service = Quickbooks::Service::Invoice.new( company_id: qbo.realm_id, access_token: access_token)
-
+    remote = QboConnectionService.with_qbo_service(entity: Invoice) do |service|
       remote = service.fetch_by_id(@invoice.id)
-
       # modify remote object here if needed
-
       service.update(remote)
     end
   rescue => e

app/services/invoice_sync_service.rb

@@ -17,19 +17,14 @@ class InvoiceSyncService < SyncServiceBase
     Invoice
   end
 
-  # Map relevant attributes from the QBO Invoice to the local Invoice model
-  def process_attributes(local, remote)
-    local.doc_number      = remote.doc_number
-    local.txn_date        = remote.txn_date
-    local.due_date        = remote.due_date
-    local.total_amount    = remote.total
-    local.balance         = remote.balance
-    local.qbo_updated_at  = remote.meta_data&.last_updated_time
-    local.customer = Customer.find_by(id: remote.customer_ref&.value)
-  end
-
   # Attach QBO Invoices to the local Issues
   def attach_documents(local, remote)
     InvoiceAttachmentService.new(local, remote).attach
   end
+
+  map_attributes :balance, :doc_number, :due_date, :txn_date
+  map_attribute :total_amount, :total
+  map_attribute :qbo_updated_at, "meta_data.last_updated_time"
+  map_belongs_to :customer
+
 end

app/services/pdf_service.rb

@@ -7,30 +7,21 @@
 #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 PdfServiceBase
+class PdfService
   
   require 'combine_pdf'
 
   # Subclasses should initialize with a QBO client instance
-  def initialize(qbo:)
-    @qbo = qbo
-    @entity = self.class.model_class
-  end
-
-  # Subclasses must implement this to specify which document model to download pdf (e.g. Estimate, Invoice)
-  def self.model_class
-    raise NotImplementedError
+  def initialize(entity: entity)
+    raise "An entity to sync is required" unless entity
+    @entity = entity
   end
 
   # Fetches the PDF for the given entity IDs. If multiple IDs are provided, their PDFs are combined into a single document.
   def fetch_pdf(doc_ids:)
     log "Fetching PDFs for #{@entity} IDs: #{doc_ids.join(', ')}"
-    @qbo.perform_authenticated_request do |access_token|
-      service_class = "Quickbooks::Service::#{@entity.name}".constantize
-      service = service_class.new(company_id: @qbo.realm_id, access_token: access_token)
-      
+    QboConnectionService.with_qbo_service(entity: @entity) do |service|
       return single_pdf(service, doc_ids.first) if doc_ids.size == 1
-
       combined_pdf(service, doc_ids)
     end
   end

app/services/qbo_connection_service.rb

@@ -10,6 +10,11 @@
 
 class QboConnectionService
 
+  # Returns the current QBO connection record. Raises an error if no connection exists.
+  def self.current!
+    Qbo.first || raise("QBO not connected")
+  end
+
   # Replaces the existing QBO connection with new credentials. Deletes all existing records and creates a new one with the provided token, refresh token, and realm ID. Refreshes the token immediately after creation.
   def self.replace!(token:, refresh_token:, realm_id:)
     Qbo.transaction do
@@ -24,9 +29,14 @@ class QboConnectionService
     end
   end
 
-  # Returns the current QBO connection record. Raises an error if no connection exists.
-  def self.current!
-    Qbo.first || raise("QBO not connected")
+  # Performs authenticaed requests with QBO service
+  def self.with_qbo_service(entity: nil)
+    qbo = current!
+    raise "An entity to sync is required" unless entity
+    service_class ||= "Quickbooks::Service::#{entity}".constantize
+    qbo.perform_authenticated_request do |access_token|
+      service = service_class.new( company_id: qbo.realm_id, access_token: access_token )
+      yield service
+    end
   end
-
 end

app/services/qbo_oauth_service.rb

@@ -10,7 +10,8 @@
 
 class QboOauthService
 
-  # Generates the QuickBooks OAuth authorization URL with the specified callback URL. The URL includes necessary parameters such as response type, state, and scope.
+  # Generates the QuickBooks OAuth authorization URL with the specified callback URL.
+  # The URL includes necessary parameters such as response type, state, and scope.
   def self.authorization_url(callback_url:)
     client.auth_code.authorize_url(
       redirect_uri: callback_url,
@@ -20,7 +21,8 @@ class QboOauthService
     )
   end
 
-  # Exchanges the authorization code for access and refresh tokens. Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation.
+  # Exchanges the authorization code for access and refresh tokens. 
+  # Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation.
   def self.exchange!(code:, callback_url:, realm_id:)
     resp = client.auth_code.get_token(code, redirect_uri: callback_url)
     QboConnectionService.replace!( token: resp.token, refresh_token: resp.refresh_token, realm_id: realm_id )

app/services/service_base.rb

@@ -10,22 +10,15 @@
 
 class ServiceBase
 
-  # Subclasses should Initializes the service with a QBO client and an optional remote record. 
+  # Subclasses should Initializes the service with a QBO client and a local record. 
   # The QBO client is used to communicate with QuickBooks Online, while the local record contains the data that needs to be pushed to QBO. 
-  # If no remote is provided, the service will not perform any operations.
-  def initialize(qbo:, remote: nil)
-    raise "No QBO configuration found" unless qbo
-    raise "#{@entity} record is required for push operation" unless remote
-    @qbo = qbo
-    @entity = remote.class.name
-    @remote = remote
+  # If no local is provided, the service will not perform any operations.
+  def initialize(local: nil)
+    @entity = local.class.name
+    raise "#{@entity} record is required for push operation" unless local
+    @local = local
   end
 
-  # # Subclasses must implement this to specify which local model they sync (e.g. Customer, Invoice)
-  # def self.model_class
-  #   raise NotImplementedError
-  # end
-
   # Subclasses must implement this to build a new QBO entity if a remote is not found
   def build_qbo_remote
     raise NotImplementedError
@@ -33,43 +26,35 @@ class ServiceBase
 
   # Pulls the Item data from QuickBooks Online. 
   def pull
-    return build_qbo_remote unless @remote.present?
-    return build_qbo_remote unless @remote.id
-    log "Fetching details for #{@entity} ##{@remote.id} from QBO..."
-    qbo = QboConnectionService.current!
-    qbo.perform_authenticated_request do |access_token|
-      service_class = "Quickbooks::Service::#{@entity}".constantize
-      service = service_class.new(
-        company_id: qbo.realm_id,
-        access_token: access_token
-      )
-      service.fetch_by_id(@remote.id)
+    return build_qbo_remote unless @local.present?
+    return build_qbo_remote unless @local.id
+    log "Fetching details for #{@entity} ##{@local.id} from QBO..."
+    QboConnectionService.with_qbo_service(entity: @entity) do |service|
+      service.fetch_by_id(@local.id)
     end
   rescue => e
-    log "Fetch failed for #{@remote.id}: #{e.message}"
+    log "Fetch failed for #{@local.id}: #{e.message}"
     build_qbo_remote
   end
 
-   # Pushes the Item data to QuickBooks Online. This method handles the communication with QBO, including authentication and error handling. It uses the QBO client to send the remote data and logs the process for monitoring and debugging purposes. If the push is successful, it returns the remote record; otherwise, it logs the error and returns false.
+   # Pushes the Item data to QuickBooks Online. 
+   # This method handles the communication with QBO, including authentication and error handling. 
+   # It uses the QBO client to send the remote data and logs the process for monitoring and debugging purposes. 
+   # If the push is successful, it returns the remote record; otherwise, it logs the error and returns false.
   def push
-    log "Pushing #{@entity} ##{@remote.id} to QBO..."
-
-    remote = @qbo.perform_authenticated_request do |access_token|
-      service_class = "Quickbooks::Service::#{@entity}".constantize
-      service = service_class.new( 
-        company_id: @qbo.realm_id, 
-        access_token: access_token 
-      )
-      if @remote.id.present?
-        service.update(@remote.details)
+    log "Pushing #{@entity} ##{@local.id} to QBO..."
+    remote = QboConnectionService.with_qbo_service(entity: @entity) do |service|
+      if @local.id.present?
+        log "Updating #{@entity}"
+        service.update(@local.details)
       else
-        service.create(@remote.details)
+        log "Creating #{@entity}"
+        service.create(@local.details)
       end
     end
-
-    @remote.id = remote.id unless @remote.persisted?
-    log "Push for remote ##{@remote.id} completed."
-    return @remote
+    @local.id = remote.id unless @local.persisted?
+    log "Push for remote ##{@local.id} completed."
+    @local
   end
 
   private 

app/services/sync_service_base.rb

@@ -12,9 +12,7 @@ class SyncServiceBase
   PAGE_SIZE = 1000
 
   # Subclasses should initialize with a QBO client instance
-  def initialize(qbo:)
-    raise "No QBO configuration found" unless qbo
-    @qbo = qbo
+  def initialize()
     @entity = self.class.model_class
     @page_size = self.class.page_size 
   end
@@ -32,17 +30,11 @@ class SyncServiceBase
   # Sync all entities, or only those updated since the last sync
   def sync(full_sync: false)
     log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync with page size of: #{@page_size}"
-
-    @qbo.perform_authenticated_request do |access_token|
-      service_class = "Quickbooks::Service::#{@entity.name}".constantize
-      service = service_class.new(company_id: @qbo.realm_id, access_token: access_token)
-
+    QboConnectionService.with_qbo_service(entity: @entity) do |service|
       query = build_query(full_sync)  
-
       service.query_in_batches(query, per_page: @page_size) do |batch|
         entries = Array(batch)
         log "Processing batch of #{entries.size} #{@entity.name}"
-
         entries.each do |remote|
           persist(remote)
         end
@@ -55,11 +47,7 @@ class SyncServiceBase
   # Sync a single entity by its QBO ID (webhook usage)
   def sync_by_id(id)
     log "Syncing #{@entity.name} with ID #{id}"
-
-    @qbo.perform_authenticated_request do |access_token|
-      service_class = "Quickbooks::Service::#{@entity.name}".constantize
-      service = service_class.new(company_id: @qbo.realm_id, access_token: access_token)
-
+    QboConnectionService.with_qbo_service(entity: @entity) do |service|
       remote = service.fetch_by_id(id)
       persist(remote)
     end
@@ -67,6 +55,10 @@ class SyncServiceBase
 
   private
 
+  def attach_documents(local, remote)
+    # Override in subclasses if the entity has attachments (e.g. Invoice)
+  end
+
   # Builds a QBO query for retrieving entities
   def build_query(full_sync)
     if full_sync
@@ -82,13 +74,125 @@ class SyncServiceBase
     end
   end
 
-  def attach_documents(local, remote)
-    # Override in subclasses if the entity has attachments (e.g. Invoice)
+  # Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
+  def destroy_local?(remote)
+    false
   end
 
-  # Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
-  def destroy_remote?(remote)
-    false
+  def extract_value(remote, remote_attr)
+    case remote_attr
+    when Proc
+      remote_attr.call(remote)
+    else
+      remote.public_send(remote_attr)
+    end
+  end
+
+  # Attribute Mapping DSL
+  #
+  # This DSL defines how attributes from a QuickBooks Online (QBO) entity
+  # are mapped onto a local ActiveRecord model during synchronization.
+  #
+  # Each mapping registers a lambda in `attribute_map`. When a remote QBO
+  # object is processed, the lambda is executed to extract and transform
+  # the value that will be assigned to the local model attribute.
+  #
+  # The DSL supports several mapping patterns:
+  #
+  # 1. Direct attribute mapping (same name)
+  #
+  #      map_attribute :doc_number
+  #
+  #    Equivalent to:
+  #
+  #      local.doc_number = remote.doc_number
+  #
+  # 2. Renamed attribute mapping
+  #
+  #      map_attribute :total_amount, :total
+  #
+  #    Equivalent to:
+  #
+  #      local.total_amount = remote.total
+  #
+  # 3. Custom transformation logic
+  #
+  #      map_attribute :qbo_updated_at do |remote|
+  #        remote.meta_data&.last_updated_time
+  #      end
+  #
+  #    Useful for nested fields or computed values.
+  #
+  # 4. Bulk attribute mapping
+  #
+  #      map_attributes :doc_number, :txn_date, :due_date
+  #
+  #    Convenience helper that maps multiple attributes with identical names.
+  #
+  # 5. Foreign key / reference mapping
+  #
+  #      map_belongs_to :customer
+  #
+  #    Resolves a QBO reference object (e.g. `customer_ref.value`) and finds
+  #    the associated local ActiveRecord model.
+  #
+  # 6. Specialized helpers
+  #
+  #      map_phone :phone_number, :primary_phone
+  #
+  #    Extracts and normalizes phone numbers by stripping non-digit characters.
+  #
+  # Internally, the mappings are stored in `attribute_map` and executed by the
+  # SyncService during `process_attributes`, which iterates through each mapping
+  # and assigns the computed value to the local record.
+  #
+  # This design keeps synchronization services declarative, readable, and easy
+  # to extend while centralizing transformation logic in a single DSL.
+  class << self
+
+    def map_attributes(*attrs)
+      attrs.each do |attr|
+        map_attribute(attr)
+      end
+    end
+
+
+    def map_attribute(local_attr, remote_attr = nil, &block)
+      attribute_map[local_attr] =
+        if block_given?
+          block
+        elsif remote_attr
+          ->(remote) do
+            remote_attr.to_s.split('.').reduce(remote) do |obj, method|
+              obj&.public_send(method)
+            end
+          end
+        else
+          ->(remote) { remote.public_send(local_attr) }
+        end
+    end
+
+    def attribute_map
+      @attribute_map ||= {}
+    end
+
+    def map_belongs_to(local_attr, ref: nil, model: nil)
+      ref ||= "#{local_attr}_ref"
+      model ||= local_attr.to_s.classify.constantize
+
+      attribute_map[local_attr] = lambda do |remote|
+        ref_obj = remote.public_send(ref)
+        id = ref_obj&.value
+        id ? model.find_by(id: id) : nil
+      end
+    end
+
+    def map_phone(local_attr, remote_attr)
+      attribute_map[local_attr] = lambda do |remote|
+        phone = remote.public_send(remote_attr)
+        phone&.free_form_number&.gsub(/\D/, '')
+      end
+    end
   end
 
   # Log messages with the entity type for better traceability
@@ -100,7 +204,7 @@ class SyncServiceBase
   def persist(remote)
     local = @entity.find_or_initialize_by(id: remote.id)
     
-    if destroy_remote?(remote)
+    if destroy_local?(remote)
       if local.persisted?
         local.destroy
         log "Deleted #{@entity.name} #{remote.id}"
@@ -110,9 +214,11 @@ class SyncServiceBase
 
     process_attributes(local, remote)
     
-    if local.changed?
+    if local.new_record? || local.changed?
+      was_new = local.new_record?
+      local.skip_qbo_push = true
       local.save!
-      log "Updated #{@entity.name} #{remote.id}"
+      log "#{was_new ? 'Created' : 'Updated'} #{@entity.name} #{remote.id}"
       attach_documents(local, remote)
     end
 
@@ -120,8 +226,16 @@ class SyncServiceBase
     log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}"
   end
 
-  # This method should be implemented in subclasses to map remote attributes to local model
+  # Maps remote attributes to local model
   def process_attributes(local, remote)
-    raise NotImplementedError, "Subclasses must implement process_attributes"
+    log "Processing #{@entity} ##{remote.id}"
+
+    self.class.attribute_map.each do |local_attr, mapper|
+      value = mapper.call(remote)
+
+      if local.public_send(local_attr) != value
+        local.public_send("#{local_attr}=", value)
+      end
+    end
   end
 end

app/views/customers/_search.html.erb

@@ -3,3 +3,4 @@
     <%= submit_tag t(:label_search) %>
 <% end %>
 <%= button_to t(:label_new_customer), new_customer_path, method: :get%>
+<%= button_to(t(:label_sync), qbo_sync_path, method: :get) if User.current.admin?%>

app/views/qbo/_settings.html.erb

@@ -107,5 +107,5 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
     <br/>
     
     <div>
-        <b><%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %> <%= link_to t(:label_sync_now), qbo_sync_path %>
+        <b><%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %> <%= link_to t(:label_sync_now), qbo_sync_path(full_sync: true) %>
 </div>

init.rb

@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
   name 'Redmine QBO plugin'
   author 'Rick Barrette'
   description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed'
-  version '2026.3.6'
+  version '2026.3.8'
   url 'https://github.com/rickbarrette/redmine_qbo'
   author_url 'https://barrettefabrication.com'
   settings default: {empty: true}, partial: 'qbo/settings'

lib/redmine_qbo/patches/pdf_patch.rb

@@ -260,7 +260,7 @@ module RedmineQbo
 
           # Check to see if there is an estimate attached, then combine them
           if issue.estimate
-            e_pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [issue.estimate.id])
+            e_pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [issue.estimate.id])
             pdf = CombinePDF.parse(pdf.output, allow_optional_content: true)
             pdf << CombinePDF.parse(e_pdf)
             return pdf.to_pdf