Merge branch 'master' into lineitems

app/models/customer.rb

@@ -11,13 +11,15 @@
 class Customer < ActiveRecord::Base
 
   include Redmine::Acts::Searchable
-  include Redmine::Acts::Event
-  
+  include Redmine::Acts::Event  
+  include Redmine::I18n
+
   has_many :issues
   has_many :invoices
   has_many :estimates
  
   validates_presence_of :id, :name
+  before_validation :normalize_phone_numbers
   
   self.primary_key = :id
 
@@ -30,128 +32,116 @@ class Customer < ActiveRecord::Base
                 :type => :to_s,
                 :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}
-  
-  # Convenience Method
-  # returns the customer's email
-  def email
-    pull unless @details
-    begin
-      return @details.email_address.address
-    rescue
-      return nil
+
+  # 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 Quickbooks::Model::Customer.new unless id.present?
+
+    @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
+    return @details&.email_address&.address
+  end
   
-  # Convenience Method
-  # Sets the email
+  # Updates the customer's email address
   def email=(s)
-    pull unless @details
+    details
     @details.email_address = s
   end
+  
 
-  # Convenience Method
-  # returns the customer's primary phone
-  def primary_phone
-    pull unless @details
-    begin
-      return @details.primary_phone.free_form_number
-    rescue
-      return nil
-    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
   
-  # Convenience Method
-  # Updates the customer's primary phone number
-  def primary_phone=(n)
-    pull unless @details
-    pn = Quickbooks::Model::TelephoneNumber.new
-    pn.free_form_number = n
-    @details.primary_phone = pn
-    #update our locally stored number too
-    update_phone_number
-  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
 
-  # Convenience Method
-  # returns the customer's mobile phone
-  def mobile_phone
-    pull unless @details
-    begin
-      return @details.mobile_phone.free_form_number
-    rescue
-      return nil
+  # 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
+    return @details&.mobile_phone&.free_form_number
+  end
   
-  # Convenience Method
   # Updates the custome's mobile phone number
   def mobile_phone=(n)
-    pull unless @details
+    details
     pn = Quickbooks::Model::TelephoneNumber.new
     pn.free_form_number = n
     @details.mobile_phone = pn
-    #update our locally stored number too
-    update_mobile_phone_number
   end
 
-  # Convenience Method
-  # Sets the notes
-  def notes=(s)
-    pull unless @details
-    @details.notes = s
-  end
-  
-  # update the localy stored phone number as a plain string with no special chars
-  def update_phone_number
-    begin
-      self.phone_number = self.primary_phone.tr('^0-9', '')
-    rescue
-      return nil
-    end
-  end
-  
-  # update the localy stored phone number as a plain string with no special chars
-  def update_mobile_phone_number
-    begin
-      self.mobile_phone_number = self.mobile_phone.tr('^0-9', '')
-    rescue
-      return nil
-    end
-  end
-  
-  # Convenience Method
   # Updates Both local DB name & QBO display_name
   def name=(s)
-    pull unless @details
+    details
     @details.display_name = s
     super
   end
+
+  # Normalizes phone numbers by removing non-digit characters. This method is called before validation to ensure that phone numbers are stored in a consistent format, which can help with searching and integration with external systems like QuickBooks Online.
+  def normalize_phone_numbers
+    self.phone_number = phone_number.to_s.gsub(/\D/, '') if phone_number.present?
+    self.mobile_phone_number = mobile_phone_number.to_s.gsub(/\D/, '') if mobile_phone_number.present?
+  end
+
+  # Sets the notes for the customer
+  def notes=(s)
+    details
+    @details.notes = s
+  end
+
+  # returns the customer's primary phone
+  def primary_phone
+    details
+    return @details&.primary_phone&.free_form_number
+  end
   
-  # Magic Method
-  # Maps Get/Set methods to QBO customer object
-  def method_missing(sym, *arguments)
-    # Check to see if the method exists
-    if Quickbooks::Model::Customer.method_defined?(sym)
-      # download details if required
-      pull unless @details
-      method_name = sym.to_s
-      # Setter
-      if method_name[-1, 1] == "="
-        @details.method(method_name).call(arguments[0])
-      # Getter
-      else
-        return @details.method(method_name).call 
-      end
-    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
+  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?
     search = sanitize_sql_like(search)
     where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%")
   end
@@ -170,39 +160,28 @@ class Customer < ActiveRecord::Base
     ids.index_with { |id| id }
   end
   
-  # proforms a bruteforce sync operation
+  # performs a sync operation for all customers
   def self.sync 
     CustomerSyncJob.perform_later(full_sync: false)
   end
 
-  # proforms a bruteforce sync operation
+  # 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
-    return "#{self[:name]} - #{phone_number.split(//).last(4).join unless phone_number.nil?}"
+    last4 = phone_number&.last(4)
+    last4.present? ? "#{name} - #{last4}" : name.to_s
   end
 
   # Push the updates
   def save_with_push
-    begin
-      qbo = Qbo.first
-      @details = qbo.perform_authenticated_request do |access_token|
-        service = Quickbooks::Service::Customer.new(
-          company_id: qbo.realm_id,
-          access_token: access_token
-        )
-        service.update(@details)
-      end
-
-      self.id = @details.id
-    rescue => e
-      errors.add(:base, e.message)
-      return false
-    end
-
+    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
 
@@ -210,19 +189,18 @@ class Customer < ActiveRecord::Base
   alias_method :save, :save_with_push
   
   private
-  
-  # pull the details
-  def pull
-    begin
-      raise Exception unless self.id
-      qbo = QboConnectionService.current!
-      @details = qbo.perform_authenticated_request do |access_token|
-        service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
-        service.fetch_by_id(self.id)
-      end
-    rescue Exception => e
-      @details = Quickbooks::Model::Customer.new
-    end
+
+  # 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

@@ -10,11 +10,19 @@
 
 class Employee < ActiveRecord::Base
   
+  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)

app/models/estimate.rb

@@ -10,11 +10,19 @@
 
 class Estimate < ActiveRecord::Base
   
+  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]
@@ -35,40 +43,7 @@ class Estimate < ActiveRecord::Base
     EstimateSyncJob.perform_later(doc_number: number)
   end
 
-  # Magic Method
-  # Maps Get/Set methods to QBO estimate object
-  def method_missing(sym, *arguments)
-    # Check to see if the method exists
-    if Quickbooks::Model::Estimate.method_defined?(sym)
-      # download details if required
-      pull unless @details
-      method_name = sym.to_s
-      # Setter
-      if method_name[-1, 1] == "="
-        @details.method(method_name).call(arguments[0])
-      # Getter
-      else
-        return @details.method(method_name).call 
-      end
-    end
-  end
-
   private
-  
-  # pull the details
-  def pull
-    log "Pulling details for estimate ##{self.id}..."
-    begin
-      raise Exception unless self.id
-      qbo = QboConnectionService.current!
-      @details = qbo.perform_authenticated_request do |access_token|
-        service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
-        service(:estimate).fetch_by_id(self.id)
-      end
-    rescue Exception => e
-      @details = Quickbooks::Model::Estimate.new
-    end
-  end
 
   def log(msg)
     Rails.logger.info "[Estimate] #{msg}"

app/models/invoice.rb

@@ -9,6 +9,9 @@
 #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
+
+  include Redmine::I18n
+
   has_and_belongs_to_many :issues
   belongs_to :customer
 
@@ -17,6 +20,12 @@ class Invoice < ActiveRecord::Base
 
   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