Compare commits

..

21 Commits

Author SHA1 Message Date
df079b767c 2026.3.11 2026-03-17 23:37:17 -04:00
7d3908ec41 fixed estimate#sync 2026-03-17 23:31:42 -04:00
f60e507029 Updated settings page 2026-03-17 21:23:29 -04:00
3e6650ee65 Merge branch 'master' of https://github.com/rickbarrette/redmine_qbo 2026-03-16 08:20:07 -04:00
c2d0e5c702 Improved qbo hooks to allow a single entity or an array of entities 2026-03-16 08:18:11 -04:00
a4f461fd4d 2026.3.10 2026-03-15 18:01:54 -04:00
3e81d2840a fixed typo 2026-03-15 17:59:53 -04:00
c9a5dc20f9 Added manual sync links 2026-03-15 08:01:04 -04:00
db3c6021c5 2026.3.9 2026-03-14 21:54:12 -04:00
b8327be5d6 Updated to handle no qbo exception 2026-03-14 21:45:15 -04:00
c4e1ece82c Merge branch 'master' into dev 2026-03-14 17:30:53 -04:00
9fd7140e4a 2026.3.8 2026-03-14 17:30:22 -04:00
a6c8923ea9 Fixed uncaught exception when there is no QBO connection 2026-03-14 17:27:01 -04:00
eb1174cf7c Updated manual sync to to allow full or partial sync 2026-03-14 15:36:39 -04:00
7993f15441 updated comments 2026-03-14 15:30:50 -04:00
bb57af71ae Simplified detail calls 2026-03-14 08:20:18 -04:00
1a10360884 refactored PdfService to use QboConnectionService 2026-03-14 00:16:11 -04:00
cd109f16b5 Refactored QBO service calls 2026-03-14 00:10:10 -04:00
164252cb97 Refactored PDF services 2026-03-13 23:40:52 -04:00
fd18205c10 Refactored all Sync Jobs into QboSyncJob 2026-03-13 23:26:02 -04:00
6fc8a18e93 Updated attribute mapping 2026-03-13 15:43:24 -04:00
30 changed files with 317 additions and 479 deletions

View File

@@ -32,38 +32,36 @@ class CustomersController < ApplicationController
autocomplete :customer, :name, full: true, extra_data: [:id] autocomplete :customer, :name, full: true, extra_data: [:id]
def address_to_s(address)
return if address.nil?
lines = [
address.line1,
address.line2,
address.line3,
address.line4,
address.line5
].compact_blank
city_line = [
address.city,
address.country_sub_division_code,
address.postal_code
].compact_blank.join(" ")
lines << city_line unless city_line.blank?
lines.join("\n")
end
def add_customer
global_check_permission(:add_customers)
end
def allowed_params def allowed_params
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes) params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
end end
# getter method for a customer's invoices
# used for customer autocomplete field / issue form
def filter_invoices_by_customer
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
end
# getter method for a customer's estimates
# used for customer autocomplete field / issue form
def filter_estimates_by_customer
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
end
# display a list of all customers
def index
if params[:search]
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page])
if only_one_non_zero?(@customers)
redirect_to @customers.first
end
end
end
# initialize a new customer
def new
@customer = Customer.new
end
# create a new customer
def create def create
@customer = Customer.new(allowed_params) @customer = Customer.new(allowed_params)
@customer.save @customer.save
@@ -76,7 +74,79 @@ class CustomersController < ApplicationController
redirect_to new_customer_path redirect_to new_customer_path
end end
# display a specific customer def edit
@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
def filter_estimates_by_customer
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
end
def filter_invoices_by_customer
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
end
def index
if params[:search]
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page])
if only_one_non_zero?(@customers)
redirect_to @customers.first
end
end
end
def load_issue_data
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
@journals.each_with_index { |j, i| j.indice = i + 1 }
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
Journal.preload_journals_details_custom_fields(@journals)
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
@journals.reverse! if User.current.wants_comments_in_reverse_order?
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
@priorities = IssuePriority.active
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
@relation = IssueRelation.new
end
def log(msg)
Rails.logger.info "[CustomersController] #{msg}"
end
def new
@customer = Customer.new
end
def only_one_non_zero?(array)
found_non_zero = false
array.each do |val|
if val != 0
return false if found_non_zero
found_non_zero = true
end
end
found_non_zero
end
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
end
def show def show
@customer = Customer.find_by_id(params[:id]) @customer = Customer.find_by_id(params[:id])
return render_404 unless @customer return render_404 unless @customer
@@ -109,17 +179,11 @@ class CustomersController < ApplicationController
render_404 render_404
end end
# return an HTML form for editing a customer def sync
def edit Customer.sync
@customer = Customer.find_by_id(params[:id]) redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
return render_404 unless @customer
rescue => e
log "Failed to edit customer"
flash[:error] = e.message
render_404
end end
# update a specific customer
def update def update
@customer = Customer.find_by_id(params[:id]) @customer = Customer.find_by_id(params[:id])
@customer.update(allowed_params) @customer.update(allowed_params)
@@ -131,108 +195,21 @@ class CustomersController < ApplicationController
redirect_to edit_customer_path redirect_to edit_customer_path
end 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
end
# displays an issue for a customer with a provided security CustomerToken
def view def view
User.current = User.anonymous User.current = User.anonymous
# Load only active, non-expired token
@token = CustomerToken.active.find_by(token: params[:token]) @token = CustomerToken.active.find_by(token: params[:token])
return render_403 unless @token return render_403 unless @token
# Load associated issue
@issue = @token.issue @issue = @token.issue
return render_403 unless @issue return render_403 unless @issue
# Optional: enforce token belongs to the issue's customer
return render_403 unless @issue.customer_id == @token.issue.customer_id return render_403 unless @issue.customer_id == @token.issue.customer_id
# Store token in session for subsequent requests if needed
session[:token] = @token.token session[:token] = @token.token
load_issue_data load_issue_data
rescue ActiveRecord::RecordNotFound rescue ActiveRecord::RecordNotFound
render_403 render_403
end end
private
def load_issue_data
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
@journals.each_with_index { |j, i| j.indice = i + 1 }
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
Journal.preload_journals_details_custom_fields(@journals)
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
@journals.reverse! if User.current.wants_comments_in_reverse_order?
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
@priorities = IssuePriority.active
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
@relation = IssueRelation.new
end
# redmine permission - add customers
def add_customer
global_check_permission(:add_customers)
end
# redmine permission - view customers
def view_customer def view_customer
global_check_permission(:view_customers) global_check_permission(:view_customers)
end end
# checks to see if there is only one item in an array end
# @return true if array only has one item
def only_one_non_zero?( array )
found_non_zero = false
array.each do |val|
if val!=0
return false if found_non_zero
found_non_zero = true
end
end
found_non_zero
end
# format a quickbooks address to a human readable string
def address_to_s(address)
return if address.nil?
lines = [
address.line1,
address.line2,
address.line3,
address.line4,
address.line5
].compact_blank
city_line = [
address.city,
address.country_sub_division_code,
address.postal_code
].compact_blank.join(" ")
lines << city_line unless city_line.blank?
lines.join("\n")
end
def log(msg)
Rails.logger.info "[CustomersController] #{msg}"
end
end

View File

@@ -7,10 +7,20 @@
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. #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. #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 InvoicePdfService < PdfServiceBase class EmployeeController < ApplicationController
include AuthHelper
def self.model_class before_action :require_user, unless: -> { session[:token].nil? }
Invoice
def sync
Employee.sync
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end end
private
# Logs messages with a consistent prefix for easier debugging.
def log(msg)
Rails.logger.info "[EmployeeController] #{msg}"
end
end end

View File

@@ -24,6 +24,11 @@ class EstimateController < ApplicationController
render_pdf(@estimate) render_pdf(@estimate)
end end
def sync
Estimate.sync
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end
private private
# Loads the estimate based on ID or doc number, with a fallback to sync if not found locally. # Loads the estimate based on ID or doc number, with a fallback to sync if not found locally.
@@ -65,7 +70,7 @@ class EstimateController < ApplicationController
# Renders the estimate PDF or redirects with an error if rendering fails. # Renders the estimate PDF or redirects with an error if rendering fails.
def render_pdf(estimate) def render_pdf(estimate)
pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [estimate.id]) pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [estimate.id])
send_data( pdf, filename: "estimate #{ref}.pdf", disposition: :inline, type: "application/pdf" ) send_data( pdf, filename: "estimate #{ref}.pdf", disposition: :inline, type: "application/pdf" )
rescue StandardError => e rescue StandardError => e
log "PDF render failed for Estimate #{estimate&.id}: #{e.message}" log "PDF render failed for Estimate #{estimate&.id}: #{e.message}"

View File

@@ -18,7 +18,7 @@ class InvoiceController < ApplicationController
log "Processing request for #{request.original_url}" log "Processing request for #{request.original_url}"
invoice_ids = Array(params[:invoice_ids] || params[:id]) invoice_ids = Array(params[:invoice_ids] || params[:id])
pdf, ref = InvoicePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: invoice_ids) pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: invoice_ids)
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf" send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
@@ -27,6 +27,11 @@ class InvoiceController < ApplicationController
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) } redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) }
end end
def sync
Invoice.sync
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end
private private
# Logs messages with a consistent prefix for easier debugging. # Logs messages with a consistent prefix for easier debugging.

View File

@@ -46,9 +46,13 @@ class QboController < ApplicationController
redirect_to issue || root_path, flash: { error: e.message } redirect_to issue || root_path, flash: { error: e.message }
end end
# Manual sync endpoint to trigger a full synchronization of QuickBooks entities with the local database. Enqueues all relevant sync jobs and redirects to the home page with a notice that syncing has started. # Manual sync endpoint to trigger synchronization of QuickBooks entities
# with the local database. Supports full or partial sync depending on
# the `full_sync` boolean parameter.
def sync def sync
QboSyncDispatcher.full_sync! full_sync = ActiveModel::Type::Boolean.new.cast(params[:full_sync])
QboSyncDispatcher.sync!(full_sync: full_sync)
redirect_to :home, flash: { notice: I18n.t(:label_syncing) } redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end end

View File

@@ -1,36 +0,0 @@
#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 CustomerSyncJob < ApplicationJob
queue_as :default
retry_on StandardError, wait: 5.minutes, attempts: 5
# Perform a full sync of all customers, or an incremental sync of only those updated since the last sync
def perform(full_sync: false, id: nil)
qbo = QboConnectionService.current!
raise "No QBO configuration found" unless qbo
log "Starting #{full_sync ? 'full' : 'incremental'} sync for customer ##{id || 'all'}..."
service = CustomerSyncService.new(qbo: qbo)
if id.present?
service.sync_by_id(id)
else
service.sync(full_sync: full_sync)
end
end
private
def log(msg)
Rails.logger.info "[CustomerSyncJob] #{msg}"
end
end

View File

@@ -1,36 +0,0 @@
#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 EmployeeSyncJob < ApplicationJob
queue_as :default
retry_on StandardError, wait: 5.minutes, attempts: 5
# Performs a sync of employees from QuickBooks Online.
def perform(full_sync: false, id: nil)
qbo = QboConnectionService.current!
raise "No QBO configuration found" unless qbo
log "Starting #{full_sync ? 'full' : 'incremental'} sync for employee ##{id || 'all'}..."
service = EmployeeSyncService.new(qbo: qbo)
if id.present?
service.sync_by_id(id)
else
service.sync(full_sync: full_sync)
end
end
private
def log(msg)
Rails.logger.info "[EmployeeSyncJob] #{msg}"
end
end

View File

@@ -1,36 +0,0 @@
#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 InvoiceSyncJob < ApplicationJob
queue_as :default
retry_on StandardError, wait: 5.minutes, attempts: 5
# Performs a sync of invoices from QuickBooks Online.
def perform(full_sync: false, id: nil)
qbo = QboConnectionService.current!
raise "No QBO configuration found" unless qbo
log "Starting #{full_sync ? 'full' : 'incremental'} sync for invoice ##{id || 'all'}..."
service = InvoiceSyncService.new(qbo: qbo)
if id.present?
service.sync_by_id(id)
else
service.sync(full_sync: full_sync)
end
end
private
def log(msg)
Rails.logger.info "[InvoiceSyncJob] #{msg}"
end
end

View File

@@ -11,29 +11,37 @@
class QboSyncDispatcher class QboSyncDispatcher
SYNC_JOBS = [ SYNC_JOBS = [
CustomerSyncJob, Customer,
EstimateSyncJob, Estimate,
InvoiceSyncJob, Invoice,
EmployeeSyncJob Employee
].freeze ].freeze
# Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database. Each job is enqueued with the `full_sync` flag set to true. # Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database.
def self.full_sync! # Each job is enqueued with the `full_sync` flag set to true.
def self.sync!(full_sync: false)
log "Manual Sync initated for #{full_sync ? "full sync" : "incremental sync"}"
enque_jobs full_sync: full_sync
end
private
# Dynamically enques all sync jobs
def self.enque_jobs(full_sync: full_sync)
jobs = SYNC_JOBS.dup jobs = SYNC_JOBS.dup
# Allow other plugins to add addtional sync jobs via Hooks # Allow other plugins to add addtional sync jobs via Hooks
Redmine::Hook.call_hook( :qbo_full_sync ).each do |context| Redmine::Hook.call_hook( :qbo_full_sync ).each do |context|
next unless context next unless context
jobs.push context Array(context).each do |entity|
log "Added additionals QBO Sync Job for #{contex.to_s}" jobs.push(entity)
log "Added additional QBO Sync Job for #{entity.to_s}"
end
end end
jobs.each { |job| job.perform_later(full_sync: true) } jobs.each { |job| QboSyncJob.perform_later(entity: job, full_sync: full_sync) }
end end
private
def self.log(msg) def self.log(msg)
Rails.logger.info "[QboSyncDispatcher] #{msg}" Rails.logger.info "[QboSyncDispatcher] #{msg}"
end end

View File

@@ -8,23 +8,22 @@
# #
#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. #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 EstimateSyncJob < ApplicationJob class QboSyncJob < ApplicationJob
queue_as :default queue_as :default
retry_on StandardError, wait: 5.minutes, attempts: 5 retry_on StandardError, wait: 5.minutes, attempts: 5
# Performs a sync of estimates from QuickBooks Online. # Perform a full sync of all records for the entity, or an incremental sync of only those updated since the last sync
def perform(full_sync: false, id: nil, doc_number: nil) def perform(full_sync: false, id: nil, entity: nil, doc_number: nil)
qbo = QboConnectionService.current! raise "An entity to sync is required" unless entity
raise "No QBO configuration found" unless qbo @entity = entity
log "Starting #{full_sync ? 'full' : 'incremental'} sync for estimate ##{id || doc_number || 'all'}..." log "Starting #{full_sync ? 'full' : 'incremental'} sync for #{entity} ##{id || doc_number || 'all'}..."
service = "#{entity}SyncService".constantize.new
service = EstimateSyncService.new(qbo: qbo)
if id.present? if id.present?
service.sync_by_id(id) service.sync_by_id(id)
elsif doc_number.present? elsif doc_number.present?
service.sync_by_doc(doc_number) service.sync_by_doc_number(doc_number)
else else
service.sync(full_sync: full_sync) service.sync(full_sync: full_sync)
end end
@@ -32,7 +31,8 @@ class EstimateSyncJob < ApplicationJob
private private
# Log messages with the entity type for better traceability
def log(msg) def log(msg)
Rails.logger.info "[EstimateSyncJob] #{msg}" Rails.logger.info "[#{@entity}SyncJob] #{msg}"
end end
end end

View File

@@ -47,8 +47,10 @@ class WebhookProcessJob < ActiveJob::Base
# Allow other plugins to add addtional qbo entities via Hooks # Allow other plugins to add addtional qbo entities via Hooks
Redmine::Hook.call_hook( :qbo_additional_entities ).each do |context| Redmine::Hook.call_hook( :qbo_additional_entities ).each do |context|
next unless context next unless context
entities.push context Array(context).each do |entity|
log "Added additional QBO entities: #{context}" jobs.push(entity)
log "Added additional QBO entity #{entity}"
end
end end
return unless entities.include?(name) return unless entities.include?(name)

View File

@@ -33,14 +33,12 @@ class Customer < QboBaseModel
# Returns the customer's email address # Returns the customer's email address
def email def email
details return details&.email_address&.address
return @details&.email_address&.address
end end
# Updates the customer's email address # Updates the customer's email address
def email=(s) def email=(s)
details details.email_address = s
@details.email_address = s
end end
# Customers are not bound by a project # Customers are not bound by a project
@@ -51,22 +49,19 @@ class Customer < QboBaseModel
# returns the customer's mobile phone # returns the customer's mobile phone
def mobile_phone def mobile_phone
details return details&.mobile_phone&.free_form_number
return @details&.mobile_phone&.free_form_number
end end
# Updates the custome's mobile phone number # Updates the custome's mobile phone number
def mobile_phone=(n) def mobile_phone=(n)
details
pn = Quickbooks::Model::TelephoneNumber.new pn = Quickbooks::Model::TelephoneNumber.new
pn.free_form_number = n pn.free_form_number = n
@details.mobile_phone = pn details.mobile_phone = pn
end end
# Updates Both local DB name & QBO display_name # Updates Both local DB name & QBO display_name
def name=(s) def name=(s)
details details.display_name = s
@details.display_name = s
super super
end end
@@ -78,22 +73,19 @@ class Customer < QboBaseModel
# Sets the notes for the customer # Sets the notes for the customer
def notes=(s) def notes=(s)
details details.notes = s
@details.notes = s
end end
# returns the customer's primary phone # returns the customer's primary phone
def primary_phone def primary_phone
details return details&.primary_phone&.free_form_number
return @details&.primary_phone&.free_form_number
end end
# Updates the customer's primary phone number # Updates the customer's primary phone number
def primary_phone=(n) def primary_phone=(n)
details
pn = Quickbooks::Model::TelephoneNumber.new pn = Quickbooks::Model::TelephoneNumber.new
pn.free_form_number = n pn.free_form_number = n
@details.primary_phone = pn details.primary_phone = pn
end end
# Seach for customers by name or phone number # Seach for customers by name or phone number

View File

@@ -21,9 +21,9 @@ class Estimate < QboBaseModel
return self[:doc_number] return self[:doc_number]
end end
# sync only one estimate # sync only one estimate by document number
def self.sync_by_doc_number(number) def self.sync_by_doc_number(number)
EstimateSyncJob.perform_later(doc_number: number) QboSyncJob.perform_later(entity: model_name.name, doc_number: number)
end end
end end

View File

@@ -14,6 +14,26 @@ class Qbo < ActiveRecord::Base
include Redmine::I18n include Redmine::I18n
validate :single_record_only, on: :create validate :single_record_only, on: :create
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
def self.last_sync
qbo = QboConnectionService.current!
format_time(qbo.last_sync)
rescue
return I18n.t(:label_qbo_never_synced)
end
def self.oauth2_access_token_expires_at
QboConnectionService.current!.oauth2_access_token_expires_at
rescue
return I18n.t(:label_qbo_never_synced)
end
def self.oauth2_refresh_token_expires_at
QboConnectionService.current!.oauth2_refresh_token_expires_at
rescue
return I18n.t(:label_qbo_never_synced)
end
# Updates last sync time stamp # Updates last sync time stamp
def self.update_time_stamp def self.update_time_stamp
@@ -24,13 +44,6 @@ class Qbo < ActiveRecord::Base
qbo.save qbo.save
end end
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
def self.last_sync
qbo = QboConnectionService.current!
return I18n.t(:label_qbo_never_synced) unless qbo&.last_sync
format_time(qbo.last_sync)
end
private private
# Logs a message with a QBO-specific prefix for easier identification in the logs. # Logs a message with a QBO-specific prefix for easier identification in the logs.

View File

@@ -70,14 +70,12 @@ class QboBaseModel < ActiveRecord::Base
# Sync all entities, typically triggered by a scheduled task or manual sync request # Sync all entities, typically triggered by a scheduled task or manual sync request
def self.sync def self.sync
job = "#{model_name.name}SyncJob".constantize QboSyncJob.perform_later(entity: model_name.name, full_sync: true)
job.perform_later(full_sync: true)
end end
# Sync a single entity by ID, typically triggered by a webhook notification or manual sync request # Sync a single entity by ID, typically triggered by a webhook notification or manual sync request
def self.sync_by_id(id) def self.sync_by_id(id)
job = "#{model_name.name}SyncJob".constantize QboSyncJob.perform_later(entity: model_name.name, id: id)
job.perform_later(id: id)
end end
# Flag used to update local without pushing to QBO. # Flag used to update local without pushing to QBO.
@@ -100,15 +98,13 @@ class QboBaseModel < ActiveRecord::Base
# Fetches the entity's details from QuickBooks Online. # Fetches the entity's details from QuickBooks Online.
def fetch_details def fetch_details
log "Fetching details for #{model_name.name} ##{id} from QBO..." log "Fetching details for #{model_name.name} ##{id} from QBO..."
qbo = QboConnectionService.current! service_class.new(local: self).pull()
service_class.new(qbo: qbo, local: self).pull()
end end
# Pushs the entity's details from QuickBooks Online. # Pushs the entity's details from QuickBooks Online.
def push_to_qbo def push_to_qbo
log "Starting push for #{model_name.name} ##{id}..." log "Starting push for #{model_name.name} ##{id}..."
qbo = QboConnectionService.current! reslut = service_class.new(local: self).push
reslut = service_class.new(qbo: qbo, local: self).push
Rails.cache.delete(details_cache_key) Rails.cache.delete(details_cache_key)
return reslut return reslut
end end

View File

@@ -22,6 +22,6 @@ class EmployeeSyncService < SyncServiceBase
!remote.active? !remote.active?
end end
map_attribute :name, ->(remote) { remote.display_name } map_attribute :name, :display_name
end end

View File

@@ -1,16 +0,0 @@
#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 EstimatePdfService < PdfServiceBase
def self.model_class
Estimate
end
end

View File

@@ -9,6 +9,14 @@
#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. #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 < SyncServiceBase class EstimateSyncService < SyncServiceBase
# sync only one estimate
def sync_by_doc_number(number)
log "Syncing estimate by doc number #{number}"
QboConnectionService.with_qbo_service(entity: @entity) do |service|
persist(service.find_by( :doc_number, number).first)
end
end
private private

View File

@@ -17,20 +17,11 @@ class InvoicePushService
# Push invoice changes to QBO if the invoice is linked to any issues with custom field changes that need to be synced # Push invoice changes to QBO if the invoice is linked to any issues with custom field changes that need to be synced
def push def push
return if @invoice.qbo_sync_locked? return if @invoice.qbo_sync_locked?
log "Pushing invoice ##{@invoice.id} to QBO due to linked issue custom field changes" log "Pushing invoice ##{@invoice.id} to QBO due to linked issue custom field changes"
@invoice.update_column(:qbo_sync_locked, true) @invoice.update_column(:qbo_sync_locked, true)
remote = QboConnectionService.with_qbo_service(entity: Invoice) do |service|
qbo = QboConnectionService.current!
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(@invoice.id) remote = service.fetch_by_id(@invoice.id)
# modify remote object here if needed # modify remote object here if needed
service.update(remote) service.update(remote)
end end
rescue => e rescue => e

View File

@@ -7,30 +7,21 @@
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. #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. #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 PdfServiceBase class PdfService
require 'combine_pdf' require 'combine_pdf'
# Subclasses should initialize with a QBO client instance # Subclasses should initialize with a QBO client instance
def initialize(qbo:) def initialize(entity: entity)
@qbo = qbo raise "An entity to sync is required" unless entity
@entity = self.class.model_class @entity = entity
end
# Subclasses must implement this to specify which document model to download pdf (e.g. Estimate, Invoice)
def self.model_class
raise NotImplementedError
end end
# Fetches the PDF for the given entity IDs. If multiple IDs are provided, their PDFs are combined into a single document. # Fetches the PDF for the given entity IDs. If multiple IDs are provided, their PDFs are combined into a single document.
def fetch_pdf(doc_ids:) def fetch_pdf(doc_ids:)
log "Fetching PDFs for #{@entity} IDs: #{doc_ids.join(', ')}" log "Fetching PDFs for #{@entity} IDs: #{doc_ids.join(', ')}"
@qbo.perform_authenticated_request do |access_token| QboConnectionService.with_qbo_service(entity: @entity) do |service|
service_class = "Quickbooks::Service::#{@entity.name}".constantize
service = service_class.new(company_id: @qbo.realm_id, access_token: access_token)
return single_pdf(service, doc_ids.first) if doc_ids.size == 1 return single_pdf(service, doc_ids.first) if doc_ids.size == 1
combined_pdf(service, doc_ids) combined_pdf(service, doc_ids)
end end
end end

View File

@@ -10,6 +10,11 @@
class QboConnectionService class QboConnectionService
# Returns the current QBO connection record. Raises an error if no connection exists.
def self.current!
Qbo.first || raise("QBO not connected")
end
# Replaces the existing QBO connection with new credentials. Deletes all existing records and creates a new one with the provided token, refresh token, and realm ID. Refreshes the token immediately after creation. # Replaces the existing QBO connection with new credentials. Deletes all existing records and creates a new one with the provided token, refresh token, and realm ID. Refreshes the token immediately after creation.
def self.replace!(token:, refresh_token:, realm_id:) def self.replace!(token:, refresh_token:, realm_id:)
Qbo.transaction do Qbo.transaction do
@@ -24,9 +29,14 @@ class QboConnectionService
end end
end end
# Returns the current QBO connection record. Raises an error if no connection exists. # Performs authenticaed requests with QBO service
def self.current! def self.with_qbo_service(entity: nil)
Qbo.first || raise("QBO not connected") qbo = current!
raise "An entity to sync is required" unless entity
service_class ||= "Quickbooks::Service::#{entity}".constantize
qbo.perform_authenticated_request do |access_token|
service = service_class.new( company_id: qbo.realm_id, access_token: access_token )
yield service
end
end end
end end

View File

@@ -10,7 +10,8 @@
class QboOauthService class QboOauthService
# Generates the QuickBooks OAuth authorization URL with the specified callback URL. The URL includes necessary parameters such as response type, state, and scope. # Generates the QuickBooks OAuth authorization URL with the specified callback URL.
# The URL includes necessary parameters such as response type, state, and scope.
def self.authorization_url(callback_url:) def self.authorization_url(callback_url:)
client.auth_code.authorize_url( client.auth_code.authorize_url(
redirect_uri: callback_url, redirect_uri: callback_url,
@@ -20,7 +21,8 @@ class QboOauthService
) )
end end
# Exchanges the authorization code for access and refresh tokens. Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation. # Exchanges the authorization code for access and refresh tokens.
# Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation.
def self.exchange!(code:, callback_url:, realm_id:) def self.exchange!(code:, callback_url:, realm_id:)
resp = client.auth_code.get_token(code, redirect_uri: callback_url) resp = client.auth_code.get_token(code, redirect_uri: callback_url)
QboConnectionService.replace!( token: resp.token, refresh_token: resp.refresh_token, realm_id: realm_id ) QboConnectionService.replace!( token: resp.token, refresh_token: resp.refresh_token, realm_id: realm_id )

View File

@@ -13,11 +13,9 @@ class ServiceBase
# Subclasses should Initializes the service with a QBO client and a local record. # Subclasses should Initializes the service with a QBO client and a local record.
# The QBO client is used to communicate with QuickBooks Online, while the local record contains the data that needs to be pushed to QBO. # The QBO client is used to communicate with QuickBooks Online, while the local record contains the data that needs to be pushed to QBO.
# If no local is provided, the service will not perform any operations. # If no local is provided, the service will not perform any operations.
def initialize(qbo:, local: nil) def initialize(local: nil)
@entity = local.class.name @entity = local.class.name
raise "No QBO configuration found" unless qbo
raise "#{@entity} record is required for push operation" unless local raise "#{@entity} record is required for push operation" unless local
@qbo = qbo
@local = local @local = local
end end
@@ -31,7 +29,7 @@ class ServiceBase
return build_qbo_remote unless @local.present? return build_qbo_remote unless @local.present?
return build_qbo_remote unless @local.id return build_qbo_remote unless @local.id
log "Fetching details for #{@entity} ##{@local.id} from QBO..." log "Fetching details for #{@entity} ##{@local.id} from QBO..."
with_qbo_service do |service| QboConnectionService.with_qbo_service(entity: @entity) do |service|
service.fetch_by_id(@local.id) service.fetch_by_id(@local.id)
end end
rescue => e rescue => e
@@ -45,7 +43,7 @@ class ServiceBase
# If the push is successful, it returns the remote record; otherwise, it logs the error and returns false. # If the push is successful, it returns the remote record; otherwise, it logs the error and returns false.
def push def push
log "Pushing #{@entity} ##{@local.id} to QBO..." log "Pushing #{@entity} ##{@local.id} to QBO..."
remote = with_qbo_service do |service| remote = QboConnectionService.with_qbo_service(entity: @entity) do |service|
if @local.id.present? if @local.id.present?
log "Updating #{@entity}" log "Updating #{@entity}"
service.update(@local.details) service.update(@local.details)
@@ -61,22 +59,9 @@ class ServiceBase
private private
# Performs authenticaed requests with QBO service
def with_qbo_service
@qbo.perform_authenticated_request do |access_token|
service = service_class.new( company_id: @qbo.realm_id, access_token: access_token )
yield service
end
end
# Log messages with the entity type for better traceability # Log messages with the entity type for better traceability
def log(msg) def log(msg)
Rails.logger.info "[#{@entity}Service] #{msg}" Rails.logger.info "[#{@entity}Service] #{msg}"
end end
# Dynamically get the Quickbooks Service Class
def service_class
@service_class ||= "Quickbooks::Service::#{@entity}".constantize
end
end end

View File

@@ -12,9 +12,7 @@ class SyncServiceBase
PAGE_SIZE = 1000 PAGE_SIZE = 1000
# Subclasses should initialize with a QBO client instance # Subclasses should initialize with a QBO client instance
def initialize(qbo:) def initialize()
raise "No QBO configuration found" unless qbo
@qbo = qbo
@entity = self.class.model_class @entity = self.class.model_class
@page_size = self.class.page_size @page_size = self.class.page_size
end end
@@ -32,7 +30,7 @@ class SyncServiceBase
# Sync all entities, or only those updated since the last sync # Sync all entities, or only those updated since the last sync
def sync(full_sync: false) def sync(full_sync: false)
log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync with page size of: #{@page_size}" log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync with page size of: #{@page_size}"
with_qbo_service do |service| QboConnectionService.with_qbo_service(entity: @entity) do |service|
query = build_query(full_sync) query = build_query(full_sync)
service.query_in_batches(query, per_page: @page_size) do |batch| service.query_in_batches(query, per_page: @page_size) do |batch|
entries = Array(batch) entries = Array(batch)
@@ -49,7 +47,7 @@ class SyncServiceBase
# Sync a single entity by its QBO ID (webhook usage) # Sync a single entity by its QBO ID (webhook usage)
def sync_by_id(id) def sync_by_id(id)
log "Syncing #{@entity.name} with ID #{id}" log "Syncing #{@entity.name} with ID #{id}"
with_qbo_service do |service| QboConnectionService.with_qbo_service(entity: @entity) do |service|
remote = service.fetch_by_id(id) remote = service.fetch_by_id(id)
persist(remote) persist(remote)
end end
@@ -240,17 +238,4 @@ class SyncServiceBase
end end
end end
end end
# Dynamically get the Quickbooks Service Class
def service_class
@service_class ||= "Quickbooks::Service::#{@entity}".constantize
end
# Performs authenticaed requests with QBO service
def with_qbo_service
@qbo.perform_authenticated_request do |access_token|
service = service_class.new( company_id: @qbo.realm_id, access_token: access_token )
yield service
end
end
end end

View File

@@ -3,3 +3,4 @@
<%= submit_tag t(:label_search) %> <%= submit_tag t(:label_search) %>
<% end %> <% end %>
<%= button_to t(:label_new_customer), new_customer_path, method: :get%> <%= button_to t(:label_new_customer), new_customer_path, method: :get%>
<%= button_to(t(:label_sync), qbo_sync_path, method: :get) if User.current.admin?%>

View File

@@ -1,111 +1,79 @@
<!--
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.
-->
<!-- somewhere in your document include the Javascript -->
<script type="text/javascript" src="https://appcenter.intuit.com/Content/IA/intuit.ipp.anywhere.js"></script> <script type="text/javascript" src="https://appcenter.intuit.com/Content/IA/intuit.ipp.anywhere.js"></script>
<!-- configure the Intuit object: 'grantUrl' is a URL in your application which kicks off the flow, see below -->
<script> <script>
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'}); intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'});
</script> </script>
<table > <div class="box tabular">
<tbody> <p>
<label><%= t(:label_client_id) %></label>
<%= text_field_tag 'settings[settingsOAuthConsumerKey]', settings['settingsOAuthConsumerKey'], size: 50 %>
</p>
<p>
<label><%= t(:label_client_secret) %></label>
<%= password_field_tag 'settings[settingsOAuthConsumerSecret]', settings['settingsOAuthConsumerSecret'], size: 50 %>
</p>
<tr> <p>
<th><%=t(:label_client_id)%></th> <label><%= t(:label_webhook_token) %></label>
<td> <%= text_field_tag 'settings[settingsWebhookToken]', settings['settingsWebhookToken'], size: 50 %>
<input </p>
type="text"
style="width:350px"
id="settingsOAuthConsumerKey"
value="<%= settings['settingsOAuthConsumerKey'] %>"
name="settings[settingsOAuthConsumerKey]" >
</td>
</tr>
<tr> <p>
<th><%=t(:label_client_secret)%></th> <label><%= t(:label_sandbox) %></label>
<td> <%= check_box_tag 'settings[sandbox]', 1, settings[:sandbox] %>
<input </p>
type="text"
style="width:350px"
id="settingsOAuthConsumerSecret"
value="<%= settings['settingsOAuthConsumerSecret'] %>"
name="settings[settingsOAuthConsumerSecret]" >
</td>
</tr>
<tr>
<th><%=t(:label_webhook_token)%></th>
<td>
<input
type="text"
style="width:350px"
id="settingsWebhookToken"
value="<%= settings['settingsWebhookToken'] %>"
name="settings[settingsWebhookToken]" >
</td>
</tr>
<tr> <hr />
<th><%=t(:label_sandbox)%></th>
<td>
<%= check_box_tag 'settings[sandbox]', @settings[:sandbox], @settings[:sandbox] %>
</td>
</tr>
<tr> <p>
<th><%=t(:label_oauth_expires)%></th> <label><%= t(:label_oauth_expires) %></label>
<td><%= QboConnectionService.current!&.oauth2_access_token_expires_at %> <span class="icon <%= Qbo.oauth2_access_token_expires_at&.future? ? 'icon-ok' : 'icon-warning' %>">
</tr> <%= Qbo.oauth2_access_token_expires_at || 'N/A' %>
</span>
<tr> </p>
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th>
<td><%= QboConnectionService.current!&.oauth2_refresh_token_expires_at %>
</tr>
</tbody> <p>
</table> <label><%= t(:label_customer_count) %></label>
<%= Customer.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Customer.last_sync %>)</em>
</p>
<br/> <p>
<%=t(:label_oauth_note)%> <label><%= t(:label_employee_count) %></label>
<br/> <%= Employee.count %>
<br/> <em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Employee.last_sync %>)</em>
</p>
<!-- this will display a button that the user clicks to start the flow --> <p>
<ipp:connectToIntuit></ipp:connectToIntuit> <label><%= t(:label_invoice_count) %></label>
<%= Invoice.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Item.last_sync %>)</em>
</p>
<br/> <p>
<br/> <label><%= t(:label_estimate_count) %></label>
<%= Estimate.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Account.last_sync %>)</em>
</p>
<div> <p>
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%> @ <%= Customer.last_sync %> <label><%= t(:label_last_sync) %> (QBO)</label>
</div> <%= Qbo.exists? ? Qbo.last_sync : 'Never synced' %>
</p>
<div>
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %> @ <%= Employee.last_sync %>
</div>
<div>
<b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %> @ <%= Invoice.last_sync%>
</div>
<div>
<b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %> @ <%= Estimate.last_sync %>
</div>
<br/>
<div>
<b><%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %> <%= link_to t(:label_sync_now), qbo_sync_path %>
</div> </div>
<fieldset class="box">
<legend>Management & Synchronization</legend>
<div style="margin-bottom: 20px;">
<ipp:connectToIntuit></ipp:connectToIntuit>
</div>
<div style="margin-bottom: 15px;">
<%= link_to t(:label_sync_now_customers), customers_sync_path(full_sync: true), class: 'button icon icon-reload' %>
<%= link_to t(:label_sync_now_employees), employees_sync_path, class: 'button icon icon-reload' %>
<%= link_to t(:label_sync_now_invoices), invoices_sync_path(full_sync: true), class: 'button icon icon-reload' %>
<%= link_to t(:label_sync_now_estimate), estimates_sync_path, class: 'button icon icon-reload' %>
</div>
</fieldset>

View File

@@ -82,6 +82,10 @@ en:
label_shipping_address: "Shipping Address" label_shipping_address: "Shipping Address"
label_sync: "Sync" label_sync: "Sync"
label_sync_now: "Sync Now" label_sync_now: "Sync Now"
label_sync_now_customers: "Sync Customers"
label_sync_now_employees: "Sync Employees"
label_sync_now_invoices: "Sync Invoices"
label_sync_now_estimate: "Sync Estimates"
label_syncing: "Syncing QuickBooks" label_syncing: "Syncing QuickBooks"
label_trim: "Trim" label_trim: "Trim"
label_webhook_token: "Intuit QBO Webhook Token" label_webhook_token: "Intuit QBO Webhook Token"

View File

@@ -14,12 +14,16 @@ get 'qbo/oauth_callback', to: 'qbo#oauth_callback'
#manual sync #manual sync
get 'qbo/sync', to: 'qbo#sync' get 'qbo/sync', to: 'qbo#sync'
get 'customers/sync', to: 'customers#sync'
get 'employees/sync', to: 'employee#sync'
get 'invoices/sync', to: 'invoice#sync'
get 'estimates/sync', to: 'estimate#sync'
#webhook #webhook
post 'qbo/webhook', to: 'qbo#webhook' post 'qbo/webhook', to: 'qbo#webhook'
# Estimate & Invoice PDF # Estimate & Invoice PDF
get 'estimates/:id', to: 'estimate#show', as: :estimate get 'estimates/sync', to: 'estimate#sync'
get 'estimates/doc/', to: 'estimate#doc', as: :estimate_doc get 'estimates/doc/', to: 'estimate#doc', as: :estimate_doc
get 'invoices/:id', to: 'invoice#show', as: :invoice get 'invoices/:id', to: 'invoice#show', as: :invoice
@@ -36,4 +40,5 @@ get 'filter_invoices_by_customer' => 'customers#filter_invoices_by_customer'
resources :customers do resources :customers do
get :autocomplete_customer_name, on: :collection get :autocomplete_customer_name, on: :collection
get :sync
end end

View File

@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
name 'Redmine QBO plugin' name 'Redmine QBO plugin'
author 'Rick Barrette' 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' 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.7' version '2026.3.11'
url 'https://github.com/rickbarrette/redmine_qbo' url 'https://github.com/rickbarrette/redmine_qbo'
author_url 'https://barrettefabrication.com' author_url 'https://barrettefabrication.com'
settings default: {empty: true}, partial: 'qbo/settings' settings default: {empty: true}, partial: 'qbo/settings'

View File

@@ -260,7 +260,7 @@ module RedmineQbo
# Check to see if there is an estimate attached, then combine them # Check to see if there is an estimate attached, then combine them
if issue.estimate if issue.estimate
e_pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [issue.estimate.id]) e_pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [issue.estimate.id])
pdf = CombinePDF.parse(pdf.output, allow_optional_content: true) pdf = CombinePDF.parse(pdf.output, allow_optional_content: true)
pdf << CombinePDF.parse(e_pdf) pdf << CombinePDF.parse(e_pdf)
return pdf.to_pdf return pdf.to_pdf