refactor(sync): improve attribute mapping to support dynamic fields and custom transformations

app/models/qbo_base_model.rb

@@ -15,6 +15,10 @@ class QboBaseModel < ActiveRecord::Base
   self.abstract_class = true
   validates_presence_of :id
 
+  attr_accessor :skip_qbo_push
+  before_validation :push_to_qbo, on: :create
+  after_commit :push_to_qbo, on: :update, unless: :skip_qbo_push?
+
   # Returns the details of the entity. 
   # If the details have already been fetched, it returns the cached version. 
   # Otherwise, it fetches the details from QuickBooks Online and caches them for future use. 
@@ -24,17 +28,15 @@ 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
 
-   # Generates a unique cache key for storing this customer's QBO details.
+  # Generates a unique cache key for storing this customer's QBO details.
   def details_cache_key
     "#{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,11 +55,10 @@ class QboBaseModel < ActiveRecord::Base
     end
   end
 
-  # Repsonds to missing methods by delegating to the QBO customer details object if the method is defined there.
+  # 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
@@ -73,21 +73,15 @@ class QboBaseModel < ActiveRecord::Base
     job.perform_later(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
-
   private
   
+  # Log messages with a standarized prefix
   def log(msg)
     Rails.logger.info "[#{model_name.name}] #{msg}"
   end
@@ -96,8 +90,26 @@ class QboBaseModel < ActiveRecord::Base
   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(qbo: qbo, local: self).pull()
+  end
+
+  # Pushs the entity's details from QuickBooks Online.
+  def push_to_qbo
+    log "Starting push for #{model_name.name} ##{id}..."
+    qbo = QboConnectionService.current!
+    reslut = service_class.new(qbo: qbo, 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, ->(remote) { remote.display_name }
+  map_attribute :phone_number, ->(remote) { remote.primary_phone&.free_form_number&.gsub(/\D/, '') }
+  map_attribute :mobile_phone_number, ->(remote) { remote.mobile_phone&.free_form_number&.gsub(/\D/, '') }
 
 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, ->(remote) { remote.display_name }
 
 end

app/services/estimate_sync_service.rb

@@ -17,11 +17,6 @@ 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_attribute :customer, ->(remote) { Customer.find_by(id: remote.customer_ref&.value) }
 
 end

app/services/invoice_sync_service.rb

@@ -16,20 +16,13 @@ class InvoiceSyncService < SyncServiceBase
   def self.model_class
     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_attribute :customer, ->(remote) { Customer.find_by(id: remote.customer_ref&.value) }
+  map_attribute :total_amount, ->(remote) { remote.total }
+  map_attribute :qbo_updated_at, ->(remote) { remote.meta_data&.last_updated_time }
 end

app/services/service_base.rb

@@ -10,22 +10,17 @@
 
 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)
+  # If no local is provided, the service will not perform any operations.
+  def initialize(qbo:, local: nil)
+    @entity = local.class.name
     raise "No QBO configuration found" unless qbo
-    raise "#{@entity} record is required for push operation" unless remote
+    raise "#{@entity} record is required for push operation" unless local
     @qbo = qbo
-    @entity = remote.class.name
-    @remote = remote
+    @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,50 +28,55 @@ 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..."
+    with_qbo_service 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 = with_qbo_service 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 
 
+  # Performs authenticaed requests with QBO service
+  def with_qbo_service
+    @qbo.perform_authenticated_request do |access_token|
+      service = service_class.new( company_id: @qbo.realm_id, access_token: access_token )
+      yield service
+    end
+  end
+
   # Log messages with the entity type for better traceability
   def log(msg)
     Rails.logger.info "[#{@entity}Service] #{msg}"
   end
 
+  # Dynamically get the Quickbooks Service Class
+  def service_class
+    @service_class ||= "Quickbooks::Service::#{@entity}".constantize
+  end
+
 end

app/services/sync_service_base.rb

@@ -32,17 +32,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)
-
-      query = build_query(full_sync)
-
+    with_qbo_service 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 +49,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)
-
+    with_qbo_service do |service|
       remote = service.fetch_by_id(id)
       persist(remote)
     end
@@ -67,6 +57,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 +76,28 @@ 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
+
+  class << self
+    def map_attribute(local, remote = nil, &block)
+      attribute_map[local] = block || remote
+    end
+
+    def attribute_map
+      @attribute_map ||= {}
+    end
   end
 
   # Log messages with the entity type for better traceability
@@ -100,7 +109,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}"
@@ -111,7 +120,8 @@ class SyncServiceBase
     process_attributes(local, remote)
 
     if local.changed?
-      local.save!
+      local.skip_qbo_push = true
+      local.save
       log "Updated #{@entity.name} #{remote.id}"
       attach_documents(local, remote)
     end
@@ -120,8 +130,25 @@ 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, remote_attr|
+      value = extract_value(remote, remote_attr)
+      local.public_send("#{local_attr}=", value)
+    end
+  end
+
+  # Dynamically get the Quickbooks Service Class
+  def service_class
+    @service_class ||= "Quickbooks::Service::#{@entity}".constantize
+  end
+
+  # Performs authenticaed requests with QBO service
+  def with_qbo_service
+    @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