diff --git a/app/controllers/customers_controller.rb b/app/controllers/customers_controller.rb index 9e88b93..e9db970 100644 --- a/app/controllers/customers_controller.rb +++ b/app/controllers/customers_controller.rb @@ -66,67 +66,76 @@ class CustomersController < ApplicationController # create a new customer def create @customer = Customer.new(allowed_params) - if @customer.save - flash[:notice] = t :notice_customer_created - redirect_to @customer - else - flash[:error] = @customer.errors.full_messages.to_sentence - redirect_to new_customer_path - end + @customer.save + log "Customer ##{@customer.id} created successfully." + flash[:notice] = t :notice_customer_created + redirect_to @customer + rescue => e + log "Failed to create customer: #{e.message}" + flash[:error] = e.message + redirect_to new_customer_path end # display a specific customer def show - begin - @customer = Customer.find_by_id(params[:id]) - @issues = @customer.issues.order(id: :desc) - @billing_address = address_to_s(@customer.billing_address) - @shipping_address = address_to_s(@customer.shipping_address) - @closed_issues = (@issues - @issues.open) - @hours = 0 - @closed_hours = 0 - @issues.open.each { |i| @hours+= i.total_spent_hours } - @closed_issues.each { |i| @closed_hours+= i.total_spent_hours } - rescue - flash[:error] = t :notice_customer_not_found - render_404 - end + @customer = Customer.find_by_id(params[:id]) + return render_404 unless @customer + + @open_issues = @customer.issues + .joins(:status) + .includes(:status, :project, :tracker, :priority) + .where(issue_statuses: { is_closed: false }) + .order(id: :desc) + + @closed_issues = @customer.issues + .joins(:status) + .includes(:status, :project, :tracker, :priority) + .where(issue_statuses: { is_closed: true }) + .order(id: :desc) + + @hours = TimeEntry + .joins(:issue) + .where(issues: { id: @open_issues.select(:id) }) + .sum(:hours) + + @closed_hours = TimeEntry + .joins(:issue) + .where(issues: { id: @closed_issues.select(:id) }) + .sum(:hours) + + rescue => e + Rails.logger.error "Failed to load customer ##{params[:id]}: #{e.message}\n#{e.backtrace.join("\n")}" + flash[:error] = e.message + render_404 end # return an HTML form for editing a customer def edit - begin - @customer = Customer.find_by_id(params[:id]) - rescue - flash[:error] = t :notice_customer_not_found - render_404 - end + @customer = Customer.find_by_id(params[:id]) + return render_404 unless @customer + rescue => e + log "Failed to edit customer" + flash[:error] = e.message + render_404 end # update a specific customer def update - begin - @customer = Customer.find_by_id(params[:id]) - if @customer.update(allowed_params) - flash[:notice] = t :notice_customer_updated - redirect_to @customer - else - redirect_to edit_customer_path - flash[:error] = @customer.errors.full_messages.to_sentence if @customer.errors - end - rescue - flash[:error] = t :notice_customer_not_found - render_404 - end + @customer = Customer.find_by_id(params[:id]) + @customer.update(allowed_params) + flash[:notice] = t :notice_customer_updated + redirect_to @customer + rescue => e + log "Failed to update customer: #{e.message}" + flash[:error] = e.message + redirect_to edit_customer_path end # creates new customer view tokens, removes expired tokens & redirects to newly created customer view with new token. def share issue = Issue.find(params[:id]) - token = issue.share_token redirect_to view_path(token.token) - rescue ActiveRecord::RecordNotFound flash[:error] = t(:notice_issue_not_found) render_404 diff --git a/app/models/customer.rb b/app/models/customer.rb index 6259cf7..7b56cfc 100644 --- a/app/models/customer.rb +++ b/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 diff --git a/app/models/employee.rb b/app/models/employee.rb index 9c5358b..92c837b 100644 --- a/app/models/employee.rb +++ b/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) diff --git a/app/models/estimate.rb b/app/models/estimate.rb index 1abb31c..5b70839 100644 --- a/app/models/estimate.rb +++ b/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}" diff --git a/app/models/invoice.rb b/app/models/invoice.rb index 3eeb638..c1e9eea 100644 --- a/app/models/invoice.rb +++ b/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 diff --git a/app/services/customer_service.rb b/app/services/customer_service.rb new file mode 100644 index 0000000..6b0f47a --- /dev/null +++ b/app/services/customer_service.rb @@ -0,0 +1,62 @@ +#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 CustomerService + + # Initializes the service with a QBO client and an optional customer record. The QBO client is used to communicate with QuickBooks Online, while the customer record contains the data that needs to be pushed to QBO. If no customer is provided, the service will not perform any operations. + def initialize(qbo:, customer: nil) + raise "No QBO configuration found" unless qbo + raise "Customer record is required for push operation" unless customer + @qbo = qbo + @customer = customer + end + + # Pulls the customer data from QuickBooks Online. + def pull + return Quickbooks::Model::Customer.new unless @customer.present? + log "Fetching details for customer ##{@customer.id} from QBO..." + qbo = QboConnectionService.current! + 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(@customer.id) + end + rescue => e + log "Fetch failed for #{@customer.id}: #{e.message}" + Quickbooks::Model::Customer.new + end + + # Pushes the customer data to QuickBooks Online. This method handles the communication with QBO, including authentication and error handling. It uses the QBO client to send the customer data and logs the process for monitoring and debugging purposes. If the push is successful, it returns the customer record; otherwise, it logs the error and returns false. + def push + log "Pushing customer ##{@customer.id} to QBO..." + + customer = @qbo.perform_authenticated_request do |access_token| + service = Quickbooks::Service::Customer.new( + company_id: @qbo.realm_id, + access_token: access_token + ) + service.update(@customer.details) + end + + @customer.id = customer.id unless @customer.persisted? + log "Push for customer ##{@customer.id} completed." + return @customer + end + + private + + # Log messages with the entity type for better traceability + def log(msg) + Rails.logger.info "[CustomerService] #{msg}" + end + +end \ No newline at end of file diff --git a/app/services/sync_service_base.rb b/app/services/sync_service_base.rb index dec46e0..85251b9 100644 --- a/app/services/sync_service_base.rb +++ b/app/services/sync_service_base.rb @@ -13,6 +13,7 @@ class SyncServiceBase # Subclasses should initialize with a QBO client instance def initialize(qbo:) + raise "No QBO configuration found" unless qbo @qbo = qbo @entity = self.class.model_class end @@ -109,10 +110,10 @@ class SyncServiceBase if local.changed? local.save! log "Updated #{@entity.name} #{remote.id}" - end - # Handle attaching documents if applicable to invoices - attach_documents(local, remote) + # Handle attaching documents if applicable to invoices + attach_documents(local, remote) + end rescue => e log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}" diff --git a/app/views/customers/_details.html.erb b/app/views/customers/_details.html.erb index 33b6b05..940f7f3 100644 --- a/app/views/customers/_details.html.erb +++ b/app/views/customers/_details.html.erb @@ -13,12 +13,12 @@
#{context[:form].select :employee_id, Employee.all.pluck(:name, :id), selected: @selected, include_blank: true}
" diff --git a/lib/redmine_qbo/patches/pdf_patch.rb b/lib/redmine_qbo/patches/pdf_patch.rb index f45d998..8566e93 100644 --- a/lib/redmine_qbo/patches/pdf_patch.rb +++ b/lib/redmine_qbo/patches/pdf_patch.rb @@ -260,8 +260,9 @@ 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]) pdf = CombinePDF.parse(pdf.output, allow_optional_content: true) - pdf << CombinePDF.parse(issue.estimate.pdf) + pdf << CombinePDF.parse(e_pdf) return pdf.to_pdf end