redmine_qbo/app/models/qbo_base_model.rb

#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
  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. 
  # 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
      qbo_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)
    if qbo_model_class.method_defined?(method_name)
      details
      @details.public_send(method_name, *args, &block)
    else
      super
    end
  end

  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)
    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
    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)
    QboSyncJob.perform_later(entity: model_name.name, id: id)
  end

  # 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

  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

  # Fetches the entity's details from QuickBooks Online. 
  def fetch_details
    log "Fetching details for #{model_name.name} ##{id} from QBO..."
    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