From 899c9878c44d26de2d0079e403bf74a999a0b18f Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Sun, 1 Mar 2026 19:27:23 -0500 Subject: [PATCH 01/22] Fix: only attach invoices if document is updated --- app/services/sync_service_base.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/services/sync_service_base.rb b/app/services/sync_service_base.rb index dec46e0..b3cfe7c 100644 --- a/app/services/sync_service_base.rb +++ b/app/services/sync_service_base.rb @@ -109,10 +109,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}" From 0deab9dbd363a850e86af9bba5b9cb20dbd027a8 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Sun, 1 Mar 2026 19:35:55 -0500 Subject: [PATCH 02/22] 2026.3.0 --- init.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/init.rb b/init.rb index f4fc613..4c3f1df 100644 --- a/init.rb +++ b/init.rb @@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do name 'Redmine QBO plugin' author 'Rick Barrette' description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed' - version '2026.2.16' + version '2026.3.0' url 'https://github.com/rickbarrette/redmine_qbo' author_url 'https://barrettefabrication.com' settings default: {empty: true}, partial: 'qbo/settings' From 03d5a5d14883f9e901229ee23bc2336d8ac1d0c5 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Sun, 1 Mar 2026 21:25:07 -0500 Subject: [PATCH 03/22] Always show sync status --- app/views/qbo/_last_sync.html.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/views/qbo/_last_sync.html.erb b/app/views/qbo/_last_sync.html.erb index dd2118e..4ac8399 100644 --- a/app/views/qbo/_last_sync.html.erb +++ b/app/views/qbo/_last_sync.html.erb @@ -1 +1 @@ -<%=t(:label_last_sync)%>: <%= Qbo.last_sync if Qbo.exists? %> +<%=t(:label_last_sync)%>: <%= Qbo.last_sync %> From 485a977d1a8c6155f72b932a5b54452f8a7f980a Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Sun, 1 Mar 2026 21:31:28 -0500 Subject: [PATCH 04/22] Use Safe Navigation Operator &. --- app/views/customers/_details.html.erb | 4 ++-- app/views/qbo/_settings.html.erb | 4 ++-- lib/redmine_qbo/hooks/users_show_hook_listener.rb | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) 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 @@ <%=t(:label_primary_phone)%> - <%= number_to_phone(customer.primary_phone.gsub(/[^\d]/, '').to_i, area_code: true) if customer.primary_phone %> + <%= number_to_phone(customer&.primary_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %> <%=t(:label_mobile_phone)%> - <%= number_to_phone(customer.mobile_phone.gsub(/[^\d]/, '').to_i, area_code: true) if customer.mobile_phone %> + <%= number_to_phone(customer&.mobile_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %> diff --git a/app/views/qbo/_settings.html.erb b/app/views/qbo/_settings.html.erb index f559e54..ad98c83 100644 --- a/app/views/qbo/_settings.html.erb +++ b/app/views/qbo/_settings.html.erb @@ -66,12 +66,12 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI <%=t(:label_oauth_expires)%> - <%= if Qbo.exists? then QboConnectionService.current!.oauth2_access_token_expires_at end %> + <%= QboConnectionService.current!&.oauth2_access_token_expires_at %> <%=t(:label_oauth2_refresh_token_expires_at)%> - <%= if Qbo.exists? then QboConnectionService.current!.oauth2_refresh_token_expires_at end %> + <%= QboConnectionService.current!&.oauth2_refresh_token_expires_at %> diff --git a/lib/redmine_qbo/hooks/users_show_hook_listener.rb b/lib/redmine_qbo/hooks/users_show_hook_listener.rb index 5c6e0a6..d62dc96 100644 --- a/lib/redmine_qbo/hooks/users_show_hook_listener.rb +++ b/lib/redmine_qbo/hooks/users_show_hook_listener.rb @@ -20,7 +20,7 @@ module RedmineQbo #Employee.update_all # Check to see if there is a quickbooks user attached to the issue - @selected = context[:user].employee.id if context[:user].employee + @selected = context[:user]&.employee&.id # Generate the drop down list of quickbooks contacts return "

#{context[:form].select :employee_id, Employee.all.pluck(:name, :id), selected: @selected, include_blank: true}

" From f02b50ae2676ee4078895464627654cf5e306911 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Mon, 2 Mar 2026 07:10:13 -0500 Subject: [PATCH 05/22] Added time stamps to each qbo entity model --- app/models/customer.rb | 11 +++++++++-- app/models/employee.rb | 8 ++++++++ app/models/estimate.rb | 8 ++++++++ app/models/invoice.rb | 9 +++++++++ app/views/qbo/_settings.html.erb | 8 ++++---- 5 files changed, 38 insertions(+), 6 deletions(-) diff --git a/app/models/customer.rb b/app/models/customer.rb index 6259cf7..b633783 100644 --- a/app/models/customer.rb +++ b/app/models/customer.rb @@ -11,8 +11,9 @@ 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 @@ -49,6 +50,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 + # Convenience Method # returns the customer's primary phone def primary_phone 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..745beb2 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] 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/views/qbo/_settings.html.erb b/app/views/qbo/_settings.html.erb index ad98c83..932d9f5 100644 --- a/app/views/qbo/_settings.html.erb +++ b/app/views/qbo/_settings.html.erb @@ -89,19 +89,19 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
- <%=t(:label_customer_count)%>: <%= Customer.count%> + <%=t(:label_customer_count)%>: <%= Customer.count%> @ <%= Customer.last_sync %>
- <%=t(:label_employee_count)%>: <%= Employee.count %> + <%=t(:label_employee_count)%>: <%= Employee.count %> @ <%= Employee.last_sync %>
- <%=t(:label_invoice_count)%>: <%= Invoice.count %> + <%=t(:label_invoice_count)%>: <%= Invoice.count %> @ <%= Invoice.last_sync%>
- <%=t(:label_estimate_count)%>: <%= Estimate.count %> + <%=t(:label_estimate_count)%>: <%= Estimate.count %> @ <%= Estimate.last_sync %>

From 899237c5ab671165c52be3d9a6fc1ff9bbf84ba2 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Mon, 2 Mar 2026 22:41:22 -0500 Subject: [PATCH 06/22] Reduced blanket rescues, added respond_to_missing?, and extracted push into CustomerPushService --- app/controllers/customers_controller.rb | 77 ++++----- app/models/customer.rb | 205 ++++++++++-------------- app/services/customer_push_service.rb | 43 +++++ 3 files changed, 163 insertions(+), 162 deletions(-) create mode 100644 app/services/customer_push_service.rb diff --git a/app/controllers/customers_controller.rb b/app/controllers/customers_controller.rb index 9e88b93..0197dd0 100644 --- a/app/controllers/customers_controller.rb +++ b/app/controllers/customers_controller.rb @@ -66,67 +66,60 @@ 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 + @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 => e + log "Failed to load customer ##{params[:id]}: #{e.message}" + 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 + flash[:error] = t :notice_customer_not_found + 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 b633783..2ddc74d 100644 --- a/app/models/customer.rb +++ b/app/models/customer.rb @@ -19,6 +19,7 @@ class Customer < ActiveRecord::Base has_many :estimates validates_presence_of :id, :name + before_validation :normalize_phone_numbers self.primary_key = :id @@ -31,22 +32,21 @@ 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 + + # 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 + @details ||= fetch_details + end + + # Returns the customer's email address def email - pull unless @details - begin - return @details.email_address.address - rescue - return nil - end + 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 @@ -56,109 +56,78 @@ class Customer < ActiveRecord::Base format_time(maximum(:updated_at)) 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 - 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 term.blank? search = sanitize_sql_like(search) where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%") end @@ -177,39 +146,27 @@ 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 - + qbo = QboConnectionService.current! + log "Starting push for customer ##{self.id}..." + CustomerPushService.new(qbo: qbo, customer: self).push() save_without_push end @@ -217,19 +174,27 @@ 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 + + # 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! + 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(id) end + rescue => e + log "Fetch failed for #{id}: #{e.message}" + Quickbooks::Model::Customer.new + end + + # Log messages with the entity type for better traceability + def log(msg) + Rails.logger.info "[Customer] #{msg}" end end diff --git a/app/services/customer_push_service.rb b/app/services/customer_push_service.rb new file mode 100644 index 0000000..5fc1fe1 --- /dev/null +++ b/app/services/customer_push_service.rb @@ -0,0 +1,43 @@ +#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 CustomerPushService + + # 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 + + # Log messages with the entity type for better traceability + def log(msg) + Rails.logger.info "[CustomerPushService] #{msg}" + 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 + +end \ No newline at end of file From f8b1c723942e12de1701c3ad604a4194dda650ba Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Mon, 2 Mar 2026 22:49:18 -0500 Subject: [PATCH 07/22] show all customer when search is blank --- app/models/customer.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/models/customer.rb b/app/models/customer.rb index 2ddc74d..0847d32 100644 --- a/app/models/customer.rb +++ b/app/models/customer.rb @@ -127,7 +127,7 @@ class Customer < ActiveRecord::Base # Seach for customers by name or phone number def self.search(search) - return none if term.blank? + #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 From 0df15693d22f0431ca6a878316b1294c9e625304 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Mon, 2 Mar 2026 22:49:53 -0500 Subject: [PATCH 08/22] removed unused begin --- db/migrate/032_add_txn_dates.rb | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/db/migrate/032_add_txn_dates.rb b/db/migrate/032_add_txn_dates.rb index c084a39..205f60a 100644 --- a/db/migrate/032_add_txn_dates.rb +++ b/db/migrate/032_add_txn_dates.rb @@ -11,9 +11,8 @@ class AddTxnDates < ActiveRecord::Migration[5.1] def change - begin - add_column :qbo_invoices, :txn_date, :date - add_column :qbo_estimates, :txn_date, :date + add_column :qbo_invoices, :txn_date, :date + add_column :qbo_estimates, :txn_date, :date end -end +end \ No newline at end of file From 28db5cb8c8052245ae15503a0c5421b381b1cefc Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Mon, 2 Mar 2026 22:50:43 -0500 Subject: [PATCH 09/22] removed unused code --- app/models/estimate.rb | 33 --------------------------------- 1 file changed, 33 deletions(-) diff --git a/app/models/estimate.rb b/app/models/estimate.rb index 745beb2..5b70839 100644 --- a/app/models/estimate.rb +++ b/app/models/estimate.rb @@ -43,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}" From 2e2b17fac38e2991406d5add346141503852739d Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Mon, 2 Mar 2026 22:54:26 -0500 Subject: [PATCH 10/22] log should be private --- app/services/customer_push_service.rb | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/app/services/customer_push_service.rb b/app/services/customer_push_service.rb index 5fc1fe1..1442caa 100644 --- a/app/services/customer_push_service.rb +++ b/app/services/customer_push_service.rb @@ -18,11 +18,6 @@ class CustomerPushService @customer = customer end - # Log messages with the entity type for better traceability - def log(msg) - Rails.logger.info "[CustomerPushService] #{msg}" - 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..." @@ -40,4 +35,11 @@ class CustomerPushService return @customer end + private + + # Log messages with the entity type for better traceability + def log(msg) + Rails.logger.info "[CustomerPushService] #{msg}" + end + end \ No newline at end of file From 23e565a304aa4a35c200d113c3960a3a3fec9895 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Mon, 2 Mar 2026 22:57:13 -0500 Subject: [PATCH 11/22] raise exceptions if not initialized properly --- app/services/sync_service_base.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/app/services/sync_service_base.rb b/app/services/sync_service_base.rb index b3cfe7c..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 From be400c2b2a12200316741b54d5dfb738e7af2f8d Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Tue, 3 Mar 2026 19:22:15 -0500 Subject: [PATCH 12/22] Added logging for errors when editing --- app/controllers/customers_controller.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/app/controllers/customers_controller.rb b/app/controllers/customers_controller.rb index 0197dd0..32abcb2 100644 --- a/app/controllers/customers_controller.rb +++ b/app/controllers/customers_controller.rb @@ -98,8 +98,9 @@ class CustomersController < ApplicationController def edit @customer = Customer.find_by_id(params[:id]) return render_404 unless @customer - rescue - flash[:error] = t :notice_customer_not_found + rescue => e + log "Failed to edit customer" + flash[:error] = e.message render_404 end From 4403267abb87b35c62924bcb61f6cdd4c898d4b7 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Tue, 3 Mar 2026 19:49:36 -0500 Subject: [PATCH 13/22] Moved QBO fetch from customer model into service --- app/models/customer.rb | 15 +++---------- ...er_push_service.rb => customer_service.rb} | 21 +++++++++++++++++-- 2 files changed, 22 insertions(+), 14 deletions(-) rename app/services/{customer_push_service.rb => customer_service.rb} (69%) diff --git a/app/models/customer.rb b/app/models/customer.rb index 0847d32..c2c849e 100644 --- a/app/models/customer.rb +++ b/app/models/customer.rb @@ -164,9 +164,9 @@ class Customer < ActiveRecord::Base # Push the updates def save_with_push - qbo = QboConnectionService.current! log "Starting push for customer ##{self.id}..." - CustomerPushService.new(qbo: qbo, customer: self).push() + qbo = QboConnectionService.current! + CustomerService.new(qbo: qbo, customer: self).push() save_without_push end @@ -180,16 +180,7 @@ class Customer < ActiveRecord::Base return Quickbooks::Model::Customer.new unless id.present? log "Fetching details for 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(id) - end - rescue => e - log "Fetch failed for #{id}: #{e.message}" - Quickbooks::Model::Customer.new + CustomerService.new(qbo: qbo, customer: self).pull() end # Log messages with the entity type for better traceability diff --git a/app/services/customer_push_service.rb b/app/services/customer_service.rb similarity index 69% rename from app/services/customer_push_service.rb rename to app/services/customer_service.rb index 1442caa..4d8e5c8 100644 --- a/app/services/customer_push_service.rb +++ b/app/services/customer_service.rb @@ -8,7 +8,7 @@ # #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 CustomerPushService +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) @@ -18,7 +18,24 @@ class CustomerPushService @customer = customer 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. + # 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..." From d44d5e2fb79e01eae509fa19a8f550843e4d8602 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Tue, 3 Mar 2026 19:54:50 -0500 Subject: [PATCH 14/22] Fixed log prefix --- app/services/customer_service.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/services/customer_service.rb b/app/services/customer_service.rb index 4d8e5c8..6b0f47a 100644 --- a/app/services/customer_service.rb +++ b/app/services/customer_service.rb @@ -56,7 +56,7 @@ class CustomerService # Log messages with the entity type for better traceability def log(msg) - Rails.logger.info "[CustomerPushService] #{msg}" + Rails.logger.info "[CustomerService] #{msg}" end end \ No newline at end of file From f041e1bce4f576216ca2ec89db5725e9220be905 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Tue, 3 Mar 2026 20:05:19 -0500 Subject: [PATCH 15/22] Added logging for completed pull --- app/services/customer_service.rb | 1 + 1 file changed, 1 insertion(+) diff --git a/app/services/customer_service.rb b/app/services/customer_service.rb index 6b0f47a..13cb0ca 100644 --- a/app/services/customer_service.rb +++ b/app/services/customer_service.rb @@ -30,6 +30,7 @@ class CustomerService ) service.fetch_by_id(@customer.id) end + log "Pull for customer ##{@customer.id} completed." rescue => e log "Fetch failed for #{@customer.id}: #{e.message}" Quickbooks::Model::Customer.new From 9f9810686f5b0c080d939480794b49785ac57523 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Tue, 3 Mar 2026 20:36:23 -0500 Subject: [PATCH 16/22] removed logging --- app/services/customer_service.rb | 1 - 1 file changed, 1 deletion(-) diff --git a/app/services/customer_service.rb b/app/services/customer_service.rb index 13cb0ca..6b0f47a 100644 --- a/app/services/customer_service.rb +++ b/app/services/customer_service.rb @@ -30,7 +30,6 @@ class CustomerService ) service.fetch_by_id(@customer.id) end - log "Pull for customer ##{@customer.id} completed." rescue => e log "Fetch failed for #{@customer.id}: #{e.message}" Quickbooks::Model::Customer.new From 2fc2f94cd176346ebd48295da101f02fbfa7a835 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Wed, 4 Mar 2026 13:23:59 -0500 Subject: [PATCH 17/22] Fixed combining of estimate pdf --- lib/redmine_qbo/patches/pdf_patch.rb | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 From aff7d0c48e927a4f91a532cbd8eecc7fa91200ec Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Wed, 4 Mar 2026 18:37:30 -0500 Subject: [PATCH 18/22] removed uneeded logging of issue and project contents. --- lib/redmine_qbo/hooks/issues_hook_listener.rb | 2 -- 1 file changed, 2 deletions(-) diff --git a/lib/redmine_qbo/hooks/issues_hook_listener.rb b/lib/redmine_qbo/hooks/issues_hook_listener.rb index 0b56dec..4e47847 100644 --- a/lib/redmine_qbo/hooks/issues_hook_listener.rb +++ b/lib/redmine_qbo/hooks/issues_hook_listener.rb @@ -21,8 +21,6 @@ module RedmineQbo f = context[:form] issue = context[:issue] project = context[:project] - log issue.inspect - log project.inspect # Customer Name Text Box with database backed autocomplete # onchange event will update the hidden customer_id field From 8ba99b7db233e5c3f5134c5c3b1980d450c16e59 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Wed, 4 Mar 2026 19:18:06 -0500 Subject: [PATCH 19/22] Fixed eager loading issues --- app/controllers/customers_controller.rb | 33 ++++++++++++++++++------- app/views/customers/show.html.erb | 4 +-- 2 files changed, 26 insertions(+), 11 deletions(-) diff --git a/app/controllers/customers_controller.rb b/app/controllers/customers_controller.rb index 32abcb2..e9db970 100644 --- a/app/controllers/customers_controller.rb +++ b/app/controllers/customers_controller.rb @@ -80,16 +80,31 @@ class CustomersController < ApplicationController def show @customer = Customer.find_by_id(params[:id]) return render_404 unless @customer - @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 } + + @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 - log "Failed to load customer ##{params[:id]}: #{e.message}" + Rails.logger.error "Failed to load customer ##{params[:id]}: #{e.message}\n#{e.backtrace.join("\n")}" flash[:error] = e.message render_404 end diff --git a/app/views/customers/show.html.erb b/app/views/customers/show.html.erb index cb7ca1e..33df5d0 100644 --- a/app/views/customers/show.html.erb +++ b/app/views/customers/show.html.erb @@ -46,8 +46,8 @@
-

<%=@issues.open.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%>

-<%= render partial: 'issues/list_simple', locals: {issues: @issues.open} %> +

<%=@open_issues.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%>

+<%= render partial: 'issues/list_simple', locals: {issues: @open_issues.open} %>

<%=@closed_issues.count%> <%=t(:label_closed_issues)%> - <%= @closed_hours.round(1)%> <%=t(:label_hours)%>

<%= render partial: 'issues/list_simple', locals: {issues: @closed_issues} %> From bccfcd9dbc3a33b04e7dab0efc8c2df9727d62f6 Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Wed, 4 Mar 2026 20:06:22 -0500 Subject: [PATCH 20/22] cache qbo details to reduce api calls --- app/models/customer.rb | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/app/models/customer.rb b/app/models/customer.rb index c2c849e..afe98ef 100644 --- a/app/models/customer.rb +++ b/app/models/customer.rb @@ -35,7 +35,20 @@ class Customer < ActiveRecord::Base # 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 - @details ||= fetch_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 + "customer:#{id}:qbo_details:#{updated_at.to_i}" end # Returns the customer's email address @@ -49,6 +62,7 @@ class Customer < ActiveRecord::Base details @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 @@ -167,6 +181,7 @@ class Customer < ActiveRecord::Base 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 From b96678a2e9c36c39a1570882649dc38a1609ba6f Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Wed, 4 Mar 2026 20:09:13 -0500 Subject: [PATCH 21/22] fixed accident deleteion details_cache_key --- app/models/customer.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/models/customer.rb b/app/models/customer.rb index afe98ef..7b56cfc 100644 --- a/app/models/customer.rb +++ b/app/models/customer.rb @@ -47,7 +47,7 @@ class Customer < ActiveRecord::Base end # Generates a unique cache key for storing this customer's QBO details. - def + def details_cache_key "customer:#{id}:qbo_details:#{updated_at.to_i}" end From 2520892e2cd444693c5584da26d312f0de7335fd Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Wed, 4 Mar 2026 20:14:16 -0500 Subject: [PATCH 22/22] 2026.3.1 --- init.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/init.rb b/init.rb index 4c3f1df..164cd9e 100644 --- a/init.rb +++ b/init.rb @@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do name 'Redmine QBO plugin' author 'Rick Barrette' description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed' - version '2026.3.0' + version '2026.3.1' url 'https://github.com/rickbarrette/redmine_qbo' author_url 'https://barrettefabrication.com' settings default: {empty: true}, partial: 'qbo/settings'