From d4a0aa1db56e2d086e8aa9bff49d62165a5b143b Mon Sep 17 00:00:00 2001 From: Rick Barrette Date: Sat, 28 Feb 2026 19:47:45 -0500 Subject: [PATCH] Refactor: Introduce SyncServiceBase for shared functionality across sync services --- app/services/customer_sync_service.rb | 89 +++--------------- app/services/employee_sync_service.rb | 85 +++--------------- app/services/estimate_sync_service.rb | 89 ++---------------- app/services/invoice_sync_service.rb | 82 +++-------------- app/services/sync_service_base.rb | 125 ++++++++++++++++++++++++++ 5 files changed, 167 insertions(+), 303 deletions(-) create mode 100644 app/services/sync_service_base.rb diff --git a/app/services/customer_sync_service.rb b/app/services/customer_sync_service.rb index 78afc43..54c1dfb 100644 --- a/app/services/customer_sync_service.rb +++ b/app/services/customer_sync_service.rb @@ -8,88 +8,25 @@ # #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 CustomerSyncService - PAGE_SIZE = 1000 - - def initialize(qbo:) - @qbo = qbo - end - - # Sync all customers, or only those updated since the last sync - def sync(full_sync: false) - log "Starting #{full_sync ? 'full' : 'incremental'} customer sync" - - @qbo.perform_authenticated_request do |access_token| - service = Quickbooks::Service::Customer.new(company_id: @qbo.realm_id, access_token: access_token) - - page = 1 - loop do - collection = fetch_page(service, page, full_sync) - entries = Array(collection&.entries) - break if entries.empty? - - entries.each { |remote| persist(remote) } - - break if entries.size < PAGE_SIZE - page += 1 - end - end - - log "Customer sync complete" - end - - # Sync a single customer by its QBO ID, used for webhook updates - def sync_by_id(id) - @qbo.perform_authenticated_request do |access_token| - service = Quickbooks::Service::Customer.new(company_id: @qbo.realm_id, access_token: access_token) - remote = service.fetch_by_id(id) - persist(remote) - end - end +class CustomerSyncService < SyncServiceBase private - # Fetch a page of customers, either all or only those updated since the last sync - def fetch_page(service, page, full_sync) - start_position = (page - 1) * PAGE_SIZE + 1 - - if full_sync - service.query("SELECT * FROM Customer STARTPOSITION #{start_position} MAXRESULTS #{PAGE_SIZE}") - else - last_update = Customer.maximum(:updated_at) || 1.year.ago - service.query(<<~SQL.squish) - SELECT * FROM Customer - WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}' - STARTPOSITION #{start_position} - MAXRESULTS #{PAGE_SIZE} - SQL - end + # Specify the local model this service syncs + def self.model_class + Customer end - # Create or update a local Customer record based on the QBO remote data - def persist(remote) - local = Customer.find_or_initialize_by(id: remote.id) - - if remote.active? - local.name = remote.display_name - local.phone_number = remote.primary_phone&.free_form_number&.gsub(/\D/, '') - local.mobile_phone_number = remote.mobile_phone&.free_form_number&.gsub(/\D/, '') - - if local.changed? - local.save - log "Updated customer #{remote.id}" - end - else - if local.persisted? - local.destroy - log "Deleted customer #{remote.id}" - end - end - rescue => e - log "Failed to sync customer #{remote.id}: #{e.message}" + # Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO) + def destroy_remote?(remote) + !remote.active? end - def log(msg) - Rails.logger.info "[CustomerSyncService] #{msg}" + # Map relevant attributes from the QBO Customer to the local Customer model + def process_attributes(local, remote) + local.name = remote.display_name + local.phone_number = remote.primary_phone&.free_form_number&.gsub(/\D/, '') + local.mobile_phone_number = remote.mobile_phone&.free_form_number&.gsub(/\D/, '') end + end \ No newline at end of file diff --git a/app/services/employee_sync_service.rb b/app/services/employee_sync_service.rb index 07fbb80..e8b99fa 100644 --- a/app/services/employee_sync_service.rb +++ b/app/services/employee_sync_service.rb @@ -8,86 +8,23 @@ # #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 EmployeeSyncService - PAGE_SIZE = 1000 - - def initialize(qbo:) - @qbo = qbo - end - - # Sync all employees, or only those updated since the last sync - def sync(full_sync: false) - log "Starting #{full_sync ? 'full' : 'incremental'} employee sync" - - @qbo.perform_authenticated_request do |access_token| - service = Quickbooks::Service::Employee.new(company_id: @qbo.realm_id, access_token: access_token) - - page = 1 - loop do - collection = fetch_page(service, page, full_sync) - entries = Array(collection&.entries) - break if entries.empty? - - entries.each { |remote| persist(remote) } - - break if entries.size < PAGE_SIZE - page += 1 - end - end - - log "Employee sync complete" - end - - # Sync a single employee by its QBO ID, used for webhook updates - def sync_by_id(id) - @qbo.perform_authenticated_request do |access_token| - service = Quickbooks::Service::Employee.new(company_id: @qbo.realm_id, access_token: access_token) - remote = service.fetch_by_id(id) - persist(remote) - end - end +class EmployeeSyncService < SyncServiceBase private - # Fetch a page of employees, either all or only those updated since the last sync - def fetch_page(service, page, full_sync) - start_position = (page - 1) * PAGE_SIZE + 1 - - if full_sync - service.query("SELECT * FROM Employee STARTPOSITION #{start_position} MAXRESULTS #{PAGE_SIZE}") - else - last_update = Employee.maximum(:updated_at) || 1.year.ago - service.query(<<~SQL.squish) - SELECT * FROM Employee - WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}' - STARTPOSITION #{start_position} - MAXRESULTS #{PAGE_SIZE} - SQL - end + # Specify the local model this service syncs + def self.model_class + Employee end - # Create or update a local Employee record based on the QBO remote data - def persist(remote) - local = Employee.find_or_initialize_by(id: remote.id) - - if remote.active? - local.name = remote.display_name - - if local.changed? - local.save - log "Updated employee #{remote.id}" - end - else - if local.persisted? - local.destroy - log "Deleted employee #{remote.id}" - end - end - rescue => e - log "Failed to sync employee #{remote.id}: #{e.message}" + # Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO) + def destroy_remote?(remote) + !remote.active? end - def log(msg) - Rails.logger.info "[EmployeeSyncService] #{msg}" + # Map relevant attributes from the QBO Employee to the local Employee model + def process_attributes(local, remote) + local.name = remote.display_name end + end \ No newline at end of file diff --git a/app/services/estimate_sync_service.rb b/app/services/estimate_sync_service.rb index bb8b96b..269a88a 100644 --- a/app/services/estimate_sync_service.rb +++ b/app/services/estimate_sync_service.rb @@ -8,95 +8,20 @@ # #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 EstimateSyncService - PAGE_SIZE = 1000 - - def initialize(qbo:) - @qbo = qbo - end - - # Sync all estimates, or only those updated since the last sync - def sync(full_sync: false) - log "Starting #{full_sync ? 'full' : 'incremental'} estimate sync" - - @qbo.perform_authenticated_request do |access_token| - service = Quickbooks::Service::Estimate.new(company_id: @qbo.realm_id, access_token: access_token) - - page = 1 - loop do - collection = fetch_page(service, page, full_sync) - entries = Array(collection&.entries) - break if entries.empty? - - entries.each { |remote| persist(remote) } - - break if entries.size < PAGE_SIZE - page += 1 - end - end - - log "Estimate sync complete" - end - - # Sync a single estimate by its QBO ID, used for webhook updates - def sync_by_doc(doc_number) - log "Syncing estimate by doc_number: #{doc_number}" - @qbo.perform_authenticated_request do |access_token| - service = Quickbooks::Service::Estimate.new(company_id: @qbo.realm_id, access_token: access_token) - remote = service.find_by( :doc_number, doc_number).first - log "Found estimate with ID #{remote.id} for doc_number #{doc_number}" if remote - persist(remote) - end - end - - # Sync a single estimate by its QBO ID, used for webhook updates - def sync_by_id(id) - log "Syncing estimate by ID: #{id}" - @qbo.perform_authenticated_request do |access_token| - service = Quickbooks::Service::Estimate.new(company_id: @qbo.realm_id, access_token: access_token) - remote = service.fetch_by_id(id) - persist(remote) - end - end - +class EstimateSyncService < SyncServiceBase + private - # Fetch a page of estimates, either all or only those updated since the last sync - def fetch_page(service, page, full_sync) - log "Fetching page #{page} of estimates (full_sync: #{full_sync})" - start_position = (page - 1) * PAGE_SIZE + 1 - - if full_sync - service.query("SELECT * FROM Estimate STARTPOSITION #{start_position} MAXRESULTS #{PAGE_SIZE}") - else - last_update = Estimate.maximum(:updated_at) || 1.year.ago - service.query(<<~SQL.squish) - SELECT * FROM Estimate - WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}' - STARTPOSITION #{start_position} - MAXRESULTS #{PAGE_SIZE} - SQL - end + # Specify the local model this service syncs + def self.model_class + Estimate end - # Create or update a local Estimate record based on the QBO remote data - def persist(remote) - log "Persisting estimate #{remote.id}" - local = Estimate.find_or_initialize_by(id: remote.id) - + # Map relevant attributes from the QBO Estimate to the local Estimate model + def process_attributes(local, remote) local.doc_number = remote.doc_number local.txn_date = remote.txn_date local.customer = Customer.find_by(id: remote.customer_ref&.value) - - if local.changed? - local.save - log "Updated estimate #{remote.id}" - end - rescue => e - log "Failed to sync estimate #{remote.id}: #{e.message}" end - def log(msg) - Rails.logger.info "[EstimateSyncService] #{msg}" - end end \ No newline at end of file diff --git a/app/services/invoice_sync_service.rb b/app/services/invoice_sync_service.rb index 5e460ba..5f1157d 100644 --- a/app/services/invoice_sync_service.rb +++ b/app/services/invoice_sync_service.rb @@ -8,88 +8,28 @@ # #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 InvoiceSyncService - PAGE_SIZE = 1000 - - def initialize(qbo:) - @qbo = qbo - end - - # Sync all invoices, or only those updated since the last sync - def sync(full_sync: false) - log "Starting #{full_sync ? 'full' : 'incremental'} invoice sync" - - @qbo.perform_authenticated_request do |access_token| - service = Quickbooks::Service::Invoice.new(company_id: @qbo.realm_id, access_token: access_token) - - page = 1 - loop do - collection = fetch_page(service, page, full_sync) - entries = Array(collection&.entries) - break if entries.empty? - - entries.each { |remote| persist(remote) } - - break if entries.size < PAGE_SIZE - page += 1 - end - end - - log "Invoice sync complete" - end - - # Sync a single invoice by its QBO ID, used for webhook updates - def sync_by_id(id) - @qbo.perform_authenticated_request do |access_token| - service = Quickbooks::Service::Invoice.new(company_id: @qbo.realm_id, access_token: access_token) - remote = service.fetch_by_id(id) - persist(remote) - end - end - +class InvoiceSyncService < SyncServiceBase + private - # Fetch a page of invoices, either all or only those updated since the last sync - def fetch_page(service, page, full_sync) - start_position = (page - 1) * PAGE_SIZE + 1 - - if full_sync - service.query("SELECT * FROM Invoice STARTPOSITION #{start_position} MAXRESULTS #{PAGE_SIZE}") - else - last_update = Invoice.maximum(:qbo_updated_at) || 1.year.ago - service.query(<<~SQL.squish) - SELECT * FROM Invoice - WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}' - STARTPOSITION #{start_position} - MAXRESULTS #{PAGE_SIZE} - SQL - end + # Specify the local model this service syncs + def self.model_class + Invoice end - - # Create or update a local Invoice record based on the QBO remote data - def persist(remote) - local = Invoice.find_or_initialize_by(id: remote.id) - + + # Map relevant attributes from the QBO Invoice to the local Invoice model + def process_attributes(local, remote) local.doc_number = remote.doc_number local.txn_date = remote.txn_date local.due_date = remote.due_date local.total_amount = remote.total local.balance = remote.balance local.qbo_updated_at = remote.meta_data&.last_updated_time - local.customer = Customer.find_by(id: remote.customer_ref&.value) - - if local.changed? - local.save - log "Updated invoice #{remote.doc_number} (#{remote.id})" - end - - InvoiceAttachmentService.new(local, remote).attach - rescue => e - log "Failed to sync invoice #{remote.doc_number} (#{remote.id}): #{e.message}" end - def log(msg) - Rails.logger.info "[InvoiceSyncService] #{msg}" + # Attach QBO Invoices to the local Issues + def attach_documents(local, remote) + InvoiceAttachmentService.new(local, remote).attach end end \ No newline at end of file diff --git a/app/services/sync_service_base.rb b/app/services/sync_service_base.rb new file mode 100644 index 0000000..fff8b4d --- /dev/null +++ b/app/services/sync_service_base.rb @@ -0,0 +1,125 @@ +#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 SyncServiceBase + PAGE_SIZE = 1000 + + # Subclasses should initialize with a QBO client instance + def initialize(qbo:) + @qbo = qbo + @entity = self.class.model_class + end + + # Subclasses must implement this to specify which local model they sync (e.g. Customer, Invoice) + def self.model_class + raise NotImplementedError + end + + # Sync all entities, or only those updated since the last sync + def sync(full_sync: false) + log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync" + + @qbo.perform_authenticated_request do |access_token| + service_class = "Quickbooks::Service::#{@entity.name}".constantize + service = service_class.new(company_id: @qbo.realm_id, access_token: access_token) + + page = 1 + loop do + collection = fetch_page(service, page, full_sync) + entries = Array(collection&.entries) + break if entries.empty? + + entries.each { |remote| persist(remote) } + + break if entries.size < PAGE_SIZE + page += 1 + log "Fetched page #{page} of #{@entity.name} from QBO" + end + end + + log "#{@entity.name} sync complete" + end + + # Sync a single entity by its QBO ID, used for webhook updates + def sync_by_id(id) + log "Syncing #{@entity.name} with ID #{id}" + @qbo.perform_authenticated_request do |access_token| + service_class = "Quickbooks::Service::#{@entity.name}".constantize + service = service_class.new(company_id: @qbo.realm_id, access_token: access_token) + remote = service.fetch_by_id(id) + persist(remote) + end + end + + private + + def attach_documents(local, remote) + # Override in subclasses if the entity has attachments (e.g. Invoice) + end + + # Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO) + def destroy_remote?(remote) + false + end + + # Log messages with the entity type for better traceability + def log(msg) + Rails.logger.info "[#{@entity.name}SyncService] #{msg}" + end + + # Fetch a page of entities, either all or only those updated since the last sync + def fetch_page(service, page, full_sync) + log "Fetching page #{page} of #{@entity.name} from QBO (#{full_sync ? 'full' : 'incremental'} sync)" + start_position = (page - 1) * PAGE_SIZE + 1 + + if full_sync + service.query("SELECT * FROM #{@entity.name} STARTPOSITION #{start_position} MAXRESULTS #{PAGE_SIZE}") + else + last_update = @entity.maximum(:updated_at) || 1.year.ago + service.query(<<~SQL.squish) + SELECT * FROM #{@entity.name} + WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}' + STARTPOSITION #{start_position} + MAXRESULTS #{PAGE_SIZE} + SQL + end + end + + # Create or update a local entity record based on the QBO remote data + def persist(remote) + local = @entity.find_or_initialize_by(id: remote.id) + + if destroy_remote?(remote) + if local.persisted? + local.destroy + log "Deleted #{@entity.name} #{remote.id}" + end + return + end + + process_attributes(local, remote) + + if local.changed? + local.save! + log "Updated #{@entity.name} #{remote.id}" + end + + attach_documents(local, remote) + + rescue => e + log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}" + end + + # This method should be implemented in subclasses to map remote attributes to local model + def process_attributes(local, remote) + raise NotImplementedError, "Subclasses must implement process_attributes" + end + +end \ No newline at end of file