Compare commits

...

43 Commits

Author SHA1 Message Date
61b02831e3 removed comment 2026-03-28 06:40:59 -04:00
7c79f2388a removed Custom Field Synchronization 2026-03-28 00:32:22 -04:00
36267893bd 2026.3.17 2026-03-28 00:25:55 -04:00
e681203a45 Removed custom field sync, it was never really useful anyways. 2026-03-28 00:25:07 -04:00
681e7f8047 2026.3.16 2026-03-26 08:13:01 -04:00
4a6c414d9e Updated customer form to use auto complete to help prevent duplicate customer enteries 2026-03-26 07:56:59 -04:00
925cb1d2bc 2026.3.15
Note: breaking change, need to update settings
2026-03-22 14:24:22 -04:00
1dcccd7b98 Merge branch 'master' into rails-7 2026-03-21 10:28:46 -04:00
f73973a4e1 2026.3.14 2026-03-21 10:27:33 -04:00
7cd388dbd4 Fixed webhook 2026-03-21 10:26:57 -04:00
7149e85d37 Updated how settings are handled.
Note: Breaking change. Will need to update settings after update
2026-03-21 10:25:46 -04:00
eacdecd65b Updated patches and hooks 2026-03-21 00:09:42 -04:00
ee2ab04206 added placeholder 2026-03-19 18:15:04 -04:00
8a8c6f5fa0 renamed issue_customer_id to customer_id 2026-03-19 18:07:21 -04:00
cc36bc16b4 use the autocomplete 2026-03-19 10:36:46 -04:00
874ec7c2dc updated plugin_config screenshot 2026-03-19 09:16:32 -04:00
f3fe38cd57 2026.3.12 2026-03-19 08:34:27 -04:00
977cbfe0e1 removed coffee-rails 2026-03-19 08:22:25 -04:00
82712f361c fixed estimate path 2026-03-19 08:07:34 -04:00
4ae7d75478 removed jquery-ui-rails 2026-03-19 07:57:00 -04:00
8fb9d74277 removced placeholder for customer field 2026-03-19 07:20:59 -04:00
b0e6236cee removed old autocomplete js 2026-03-18 21:56:52 -04:00
b367687113 Implmented custom autocomplete for customer field 2026-03-18 21:55:55 -04:00
460bcd466f Fixed routes 2026-03-18 19:11:33 -04:00
020ea01d36 renamed controllers and updated routes 2026-03-18 00:08:56 -04:00
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
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
50 changed files with 840 additions and 1007 deletions

View File

@@ -4,11 +4,5 @@ gem 'quickbooks-ruby'
gem 'oauth2' gem 'oauth2'
gem 'roxml' gem 'roxml'
gem 'will_paginate' gem 'will_paginate'
gem 'rails-jquery-autocomplete'
gem 'jquery-ui-rails'
gem 'rexml' gem 'rexml'
gem 'combine_pdf' gem 'combine_pdf'
group :assets do
gem 'coffee-rails'
end

View File

@@ -89,17 +89,6 @@ Supported automation:
Invoices containing an Issue reference (e.g. `#123`) automatically attach to the corresponding Issue. Invoices containing an Issue reference (e.g. `#123`) automatically attach to the corresponding Issue.
### Custom Field Synchronization
Invoice custom fields can be mapped to Issue custom fields.
Example use case:
* Mileage In/Out recorded in Redmine
* Automatically synchronized to the QuickBooks invoice.
### Customer Synchronization ### Customer Synchronization
Customer records are automatically updated in the local database when changes occur in QuickBooks. Customer records are automatically updated in the local database when changes occur in QuickBooks.
@@ -121,7 +110,6 @@ Available hooks:
|--|--|--| |--|--|--|
View Hook|:pdf_left, { issue: issue } | Used to add text to left side of PDF View Hook|:pdf_left, { issue: issue } | Used to add text to left side of PDF
View Hook|:pdf_right, { issue: issue } | Used to add text to right side of PDF View Hook|:pdf_right, { issue: issue } | Used to add text to right side of PDF
Hook|process_invoice_custom_fields, { issue: issue, invoice: invoice } | Used to process invoice custom fields
View Hook|:show_customer_view_right, { customer: customer } | Used to show partials on right side of customer view View Hook|:show_customer_view_right, { customer: customer } | Used to show partials on right side of customer view
Hook| :qbo_additional_entities | Used to add additional entites to be processed by the WebhookProcessJob Hook| :qbo_additional_entities | Used to add additional entites to be processed by the WebhookProcessJob
Hook| :qbo_full_sync | Used to add a Class to be called by the QboSyncDispatcher Hook| :qbo_full_sync | Used to add a Class to be called by the QboSyncDispatcher

Binary file not shown.

Before

Width:  |  Height:  |  Size: 672 KiB

After

Width:  |  Height:  |  Size: 269 KiB

View File

@@ -30,40 +30,49 @@ class CustomersController < ApplicationController
before_action :view_customer, except: [:new, :view] before_action :view_customer, except: [:new, :view]
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view] skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
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 autocomplete form
# used for customer autocomplete field / issue form def autocomplete
def filter_invoices_by_customer term = ActiveRecord::Base.sanitize_sql_like(params[:q].to_s)
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
items = Customer.where("name LIKE :t OR phone_number LIKE :t OR mobile_phone_number LIKE :t", t: "%#{term}%")
.order(:name)
.limit(20)
render json: items.map { |i|
{ id: i.id, name: i.name, phone_number: i.phone_number, mobile_phone_number: i.mobile_phone_number }
}
end 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 +85,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 +190,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 +206,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
# @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 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 EstimatePdfService < PdfServiceBase class EmployeesController < ApplicationController
include AuthHelper
def self.model_class before_action :require_user, unless: -> { session[:token].nil? }
Estimate
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

@@ -7,7 +7,7 @@
#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 EstimateController < ApplicationController class EstimatesController < ApplicationController
include AuthHelper include AuthHelper
before_action :require_user, unless: -> { session[:token].nil? } before_action :require_user, unless: -> { session[:token].nil? }
@@ -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

@@ -7,7 +7,7 @@
#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 InvoiceController < ApplicationController class InvoicesController < ApplicationController
include AuthHelper include AuthHelper
before_action :require_user, unless: -> { session[:token].nil? } before_action :require_user, unless: -> { session[:token].nil? }
@@ -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

@@ -14,7 +14,7 @@ class QboWebhookProcessor
def self.process!(request:) def self.process!(request:)
body = request.raw_post body = request.raw_post
signature = request.headers['intuit-signature'] signature = request.headers['intuit-signature']
secret = Setting.plugin_redmine_qbo['settingsWebhookToken'] secret = RedmineQbo.webhook_token_secret
raise "Invalid signature" unless valid_signature?(body, signature, secret) raise "Invalid signature" unless valid_signature?(body, signature, secret)

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}" entities.push(entity)
log "Added additional QBO entity #{entity}"
end
end end
return unless entities.include?(name) return unless entities.include?(name)

View File

@@ -75,11 +75,8 @@ module QuickbooksOauth
# This method will construct and return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings. This method is used by the instance method oauth_client to create a new OAuth2 client for each instance of the model that includes this concern. # This method will construct and return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings. This method is used by the instance method oauth_client to create a new OAuth2 client for each instance of the model that includes this concern.
def construct_oauth2_client def construct_oauth2_client
oauth_consumer_key = Setting.plugin_redmine_qbo['settingsOAuthConsumerKey']
oauth_consumer_secret = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret']
# Are we are playing in the sandbox? # Are we are playing in the sandbox?
Quickbooks.sandbox_mode = Setting.plugin_redmine_qbo[:sandbox] ? true : false Quickbooks.sandbox_mode = RedmineQbo.sandbox_mode?
log "Sandbox mode: #{Quickbooks.sandbox_mode}" log "Sandbox mode: #{Quickbooks.sandbox_mode}"
options = { options = {
@@ -87,7 +84,7 @@ module QuickbooksOauth
authorize_url: "https://appcenter.intuit.com/connect/oauth2", authorize_url: "https://appcenter.intuit.com/connect/oauth2",
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer" token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
} }
OAuth2::Client.new(oauth_consumer_key, oauth_consumer_secret, options) OAuth2::Client.new(RedmineQbo.oauth_consumer_key, RedmineQbo.oauth_consumer_secret, options)
end end
end end

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

@@ -15,6 +15,26 @@ class Qbo < ActiveRecord::Base
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
date = DateTime.now date = DateTime.now
@@ -24,14 +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!
format_time(qbo.last_sync)
rescue
return I18n.t(:label_qbo_never_synced)
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

@@ -10,6 +10,14 @@
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
# Specify the local model this service syncs # Specify the local model this service syncs

View File

@@ -29,8 +29,6 @@ class InvoiceAttachmentService
issue.save! if issue.changed? issue.save! if issue.changed?
log "Attached invoice ##{@invoice.id} to issue ##{issue.id}" log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
end end
InvoiceCustomFieldSyncService.new(issue, @invoice, @remote).sync
end end
end end

View File

@@ -1,69 +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 InvoiceCustomFieldSyncService
def initialize(issue, invoice, remote)
@issue = issue
@invoice = invoice
@remote = remote
end
# Sync custom fields on the issue based on the invoice data, then push changes to QBO if any fields were updated
def sync
return if @invoice.qbo_sync_locked?
log "Syncing custom fields for issue ##{@issue.id} based on invoice ##{@invoice.doc_number}"
changed = false
# Process Invoice Custom Fields via Hooks
Redmine::Hook.call_hook(
:process_invoice_custom_fields,
issue: @issue,
invoice: @remote
).each do |context|
next unless context
changed ||= context[:is_changed]
log "Custom fields updated by hook, marking invoice for push to QBO" if context[:is_changed]
end
# Process Issue Custom Values from any issue custom fields that match the invoice custom fields
begin
value = @issue.custom_values.find_by(custom_field_id: CustomField.find_by_name(cf.name).id)
# Check to see if the value is blank...
if not value.value.to_s.blank?
# Check to see if the value is diffrent
if not cf.string_value.to_s.eql? value.value.to_s
# update the custom field on the invoice
cf.string_value = value.value.to_s
is_changed = true
end
end
rescue
# Nothing to do here, there is no match
end
push_if_changed if changed
end
private
# If any custom fields were changed during the sync process, this method will trigger a push of the invoice data to QuickBooks Online to ensure that the remote data stays in sync with the local changes. It uses the InvoicePushService to handle the actual communication with QBO.
def push_if_changed
InvoicePushService.new(@invoice).push
end
def log(msg)
Rails.logger.info "[InvoiceCustomFieldSyncService] #{msg}"
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 InvoicePdfService < PdfServiceBase
def self.model_class
Invoice
end
end

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

@@ -7,7 +7,7 @@
<div class="clearfix"> <div class="clearfix">
<%=t(:label_display_name)%> <%=t(:label_display_name)%>
<div class="input"> <div class="input">
<%= f.text_field :name, required: true, autocomplete: "off" %> <%= f.text_field :name, required: true, class: "customer-name", autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
</div> </div>
</div> </div>

View File

@@ -1,5 +1,6 @@
<%= form_tag(customers_path, method: "get", id: "customer-search-form") do %> <%= form_tag(customers_path, method: "get", id: "customer-search-form") do %>
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_customers), autocomplete: "off" %> <%= text_field_tag :search, params[:search], class: "customer-name", placeholder: t(:label_search_customers), autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
<%= 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,4 +1,4 @@
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{Setting.plugin_redmine_qbo[:sandbox] ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2> <h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{RedmineQbo.sandbox_mode? ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
<div class="issue"> <div class="issue">
<div class="splitcontent"> <div class="splitcontent">

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[oauth_consumer_key]', settings[:oauth_consumer_key], size: 50 %>
</p>
<tr> <p>
<th><%=t(:label_client_id)%></th> <label><%= t(:label_client_secret) %></label>
<td> <%= password_field_tag 'settings[oauth_consumer_secret]', settings[:oauth_consumer_secret], 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_webhook_token) %></label>
<td> <%= text_field_tag 'settings[webhook_token]', settings[:webhook_token], size: 50 %>
<input </p>
type="text"
style="width:350px"
id="settingsOAuthConsumerSecret"
value="<%= settings['settingsOAuthConsumerSecret'] %>"
name="settings[settingsOAuthConsumerSecret]" >
</td>
</tr>
<tr> <p>
<th><%=t(:label_webhook_token)%></th> <label><%= t(:label_sandbox) %></label>
<td> <%= check_box_tag 'settings[sandbox]', 1, settings[:sandbox] %>
<input </p>
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>
</p>
<tr> <p>
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th> <label><%= t(:label_customer_count) %></label>
<td><%= QboConnectionService.current!&.oauth2_refresh_token_expires_at %> <%= Customer.count %>
</tr> <em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Customer.last_sync %>)</em>
</p>
</tbody> <p>
</table> <label><%= t(:label_employee_count) %></label>
<%= Employee.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Employee.last_sync %>)</em>
</p>
<br/> <p>
<%=t(:label_oauth_note)%> <label><%= t(:label_invoice_count) %></label>
<br/> <%= Invoice.count %>
<br/> <em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Item.last_sync %>)</em>
</p>
<!-- this will display a button that the user clicks to start the flow --> <p>
<label><%= t(:label_estimate_count) %></label>
<%= Estimate.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Account.last_sync %>)</em>
</p>
<p>
<label><%= t(:label_last_sync) %> (QBO)</label>
<%= Qbo.exists? ? Qbo.last_sync : 'Never synced' %>
</p>
</div>
<fieldset class="box">
<legend>Management & Synchronization</legend>
<div style="margin-bottom: 20px;">
<ipp:connectToIntuit></ipp:connectToIntuit> <ipp:connectToIntuit></ipp:connectToIntuit>
<br/>
<br/>
<div>
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%> @ <%= Customer.last_sync %>
</div> </div>
<div> <div style="margin-bottom: 15px;">
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %> @ <%= Employee.last_sync %> <%= link_to t(:label_sync_now_customers), sync_customers_path, class: 'button icon icon-reload' %>
</div> <%= 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, class: 'button icon icon-reload' %>
<div> <%= link_to t(:label_sync_now_estimate), estimates_sync_path, class: 'button icon icon-reload' %>
<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>

View File

@@ -1 +0,0 @@
!function(t){t.fn.railsAutocomplete=function(e){var a=function(){this.railsAutoCompleter||(this.railsAutoCompleter=new t.railsAutocomplete(this))};if(void 0!==t.fn.on){if(!e)return;return t(document).on("focus",e,a)}return this.live("focus",a)},t.railsAutocomplete=function(t){var e=t;this.init(e)},t.railsAutocomplete.options={showNoMatches:!0,noMatchesLabel:"no existing match"},t.railsAutocomplete.fn=t.railsAutocomplete.prototype={railsAutocomplete:"0.0.1"},t.railsAutocomplete.fn.extend=t.railsAutocomplete.extend=t.extend,t.railsAutocomplete.fn.extend({init:function(e){function a(t){return t.split(e.delimiter)}function i(t){return a(t).pop().replace(/^\s+/,"")}e.delimiter=t(e).attr("data-delimiter")||null,e.min_length=t(e).attr("data-min-length")||t(e).attr("min-length")||2,e.append_to=t(e).attr("data-append-to")||null,e.autoFocus=t(e).attr("data-auto-focus")||!1,t(e).autocomplete({appendTo:e.append_to,autoFocus:e.autoFocus,delay:t(e).attr("delay")||0,source:function(a,r){var n=this.element[0],o={term:i(a.term)};t(e).attr("data-autocomplete-fields")&&t.each(t.parseJSON(t(e).attr("data-autocomplete-fields")),function(e,a){o[e]=t(a).val()}),t.getJSON(t(e).attr("data-autocomplete"),o,function(){var a={};t.extend(a,t.railsAutocomplete.options),t.each(a,function(i,r){if(a.hasOwnProperty(i)){var n=t(e).attr("data-"+i);a[i]=n?n:r}}),0==arguments[0].length&&t.inArray(a.showNoMatches,[!0,"true"])>=0&&(arguments[0]=[],arguments[0][0]={id:"",label:a.noMatchesLabel}),t(arguments[0]).each(function(a,i){var r={};r[i.id]=i,t(e).data(r)}),r.apply(null,arguments),t(n).trigger("railsAutocomplete.source",arguments)})},change:function(e,a){if(t(this).is("[data-id-element]")&&""!==t(t(this).attr("data-id-element")).val()&&(t(t(this).attr("data-id-element")).val(a.item?a.item.id:"").trigger("change"),t(this).attr("data-update-elements"))){var i=t.parseJSON(t(this).attr("data-update-elements")),r=a.item?t(this).data(a.item.id.toString()):{};if(i&&""===t(i.id).val())return;for(var n in i){var o=t(i[n]);o.is(":checkbox")?null!=r[n]&&o.prop("checked",r[n]):o.val(a.item?r[n]:"").trigger("change")}}},search:function(){var t=i(this.value);return t.length<e.min_length?!1:void 0},focus:function(){return!1},select:function(i,r){if(r.item.value=r.item.value.toString(),-1!=r.item.value.toLowerCase().indexOf("no match")||-1!=r.item.value.toLowerCase().indexOf("too many results"))return t(this).trigger("railsAutocomplete.noMatch",r),!1;var n=a(this.value);if(n.pop(),n.push(r.item.value),null!=e.delimiter)n.push(""),this.value=n.join(e.delimiter);else if(this.value=n.join(""),t(this).attr("data-id-element")&&t(t(this).attr("data-id-element")).val(r.item.id).trigger("change"),t(this).attr("data-update-elements")){var o=r.item,l=-1!=r.item.value.indexOf("Create New")?!0:!1,u=t.parseJSON(t(this).attr("data-update-elements"));for(var s in u)"checkbox"===t(u[s]).attr("type")?o[s]===!0||1===o[s]?t(u[s]).attr("checked","checked"):t(u[s]).removeAttr("checked"):l&&o[s]&&-1==o[s].indexOf("Create New")||!l?t(u[s]).val(o[s]).trigger("change"):t(u[s]).val("").trigger("change")}var c=this.value;return t(this).bind("keyup.clearId",function(){t.trim(t(this).val())!=t.trim(c)&&(t(t(this).attr("data-id-element")).val("").trigger("change"),t(this).unbind("keyup.clearId"))}),t(e).trigger("railsAutocomplete.select",r),!1}}),t(e).trigger("railsAutocomplete.init")}}),t(document).ready(function(){t("input[data-autocomplete]").railsAutocomplete("input[data-autocomplete]")})}(jQuery);

View File

@@ -0,0 +1,102 @@
(function () {
// Helper: escape HTML for safety
function escapeHtml(str) {
return $("<div>").text(str).html();
}
// Helper: highlight all occurrences of term (case-insensitive)
function highlightTerm(text, term) {
if (!term) return text;
const escapedTerm = term.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
const regex = new RegExp("(" + escapedTerm + ")", "ig");
return text.replace(regex, "<strong>$1</strong>");
}
window.initCustomerAutocomplete = function(context) {
let scope = context || document;
$(scope).find(".customer-name").each(function() {
if ($(this).data("autocomplete-initialized")) return;
$(this).data("autocomplete-initialized", true);
let $input = $(this);
let ac = $input.autocomplete({
appendTo: "body", // crucial for Redmine positioning
minLength: 2,
source: function(request, response) {
$.getJSON("/customers/autocomplete", { q: request.term })
.done(function(data) {
response(data.map(function(item) {
// combine secondary info
let secondary = [];
if (item.phone_number) secondary.push(item.phone_number);
if (item.mobile_phone_number) secondary.push(item.mobile_phone_number);
let meta = secondary.length ? " (" + secondary.join(" • ") + ")" : "";
// escape HTML to avoid XSS
let safeText = escapeHtml(item.name + meta);
return {
label: item.name + meta, // plain fallback
value: item.name, // goes into input
id: item.id,
html: highlightTerm(safeText, request.term)
};
}));
})
.fail(function() {
response([]);
});
},
select: function(event, ui) {
$input.val(ui.item.value); // visible text
$("#customer_id").val(ui.item.id); // hidden ID
// trigger Redmine form update safely
setTimeout(function() {
$("#customer_id").trigger("change");
}, 0);
return false;
},
change: function(event, ui) {
// clear hidden field if no valid selection
if (!ui.item && !$input.val()) {
$("#customer_id").val("");
}
}
});
// Render item HTML for highlight
ac.autocomplete("instance")._renderItem = function(ul, item) {
return $("<li>")
.append($("<div>").html(item.html))
.appendTo(ul);
};
});
};
// Re-init after Redmine AJAX form updates
$(document).on("ajaxComplete", function() {
if (window.initCustomerAutocomplete) {
window.initCustomerAutocomplete(document);
}
});
// Init on page load
$(document).ready(function() {
window.initCustomerAutocomplete(document);
});
// Also init on Turbo/Redmine load events
document.addEventListener("turbo:load", function() {
window.initCustomerAutocomplete(document);
});
})();

View File

@@ -0,0 +1,5 @@
/* Keep Redmine default look, just enhance metadata */
.ui-autocomplete .autocomplete-meta {
color: #888;
font-size: 0.9em;
}

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,14 +14,17 @@ 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 'invoices/sync', to: 'invoices#sync'
get 'estimates/sync', to: 'estimates#sync'
get 'employees/sync', to: 'employees#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/:id', to: 'estimates#show', as: :estimate
get 'estimates/doc/', to: 'estimate#doc', as: :estimate_doc get 'estimates/doc/', to: 'estimates#doc', as: :estimate_doc
get 'invoices/:id', to: 'invoice#show', as: :invoice get 'invoices/:id', to: 'invoices#show', as: :invoice
#manual billing #manual billing
get 'bill/:id', to: 'qbo#bill', as: :bill get 'bill/:id', to: 'qbo#bill', as: :bill
@@ -35,5 +38,8 @@ get 'filter_estimates_by_customer' => 'customers#filter_estimates_by_customer'
get 'filter_invoices_by_customer' => 'customers#filter_invoices_by_customer' get 'filter_invoices_by_customer' => 'customers#filter_invoices_by_customer'
resources :customers do resources :customers do
get :autocomplete_customer_name, on: :collection collection do
get :autocomplete
get :sync
end
end end

10
init.rb
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.8' version '2026.3.17'
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'
@@ -43,10 +43,4 @@ Redmine::Plugin.register :redmine_qbo do
end end
# Dynamically load all Hooks & Patches recursively RedmineQbo.setup
base_dir = File.join(File.dirname(__FILE__), 'lib')
# '**' looks inside subdirectories, '*.rb' matches Ruby files
Dir.glob(File.join(base_dir, '**', '*.rb')).sort.each do |file|
require file
end

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2016 - 2026 rick barrette #Copyright (c) 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: #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:
# #
@@ -8,40 +8,48 @@
# #
#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 InvoicePushService module RedmineQbo
def self.setup
# === Models ===
Issue.prepend RedmineQbo::Patches::IssuePatch
User.prepend RedmineQbo::Patches::UserPatch
def initialize(invoice) # === Queries ===
@invoice = invoice IssueQuery.prepend RedmineQbo::Patches::QueryPatch
TimeEntryQuery.prepend RedmineQbo::Patches::TimeEntryQueryPatch
# === Controllers ===
RedmineQbo::Patches::IssuesControllerPatch.apply
RedmineQbo::Patches::AttachmentsControllerPatch.apply
# === Helpers / Exports ===
Redmine::Export::PDF::IssuesPdfHelper.prepend RedmineQbo::Patches::PdfPatch
# === Hooks ===
RedmineQbo::Hooks::IssuesHookListener
RedmineQbo::Hooks::UsersShowHookListener
RedmineQbo::Hooks::ViewHookListener
end end
# Push invoice changes to QBO if the invoice is linked to any issues with custom field changes that need to be synced def self.settings
def push Setting.plugin_redmine_qbo
return if @invoice.qbo_sync_locked?
log "Pushing invoice ##{@invoice.id} to QBO due to linked issue custom field changes"
@invoice.update_column(:qbo_sync_locked, true)
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)
# modify remote object here if needed
service.update(remote)
end
rescue => e
Rails.logger.error "[InvoicePushService] #{e.message}"
ensure
@invoice.update_column(:qbo_sync_locked, false)
end end
private def self.oauth_consumer_key
settings[:oauth_consumer_key]
end
def log(msg) def self.oauth_consumer_secret
Rails.logger.info "[InvoicePushService] #{msg}" settings[:oauth_consumer_secret]
end end
def self.sandbox_mode?
settings[:sandbox] ? true : false
end
def self.webhook_token_secret
settings[:webhook_token]
end
end end

View File

@@ -24,12 +24,11 @@ module RedmineQbo
# Customer Name Text Box with database backed autocomplete # Customer Name Text Box with database backed autocomplete
# onchange event will update the hidden customer_id field # onchange event will update the hidden customer_id field
search_customer = f.autocomplete_field :customer, search_customer = f.text_field :customer,
autocomplete_customer_name_customers_path, class: "customer-name",
selected: issue.customer, autocomplete: "off",
update_elements: { data: {
id: '#issue_customer_id', autocomplete_url: "/customers/autocomplete"
value: '#issue_customer'
} }
# We need to handle 3 cases for the onchange event of the customer name field: # We need to handle 3 cases for the onchange event of the customer name field:
@@ -47,7 +46,7 @@ module RedmineQbo
# This hidden field is used for the customer ID for the issue # This hidden field is used for the customer ID for the issue
# the onchange event will reload the issue form via ajax to update the available estimates # the onchange event will reload the issue form via ajax to update the available estimates
customer_id = f.hidden_field :customer_id, customer_id = f.hidden_field :customer_id,
id: "issue_customer_id", id: "customer_id",
onchange: js_path.html_safe onchange: js_path.html_safe
# Generate the drop down list of quickbooks estimates owned by the selected customer # Generate the drop down list of quickbooks estimates owned by the selected customer

View File

@@ -16,9 +16,6 @@ module RedmineQbo
# View User # View User
def view_users_form(context={}) def view_users_form(context={})
# Update the users
#Employee.update_all
# Check to see if there is a quickbooks user attached to the issue # Check to see if there is a quickbooks user attached to the issue
@selected = context[:user]&.employee&.id @selected = context[:user]&.employee&.id

View File

@@ -17,8 +17,9 @@ module RedmineQbo
def view_layouts_base_html_head(context = {}) def view_layouts_base_html_head(context = {})
safe_join([ safe_join([
javascript_include_tag( 'application.js', plugin: :redmine_qbo), javascript_include_tag( 'application.js', plugin: :redmine_qbo),
javascript_include_tag( 'autocomplete-rails.js', plugin: :redmine_qbo), javascript_include_tag( 'autocomplete.js', plugin: :redmine_qbo),
javascript_include_tag( 'checkbox_controller.js', plugin: :redmine_qbo) javascript_include_tag( 'checkbox_controller.js', plugin: :redmine_qbo),
stylesheet_link_tag( 'autocomplete', plugin: :redmine_qbo)
]) ])
end end

View File

@@ -8,41 +8,32 @@
# #
#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.
require_dependency 'attachments_controller'
module RedmineQbo module RedmineQbo
module Patches module Patches
module AttachmentsControllerPatch module AttachmentsControllerPatch
module Helper
def self.included(base) # Check if login is globally required to access the application
base.class_eval do
# check if login is globally required to access the application
def check_if_login_required def check_if_login_required
# no check needed if user is already logged in # Return true if the user is already logged in
return true if User.current.logged? return true if User.current.logged?
# Pull up the attachmet, & verify if we have a valid token for the Issue # Pull up the attachment and verify if we have a valid token for the issue
attachment = Attachment.find(params[:id]) attachment = Attachment.find_by(id: params[:id])
token = CustomerToken.where("token = ? and expires_at > ?", session[:token], Time.now) return require_login if attachment.nil?
token = token.first
unless token.nil?
return true if token.issue_id == attachment.container_id
end
token = CustomerToken.where("token = ? AND expires_at > ?", session[:token], Time.current).first
return true if token&.issue_id == attachment.container_id
# Default to requiring login if all else fails
require_login if Setting.login_required? require_login if Setting.login_required?
end end
end end
end def self.apply
AttachmentsController.class_eval do
end helper Helper
end
# Add module to AttachmentsController end
AttachmentsController.send(:include, AttachmentsControllerPatch) end
end end
end end

View File

@@ -8,60 +8,39 @@
# #
#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.
require_dependency 'issue'
module RedmineQbo module RedmineQbo
module Patches module Patches
module IssuePatch module IssuePatch
extend ActiveSupport::Concern
def self.included(base) prepended do
base.extend(ClassMethods)
base.send(:include, InstanceMethods)
base.class_eval do
belongs_to :customer, class_name: 'Customer', foreign_key: :customer_id, optional: true belongs_to :customer, class_name: 'Customer', foreign_key: :customer_id, optional: true
belongs_to :customer_token, primary_key: :id belongs_to :customer_token, primary_key: :id, optional: true
belongs_to :estimate, primary_key: :id belongs_to :estimate, primary_key: :id, optional: true
has_and_belongs_to_many :invoices has_and_belongs_to_many :invoices
before_save :titlize_subject before_save :titlize_subject
after_commit :enqueue_billing, on: :update after_commit :enqueue_billing, on: :update
end end
end # Enqueue a background job to bill the time spent on this issue to QuickBooks if the issue is closed and assigned to an employee
module ClassMethods
end
module InstanceMethods
# Enqueue a background job to bill the time spent on this issue to the associated customer in Quickbooks, if the issue is closed and has a customer assigned.
def enqueue_billing def enqueue_billing
log "Checking if issue needs to be billed for issue ##{id}" log "Checking if issue needs billing for ##{id}"
return unless closed? return unless closed? && customer.present? && assigned_to&.employee_id.present?
return unless customer.present?
return unless assigned_to&.employee_id.present?
log "Enqueuing billing for issue ##{id}" log "Enqueuing billing for issue ##{id}"
BillIssueTimeJob.perform_later(id) BillIssueTimeJob.perform_later(id)
end end
# Titlize the subject of the issue before saving to ensure consistent formatting for billing descriptions in Quickbooks # Titlize the subject for consistent formatting in billing descriptions
def titlize_subject def titlize_subject
log "Titlizing subject for issue ##{id}" log "Titlizing subject for issue ##{id}"
self.subject = subject.split(/\s+/).map do |word| self.subject = subject.split(/\s+/).map do |word|
if word =~ /[A-Z]/ && word =~ /[0-9]/ (word =~ /[A-Z]/ && word =~ /[0-9]/) ? word : word.capitalize
word
else
word.capitalize
end
end.join(' ') end.join(' ')
end end
end
# This method is used to generate a shareable token for the customer associated with this issue, which can be used to link the issue to the corresponding customer in Quickbooks for billing and tracking purposes. # Generate a shareable token linking this issue to the customer for QuickBooks
def share_token def share_token
CustomerToken.get_token(self) CustomerToken.get_token(self)
end end
@@ -72,7 +51,5 @@ module RedmineQbo
Rails.logger.info "[IssuePatch] #{msg}" Rails.logger.info "[IssuePatch] #{msg}"
end end
end end
Issue.send(:include, IssuePatch)
end end
end end

View File

@@ -7,30 +7,31 @@
#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.
require_dependency 'issues_controller'
module RedmineQbo module RedmineQbo
module Patches module Patches
module IssuesControllerPatch module IssuesControllerPatch
module Helper module Helper
# Extend the watcher links to include billing and share options
def watcher_link(issue, user) def watcher_link(issue, user)
link = '' links = ''
link = link_to(I18n.t(:label_bill_time), bill_path( issue.id ), method: :get, class: 'icon icon-email-add') if user.admin?
link << link_to(I18n.t(:label_share), share_path( issue.id ), method: :get, target: :_blank, class: 'icon icon-shared') if user.logged? # Admin users can bill time
link.html_safe + super links << link_to(I18n.t(:label_bill_time), bill_path(issue.id), method: :get, class: 'icon icon-email-add') if user.admin?
# Logged-in users can share the issue
links << link_to(I18n.t(:label_share), share_path(issue.id), method: :get, target: :_blank, class: 'icon icon-shared') if user.logged?
# Append to the original watcher links
(links.html_safe + super).html_safe
end end
end end
def self.included(base) def self.apply
base.class_eval do IssuesController.class_eval do
helper Helper helper Helper
end end
end end
end end
# Add module to IssuessController
IssuesController.send(:include, IssuesControllerPatch)
end end
end end

View File

@@ -8,64 +8,105 @@
# #
#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.
require_dependency 'redmine/export/pdf'
require_dependency 'redmine/export/pdf/issues_pdf_helper'
module RedmineQbo module RedmineQbo
module Patches module Patches
module PdfPatch module PdfPatch
extend ActiveSupport::Concern
def self.included(base) def issue_to_pdf(issue, assoc={})
base.send(:include, InstanceMethods) pdf = setup_pdf(issue)
base.class_eval do
alias_method :issue_to_pdf, :issue_to_pdf_with_patch render_header(pdf, issue)
alias_method :issue_to_pdf_with_patch, :issue_to_pdf render_ancestors_and_subject(pdf, issue)
end
left, right = build_issue_attributes(issue)
render_attributes_grid(pdf, left, right)
render_description(pdf, issue)
render_subtasks(pdf, issue)
render_relations(pdf, issue)
render_changesets(pdf, issue)
render_journals(pdf, issue, assoc)
render_attachments(pdf, issue)
merge_estimate_if_present(pdf, issue)
end end
module InstanceMethods private
def issue_to_pdf_with_patch(issue, assoc={}) def log(msg)
Rails.logger.info "[PdfPatch] #{msg}"
end
def setup_pdf(issue)
pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language) pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language)
pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}") pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}")
pdf.alias_nb_pages pdf.alias_nb_pages
pdf.footer_date = format_date(Date.today) pdf.footer_date = format_date(Date.today)
pdf.add_page pdf.add_page
pdf
end
def render_header(pdf, issue)
pdf.SetFontStyle('B', 11) pdf.SetFontStyle('B', 11)
buf = "#{issue.project} - #{issue.tracker} ##{issue.id}" pdf.RDMMultiCell(190, 5, "#{issue.project} - #{issue.tracker} ##{issue.id}")
pdf.RDMMultiCell(190, 5, buf)
pdf.SetFontStyle('', 8) pdf.SetFontStyle('', 8)
end
def render_ancestors_and_subject(pdf, issue)
base_x = pdf.get_x base_x = pdf.get_x
i = 1 i = 1
# Render ancestors
issue.ancestors.visible.each do |ancestor| issue.ancestors.visible.each do |ancestor|
pdf.set_x(base_x + i) pdf.set_x(base_x + i)
buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status.to_s}): #{ancestor.subject}" buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status}): #{ancestor.subject}"
pdf.RDMMultiCell(190 - i, 5, buf) pdf.RDMMultiCell(190 - i, 5, buf)
i += 1 if i < 35 i += 1 if i < 35
end end
# Render current issue subject and meta
pdf.SetFontStyle('B', 11) pdf.SetFontStyle('B', 11)
pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s) pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s)
pdf.SetFontStyle('', 8) pdf.SetFontStyle('', 8)
pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}") pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}")
pdf.ln pdf.ln
end
customer = issue.customer.name if issue.customer def build_issue_attributes(issue)
left = build_left_attributes(issue)
right = build_right_attributes(issue)
# Pad arrays to equal length
rows = [left.size, right.size].max
left.fill(nil, left.size...rows)
right.fill(nil, right.size...rows)
# Distribute custom fields evenly
half = (issue.visible_custom_field_values.size / 2.0).ceil
issue.visible_custom_field_values.each_with_index do |custom_value, i|
target_column = i < half ? left : right
target_column << [custom_value.custom_field.name, show_value(custom_value, false)]
end
[left, right]
end
def build_left_attributes(issue)
left = [] left = []
left << [l(:field_status), issue.status] left << [l(:field_status), issue.status]
left << [l(:field_priority), issue.priority] left << [l(:field_priority), issue.priority]
left << [l(:field_customer), customer] left << [l(:field_customer), issue.customer&.name]
left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id) left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id)
#left << [l(:field_category), issue.category] unless issue.disabled_core_fields.include?(:category_id)
#left << [l(:field_fixed_version), issue.fixed_version] unless issue.disabled_core_fields.include?(:fixed_version_id)
log "Calling :pdf_left hook" log "Calling :pdf_left hook"
left_hook_output = Redmine::Hook.call_hook :pdf_left, { issue: issue } left_hook_output = Redmine::Hook.call_hook(:pdf_left, { issue: issue })
unless left_hook_output.nil? Array(left_hook_output).compact.each { |l| left.concat(l) }
left_hook_output.each do |l|
left.concat l unless l.nil? left
end
end end
def build_right_attributes(issue)
right = [] right = []
right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?(:start_date) right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?(:start_date)
right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?(:due_date) right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?(:due_date)
@@ -74,181 +115,180 @@ module RedmineQbo
right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project) right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project)
log "Calling :pdf_right hook" log "Calling :pdf_right hook"
right_hook_output = Redmine::Hook.call_hook :pdf_right, { issue: issue } right_hook_output = Redmine::Hook.call_hook(:pdf_right, { issue: issue })
unless right_hook_output.nil? Array(right_hook_output).compact.each { |r| right.concat(r) }
right_hook_output.each do |r|
right.concat r unless r.nil? right
end
end end
rows = left.size > right.size ? left.size : right.size def render_attributes_grid(pdf, left, right)
while left.size < rows base_x = pdf.get_x
left << nil borders = determine_borders(pdf.get_rtl)
end rows = [left.size, right.size].max
while right.size < rows
right << nil
end
half = (issue.visible_custom_field_values.size / 2.0).ceil
issue.visible_custom_field_values.each_with_index do |custom_value, i|
(i < half ? left : right) << [custom_value.custom_field.name, show_value(custom_value, false)]
end
if pdf.get_rtl
border_first_top = 'RT'
border_last_top = 'LT'
border_first = 'R'
border_last = 'L'
else
border_first_top = 'LT'
border_last_top = 'RT'
border_first = 'L'
border_last = 'R'
end
rows = left.size > right.size ? left.size : right.size
rows.times do |i| rows.times do |i|
heights = [] item_left = left[i]
pdf.SetFontStyle('B',9) item_right = right[i]
item = left[i]
heights << pdf.get_string_height(35, item ? "#{item.first}:" : "")
item = right[i]
heights << pdf.get_string_height(35, item ? "#{item.first}:" : "")
pdf.SetFontStyle('',9)
item = left[i]
heights << pdf.get_string_height(60, item ? item.last.to_s : "")
item = right[i]
heights << pdf.get_string_height(60, item ? item.last.to_s : "")
height = heights.max
item = left[i] # Calculate dynamic row height
pdf.SetFontStyle('B', 9) pdf.SetFontStyle('B', 9)
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0) hl1 = pdf.get_string_height(35, item_left ? "#{item_left.first}:" : "")
pdf.SetFontStyle('',9) hr1 = pdf.get_string_height(35, item_right ? "#{item_right.first}:" : "")
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 0)
item = right[i]
pdf.SetFontStyle('B',9)
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0)
pdf.SetFontStyle('', 9) pdf.SetFontStyle('', 9)
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 2) hl2 = pdf.get_string_height(60, item_left ? item_left.last.to_s : "")
hr2 = pdf.get_string_height(60, item_right ? item_right.last.to_s : "")
height = [hl1, hr1, hl2, hr2].max
# Render cells
render_grid_cell(pdf, item_left, height, i == 0 ? borders[:first_top] : borders[:first], i == 0 ? borders[:last_top] : borders[:last], 0)
render_grid_cell(pdf, item_right, height, i == 0 ? borders[:first_top] : borders[:first], i == 0 ? borders[:last_top] : borders[:last], 2)
pdf.set_x(base_x) pdf.set_x(base_x)
end end
end
def determine_borders(is_rtl)
if is_rtl
{ first_top: 'RT', last_top: 'LT', first: 'R', last: 'L' }
else
{ first_top: 'LT', last_top: 'RT', first: 'L', last: 'R' }
end
end
def render_grid_cell(pdf, item, height, border_label, border_val, ln_type)
pdf.SetFontStyle('B', 9) pdf.SetFontStyle('B', 9)
pdf.RDMCell(35+155, 5, l(:field_description), "LRT", 1) pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", border_label, '', 0, 0)
pdf.SetFontStyle('', 9)
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", border_val, '', 0, ln_type)
end
def render_description(pdf, issue)
pdf.SetFontStyle('B', 9)
pdf.RDMCell(190, 5, l(:field_description), "LRT", 1)
pdf.SetFontStyle('', 9) pdf.SetFontStyle('', 9)
# Set resize image scale
pdf.set_image_scale(1.6) pdf.set_image_scale(1.6)
text = textilizable(issue, :description, text = textilizable(issue, :description,
only_path: false, only_path: false,
edit_section_links: false, edit_section_links: false,
headings: false, headings: false,
inline_attachments: false inline_attachments: false)
) pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "LRB")
pdf.RDMwriteFormattedCell(35+155, 5, '', '', text, issue.attachments, "LRB") end
unless issue.leaf? def render_subtasks(pdf, issue)
truncate_length = (!is_cjk? ? 90 : 65) return if issue.leaf?
truncate_length = !is_cjk? ? 90 : 65
pdf.SetFontStyle('B', 9) pdf.SetFontStyle('B', 9)
pdf.RDMCell(35+155,5, l(:label_subtask_plural) + ":", "LTR") pdf.RDMCell(190, 5, "#{l(:label_subtask_plural)}:", "LTR")
pdf.ln pdf.ln
border_first = pdf.get_rtl ? 'R' : 'L'
border_last = pdf.get_rtl ? 'L' : 'R'
issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level| issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
buf = "#{child.tracker} # #{child.id}: #{child.subject}". buf = "#{child.tracker} # #{child.id}: #{child.subject}".truncate(truncate_length)
truncate(truncate_length)
level = 10 if level >= 10 level = 10 if level >= 10
pdf.SetFontStyle('', 8) pdf.SetFontStyle('', 8)
pdf.RDMCell(35+135,5, (level >=1 ? " " * level : "") + buf, border_first) pdf.RDMCell(170, 5, (level >= 1 ? " " * level : "") + buf, border_first)
pdf.SetFontStyle('B', 8) pdf.SetFontStyle('B', 8)
pdf.RDMCell(20, 5, child.status.to_s, border_last) pdf.RDMCell(20, 5, child.status.to_s, border_last)
pdf.ln pdf.ln
end end
end end
def render_relations(pdf, issue)
relations = issue.relations.select { |r| r.other_issue(issue).visible? } relations = issue.relations.select { |r| r.other_issue(issue).visible? }
unless relations.empty? return if relations.empty?
truncate_length = (!is_cjk? ? 80 : 60)
truncate_length = !is_cjk? ? 80 : 60
pdf.SetFontStyle('B', 9) pdf.SetFontStyle('B', 9)
pdf.RDMCell(35+155,5, l(:label_related_issues) + ":", "LTR") pdf.RDMCell(190, 5, "#{l(:label_related_issues)}:", "LTR")
pdf.ln pdf.ln
border_first = pdf.get_rtl ? 'R' : 'L'
border_last = pdf.get_rtl ? 'L' : 'R'
relations.each do |relation| relations.each do |relation|
buf = relation.to_s(issue) {|other| other = relation.other_issue(issue)
text = "" text = Setting.cross_project_issue_relations? ? "#{other.project} - " : ""
if Setting.cross_project_issue_relations?
text += "#{relation.other_issue(issue).project} - "
end
text += "#{other.tracker} ##{other.id}: #{other.subject}" text += "#{other.tracker} ##{other.id}: #{other.subject}"
text
}
buf = buf.truncate(truncate_length)
pdf.SetFontStyle('', 8) pdf.SetFontStyle('', 8)
pdf.RDMCell(35+155-60, 5, buf, border_first) pdf.RDMCell(130, 5, text.truncate(truncate_length), border_first)
pdf.SetFontStyle('B', 8) pdf.SetFontStyle('B', 8)
pdf.RDMCell(20,5, relation.other_issue(issue).status.to_s, "") pdf.RDMCell(20, 5, other.status.to_s, "")
pdf.RDMCell(20,5, format_date(relation.other_issue(issue).start_date), "") pdf.RDMCell(20, 5, format_date(other.start_date), "")
pdf.RDMCell(20,5, format_date(relation.other_issue(issue).due_date), border_last) pdf.RDMCell(20, 5, format_date(other.due_date), border_last)
pdf.ln pdf.ln
end end
end
pdf.RDMCell(190, 5, "", "T") pdf.RDMCell(190, 5, "", "T")
pdf.ln pdf.ln
end
def render_changesets(pdf, issue)
return unless issue.changesets.any? && User.current.allowed_to?(:view_changesets, issue.project)
if issue.changesets.any? &&
User.current.allowed_to?(:view_changesets, issue.project)
pdf.SetFontStyle('B', 9) pdf.SetFontStyle('B', 9)
pdf.RDMCell(190, 5, l(:label_associated_revisions), "B") pdf.RDMCell(190, 5, l(:label_associated_revisions), "B")
pdf.ln pdf.ln
for changeset in issue.changesets
issue.changesets.each do |changeset|
pdf.SetFontStyle('B', 8) pdf.SetFontStyle('B', 8)
csstr = "#{l(:label_revision)} #{changeset.format_identifier} - " csstr = "#{l(:label_revision)} #{changeset.format_identifier} - #{format_time(changeset.committed_on)} - #{changeset.author}"
csstr += format_time(changeset.committed_on) + " - " + changeset.author.to_s
pdf.RDMCell(190, 5, csstr) pdf.RDMCell(190, 5, csstr)
pdf.ln pdf.ln
unless changeset.comments.blank? unless changeset.comments.blank?
pdf.SetFontStyle('', 8) pdf.SetFontStyle('', 8)
pdf.RDMwriteHTMLCell(190,5,'','', pdf.RDMwriteHTMLCell(190, 5, '', '', changeset.comments.to_s, issue.attachments, "")
changeset.comments.to_s, issue.attachments, "")
end end
pdf.ln pdf.ln
end end
end end
if assoc[:journals].present? def render_journals(pdf, issue, assoc)
return unless assoc[:journals].present?
pdf.SetFontStyle('B', 9) pdf.SetFontStyle('B', 9)
pdf.RDMCell(190, 5, l(:label_history), "B") pdf.RDMCell(190, 5, l(:label_history), "B")
pdf.ln pdf.ln
assoc[:journals].each do |journal| assoc[:journals].each do |journal|
pdf.SetFontStyle('B', 8) pdf.SetFontStyle('B', 8)
title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}" title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}"
title << " (#{l(:field_private_notes)})" if journal.private_notes? title << " (#{l(:field_private_notes)})" if journal.private_notes?
pdf.RDMCell(190, 5, title) pdf.RDMCell(190, 5, title)
pdf.ln pdf.ln
pdf.SetFontStyle('I', 8) pdf.SetFontStyle('I', 8)
details_to_strings(journal.visible_details, true).each do |string| details_to_strings(journal.visible_details, true).each do |string|
pdf.RDMMultiCell(190, 5, "- " + string) pdf.RDMMultiCell(190, 5, "- " + string)
end end
if journal.notes? if journal.notes?
pdf.ln unless journal.details.empty? pdf.ln unless journal.details.empty?
pdf.SetFontStyle('', 8) pdf.SetFontStyle('', 8)
text = textilizable(journal, :notes, text = textilizable(journal, :notes, only_path: false, edit_section_links: false, headings: false, inline_attachments: false)
only_path: false,
edit_section_links: false,
headings: false,
inline_attachments: false
)
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "") pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "")
end end
pdf.ln pdf.ln
end end
end end
if issue.attachments.any? def render_attachments(pdf, issue)
return unless issue.attachments.any?
pdf.SetFontStyle('B', 9) pdf.SetFontStyle('B', 9)
pdf.RDMCell(190, 5, l(:label_attachment_plural), "B") pdf.RDMCell(190, 5, l(:label_attachment_plural), "B")
pdf.ln pdf.ln
for attachment in issue.attachments
issue.attachments.each do |attachment|
pdf.SetFontStyle('', 8) pdf.SetFontStyle('', 8)
pdf.RDMCell(80, 5, attachment.filename) pdf.RDMCell(80, 5, attachment.filename)
pdf.RDMCell(20, 5, number_to_human_size(attachment.filesize), 0, 0, "R") pdf.RDMCell(20, 5, number_to_human_size(attachment.filesize), 0, 0, "R")
@@ -258,28 +298,17 @@ module RedmineQbo
end end
end end
# Check to see if there is an estimate attached, then combine them def merge_estimate_if_present(pdf, issue)
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) combined = CombinePDF.parse(pdf.output, allow_optional_content: true)
pdf << CombinePDF.parse(e_pdf) combined << CombinePDF.parse(e_pdf)
return pdf.to_pdf combined.to_pdf
else
pdf.output
end end
return pdf.output
end end
end end
private
def log(msg)
Rails.logger.info "[PdfPatch] #{msg}"
end
end
Redmine::Export::PDF::IssuesPdfHelper.send(:include, PdfPatch)
end end
end end

View File

@@ -8,11 +8,10 @@
# #
#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.
require_dependency 'issue_query'
module RedmineQbo module RedmineQbo
module Patches module Patches
module QueryPatch module QueryPatch
extend ActiveSupport::Concern
def base_scope def base_scope
scope = super scope = super
@@ -59,12 +58,6 @@ module RedmineQbo
Issue.joins(:customer).sanitize_sql_for_conditions([sql, pattern]) Issue.joins(:customer).sanitize_sql_for_conditions([sql, pattern])
end end
end
end
# Add module to Issue
IssueQuery.send(:prepend, QueryPatch)
end end
end end

View File

@@ -8,11 +8,10 @@
# #
#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.
require_dependency 'time_entry_query'
module RedmineQbo module RedmineQbo
module Patches module Patches
module TimeEntryQueryPatch module TimeEntryQueryPatch
extend ActiveSupport::Concern
# Add QBO options to columns # Add QBO options to columns
def available_columns def available_columns
@@ -28,11 +27,6 @@ module RedmineQbo
add_available_filter "billed", type: :boolean add_available_filter "billed", type: :boolean
super super
end end
end
end
# Add module to TimeEntryQuery
TimeEntryQuery.send(:prepend, QueryPatch)
end end
end end

View File

@@ -8,37 +8,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.
require_dependency 'user'
module RedmineQbo module RedmineQbo
module Patches module Patches
# Patches Redmine's User dynamically.
# Adds a relationships
module UserPatch module UserPatch
def self.included(base) # :nodoc: extend ActiveSupport::Concern
base.extend(ClassMethods)
base.send(:include, InstanceMethods) prepended do
# Same as typing in the class
base.class_eval do
belongs_to :employee, primary_key: :id belongs_to :employee, primary_key: :id
end end
end end
module ClassMethods
end
module InstanceMethods
end
end
# Add module to Issue
User.send(:include, UserPatch)
end end
end end