Refactored models to use base model

app/models/customer.rb

@@ -8,19 +8,16 @@
 #
 #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 Customer < ActiveRecord::Base
+class Customer < QboBaseModel
 
   include Redmine::Acts::Searchable
   include Redmine::Acts::Event  
-  include Redmine::I18n
 
   has_many :issues
   has_many :invoices
   has_many :estimates
- 
+  validates_presence_of :name
-  validates_presence_of :id, :name
   before_validation :normalize_phone_numbers
-  
   self.primary_key = :id
   
   acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
@@ -33,24 +30,6 @@ class Customer < ActiveRecord::Base
                 :description => Proc.new {|o| "#{I18n.t :label_primary_phone}: #{o.phone_number} #{I18n.t:label_mobile_phone}: #{o.mobile_phone_number}"},
                 :datetime => Proc.new {|o| o.updated_at || o.created_at}
 
-  # Returns the details of the customer. 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. This method is used to access the customer's information in a way that minimizes unnecessary API calls to QBO, improving performance and reducing latency.
-  def details
-    return (@details ||= Quickbooks::Model::Customer.new) if new_record?
-
-    @details ||= begin
-      xml = Rails.cache.fetch(details_cache_key, expires_in: 10.minutes) do
-        fetch_details.to_xml_ns
-      end
-
-      Quickbooks::Model::Customer.from_xml(xml)
-    end
-  end
-
-  # Generates a unique cache key for storing this customer's QBO details.
-  def details_cache_key
-    "customer:#{id}:qbo_details:#{updated_at.to_i}"
-  end
-
   # Returns the customer's email address
   def email
     details
@@ -63,30 +42,12 @@ class Customer < ActiveRecord::Base
     @details.email_address = s
   end
   
-
-  # Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
-  def self.last_sync
-    return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
-    format_time(maximum(:updated_at))
-  end
-  
   # Customers are not bound by a project
   # but we need to implement this method for the Redmine::Acts::Searchable interface
   def project
     nil
   end
 
-  # Magic Method
-  # Maps Get/Set methods to QBO customer object
-  def method_missing(method_name, *args, &block)
-    if Quickbooks::Model::Customer.method_defined?(method_name)
-      details
-      @details.public_send(method_name, *args, &block)
-    else
-      super
-    end
-  end
-
   # returns the customer's mobile phone
   def mobile_phone
     details
@@ -134,11 +95,6 @@ class Customer < ActiveRecord::Base
     @details.primary_phone = pn
   end
 
-  # Repsonds to missing methods by delegating to the QBO customer details object 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 Customer model, providing flexibility and reducing boilerplate code.
-  def respond_to_missing?(method_name, include_private = false)
-    Quickbooks::Model::Customer.method_defined?(method_name) || super
-  end
-
   # Seach for customers by name or phone number
   def self.search(search)
     #return none if search.blank?
@@ -160,47 +116,10 @@ class Customer < ActiveRecord::Base
     ids.index_with { |id| id }
   end
   
-  # performs a sync operation for all customers
-  def self.sync 
-    CustomerSyncJob.perform_later(full_sync: false)
-  end
-
-  # performs a sync operation for a specific customer
-  def self.sync_by_id(id) 
-    CustomerSyncJob.perform_later(id: id)
-  end
-  
   # returns a human readable string
   def to_s
     last4 = phone_number&.last(4)
     last4.present? ? "#{name} - #{last4}" : name.to_s
   end
   
-  # Push the updates
-  def save_with_push
-    log "Starting push for customer ##{self.id}..."
-    qbo = QboConnectionService.current!
-    CustomerService.new(qbo: qbo, customer: self).push()
-    Rails.cache.delete(details_cache_key)
-    save_without_push
-  end
-
-  alias_method :save_without_push, :save
-  alias_method :save, :save_with_push
-  
-  private
-
-  # Fetches the customer's details from QuickBooks Online. If the customer has an ID, it makes an authenticated request to QBO to retrieve the customer's information. If the customer does not have an ID or if there is an error during the fetch, it returns a new instance of Quickbooks::Model::Customer with default values. This method is used to ensure that the customer object has the most up-to-date information from QBO when needed.
-  def fetch_details
-    return Quickbooks::Model::Customer.new unless id.present?
-    log "Fetching details for customer ##{id} from QBO..."
-    qbo = QboConnectionService.current!
-    CustomerService.new(qbo: qbo, customer: self).pull()
-  end
-
-  # Log messages with the entity type for better traceability
-  def log(msg)
-    Rails.logger.info "[Customer] #{msg}"
-  end
-  
 end

app/models/employee.rb

@@ -8,29 +8,10 @@
 #
 #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 Employee < ActiveRecord::Base
+class Employee < QboBaseModel
-  
-  include Redmine::I18n
 
   has_many :users
   validates_presence_of :id, :name
-
   self.primary_key = :id
   
-  # Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
-  def self.last_sync
-    return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
-    format_time(maximum(:updated_at))
-  end
-  
-  # Sync all employees, typically triggered by a scheduled task or manual sync request
-  def self.sync
-    EmployeeSyncJob.perform_later(full_sync: true)
-  end
-
-  # Sync a single employee by ID, typically triggered by a webhook notification or manual sync request
-  def self.sync_by_id(id)
-    EmployeeSyncJob.perform_later(id: id)
-  end
-  
 end

app/models/estimate.rb

@@ -8,45 +8,21 @@
 #
 #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 Estimate < ActiveRecord::Base
+class Estimate < QboBaseModel
-  
-  include Redmine::I18n
 
   has_and_belongs_to_many :issues
   belongs_to :customer 
   validates_presence_of :doc_number, :id
   self.primary_key = :id
 
-  # Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
-  def self.last_sync
-    return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
-    format_time(maximum(:updated_at))
-  end
-
   # returns a human readable string
   def to_s
     return self[:doc_number]
   end
 
-  # sync all estimates
-  def self.sync
-    EstimateSyncJob.perform_later(full_sync: false)
-  end
-  
-  # sync only one estimate
-  def self.sync_by_id(id)
-    EstimateSyncJob.perform_later(id: id)
-  end
-
   # sync only one estimate
   def self.sync_by_doc_number(number)
     EstimateSyncJob.perform_later(doc_number: number)
   end
   
-  private
-
-  def log(msg)
-    Rails.logger.info "[Estimate] #{msg}"
-  end
-  
 end

app/models/invoice.rb

@@ -8,37 +8,17 @@
 #
 #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 Invoice < ActiveRecord::Base
+class Invoice < QboBaseModel
-
-  include Redmine::I18n
 
   has_and_belongs_to_many :issues
   belongs_to :customer
-
   validates :id, presence: true, uniqueness: true
   validates :doc_number, :txn_date, presence: true
-
   self.primary_key = :id
 
-  # Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
-  def self.last_sync
-    return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
-    format_time(maximum(:updated_at))
-  end
-
   # Return the invoice's document number as its string representation
   def to_s
     doc_number
   end
 
-  # Sync all invoices from QuickBooks, typically triggered by a scheduled task or manual sync request
-  def self.sync
-    InvoiceSyncJob.perform_later(full_sync: true)
-  end
-
-  # Sync a single invoice by ID, typically triggered by a webhook notification or manual sync request
-  def self.sync_by_id(id)
-    InvoiceSyncJob.perform_later(id: id)
-  end
-
 end

app/models/qbo_base_model.rb

@@ -0,0 +1,103 @@
+#The MIT License (MIT)
+#
+#Copyright (c) 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 QboBaseModel < ActiveRecord::Base
+
+  include Redmine::I18n
+
+  self.abstract_class = true
+  validates_presence_of :id
+
+  # 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. 
+  # This method is used to access the entity's information in a way that minimizes unnecessary API calls to QBO, improving performance and reducing latency.
+  def details
+    @details ||= begin
+      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)
+    end
+  end
+
+   # 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
+    return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
+    format_time(maximum(:updated_at))
+  end
+
+  # 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)
+      details
+      @details.public_send(method_name, *args, &block)
+    else
+      super
+    end
+  end
+
+  # Repsonds to missing methods by delegating to the QBO customer details object 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
+  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)
+  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)
+  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
+  end
+
+   alias_method :save_without_push, :save
+   alias_method :save, :save_with_push
+
+  private
+  
+  def log(msg)
+    Rails.logger.info "[#{model_name.name}] #{msg}"
+  end
+
+  # 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()
+  end
+
+end